m2mb_spi_master.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_SPI_API_H
#define M2M_M2MB_SPI_API_H

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/
#define M2MB_SPI_CLKPOL_IDLE_LOW  0     
#define M2MB_SPI_CLKPOL_IDLE_HIGH 1     
#define M2MB_SPI_CLKPHASE_RISING_EDGE  0        
#define M2MB_SPI_CLKPHASE_FALLING_EDGE 1        
#define M2MB_SPI_BITS_PER_WORD_8  8     
#define M2MB_SPI_BAUD_RATE_10MHZ  10000000      
/* Global enums ==============================================================================*/

typedef enum M2MB_SPI_IOCTL_REQUEST
{
  M2MB_SPI_IOCTL_SET_CFG = 0,                 
  M2MB_SPI_IOCTL_GET_CFG,                     
  M2MB_SPI_IOCTL_SET_SHIFT_MODE,              
  M2MB_SPI_IOCTL_GET_SHIFT_MODE,              
  M2MB_SPI_IOCTL_SET_CS_POLARITY,             
  M2MB_SPI_IOCTL_GET_CS_POLARITY,             
  M2MB_SPI_IOCTL_SET_CS_MODE,                 
  M2MB_SPI_IOCTL_GET_CS_MODE,                 
  M2MB_SPI_IOCTL_SET_BYTE_ORDER,              
  M2MB_SPI_IOCTL_GET_BYTE_ORDER,              
  M2MB_SPI_IOCTL_SET_CALLBACK_FN,             
  M2MB_SPI_IOCTL_GET_CALLBACK_FN,             
  M2MB_SPI_IOCTL_SET_CALLBACK_CTXT,           
  M2MB_SPI_IOCTL_GET_CALLBACK_CTXT,           
  M2MB_SPI_IOCTL_SET_CLK_FREQ_HZ,             
  M2MB_SPI_IOCTL_GET_CLK_FREQ_HZ,             
  M2MB_SPI_IOCTL_SET_BITS_PER_WORD,           
  M2MB_SPI_IOCTL_GET_BITS_PER_WORD,           
  M2MB_SPI_IOCTL_SET_CS_CLK_DELAY_CYCLES,     
  M2MB_SPI_IOCTL_GET_CS_CLK_DELAY_CYCLES,     
  M2MB_SPI_IOCTL_SET_INTER_WORD_DELAY_CYCLES, 
  M2MB_SPI_IOCTL_GET_INTER_WORD_DELAY_CYCLES, 
  M2MB_SPI_IOCTL_SET_LOOPBACK_MODE,           
  M2MB_SPI_IOCTL_GET_LOOPBACK_MODE,           
  M2MB_SPI_IOCTL_NOF_REQ                      
} M2MB_SPI_IOCTL_REQUEST_T;

/* Global typedefs ==============================================================================*/

/* SPI phase type.
 * This type defines the clock phase that the client can set in the 
 * SPI configuration.
 */
typedef enum 
{
  M2MB_SPI_MODE_0,  
  M2MB_SPI_MODE_1,  
  M2MB_SPI_MODE_2,  
  M2MB_SPI_MODE_3,  
  M2MB_SPI_MODE_INVALID = 0x7FFFFFFF
} M2MB_SPI_SHIFT_MODE_T;

/* SPI chip select polarity type.
 */
typedef enum 
{
  M2MB_SPI_CS_ACTIVE_LOW,   
  M2MB_SPI_CS_ACTIVE_HIGH,  
  M2MB_SPI_CS_ACTIVE_INVALID = 0x7FFFFFFF
} M2MB_SPI_CS_POLARITY_T;

/* SPI clock mode
 */
typedef enum 
{
  M2MB_SPI_CLK_NORMAL,          
  M2MB_SPI_CLK_ALLWAYS_ON,  
  M2MB_SPI_CLK_INVALID = 0x7FFFFFFF
} M2MB_SPI_CLK_MODE_T;

/* SPI chip select assertion type.
 * This type defines how the chip select line is configured between N word cycles.
 */
typedef enum 
{
  M2MB_SPI_CS_DEASSERT,        
  M2MB_SPI_CS_KEEP_ASSERTED,   
  M2MB_SPI_CS_MODE_INVALID = 0x7FFFFFFF
} M2MB_SPI_CS_MODE_T;

/* Order in which bytes from Tx/Rx buffer words are put on the bus.
 */
typedef enum
{
  M2MB_SPI_NATIVE = 0,         
  M2MB_SPI_LITTLE_ENDIAN = 0,  
  M2MB_SPI_BIG_ENDIAN,         
  M2MB_SPI_BYTE_ORDER_INVALID = 0x7FFFFFFF
} M2MB_SPI_BYTE_ORDER_T;

/* SPI callback function type.
 * This type is used by the client to register its callback notification function. The 
 * callback_ctxt is the context object that will be passed untouched by the SPI Master
 * driver to help the client identify which transfer completion instance is being signaled.
 */
typedef void (*M2MB_SPI_CALLBACK_FN_T) (UINT32 status, void *callback_ctxt);

/* SPI access ID*/
typedef void* M2MB_SPI_ID_t;

/* SPI configuration.
 * The SPI configuration is the collection of settings specified for each SPI
 * transfer call to select the various possible SPI transfer parameters.
 */
typedef struct
{
  M2MB_SPI_ID_t                         accessId;                               
  M2MB_SPI_SHIFT_MODE_T         spi_mode;                       
  M2MB_SPI_CS_POLARITY_T        cs_polarity;                    
  M2MB_SPI_CS_MODE_T            cs_mode;                        
  M2MB_SPI_CLK_MODE_T           clk_mode;                               
  M2MB_SPI_BYTE_ORDER_T         endianness;                     
  M2MB_SPI_CALLBACK_FN_T        callback_fn;                    
  HANDLE                                        callback_ctxt;          
  UINT32                                        clk_freq_Hz;            
  UINT32                                        bits_per_word;          
  UINT32                                        cs_clk_delay_cycles;    
  UINT32                                        inter_word_delay_cycles;
  UINT32                                        loopback_mode;          
} M2MB_SPI_CFG_T;

/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_spi_open( const CHAR *path, INT32 flags, ... );
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_spi_close( INT32 fd );
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_spi_ioctl( INT32 fd, M2MB_SPI_IOCTL_REQUEST_T request, ... );

/*-----------------------------------------------------------------------------------------------*/
#ifdef WE310_BUILD_GCC
SSIZE_T m2mb_spi_read( INT32 fd, void *buf, INT32 nbyte );
#else
SSIZE_T m2mb_spi_read( INT32 fd, void *buf, SIZE_T nbyte );
#endif
/*-----------------------------------------------------------------------------------------------*/
#ifdef WE310_BUILD_GCC
SSIZE_T m2mb_spi_write( INT32 fd, const void *buf, INT32 nbyte );
#else
SSIZE_T m2mb_spi_write( INT32 fd, const void *buf, SIZE_T nbyte );
#endif
/*-----------------------------------------------------------------------------------------------*/
#ifdef WE310_BUILD_GCC
SSIZE_T m2mb_spi_write_read( INT32 fd, const void *bufwr, void *bufWr, INT32 nbyte );
#else
SSIZE_T m2mb_spi_write_read( INT32 fd, const void *bufwr, void *bufWr, SIZE_T nbyte );
#endif

/*-----------------m2mb_spi_write_read------------------------------------------------------------------------------*/


#ifdef __cplusplus
}
#endif

#endif  /* M2M_M2MB_SPI_API_H */