USBPhy Class Reference

Set this device to the configured state.

Enable added endpoints if they are not enabled already.

Make the USB phy visible to the USB host.

Enable either the D+ or D- pullup so the host can detect the presence of this device.

Power down this USBPhy instance.

Disable interrupts and stop sending events.

Detach the USB phy.

Disable the D+ and D- pullup and stop responding to USB traffic.

Abort the current transfer if it has not yet been sent.

Parameters:

endpoint

Endpoint to abort the transfer on. It is implementation defined if this function has an effect on receive endpoints.

Configure and enable an endpoint.

Parameters:

endpoint	Endpoint to configure and enable
max_packet	The maximum packet size that can be sent or received
type	The type of endpoint this should be configured as - USB_EP_TYPE_BULK, USB_EP_TYPE_INT or USB_EP_TYPE_ISO

Note:

This function cannot be used to configure endpoint 0. That must be done with ep0_set_max_packet

Start a read on the given endpoint.

Parameters:

endpoint	Endpoint to start the read on
data	Buffer to fill with data
size	Size of the read buffer. This must be at least the max packet size for this endpoint.

Returns:

true if the read was successfully started, false otherwise

Finish a read on the given endpoint.

Parameters:

endpoint

Endpoint to check

Returns:

The number of bytes received

Disable an endpoint.

Parameters:

endpoint

Endpoint to disable

Perform a functional stall on the given endpoint.

Set the HALT feature for this endpoint so that all further communication is aborted.

Parameters:

endpoint

Endpoint to stall

Get the endpoint table.

This function returns a table which describes the endpoints can be used, the functionality of those endpoints and the resource cost.

Un-stall the endpoint.

Clear the HALT feature on this endpoint so communication can resume.

Parameters:

endpoint

Endpoint to stall

Start a write on the given endpoint.

Parameters:

endpoint	Endpoint to write to
data	Buffer to write
size	Size of data to write

Returns:

true if the data was prepared for transmit, false otherwise

Start receiving a packet of up to wMaxPacketSize on endpoint 0.

Parameters:

data	Buffer to fill with the data read
size	Size of buffer

Read the contents of a received packet.

Returns:

Size of data read

Set wMaxPacketSize of endpoint 0.

Parameters:

max_packet

The wMaxPacketSize value for endpoint 0

Returns:

The actual size of endpoint 0

Read the contents of the SETUP packet.

Parameters:

buffer	Buffer to fill with data
size	Size of buffer passed in

Protocol stall on endpoint 0.

Stall all IN and OUT packets on endpoint 0 until a setup packet is received.

Note:

The stall is cleared automatically when a setup packet is received

Write a packet on endpoint 0.

Parameters:

buffer	Buffer fill with data to send
size	Size of data to send

Initialize this USBPhy instance.

This function must be called before calling any other functions of this class, unless specifically noted.

Parameters:

events

Callback class to handle USB events

Check if USB power is present.

Devices which don't support checking the USB power state must always return true.

Returns:

true if USB power is present, false otherwise

Callback used for performing USB processing.

USBPhy processing should be triggered by calling USBPhyEvents::start_process and done inside process. All USBPhyEvents callbacks aside from USBPhyEvents::start_process must be called in the context of process

Wake upstream devices.

Set the USBPhy's address.

Parameters:

address

This device's USB address

Disable the start of frame interrupt.

Stop calling USBPhyEvents::sof.

Enable the start of frame interrupt.

Call USBPhyEvents::sof on every frame.

Leave the configured state.

This is a notification to the USBPhy indicating that the device is leaving the configured state. The USBPhy can disable all endpoints other than endpoint 0.