spi.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * 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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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.
 * --/COPYRIGHT--*/
#ifndef _SPI_H_
#define _SPI_H_



// **************************************************************************
// the includes

// drivers
#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"


// modules
#include "sw/modules/types/src/types.h"





#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define SPIA_BASE_ADDR              (0x00007040)

#define SPIB_BASE_ADDR              (0x00007740)

#define SPI_SPICCR_CHAR_LENGTH_BITS        (15 << 0)

#define SPI_SPICCR_SPILBK_BITS             ( 1 << 4)  

#define SPI_SPICCR_CLKPOL_BITS             ( 1 << 6)

#define SPI_SPICCR_RESET_BITS              ( 1 << 7)

#define SPI_SPIST_INTFLAG_BITS              ( 1 << 6)

#define SPI_SPIST_TXBUF_BITS                (1 << 5)

#define SPI_SPICTL_INT_ENA_BITS             (1 << 0)

#define SPI_SPICTL_TALK_BITS                (1 << 1)

#define SPI_SPICTL_MODE_BITS                (1 << 2)

#define SPI_SPICTL_CLK_PHASE_BITS           (1 << 3)

#define SPI_SPICTL_OVRRUN_INT_ENA_BITS      (1 << 4)


#define SPI_SPIFFRX_IL_BITS           (31 << 0)

#define SPI_SPIFFRX_IENA_BITS         ( 1 << 5)

#define SPI_SPIFFRX_INTCLR_BITS       ( 1 << 6)

#define SPI_SPIFFRX_INT_BITS          ( 1 << 7)

#define SPI_SPIFFRX_FIFO_ST_BITS      (31 << 8)

#define SPI_SPIFFRX_FIFO_RESET_BITS   ( 1 << 13)

#define SPI_SPIFFRX_FIFO_OVFCLR_BITS  ( 1 << 14)

#define SPI_SPIFFRX_FIFO_OVF_BITS     ( 1 << 15)


#define SPI_SPIFFTX_IL_BITS           (31 << 0)

#define SPI_SPIFFTX_IENA_BITS         ( 1 << 5)

#define SPI_SPIFFTX_INTCLR_BITS       ( 1 << 6)

#define SPI_SPIFFTX_INT_BITS          ( 1 << 7)

#define SPI_SPIFFTX_FIFO_ST_BITS      (31 << 8)

#define SPI_SPIFFTX_FIFO_RESET_BITS   ( 1 << 13)

#define SPI_SPIFFTX_FIFO_ENA_BITS     ( 1 << 14)

#define SPI_SPIFFTX_CHAN_RESET_BITS   ( 1 << 15)


#define SPI_SPIPRI_SUSP_BITS          (  3 << 4)

#define SPI_SPIPRI_STE_INV_BITS       (  1 << 1)

#define SPI_SPIPRI_TRIWIRE            (  1 << 0)


// **************************************************************************
// the typedefs

typedef enum
{
  SPI_BaudRate_LSPCLK_Over_Four=0,
  SPI_BaudRate_1_MBaud=(14 << 0)   
} SPI_BaudRate_e;


typedef enum
{
  SPI_CharLength_1_Bit=(0 << 0),        
  SPI_CharLength_2_Bits=(1 << 0),       
  SPI_CharLength_3_Bits=(2 << 0),       
  SPI_CharLength_4_Bits=(3 << 0),       
  SPI_CharLength_5_Bits=(4 << 0),       
  SPI_CharLength_6_Bits=(5 << 0),       
  SPI_CharLength_7_Bits=(6 << 0),       
  SPI_CharLength_8_Bits=(7 << 0),       
  SPI_CharLength_9_Bits=(8 << 0),       
  SPI_CharLength_10_Bits=(9 << 0),      
  SPI_CharLength_11_Bits=(10 << 0),     
  SPI_CharLength_12_Bits=(11 << 0),     
  SPI_CharLength_13_Bits=(12 << 0),     
  SPI_CharLength_14_Bits=(13 << 0),     
  SPI_CharLength_15_Bits=(14 << 0),     
  SPI_CharLength_16_Bits=(15 << 0)      
} SPI_CharLength_e;


