From 6933f2e1a543b066ebe734bd126a7ff2f1c2777f Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Wed, 1 Apr 2009 13:53:58 +0000 Subject: All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected. --- LUFA/ChangeLog.txt | 1 + LUFA/Common/Common.h | 18 +++++------ LUFA/Common/FunctionAttributes.h | 10 +++---- LUFA/DriverStubs/Joystick.h | 2 +- LUFA/Drivers/Board/HWB.h | 2 +- LUFA/Drivers/Board/Joystick.h | 2 +- LUFA/Drivers/Board/LEDs.h | 2 +- LUFA/Drivers/Board/Temperature.h | 6 ++-- LUFA/Drivers/USB/Class/ConfigDescriptor.h | 10 +++---- LUFA/Drivers/USB/Class/HIDParser.h | 2 +- LUFA/Drivers/USB/Class/HIDReportData.h | 2 +- LUFA/Drivers/USB/HighLevel/Events.h | 18 +++++------ LUFA/Drivers/USB/HighLevel/StdDescriptors.h | 10 +++---- LUFA/Drivers/USB/HighLevel/USBInterrupt.h | 2 +- LUFA/Drivers/USB/HighLevel/USBTask.h | 6 ++-- LUFA/Drivers/USB/LowLevel/Device.h | 2 +- LUFA/Drivers/USB/LowLevel/Endpoint.h | 46 ++++++++++++++--------------- LUFA/Drivers/USB/LowLevel/Host.c | 4 +-- LUFA/Drivers/USB/LowLevel/Host.h | 6 ++-- LUFA/Drivers/USB/LowLevel/HostChapter9.h | 2 +- LUFA/Drivers/USB/LowLevel/OTG.h | 2 +- LUFA/Drivers/USB/LowLevel/Pipe.h | 44 +++++++++++++-------------- LUFA/MemoryAllocator/DynAlloc.h | 6 ++-- LUFA/Scheduler/Scheduler.h | 10 +++---- 24 files changed, 108 insertions(+), 107 deletions(-) (limited to 'LUFA') diff --git a/LUFA/ChangeLog.txt b/LUFA/ChangeLog.txt index 4365350ca..036e0314c 100644 --- a/LUFA/ChangeLog.txt +++ b/LUFA/ChangeLog.txt @@ -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 * diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index ed2d1bc90..36d9e3f6f 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -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" ::) diff --git a/LUFA/Common/FunctionAttributes.h b/LUFA/Common/FunctionAttributes.h index daa6c4a26..cd406734d 100644 --- a/LUFA/Common/FunctionAttributes.h +++ b/LUFA/Common/FunctionAttributes.h @@ -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. */ diff --git a/LUFA/DriverStubs/Joystick.h b/LUFA/DriverStubs/Joystick.h index 415976a46..ca80672b3 100644 --- a/LUFA/DriverStubs/Joystick.h +++ b/LUFA/DriverStubs/Joystick.h @@ -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; diff --git a/LUFA/Drivers/Board/HWB.h b/LUFA/Drivers/Board/HWB.h index 43aac9b5c..6ad2fa821 100644 --- a/LUFA/Drivers/Board/HWB.h +++ b/LUFA/Drivers/Board/HWB.h @@ -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. diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index 1f57e62c3..a3f70b8a4 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -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. diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index cda15a421..03e0db5e8 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -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. diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index c205093a8..17b8acfe1 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -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; diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.h b/LUFA/Drivers/USB/Class/ConfigDescriptor.h index d1f8927f8..d42b71cce 100644 --- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h @@ -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. */ diff --git a/LUFA/Drivers/USB/Class/HIDParser.h b/LUFA/Drivers/USB/Class/HIDParser.h index 314d08072..47a678b9b 100644 --- a/LUFA/Drivers/USB/Class/HIDParser.h +++ b/LUFA/Drivers/USB/Class/HIDParser.h @@ -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). diff --git a/LUFA/Drivers/USB/Class/HIDReportData.h b/LUFA/Drivers/USB/Class/HIDReportData.h index 1bb8676d7..0961cd40c 100644 --- a/LUFA/Drivers/USB/Class/HIDReportData.h +++ b/LUFA/Drivers/USB/Class/HIDReportData.h @@ -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: */ diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index eeb0ed37a..d53cd8eb0 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -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. * diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h index 3090d8c24..491e817a9 100644 --- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h +++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h @@ -31,7 +31,7 @@ /** \file * * Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains - * strucutures and macros for the easy creation of standard USB descriptors in USB device projects. + * structures and macros for the easy creation of standard USB descriptors in USB device projects. * * All standard descriptors have their elements named in an identical manner to the official USB specification, * however slightly more verbose alternate (non-standard) names are also supplied if the macro @@ -245,7 +245,7 @@ uint16_t ReleaseNumber; /**< Product release (version) number. */ uint8_t ManufacturerStrIndex; /**< String index for the manufacturer's name. The - * host will request this string via a seperate + * host will request this string via a separate * control request for the string descriptor. * * \note If no string supplied, use NO_DESCRIPTOR. @@ -255,7 +255,7 @@ * \see ManufacturerStrIndex structure entry. */ uint8_t SerialNumStrIndex; /**< String index for the product's globally unique hexadecimal - * serial number, in uppercase Unicoded ASCII. + * serial number, in uppercase Unicode ASCII. * * \see ManufacturerStrIndex structure entry. */ @@ -363,7 +363,7 @@ /** Type define for a standard interface association descriptor. * - * This descriptor has been added as a suppliment to the USB2.0 standard, in the ECN located at + * This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at * http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf. It allows compound * devices with multiple interfaces related to the same function to have the multiple interfaces bound * together at the point of enumeration, loading one generic driver for all the interfaces in the single @@ -425,7 +425,7 @@ * maximum packet size that the endpoint can receive at a time. */ - uint8_t PollingIntervalMS; /**< Polling interval in milliseconds for the endpont + uint8_t PollingIntervalMS; /**< Polling interval in milliseconds for the endpoint * if it is an INTERRUPT or ISOCHRONOUS type. */ #else diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h index 8438a589e..20b89eba1 100644 --- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h +++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h @@ -79,7 +79,7 @@ #define USB_INT_IsEnabled(int) ((USB_INT_GET_EN_REG(int) & USB_INT_GET_EN_MASK(int)) ? true : false) /** Returns boolean true if the given interrupt flag is set (i.e. the condition for the interrupt has occurred, - * but the interrupt vector is not neccesarily enabled), otherwise returns false. + * but the interrupt vector is not necessarily enabled), otherwise returns false. */ #define USB_INT_HasOccurred(int) ((USB_INT_GET_INT_REG(int) & USB_INT_GET_INT_MASK(int)) ? true : false) diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h index 5bbd4f92e..c8180f588 100644 --- a/LUFA/Drivers/USB/HighLevel/USBTask.h +++ b/LUFA/Drivers/USB/HighLevel/USBTask.h @@ -76,7 +76,7 @@ */ extern volatile bool USB_IsConnected; - /** Indicates if the USB interface is currently initialized but not neccesarily connected to a host + /** Indicates if the USB interface is currently initialized but not necessarily connected to a host * or device (i.e. if USB_Init() has been run). If this is false, all other library globals are invalid. * * \note This variable should be treated as read-only in the user application, and never manually @@ -166,10 +166,10 @@ * The USB task must be serviced within 50mS in all modes, when needed. The task may be serviced * at all times, or (for minimum CPU consumption): * - * - In device mode, it may be disabled at startup, enabled on the firing of the USB_Connect event + * - In device mode, it may be disabled at start-up, enabled on the firing of the USB_Connect event * and disabled again on the firing of the USB_Disconnect event. * - * - In host mode, it may be disabled at startup, enabled on the firing of the USB_DeviceAttached + * - In host mode, it may be disabled at start-up, enabled on the firing of the USB_DeviceAttached * event and disabled again on the firing of the USB_DeviceUnattached event. * * \see Events.h for more information on the USB events. diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 187fccb4a..c6e5f7f5a 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -94,7 +94,7 @@ /** Indicates if the device is currently suspended by the host. While suspended, the device is * to enter a low power state until resumed by the host. While suspended no USB traffic to or - * from the device can ocurr (except for Remote Wakeup requests). + * from the device can occur (except for Remote Wakeup requests). * * This macro returns true if the USB communications have been suspended by the host, false * otherwise. diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index c6aece708..8c22bb7f7 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -32,7 +32,7 @@ * * Functions, macros and enums related to endpoint management when in USB Device mode. This * module contains the endpoint management macros, as well as endpoint interrupt and data - * send/recieve functions for various datatypes. + * send/recieve functions for various data types. */ #ifndef __ENDPOINT_H__ @@ -210,7 +210,7 @@ /** Returns true if the currently selected endpoint may be read from (if data is waiting in the endpoint * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an - * IN direction). This function will return false if an error has occured in the endpoint, or if + * IN direction). This function will return false if an error has occurred in the endpoint, or if * the endpoint is an OUT direction and no packet has been received, or if the endpoint is an IN * direction and the endpoint bank is full. */ @@ -262,10 +262,10 @@ */ #define Endpoint_ClearSetupOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE - /** Stalls the current endpoint, indicating to the host that a logical problem occured with the + /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the * indicated endpoint and that the current transfer sequence should be aborted. This provides a * way for devices to indicate invalid commands to the host so that the current transfer can be - * aborted and the host can begin its own recovery seqeuence. + * aborted and the host can begin its own recovery sequence. * * The currently selected endpoint remains stalled until either the Endpoint_ClearStall() macro * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected @@ -276,7 +276,7 @@ /** Clears the stall on the currently selected endpoint. */ #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE - /** Returns true if the currently selected endpoint is stalled, false othewise. */ + /** Returns true if the currently selected endpoint is stalled, false otherwise. */ #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false) /** Resets the data toggle of the currently selected endpoint. */ @@ -552,12 +552,12 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \note This routine should not be used on CONTROL type endpoints. * * \param Length Number of bytes to send via the currently selected endpoint. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum. */ @@ -576,13 +576,13 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \note This routine should not be used on CONTROL type endpoints. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected endpoint into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum. */ @@ -601,13 +601,13 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \note This routine should not be used on CONTROL type endpoints. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected endpoint into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum. */ @@ -626,13 +626,13 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \note This routine should not be used on CONTROL type endpoints. * * \param Buffer Pointer to the destination data buffer to write to. * \param Length Number of bytes to send via the currently selected endpoint. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum. */ @@ -651,13 +651,13 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \note This routine should not be used on CONTROL type endpoints. * * \param Buffer Pointer to the destination data buffer to write to. * \param Length Number of bytes to send via the currently selected endpoint. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum. */ @@ -749,27 +749,27 @@ #define Endpoint_Ignore_DWord() Endpoint_Discard_DWord() /** Alias for Endpoint_Read_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Read_Word() Endpoint_Read_Word_LE() /** Alias for Endpoint_Write_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Write_Word(Word) Endpoint_Write_Word_LE(Word) /** Alias for Endpoint_Read_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Read_DWord() Endpoint_Read_DWord_LE() /** Alias for Endpoint_Write_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Write_DWord(DWord) Endpoint_Write_DWord_LE(DWord) /** Alias for Endpoint_Read_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Endpoint_Read_Stream(Buffer, Length, Callback) Endpoint_Read_Stream_LE(Buffer, Length, Callback) @@ -778,7 +778,7 @@ #endif /** Alias for Endpoint_Write_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Endpoint_Write_Stream(Buffer, Length, Callback) Endpoint_Write_Stream_LE(Buffer, Length, Callback) @@ -787,12 +787,12 @@ #endif /** Alias for Endpoint_Read_Control_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Read_Control_Stream(Data, Length) Endpoint_Read_Control_Stream_LE(Data, Length) /** Alias for Endpoint_Write_Control_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Endpoint_Write_Control_Stream(Data, Length) Endpoint_Write_Control_Stream_LE(Data, Length) diff --git a/LUFA/Drivers/USB/LowLevel/Host.c b/LUFA/Drivers/USB/LowLevel/Host.c index 7acbffe71..04b06b3da 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.c +++ b/LUFA/Drivers/USB/LowLevel/Host.c @@ -93,8 +93,8 @@ void USB_Host_ResetDevice(void) for (uint8_t MSRem = 10; MSRem != 0; MSRem--) { - /* Workaround for powerless-pullup devices. After a USB bus reset, - all disconnection interrupts are supressed while a USB frame is + /* Workaround for powerless-pull-up devices. After a USB bus reset, + all disconnection interrupts are suppressed while a USB frame is looked for - if it is found within 10ms, the device is still present. */ diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index 5cc215454..427ed85ee 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -102,7 +102,7 @@ */ #define USB_Host_ResumeBus() MACROS{ UHCON |= (1 << SOFEN); }MACROE - /** Suspends the USB bus, preventing any communications from occuring between the host and attached + /** Suspends the USB bus, preventing any communications from occurring between the host and attached * device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame * messages to the device. */ @@ -192,14 +192,14 @@ * event. */ HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed - * to complete successfuly, due to a timeout or other + * to complete successfully, due to a timeout or other * error. */ HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines * indicating the attachment of a device. */ HOST_ENUMERROR_ControlError = 3, /**< One of the enumeration control requests failed to - * complete successfuly. + * complete successfully. */ HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to * configure correctly. diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h index 1ca4343a9..4e4fa4f08 100644 --- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h @@ -77,7 +77,7 @@ HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the * request transfer. */ - HOST_SENDCONTROL_PipeError = 2, /**< An error occured in the pipe while sending the request. */ + HOST_SENDCONTROL_PipeError = 2, /**< An error occurred in the pipe while sending the request. */ HOST_SENDCONTROL_SetupStalled = 3, /**< The attached device stalled the request, usually * indicating that the request is unsupported on the device. */ diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h index e1a92f1eb..88a955403 100644 --- a/LUFA/Drivers/USB/LowLevel/OTG.h +++ b/LUFA/Drivers/USB/LowLevel/OTG.h @@ -82,7 +82,7 @@ * host mode indicates that VBUS should be applied and a session started. * * There are two different methods of sending a SRP - either pulses on the VBUS line, or by - * pulsing the Data + line via the internal pullup resistor. The SRP mode is given as the + * pulsing the Data + line via the internal pull-up resistor. The SRP mode is given as the * "type" parameter, and can be either USB_OTG_SRP_VBUS or USB_OTG_STP_DATA. */ #define USB_OTG_DEV_Initiate_SRP(type) MACROS{ OTGCON = ((OTGCON & ~(1 << SRPSEL)) | (type | (1 << SRPREQ))); }MACROE diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index df3ac7ddc..9a59dbca8 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -32,7 +32,7 @@ * * Functions, macros and enums related to pipe management when in USB Host mode. This * module contains the pipe management macros, as well as pipe interrupt and data - * send/recieve functions for various datatypes. + * send/recieve functions for various data types. */ #ifndef __PIPE_H__ @@ -303,7 +303,7 @@ /** Returns true if the master pipe error flag is set for the currently selected pipe, indicating that * some sort of hardware error has occurred on the pipe. * - * \see Pipe_GetErrorFlags() macro for information on retreiving the exact error flag. + * \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag. */ #define Pipe_IsError() ((UPINTX & (1 << PERRI)) ? true : false) @@ -311,14 +311,14 @@ * flag for the pipe. */ #define Pipe_ClearErrorFlags() MACROS{ UPERRX = 0; }MACROE - /** Returns a mask of the hardware error flags which have occured on the currently selected pipe. This + /** Returns a mask of the hardware error flags which have occurred on the currently selected pipe. This * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred. */ #define Pipe_GetErrorFlags() UPERRX /** Returns true if the currently selected pipe may be read from (if data is waiting in the pipe * bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT - * direction). This function will return false if an error has occured in the pipe, or if the pipe + * direction). This function will return false if an error has occurred in the pipe, or if the pipe * is an IN direction and no packet has been received, or if the pipe is an OUT direction and the * pipe bank is full. */ @@ -358,9 +358,9 @@ #define Pipe_ClearSetupOUT() MACROS{ UPINTX &= ~(1 << TXOUTI); UPINTX &= ~(1 << FIFOCON); }MACROE /** Returns true if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on - * the currently selected pipe. This ocurrs when the host sends a packet to the device, but the device + * the currently selected pipe. This occurs when the host sends a packet to the device, but the device * is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been - * received, it must be cleard using Pipe_ClearNAKReceived() before the previous (or any other) packet + * received, it must be cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet * can be re-sent. */ #define Pipe_IsNAKReceived() ((UPINTX & (1 << NAKEDI)) ? true : false) @@ -607,11 +607,11 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected pipe into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -629,11 +629,11 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to read from. * \param Length Number of bytes to read for the currently selected pipe into the buffer. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -651,10 +651,10 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \param Length Number of bytes to send via the currently selected pipe. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -672,11 +672,11 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to write to. * \param Length Number of bytes to read for the currently selected pipe to read from. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -694,11 +694,11 @@ * * The callback routine should be created using the STREAM_CALLBACK() macro. If the token * NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled - * and this function has the Callback parameter ommitted. + * and this function has the Callback parameter omitted. * * \param Buffer Pointer to the source data buffer to write to. * \param Length Number of bytes to read for the currently selected pipe to read from. - * \param Callback Name of a callback routine to call between sucessive USB packet transfers, NULL if no callback + * \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback * * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum. */ @@ -722,27 +722,27 @@ #define Pipe_Ignore_DWord() Pipe_Discard_DWord() /** Alias for Pipe_Read_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Read_Word() Pipe_Read_Word_LE() /** Alias for Pipe_Write_Word_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Write_Word(Word) Pipe_Write_Word_LE(Word) /** Alias for Pipe_Read_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Read_DWord() Pipe_Read_DWord_LE() /** Alias for Pipe_Write_DWord_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #define Pipe_Write_DWord(DWord) Pipe_Write_DWord_LE(DWord) /** Alias for Pipe_Read_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Pipe_Read_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback) @@ -751,7 +751,7 @@ #endif /** Alias for Pipe_Write_Stream_LE(). By default USB transfers use little endian format, thus - * the command with no endianness specifier indicates little endian mode. + * the command with no endianness specified indicates little endian mode. */ #if !defined(NO_STREAM_CALLBACKS) #define Pipe_Write_Stream(Buffer, Length, Callback) Pipe_Read_Stream_LE(Buffer, Length, Callback) diff --git a/LUFA/MemoryAllocator/DynAlloc.h b/LUFA/MemoryAllocator/DynAlloc.h index 6fd743ea3..dba1864cd 100644 --- a/LUFA/MemoryAllocator/DynAlloc.h +++ b/LUFA/MemoryAllocator/DynAlloc.h @@ -45,9 +45,9 @@ * The constants NUM_BLOCKS, BLOCK_SIZE and NUM_HANDLES must be defined in the project makefile (and passed to the * preprocessor via the -D GCC switch) for this library to compile. * - * NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chaned together and handed + * NUM_BLOCKS indicates the number of memory blocks in the memory psudoheap which can be chained together and handed * to the application via a memory handle. NUM_HANDLES is the maximum number of memory handles (pointing to one or - * more chained memory blocks) which can be handed out simultaneously before requring a handle (and its associated + * more chained memory blocks) which can be handed out simultaneously before requiring a handle (and its associated * memory) to be freed. BLOCK_SIZE gives the number of bytes in each memory block. */ @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** Macro to dereference a given memory handle into the given type. The given type should be a pointer - * if the memory is to contain an array of items, or should be a standard type (such as a primative or + * if the memory is to contain an array of items, or should be a standard type (such as a primitive or * structure) if the memory is to hold a single item of a single type. */ #define DEREF(handle, type) (*(type*)handle) diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h index e536e7137..414b0b291 100644 --- a/LUFA/Scheduler/Scheduler.h +++ b/LUFA/Scheduler/Scheduler.h @@ -30,10 +30,10 @@ /** \file * - * Simple round-robbin cooperative scheduler for use in basic projects where non realtime tasks need + * Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need * to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group. * - * For a task to yield it must return, thus each task should have persistant data marked with the static attribute. + * For a task to yield it must return, thus each task should have persistent data marked with the static attribute. * * Usage Example: * \code @@ -126,8 +126,8 @@ #define Scheduler_Start() Scheduler_GoSchedule(TOTAL_TASKS); /** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself - * is started. This must be exeucted before any scheduler function calls other than Scheduler_Start(), - * and can be ommitted if no such functions could be called before the scheduler is started. + * is started. This must be executed before any scheduler function calls other than Scheduler_Start(), + * and can be omitted if no such functions could be called before the scheduler is started. */ #define Scheduler_Init() Scheduler_InitScheduler(TOTAL_TASKS); @@ -194,7 +194,7 @@ * * Usage Example: * \code - * 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)) -- cgit v1.2.3