Spell check source code, fix mistakes.
This commit is contained in:
parent
544027da18
commit
3808f5c36d
41 changed files with 63 additions and 63 deletions
|
@ -124,7 +124,7 @@
|
|||
*
|
||||
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
|
||||
* the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
|
||||
* to indicate the size of the retreived data.
|
||||
* to indicate the size of the retrieved data.
|
||||
*
|
||||
* \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
|
||||
* of the \c DataLength parameter.
|
||||
|
@ -153,7 +153,7 @@
|
|||
*
|
||||
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
|
||||
* the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations
|
||||
* to indicate the size of the retreived data.
|
||||
* to indicate the size of the retrieved data.
|
||||
*
|
||||
* \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
|
||||
* of the \c DataLength parameter.
|
||||
|
|
|
@ -130,7 +130,7 @@
|
|||
|
||||
|
||||
/** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the
|
||||
* \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.
|
||||
* \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.
|
||||
*
|
||||
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||||
*
|
||||
|
|
|
@ -156,7 +156,7 @@
|
|||
*
|
||||
* \param[in,out] AOAInterfaceInfo Pointer to a structure containing an AOA Class host configuration and state.
|
||||
*
|
||||
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum, or \ref AOA_ERROR_LOGICAL_CMD_FAILED if a logical error occured..
|
||||
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum, or \ref AOA_ERROR_LOGICAL_CMD_FAILED if a logical error occurred..
|
||||
*/
|
||||
uint8_t AOA_Host_StartAccessoryMode(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||||
|
||||
|
@ -311,4 +311,4 @@
|
|||
|
||||
/** @} */
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -246,7 +246,7 @@
|
|||
uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||||
|
||||
/** Sets the idle period for the attached HID device to the specified interval. The HID idle period determines the rate
|
||||
* at which the device should send a report, when no state changes have ocurred; i.e. on HID keyboards, this sets the
|
||||
* at which the device should send a report, when no state changes have occurred; i.e. on HID keyboards, this sets the
|
||||
* hardware key repeat interval.
|
||||
*
|
||||
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
|
||||
|
|
|
@ -145,7 +145,7 @@
|
|||
MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
|
||||
|
||||
/** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
|
||||
* \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
|
||||
* \ref MIDI_Host_SendEventPacket() function's packing behavior, to flush queued events. Events are queued into the
|
||||
* pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
|
||||
* events to be packed into a single pipe packet, increasing data throughput.
|
||||
*
|
||||
|
|
|
@ -215,7 +215,7 @@
|
|||
* from the \ref USB_Modes_t enum.
|
||||
*
|
||||
* \param[in] Options Mask indicating the options which should be used when initializing the USB
|
||||
* interface to control the USB interface's behaviour. This should be comprised of
|
||||
* interface to control the USB interface's behavior. This should be comprised of
|
||||
* a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
|
||||
* PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
|
||||
* mode speed.
|
||||
|
|
|
@ -213,7 +213,7 @@
|
|||
* function. The routine updates the position and remaining configuration descriptor bytes values
|
||||
* automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
|
||||
* so that the next descriptor search invocation will start from the descriptor which first caused the
|
||||
* original search to fail. This behaviour allows for one comparator to be used immediately after another
|
||||
* original search to fail. This behavior allows for one comparator to be used immediately after another
|
||||
* has failed, starting the second search from the descriptor which failed the first.
|
||||
*
|
||||
* Comparator functions should be standard functions which accept a pointer to the header of the current
|
||||
|
|
|
@ -189,7 +189,7 @@
|
|||
* \note For the microcontrollers with limited USB controller functionality, VBUS sensing is not available.
|
||||
* this means that the current connection state is derived from the bus suspension and wake up events by default,
|
||||
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
|
||||
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
|
||||
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
|
||||
* passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
|
||||
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
|
||||
* \n\n
|
||||
|
@ -207,7 +207,7 @@
|
|||
* \note For the microcontrollers with limited USB controllers, VBUS sense is not available to the USB controller.
|
||||
* this means that the current connection state is derived from the bus suspension and wake up events by default,
|
||||
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
|
||||
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
|
||||
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
|
||||
* passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
|
||||
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
|
||||
* \n\n
|
||||
|
|
|
@ -91,7 +91,7 @@
|
|||
|
||||
/* Global Variables: */
|
||||
/** Indicates the currently set configuration number of the attached device. This indicates the currently
|
||||
* selected configuration value if one has been set sucessfully, or 0 if no configuration has been selected.
|
||||
* selected configuration value if one has been set successfully, or 0 if no configuration has been selected.
|
||||
*
|
||||
* To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
|
||||
*
|
||||
|
|
|
@ -105,7 +105,7 @@
|
|||
/** \name USB Configuration Descriptor Attribute Masks */
|
||||
//@{
|
||||
/** Mask for the reserved bit in the Configuration Descriptor's \c ConfigAttributes field, which must be set on all
|
||||
* devices for historial purposes.
|
||||
* devices for historical purposes.
|
||||
*/
|
||||
#define USB_CONFIG_ATTR_RESERVED 0x80
|
||||
|
||||
|
|
|
@ -172,7 +172,7 @@
|
|||
* from the \ref USB_Modes_t enum.
|
||||
*
|
||||
* \param[in] Options Mask indicating the options which should be used when initializing the USB
|
||||
* interface to control the USB interface's behaviour. This should be comprised of
|
||||
* interface to control the USB interface's behavior. This should be comprised of
|
||||
* a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
|
||||
* PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
|
||||
* mode speed.
|
||||
|
|
|
@ -180,7 +180,7 @@
|
|||
* from the \ref USB_Modes_t enum.
|
||||
*
|
||||
* \param[in] Options Mask indicating the options which should be used when initializing the USB
|
||||
* interface to control the USB interface's behaviour. This should be comprised of
|
||||
* interface to control the USB interface's behavior. This should be comprised of
|
||||
* a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
|
||||
* PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
|
||||
* mode speed.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue