Main Page | Data Structures | File List | Data Fields | Globals | Related Pages

dwc_otg_hcd_if.h File Reference

This file defines DWC_OTG HCD Core API. More...

#include "dwc_otg_core_if.h"

Go to the source code of this file.

Data Structures

struct  dwc_otg_hcd_function_ops

HCD Core API

#define URB_GIVEBACK_ASAP   0x1
#define URB_SEND_ZERO_PACKET   0x2
dwc_otg_hcd_t * dwc_otg_hcd_alloc_hcd (void)
 This function allocates dwc_otg_hcd structure and returns pointer on it.
int dwc_otg_hcd_init (dwc_otg_hcd_t *hcd, dwc_otg_core_if_t *core_if)
 This function should be called to initiate HCD Core.
void dwc_otg_hcd_remove (dwc_otg_hcd_t *hcd)
 Frees HCD.
int32_t dwc_otg_hcd_handle_intr (dwc_otg_hcd_t *dwc_otg_hcd)
 This function should be called on every hardware interrupt.
void * dwc_otg_hcd_get_priv_data (dwc_otg_hcd_t *hcd)
 Returns private data set by dwc_otg_hcd_set_priv_data function.
void dwc_otg_hcd_set_priv_data (dwc_otg_hcd_t *hcd, void *priv_data)
 Set private data.
int dwc_otg_hcd_start (dwc_otg_hcd_t *hcd, struct dwc_otg_hcd_function_ops *fops)
 This function initializes the HCD Core.
void dwc_otg_hcd_stop (dwc_otg_hcd_t *hcd)
 Halts the DWC_otg host mode operations in a clean manner.
int dwc_otg_hcd_hub_control (dwc_otg_hcd_t *dwc_otg_hcd, uint16_t typeReq, uint16_t wValue, uint16_t wIndex, uint8_t *buf, uint16_t wLength)
 Handles hub class-specific requests.
uint32_t dwc_otg_hcd_otg_port (dwc_otg_hcd_t *hcd)
 Returns otg port number.
uint16_t dwc_otg_get_otg_version (dwc_otg_core_if_t *core_if)
 Returns OTG version - either 1.3 or 2.0.
uint32_t dwc_otg_hcd_is_b_host (dwc_otg_hcd_t *hcd)
 Returns 1 if currently core is acting as B host, and 0 otherwise.
int dwc_otg_hcd_get_frame_number (dwc_otg_hcd_t *hcd)
 Returns current frame number.
void dwc_otg_hcd_dump_state (dwc_otg_hcd_t *hcd)
 Dumps hcd state.
void dwc_otg_hcd_dump_frrem (dwc_otg_hcd_t *hcd)
 Dump the average frame remaining at SOF.
int dwc_otg_hcd_send_lpm (dwc_otg_hcd_t *hcd, uint8_t devaddr, uint8_t hird, uint8_t bRemoteWake)
 Sends LPM transaction to the local device.
dwc_otg_hcd_urb_t * dwc_otg_hcd_urb_alloc (dwc_otg_hcd_t *hcd, int iso_desc_count, int atomic_alloc)
 Allocates memory for dwc_otg_hcd_urb structure.
void dwc_otg_hcd_urb_set_pipeinfo (dwc_otg_hcd_urb_t *hcd_urb, uint8_t devaddr, uint8_t ep_num, uint8_t ep_type, uint8_t ep_dir, uint16_t mps)
 Set pipe information in URB.
void dwc_otg_hcd_urb_set_params (dwc_otg_hcd_urb_t *urb, void *urb_handle, void *buf, dwc_dma_t dma, uint32_t buflen, void *sp, dwc_dma_t sp_dma, uint32_t flags, uint16_t interval)
 Sets dwc_otg_hcd_urb parameters.
uint32_t dwc_otg_hcd_urb_get_status (dwc_otg_hcd_urb_t *dwc_otg_urb)
 Gets status from dwc_otg_hcd_urb.
