iot_usb_device.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 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_DEVICE_H_
#define _IOT_USB_DEVICE_H_

#define IOT_USB_DEVICE_SUCCESS                   ( 0 )     
#define IOT_USB_DEVICE_ERROR                     ( 1 )     
#define IOT_USB_DEVICE_BUSY                      ( 2 )     
#define IOT_USB_DEVICE_INVALID_VALUE             ( 3 )     
#define IOT_USB_DEVICE_WRITE_FAILED              ( 4 )     
#define IOT_USB_DEVICE_READ_FAILED               ( 5 )     
#define IOT_USB_DEVICE_FUNCTION_NOT_SUPPORTED    ( 6 )     
#define IOT_USB_DEVICE_NOTHING_TO_CANCEL         ( 7 )     
#define IOT_USB_CONTROL_ENDPOINT (0U)

#define IOT_USB_SETUP_PACKET_SIZE (8U)

#define IOT_USB_ENDPOINT_NUMBER_MASK (0x0FU)

#define IOT_USB_UNINITIALIZED_VAL_32 (0xFFFFFFFFU)

typedef enum
{
    eUSBDeviceBusResetEvent,           
    eUSBDeviceLPMState1Event,          
    eUSBDeviceLPMState2Event,          
    eUSBDeviceLPMState3Event,          
    eUSBDeviceLPMState1ResumeEvent,    
    eUSBDeviceLPMState2ResumeEvent,    
    eUSBDeviceLPMState3ResumeEvent,    
    eUSBDeviceErrorEvent,              
    eUSBDeviceDetachEvent,             
    eUSBDeviceAttachEvent,             
} IotUsbDeviceEvent_t;

typedef enum
{
    eUSBDeviceGetSpeed,          
    eUSBDeviceGetAddress,        
    eUSBDeviceSetAddress,        
    eUSBDeviceGetEndpointStatus, 
    eUSBDeviceGetState,          
    eUSBDeviceGetStatus,         
    eUSBDeviceGetSyncFrame,      
    eUSBDeviceSetTestMode,       
    eUSBDeviceSetState,          
    eUSBDeviceLPMState1Suspend,  
    eUSBDeviceLPMState1Resume,   
    eUSBDeviceLPMState2Suspend,  
    eUSBDeviceLPMState2Resume,   
    eUSBDeviceLPMState3Suspend,  
    eUSBDeviceLPMState3Resume,   
    eUSBDeviceRemoteWakeup,      
} IotUsbDeviceIoctlRequest_t;

typedef enum
{
    eUsbDeviceStateConfigured,        
    eUsbDeviceStateAddress,           
    eUsbDeviceStateDefault,           
    eUsbDeviceStateAddressing,        
    eUsbDeviceStateTestMode,          
} IotUsbDeviceState_t;

typedef enum
{
    eUsbDeviceEndpointStateIdle,      
    eUsbDeviceEndpointStateStalled,   
    eUsbDeviceEndpointStateBusy,      
    eUsbDeviceEndpointStateClosed,    
} IotUsbDeviceEndpointStatus_t;

typedef enum
{
    eUsbDeviceControllerOHCI,      
    eUsbDeviceControllerUHCI,      
    eUsbDeviceControllerEHCI,      
    eUsbDeviceControllerXHCI,      
} IotUsbHostController_t;

typedef enum
{
    eUsbDeviceCompleted = IOT_USB_DEVICE_SUCCESS,         
    eUsbDeviceReadFailed = IOT_USB_DEVICE_READ_FAILED,    
    eUsbDeviceWriteFailed = IOT_USB_DEVICE_WRITE_FAILED,  
} IotUsbDeviceOperationStatus_t;

struct IotUsbDevice;

typedef struct IotUsbDevice * IotUsbDeviceHandle_t;

typedef int32_t (*IotUsbDeviceCallback_t) ( IotUsbDeviceHandle_t const pxUsbDevice, uint32_t ulDeviceEvent, void * pvUserContext );

typedef int32_t (* IotUsbDeviceEndpointCallbackFn_t) ( IotUsbDeviceOperationStatus_t xStatus, void * pvUserContext );

typedef struct
{
    uint16_t usMaxPacketSize;  
    uint8_t ucEndpointAddress; 
    uint8_t ucTransferType;    
    uint8_t ucZlt;             
    uint8_t ucInterval;        
} IotUsbDeviceEndpointConfig_t;

typedef struct
{
    uint8_t ucEndpointAddress; 
    uint16_t usEndpointStatus; 
} IotUsbDeviceEndpointInfo_t;

IotUsbDeviceHandle_t iot_usb_device_open( int32_t lUsbDeviceControllerInstance );

int32_t iot_usb_device_connect( IotUsbDeviceHandle_t const pxUsbDevice );

int32_t iot_usb_device_disconnect( IotUsbDeviceHandle_t const pxUsbDevice );

void iot_usb_device_set_device_callback( IotUsbDeviceHandle_t const pxUsbDevice,
                           IotUsbDeviceCallback_t xCallback,
                           void * pvUserContext );

int32_t iot_usb_device_endpoint_open( IotUsbDeviceHandle_t const pxUsbDevice,
                                      IotUsbDeviceEndpointConfig_t * pxEpConfig);

void iot_usb_device_set_endpoint_callback( IotUsbDeviceHandle_t const pxUsbDevice,
                           uint8_t ucEndpointAddress, IotUsbDeviceEndpointCallbackFn_t xCallback,
                           void * pvUserContext );

int32_t iot_usb_device_endpoint_close( IotUsbDeviceHandle_t const pxUsbDevice,
                                          uint8_t ucEndpointAddress );

int32_t iot_usb_device_endpoint_stall( IotUsbDeviceHandle_t const pxUsbDevice,
                                          uint8_t ucEndpointAddress );

int32_t iot_usb_device_endpoint_unstall( IotUsbDeviceHandle_t const pxUsbDevice,
                                          uint8_t ucEndpointAddress );

int32_t iot_usb_device_read_sync( IotUsbDeviceHandle_t const pxUsbDevice,
                            uint8_t ucEndpointAddress,
                            uint8_t * const pvBuffer,
                            size_t xBytes );

int32_t iot_usb_device_write_sync( IotUsbDeviceHandle_t const pxUsbDevice,
                            uint8_t ucEndpointAddress,
                            uint8_t * const pvBuffer,
                            size_t xBytes );

int32_t iot_usb_device_read_async( IotUsbDeviceHandle_t const pxUsbDevice,
                            uint8_t ucEndpointAddress,
                            uint8_t * const pvBuffer,
                            size_t xBytes );

int32_t iot_usb_device_write_async( IotUsbDeviceHandle_t const pxUsbDevice,
                            uint8_t ucEndpointAddress,
                            uint8_t * const pvBuffer,
                            size_t xBytes );

int32_t iot_usb_device_ioctl( IotUsbDeviceHandle_t const pxUsbDevice,
                       IotUsbDeviceIoctlRequest_t xUsbDeviceRequest,
                       void * const pvBuffer );

int32_t iot_usb_device_endpoint_cancel_transfer( IotUsbDeviceHandle_t const pxUsbDevice, uint8_t ucEndpointAddress );

int32_t iot_usb_device_close( IotUsbDeviceHandle_t const pxUsbDevice );

/* end of group iot_usb_device */

#endif /* ifndef _IOT_USB_DEVICE_H_ */