Diff: inc/adi_sense_log.h

Revision:

7:4dbae381f693

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/adi_sense_log.h	Fri Oct 20 15:58:01 2017 +0000
@@ -0,0 +1,124 @@
+/*!
+ ******************************************************************************
+ * @file:   adi_sense_log.h
+ * @brief:  ADI Sense OS-dependent wrapper layer for log functions
+ *-----------------------------------------------------------------------------
+ */
+
+/*
+Copyright (c) 2017 Emutex Ltd. / Analog Devices, Inc.
+
+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.
+  - Modified versions of the software must be conspicuously marked as such.
+  - This software is licensed solely and exclusively for use with processors
+    manufactured by or for Analog Devices, Inc.
+  - This software may not be combined or merged with other code in any manner
+    that would cause the software to become subject to terms and conditions
+    which differ from those listed here.
+  - Neither the name of Analog Devices, Inc. nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+  - The use of this software may or may not infringe the patent rights of one
+    or more patent holders.  This license does not release you from the
+    requirement that you obtain separate licenses from these patent holders
+    to use this software.
+
+THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
+TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
+PROPERTY RIGHTS INFRINGEMENT; 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 __ADI_SENSE_LOG_H__
+#define __ADI_SENSE_LOG_H__
+
+#include "inc/adi_sense_types.h"
+
+/*! @ingroup ADI_Sense_Host */
+
+/*! @addtogroup ADI_Sense_Log ADI Sense Host Logging functions
+ *  @{
+ */
+
+/*! Macro function for logging an error message */
+#define ADI_SENSE_LOG_ERROR(...)                                        \
+    adi_sense_Log(ADI_SENSE_LOG_LEVEL_ERROR, "[ERROR] " __VA_ARGS__)
+/*! Macro function for logging a warning message */
+#define ADI_SENSE_LOG_WARN(...)  \
+    adi_sense_Log(ADI_SENSE_LOG_LEVEL_WARN,  "[WARN] "  __VA_ARGS__)
+/*! Macro function for logging an information message */
+#define ADI_SENSE_LOG_INFO(...)  \
+    adi_sense_Log(ADI_SENSE_LOG_LEVEL_INFO,  "[INFO] "  __VA_ARGS__)
+/*! Macro function for logging a debug message */
+#define ADI_SENSE_LOG_DEBUG(...) \
+    adi_sense_Log(ADI_SENSE_LOG_LEVEL_DEBUG, "[DEBUG] " __VA_ARGS__)
+
+/*!
+ * Log message priority levels
+ */
+typedef enum
+{
+    ADI_SENSE_LOG_LEVEL_ERROR = 0, /*!< Error message priority */
+    ADI_SENSE_LOG_LEVEL_WARN,      /*!< Warning message priority */
+    ADI_SENSE_LOG_LEVEL_INFO,      /*!< Information message priority */
+    ADI_SENSE_LOG_LEVEL_DEBUG,     /*!< Debug message priority */
+} ADI_SENSE_LOG_LEVEL;
+
+
+#ifdef __cplusplus
+extern "C" 
+{
+#endif
+
+/*!
+ * @brief Initialise the Log interface and allocate resources.
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully.
+ *         - #ADI_SENSE_NO_MEM  Failed to allocate memory for device context.
+ */
+ADI_SENSE_RESULT adi_sense_LogOpen(
+    void);
+
+/*!
+ * @brief Close the Log interface and free resources.
+ */
+void adi_sense_LogClose(
+    void);
+
+/*!
+ * @brief Print a log message to the platform log interface.
+ *
+ * @param[in] level  Log message priority level
+ * @param[in] format Format string and variable argument list, if any
+ */
+void adi_sense_Log(
+    ADI_SENSE_LOG_LEVEL   level,
+    const char          * format,
+    ...);
+
+#ifdef __cplusplus
+}
+#endif
+
+/*!
+ * @}
+ */
+
+#endif /* __ADI_SENSE_LOG_H__ */
+