m2mb_usb.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_USB_API_H
#define M2M_M2MB_USB_API_H
 
/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif
 
/* defines used to check if USB cable is connected or not */
#define M2MB_USB_CABLE_ATTACHED  TRUE
#define M2MB_USB_CABLE_DETACHED  FALSE
 
 
/* Global enums ==============================================================================*/
 
typedef enum
{
  M2MB_USB_IOCTL_SET_CFG = 0,     
  M2MB_USB_IOCTL_GET_CFG,         
  M2MB_USB_IOCTL_SET_CB,          
  M2MB_USB_IOCTL_GET_CB,          
  M2MB_USB_IOCTL_SET_USERDATA,    
  M2MB_USB_IOCTL_GET_USERDATA,    
  M2MB_USB_IOCTL_SET_DCD,         
  M2MB_USB_IOCTL_GET_RTS_STATE,   
  M2MB_USB_IOCTL_GET_DTR_STATE,   
  M2MB_USB_IOCTL_GET_CABLE_STATE, 
  M2MB_USB_IOCTL_SET_DTR_FCTL,    
  M2MB_USB_IOCTL_GET_DTR_FCTL,    
  M2MB_USB_IOCTL_SET_DSR,         
  M2MB_USB_IOCTL_SET_RING,        
  M2MB_USB_IOCTL_SET_TX_TIMEOUT,  
  M2MB_USB_IOCTL_GET_TX_TIMEOUT,  
  M2MB_USB_IOCTL_SET_RX_TIMEOUT,  
  M2MB_USB_IOCTL_GET_RX_TIMEOUT,  
  M2MB_USB_IOCTL_NOF_REQ,
  ENUM_TO_INT( M2MB_USB_IOCTL_REQUEST )
} M2MB_USB_IOCTL_REQUEST;
 
/* Global typedefs ==============================================================================*/
 
typedef enum
{
  M2MB_USB_RX_EVENT,               
  M2MB_USB_TX_EVENT,               
  M2MB_USB_CABLE_CONNECTED_EVENT,  
  M2MB_USB_DTR_EVENT,              
  ENUM_TO_INT( M2MB_USB_IND_E )
} M2MB_USB_IND_E;
 
typedef enum
{
  M2MB_USB_LOW_VALUE,                   
  M2MB_USB_HIGH_VALUE,                  
  ENUM_TO_INT( M2MB_USB_SIGNAL_VALUE_E )
} M2MB_USB_SIGNAL_VALUE_E;
 
typedef void ( *m2mb_usb_ind_callback )( INT32 fd, M2MB_USB_IND_E usb_event, UINT16 resp_size, void *resp_struct, void *userdata );
 
typedef struct
{
  m2mb_usb_ind_callback m2mb_usb_app_cb_func; 
  void *userData;                             
} M2MB_USB_CFG_T;
 
typedef struct M2MB_USB_HANDLE_TAG *M2MB_USB_HANDLE;
 
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_open( const CHAR *path, INT32 flags, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_close( INT32 fd );
 
/*-----------------------------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_ioctl( INT32 fd, INT32 request, ... );
 
/*-----------------------------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_usb_read( INT32 fd, void *buf, SIZE_T nbyte );
 
/*-----------------------------------------------------------------------------------------------*/
  /*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_usb_write( INT32 fd, const void *buf, SIZE_T nbyte );
 
 
/*-----------------------------------------------------------------------------------------------*/
  /*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_usb_isCableAttached( const CHAR *path );
 
 
#endif  /* M2M_M2MB_USB_API_H */