typedef enum
{
  SPI_ClkPhase_Normal=(0<<3),      
  SPI_ClkPhase_Delayed=(1<<3)      
} SPI_ClkPhase_e;


typedef enum
{
  SPI_ClkPolarity_OutputRisingEdge_InputFallingEdge=(0 << 6),  
  SPI_ClkPolarity_OutputFallingEdge_InputRisingEdge=(1 << 6)   
} SPI_ClkPolarity_e;



typedef enum
{
  SPI_Mode_Slave=(0<<2),      
  SPI_Mode_Master=(1<<2)      
} SPI_Mode_e;


typedef enum
{
  SPI_FifoLevel_Empty=(0 << 0),      
  SPI_FifoLevel_1_Word=(1 << 0),     
  SPI_FifoLevel_2_Words=(2 << 0),    
  SPI_FifoLevel_3_Words=(3 << 0),    
  SPI_FifoLevel_4_Words=(4 << 0)     
} SPI_FifoLevel_e;


typedef enum
{
  SPI_FifoStatus_Empty=(0 << 8),      
  SPI_FifoStatus_1_Word=(1 << 8),     
  SPI_FifoStatus_2_Words=(2 << 8),    
  SPI_FifoStatus_3_Words=(3 << 8),    
  SPI_FifoStatus_4_Words=(4 << 8)     
}  SPI_FifoStatus_e;


typedef enum
{
  SPI_Priority_Immediate=(0 << 4),      
  SPI_Priority_FreeRun=(1 << 4),        
  SPI_Priority_AfterRxRxSeq=(2 << 4)    
} SPI_Priority_e;


typedef enum
{
  SPI_IntFlagStatus_InProgress=(0<<6),  
  SPI_IntFlagStatus_Completed=(1<<6)    
} SPI_IntFlagStatus_e;


typedef enum
{
  SPI_SteInv_ActiveLow=(0 << 1),        
  SPI_SteInv_ActiveHigh=(1 << 1)        
} SPI_SteInv_e;


typedef enum
{
  SPI_TriWire_NormalFourWire=(0 << 0),  
  SPI_TriWire_ThreeWire=(1 << 0)        
} SPI_TriWire_e;


typedef enum
{
  SPI_TxBufferStatus_Empty=(0<<5),   
  SPI_TxBufferStatus_Full=(1<<5)     
} SPI_TxBufferStatus_e;


typedef enum
{
  SPI_TxSuspend_00=(0x0<<4),      
  SPI_TxSuspend_10=(0x2<<4),      
  SPI_TxSuspend_free=(0x1<<4)     
} SPI_EmulationSuspend_e;


typedef struct _SPI_Obj_
{
  volatile uint16_t      SPICCR;        
  volatile uint16_t      SPICTL;        
  volatile uint16_t      SPIST;         
  volatile uint16_t      rsvd_1;        
  volatile uint16_t      SPIBRR;        
  volatile uint16_t      rsvd_2;        
  volatile uint16_t      SPIEMU;        
  volatile uint16_t      SPIRXBUF;      
  volatile uint16_t      SPITXBUF;      
  volatile uint16_t      SPIDAT;        
  volatile uint16_t      SPIFFTX;       
  volatile uint16_t      SPIFFRX;       
  volatile uint16_t      SPIFFCT;       
  volatile uint16_t      rsvd_3[2];     
  volatile uint16_t      SPIPRI;        
} SPI_Obj;


typedef struct _SPI_Obj_ *SPI_Handle;


// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes

extern void SPI_clearRxFifoOvf(SPI_Handle spiHandle);


extern void SPI_clearRxFifoInt(SPI_Handle spiHandle);


extern void SPI_clearTxFifoInt(SPI_Handle spiHandle);


extern void SPI_disableInt(SPI_Handle spiHandle);


extern void SPI_disableLoopBack(SPI_Handle spiHandle);


extern void SPI_disableOverRunInt(SPI_Handle spiHandle);


extern void SPI_disableRxFifoInt(SPI_Handle spiHandle);


extern void SPI_disableTx(SPI_Handle spiHandle);


extern void SPI_disableTxFifoEnh(SPI_Handle spiHandle);


