usb_host_hci.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016 - 2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _USB_HOST_HCI_H_
#define _USB_HOST_HCI_H_
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define USB_HostLock() OSA_MutexLock(hostInstance->hostMutex, USB_OSA_WAIT_TIMEOUT)
#define USB_HostUnlock() OSA_MutexUnlock(hostInstance->hostMutex)
 
typedef enum _usb_host_controller_control
{
    kUSB_HostCancelTransfer = 1U,          
    kUSB_HostBusControl,                   
    kUSB_HostGetFrameNumber,               
    kUSB_HostUpdateControlEndpointAddress, 
    kUSB_HostUpdateControlPacketSize,      
    kUSB_HostPortAttachDisable,            
    kUSB_HostPortAttachEnable,             
    kUSB_HostL1Config,                     
    kUSB_HostSetChargerType,               
#if ((defined USB_HOST_CONFIG_COMPLIANCE_TEST) && (USB_HOST_CONFIG_COMPLIANCE_TEST))
    kUSB_HostTestModeInit, 
#endif
} usb_host_controller_control_t;
 
typedef enum _usb_host_bus_control
{
    kUSB_HostBusReset = 1U,    
    kUSB_HostBusRestart,       
    kUSB_HostBusEnableAttach,  
    kUSB_HostBusDisableAttach, 
    kUSB_HostBusSuspend,       
    kUSB_HostBusResume,        
    kUSB_HostBusL1SuspendInit, 
    kUSB_HostBusL1Sleep,       
    kUSB_HostBusL1Resume,      
} usb_host_bus_control_t;
 
typedef struct _usb_host_controller_interface
{
    usb_status_t (*controllerCreate)(
        uint8_t controllerId,
        usb_host_handle upperLayerHandle,
        usb_host_controller_handle *controllerHandle); 
    usb_status_t (*controllerDestory)(
        usb_host_controller_handle controllerHandle); 
    usb_status_t (*controllerOpenPipe)(usb_host_controller_handle controllerHandle,
                                       usb_host_pipe_handle *pipeHandle,
                                       usb_host_pipe_init_t *pipeInit); 
    usb_status_t (*controllerClosePipe)(
        usb_host_controller_handle controllerHandle,
        usb_host_pipe_handle pipeHandle); 
    usb_status_t (*controllerWritePipe)(usb_host_controller_handle controllerHandle,
                                        usb_host_pipe_handle pipeHandle,
                                        usb_host_transfer_t *transfer); 
    usb_status_t (*controllerReadPipe)(usb_host_controller_handle controllerHandle,
                                       usb_host_pipe_handle pipeHandle,
                                       usb_host_transfer_t *transfer); 
    usb_status_t (*controllerIoctl)(usb_host_controller_handle controllerHandle,
                                    uint32_t ioctlEvent,
                                    void *ioctlParam); 
} usb_host_controller_interface_t;
#if ((defined USB_HOST_CONFIG_COMPLIANCE_TEST) && (USB_HOST_CONFIG_COMPLIANCE_TEST))
usb_status_t USB_HostTestModeInit(usb_device_handle deviceHandle);
#endif
typedef struct _usb_host_instance
{
    void *controllerHandle;                                          
    host_callback_t deviceCallback;                                  
    osa_mutex_handle_t hostMutex;                                    
    uint32_t mutexBuffer[(OSA_MUTEX_HANDLE_SIZE + 3) / 4];           
    usb_host_transfer_t transferList[USB_HOST_CONFIG_MAX_TRANSFERS]; 
    usb_host_transfer_t *transferHead;                               
    const usb_host_controller_interface_t *controllerTable;          
    void *deviceList;                                                
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
    void *suspendedDevice;    
    volatile uint64_t hwTick; 
    uint8_t sleepType;        
#endif
    uint8_t addressBitMap[16]; 
    uint8_t occupied;          
    uint8_t controllerId;      
} usb_host_instance_t;
 
extern usb_host_instance_t g_UsbHostInstance[USB_HOST_CONFIG_MAX_HOST];
#endif /* _USB_HOST_HCI_H_ */