uint32_t dwc_otg_hcd_urb_get_actual_length (dwc_otg_hcd_urb_t *dwc_otg_urb)
 Gets actual length from dwc_otg_hcd_urb.
uint32_t dwc_otg_hcd_urb_get_error_count (dwc_otg_hcd_urb_t *dwc_otg_urb)
 Gets error count from dwc_otg_hcd_urb.
void dwc_otg_hcd_urb_set_iso_desc_params (dwc_otg_hcd_urb_t *dwc_otg_urb, int desc_num, uint32_t offset, uint32_t length)
 Set ISOC descriptor offset and length.
uint32_t dwc_otg_hcd_urb_get_iso_desc_status (dwc_otg_hcd_urb_t *dwc_otg_urb, int desc_num)
 Get status of ISOC descriptor, specified by desc_num.
uint32_t dwc_otg_hcd_urb_get_iso_desc_actual_length (dwc_otg_hcd_urb_t *dwc_otg_urb, int desc_num)
 Get actual length of ISOC descriptor, specified by desc_num.
int dwc_otg_hcd_urb_enqueue (dwc_otg_hcd_t *dwc_otg_hcd, dwc_otg_hcd_urb_t *dwc_otg_urb, void **ep_handle, int atomic_alloc)
 Queue URB.
int dwc_otg_hcd_urb_dequeue (dwc_otg_hcd_t *dwc_otg_hcd, dwc_otg_hcd_urb_t *dwc_otg_urb)
 De-queue the specified URB.
int dwc_otg_hcd_endpoint_disable (dwc_otg_hcd_t *hcd, void *ep_handle, int retry)
 Frees resources in the DWC_otg controller related to a given endpoint.
int dwc_otg_hcd_endpoint_reset (dwc_otg_hcd_t *hcd, void *ep_handle)
int dwc_otg_hcd_is_status_changed (dwc_otg_hcd_t *hcd, int port)
 Returns 1 if status of specified port is changed and 0 otherwise.
int dwc_otg_hcd_is_bandwidth_allocated (dwc_otg_hcd_t *hcd, void *ep_handle)
 Call this function to check if bandwidth was allocated for specified endpoint.
int dwc_otg_hcd_is_bandwidth_freed (dwc_otg_hcd_t *hcd, void *ep_handle)
 Call this function to check if bandwidth was freed for specified endpoint.
uint8_t dwc_otg_hcd_get_ep_bandwidth (dwc_otg_hcd_t *hcd, void *ep_handle)
 Returns bandwidth allocated for specified endpoint in microseconds.

HCD Function Driver Callbacks

typedef int(* dwc_otg_hcd_start_cb_t )(dwc_otg_hcd_t *hcd)
 This function is called whenever core switches to host mode.
typedef int(* dwc_otg_hcd_disconnect_cb_t )(dwc_otg_hcd_t *hcd)
 This function is called when device has been disconnected.
typedef int(* dwc_otg_hcd_hub_info_from_urb_cb_t )(dwc_otg_hcd_t *hcd, void *urb_handle, uint32_t *hub_addr, uint32_t *port_addr)
 Wrapper provides this function to HCD to core, so it can get hub information to which device is connected.
typedef int(* dwc_otg_hcd_speed_from_urb_cb_t )(dwc_otg_hcd_t *hcd, void *urb_handle)
 Via this function HCD core gets device speed.
typedef int(* dwc_otg_hcd_complete_urb_cb_t )(dwc_otg_hcd_t *hcd, void *urb_handle, dwc_otg_hcd_urb_t *dwc_otg_urb, int32_t status)
 This function is called when urb is completed.
typedef int(* dwc_otg_hcd_get_b_hnp_enable )(dwc_otg_hcd_t *hcd)
 Via this function HCD core gets b_hnp_enable parameter.

Typedefs

typedef dwc_otg_hcd dwc_otg_hcd_t
typedef dwc_otg_hcd_urb dwc_otg_hcd_urb_t

Detailed Description

This file defines DWC_OTG HCD Core API.

