nm_bus_wrapper.h

Go to the documentation of this file.

#ifndef _NM_BUS_WRAPPER_H_
#define _NM_BUS_WRAPPER_H_

#include "common/include/nm_common.h"

#define  NM_BUS_TYPE_I2C        ((uint8)0)
#define  NM_BUS_TYPE_SPI        ((uint8)1)
#define  NM_BUS_TYPE_UART       ((uint8)2)

#define NM_BUS_IOCTL_R                  ((uint8)0)      
#define NM_BUS_IOCTL_W                  ((uint8)1)      
#define NM_BUS_IOCTL_W_SPECIAL  ((uint8)2)      
#define NM_BUS_IOCTL_RW                 ((uint8)3)      
#define NM_BUS_IOCTL_WR_RESTART ((uint8)4)                              
typedef struct
{
        uint16  u16MaxTrxSz;    
} tstrNmBusCapabilities;

typedef struct
{
        uint8 u8SlaveAdr;
        uint8   *pu8Buf;        
        uint16  u16Sz;          
} tstrNmI2cDefault;

typedef struct
{
        uint8 u8SlaveAdr;
        uint8   *pu8Buf1;       
        uint8   *pu8Buf2;       
        uint16  u16Sz1;         
        uint16  u16Sz2;         
} tstrNmI2cSpecial;

typedef struct
{
        uint8   *pu8InBuf;              
        uint8   *pu8OutBuf;             
        uint16  u16Sz;                  
} tstrNmSpiRw;


typedef struct
{
        uint8   *pu8Buf;        
        uint16  u16Sz;          
} tstrNmUartDefault;
extern tstrNmBusCapabilities egstrNmBusCapabilities;


#ifdef __cplusplus
     extern "C" {
 #endif

sint8 nm_bus_init(uint8 *req_com_port, uint32 req_serial_number);

sint8 nm_bus_ioctl(uint8 u8Cmd, void* pvParameter);

sint8 nm_bus_deinit(void);

/*
*       @fn                     nm_bus_reinit
*       @brief          re-initialize the bus wrapper
*       @param [in]     void *config
*                                       re-init configuration data
*       @return         ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
sint8 nm_bus_reinit(void *);
/*
*       @fn                     nm_bus_get_chip_type
*       @brief          get chip type
*       @return         ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/ 
#ifdef CONF_WINC_USE_UART
uint8 nm_bus_get_chip_type(void);
uint8 nm_bus_get_sb_type(void);
#endif

/*
*       @fn                     spi_rw
*       @brief          Process SPI Read/Write operation
*   @param      pu8Mosi TX Data buffer
*   @param      pu8Miso RX Data buffer
*   @param      u16Sz Transfer length
*       @return         ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
#ifdef CONF_WINC_USE_SPI
sint8 nm_spi_rw(uint8* pu8Mosi, uint8* pu8Miso, uint16 u16Sz);
#endif

#ifdef __cplusplus
         }
 #endif

#endif  /*_NM_BUS_WRAPPER_H_*/