Commit 6933f2e1 authored by Dean Camera's avatar Dean Camera
Browse files

All comments in the library, bootloaders, demos and projects have now been...

All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected.
parent fb3fcb96
......@@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
......@@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
......@@ -259,7 +259,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
......@@ -306,7 +306,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Protocol).\r\n"));
......
......@@ -60,7 +60,7 @@
{
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
ParseError = 1, /**< Failed to fully process the HID report descriptor */
ParseControlError = 2, /**< Control error occured while trying to read the device HID descriptor */
ParseControlError = 2, /**< Control error occurred while trying to read the device HID descriptor */
};
/* Type Defines: */
......
......@@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
......@@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
......@@ -200,7 +200,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
......@@ -256,7 +256,7 @@ TASK(USB_Mouse_Host)
break;
}
/* All LEDs off - ready to indicate keypresses */
/* All LEDs off - ready to indicate key presses */
UpdateStatus(Status_USBReady);
puts_P(PSTR("Mouse Enumerated.\r\n"));
......@@ -285,7 +285,7 @@ TASK(USB_Mouse_Host)
/* Check each HID report item in turn, looking for mouse X/Y/button reports */
for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
{
/* Create a tempoary item pointer to the next report item */
/* Create a temporary item pointer to the next report item */
HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
bool FoundData;
......
......@@ -111,7 +111,7 @@ uint8_t SImage_RecieveBlockHeader(void)
/* Check to see if a new frame has been issued (1ms elapsed) */
if (USB_INT_HasOccurred(USB_INT_HSOFI))
{
/* Clear the flag and decrement the timout period counter */
/* Clear the flag and decrement the timeout period counter */
USB_INT_Clear(USB_INT_HSOFI);
TimeoutMSRem--;
......
......@@ -62,7 +62,7 @@
(params * sizeof(PIMA_SendBlock.Params[0])))
/* Type Defines: */
/** Type define for a PIMA container, use to send commands and receieve responses to and from an
/** Type define for a PIMA container, use to send commands and receive responses to and from an
* attached Still Image device.
*/
typedef struct
......
......@@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Still Image Host Demo running.\r\n" ESC_INVERSE_OFF));
......@@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
......@@ -165,7 +165,7 @@ TASK(USB_SImage_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if (USB_Host_SendControlRequest(NULL) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control error.\r\n"));
......@@ -223,7 +223,7 @@ TASK(USB_SImage_Host)
/* Send the GETDEVICEINFO block */
SImage_SendBlockHeader();
/* Recieve the response data block */
/* Receive the response data block */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
......@@ -274,7 +274,7 @@ TASK(USB_SImage_Host)
UnicodeToASCII(DeviceInfoPos, DeviceVersion);
printf_P(PSTR(" Device Version: %s\r\n"), DeviceVersion);
/* Recieve the final response block from the device */
/* Receive the final response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
......@@ -302,7 +302,7 @@ TASK(USB_SImage_Host)
/* Send the OPENSESSION block, open a session with an ID of 0x0001 */
SImage_SendBlockHeader();
/* Recieve the response block from the device */
/* Receive the response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
......@@ -330,7 +330,7 @@ TASK(USB_SImage_Host)
/* Send the CLOSESESSION block, close the session with an ID of 0x0001 */
SImage_SendBlockHeader();
/* Recieve the response block from the device */
/* Receive the response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
......
......@@ -140,7 +140,7 @@ USB_Descriptor_String_t PROGMEM ProductString =
/** This function is called by the library when in device mode, and must be overridden (see StdDescriptors.h
* documentation) by the application code so that the address and size of a requested descriptor can be given
* to the USB library. When the device recieves a Get Descriptor request on the control endpoint, this function
* to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
* is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
* USB host.
*/
......
......@@ -80,7 +80,7 @@ int main(void)
/* Turn on interrupts */
sei();
/* Startup message via USART */
/* Start-up message via USART */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"LUFA Demo running.\r\n" ESC_INVERSE_OFF));
......@@ -130,7 +130,7 @@ TASK(TestApp_CheckJoystick)
*/
TASK(TestApp_CheckTemp)
{
static SchedulerDelayCounter_t DelayCounter = 10000; // Force immediate run on startup
static SchedulerDelayCounter_t DelayCounter = 10000; // Force immediate run on start-up
/* Task runs every 10000 ticks, 10 seconds for this demo */
if (Scheduler_HasDelayElapsed(10000, &DelayCounter))
......@@ -161,7 +161,7 @@ TASK(TestApp_CheckHWB)
/* Set flag, indicating that current pressed state has been handled */
IsPressed = true;
/* First start of the USB interface permenantly blocks the joystick task */
/* First start of the USB interface permanently blocks the joystick task */
if (BlockingJoystickTask == false)
{
Scheduler_SetTaskMode(TestApp_CheckJoystick, TASK_STOP);
......
......@@ -13,6 +13,7 @@
* - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR
* - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile
* time options
* - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected
*
* \section Sec_ChangeLog090401 Version 090401
*
......
......@@ -31,7 +31,7 @@
/** \file
*
* This file contains macros which are common to all library elements, and which may be useful in user code. It
* also includes other common headees, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
* also includes other common headers, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
*/
#ifndef __COMMON_H__
......@@ -49,27 +49,27 @@
/* Public Interface - May be used in end-application: */
/* Macros: */
/** Macro for encasing other multi-statment macros. This should be used along with an opening brace
/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
* before the start of any multi-statement macro, so that the macros contents as a whole are treated
* as a discreete block and not as a list of seperate statements which may cause problems when used as
* a block (such as inline IF statments).
* as a discrete block and not as a list of separate statements which may cause problems when used as
* a block (such as inline IF statements).
*/
#define MACROS do
/** Macro for encasing other multi-statment macros. This should be used along with a preceeding closing
/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
* brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
* as a discreete block and not as a list of seperate statements which may cause problems when used as
* a block (such as inline IF statments).
* as a discrete block and not as a list of separate statements which may cause problems when used as
* a block (such as inline IF statements).
*/
#define MACROE while (0)
/** Defines a volatile NOP statment which cannot be optimized out by the compiler, and thus can always
/** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
* removes/reorders code to the point where break points cannot reliably be set.
*/
#define JTAG_DEBUG_POINT() asm volatile ("NOP" ::)
/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statment. When
/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
* a JTAG is used, this causes the program execution to halt when reached until manually resumed. */
#define JTAG_DEBUG_BREAK() asm volatile ("BREAK" ::)
......
......@@ -32,7 +32,7 @@
*
* This file contains macros for applying GCC specific attributes to functions to control various optimizer
* and code generation features of the compiler. Attributes may be placed in the function prototype in any
* order, and multiple attributes can be specified for a single function via a space seperated list.
* order, and multiple attributes can be specified for a single function via a space separated list.
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
......@@ -49,11 +49,11 @@
/* Public Interface - May be used in end-application: */
/* Macros: */
/** Indicates to the compiler that the function can not ever return, so that any stack restoring or
* return code may be ommited by the compiler in the resulting binary.
* return code may be omitted by the compiler in the resulting binary.
*/
#define ATTR_NO_RETURN __attribute__ ((noreturn))
/** Places the function in one of the initilization sections, which execute before the main function
/** Places the function in one of the initialization sections, which execute before the main function
* of the application. The init function number can be specified as "x", as an integer. Refer to the
* avr-libc manual for more information on the initialization sections.
*/
......@@ -65,12 +65,12 @@
#define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
/** Indicates that the specified parameters of the function are pointers which should never be NULL.
* When applied as a 1-based comma seperated list the compiler will emmit a warning if the specified
* When applied as a 1-based comma separated list the compiler will emit a warning if the specified
* parameters are known at compiler time to be NULL at the point of calling the function.
*/
#define ATTR_NON_NULL_PTR_ARG(...) __attribute__ ((nonnull (__VA_ARGS__)))
/** Removes any preample or postample from the function. When used, the function will not have any
/** Removes any preamble or postamble from the function. When used, the function will not have any
* register or stack saving code. This should be used with caution, and when used the programmer
* is responsible for maintaining stack and register integrity.
*/
......
......@@ -81,7 +81,7 @@
#if !defined(__DOXYGEN__)
static inline void Joystick_Init(void)
{
// TODO: Initialize joystick port pins as inputs with pullups
// TODO: Initialize joystick port pins as inputs with pull-ups
};
static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
......
......@@ -68,7 +68,7 @@
#error The selected board does not contain a HWB.
#endif
/* Psudo-Functions for Doxygen: */
/* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__)
/** Initializes the HWB driver, so that the current button position can be read. This sets the appropriate
* I/O pin to an input with pull-up enabled.
......
......@@ -66,7 +66,7 @@
#error The selected board does not contain a joystick.
#endif
/* Psudo-Functions for Doxygen: */
/* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__)
/** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
* I/O pins to inputs with their pull-ups enabled.
......
......@@ -68,7 +68,7 @@
#include "Board/LEDs.h"
#endif
/* Psudo-Functions for Doxygen: */
/* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__)
/** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
* I/O pins as outputs, and sets the LEDs to default to off.
......
......@@ -72,16 +72,16 @@
/** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
* This must be called before any other temperature sensor routines.
*
* The ADC itself (not the ADC channel) must be configured seperately before calling the temperature
* The ADC itself (not the ADC channel) must be configured separately before calling the temperature
* sensor functions.
*/
#define Temperature_Init() ADC_SetupChannel(TEMP_ADC_CHANNEL);
/* Function Prototypes: */
/** Performs a complete ADC on the temperature sensor channel, and converts the result into a
* valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celcius.
* valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius.
*
* \return Signed temperature in degrees Celcius
* \return Signed temperature in degrees Celsius
*/
int8_t Temperature_GetTemperature(void) ATTR_WARN_UNUSED_RESULT;
......
......@@ -97,13 +97,13 @@
#define DESCRIPTOR_SIZE(DescriptorPtr) DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).bLength
#endif
/** Creates a prototype for or begins a descriptor comparitor routine. Descriptor comparitor routines are
/** Creates a prototype for or begins a descriptor comparator routine. Descriptor comparator routines are
* small search routines which are passed a pointer to the current sub descriptor in the configuration
* descriptor, and which analyse the sub descriptor to determine whether or not it matches the routine's
* search parameters. Comparitor routines provide a powerful way to scan through the config descriptor
* search parameters. Comparator routines provide a powerful way to scan through the config descriptor
* for certain descriptors matching unique criteria.
*
* Comparitor routines are passed in a single pointer named CurrentDescriptor, and should return a value
* Comparator routines are passed in a single pointer named CurrentDescriptor, and should return a value
* of a member of the DSEARCH_Return_ErrorCodes_t enum.
*/
#define DESCRIPTOR_COMPARATOR(name) uint8_t DCOMP_##name (void* const CurrentDescriptor)
......@@ -117,7 +117,7 @@
*
* \param DSize Pointer to an int storing the remaining bytes in the configuration descriptor
* \param DPos Pointer to the current position in the configuration descriptor
* \param DSearch Name of the comparitor search function to use on the configuration descriptor
* \param DSearch Name of the comparator search function to use on the configuration descriptor
*
* \return Value of one of the members of the DSEARCH_Comp_Return_ErrorCodes_t enum
*
......@@ -156,7 +156,7 @@
/** Enum for return values of USB_Host_GetNextDescriptorComp() */
enum DSEARCH_Comp_Return_ErrorCodes_t
{
Descriptor_Search_Comp_Found = 0, /**< Configuration descriptor now points to decriptor which matches
Descriptor_Search_Comp_Found = 0, /**< Configuration descriptor now points to descriptor which matches
* search criteria of the given comparator function. */
Descriptor_Search_Comp_Fail = 1, /**< Comparator function returned Descriptor_Search_Fail. */
Descriptor_Search_Comp_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
......
......@@ -220,7 +220,7 @@
bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
ATTR_NON_NULL_PTR_ARG(1, 2);
/** Retreives the given report item's value out of the Value member of the report item's
/** Retrieves the given report item's value out of the Value member of the report item's
* HID_ReportItem_t structure and places it into the correct position in the HID report
* buffer. The report buffer is assumed to have the appropriate bits cleared before calling
* this function (i.e., the buffer should be explicitly cleared before report values are added).
......
......@@ -84,7 +84,7 @@
/** HID_ReportItem_t.ItemFlags flag for buffered bytes. */
#define IOF_BUFFEREDBYTES (1 << 8)
/** HID_ReportItem_t.ItemFlags flag for bitfield data. */
/** HID_ReportItem_t.ItemFlags flag for bit field data. */
#define IOF_BITFIELD (0 << 8)
/* Private Interface - For use in library only: */
......
......@@ -58,7 +58,7 @@
/* Macros: */
/** Raises a given event name, with the specified parameters. For events with no parameters the
* only argument to the macro is the event name, events with parameters list the parameter values
* after the name as a comma seperated list.
* after the name as a comma separated list.
*
* When a given event is fired, its corresponding event handler code is executed.
*
......@@ -75,7 +75,7 @@
*/
#define RAISE_EVENT(e, ...) Event_ ## e (__VA_ARGS__)
/** Indicates that a given module can raise a given event. This is the equivelent of putting the
/** Indicates that a given module can raise a given event. This is the equivalent of putting the
* event function's prototype into the module, but in a cleaner way. Each event which may be
* fired via the RAISE_EVENT macro in the module should have an accompanying RAISES_EVENT
* prototype in the module's header file.
......@@ -100,7 +100,7 @@
*
* Only one event handler may be defined in any user project for each individual event. Events may
* or may not have parameters - for each event, refer to its documentation elsewhere in this module
* to determine the presense and purpose of any event parameters.
* to determine the presence and purpose of any event parameters.
*
* Usage Example:
* \code
......@@ -115,7 +115,7 @@
*/
#define EVENT_HANDLER(e) void Event_ ## e e ## _P
/** Indicates that a given module handles an event. This is the equivelent of putting the
/** Indicates that a given module handles an event. This is the equivalent of putting the
* event function's prototype into the module, but in a cleaner way. Each event which may be
* handled via the EVENT_HANDLER macro in the module should have an accompanying HANDLES_EVENT
* prototype in the module's header file.
......@@ -136,7 +136,7 @@
*/
#define HANDLES_EVENT(e) EVENT_HANDLER(e)
/* Psudo-Functions for Doxygen: */
/* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__)
/** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from
* high to low or vice-versa.
......@@ -165,7 +165,7 @@
* has been attached (but not yet fully enumerated), or when in device mode and the device is connected
* to a host, beginning the enumeration process.
*
* When in device mode, this can be used to progmatically start the USB management task to reduce
* When in device mode, this can be used to programmatically start the USB management task to reduce
* CPU usage.
*
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
......@@ -183,7 +183,7 @@
* attached and enumerated device has been disconnected, or when in device mode and the device is
* disconnected from the host.
*
* When in device mode, this can be used to progmatically stop the USB management task to reduce
* When in device mode, this can be used to programmatically stop the USB management task to reduce
* CPU usage.
*
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
......@@ -231,7 +231,7 @@
/** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
* a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
* the standard USB_DeviceConnect event and so can be used to programatically start the USB management
* the standard USB_DeviceConnect event and so can be used to programmatically start the USB management
* task to reduce CPU consumption.
*
* \note This event only exists on USB AVR models which supports host mode.
......@@ -245,7 +245,7 @@
/** Event for USB device removal. This event fires when a the USB interface is in host mode, and
* a USB device has been removed the USB interface whether or not it has been enumerated. This
* can be used to programatically stop the USB management task to reduce CPU consumption.
* can be used to programmatically stop the USB management task to reduce CPU consumption.
*
* \note This event only exists on USB AVR models which supports host mode.
*
......
Markdown is supported
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