1 /*
2 * Copyright (c) 2014, The Linux Foundation. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are permitted
5 * provided that the following conditions are met:
6 *    * Redistributions of source code must retain the above copyright notice, this list of
7 *      conditions and the following disclaimer.
8 *    * Redistributions in binary form must reproduce the above copyright notice, this list of
9 *      conditions and the following disclaimer in the documentation and/or other materials provided
10 *      with the distribution.
11 *    * Neither the name of The Linux Foundation nor the names of its contributors may be used to
12 *      endorse or promote products derived from this software without specific prior written
13 *      permission.
14 *
15 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24 
25 /*! @file dump_interface.h
26   @brief Interface file for dump options provided by display manager.
27 
28 */
29 #ifndef __DUMP_INTERFACE_H__
30 #define __DUMP_INTERFACE_H__
31 
32 #include <stdint.h>
33 
34 #include "sdm_types.h"
35 
36 namespace sdm {
37 
38 /*! @brief Display dump interface.
39 
40   @details This class defines dump methods provided by display manager.
41 
42 */
43 class DumpInterface {
44  public:
45   /*! @brief Method to get dump information in form of a string.
46 
47     @details Client shall use this method to get current snapshot of display manager context as a
48     formatted string for logging or dumping purposes.
49 
50     @param[inout] buffer String buffer allocated by the client. Filled with null terminated dump
51     information upon return.
52     @param[in] length Length of the string buffer. Length shall be offset adjusted if any.
53 
54     @return \link DisplayError \endlink
55 
56     @warning Client shall ensure that this interface is not used while a display is being either
57     created or destroyed through display core.
58   */
59   static DisplayError GetDump(char *buffer, uint32_t length);
60 
61  protected:
~DumpInterface()62   virtual ~DumpInterface() { }
63 };
64 
65 }  // namespace sdm
66 
67 #endif  // __DUMP_INTERFACE_H__
68 
69