usb_host_ehci.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016,2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _USB_HOST_CONTROLLER_EHCI_H_
#define _USB_HOST_CONTROLLER_EHCI_H_
 
/*******************************************************************************
 * KHCI private public structures, enumerations, macros, functions
 ******************************************************************************/
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
/* EHCI host macros */
#define EHCI_HOST_T_INVALID_VALUE      (1U)
#define EHCI_HOST_POINTER_TYPE_ITD     (0x00U)
#define EHCI_HOST_POINTER_TYPE_QH      (0x00000002U)
#define EHCI_HOST_POINTER_TYPE_SITD    (0x00000004U)
#define EHCI_HOST_POINTER_TYPE_FSTN    (0x00000006U)
#define EHCI_HOST_POINTER_TYPE_MASK    (0x00000006U)
#define EHCI_HOST_POINTER_ADDRESS_MASK (0xFFFFFFE0U)
#define EHCI_HOST_PID_OUT              (0UL)
#define EHCI_HOST_PID_IN               (1UL)
#define EHCI_HOST_PID_SETUP            (2UL)
 
#define EHCI_HOST_QH_RL_SHIFT                  (28U)
#define EHCI_HOST_QH_RL_MASK                   (0xF0000000U)
#define EHCI_HOST_QH_C_SHIFT                   (27U)
#define EHCI_HOST_QH_MAX_PACKET_LENGTH_SHIFT   (16U)
#define EHCI_HOST_QH_MAX_PACKET_LENGTH_MASK    (0x07FF0000U)
#define EHCI_HOST_QH_H_SHIFT                   (15U)
#define EHCI_HOST_QH_DTC_SHIFT                 (14U)
#define EHCI_HOST_QH_EPS_SHIFT                 (12U)
#define EHCI_HOST_QH_ENDPT_SHIFT               (8U)
#define EHCI_HOST_QH_I_SHIFT                   (7U)
#define EHCI_HOST_QH_DEVICE_ADDRESS_SHIFT      (0U)
#define EHCI_HOST_QH_MULT_SHIFT                (30U)
#define EHCI_HOST_QH_PORT_NUMBER_SHIFT         (23U)
#define EHCI_HOST_QH_HUB_ADDR_SHIFT            (16U)
#define EHCI_HOST_QH_UFRAME_CMASK_SHIFT        (8U)
#define EHCI_HOST_QH_UFRAME_SMASK_SHIFT        (0U)
#define EHCI_HOST_QH_STATUS_ERROR_MASK         (0x0000007EU)
#define EHCI_HOST_QH_STATUS_NOSTALL_ERROR_MASK (0x0000003EU)
 
#define EHCI_HOST_QTD_DT_SHIFT                (31U)
#define EHCI_HOST_QTD_DT_MASK                 (0x80000000U)
#define EHCI_HOST_QTD_TOTAL_BYTES_SHIFT       (16U)
#define EHCI_HOST_QTD_TOTAL_BYTES_MASK        (0x7FFF0000U)
#define EHCI_HOST_QTD_IOC_MASK                (0x00008000U)
#define EHCI_HOST_QTD_C_PAGE_SHIFT            (12U)
#define EHCI_HOST_QTD_CERR_SHIFT              (10U)
#define EHCI_HOST_QTD_CERR_MAX_VALUE          (0x00000003UL)
#define EHCI_HOST_QTD_PID_CODE_SHIFT          (8U)
#define EHCI_HOST_QTD_STATUS_SHIFT            (0U)
#define EHCI_HOST_QTD_CURRENT_OFFSET_MASK     (0x00000FFFU)
#define EHCI_HOST_QTD_BUFFER_POINTER_SHIFT    (12U)
#define EHCI_HOST_QTD_STATUS_ACTIVE_MASK      (0x00000080U)
#define EHCI_HOST_QTD_STATUS_MASK             (0x000000ffU)
#define EHCI_HOST_QTD_STATUS_ERROR_MASK       (0x0000007EU)
#define EHCI_HOST_QTD_STATUS_STALL_ERROR_MASK (0x00000040U)
 