extern void SPI_disableTxFifoInt(SPI_Handle spiHandle);


extern void SPI_enable(SPI_Handle spiHandle);


extern void SPI_enableChannels(SPI_Handle spiHandle);


extern void SPI_enableInt(SPI_Handle spiHandle);


extern void SPI_enableLoopBack(SPI_Handle spiHandle);


extern void SPI_enableOverRunInt(SPI_Handle spiHandle);


extern void SPI_enableRxFifo(SPI_Handle spiHandle);


extern void SPI_enableRxFifoInt(SPI_Handle spiHandle);


extern void SPI_enableTx(SPI_Handle spiHandle);


extern void SPI_enableTxFifo(SPI_Handle spiHandle);


extern void SPI_enableTxFifoEnh(SPI_Handle spiHandle);


extern void SPI_enableTxFifoInt(SPI_Handle spiHandle);


extern SPI_FifoStatus_e SPI_getRxFifoStatus(SPI_Handle spiHandle);


extern SPI_FifoStatus_e SPI_getTxFifoStatus(SPI_Handle spiHandle);


extern SPI_IntFlagStatus_e SPI_getIntFlagStatus(SPI_Handle spiHandle);


extern SPI_TxBufferStatus_e SPI_getTxBufferStatus(SPI_Handle spiHandle);


extern SPI_Handle SPI_init(void *pMemory,const size_t numBytes);


static inline uint16_t SPI_read(SPI_Handle spiHandle)
{
  SPI_Obj *spi = (SPI_Obj *)spiHandle;


  // read the data
  uint16_t data = spi->SPIRXBUF;

  return(data);
} // end of SPI_read() function


static inline uint16_t SPI_readEmu(SPI_Handle spiHandle)
{
  SPI_Obj *spi = (SPI_Obj *)spiHandle;


  // read the data
  uint16_t data = spi->SPIEMU;

  return(data);
} // end of SPI_readEmu() function


extern void SPI_reset(SPI_Handle spiHandle);


extern void SPI_resetChannels(SPI_Handle spiHandle);


extern void SPI_resetRxFifo(SPI_Handle spiHandle);


extern void SPI_resetTxFifo(SPI_Handle spiHandle);


extern void SPI_setBaudRate(SPI_Handle spiHandle,const SPI_BaudRate_e baudRate);


extern void SPI_setCharLength(SPI_Handle spiHandle,const SPI_CharLength_e length);


extern void SPI_setClkPhase(SPI_Handle spiHandle,const SPI_ClkPhase_e clkPhase);


extern void SPI_setClkPolarity(SPI_Handle spiHandle,const SPI_ClkPolarity_e polarity);


extern void SPI_setMode(SPI_Handle spiHandle,const SPI_Mode_e mode);


extern void SPI_setRxFifoIntLevel(SPI_Handle spiHandle,const SPI_FifoLevel_e fifoLevel);


extern void SPI_setPriority(SPI_Handle spiHandle,const SPI_Priority_e priority);


extern void SPI_setSteInv(SPI_Handle spiHandle,const SPI_SteInv_e steinv);


extern void SPI_setSuspend(SPI_Handle spiHandle,const SPI_EmulationSuspend_e emuSuspend);


extern void SPI_setTriWire(SPI_Handle spiHandle,const SPI_TriWire_e triwire);


extern void SPI_setTxDelay(SPI_Handle spiHandle,const uint_least8_t delay);


extern void SPI_setTxFifoIntLevel(SPI_Handle spiHandle,const SPI_FifoLevel_e fifoLevel);


static inline void SPI_write(SPI_Handle spiHandle,const uint16_t data)
{
  SPI_Obj *spi = (SPI_Obj *)spiHandle;


  // set the bits
  spi->SPITXBUF = data;

  return;
} // end of SPI_write() function


static inline void SPI_write8(SPI_Handle spiHandle,const uint16_t data)
{
    SPI_Obj *spi = (SPI_Obj *)spiHandle;


    // set the bits
    spi->SPITXBUF = (data & 0xFF) << 8;

    return;
} // end of SPI_write() function

#ifdef __cplusplus
}
#endif // extern "C"

#endif // end of _SPI_H_ definition