Commit 0f45b9c8 authored by Dean Camera's avatar Dean Camera
Browse files

More spell checking of all source files -- correct missed errors, switch to...

More spell checking of all source files -- correct missed errors, switch to EN-GB spelling dictionary.
parent 2034141a
......@@ -96,7 +96,7 @@
/** Enum for the possible NDIS adapter states. */
enum RNDIS_States_t
{
RNDIS_Uninitialized = 0, /**< Adapter currently uninitialized. */
RNDIS_Uninitialized = 0, /**< Adapter currently uninitialised. */
RNDIS_Initialized = 1, /**< Adapter currently initialized but not ready for data transfers. */
RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */
};
......
......@@ -129,7 +129,7 @@
/** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the
* \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.
* \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
*
......
......@@ -143,7 +143,7 @@
MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
/** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
* \ref MIDI_Host_SendEventPacket() function's packing behavior, to flush queued events. Events are queued into the
* \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
* pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
* events to be packed into a single pipe packet, increasing data throughput.
*
......
......@@ -158,7 +158,7 @@
*/
uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
/** Initialises the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
* configured via the call to \ref RNDIS_Host_ConfigurePipes().
*
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state.
......
......@@ -218,7 +218,7 @@
* function. The routine updates the position and remaining configuration descriptor bytes values
* automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
* so that the next descriptor search invocation will start from the descriptor which first caused the
* original search to fail. This behavior allows for one comparator to be used immediately after another
* original search to fail. This behaviour allows for one comparator to be used immediately after another
* has failed, starting the second search from the descriptor which failed the first.
*
* Comparator functions should be standard functions which accept a pointer to the header of the current
......
......@@ -189,7 +189,7 @@
* \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
* this means that the current connection state is derived from the bus suspension and wake up events by default,
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n
......@@ -207,7 +207,7 @@
* \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
* this means that the current connection state is derived from the bus suspension and wake up events by default,
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n
......
......@@ -264,7 +264,7 @@
* Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.
*
* \param[in] Options Mask indicating the options which should be used when initializing the USB
* interface to control the USB interface's behavior. This should be comprised of
* interface to control the USB interface's behaviour. This should be comprised of
* a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the
* PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
* mode speed.
......
......@@ -37,11 +37,11 @@
* - The software UART in the XPLAINBridge has been largely altered to try to improve upon its performance and reliability
* - The USBtoSerial and Benito projects now flushes received data via a flush timer, so that several bytes can be transmitted at once
* - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistencies between the
* behavior of the command line tools used to perform the check on each platform
* behaviour of the command line tools used to perform the check on each platform
* - Internal USB driver source files renamed and moved to ease future possible architecture ports
* - All internal pseudo-function macros have been converted to true inline functions for type-safety and readability
* - Changed LED indicator masks for the AVRISP-MKII project, so that there are defined roles for each LED
* - Altered the CDC Deivice and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a
* - Altered the CDC Device and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a
* negative value (thanks to Andreas Paulin)
* - Added auto flushing of OUT data to the CDC Host Class driver's USBTask function to automatically flush the send pipe buffer
*
......@@ -220,7 +220,7 @@
*
* <b>Changed:</b>
* - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of key codes
* as this relied on non-standard OS driver behavior to repeat key groups
* as this relied on non-standard OS driver behaviour to repeat key groups
* - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class
* driver common defines, rather than being defined in the Host mode Class driver section only
* - The USB_MODE_HOST token is now defined even when host mode is not available
......@@ -254,7 +254,7 @@
* devices from timing out the data pipes
* - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts
* - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing
* - Fixed use of deprecated struct initializers, removed library unused parameter warnings when compiled with -Wextra enabled
* - Fixed use of deprecated struct initialisers, removed library unused parameter warnings when compiled with -Wextra enabled
* - Fixed Still Image Host Class driver truncating the PIMA response code (thanks to Daniel Seibert)
* - Fixed USB_CurrentMode not being reset to USB_MODE_NONE when the USB interface is shut down and both Host and Device modes can be
* used (thanks to Daniel Levy)
......@@ -338,7 +338,7 @@
* - Added new "Common" section to the class drivers, to hold all mode-independent definitions for clarity
* - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code
* - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls
* - Changed the parameters and behavior of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
* - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
* and data validations internally, to simplify user code
* - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles
* - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect
......@@ -540,7 +540,7 @@
* USB_INITERROR_NoUSBModeSpecified
* - Renamed USB_PowerOnFail event to USB_InitFailure
* - Renamed OTG.h header functions to be more consistent with the rest of the library API
* - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)
* - Changed over all deprecated GCC structure tag initialisers to the standardized C99 format (thanks to Mike Alexander)
* - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode
* rather than having the library pass only partially read header data to the application
* - The USB_UnhandledControlPacket event has had its parameters removed, in favor of accessing the new USB_ControlRequest structure
......
......@@ -7,7 +7,7 @@
/** \page Page_TokenSummary Summary of Compile Tokens
*
* The following lists all the possible tokens which can be defined in a project makefile, and passed to the
* compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behavior,
* compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
* or remove features unused by a given application in order to save flash space.
*
*
......@@ -87,7 +87,7 @@
* due to the extra code required to deal with byte alignment.
*
* <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behavior, including whether the USB pad
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
* voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
* mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
......
......@@ -81,7 +81,7 @@
* <b>Host Mode</b>
* - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
* packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
* pipe bank is full. To override this new behavior and revert to the previous behavior, the user application may manually
* pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
* flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().
* - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address
* is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint
......@@ -90,7 +90,7 @@
* <b>Device Mode</b>
* - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
* packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
* endpoint bank is full. To override this new behavior and revert to the previous behavior, the user application may manually
* endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
* flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
*
* \section Sec_Migration091223 Migrating from 091122 to 091223
......@@ -122,11 +122,11 @@
* - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library.
* - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See
* the \ref SPI_Init() function documentation for more details
* - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a
* - The \ref Dataflash_Init() routine no longer initialises the SPI bus - the SPI bus should be initialized manually via a
* call to SPI_Init() before using the Dataflash driver
*
* <b>Host Mode</b>
* - The USB_GetDeviceConfigDescriptor() function's parameters and behavior has changed; the user is required to
* - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
* preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
* call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
* application perform these intermediary steps.
......@@ -435,7 +435,7 @@
*
* <b>Library Demos</b>
* - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
* of the RNDIS specification, which had non-standard behavior. Projects built upon the demo should upgrade
* of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
* to the latest code.
* - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
* possible any existing devices upgrade to the latest bootloader code.
......
......@@ -145,7 +145,7 @@
*/
void Scheduler_Start(void);
/** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself
/** Initialises the scheduler so that the scheduler functions can be called before the scheduler itself
* 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.
*/
......
......@@ -203,7 +203,7 @@
*
* \section SSec_Options Project Options
*
* The following defines can be found in this project, which can control the project behavior when defined, or changed in value.
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*
* <table>
* <tr>
......
......@@ -132,7 +132,7 @@ ISR(TIMER1_COMPA_vect, ISR_BLOCK)
PORTB ^= (1 << 1);
}
/** Initializes the appropriate SPI driver (hardware or software, depending on the selected ISP speed) ready for
/** Initialises the appropriate SPI driver (hardware or software, depending on the selected ISP speed) ready for
* communication with the attached target.
*/
void ISPTarget_Init(void)
......
......@@ -50,7 +50,7 @@ ISR(TIMER0_COMPA_vect, ISR_NOBLOCK)
TimeoutTicksRemaining--;
}
/** Initializes the hardware and software associated with the V2 protocol command handling. */
/** Initialises the hardware and software associated with the V2 protocol command handling. */
void V2Protocol_Init(void)
{
#if defined(ADC)
......
......@@ -58,7 +58,7 @@
*
* \section SSec_Options Project Options
*
* The following defines can be found in this project, which can control the project behavior when defined, or changed in value.
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*
* <table>
* <tr>
......
......@@ -62,7 +62,7 @@
} RingBuff_t;
/* Inline Functions: */
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
/** Initialises a ring buffer ready for use. Buffers must be initialized via this function
* before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function.
*
......@@ -172,4 +172,4 @@
}
#endif
\ No newline at end of file
......@@ -50,7 +50,7 @@
*
* \section SSec_Options Project Options
*
* The following defines can be found in this project, which can control the project behavior when defined, or changed in value.
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*
* <table>
* <tr>
......
......@@ -71,7 +71,7 @@
} BitBuffer_t;
/* Function Prototypes: */
/** Initializes or resets a given bit buffer, ready to store new bits.
/** Initialises or resets a given bit buffer, ready to store new bits.
*
* \param[in,out] Buffer Bit buffer to initialize
*/
......
......@@ -76,7 +76,7 @@
/* Public Interface - May be used in end-application: */
/* Inline Functions: */
/** Initializes the magnetic stripe card reader ports and pins so that the card reader
/** Initialises the magnetic stripe card reader ports and pins so that the card reader
* device can be controlled and read by the card reader driver. This must be called before
* trying to read any of the card reader's status lines.
*/
......
......@@ -97,7 +97,7 @@
*
* \section SSec_Options Project Options
*
* The following defines can be found in this project, which can control the project behavior when defined, or changed in value.
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*
* <table>
* <tr>
......
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