m2mb_spi_frame.h

Go to the documentation of this file.

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

/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif

/* Global enums ==============================================================================*/


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

/* SPI Frame callback.
   This type defines the SPI frame callback prototype.
*/
typedef void (*M2MB_SPI_FRAME_DATA_RECV_T)( VOID* ctx, UINT8* data, 
    UINT32 length );
        
/* SPI Frame configuration.
   This type defines the SPI frame configuration structure.
*/      
typedef struct M2MB_SPI_FRAME_CFG_S
{
    UINT32 gpio_no;                                     
    UINT8  role;                                        
    UINT16 max_frame_size;                              
    M2MB_SPI_FRAME_DATA_RECV_T rcb;     
    VOID* ctx;                                                  
}M2MB_SPI_FRAME_CFG_T;


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

/*-----------------------------------------------------------------------------------------------*/
/* m2mb_spi_fmt_init:
   description:
     Initialize the SPI Framing module
   arguments:
     h: Handle returned by m2mb_spi_fmt_init
         spi: Handle of the SPI driver opened by user.
         pCfg: Pointer to the configuration structure.
     
   return:
     0 on SUCCESS
     -1 on FAILURE   
*/
INT32 m2mb_spi_fmt_init( HANDLE *h, HANDLE spi, M2MB_SPI_FRAME_CFG_T *pCfg );

/*-----------------------------------------------------------------------------------------------*/
/* m2mb_spi_fmt_read:
   description:
     Read user data from SPI
   arguments:
     h: Handle given in m2mb_spi_fmt_init
         len: Pointer to the length field. This is filled by the module 
   return:
     Pointer to the buffer when data is received.
   note: This API will block the user till it received data over SPI.    
*/
UINT8* m2mb_spi_fmt_read( HANDLE h, UINT32* len );

/*-----------------------------------------------------------------------------------------------*/
/* m2mb_spi_fmt_write:
   description:
     Write over SPI
   arguments:
     h: Handle given in m2mb_spi_fmt_init
         buf: Pointer to the buffer containing data that has to be sent.
         length: Length of the data to be sent  
   return:
     0 on SUCCESS
    -1 on FAILURE
*/
INT32 m2mb_spi_fmt_write( HANDLE h, UINT8* buf, UINT32 length );


#endif  /* M2M_M2MB_SPI_FMT_API_H */