Definition in file dwc_otg_hcd_if.h.

Function Documentation

int dwc_otg_hcd_init (  dwc_otg_hcd_t *  hcd,
dwc_otg_core_if_t *  core_if
) 
 

This function should be called to initiate HCD Core.

Parameters:
hcd The HCD
core_if The DWC_OTG Core
Returns -DWC_E_NO_MEMORY if no enough memory. Returns 0 on success

Definition at line 780 of file dwc_otg_hcd.c.

void dwc_otg_hcd_remove (  dwc_otg_hcd_t *  hcd  ) 
 

Frees HCD.

Parameters:
hcd The HCD

Definition at line 879 of file dwc_otg_hcd.c.

int32_t dwc_otg_hcd_handle_intr (  dwc_otg_hcd_t *  dwc_otg_hcd  ) 
 

This function should be called on every hardware interrupt.

Todo:
Implement i2cintr handler.

Definition at line 43 of file dwc_otg_hcd_intr.c.

void* dwc_otg_hcd_get_priv_data (  dwc_otg_hcd_t *  hcd  ) 
 

Returns private data set by dwc_otg_hcd_set_priv_data function.

Parameters:
hcd The HCD

Definition at line 2958 of file dwc_otg_hcd.c.

void dwc_otg_hcd_set_priv_data (  dwc_otg_hcd_t *  hcd,
void *  priv_data
) 
 

Set private data.

Parameters:
hcd The HCD
priv_data pointer to be stored in private data

Definition at line 2963 of file dwc_otg_hcd.c.

int dwc_otg_hcd_start (  dwc_otg_hcd_t *  hcd,
struct dwc_otg_hcd_function_ops *  fops
) 
 

This function initializes the HCD Core.

Parameters:
hcd The HCD
fops The Function Driver Operations data structure containing pointers to all callbacks.
Returns -DWC_E_NO_DEVICE if Core is currently is in device mode. Returns 0 on success

Definition at line 2942 of file dwc_otg_hcd.c.

void dwc_otg_hcd_stop (  dwc_otg_hcd_t *  hcd  ) 
 

Halts the DWC_otg host mode operations in a clean manner.

USB transfers are stopped.

Definition at line 421 of file dwc_otg_hcd.c.

int dwc_otg_hcd_hub_control (  dwc_otg_hcd_t *  dwc_otg_hcd,
uint16_t  typeReq,
uint16_t  wValue,
uint16_t  wIndex,
uint8_t *  buf,
uint16_t  wLength
) 
 

Handles hub class-specific requests.

Todo:
  • check how sw can wait for 1 sec to check asesvld???

Definition at line 2015 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_otg_port (  dwc_otg_hcd_t *  hcd  ) 
 

Returns otg port number.

Parameters:
hcd The HCD

Definition at line 2968 of file dwc_otg_hcd.c.

uint16_t dwc_otg_get_otg_version (  dwc_otg_core_if_t *  core_if  ) 
 

Returns OTG version - either 1.3 or 2.0.

Parameters:
core_if The core_if structure pointer

Definition at line 7012 of file dwc_otg_cil.c.

uint32_t dwc_otg_hcd_is_b_host (  dwc_otg_hcd_t *  hcd  ) 
 

Returns 1 if currently core is acting as B host, and 0 otherwise.

Parameters:
hcd The HCD

Definition at line 2973 of file dwc_otg_hcd.c.

int dwc_otg_hcd_get_frame_number (  dwc_otg_hcd_t *  hcd  ) 
 

Returns current frame number.

Parameters:
hcd The HCD

Definition at line 2928 of file dwc_otg_hcd.c.

void dwc_otg_hcd_dump_state (  dwc_otg_hcd_t *  hcd  ) 
 

Dumps hcd state.

Parameters:
hcd The HCD

Definition at line 3102 of file dwc_otg_hcd.c.

void dwc_otg_hcd_dump_frrem (  dwc_otg_hcd_t *  hcd  ) 
 

