adi_sense_log.h

00001 /*!
00002  ******************************************************************************
00003  * @file:   adi_sense_log.h
00004  * @brief:  ADI Sense OS-dependent wrapper layer for log functions
00005  *-----------------------------------------------------------------------------
00006  */
00007 
00008 /*
00009 Copyright 2017 (c) Analog Devices, Inc.
00010 
00011 All rights reserved.
00012 
00013 Redistribution and use in source and binary forms, with or without
00014 modification, are permitted provided that the following conditions are met:
00015   - Redistributions of source code must retain the above copyright
00016     notice, this list of conditions and the following disclaimer.
00017   - Redistributions in binary form must reproduce the above copyright
00018     notice, this list of conditions and the following disclaimer in
00019     the documentation and/or other materials provided with the
00020     distribution.
00021   - Neither the name of Analog Devices, Inc. nor the names of its
00022     contributors may be used to endorse or promote products derived
00023     from this software without specific prior written permission.
00024   - The use of this software may or may not infringe the patent rights
00025     of one or more patent holders. This license does not release you
00026     from the requirement that you obtain separate licenses from these
00027     patent holders to use this software.
00028   - Use of the software either in source or binary form, must be run
00029     on or directly connected to an Analog Devices Inc. component.
00030 
00031 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00032 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00033 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00034 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00035 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00036 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00037 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00038 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00039 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00040 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00041 */
00042 
00043 #ifndef __ADI_SENSE_LOG_H__
00044 #define __ADI_SENSE_LOG_H__
00045 
00046 #include "inc/adi_sense_types.h"
00047 
00048 /*! @ingroup ADI_Sense_Host */
00049 
00050 /*! @addtogroup ADI_Sense_Log ADI Sense Host Logging functions
00051  *  @{
00052  */
00053 
00054 /*! Macro function for logging an error message */
00055 #define ADI_SENSE_LOG_ERROR(...)                                        \
00056     adi_sense_Log(ADI_SENSE_LOG_LEVEL_ERROR, "[ERROR] " __VA_ARGS__)
00057 /*! Macro function for logging a warning message */
00058 #define ADI_SENSE_LOG_WARN(...)  \
00059     adi_sense_Log(ADI_SENSE_LOG_LEVEL_WARN,  "[WARN] "  __VA_ARGS__)
00060 /*! Macro function for logging an information message */
00061 #define ADI_SENSE_LOG_INFO(...)  \
00062     adi_sense_Log(ADI_SENSE_LOG_LEVEL_INFO,  "[INFO] "  __VA_ARGS__)
00063 /*! Macro function for logging a debug message */
00064 #define ADI_SENSE_LOG_DEBUG(...) \
00065     adi_sense_Log(ADI_SENSE_LOG_LEVEL_DEBUG, "[DEBUG] " __VA_ARGS__)
00066 
00067 /*!
00068  * Log message priority levels
00069  */
00070 typedef enum
00071 {
00072     ADI_SENSE_LOG_LEVEL_ERROR  = 0, /*!< Error message priority */
00073     ADI_SENSE_LOG_LEVEL_WARN ,      /*!< Warning message priority */
00074     ADI_SENSE_LOG_LEVEL_INFO ,      /*!< Information message priority */
00075     ADI_SENSE_LOG_LEVEL_DEBUG ,     /*!< Debug message priority */
00076 } ADI_SENSE_LOG_LEVEL ;
00077 
00078 
00079 #ifdef __cplusplus
00080 extern "C" 
00081 {
00082 #endif
00083 
00084 /*!
00085  * @brief Initialise the Log interface and allocate resources.
00086  *
00087  * @return Status
00088  *         - #ADI_SENSE_SUCCESS Call completed successfully.
00089  *         - #ADI_SENSE_NO_MEM  Failed to allocate memory for device context.
00090  */
00091 ADI_SENSE_RESULT  adi_sense_LogOpen(
00092     void);
00093 
00094 /*!
00095  * @brief Close the Log interface and free resources.
00096  */
00097 void adi_sense_LogClose(
00098     void);
00099 
00100 /*!
00101  * @brief Print a log message to the platform log interface.
00102  *
00103  * @param[in] level  Log message priority level
00104  * @param[in] format Format string and variable argument list, if any
00105  */
00106 void adi_sense_Log(
00107     ADI_SENSE_LOG_LEVEL    level,
00108     const char          * format,
00109     ...);
00110 
00111 #ifdef __cplusplus
00112 }
00113 #endif
00114 
00115 /*!
00116  * @}
00117  */
00118 
00119 #endif /* __ADI_SENSE_LOG_H__ */
00120