ca821x_error.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2020, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  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 HOLDER 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.
 */
#ifndef CA821X_API_INCLUDE_CA821X_ERROR_H_
#define CA821X_API_INCLUDE_CA821X_ERROR_H_
 
#include "ca821x_toolchain.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum ca_error
{
    /*General Errors*/
    CA_ERROR_SUCCESS         = 0x00, 
    CA_ERROR_FAIL            = 0x01, 
    CA_ERROR_UNKNOWN         = 0x02, 
    CA_ERROR_INVALID         = 0x03, 
    CA_ERROR_NO_ACCESS       = 0x04, 
    CA_ERROR_INVALID_STATE   = 0x05, 
    CA_ERROR_BUSY            = 0x06, 
    CA_ERROR_INVALID_ARGS    = 0x07, 
    CA_ERROR_NOT_HANDLED     = 0x08, 
    CA_ERROR_NOT_FOUND       = 0x09, 
    CA_ERROR_NO_BUFFER       = 0x0A, 
    CA_ERROR_TIMEOUT         = 0x0B, 
    CA_ERROR_ALREADY         = 0x0C, 
    CA_ERROR_NOT_IMPLEMENTED = 0x0D, 
    /* SPI Errors*/
    CA_ERROR_SPI_WAIT_TIMEOUT       = 0xA0, 
    CA_ERROR_SPI_NACK_TIMEOUT       = 0xA1, 
    CA_ERROR_SPI_SCAN_IN_PROGRESS   = 0xA2, 
    CA_ERROR_SPI_SEND_EXCHANGE_FAIL = 0xA3, 
} ca_error;
 
const char *ca_error_str(ca_error aError);
 
#if __STDC_VERSION__ >= 201112L || __cplusplus >= 201103L || __cpp_static_assert >= 200410
#define ca_static_assert(x) static_assert(x, #x)
#elif !defined(__cplusplus) && defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 406) && \
    (__STDC_VERSION__ > 199901L)
#define ca_static_assert(x) _Static_assert(x, #x)
#else
#define ca_static_assert(x) typedef char static_assertion[(x) ? 1 : -1]
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* CA821X_API_INCLUDE_CA821X_ERROR_H_ */