Dump the average frame remaining at SOF.

This can be used to determine average interrupt latency. Frame remaining is also shown for start transfer and two additional sample points. Currently this function is not implemented.

Parameters:
hcd The HCD

Definition at line 3278 of file dwc_otg_hcd.c.

int dwc_otg_hcd_send_lpm (  dwc_otg_hcd_t *  hcd,
uint8_t  devaddr,
uint8_t  hird,
uint8_t  bRemoteWake
) 
 

Sends LPM transaction to the local device.

Parameters:
hcd The HCD
devaddr Device Address
hird Host initiated resume duration
bRemoteWake Value of bRemoteWake field in LPM transaction
Returns negative value if sending LPM transaction was not succeeded. Returns 0 on success.

dwc_otg_hcd_urb_t* dwc_otg_hcd_urb_alloc (  dwc_otg_hcd_t *  hcd,
int  iso_desc_count,
int  atomic_alloc
) 
 

Allocates memory for dwc_otg_hcd_urb structure.

Allocated memory should be freed by call of DWC_FREE.

Parameters:
hcd The HCD
iso_desc_count Count of ISOC descriptors
atomic_alloc Specefies whether to perform atomic allocation.

Definition at line 2985 of file dwc_otg_hcd.c.

void dwc_otg_hcd_urb_set_pipeinfo (  dwc_otg_hcd_urb_t *  hcd_urb,
uint8_t  devaddr,
uint8_t  ep_num,
uint8_t  ep_type,
uint8_t  ep_dir,
uint16_t  mps
) 
 

Set pipe information in URB.

Parameters:
hcd_urb DWC_OTG URB
devaddr Device Address
ep_num Endpoint Number
ep_type Endpoint Type
ep_dir Endpoint Direction
mps Max Packet Size

Definition at line 3004 of file dwc_otg_hcd.c.

void dwc_otg_hcd_urb_set_params (  dwc_otg_hcd_urb_t *  urb,
void *  urb_handle,
void *  buf,
dwc_dma_t  dma,
uint32_t  buflen,
void *  sp,
dwc_dma_t  sp_dma,
uint32_t  flags,
uint16_t  interval
) 
 

Sets dwc_otg_hcd_urb parameters.

Parameters:
urb DWC_OTG URB allocated by dwc_otg_hcd_urb_alloc function.
urb_handle Unique handle for request, this will be passed back to function driver in completion callback.
buf The buffer for the data
dma The DMA buffer for the data
buflen Transfer length
sp Buffer for setup data
sp_dma DMA address of setup data buffer
flags Transfer flags
interval Polling interval for interrupt or isochronous transfers.

Definition at line 3017 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_urb_get_status (  dwc_otg_hcd_urb_t *  dwc_otg_urb  ) 
 

Gets status from dwc_otg_hcd_urb.

Parameters:
dwc_otg_urb DWC_OTG URB

Definition at line 3034 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_urb_get_actual_length (  dwc_otg_hcd_urb_t *  dwc_otg_urb  ) 
 

Gets actual length from dwc_otg_hcd_urb.

Parameters:
dwc_otg_urb DWC_OTG URB

Definition at line 3039 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_urb_get_error_count (  dwc_otg_hcd_urb_t *  dwc_otg_urb  ) 
 

Gets error count from dwc_otg_hcd_urb.

Only for ISOC URBs

Parameters:
dwc_otg_urb DWC_OTG URB

Definition at line 3044 of file dwc_otg_hcd.c.

void dwc_otg_hcd_urb_set_iso_desc_params (  dwc_otg_hcd_urb_t *  dwc_otg_urb,
int  desc_num,
uint32_t  offset,
uint32_t  length
) 
 

Set ISOC descriptor offset and length.

Parameters:
dwc_otg_urb DWC_OTG URB
desc_num ISOC descriptor number
offset Offset from beginig of buffer.
length Transaction length

Definition at line 3049 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_urb_get_iso_desc_status (  dwc_otg_hcd_urb_t *  dwc_otg_urb,
int  desc_num
) 
 

