csl_usbhc.h

来自「dsp在音频处理中的运用」· C头文件 代码 · 共 1,496 行 · 第 1/4 页

@param NULL
@return  CSL_ESYS_INVCMD
*/
    CSL_USBHC_CMD_RMCON_ENABLE,
/**@brief Remote WakeUp connect disable.On Trinity this feature is not 
          supported.
@param NULL
@return  CSL_ESYS_INVCMD
*/
    CSL_USBHC_CMD_RMCON_DISABLE,
/**@brief Interrupt routing enable. On Trinity this feature is not supported.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_INTRROUTE_ENABLE,
/**@brief Interrupt routing disable.On Trinity this feature is not supported.
@param NULL None
@return CSL_SOK
*/
    CSL_USBHC_CMD_INTRROUTE_DISABLE,
/**@brief  Sets the Host controller functional state.On Trinity this feature 
           is not supported.
@param (CSL_UsbhcFuncState*) i.e Enums for USB Host Function States
@return  CSL_SOK
*/
    CSL_USBHC_CMD_HCFUNCSTATE_SET,
/**@brief Enable lists as specified in the BitMask
Programmation of CLE,BLE,PLE,IE field in the HCCONTROL register.
@param (BitMask16*) OR'd sybols from the Symbols for List IDs
@return CSL_SOK
*/
    CSL_USBHC_CMD_LIST_ENABLE,
/**@brief Disable lists as specified in the BitMask
Programmation of CLE,BLE,PLE,IE field in the HCCONTROL register.
@param (BitMask16*) OR'd sybols from the Symbols for List IDs
@return CSL_SOK
*/
    CSL_USBHC_CMD_LIST_DISABLE,
/**@brief Sets the Control-bulk service ratio
Programmation of CBSR field in the HCCONTROL register.
@param (CSL_UsbhcCtrlBulkRatio*)  i.e Enums for Control-Bulk Ratio
@return CSL_SOK
*/
    CSL_USBHC_CMD_CTRLBULKRATIO_SET,
/**@brief Ownership request by SW driver. On Trinity this feature is not 
          supported.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_OWNERSHIP_REQ,
/**@brief Sets the Fill bit for the respective lists
Programmation of BLF, CLF field in the HCCOMMANDSTATUS register.
@param (BitMask16*) OR'd sybols from the Symbols for List IDs, only
Control and Bulk list flags are valid.
@return CSL_SOK
*/
    CSL_USBHC_CMD_LIST_FILL,
/**@brief Resets the Host Controller
Programmation of HCR field in the HCCOMMANDSTATUS register.
@param  NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_HC_RESET,
/**@brief Enable the various interrupts events as passed in
	the argument.\n
Programmation of HCINTERRUPTENABLE register.
@param (BitMask32*) OR'd sybols from the Symbols for Events
@return CSL_SOK
*/
    CSL_USBHC_CMD_INTREVENTS_ENABLE,
/**@brief Disable the various interrupts events as passed in
	the argument.\n
Programmation of HCINTERRUPTDISABLE register.
@param (BitMask32*) OR'd sybols from the Symbols for Events
@return CSL_SOK
*/
    CSL_USBHC_CMD_INTREVENTS_DISABLE,
/**@brief Clears the various interrupts events as passed in the
	Bitmask.\n
Programmation of HCINTERRUPTSTATUS register.
@param (BitMask32*) OR'd sybols from the Symbols for Events
@return CSL_SOK
*/
    CSL_USBHC_CMD_INTREVENTS_CLEAR,
/**@brief Modifies the Frame interval value, along with which
	the Frame Interval Toggle field is also modified.\n
Programmation of FI field in the HCFMINTERVAL register.\n
Programmation of FIT field in the HCFMINTERVAL register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_FRMINTERVAL_SET,
/**@brief Sets the largest data packet size allowed for
	full-speed packets.\n
Programmation of FSMPS field in the HCFMINTERVAL register.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_LARGESTDATAPKT,
/**@brief Enable Bus time out counter.
Programmation of TO_DIS field in the HOSTTIMEOUTCTRL register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_BUSTIMEOUT_ENABLE,
/**@brief Disables Bus time out counter
Programmation of TO_DIS field in the HOSTTIMEOUTCTRL register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_BUSTIMEOUT_DISABLE,
/**@brief Sets the physical address of the current Bulk
	Endpoint descriptor.\n
Programmation of HCBULKCURRENTED register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_CURRENTED_BULK,
/**@brief Sets the physical address of the current Control
	Endpoint descriptor.  \n
Programmation of HCCONTROLCURRENTED register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_CURRENTED_CTRL,
/**@brief Sets the physical address of the current Periodic
	Endpoint descriptor.\n
Programmation of HCPERIODCURRENTED register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_CURRENTED_PER,
/**@brief Sets the physical address of the head of bulk
	endpoint descriptor.\n
Programmation of HCBULKHEADED register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_HEADED_BULK,
/**@brief Sets the physical address of the head of control
	endpoint descriptor. \n
Programmation of HCCONTROLHEADED register.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_HEADED_CTRL,
/**@brief Sets the startUp parameters
        This command does the following :-\n
        1. Asserts a soft reset \n
        2. Restores the values of the Frame Interval Field \n
        3. Initializes the Control Bulk ratio \n
        4. Enables appropriate interrupts.\n
        5. Initializes the physical address of the HCCA    \n
        6. Initializes the PeriodicStart to be 90% of the Frame I
           nterval field.\n
        7. Initializes the low speed threshold.\n
        8. Initializes the control head queue address.\n
        9. Initializes the bulk head queue address.\n
        10.Enables appropriate queues.\n
        11.Sets the functional state to OPERATIONAL.   \n
		Register fields programmed :-        \n
		1. Programmation of HCR field in the HCCOMMANDSTATUS register.\n
		2. Programmation of FI field in the  HCFMINTERVALregister.\n
		3. Programmation of PS field in the HCPERIODICSTART register to 90% 
           of the Frame Interval field.\n
		4. Programmation of HCHCCA register.\n
		5. Programmation of HCCONTROLHEADED register.\n
		6. Programmation of HCBULKHEADED register.\n
		7. Programmation of LST field in the HCLSTHRESHOLD register.\n
		8. Programmation of CBSR field in the HCCONTROL register.\n
		9. Programmation of HCFS field in the HCCONTROL  register to 
           operational.\n
		10.Programmation of BLE/CLE/PLE/IE field in the HCCONTROL register.\n
		11.Programmation of HCINTERRUPTENABLE register.        \n
@param (CSL_UsbhcHwStart*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_START,
/**@brief Clears Device Remote Wakeup Enable
Programmation of CRWE field in the HCRHSTATUS register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_ROOTHUBCONTROL_REMOTEWKUPEN_CLEAR,
/**@brief Sets the Device Remote Wakeup Enable
Programmation of DRWE field in the HCRHSTATUS register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_ROOTHUBCONTROL_REMOTEWKUPEN_SET,
/**@brief Clears global power bit, this is relevant only when
	power switching is used.\n
Programmation of LPS field in the HCRHSTATUS register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_ROOTHUBCONTROL_GLOBALPOWER_CLR,
/**@brief Sets global power bit, this is relevant only when power
        switching is used.\n
Programmation of LPSC field in the HCRHSTATUS register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_ROOTHUBCONTROL_GLOBALPOWER_SET,
/**@brief Clears the overcurrent Indicator Change.
Programmation of OCIC field in the HCRHSTATUS register.
@param NULL
@return CSL_SOK
*/
    CSL_USBHC_CMD_ROOTHUBCONTROL_OVERCURRENTINDICATOR_CLR,
