m2mb_usb.h

Go to the documentation of this file.

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

/* Include ======================================================================================*/
/* Global declarations ==========================================================================*/
/* Global typedefs ==============================================================================*/
typedef VOID(*M2MB_USB_CB_T)( VOID* ctx, UINT32 num_bytes, VOID *data );

typedef enum M2MB_USB_CONN_STATUS_E
{
    M2MB_USB_STATUS_INIT = 0,
    M2MB_USB_STATUS_DETACHED,
    M2MB_USB_STATUS_ATTACHED
} M2MB_USB_CONN_STATUS;

typedef struct M2MB_USB_CB_CFG
{
    M2MB_USB_CB_T cb;
    VOID* ctx;
} M2MB_USB_CB_CFG_T;

typedef enum M2MB_USB_IOCTL_REQUEST_E
{
    M2MB_USB_IOCTL_SET_CFG = 0,   /* set whole usb device configuration */
    M2MB_USB_IOCTL_GET_CFG,       /* get whole usb device configuration */
    M2MB_USB_IOCTL_SET_RX_CB,     /* set usb rx callback function */
    M2MB_USB_IOCTL_GET_RX_CB,     /* get usb rx callback function */
    M2MB_USB_IOCTL_SET_TX_CB,     /* set usb tx callback function */
    M2MB_USB_IOCTL_GET_TX_CB,     /* get usb tx callback function */
    M2MB_USB_IOCTL_GET_STATUS,    /* get usb connection status */
    M2MB_USB_IOCTL_SET_READ_EXIT, /* set to exit from read mode. If there is no
    data available the read API waits for data to come and blocks the user. To 
    come out of the read, user can issue this option from another thread */
    M2MB_USB_IOCTL_SET_READ_TIMEOUT, /* set to timeout for read mode. If there 
    is no data available the read API waits for till the timeout and returns */
    M2MB_USB_IOCTL_GET_READ_TIMEOUT,
    M2MB_USB_IOCTL_NOF_REQ        /* number of m2mb usb ioctl requests */
} M2MB_USB_IOCTL_REQUEST;

typedef union M2MB_USB_IOCTL
{
    M2MB_USB_CB_CFG_T* rx_cb;
    M2MB_USB_CB_CFG_T* tx_cb;
    M2MB_USB_CONN_STATUS status;
    UINT32 read_timeout;
} M2MB_USB_IOCTL_T;

/* Global functions =============================================================================*/
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_open( HANDLE *pHandle, const char *path, int flags, ... );

/*-----------------------------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_usb_read( HANDLE pHandle, void *buf, size_t nbyte );

/*-----------------------------------------------------------------------------------------------*/
  /*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_usb_write( HANDLE pHandle, void *buf, size_t nbyte );

/*-----------------------------------------------------------------------------------------------*/
  /*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_close( HANDLE pHandle );

/*-----------------------------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------------------------*/
INT32 m2mb_usb_ioctl( HANDLE fd, INT32 request, M2MB_USB_IOCTL_T *reqData );

#endif