Vybhav Kadaba / Mbed OS EV-PRO-MW1001_MWARE2138

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

inc/adi_sense_log.h@0:85855ecd3257, 2019-04-01 (annotated)

Committer:
ADIJake
Date:
Mon Apr 01 11:09:52 2019 +0000
Revision:
0:85855ecd3257
Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ADIJake 0:85855ecd3257 1 /*
ADIJake 0:85855ecd3257 2 Copyright 2017 (c) Analog Devices, Inc.
ADIJake 0:85855ecd3257 3
ADIJake 0:85855ecd3257 4 All rights reserved.
ADIJake 0:85855ecd3257 5
ADIJake 0:85855ecd3257 6 Redistribution and use in source and binary forms, with or without
ADIJake 0:85855ecd3257 7 modification, are permitted provided that the following conditions are met:
ADIJake 0:85855ecd3257 8 - Redistributions of source code must retain the above copyright
ADIJake 0:85855ecd3257 9 notice, this list of conditions and the following disclaimer.
ADIJake 0:85855ecd3257 10 - Redistributions in binary form must reproduce the above copyright
ADIJake 0:85855ecd3257 11 notice, this list of conditions and the following disclaimer in
ADIJake 0:85855ecd3257 12 the documentation and/or other materials provided with the
ADIJake 0:85855ecd3257 13 distribution.
ADIJake 0:85855ecd3257 14 - Neither the name of Analog Devices, Inc. nor the names of its
ADIJake 0:85855ecd3257 15 contributors may be used to endorse or promote products derived
ADIJake 0:85855ecd3257 16 from this software without specific prior written permission.
ADIJake 0:85855ecd3257 17 - The use of this software may or may not infringe the patent rights
ADIJake 0:85855ecd3257 18 of one or more patent holders. This license does not release you
ADIJake 0:85855ecd3257 19 from the requirement that you obtain separate licenses from these
ADIJake 0:85855ecd3257 20 patent holders to use this software.
ADIJake 0:85855ecd3257 21 - Use of the software either in source or binary form, must be run
ADIJake 0:85855ecd3257 22 on or directly connected to an Analog Devices Inc. component.
ADIJake 0:85855ecd3257 23
ADIJake 0:85855ecd3257 24 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
ADIJake 0:85855ecd3257 25 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
ADIJake 0:85855ecd3257 26 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
ADIJake 0:85855ecd3257 27 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
ADIJake 0:85855ecd3257 28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
ADIJake 0:85855ecd3257 29 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
ADIJake 0:85855ecd3257 30 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
ADIJake 0:85855ecd3257 31 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
ADIJake 0:85855ecd3257 32 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
ADIJake 0:85855ecd3257 33 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ADIJake 0:85855ecd3257 34 */
ADIJake 0:85855ecd3257 35
ADIJake 0:85855ecd3257 36 /*!
ADIJake 0:85855ecd3257 37 ******************************************************************************
ADIJake 0:85855ecd3257 38 * @file: adi_sense_log.h
ADIJake 0:85855ecd3257 39 * @brief: ADISENSE OS-dependent wrapper layer for log functions
ADIJake 0:85855ecd3257 40 *-----------------------------------------------------------------------------
ADIJake 0:85855ecd3257 41 */
ADIJake 0:85855ecd3257 42
ADIJake 0:85855ecd3257 43 #ifndef __ADI_SENSE_LOG_H__
ADIJake 0:85855ecd3257 44 #define __ADI_SENSE_LOG_H__
ADIJake 0:85855ecd3257 45
ADIJake 0:85855ecd3257 46 #include "inc/adi_sense_types.h"
ADIJake 0:85855ecd3257 47
ADIJake 0:85855ecd3257 48 /*! @ingroup ADISENSE_Host */
ADIJake 0:85855ecd3257 49
ADIJake 0:85855ecd3257 50 /*! @addtogroup ADISENSE_Log ADISENSE Host Logging functions
ADIJake 0:85855ecd3257 51 * @{
ADIJake 0:85855ecd3257 52 */
ADIJake 0:85855ecd3257 53
ADIJake 0:85855ecd3257 54 /*! Macro function for logging an error message */
ADIJake 0:85855ecd3257 55 #define ADI_SENSE_LOG_ERROR(...) \
ADIJake 0:85855ecd3257 56 adi_sense_Log(ADI_SENSE_LOG_LEVEL_ERROR, "[ERROR] " __VA_ARGS__)
ADIJake 0:85855ecd3257 57 /*! Macro function for logging a warning message */
ADIJake 0:85855ecd3257 58 #define ADI_SENSE_LOG_WARN(...) \
ADIJake 0:85855ecd3257 59 adi_sense_Log(ADI_SENSE_LOG_LEVEL_WARN, "[WARN] " __VA_ARGS__)
ADIJake 0:85855ecd3257 60 /*! Macro function for logging an information message */
ADIJake 0:85855ecd3257 61 #define ADI_SENSE_LOG_INFO(...) \
ADIJake 0:85855ecd3257 62 adi_sense_Log(ADI_SENSE_LOG_LEVEL_INFO, "[INFO] " __VA_ARGS__)
ADIJake 0:85855ecd3257 63 /*! Macro function for logging a debug message */
ADIJake 0:85855ecd3257 64 #define ADI_SENSE_LOG_DEBUG(...) \
ADIJake 0:85855ecd3257 65 adi_sense_Log(ADI_SENSE_LOG_LEVEL_DEBUG, "[DEBUG] " __VA_ARGS__)
ADIJake 0:85855ecd3257 66
ADIJake 0:85855ecd3257 67 /*!
ADIJake 0:85855ecd3257 68 * Log message priority levels
ADIJake 0:85855ecd3257 69 */
ADIJake 0:85855ecd3257 70 typedef enum
ADIJake 0:85855ecd3257 71 {
ADIJake 0:85855ecd3257 72 ADI_SENSE_LOG_LEVEL_ERROR = 0, /*!< Error message priority */
ADIJake 0:85855ecd3257 73 ADI_SENSE_LOG_LEVEL_WARN, /*!< Warning message priority */
ADIJake 0:85855ecd3257 74 ADI_SENSE_LOG_LEVEL_INFO, /*!< Information message priority */
ADIJake 0:85855ecd3257 75 ADI_SENSE_LOG_LEVEL_DEBUG, /*!< Debug message priority */
ADIJake 0:85855ecd3257 76 } ADI_SENSE_LOG_LEVEL;
ADIJake 0:85855ecd3257 77
ADIJake 0:85855ecd3257 78
ADIJake 0:85855ecd3257 79 #ifdef __cplusplus
ADIJake 0:85855ecd3257 80 extern "C"
ADIJake 0:85855ecd3257 81 {
ADIJake 0:85855ecd3257 82 #endif
ADIJake 0:85855ecd3257 83
ADIJake 0:85855ecd3257 84 /*!
ADIJake 0:85855ecd3257 85 * @brief Initialise the Log interface and allocate resources.
ADIJake 0:85855ecd3257 86 *
ADIJake 0:85855ecd3257 87 * @return Status
ADIJake 0:85855ecd3257 88 * - #ADI_SENSE_SUCCESS Call completed successfully.
ADIJake 0:85855ecd3257 89 * - #ADI_SENSE_NO_MEM Failed to allocate memory for device context.
ADIJake 0:85855ecd3257 90 */
ADIJake 0:85855ecd3257 91 ADI_SENSE_RESULT adi_sense_LogOpen(
ADIJake 0:85855ecd3257 92 ADI_SENSE_PLATFORM_LOG_CONFIG *pConfig);
ADIJake 0:85855ecd3257 93
ADIJake 0:85855ecd3257 94 /*!
ADIJake 0:85855ecd3257 95 * @brief Close the Log interface and free resources.
ADIJake 0:85855ecd3257 96 */
ADIJake 0:85855ecd3257 97 void adi_sense_LogClose(void);
ADIJake 0:85855ecd3257 98
ADIJake 0:85855ecd3257 99 /*!
ADIJake 0:85855ecd3257 100 * @brief Set the minimum priority level for the log messages.
ADIJake 0:85855ecd3257 101 *
ADIJake 0:85855ecd3257 102 * @param[in] maxLevel priority level
ADIJake 0:85855ecd3257 103 *
ADIJake 0:85855ecd3257 104 * @details Sets the log priority level. Messages with priority lower
ADIJake 0:85855ecd3257 105 that this level will not be passed to the log interface.
ADIJake 0:85855ecd3257 106 */
ADIJake 0:85855ecd3257 107 void adi_sense_LogLevel(
ADIJake 0:85855ecd3257 108 ADI_SENSE_LOG_LEVEL maxLevel);
ADIJake 0:85855ecd3257 109
ADIJake 0:85855ecd3257 110 /*!
ADIJake 0:85855ecd3257 111 * @brief Print a log message to the platform log interface.
ADIJake 0:85855ecd3257 112 *
ADIJake 0:85855ecd3257 113 * @param[in] level Log message priority level
ADIJake 0:85855ecd3257 114 * @param[in] format Format string and variable argument list, if any
ADIJake 0:85855ecd3257 115 */
ADIJake 0:85855ecd3257 116 void adi_sense_Log(
ADIJake 0:85855ecd3257 117 ADI_SENSE_LOG_LEVEL level,
ADIJake 0:85855ecd3257 118 const char * format,
ADIJake 0:85855ecd3257 119 ...);
ADIJake 0:85855ecd3257 120
ADIJake 0:85855ecd3257 121 #ifdef __cplusplus
ADIJake 0:85855ecd3257 122 }
ADIJake 0:85855ecd3257 123 #endif
ADIJake 0:85855ecd3257 124
ADIJake 0:85855ecd3257 125 /*!
ADIJake 0:85855ecd3257 126 * @}
ADIJake 0:85855ecd3257 127 */
ADIJake 0:85855ecd3257 128
ADIJake 0:85855ecd3257 129 #endif /* __ADI_SENSE_LOG_H__ */
ADIJake 0:85855ecd3257 130