ruuvi_driver_error.h

Go to the documentation of this file.

#ifndef RUUVI_DRIVER_ERROR_H
#define RUUVI_DRIVER_ERROR_H
#include <float.h>
#include <math.h>
#include <stdbool.h>
#include <stdint.h>
 
#define RD_FLOAT_INVALID  NAN            
#define RD_UINT64_INVALID UINT64_MAX     
#define RD_INT64_INVALID  INT64_MIN      
#define RD_INT32_INVALID  INT32_MIN      
 
#define RD_SUCCESS                (0U)       
#define RD_ERROR_INTERNAL         (1U<<0U)   
#define RD_ERROR_NO_MEM           (1U<<1U)   
#define RD_ERROR_NOT_FOUND        (1U<<2U)   
#define RD_ERROR_NOT_SUPPORTED    (1U<<3U)   
#define RD_ERROR_INVALID_PARAM    (1U<<4U)   
#define RD_ERROR_INVALID_STATE    (1U<<5U)   
#define RD_ERROR_INVALID_LENGTH   (1U<<6U)   
#define RD_ERROR_INVALID_FLAGS    (1U<<7U)   
#define RD_ERROR_INVALID_DATA     (1U<<8U)   
#define RD_ERROR_DATA_SIZE        (1U<<9U)   
#define RD_ERROR_TIMEOUT          (1U<<10U)  
#define RD_ERROR_NULL             (1U<<11U)  
#define RD_ERROR_FORBIDDEN        (1U<<12U)  
#define RD_ERROR_INVALID_ADDR     (1U<<13U)  
#define RD_ERROR_BUSY             (1U<<14U)  
#define RD_ERROR_RESOURCES        (1U<<15U)  
#define RD_ERROR_NOT_IMPLEMENTED  (1U<<16U)  
#define RD_ERROR_SELFTEST         (1U<<17U)  
#define RD_STATUS_MORE_AVAILABLE  (1U<<18U)  
#define RD_ERROR_NOT_INITIALIZED  (1U<<19U)  
#define RD_ERROR_NOT_ACKNOWLEDGED (1U<<20U)  
#define RD_ERROR_NOT_ENABLED      (1U<<21U)  
#define RD_WARNING_DEPRECATED     (1U<<22U)  
#define RD_ERROR_FATAL            (1U<<31U)  
 
typedef uint32_t rd_status_t; 
 
void rd_error_check (const rd_status_t error,
                     const rd_status_t non_fatal_mask, const char * p_file, const int line);
 
#define RD_ERROR_CHECK(error, mask) rd_error_check(error, mask, __FILE__, __LINE__)
 
/*
 * @brief reset global error flags and return their value.
 *
 * @return errors occured after last call to this function.
 */
rd_status_t rd_errors_clear();
 
/* @brief Application callback on error
 *
 * If this callback is set, it will get called on error.
 *
 * @param[in] error Type of error
 * @param[in] fatal True if error is considered non-recoverable
 * @param[in] file  Pointer to name of file where error occured
 * @param[in] line  line where error occured
 */
typedef void (*rd_error_cb) (const rd_status_t error,
                             const bool fatal,
                             const char * file,
                             const int line);
 
void rd_error_cb_set (rd_error_cb cb);
 
#endif