sde: Add hooks for dump information.
1. Implement dump interface and provide hooks for adding
dump information from different modules.
2. Rename writeback session module to offline controller.
3. Merge logger.h functionality into debug.h
4. Rename DISPLAY_* as SDE_*.
Change-Id: I3e8df27a848475d067801037bcdc807561d35cc8
diff --git a/displayengine/include/core/debug_interface.h b/displayengine/include/core/dump_interface.h
similarity index 67%
rename from displayengine/include/core/debug_interface.h
rename to displayengine/include/core/dump_interface.h
index 2c6349a..674e60f 100644
--- a/displayengine/include/core/debug_interface.h
+++ b/displayengine/include/core/dump_interface.h
@@ -22,12 +22,12 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-/*! @file debug_interface.h
- @brief Interface file for debugging options provided by display engine.
+/*! @file dump_interface.h
+ @brief Interface file for dump options provided by display engine.
*/
-#ifndef __DEBUG_INTERFACE_H__
-#define __DEBUG_INTERFACE_H__
+#ifndef __DUMP_INTERFACE_H__
+#define __DUMP_INTERFACE_H__
#include <stdint.h>
@@ -35,31 +35,35 @@
namespace sde {
-/*! @brief Display debug interface.
+/*! @brief Display dump interface.
- @details This class defines debugging methods provided by display engine.
+ @details This class defines dump methods provided by display engine.
*/
-class DebugInterface {
+class DumpInterface {
public:
- /*! @brief Method to get debugging information in form of a string.
+ /*! @brief Method to get dump information in form of a string.
- @details Client shall use this method to get current snapshot of display engine context in form
- of a formatted string for logging or dumping purposes.
+ @details Client shall use this method to get current snapshot of display engine context as a
+ formatted string for logging or dumping purposes.
- @param[out] buffer String buffer allocated by the client. Filled with debugging information
- upon return.
+ @param[inout] buffer String buffer allocated by the client. Filled with dump information upon
+ return.
@param[in] length Length of the string buffer. Length shall be offset adjusted if any.
+ @param[in] filled Number of bytes filled into the string buffer.
@return \link DisplayError \endlink
+
+ @warning Client shall ensure that this interface is not used while a device is being either
+ created or destroyed through display core.
*/
- static DisplayError GetDump(uint8_t *buffer, uint32_t length);
+ static DisplayError GetDump(uint8_t *buffer, uint32_t length, uint32_t *filled);
protected:
- virtual ~DebugInterface() { }
+ virtual ~DumpInterface() { }
};
} // namespace sde
-#endif // __DEBUG_INTERFACE_H__
+#endif // __DUMP_INTERFACE_H__
diff --git a/displayengine/include/utils/debug.h b/displayengine/include/utils/debug.h
index 6b1d418..10d5ea6 100644
--- a/displayengine/include/utils/debug.h
+++ b/displayengine/include/utils/debug.h
@@ -25,6 +25,24 @@
#ifndef __DEBUG_H__
#define __DEBUG_H__
+#ifndef SDE_LOG_TAG
+#define SDE_LOG_TAG kLogTagNone
+#endif
+
+#ifndef SDE_MODULE_NAME
+#define SDE_MODULE_NAME "SDE"
+#endif
+
+#define DLOG(method, format, ...) Debug::method(SDE_LOG_TAG, SDE_MODULE_NAME ": " format, \
+ ##__VA_ARGS__)
+
+// SDE_LOG_TAG and SDE_MODULE_NAME must be defined before #include this header file in
+// respective module, else default definitions are used.
+#define DLOGE(format, ...) DLOG(Error, format, ##__VA_ARGS__)
+#define DLOGW(format, ...) DLOG(Warning, format, ##__VA_ARGS__)
+#define DLOGI(format, ...) DLOG(Info, format, ##__VA_ARGS__)
+#define DLOGV(format, ...) DLOG(Verbose, format, ##__VA_ARGS__)
+
namespace sde {
enum LogTag {
diff --git a/displayengine/include/utils/logger.h b/displayengine/include/utils/logger.h
deleted file mode 100644
index 03c398a..0000000
--- a/displayengine/include/utils/logger.h
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
-* Copyright (c) 2014, The Linux Foundation. All rights reserved.
-*
-* Redistribution and use in source and binary forms, with or without modification, are permitted
-* provided that the following conditions are met:
-* * Redistributions of source code must retain the above copyright notice, this list of
-* conditions and the following disclaimer.
-* * Redistributions in binary form must reproduce the above copyright notice, this list of
-* conditions and the following disclaimer in the documentation and/or other materials provided
-* with the distribution.
-* * Neither the name of The Linux Foundation nor the names of its contributors may be used to
-* endorse or promote products derived from this software without specific prior written
-* permission.
-*
-* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-* NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-#ifndef __LOGGER_H__
-#define __LOGGER_H__
-
-#include "debug.h"
-
-namespace sde {
-
-#ifndef DISPLAY_LOG_TAG
-#define DISPLAY_LOG_TAG kLogTagNone
-#endif
-
-#ifndef DISPLAY_MODULE_NAME
-#define DISPLAY_MODULE_NAME "SDE"
-#endif
-
-#define DLOG(method, format, ...) Debug::method(DISPLAY_LOG_TAG, \
- DISPLAY_MODULE_NAME ": " format, ##__VA_ARGS__)
-
-// DISPLAY_LOG_TAG and DISPLAY_MODULE_NAME must be defined before #include this header file in
-// respective module, else default definitions are used.
-#define DLOGE(format, ...) DLOG(Error, format, ##__VA_ARGS__)
-#define DLOGW(format, ...) DLOG(Warning, format, ##__VA_ARGS__)
-#define DLOGI(format, ...) DLOG(Info, format, ##__VA_ARGS__)
-#define DLOGV(format, ...) DLOG(Verbose, format, ##__VA_ARGS__)
-
-} // namespace sde
-
-#endif // __LOGGER_H__
-