error.h

Go to the documentation of this file.

/************************************************************************//**
 * \file    heivs/error.h
 * \brief   Errors definitions
 * \author  marc dot pignat at hevs dot ch
 ***************************************************************************/
#ifndef HEIVS_ERROR_H
#define HEIVS_ERROR_H

#include "heivs/utils.h"

/************************************************************************//**
 * \defgroup error Status (or errors)
 * @{
 * \ingroup utils
 * \brief Error codes
 ***************************************************************************/

/**
 * \brief Known errors
 */
typedef enum
{
    /**
     * \brief No error
     *
     * This function was successful.
     */
    NO_ERROR                        = 0x00000000,

    /**
     * \brief Unspecified error.
     *
     * There is no more details about what has failed.
     */
    ERROR_FAILED                    = 0x80000001,

    /**
     * \brief NULL parameter
     *
     * A parameter with a NULL value was passed, and this is not supported.
     */
    ERROR_NULL_PARAM                = 0x80000002,

    /**
     * \brief Retry later
     *
     * This function (device) is currently busy, retry later.
     */
    ERROR_AGAIN                     = 0x80000003,

    /**
     * \brief Parameter unsupported
     *
     * A parameter was not supported by the function.
     */
    ERROR_BAD_PARAM                 = 0x80000004,

    /**
     * \brief Impossible switch value
     *
     * According to the code, the
     */
    ERROR_BAD_SWITCH                = 0x80000005,   ///< Impossible switch value
    ERROR_TIMEOUT                   = 0x80000006,   ///< No comment
    ERROR_NOT_SUPPORTED             = 0x80000007,   ///< Function is not available
    ERROR_HW_FAILED                 = 0x80000008,   ///< You should check your solder/cables
    ERROR_BAD_STATE                 = 0x80000009,   ///< Function called at bad time
    ERROR_STACK_OVERFLOW            = 0x8000000a,   ///< No comment
    ERROR_OUT_OF_MEMORY             = 0x8000000b,   ///<  (or friend) failed
    ERROR_MAIN_FINISHED             = 0x8000000c,   ///< main has finished (shouldn't happen in embedded software)
    ERROR_IRQ_NOT_HANDLED           = 0x8000000d,   ///< Default interrupt handler fired
    ERROR_CONFIG                    = 0x8000000e,   ///< Compile time configuration error
    ERROR_TOO_BIG                   = 0x8000000f,   ///< Parameter too big
    ERROR_DMA_UNDERRUN              = 0x80000010,   ///< No comment
    ERROR_BAD_ALIGN                 = 0x80000011,   ///< Pointer with wrong alignment
    ERROR_FREERTOS_CONFIG_ASSERT    = 0x80000012,   ///< FreeRTOS configASSERT

    ERROR_BUS_NOINIT                = 0x80000020,   ///< Have you called bus_init ?
    ERROR_BUS_INACTIVE              = 0x80000021,   ///< Have you called bus_get ?
    ERROR_BUS_SUSPENDED             = 0x80000022,   ///< Bus not operable while in power down
    ERROR_BUS_BAD_STATE             = 0x80000023,   ///< see bus_get/bus_release and errors
    ERROR_BUS_BUSY_TIMEOUT          = 0x80000030,   ///<
    ERROR_BUS_NACK                  = 0x80000031,
    ERROR_BUS_NO_START              = 0x80000032,
    ERROR_BUS_NO_ADDR_TX            = 0x80000033,
    ERROR_BUS_BUSY                  = 0x80000034,

    ERROR_SD_NOT_PRESENT            = 0x80000050,   ///< SD card not detected
    ERROR_SD_ACCESS_FAILED          = 0x80000052,   ///< No comment

    ERROR_TRACE_FAILED              = 0x80000060,   ///< No comment

    ERROR_EEPROM_BAD_MAGIC          = 0x80000070,   ///< EEPROM is empty or has failed
    ERROR_EEPROM_BAD_CALIB          = 0x80000071,   ///< EEPROM has no touchscreen calibration data

    _ERROR_APP_START                = 0x81000000,   ///< Application specific range start
    _ERROR_APP_END                  = 0x8fffffff,   ///< Application specific range end

    ERROR_0_TBD                     = 0xdeadbeef,   ///< Should not happen, this is a placeholder

    ERROR_NOT_YET_IMPLEMENTED       = 0xffffffff,
} status_e;

#define ERROR_APP(__X__) (_ERROR_APP_START | (__X__))
/************************************************************************//**
 * @}
 ***************************************************************************/
#endif /* HEIVS_ERROR_H */