Commit 3808f5c3 authored by Dean Camera's avatar Dean Camera
Browse files

Spell check source code, fix mistakes.

parent 544027da
...@@ -175,7 +175,7 @@ void EVENT_USB_Device_ControlRequest(void) ...@@ -175,7 +175,7 @@ void EVENT_USB_Device_ControlRequest(void)
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
...@@ -243,7 +243,7 @@ bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* ...@@ -243,7 +243,7 @@ bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t*
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
......
...@@ -212,7 +212,7 @@ void EVENT_USB_Device_ControlRequest(void) ...@@ -212,7 +212,7 @@ void EVENT_USB_Device_ControlRequest(void)
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
...@@ -280,7 +280,7 @@ bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* ...@@ -280,7 +280,7 @@ bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t*
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
......
...@@ -71,7 +71,7 @@ static uint16_t LastTransferLength = 0; ...@@ -71,7 +71,7 @@ static uint16_t LastTransferLength = 0;
static uint8_t NextResponseBuffer[64]; static uint8_t NextResponseBuffer[64];
/** Indicates the length of the next response to send */ /** Indicates the length of the next response to send */
static uint8_t NextReponseLen; static uint8_t NextResponseLen;
/** Main program entry point. This routine contains the overall program flow, including initial /** Main program entry point. This routine contains the overall program flow, including initial
* setup of all components and the main program loop. * setup of all components and the main program loop.
...@@ -326,16 +326,16 @@ void ProcessSentMessage(uint8_t* const Data, const uint8_t Length) ...@@ -326,16 +326,16 @@ void ProcessSentMessage(uint8_t* const Data, const uint8_t Length)
if (strncmp((char*)Data, "*IDN?", 5) == 0) if (strncmp((char*)Data, "*IDN?", 5) == 0)
strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO"); strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO");
NextReponseLen = strlen((char*)NextResponseBuffer); NextResponseLen = strlen((char*)NextResponseBuffer);
} }
uint8_t GetNextMessage(uint8_t* const Data) uint8_t GetNextMessage(uint8_t* const Data)
{ {
strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO"); strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO");
NextReponseLen = strlen((char*)NextResponseBuffer); NextResponseLen = strlen((char*)NextResponseBuffer);
// --- // ---
uint8_t DataLen = MIN(NextReponseLen, 64); uint8_t DataLen = MIN(NextResponseLen, 64);
strlcpy((char*)Data, (char*)NextResponseBuffer, DataLen); strlcpy((char*)Data, (char*)NextResponseBuffer, DataLen);
......
...@@ -181,7 +181,7 @@ void EVENT_USB_Device_ControlRequest(void) ...@@ -181,7 +181,7 @@ void EVENT_USB_Device_ControlRequest(void)
/** Processes a given Keyboard LED report from the host, and sets the board LEDs to match. Since the Keyboard /** Processes a given Keyboard LED report from the host, and sets the board LEDs to match. Since the Keyboard
* LED report can be sent through either the control endpoint (via a HID SetReport request) or the HID OUT * LED report can be sent through either the control endpoint (via a HID SetReport request) or the HID OUT
* endpoint, the processing code is placed here to avoid duplicating it and potentially having different * endpoint, the processing code is placed here to avoid duplicating it and potentially having different
* behaviour depending on the method used to sent it. * behavior depending on the method used to sent it.
*/ */
void Keyboard_ProcessLEDReport(const uint8_t LEDStatus) void Keyboard_ProcessLEDReport(const uint8_t LEDStatus)
{ {
......
...@@ -101,7 +101,7 @@ void SetupHardware(void) ...@@ -101,7 +101,7 @@ void SetupHardware(void)
} }
/** Task to manage an enumerated USB MIDI device once connected, to display received /** Task to manage an enumerated USB MIDI device once connected, to display received
* note events from the host and send note changes in response to tbe board's joystick. * note events from the host and send note changes in response to the board's joystick.
*/ */
void JoystickHost_Task(void) void JoystickHost_Task(void)
{ {
......
...@@ -283,7 +283,7 @@ static uint8_t MassStore_GetReturnedStatus(MS_CommandStatusWrapper_t* const SCSI ...@@ -283,7 +283,7 @@ static uint8_t MassStore_GetReturnedStatus(MS_CommandStatusWrapper_t* const SCSI
/** Issues a Mass Storage class specific request to reset the attached device's Mass Storage interface, /** Issues a Mass Storage class specific request to reset the attached device's Mass Storage interface,
* readying the device for the next CBW. The Data endpoints are cleared of any STALL condition once this * readying the device for the next CBW. The Data endpoints are cleared of any STALL condition once this
* command completes sucessfuly. * command completes successfully.
* *
* \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails * \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
*/ */
......
...@@ -66,7 +66,7 @@ ...@@ -66,7 +66,7 @@
#if (ARCH == ARCH_AVR8) || (ARCH == ARCH_XMEGA) || defined(__DOXYGEN__) #if (ARCH == ARCH_AVR8) || (ARCH == ARCH_XMEGA) || defined(__DOXYGEN__)
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__) #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
/** Re-enables the AVR's JTAG bus in software, until a system reset. This will re-enable JTAG debugging /** Re-enables the AVR's JTAG bus in software, until a system reset. This will re-enable JTAG debugging
* interface after is has been disbled in software via \ref JTAG_DISABLE(). * interface after is has been disabled in software via \ref JTAG_DISABLE().
* *
* \note This macro is not available for all architectures. * \note This macro is not available for all architectures.
*/ */
......
...@@ -116,7 +116,7 @@ ...@@ -116,7 +116,7 @@
/** Forces the compiler to not automatically zero the given global variable on startup, so that the /** Forces the compiler to not automatically zero the given global variable on startup, so that the
* current RAM contents is retained. Under most conditions this value will be random due to the * current RAM contents is retained. Under most conditions this value will be random due to the
* behaviour of volatile memory once power is removed, but may be used in some specific circumstances, * behavior of volatile memory once power is removed, but may be used in some specific circumstances,
* like the passing of values back after a system watchdog reset. * like the passing of values back after a system watchdog reset.
*/ */
#define ATTR_NO_INIT __attribute__ ((section (".noinit"))) #define ATTR_NO_INIT __attribute__ ((section (".noinit")))
......
...@@ -160,7 +160,7 @@ ...@@ -160,7 +160,7 @@
*/ */
static inline void Buttons_Init(void); static inline void Buttons_Init(void);
/** Disables the buttons driver, releasing the I/O pins back to their default high-impedence input mode. */ /** Disables the buttons driver, releasing the I/O pins back to their default high-impedance input mode. */
static inline void Buttons_Disable(void); static inline void Buttons_Disable(void);
/** Returns a mask indicating which board buttons are currently pressed. /** Returns a mask indicating which board buttons are currently pressed.
......
...@@ -126,7 +126,7 @@ ...@@ -126,7 +126,7 @@
*/ */
static inline void Joystick_Init(void); static inline void Joystick_Init(void);
/** Disables the joystick driver, releasing the I/O pins back to their default high-impedence input mode. */ /** Disables the joystick driver, releasing the I/O pins back to their default high-impedance input mode. */
static inline void Joystick_Disable(void); static inline void Joystick_Disable(void);
/** Returns the current status of the joystick, as a mask indicating the direction the joystick is /** Returns the current status of the joystick, as a mask indicating the direction the joystick is
......
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
* *
* \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If * \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
* a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect. * a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
* If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D * If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D
* switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when * switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when
* a non-existing LED is referenced in application code. Note that this means that it is possible to make * a non-existing LED is referenced in application code. Note that this means that it is possible to make
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers) * compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
...@@ -221,7 +221,7 @@ ...@@ -221,7 +221,7 @@
*/ */
static inline void LEDs_Init(void); static inline void LEDs_Init(void);
/** Disables the board LED driver, releasing the I/O pins back to their default high-impedence input mode. */ /** Disables the board LED driver, releasing the I/O pins back to their default high-impedance input mode. */
static inline void LEDs_Disable(void); static inline void LEDs_Disable(void);
/** Turns on the LEDs specified in the given LED mask. /** Turns on the LEDs specified in the given LED mask.
......
...@@ -248,7 +248,7 @@ ...@@ -248,7 +248,7 @@
#define ADC_INT_TEMP_SENS ((1 << 8) | (0x07 << MUX0)) #define ADC_INT_TEMP_SENS ((1 << 8) | (0x07 << MUX0))
#endif #endif
/** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */ /** MUX mask define for the internal 1.1V band-gap channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
#define ADC_1100MV_BANDGAP (0x1E << MUX0) #define ADC_1100MV_BANDGAP (0x1E << MUX0)
/** Retrieves the ADC MUX mask for the given ADC channel number. /** Retrieves the ADC MUX mask for the given ADC channel number.
......
...@@ -124,7 +124,7 @@ ...@@ -124,7 +124,7 @@
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
...@@ -153,7 +153,7 @@ ...@@ -153,7 +153,7 @@
* *
* When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for * 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 * 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 * \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. * of the \c DataLength parameter.
......
...@@ -130,7 +130,7 @@ ...@@ -130,7 +130,7 @@
/** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the /** 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. * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
* *
......
...@@ -156,7 +156,7 @@ ...@@ -156,7 +156,7 @@
* *
* \param[in,out] AOAInterfaceInfo Pointer to a structure containing an AOA Class host configuration and state. * \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); uint8_t AOA_Host_StartAccessoryMode(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
...@@ -311,4 +311,4 @@ ...@@ -311,4 +311,4 @@
/** @} */ /** @} */
...@@ -246,7 +246,7 @@ ...@@ -246,7 +246,7 @@
uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); 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 /** 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. * hardware key repeat interval.
* *
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
......
...@@ -145,7 +145,7 @@ ...@@ -145,7 +145,7 @@
MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); 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 /** 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 * 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. * events to be packed into a single pipe packet, increasing data throughput.
* *
......
...@@ -215,7 +215,7 @@ ...@@ -215,7 +215,7 @@
* from the \ref USB_Modes_t enum. * from the \ref USB_Modes_t enum.
* *
* \param[in] Options Mask indicating the options which should be used when initializing the USB * \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 * 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 * PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
* mode speed. * mode speed.
......
...@@ -213,7 +213,7 @@ ...@@ -213,7 +213,7 @@
* function. The routine updates the position and remaining configuration descriptor bytes values * 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 * 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 * 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. * 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 * Comparator functions should be standard functions which accept a pointer to the header of the current
......
...@@ -189,7 +189,7 @@ ...@@ -189,7 +189,7 @@
* \note For the microcontrollers with limited USB controller functionality, VBUS sensing is not available. * \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, * 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 * 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 * 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. * and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n * \n\n
...@@ -207,7 +207,7 @@ ...@@ -207,7 +207,7 @@
* \note For the microcontrollers with limited USB controllers, VBUS sense is not available to the USB controller. * \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, * 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 * 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 * 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. * and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n * \n\n
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment