logger.h

Go to the documentation of this file.

/*
 *****************************************************************************
 * AS3993/ST25RU3993 Firmware   tech@eleckits.com   http://iot.eleckits.com  *
 * STMicroelectronics ST25RU3993 is an EPC Class 1 Gen 2 RFID reader IC      *
 *                                                                           *
 * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
 * THE SOFTWARE.                                                             *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT         *
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS         *
 * FOR A PARTICULAR PURPOSE 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.      *
 *****************************************************************************
 */
/*
 *      PROJECT:   ASxxxx firmware
 *      $Revision: $
 *      LANGUAGE:  ANSI C
 */

#ifndef LOGGER_H
#define LOGGER_H

/*
******************************************************************************
* INCLUDES
******************************************************************************
*/
#include "ams_types.h"

/*
******************************************************************************
* DEFINES
******************************************************************************
*/
#define LOGGER_ON   1
#define LOGGER_OFF  0

// Set in Project settings!
// #define DYNAMIC_LOG

#ifndef USE_USB_LOGGER
#define USE_USB_LOGGER  LOGGER_OFF
#endif

#ifndef USE_I2C_LOGGER
#define USE_I2C_LOGGER  LOGGER_OFF
#endif

#ifndef USE_SPI_LOGGER
#define USE_SPI_LOGGER  LOGGER_OFF
#endif

#ifndef USE_STREAM_LOGGER
#define USE_STREAM_LOGGER  LOGGER_OFF
#endif

#ifndef USE_LOGGER
#if (  (USE_USB_LOGGER == LOGGER_ON) \
    || (USE_I2C_LOGGER == LOGGER_ON) \
    || (USE_SPI_LOGGER == LOGGER_ON) \
    || (USE_STREAM_LOGGER == LOGGER_ON) \
    )

#define USE_LOGGER  LOGGER_ON
#else
#define USE_LOGGER  LOGGER_OFF
#endif
#endif

/*
******************************************************************************
* GLOBAL MACROS
******************************************************************************
*/
#if (USE_LOGGER == LOGGER_ON) || defined(DYNAMIC_LOG)

#define LOG dbgLog 
#define LOGDUMP dbgHexDump 
/* debug assertion macro:
 * If condition mustBeTrue is not fulfilled, an endless (idle) loop is entered
 */
#define DBG_ASSERT(mustBeTrue) {                                            \
    if (!(mustBeTrue))                                                      \
    {                                                                       \
        dbgLog("ASSERT! " __FILE__ " %x\n", __LINE__);                      \
        while (1);                                                          \
    }                                                                       \
}
#else
#define LOG(...) 
#define LOGDUMP(...) 
#define DBG_ASSERT(mustBeTrue)  {}
#endif

#if (USE_USB_LOGGER == LOGGER_ON)

#define USB_LOG dbgLog 
#define USB_LOGDUMP dbgHexDump 
#else

#define USB_LOG(...) 
#define USB_LOGDUMP(...) 
#endif

#if (USE_I2C_LOGGER == LOGGER_ON)
#define I2C_LOG dbgLog 
#define I2C_LOGDUMP dbgHexDump 
#else
#define I2C_LOG(...) 
#define I2C_LOGDUMP(...) 
#endif

#if (USE_SPI_LOGGER == LOGGER_ON)
#define SPI_LOG dbgLog 
#define SPI_LOGDUMP dbgHexDump 
#else
#define SPI_LOG(...) 
#define SPI_LOGDUMP(...) 
#endif

#if (USE_STREAM_LOGGER == LOGGER_ON)
#define INFO_LOG dbgLog 
#define INFO_LOGDUMP dbgHexDump 
#else
#define INFO_LOG(...) 
#define INFO_LOGDUMP(...) 
#endif

extern s8 dbgLog(const char* format, ...);

extern void dbgHexDump (const unsigned char *buffer, u16 length);

#endif /* LOGGER_H */