cascoda_spi.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2019, 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 CASCODA_SPI_H
#define CASCODA_SPI_H
 
#include "cascoda-bm/cascoda_types.h"
#include "ca821x_api.h"
#include "mac_messages.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/****** Definitions for SPI Handling                                     ******/
 
#define SPI_T_TIMEOUT 500   
#define SPI_T_BACKOFF 10    
#define SPI_T_HOLD_8210 100 
#define SPI_T_CSHOLD 50     
 
#define SPI_RX_FIFO_SIZE 7 
#define SPI_RX_FIFO_RESV 4 
 
#if !(SPI_RX_FIFO_RESV < SPI_RX_FIFO_SIZE)
#error "SPI_RX_FIFO_RESV must be less than SPI_RX_FIFO_SIZE"
#endif
 
/****** Function Declarations for cascoda_spi.c                          ******/
 
ca_error SPI_Exchange(const struct MAC_Message *pTxBuffer, struct ca821x_dev *pDeviceRef);
 
ca_error SPI_Send(const uint8_t *buf, u8_t *response, struct ca821x_dev *pDeviceRef);
 
struct MAC_Message *SPI_PeekFullBuf(void);
 
void SPI_DequeueFullBuf(void);
 
bool SPI_IsFifoFull(void);
 
bool SPI_IsFifoAlmostFull(void);
 
bool SPI_IsFifoEmpty(void);
 
bool SPI_IsExchangeWithCA821xInProgress(void);
 
bool SPI_IsSyncChainInFlight(void);
 
void SPI_StartSyncChain(struct ca821x_dev *pDeviceRef);
 
void SPI_StopSyncChain(struct ca821x_dev *pDeviceRef);
 
void SPI_Initialise(void);
 
void SPI_ExchangeComplete(void);
 
bool SPI_GetExternallyInUseStatus(void);
 
#if CASCODA_EXTERNAL_FLASHCHIP_PRESENT
ca_error SPI_SetExternallyInUseStatus(bool status, void (*callback)(void));
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif // CASCODA_SPI_H