Basic constructor.

Construct this object optionally connecting and blocking until it is ready.

Note

Do not use this constructor in derived classes.

Parameters

connect_blocking	true to perform a blocking connect, false to start in a disconnected state
mouse_type	Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
vendor_id	Your vendor_id (default: 0x1234)
product_id	Your product_id (default: 0x0001)
product_release	Your preoduct_release (default: 0x0001)

Fully featured constructor.

Construct this object with the supplied USBPhy and parameters. The user this object is responsible for calling connect() or init().

Note

Derived classes must use this constructor and call init() or connect() themselves. Derived classes should also call deinit() in their destructor. This ensures that no interrupts can occur when the object is partially constructed or destroyed.

Parameters

phy	USB phy to use
mouse_type	Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
vendor_id	Your vendor_id (default: 0x1234)
product_id	Your product_id (default: 0x0001)
product_release	Your preoduct_release (default: 0x0001)

Destroy this object.

Any classes which inherit from this class must call deinit before this destructor runs.

Send a character.

Parameters

c	character to be sent

Returns

true if there is no error, false otherwise

Implements Stream.

Assert that the current thread of execution holds the lock.

Called by USBDevice layer on power state change.

Parameters

powered

true if device is powered, false otherwise

Warning: Called in ISR context

Definition at line 342 of file USBDevice.h.

Called by USBDevice on Endpoint0 request.

This is used to handle extensions to standard requests and class specific requests. The function complete_request must be always be called in response to this callback.

Warning: Called in ISR context

Implements USBDevice.

Called by USBDevice on data stage completion.

The function complete_request_xfer_done must be always be called in response to this callback.

Parameters

setup	Setup packet of the current request
aborted	false if the operation was aborted, true otherwise

Warning: Called in ISR context

Implements USBDevice.

Called by USBDevice layer on bus reset.

complete_reset must be called after the device is fully reset.

Warning: Called in ISR context

Reimplemented in USBCDC_ECM, USBCDC, and USBTester.

Definition at line 370 of file USBDevice.h.

Called by USBDevice layer on each new USB frame.

Callbacks are enabled and disabled by calling sof_enable and sof_disable.

Parameters

frame_number

The current frame number

Warning: Called in ISR context

Definition at line 357 of file USBDevice.h.

Called when USB changes state.

Parameters

new_state

The new state of the USBDevice

Warning: Called in ISR context

Implements USBDevice.

Click.

Parameters

button

state of the buttons ( ex: clic(MOUSE_LEFT))

Returns

true if there is no error, false otherwise

Close a file.

Returns

0 on success, negative error code on failure

Implements FileHandle.

Called to complete the setup stage of a callback request.

Possible options that can be passed as a result are:

• Receive - Start the data OUT phase of this control transfer
• Send - Start the data IN phase of this control transfer
• Success - Operation was a success so start the status phase
• Failure - Operation failed or is unsupported so send a stall
• PassThrough - Pass on the request for standard processing

Parameters

result	The result of the setup phase.
data	Buffer to send or receive if the result is Send or Receive
size	Size to transfer if the result is Send or Receive

Called to complete the data stage of a callback request.

Parameters

success

true if the operation was successful, false otherwise

Called to complete a set configuration command.

Parameters

success

true if the configuration was set, false otherwise

Called to complete a set interface command.

Parameters

success

true if the interface was set, false otherwise

Check if the device is configured.

Returns

true if configured, false otherwise

Connect a device This method can also be used to resume USB operation when USB power is detected after it was suspended via USBDevice::deinit.

Power down this instance.

Disable interrupts and stop sending events. This method can be used for temporary power-saving; This call can allow USB to be temporarily disabled to permit power saving. However, it is up to the user to make sure all the transfers have concluded (for example when USB power is lost). USBDevice::connect can be used to resume USB operation.

Disconnect a device.

Double click (MOUSE_LEFT)

Returns

true if there is no error, false otherwise

Enable or disable input.

Control enabling of device for input. This is primarily intended for temporary power-saving; the overall ability of the device to operate for input and/or output may be fixed at creation time, but this call can allow input to be temporarily disabled to permit power saving without losing device state.

Parameters

enabled

true to enable input, false to disable.

Returns

0 on success

Negative error code on failure

Reimplemented in BufferedSerial, and UnbufferedSerial.

Definition at line 192 of file FileHandle.h.

Enable or disable output.

Control enabling of device for output. This is primarily intended for temporary power-saving; the overall ability of the device to operate for input and/or output may be fixed at creation time, but this call can allow output to be temporarily disabled to permit power saving without losing device state.

Parameters

enabled

true to enable output, false to disable.

Returns

0 on success

Negative error code on failure

Reimplemented in BufferedSerial, and UnbufferedSerial.

