iot_usb_host.h

Go to the documentation of this file.

/*
 * Common IO - basic V1.0.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
#ifndef _IOT_USB_HOST_H_
#define _IOT_USB_HOST_H_
 
#define IOT_USB_HOST_SUCCESS                   ( 0 ) 
#define IOT_USB_HOST_ERROR                     ( 1 ) 
#define IOT_USB_HOST_BUSY                      ( 2 ) 
#define IOT_USB_HOST_INVALID_VALUE             ( 3 ) 
#define IOT_USB_HOST_WRITE_FAIL                ( 4 ) 
#define IOT_USB_HOST_READ_FAIL                 ( 5 ) 
#define IOT_USB_HOST_CANCEL_FAILED             ( 6 ) 
#define IOT_USB_HOST_FUNCTION_NOT_SUPPORTED    ( 7 ) 
#define IOT_USB_HOST_NOTHING_TO_CANCEL         ( 8 ) 
#define IOT_USB_HOST_MAX_ENDPOINTS             ( 4 ) 
typedef enum
{
    eUSBHostAttachEvent,          
    eUSBHostDetachEvent,          
    eUSBHostEnumerationDoneEvent, 
    eUSBHostResetEvent,           
    eUSBHostSuspendEvent,         
    eUSBHostResumeEvent,          
    eUSBHostRemoteWakeEvent,      
} IotUsbHostEvent_t;
 
typedef enum
{
    eUSBHostGetHosthandle,          
    eUSBHostGetDeviceControlPipe,   
    eUSBHostGetDeviceAddress,       
    eUSBHostOpenDeviceInterface,    
    eUSBHostCloseDeviceInterface,   
    eUSBHostGetDeviceInfo,          
    eUSBHostGetInterfaceInfo,       
    eUSBHostGetInterfaceDescriptor, 
    eUSBHostGetConfigureHandle,     
    eUSBHostGetInterfaceHandle,     
} IotUsbHostIoctlRequest_t;
 
struct  IotUsbHost;
 
struct IotUsbDevice;
struct IotUsbConfiguration;
struct IotUsbInterface;
struct IotUsbPipe;
 
typedef struct IotUsbHost            * IotUsbHostHandle_t;
 
typedef struct IotUsbDevice          * IotUsbDeviceHandle_t;
 
typedef struct IotUsbConfiguration   * IotUsbConfigHandle_t;
 
typedef struct IotUsbInterface       * IotUsbInterfaceHandle_t;
 
typedef struct IotUsbPipe            * IotPipeHandle_t;
 
typedef void (* IotUsbHostCallback_t) ( IotUsbDeviceHandle_t const pxUsbDevice,
                                        IotUsbHostEvent_t xEvent,
                                        void * pvUserContext );
 
typedef void (* IotUsbHostTransferCallback_t) ( void * pvUserContext,
                                                uint8_t ucStatus );
 
typedef struct
{
    uint16_t usMaxPacketSize;  
    uint8_t ucEndpointAddress; 
    uint8_t ucTransferType;    
    uint8_t ucZlt;             
    uint8_t ucInterval;        
} IotUsbDeviceEndpointConfig_t;
 
typedef struct IotUsbInterfaceInfo
{
    IotUsbDeviceEndpointConfig_t endpoint[ IOT_USB_HOST_MAX_ENDPOINTS ]; 
    uint8_t ucInterfaceIndex;                                            
    uint8_t ucEpCount;                                                   
    uint8_t ucAlternateSettingNumber;                                    
} IotUsbInterfaceInfo_t;
 
typedef struct IotUsbConfigurationInfo
{
    IotUsbInterfaceInfo_t * pxInterface; 
    uint8_t ucInterfaceCount;            
} IotUsbConfigurationInfo_t;
 
typedef struct IotUsbDeviceInfo
{
    uint8_t ucSpeed;      
    uint8_t ucDevAddress; 
    uint16_t usPid;       
    uint16_t usVid;       
} IotUsbDeviceInfo_t;
 
IotUsbHostHandle_t iot_usb_host_open( int32_t lUsbHostControllerInstance );
 
void iot_usb_host_set_host_callback( IotUsbHostHandle_t const pxUsbHost,
                                     IotUsbHostCallback_t xCallback,
                                     void * pvUserContext );
 
void iot_usb_host_set_pipe_callback( IotUsbHostHandle_t const pxUsbHost,
                                     IotPipeHandle_t pxPipe,
                                     IotUsbHostTransferCallback_t xCallback,
                                     void * pvUserContext );
 
IotPipeHandle_t iot_usb_host_pipe_open( IotUsbHostHandle_t const pxUsbHost,
                                        uint8_t ucDevAddress,
                                        IotUsbDeviceEndpointConfig_t * pxEpConfig );
 
int32_t iot_usb_host_pipe_close( IotUsbHostHandle_t const pxUsbHost,
                                 IotPipeHandle_t pxPipe );
 
int32_t iot_usb_host_read_async( IotUsbHostHandle_t const pxUsbHost,
                                 IotPipeHandle_t pxPipe,
                                 void * const pvBuffer,
                                 size_t xBytes );
 
int32_t iot_usb_host_write_async( IotUsbHostHandle_t const pxUsbHost,
                                  IotPipeHandle_t pxPipe,
                                  void * const pvBuffer,
                                  size_t xBytes );
 
int32_t iot_usb_host_read_sync( IotUsbHostHandle_t const pxUsbHost,
                                IotPipeHandle_t pxPipe,
                                void * const pvBuffer,
                                size_t xBytes );
 
int32_t iot_usb_host_write_sync( IotUsbHostHandle_t const pxUsbHost,
                                 IotPipeHandle_t pxPipe,
                                 void * const pvBuffer,
                                 size_t xBytes );
 
int32_t iot_usb_host_cancel( IotUsbHostHandle_t const pxUsbHost,
                             IotPipeHandle_t pxPipe );
 
int32_t iot_usb_host_ioctl( IotUsbDeviceHandle_t pxUsbDevice,
                            IotUsbHostIoctlRequest_t xRequest,
                            void * const pvBuffer );
 
int32_t iot_usb_host_send_setup( IotUsbHostHandle_t const pxUsbHost,
                                 IotPipeHandle_t pxPipe,
                                 void * pvSetup,
                                 uint8_t * pucData );
 
int32_t iot_usb_host_close( IotUsbHostHandle_t const pxUsbHost );
 
/* end of group iot_usb_host */
 
#endif /* ifndef _IOT_USB_HOST_H_ */