usbpsu
Vitis Drivers API Documentation
XUsbPsu Struct Reference

USB Device Controller representation USB Device Controller representation. More...

Public Member Functions

u8 EventBuffer[XUSBPSU_EVENT_BUFFERS_SIZE] __attribute__ ((aligned(XUSBPSU_EVENT_BUFFERS_SIZE)))
 Event buffer array. More...
 

Data Fields

SetupPacket SetupData ALIGNMENT_CACHELINE
 Setup Packet buffer. More...
 
struct XUsbPsu_Trb Ep0_Trb ALIGNMENT_CACHELINE
 TRB for control transfers. More...
 
XUsbPsu_ConfigConfigPtr
 Configuration info pointer. More...
 
struct XUsbPsu_Ep eps [XUSBPSU_ENDPOINTS_NUM]
 Endpoints. More...
 
struct XUsbPsu_EvtBuffer Evt
 Usb event buffer. More...
 
struct XUsbPsu_EpParams EpParams
 Endpoint Parameters. More...
 
u32 BaseAddress
 Core register base address. More...
 
u32 DevDescSize
 Device descriptor size. More...
 
u32 ConfigDescSize
 Config descriptor size. More...
 
struct Usb_DevDataAppData
 Allication Data. More...
 
void(* Chapter9 )(struct Usb_DevData *, SetupPacket *)
 USB Chapter9 function handler. More...
 
void(* ResetIntrHandler )(struct Usb_DevData *)
 Reset function handler. More...
 
void(* DisconnectIntrHandler )(struct Usb_DevData *)
 Disconnect function handler. More...
 
void * DevDesc
 Device descriptor pointer. More...
 
void * ConfigDesc
 Config descriptor pointer. More...
 
u8 NumOutEps
 Number of out endpoints. More...
 
u8 NumInEps
 Number of in endpoint. More...
 
u8 ControlDir
 Control endpoint direction. More...
 
u8 IsInTestMode
 USB test mode flag. More...
 
u8 TestMode
 Test Mode. More...
 
u8 Ep0State
 Control EP state. More...
 
u8 LinkState
 Usb link state. More...
 
u8 UnalignedTx
 Unaligned transfer flag. More...
 
u8 IsConfigDone
 Flag - Check config is done or not. More...
 
u8 IsThreeStage
 USB three stage communication. More...
 
u8 IsHibernated
 Hibernated state. More...
 
u8 HasHibernation
 Has hibernation support. More...
 
void * data_ptr
 pointer for storing applications data More...
 

Detailed Description

USB Device Controller representation USB Device Controller representation.

struct XUsbPsu - USB Device Controller representation

Parameters
SetupData,:Setup data packet
Ep0_Trb,:TRB for control transfers
ConfigPtr,:Configuration info pointer
eps,:Endpoints array
Evt,:Usb event buffer
EpParams,:Endpoint Parameters
BaseAddress,:Core register base address
DevDescSize,:Device descriptor size
ConfigDescSize,:Config descriptor size
AppData,:Application data
*Chapter9,:USB Chapter9 function handler
*ResetIntrHandler,:Reset function handler
*DisconnectIntrHandler,:Disconnect function handler
*DevDesc,:Device descriptor pointer
*ConfigDesc,:Config descriptor pointer
EventBuffer,:Event buffer array
NumOutEps,:Number of out endpoints
NumInEps,:Number of in endpoint
ControlDir,:Control endpoint direction
IsInTestMode,:USB test mode flag
TestMode,:Test Mode
Ep0State,:Control EP state
LinkState,:USB link state
UnalignedTx,:Unaligned transfer flag
IsConfigDone,:Flag - Check config is done or not
IsThreeStage,:USB three stage communication
IsHibernated,:Flag - Hibernated state
HasHibernation,:Has hibernation support
*data_ptr,:pointer for storing applications data

Member Function Documentation

u8 EventBuffer [XUSBPSU_EVENT_BUFFERS_SIZE] XUsbPsu::__attribute__ ( (aligned(XUSBPSU_EVENT_BUFFERS_SIZE))  )

Event buffer array.

Field Documentation

SetupPacket SetupData XUsbPsu::ALIGNMENT_CACHELINE

Setup Packet buffer.

struct XUsbPsu_Trb Ep0_Trb XUsbPsu::ALIGNMENT_CACHELINE

TRB for control transfers.

u32 XUsbPsu::BaseAddress

Core register base address.

void(* XUsbPsu::Chapter9)(struct Usb_DevData *, SetupPacket *)

USB Chapter9 function handler.

Referenced by XUsbPsu_Ep0XferComplete().

void* XUsbPsu::ConfigDesc

Config descriptor pointer.

u32 XUsbPsu::ConfigDescSize

Config descriptor size.

u8 XUsbPsu::ControlDir

Control endpoint direction.

Referenced by XUsbPsu_Ep0StartStatus(), XUsbPsu_Ep0XferComplete(), and XUsbPsu_Ep0XferNotReady().

void* XUsbPsu::data_ptr

pointer for storing applications data

void* XUsbPsu::DevDesc

Device descriptor pointer.

u32 XUsbPsu::DevDescSize

Device descriptor size.

void(* XUsbPsu::DisconnectIntrHandler)(struct Usb_DevData *)

Disconnect function handler.

Referenced by XUsbPsu_DisconnectIntr().

struct XUsbPsu_EpParams XUsbPsu::EpParams

Endpoint Parameters.

Referenced by XUsbPsu_GetEpParams().

struct XUsbPsu_EvtBuffer XUsbPsu::Evt
u8 XUsbPsu::HasHibernation
u8 XUsbPsu::IsConfigDone

Flag - Check config is done or not.

Referenced by GetConfigDone(), XUsbPsu_DisconnectIntr(), XUsbPsu_ResetIntr(), and XUsbPsu_StartEpConfig().

u8 XUsbPsu::IsHibernated

Hibernated state.

Referenced by XUsbPsu_EpEnable(), and XUsbPsu_EventBufferHandler().

u8 XUsbPsu::IsInTestMode

USB test mode flag.

Referenced by XUsbPsu_Ep0StatusDone().

u8 XUsbPsu::IsThreeStage

USB three stage communication.

Referenced by XUsbPsu_Ep0StartStatus(), and XUsbPsu_Ep0XferComplete().

u8 XUsbPsu::LinkState

Usb link state.

Referenced by XUsbPsu_LinkStsChangeIntr().

u8 XUsbPsu::NumInEps

Number of in endpoint.

Referenced by XUsbPsu_CfgInitialize(), and XUsbPsu_ResetIntr().

u8 XUsbPsu::NumOutEps

Number of out endpoints.

Referenced by XUsbPsu_CfgInitialize(), and XUsbPsu_ResetIntr().

void(* XUsbPsu::ResetIntrHandler)(struct Usb_DevData *)

Reset function handler.

Referenced by XUsbPsu_ResetIntr().

u8 XUsbPsu::TestMode

Test Mode.

Referenced by XUsbPsu_Ep0StatusDone(), and XUsbPsu_ResetIntr().

u8 XUsbPsu::UnalignedTx

Unaligned transfer flag.