Definition at line 210 of file FileHandle.h.

Abort the current transfer on this endpoint.

Parameters

endpoint

endpoint with transfer to abort

Note

This endpoint must already have been setup with endpoint_add

Add an endpoint.

Parameters

endpoint	Endpoint to enable
max_packet	Maximum size of a packet which can be sent or received on this endpoint
type	Endpoint type - USB_EP_TYPE_BULK, USB_EP_TYPE_INT or USB_EP_TYPE_ISO
callback	Method pointer to be called when a packet is transferred

Returns

true if successful, false otherwise

Add an endpoint.

Parameters

endpoint	Endpoint to enable
max_packet	Maximum size of a packet which can be sent or received on this endpoint
type	Endpoint type - USB_EP_TYPE_BULK, USB_EP_TYPE_INT or USB_EP_TYPE_ISO
callback	Method pointer to be called when a packet is transferred

Returns

true if successful, false otherwise

Definition at line 162 of file USBDevice.h.

Get the current maximum size for this endpoint.

Return the currently configured maximum packet size, wMaxPacketSize, for this endpoint.

Note

This endpoint must already have been setup with endpoint_add

Remove an endpoint.

Parameters

endpoint

Endpoint to disable

Note

This endpoint must already have been setup with endpoint_add

Remove all non-zero endpoints.

Stall an endpoint.

If there is an ongoing transfer on this endpoint then it will be aborted.

Parameters

endpoint

Endpoint to stall

Note

You cannot stall endpoint 0 with this function

This endpoint must already have been setup with endpoint_add

Get the endpoint table of this device.

Returns

Endpoint table of the USBPhy attached to this USBDevice

Un-stall an endpoint.

Un-stalling an endpoint resets data toggle back to DATA0. Additionally, if there is an ongoing transfer on this endpoint it will be aborted.

Parameters

endpoint

Endpoint to un-stall

Note

This endpoint must already have been setup with endpoint_add

Find a descriptor type inside the configuration descriptor.

Parameters

descriptor_type	Type of descriptor to find
index	Configuration descriptor index ( 0 if only one configuration present )

Returns

A descriptor of the given type or NULL if none were found

Initialize this instance.

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

Check current blocking or nonblocking mode for file operations.

Returns

true for blocking mode, false for nonblocking mode.

Reimplemented in BufferedSerial.

Definition at line 174 of file FileHandle.h.

Check if the file in an interactive terminal device.

Returns

True if the file is a terminal

False if the file is not a terminal

Negative error code on failure

Reimplemented from FileHandle.

To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key.

Parameters

modifier	bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
key	character to send

Returns

true if there is no error, false otherwise

Acquire exclusive access to this object.

Definition at line 84 of file Stream.h.

Acquire exclusive access to this instance USBDevice.

Read status of lock keys.

Useful to switch-on/off LEDs according to key pressed. Only the first three bits of the result is important:

• First bit: NUM_LOCK
• Second bit: CAPS_LOCK
• Third bit: SCROLL_LOCK

Returns

status of lock keys

Control media keys.

Parameters

key	media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)

Returns

true if there is no error, false otherwise

Move the cursor to (x, y)

Parameters

x	x-axis position
y	y-axis position

Returns

true if there is no error, false otherwise

Check for poll event flags You can use or ignore the input parameter.

You can return all events or check just the events listed in events. Call is nonblocking - returns instantaneous state of events. Whenever an event occurs, the derived class should call the sigio() callback).

Parameters

events

bitmask of poll events we're interested in - POLLIN/POLLOUT etc.

Returns

bitmask of poll events that have occurred.

Reimplemented in UnbufferedSerial, and BufferedSerial.

Definition at line 225 of file FileHandle.h.

Press one or several buttons.

Parameters

button

button state (ex: press(MOUSE_LEFT))

Returns

true if there is no error, false otherwise

Read the contents of a file into a buffer.

Devices acting as FileHandles should follow POSIX semantics:

• if no data is available, and nonblocking set, return -EAGAIN
• if no data is available, and blocking set, wait until some data is available
• If any data is available, call returns immediately

Parameters

buffer	The buffer to read in to
size	The number of bytes to read

Returns

The number of bytes read, 0 at end of file, negative error on failure

Implements FileHandle.

Read a report: blocking.

Parameters

report

pointer to the report to fill

Returns

true if successful

Get the status of a read.

Parameters

endpoint

endpoint to get the status of

Returns

number of bytes read by this endpoint

Read a report: non blocking.

Parameters

report

pointer to the report to fill

Returns

true if successful

start a read on the given endpoint

Start a read on the given endpoint. The data buffer must remain unchanged until the transfer either completes or is aborted.

Parameters