#define EHCI_HOST_ITD_STATUS_ACTIVE_MASK       (0x80000000U)
#define EHCI_HOST_ITD_TRANSACTION_LEN_SHIFT    (16U)
#define EHCI_HOST_ITD_TRANSACTION_LEN_MASK     (0x0FFF0000U)
#define EHCI_HOST_ITD_IOC_SHIFT                (15U)
#define EHCI_HOST_ITD_PG_SHIFT                 (12U)
#define EHCI_HOST_ITD_TRANSACTION_OFFSET_SHIFT (0U)
#define EHCI_HOST_ITD_TRANSACTION_OFFSET_MASK  (0x00000FFFU)
#define EHCI_HOST_ITD_BUFFER_POINTER_SHIFT     (12U)
#define EHCI_HOST_ITD_ENDPT_SHIFT              (8U)
#define EHCI_HOST_ITD_DEVICE_ADDRESS_SHIFT     (0U)
#define EHCI_HOST_ITD_MAX_PACKET_SIZE_SHIFT    (0U)
#define EHCI_HOST_ITD_MULT_SHIFT               (0U)
#define EHCI_HOST_ITD_DIRECTION_SHIFT          (11U)
 
#define EHCI_HOST_SITD_STATUS_ACTIVE_MASK   (0x00000080U)
#define EHCI_HOST_SITD_DIRECTION_SHIFT      (31U)
#define EHCI_HOST_SITD_PORT_NUMBER_SHIFT    (24U)
#define EHCI_HOST_SITD_HUB_ADDR_SHIFT       (16U)
#define EHCI_HOST_SITD_ENDPT_SHIFT          (8U)
#define EHCI_HOST_SITD_DEVICE_ADDRESS_SHIFT (0U)
#define EHCI_HOST_SITD_CMASK_SHIFT          (8U)
#define EHCI_HOST_SITD_SMASK_SHIFT          (0U)
#define EHCI_HOST_SITD_TOTAL_BYTES_SHIFT    (16U)
#define EHCI_HOST_SITD_TOTAL_BYTES_MASK     (0x03FF0000U)
#define EHCI_HOST_SITD_TP_SHIFT             (3U)
#define EHCI_HOST_SITD_TCOUNT_SHIFT         (0U)
#define EHCI_HOST_SITD_IOC_SHIFT            (31U)
 
/* register related MACROs */
#define EHCI_PORTSC1_W1_BITS  (0x0000002AU)
#define EHCI_MAX_UFRAME_VALUE (0x00003FFFU)
 
/* task event */
#define EHCI_TASK_EVENT_DEVICE_ATTACH    (0x01U)
#define EHCI_TASK_EVENT_TRANSACTION_DONE (0x02U)
#define EHCI_TASK_EVENT_DEVICE_DETACH    (0x04U)
#define EHCI_TASK_EVENT_PORT_CHANGE      (0x08U)
#define EHCI_TASK_EVENT_TIMER0           (0x10U)
#define EHCI_TASK_EVENT_TIMER1           (0x20U)
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
#if ((defined(USB_HOST_CONFIG_LPM_L1)) && (USB_HOST_CONFIG_LPM_L1 > 0U))
#define EHCI_TASK_EVENT_HOST_COMPLETED_LPM  (0x40U)
#endif
#endif
 
#define USB_HostEhciLock()   (void)OSA_MutexLock(ehciInstance->ehciMutex, USB_OSA_WAIT_TIMEOUT)
#define USB_HostEhciUnlock() (void)OSA_MutexUnlock(ehciInstance->ehciMutex)
 
/*******************************************************************************
 * KHCI driver public structures, enumerations, macros, functions
 ******************************************************************************/
 
#define USB_HOST_EHCI_ISO_NUMBER USB_HOST_CONFIG_EHCI_MAX_ITD
#define USB_HOST_EHCI_PORT_CONNECT_DEBOUNCE_DELAY (101U)
#define USB_HOST_EHCI_PORT_RESET_DELAY (11U)
#define USB_HOST_EHCI_ISO_MAX_CONTINUOUS_TRANSFER (8U)
#define USB_HOST_EHCI_ISO_BOUNCE_FRAME_NUMBER (2U)
#define USB_HOST_EHCI_ISO_BOUNCE_UFRAME_NUMBER (16U)
#define USB_HOST_EHCI_CONTROL_BULK_TIME_OUT_VALUE (50U)
 
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
typedef enum _bus_ehci_suspend_request_state
{
    kBus_EhciIdle = 0U,
    kBus_EhciStartSuspend,
    kBus_EhciSuspended,
    kBus_EhciStartResume,
    kBus_EhciL1StartSleep,
    kBus_EhciL1Sleeped,
    kBus_EhciL1StartResume,
    kBus_EhciHsError,
} bus_ehci_suspend_request_state_t;
#endif
 