Get status of ISOC descriptor, specified by desc_num.

Parameters:
dwc_otg_urb DWC_OTG URB
desc_num ISOC descriptor number

Definition at line 3057 of file dwc_otg_hcd.c.

uint32_t dwc_otg_hcd_urb_get_iso_desc_actual_length (  dwc_otg_hcd_urb_t *  dwc_otg_urb,
int  desc_num
) 
 

Get actual length of ISOC descriptor, specified by desc_num.

Parameters:
dwc_otg_urb DWC_OTG URB
desc_num ISOC descriptor number

Definition at line 3063 of file dwc_otg_hcd.c.

int dwc_otg_hcd_urb_enqueue (  dwc_otg_hcd_t *  dwc_otg_hcd,
dwc_otg_hcd_urb_t *  dwc_otg_urb,
void **  ep_handle,
int  atomic_alloc
) 
 

Queue URB.

After transfer is completes, the complete callback will be called with the URB status

Parameters:
dwc_otg_hcd The HCD
dwc_otg_urb DWC_OTG URB
ep_handle Out parameter for returning endpoint handle
atomic_alloc Flag to do atomic allocation if needed
Returns -DWC_E_NO_DEVICE if no device is connected. Returns -DWC_E_NO_MEMORY if there is no enough memory. Returns 0 on success.

Definition at line 443 of file dwc_otg_hcd.c.

int dwc_otg_hcd_urb_dequeue (  dwc_otg_hcd_t *  dwc_otg_hcd,
dwc_otg_hcd_urb_t *  dwc_otg_urb
) 
 

De-queue the specified URB.

Parameters:
dwc_otg_hcd The HCD
dwc_otg_urb DWC_OTG URB

Definition at line 492 of file dwc_otg_hcd.c.

int dwc_otg_hcd_endpoint_disable (  dwc_otg_hcd_t *  hcd,
void *  ep_handle,
int  retry
) 
 

Frees resources in the DWC_otg controller related to a given endpoint.

Any URBs for the endpoint must already be dequeued.

Parameters:
hcd The HCD
ep_handle Endpoint handle, returned by dwc_otg_hcd_urb_enqueue function
retry Number of retries if there are queued transfers.
Returns -DWC_E_INVALID if invalid arguments are passed. Returns 0 on success

Definition at line 542 of file dwc_otg_hcd.c.

int dwc_otg_hcd_is_status_changed (  dwc_otg_hcd_t *  hcd,
int  port
) 
 

Returns 1 if status of specified port is changed and 0 otherwise.

Parameters:
hcd The HCD
port Port number

Definition at line 2896 of file dwc_otg_hcd.c.

int dwc_otg_hcd_is_bandwidth_allocated (  dwc_otg_hcd_t *  hcd,
void *  ep_handle
) 
 

Call this function to check if bandwidth was allocated for specified endpoint.

Only for ISOC and INTERRUPT endpoints.

Parameters:
hcd The HCD
ep_handle Endpoint handle

Definition at line 3069 of file dwc_otg_hcd.c.

int dwc_otg_hcd_is_bandwidth_freed (  dwc_otg_hcd_t *  hcd,
void *  ep_handle
) 
 

Call this function to check if bandwidth was freed for specified endpoint.

Parameters:
hcd The HCD
ep_handle Endpoint handle

Definition at line 3082 of file dwc_otg_hcd.c.

uint8_t dwc_otg_hcd_get_ep_bandwidth (  dwc_otg_hcd_t *  hcd,
void *  ep_handle
) 
 

Returns bandwidth allocated for specified endpoint in microseconds.

Only for ISOC and INTERRUPT endpoints.

Parameters:
hcd The HCD
ep_handle Endpoint handle

Definition at line 3095 of file dwc_otg_hcd.c.

Generated on Thu Oct 27 03:56:38 2011 for DesignWare USB 2.0 OTG Controller (DWC_otg) Device Driver by  doxygen 1.3.9.1