Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
USBPhyEvents Class Referenceabstract

Event handler for USBPhy. More...

#include <USBPhyEvents.h>

Inheritance diagram for USBPhyEvents:
USBDevice USBAudio USBCDC USBEndpointTester USBHID USBMIDI USBMSD USBTester USBSerial USBKeyboard USBMouse USBMouseKeyboard TestUSBMSD

Public Member Functions

virtual void reset ()=0
 Callback called when a bus reset occurs. More...
 
virtual void ep0_setup ()=0
 Callback called when an endpoint 0 setup packet is received. More...
 
virtual void ep0_out ()=0
 Callback called when an endpoint 0 out packet is received. More...
 
virtual void ep0_in ()=0
 Callback called when an endpoint 0 in packet is received. More...
 
virtual void power (bool powered)=0
 Callback called USB power is applied or removed. More...
 
virtual void suspend (bool suspended)=0
 Callback called when entering or leaving suspend mode. More...
 
virtual void sof (int frame_number)=0
 Callback called on start of frame. More...
 
virtual void out (usb_ep_t endpoint)=0
 Callback called on the reception of an OUT packet. More...
 
virtual void in (usb_ep_t endpoint)=0
 Callback called on the transmission of an IN packet. More...
 
virtual void start_process ()=0
 Callback called to indicate the USB processing needs to be done. More...
 

Detailed Description

Event handler for USBPhy.

This class is the event handler for the USBPhy class. Any events generated by USBPhy are passed to this class via the virtual functions.

Definition at line 31 of file USBPhyEvents.h.

Member Function Documentation

virtual void ep0_in ( )
pure virtual

Callback called when an endpoint 0 in packet is received.

Note
called in the contex of USBPhy::process
virtual void ep0_out ( )
pure virtual

Callback called when an endpoint 0 out packet is received.

Note
called in the contex of USBPhy::process
virtual void ep0_setup ( )
pure virtual

Callback called when an endpoint 0 setup packet is received.

Note
called in the contex of USBPhy::process
virtual void in ( usb_ep_t  endpoint)
pure virtual

Callback called on the transmission of an IN packet.

Parameters
endpointEndpoint which sent the IN packet
Note
called in the contex of USBPhy::process
virtual void out ( usb_ep_t  endpoint)
pure virtual

Callback called on the reception of an OUT packet.

Parameters
endpointEndpoint which received the OUT packet
Note
called in the contex of USBPhy::process
virtual void power ( bool  powered)
pure virtual

Callback called USB power is applied or removed.

Parameters
poweredtrue if USB power is present, false otherwise
Note
called in the contex of USBPhy::process
virtual void reset ( )
pure virtual

Callback called when a bus reset occurs.

Note
called in the contex of USBPhy::process
virtual void sof ( int  frame_number)
pure virtual

Callback called on start of frame.

Parameters
frame_numberThe current frame number
Note
This callback is enabled/disabled by calling USBPhy::sof_enable / USBPhy::sof_disable
called in the contex of USBPhy::process
virtual void start_process ( )
pure virtual

Callback called to indicate the USB processing needs to be done.

Implemented in USBDevice.

virtual void suspend ( bool  suspended)
pure virtual

Callback called when entering or leaving suspend mode.

Parameters
suspendedtrue if entering suspend mode false otherwise
Note
called in the contex of USBPhy::process
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.