typedef enum _host_ehci_device_state_
{
    kEHCIDevicePhyAttached = 1, 
    kEHCIDeviceAttached,        
    kEHCIDeviceDetached,        
} host_ehci_device_state_t;
 
typedef struct _usb_host_ehci_pipe
{
    usb_host_pipe_t pipeCommon; 
    void *ehciQh;               
    /* bandwidth */
    uint16_t uframeInterval;    
    uint16_t startFrame;        
    uint16_t dataTime;          
    uint16_t startSplitTime;    
    uint16_t completeSplitTime; 
    uint8_t startUframe;        
    uint8_t uframeSmask;        
    uint8_t uframeCmask;        
} usb_host_ehci_pipe_t;
 
typedef struct _usb_host_ehci_qh
{
    uint32_t horizontalLinkPointer; 
    uint32_t
        staticEndpointStates[2]; 
    uint32_t currentQtdPointer;  
    uint32_t nextQtdPointer;     
    uint32_t alternateNextQtdPointer; 
    uint32_t
        transferOverlayResults[6]; 
    /* reserved space */
    usb_host_ehci_pipe_t *ehciPipePointer; 
    usb_host_transfer_t *ehciTransferHead; 
    usb_host_transfer_t *ehciTransferTail; 
    uint16_t timeOutValue; 
    uint16_t timeOutLabel; 
} usb_host_ehci_qh_t;
 
typedef struct _usb_host_ehci_qtd
{
    uint32_t nextQtdPointer;          
    uint32_t alternateNextQtdPointer; 
    uint32_t transferResults[2];      
    uint32_t bufferPointers[4];       
} usb_host_ehci_qtd_t;
 
typedef struct _usb_host_ehci_itd
{
    uint32_t nextLinkPointer;   
    uint32_t transactions[8];   
    uint32_t bufferPointers[7]; 
    /* add space */
    struct _usb_host_ehci_itd *nextItdPointer; 
    uint32_t frameEntryIndex;                  
    uint32_t reserved[6];                      
} usb_host_ehci_itd_t;
 
typedef struct _usb_host_ehci_sitd
{
    uint32_t nextLinkPointer;    
    uint32_t endpointStates[2];  
    uint32_t transferResults[3]; 
    uint32_t backPointer;        
    /* reserved space */
    uint16_t frameEntryIndex; 
    uint8_t nextSitdIndex;    
    uint8_t reserved;         
} usb_host_ehci_sitd_t;
 
typedef struct _usb_host_ehci_iso
{
    struct _usb_host_ehci_iso *next;       
    usb_host_pipe_t *ehciPipePointer;      
    usb_host_transfer_t *ehciTransferHead; 
    usb_host_transfer_t *ehciTransferTail; 
    uint16_t lastLinkFrame; 
} usb_host_ehci_iso_t;
 
typedef struct _usb_host_ehci_instance
{
    usb_host_handle hostHandle;                
    uint32_t *ehciUnitBase;                    
    uint8_t *ehciFrameList;                    
    usb_host_ehci_qh_t *ehciQhList;            
    usb_host_ehci_qtd_t *ehciQtdHead;          
    usb_host_ehci_qtd_t *ehciQtdTail;          
    usb_host_ehci_itd_t *ehciItdList;          
    usb_host_ehci_sitd_t *ehciSitdIndexBase;   
    usb_host_ehci_sitd_t *ehciSitdList;        
    usb_host_ehci_iso_t *ehciIsoList;          
    USBHS_Type *ehciIpBase;                    
    usb_host_ehci_qh_t *shedFirstQh;           
    usb_host_ehci_pipe_t *ehciPipeIndexBase;   
    usb_host_ehci_pipe_t *ehciPipeList;        
    usb_host_ehci_pipe_t *ehciRunningPipeList; 
    osa_mutex_handle_t ehciMutex;              
    uint32_t mutexBuffer[(OSA_MUTEX_HANDLE_SIZE + 3) / 4];           
    osa_event_handle_t taskEventHandle;                              
    uint32_t taskEventHandleBuffer[(OSA_EVENT_HANDLE_SIZE + 3) / 4]; 
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
    uint64_t matchTick;
#if ((defined FSL_FEATURE_SOC_USBPHY_COUNT) && (FSL_FEATURE_SOC_USBPHY_COUNT > 0U))
    USBPHY_Type *registerPhyBase; 
#endif
#if (defined(FSL_FEATURE_SOC_USBNC_COUNT) && (FSL_FEATURE_SOC_USBNC_COUNT > 0U))
    USBNC_Type *registerNcBase; 
#endif
 
#endif
    uint8_t controllerId;     
    uint8_t deviceAttached;   
    uint8_t firstDeviceSpeed; 
    uint8_t ehciItdNumber;    
    uint8_t ehciSitdNumber;   
    uint8_t ehciQtdNumber;    
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
#if ((defined(USB_HOST_CONFIG_LPM_L1)) && (USB_HOST_CONFIG_LPM_L1 > 0U))
    uint8_t hirdValue;
    uint8_t L1remoteWakeupEnable;
#endif
    bus_ehci_suspend_request_state_t busSuspendStatus; 
#endif
} usb_host_ehci_instance_t;
 