endpoint	endpoint to read data from
buffer	buffer to fill with read data
size	The size of data to read. This must be greater than or equal to the max packet size for this endpoint

Returns

true if the read was completed, otherwise false

Note

This endpoint must already have been setup with endpoint_add

Definition depends on the subclass implementing FileHandle.

For example, if the FileHandle is of type Stream, readable() could return true when there is something available to read.

Returns

true when there is something available to read.

Definition at line 248 of file FileHandle.h.

Check if this class is ready.

Returns

true if the device is in the configured state

Release one or several buttons.

Parameters

button

button state (ex: release(MOUSE_LEFT))

Returns

true if there is no error, false otherwise

Rewind the file position to the beginning of the file.

Note

This is equivalent to seek(0, SEEK_SET)

Reimplemented from FileHandle.

Scrolling.

Parameters

z	value of the wheel (>0 to go down, <0 to go up)

Returns

true if there is no error, false otherwise

Move the file position to a given offset from from a given location.

Parameters

offset	The offset from whence to move to
whence	The start of where to seek SEEK_SET to start from beginning of file, SEEK_CUR to start from current position in file, SEEK_END to start from end of file

Returns

The new offset of the file, negative error code on failure

Implements FileHandle.

Send a Report.

warning: blocking

Parameters

report

Report which will be sent (a report is defined by all data and the length)

Returns

true if successful

Send a Report.

warning: non blocking

Parameters

report

Report which will be sent (a report is defined by all data and the length)

Returns

true if successful

Set blocking or nonblocking mode of the file operation like read/write.

Definition depends on the subclass implementing FileHandle. The default is blocking.

Parameters

blocking

true for blocking mode, false for nonblocking mode.

Returns

0 on success

Negative error code on failure

Reimplemented in BufferedSerial.

Definition at line 165 of file FileHandle.h.

Register a callback on state change of the file.

The specified callback will be called on state changes such as when the file can be written to or read from.

The callback may be called in an interrupt context and should not perform expensive operations.

Note! This is not intended as an attach-like asynchronous API, but rather as a building block for constructing such functionality.

The exact timing of when the registered function is called is not guaranteed and is susceptible to change. It should be used as a cue to make read/write/poll calls to find the current state.

Parameters

func	Function to call on state change

Reimplemented in BufferedSerial.

Definition at line 270 of file FileHandle.h.

Get the size of the file.

Returns

Size of the file in bytes

Reimplemented from FileHandle.

Disable the start of frame interrupt.

Stop calling USBDevice::callback_sof.

Enable the start of frame interrupt.

Call USBDevice::callback_sof on every frame.

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

Implements USBPhyEvents.

Flush any buffers associated with the file.

Returns

0 on success, negative error code on failure

Reimplemented from FileHandle.

Get the file position of the file.

Note

This is equivalent to seek(0, SEEK_CUR)

Returns

The current offset in the file, negative error code on failure

Reimplemented from FileHandle.

Truncate or extend a file.

The file's length is set to the specified value. The seek pointer is not changed. If the file is extended, the extended area appears as if it were zero-filled.

Parameters

length

The requested new length for the file

Returns

Zero on success, negative error code on failure

Reimplemented in File, and TestFile< FILE_SIZE >.

Definition at line 151 of file FileHandle.h.

Release exclusive access to this object.

Definition at line 91 of file Stream.h.

Release exclusive access to this instance USBDevice.

Write a state of the mouse.

Parameters

x	x-axis position
y	y-axis position
buttons	buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE)
z	wheel state (>0 to scroll down, <0 to scroll up)

Returns

true if there is no error, false otherwise

Block until this HID device is in the configured state.

Definition depends on the subclass implementing FileHandle.

For example, if the FileHandle is of type Stream, writable() could return true when there is ample buffer space available for write() calls.

Returns

true if the FileHandle is writable.

Definition at line 237 of file FileHandle.h.

Write the contents of a buffer to a file.

Devices acting as FileHandles should follow POSIX semantics:

• if blocking, block until all data is written
• if no data can be written, and nonblocking set, return -EAGAIN

• if some data can be written, and nonblocking set, write partial

  Parameters

  buffer	The buffer to write from
  size	The number of bytes to write

  Returns

  The number of bytes written, negative error on failure

Implements FileHandle.

Get the status of a write.

Parameters

endpoint

endpoint to get the status of

Returns

number of bytes sent by this endpoint

Write a data to the given endpoint.

Write data to an endpoint. The data sent must remain unchanged until the transfer either completes or is aborted.

Parameters

endpoint	endpoint to write data to
buffer	data to write
size	the size of data to send. This must be less than or equal to the max packet size of this endpoint

Note

This endpoint must already have been setup with endpoint_add