Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

USBPhyEvents Class Reference

USBPhyEvents Class Reference

Event handler for USBPhy. More...

#include <USBPhyEvents.h>

Inherited by USBDevice.

Public Member Functions

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

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