/**@brief  Sets the Port Enable status
Programmation of SPE field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/

    CSL_USBHC_CMD_PORTCONTROL_PORT_SUSPEND,
/**@brief Places the port USB suspend state
Programmation of CPE field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/    

    CSL_USBHC_CMD_PORTCONTROL_PORT_CLEAR,
/**@brief Clears the suspend status and issues resume signalling
Programmation of CPE field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/    

    CSL_USBHC_CMD_PORTCONTROL_PORT_ENABLE,
/**@brief Clears the Port Enable status
Programmation of CPE field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_PORT_DISABLE,
/**@brief Reset the Port
Programmation of SPR field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_RESET,

/**@brief  This command could be used to control a
	number of fields together. These include clearing of any status bits 
	in the Port Status register. \n
Programmation of HCRHPORTSTATUS register.
@param (CSL_UsbhcPortStatCtrl*)
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL,
    
    /**@brief Enables power to a port
Programmation of SPP field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_POWER_SET,
    
    /**@brief Clears power to a port
Programmation of CPP field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_POWER_CLEAR,
    
    /**@brief Clears status change indication bit 
Programmation of CSC field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_CONNECTST_CLEAR,
    
    /**@brief Clears the port enable status change 
Programmation of PESC field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_ENABLEST_CLEAR,
    
    /**@brief Clears the port suspend status change 
Programmation of PSSC field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_SUSPENDST_CLEAR,
    
    /**@brief Clears the over current indication status change 
Programmation of OCIC field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_OCIINDST_CLEAR,
    
    /**@brief Clears the over current indication status change 
Programmation of PRSC field in the HCRHPORTSTATUS[PortNum] register.
@param (CSL_UsbhcDev*) i.e Enums for Port Number
@return CSL_SOK
*/
    CSL_USBHC_CMD_PORTCONTROL_RESETST_CLEAR
}CSL_UsbhcHwControlCmd;
/** @}*/


/**@defgroup CSL_USBHC_QUERYCMD_ENUM Enums for Query Commands
*  @ingroup CSL_USBHC_QUERY_API
* @{ */

/** @brief Enumeration for queries passed to @a CSL_usbhcGetHwStatus()
*
* This is used to get the status of different operations or to get the
* existing setup of USBHC. The arguments to be passed with each
* enumeration if any are specified next to the enumeration */

typedef enum {
/**@brief  OHCI specification revision.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_REV,
/**@brief  Queries the Scheduling overrun count.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_SCHEDOVRRUN_CNT,
/**@brief  Queries the Frame remaining of current frame.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_FRMREMAINING,
/**@brief Queries the Current Frame number.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_CURRFRMNUM,
/**@brief Queries the number of Downstream ports.
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_PORTNUM,
/**@brief  Queries the root hub status.
@param (CSL_BitMask32*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_ROOTHUBSTATUS,
/**@brief  Queries the port status.
@param (CSL_UsbhcPortStatCtrl*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_PORTSTATUS,
/**@brief Queries the unrecoverable error address.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_UNRECOVERERROR_ADDR,
/**@brief Queries the unrecoverable error access type.
@param (Bool*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_UNRECOVERERROR_ACCESSTYPE,
/**@brief Host Revision on the OMAP1610
@param (Uint16*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_HOSTREV,
/**@brief Queries the physical address of the current Endpoint
	descriptor on the Bulk list.
@param (Uint32*)
@return CSL_SOK
*/
    CSL_USBHC_QUERY_CURRENTED_BULK,
/**@brief Queries the physical address of the current Endpoint
	descriptor on the Control list.