csl_spi.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 22-Aug-2008 Created
 * ============================================================================
 */

#ifndef _CSL_SPI_H_
#define _CSL_SPI_H_


#ifdef __cplusplus
extern "C" {
#endif

#include "soc.h"
#include "csl_error.h"
#include "csl_types.h"
#include "csl_general.h"

/*****************************************************************************\
*         I2S global macro declarations
\*****************************************************************************/
#define CSL_SPI_SPICR1_FIRQ_DISABLE         (Uint16)0

#define CSL_SPI_SPICR1_FIRQ_ENABLE          (Uint16)1

#define SPI_READ_CMD                        (Uint16)1

#define SPI_WRITE_CMD                       (Uint16)2

#define SPI_DISABLE                         (0)

#define SPI_ENABLE                          (1)

#define SPI_ACTIVE                          (0)

/**************************************************************************\
* I2S global enum declaration                                             *
\**************************************************************************/
typedef enum
{
    SPI_CS_NUM_0,           
    SPI_CS_NUM_1,           
    SPI_CS_NUM_2,           
    SPI_CS_NUM_3,           
    SPI_CS_NUM_INVALID      
}SPI_HwMode;

typedef enum
{
    SPI_WORD_LENGTH_1 = 0,      
    SPI_WORD_LENGTH_2,          
    SPI_WORD_LENGTH_3,          
    SPI_WORD_LENGTH_4,          
    SPI_WORD_LENGTH_5,          
    SPI_WORD_LENGTH_6,          
    SPI_WORD_LENGTH_7,          
    SPI_WORD_LENGTH_8,          
    SPI_WORD_LENGTH_9,          
    SPI_WORD_LENGTH_10,         
    SPI_WORD_LENGTH_11,         
    SPI_WORD_LENGTH_12,         
    SPI_WORD_LENGTH_13,         
    SPI_WORD_LENGTH_14,         
    SPI_WORD_LENGTH_15,         
    SPI_WORD_LENGTH_16,         
    SPI_WORD_LENGTH_17,         
    SPI_WORD_LENGTH_18,         
    SPI_WORD_LENGTH_19,         
    SPI_WORD_LENGTH_20,         
    SPI_WORD_LENGTH_21,         
    SPI_WORD_LENGTH_22,         
    SPI_WORD_LENGTH_23,         
    SPI_WORD_LENGTH_24,         
    SPI_WORD_LENGTH_25,         
    SPI_WORD_LENGTH_26,         
    SPI_WORD_LENGTH_27,         
    SPI_WORD_LENGTH_28,         
    SPI_WORD_LENGTH_29,         
    SPI_WORD_LENGTH_30,         
    SPI_WORD_LENGTH_31,         
    SPI_WORD_LENGTH_32,         
    SPI_MAX_WORD_LEN            
}SPI_WordLen;

typedef enum
{
    SPI_WORD_IRQ_DISABLE,       
    SPI_WORD_IRQ_ENABLE         
}SPI_WordCntEnb;

typedef enum
{
    SPI_FRAME_IRQ_DISABLE,      
    SPI_FRAME_IRQ_ENABLE        
}SPI_FrameCntEnb;

typedef enum SPI_Command
{
    SPI_RSVD_CMD = 0,           
    SPI_READ,                   
    SPI_WRITE,                  
    SPI_RSVD1_CMD               
} SPI_Command;

typedef enum
{
    SPI_DATA_DLY_0 = 0,         
    SPI_DATA_DLY_1,             
    SPI_DATA_DLY_2,             
    SPI_DATA_DLY_3,             
    SPI_DATA_DLY_UNKNOWN        
} SPI_DataDly;

typedef enum
{
    SPI_CLKP_LOW_AT_IDLE = 0,   
    SPI_CLKP_HIGH_AT_IDLE       
}SPI_ClkPolarity;

typedef enum
{
    SPI_CSP_ACTIVE_LOW = 0,     
    SPI_CSP_ACTIVE_HIGH         
} SPI_ChipSelPol;

typedef enum
{
    SPI_CLK_PH_FALL_EDGE = 0,   
    SPI_CLK_PH_RISE_EDGE        
} SPI_ClkPh;

typedef enum
{
    SPI_POLLING_MODE,   
    SPI_INTERRUPT_MODE      
}SPI_OperMode;
/**************************************************************************\
*               SPI global data structures                                *
\**************************************************************************/
typedef struct
{
    Uint16          configured;     
    SPI_HwMode      mode;           
    SPI_OperMode    opMode;         
}CSL_SpiObj;

typedef struct
{
    Uint16              spiClkDiv;  
    SPI_WordLen         wLen;       
    Uint16              frLen;      
    SPI_WordCntEnb      wcEnable;   
    SPI_FrameCntEnb     fcEnable;   
    SPI_HwMode          csNum;      
    SPI_DataDly         dataDelay;  
    SPI_ClkPolarity     clkPol;     
    SPI_ChipSelPol      csPol;      
    SPI_ClkPh           clkPh;      
}SPI_Config;

typedef CSL_SpiObj *CSL_SpiHandle;
/*****************************************************************************\
 * SPI function declarations                                                  *
\*****************************************************************************/

CSL_Status SPI_init(void);

CSL_Status SPI_deInit(void);

CSL_SpiHandle SPI_open(SPI_HwMode   csNum, SPI_OperMode opMode);

CSL_Status SPI_close(CSL_SpiHandle hSpi);

CSL_Status SPI_config   (CSL_SpiHandle hSpi, SPI_Config     *spiHwConfig);

CSL_Status SPI_read (CSL_SpiHandle hSpi, Uint16 *readBuffer, Uint16 bufLen);

CSL_Status SPI_write    (CSL_SpiHandle hSpi, Uint16 *writeBuffer, Uint16    bufLen);

CSL_Status SPI_dataTransaction(CSL_SpiHandle hSpi,
                                Uint16       *rwBuffer,
                                Uint16       rwBufLen,
                                SPI_Command  readOrWrite);

/*****************************************************************************\
 * SPI Global variable                                                   *
\*****************************************************************************/
static CSL_SpiObj   SPI_Instance;
#ifdef __cplusplus
}
#endif
#endif /* _CSL_SPI_H_ */