ccx_api.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (c) 2017, Alan Barr
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
*   list of conditions and the following disclaimer.
*
* * 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.
*
* 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 __CCX_API_H__
#define __CCX_API_H__

#include <cc1100_cc2500.h>
#include <stddef.h>
#include <stdint.h>
/******************************************************************************/
/******************************************************************************/


#if CCX_LOG_ERRORS || defined(__DOXYGEN__)

#   define CCX_STATUS_LOG(_STATUS)  _CCX_STATUS_LOG(_STATUS, __FILE__, __LINE__)
#else
    /* Error logging not desired, do nothing */
#   define CCX_STATUS_LOG(_STATUS) 
#endif

#define __CCX_STATUS_LOG(_STATUS, F, L)  ccxErrorLog(_STATUS, F, #L)

#define _CCX_STATUS_LOG(_STATUS, F, L)  __CCX_STATUS_LOG(_STATUS, F, L)

#define CCX_STATUS_CHECK(_STATEMENT, _STATUS)                       \
do {                                                                \
    _STATUS = (_STATEMENT);                                         \
    if ((_STATUS) != CCX_OK)                                        \
    {                                                               \
        CCX_STATUS_LOG(_STATUS);                                    \
        return _STATUS;                                             \
    }                                                               \
} while (0);

#define CCX_STATUS_CHECK_CLEANUP(_STATEMENT, _STATUS, _CLEANUP)     \
do {                                                                \
    _STATUS = (_STATEMENT);                                         \
    if ((_STATUS) != CCX_OK)                                        \
    {                                                               \
        CCX_STATUS_LOG(_STATUS);                                    \
        _CLEANUP;                                                   \
    }                                                               \
} while (0);

typedef enum {
    CCX_OK,              
    CCX_ERROR_API,       
    CCX_ERROR_INTERNAL,  
    CCX_ERROR_TIMEOUT,   
    CCX_ERROR_SPI,       
    CCX_ERROR_RX_CRC,    
    CCX_ERROR_STATE,     
    CCX_ERROR_FIFO,      
    CCX_ERROR_ASSERT,    
} CcxStatus;


void ccxErrorLog(uint8_t status, char *file, char *line);


uint8_t ccxWriteByte(uint8_t address, uint8_t value);

uint8_t ccxWriteBytes(uint8_t address,
                      const uint8_t *writeBuffer,
                      uint8_t writeBufferLength);

uint8_t ccxStrobe(uint8_t strobeAddress);

uint8_t ccxReadByte(uint8_t address, uint8_t *readByte);

uint8_t ccxReadBytes(uint8_t startAddress,
                     uint8_t *readBuffer,
                     uint8_t readBufferLength);

uint8_t ccxReadStatusRegister(uint8_t address, 
                              uint8_t *readStatus);

uint8_t ccxDelay25us(void);

uint8_t ccxReset(void);

uint8_t ccxInit(void);

uint8_t ccxShutdown(void);


uint8_t ccxRunTests(void);

/******************************************************************************/
/******************************************************************************/


#endif