typedef struct _usb_host_ehci_data
{
#if ((defined(USB_HOST_CONFIG_EHCI_MAX_QH)) && (USB_HOST_CONFIG_EHCI_MAX_QH > 0U))
    usb_host_ehci_qh_t ehciQh[USB_HOST_CONFIG_EHCI_MAX_QH]; 
#endif
#if ((defined(USB_HOST_CONFIG_EHCI_MAX_QTD)) && (USB_HOST_CONFIG_EHCI_MAX_QTD > 0U))
    usb_host_ehci_qtd_t ehciQtd[USB_HOST_CONFIG_EHCI_MAX_QTD]; 
#endif
#if ((defined(USB_HOST_CONFIG_EHCI_MAX_ITD)) && (USB_HOST_CONFIG_EHCI_MAX_ITD > 0U))
    usb_host_ehci_itd_t ehciItd[USB_HOST_CONFIG_EHCI_MAX_ITD]; 
    /* add additional 32bytes because the itd cannot cross over 4K boundary,
     * If one ITD cross over 4K boundary, the code will move 32 bytes for ITD.
     */
    uint32_t reserved[8];
#endif
#if ((defined(USB_HOST_CONFIG_EHCI_MAX_SITD)) && (USB_HOST_CONFIG_EHCI_MAX_SITD > 0U))
    usb_host_ehci_sitd_t ehciSitd[USB_HOST_CONFIG_EHCI_MAX_SITD]; 
#endif
#if ((defined(USB_HOST_EHCI_ISO_NUMBER)) && (USB_HOST_EHCI_ISO_NUMBER > 0U))
    usb_host_ehci_iso_t ehciIso[USB_HOST_EHCI_ISO_NUMBER]; 
#endif
#if ((defined(USB_HOST_CONFIG_MAX_PIPES)) && (USB_HOST_CONFIG_MAX_PIPES > 0U))
    usb_host_ehci_pipe_t ehciPipe[USB_HOST_CONFIG_MAX_PIPES]; 
#endif
} usb_host_ehci_data_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#ifdef __cplusplus
extern "C" {
#endif
extern usb_status_t USB_HostEhciCreate(uint8_t controllerId,
                                       usb_host_handle upperLayerHandle,
                                       usb_host_controller_handle *controllerHandle);
 
extern usb_status_t USB_HostEhciDestory(usb_host_controller_handle controllerHandle);
 
extern usb_status_t USB_HostEhciOpenPipe(usb_host_controller_handle controllerHandle,
                                         usb_host_pipe_handle *pipeHandle,
                                         usb_host_pipe_init_t *pipeInit);
 
extern usb_status_t USB_HostEhciClosePipe(usb_host_controller_handle controllerHandle, usb_host_pipe_handle pipeHandle);
 
extern usb_status_t USB_HostEhciWritePipe(usb_host_controller_handle controllerHandle,
                                          usb_host_pipe_handle pipeHandle,
                                          usb_host_transfer_t *transfer);
 
extern usb_status_t USB_HostEhciReadpipe(usb_host_controller_handle controllerHandle,
                                         usb_host_pipe_handle pipeHandle,
                                         usb_host_transfer_t *transfer);
 
extern usb_status_t USB_HostEhciIoctl(usb_host_controller_handle controllerHandle,
                                      uint32_t ioctlEvent,
                                      void *ioctlParam);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _USB_HOST_CONTROLLER_EHCI_H_ */