Commit 619b0b7b authored by Dean Camera's avatar Dean Camera
Browse files

Spell checked non-source documentation pages.

parent 663f449c
......@@ -44,9 +44,9 @@
* As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
* software, available for download at http://sourceforge.net/projects/dfu-programmer/.
*
* If SECURE_MODE is defined as true, upon startup the bootloader will be locked, with only the chip erase
* If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase
* function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
* are usable on startup without the prerequisite firmware erase.
* are usable on start-up without the prerequisite firmware erase.
*
* Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
* you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
......@@ -69,8 +69,8 @@
* <tr>
* <td>SECURE_MODE</td>
* <td>BootloaderDFU.h</td>
* <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on statup, until an
* erase has been perfomed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
* <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
* erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
* being dumped by unauthorized persons.</td>
* </tr>
* <tr>
......@@ -81,4 +81,4 @@
* manually in the makefile CDEFS.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -42,7 +42,7 @@
*
* Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
*
* This spoofs (with permission) the offical Teensy bootloader's VID and PID, so that the software remains
* This spoofs (with permission) the official Teensy bootloader's VID and PID, so that the software remains
* compatible with no changes.
*
* \section SSec_Options Project Options
......@@ -56,4 +56,4 @@
* </td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -42,8 +42,8 @@
* basic USB Audio drivers in all modern OSes (i.e. no special drivers
* required).
*
* On startup the system will automatically enumerate and function
* as a USB microphone. Incomming audio from the ADC channel 1 will
* On start-up the system will automatically enumerate and function
* as a USB microphone. Incoming audio from the ADC channel 1 will
* be sampled and sent to the host computer.
*
* To use, connect a microphone to the ADC channel 2.
......@@ -72,4 +72,4 @@
* <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -42,8 +42,8 @@
* basic USB Audio drivers in all modern OSes (i.e. no special drivers
* required).
*
* On startup the system will automatically enumerate and function
* as a USB speaker. Incomming audio will output in 8-bit PWM onto
* On start-up the system will automatically enumerate and function
* as a USB speaker. Incoming audio will output in 8-bit PWM onto
* the timer output (timer 3 for the AT90USBXXX6/7 USB AVRs, timer 1 for
* the AT90USBXXX2 controller AVRs) compare channel A for AUDIO_OUT_MONO
* mode, on channels A and B for AUDIO_OUT_STEREO and on the board LEDs
......@@ -90,4 +90,4 @@
* <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -40,7 +40,7 @@
* OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to
* and from a USB Host, and by default transmits the last sent report back to the host.
*
* On startup the system will automatically enumerate and function as a vendor HID device.
* On start-up the system will automatically enumerate and function as a vendor HID device.
* When controlled by a custom HID class application, reports can be sent and received by
* both the standard data endpoint and control request methods defined in the HID specification.
*
......@@ -71,8 +71,8 @@
* <td>INTERRUPT_DATA_ENDPOINT</td>
* <td>Makefile CDEFS</td>
* <td>When defined, this causes the demo to enable interrupts for the data endpoints,
* which services incomming LED reports and outgoing key status reports to and from the host.
* which services incoming LED reports and outgoing key status reports to and from the host.
* If not defined, the data endpoints are serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -40,11 +40,11 @@
* OSes (i.e. no special drivers required). It is boot protocol compatible, and thus
* works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
*
* On startup the system will automatically enumerate and function
* On start-up the system will automatically enumerate and function
* as a keyboard when the USB connection to a host is present. To use
* the keyboard example, manipulate the joystick to send the letters
* a, b, c, d and e. See the USB HID documentation for more information
* on sending keyboard event and keypresses.
* on sending keyboard event and key presses.
*
* \section SSec_Options Project Options
*
......@@ -67,8 +67,8 @@
* <td>INTERRUPT_DATA_ENDPOINT</td>
* <td>Makefile CDEFS</td>
* <td>When defined, this causes the demo to enable interrupts for the data endpoints,
* which services incomming LED reports and outgoing key status reports to and from the host.
* which services incoming LED reports and outgoing key status reports to and from the host.
* If not defined, the data endpoints are serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -38,15 +38,15 @@
* Keyboard/Mouse demonstration application. This gives a simple reference
* application for implementing a composite device containing both USB Keyboard
* and USB Mouse functionality using the basic USB HID drivers in all modern OSes
* (i.e. no special drivers required). This example uses two seperate HID
* (i.e. no special drivers required). This example uses two separate HID
* interfaces for each function. It is boot protocol compatible, and thus works under
* compatible BIOS as if it was a native keyboard and mouse (e.g. PS/2).
*
* On startup the system will automatically enumerate and function
* On start-up the system will automatically enumerate and function
* as a keyboard when the USB connection to a host is present and the HWB is not
* pressed. When enabled, manipulate the joystick to send the letters
* a, b, c, d and e. See the USB HID documentation for more information
* on sending keyboard event and keypresses.
* on sending keyboard event and key presses.
*
* When the HWB is pressed, the mouse mode is enabled. When enabled, move the
* joystick to move the pointer, and push the joystick inwards to simulate a
......@@ -63,4 +63,4 @@
* </td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -26,7 +26,7 @@
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>USBIF Audio Class Specification</td>
* <td>USB-MIDI Audio Class Extention Specification</td>
* <td>USB-MIDI Audio Class Extension Specification</td>
* <td>General MIDI Specification</td>
* </tr>
* <tr>
......@@ -62,4 +62,4 @@
* </td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -43,8 +43,8 @@
* device using the basic USB UFI drivers in all modern OSes (i.e. no
* special drivers required).
*
* On startup the system will automatically enumerate and function as an
* external mass storage device with two LUNs (seperate disks) which may
* On start-up the system will automatically enumerate and function as an
* external mass storage device with two LUNs (separate disks) which may
* be formatted and used in the same manner as commercial USB Mass Storage
* devices.
*
......@@ -75,4 +75,4 @@
* - this can be set to any positive non-zero amount.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -41,7 +41,7 @@
* boot protocol compatible, and thus works under compatible BIOS as if
* it was a native mouse (e.g. PS/2).
*
* On startup the system will automatically enumerate and function
* On start-up the system will automatically enumerate and function
* as a mouse when the USB connection to a host is present. To use
* the mouse, move the joystick to move the pointer, and push the
* joystick inwards to simulate a left-button click. The HWB serves as
......@@ -72,4 +72,4 @@
* the data endpoint is serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -42,8 +42,8 @@
*
* Not that this demo is only compatible with devices which report the correct CDC
* and ACM class, subclass and protocol values. Most USB-Serial cables have vendor
* specific features, thus use vendor-specfic class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compaible with such devices.
* specific features, thus use vendor-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.
*
* \section SSec_Options Project Options
*
......@@ -56,4 +56,4 @@
* </td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -36,7 +36,7 @@
* \section SSec_Description Project Description:
*
* Generic HID host demonstration application. This gives a simple reference
* application for implementing a Genric HID USB host, for any device implementing
* application for implementing a Generic HID USB host, for any device implementing
* the HID profile.
*
* Received reports from the attached device are printed to the serial port.
......@@ -59,4 +59,4 @@
* serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -45,7 +45,7 @@
* This uses a naive method where the keyboard is set to Boot Protocol mode, so
* that the report structure is fixed and known. A better implementation
* uses the HID report parser for correct report data processing across
* all compatable mice with advanced characteristics, as shown in the
* all compatible mice with advanced characteristics, as shown in the
* KeyboardHostWithParser demo application.
*
* Currently only single interface keyboards are supported.
......@@ -68,4 +68,4 @@
* serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -46,7 +46,7 @@
* This uses a naive method where the mouse is set to Boot Protocol mode, so
* that the report structure is fixed and known. A better implementation
* uses the HID report parser for correct report data processing across
* all compatable mice with advanced characteristics, as shown in the
* all compatible mice with advanced characteristics, as shown in the
* MouseHostWithParser demo application.
*
* Currently only single interface mice are supported.
......@@ -69,4 +69,4 @@
* serviced via polling using the task scheduler.</td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -261,14 +261,14 @@ bool SImage_IsEventReceived(void)
*
* \return A value from the USB_Host_SendControlErrorCodes_t enum
*/
uint8_t SImage_ClearPipeStall(const uint8_t PipeEndpointNum)
uint8_t SImage_ClearPipeStall(const uint8_t EndpointNum)
{
USB_HostRequest = (USB_Host_Request_Header_t)
{
bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_ENDPOINT),
bRequest: REQ_ClearFeature,
wValue: FEATURE_ENDPOINT_HALT,
wIndex: PipeEndpointNum,
wIndex: EndpointNum,
wLength: 0,
};
......
......@@ -105,6 +105,6 @@
void SImage_SendData(void* Buffer, uint16_t Bytes);
uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes);
bool SImage_IsEventReceived(void);
uint8_t SImage_ClearPipeStall(const uint8_t PipeEndpointNum);
uint8_t SImage_ClearPipeStall(const uint8_t EndpointNum);
#endif
......@@ -417,7 +417,7 @@ void UpdateStatus(uint8_t CurrentStatus)
/** Displays a PIMA command error via the device's serial port.
*
* \param ErrorCode Error code of the function which failed to complete successfully
* \param ResponseErrorCode Indicates if the error is due to a command failed indication from the device, or a communication failure
* \param ResponseCodeError Indicates if the error is due to a command failed indication from the device, or a communication failure
*/
void ShowCommandError(uint8_t ErrorCode, bool ResponseCodeError)
{
......
......@@ -36,7 +36,7 @@
* \section SSec_Description Project Description:
*
* Test application. Demonstrates several aspects of the LUFA
* Library. On startup the current temperature will be printed
* Library. On start-up the current temperature will be printed
* through the USART every 10 seconds, and the current joystick
* position will be indicated via the LEDs on the selected board.
* Pressing the HWB will initiate the USB subsystem, enumerating
......@@ -66,4 +66,4 @@
* </td>
* </tr>
* </table>
*/
\ No newline at end of file
*/
......@@ -24,7 +24,7 @@
* code without having to be itself patched and recompiled first
* - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to
* outdated avr-libc versions.
* - Added support to the CDCHost demo for devices with mutiple CDC interfaces which are not the correct ACM type preceeding the desired
* - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired
* ACM CDC interface
* - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)
* - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley)
......@@ -53,7 +53,7 @@
* device descriptor
* - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name
* - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman)
* - Capitolised the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and
* - Capitalised the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and
* DSearch_Comp_Return_ErrorCodes_t enums
*
*
......@@ -63,7 +63,7 @@
* - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations
* - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data
* - LUFA devices now enumerate correctly with LUFA hosts
* - Fixed Configuration Descriptor search routine freezing when a comparitor returned a failure
* - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure
* - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and
* slowed down the enumeration of HID devices too much
* - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7
......@@ -91,7 +91,7 @@
* - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos
* - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos
* - Removed AVRISP_Programmer project due to code quality concerns
* - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data
* - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data
* - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
* - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
* - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
......@@ -133,7 +133,7 @@
* - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol
* - Added new "dfu" and "flip" programming targets to project makefiles
* - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful
* - Changed COLLECTION item strucutres in the HID descriptor parser to include the collection's Usage Page value
* - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value
* - Serial driver now sets Tx line as output, enables pullup on Rx line
* - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled
* - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated
......@@ -189,7 +189,7 @@
* easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes
* - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software
* - Fixed RNDIS demo ICMP ping requests echoing back incorrect data
* - Added DHCP server code to RNDIS demo, allowing for hands-free autoconfiguration on any PC
* - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC
* - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR
* - Endpoint and Pipe configuration functions now return an error code indicating success or failure
* - USB Reset in device mode now resets and disables all device endpoints
......@@ -197,7 +197,7 @@
* invocation when in host mode
* - Added support for the ATMEGA32U6 microcontroller
* - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage
* - Removed redudant code from the USB device GetStatus() chapter 9 processing routine
* - Removed redundant code from the USB device GetStatus() chapter 9 processing routine
* - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)
* - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers
* - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host
......@@ -211,7 +211,7 @@
* - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)
* - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes
* - Removed serial number strings from all but the MassStore demo where it is required - users were not
* modifing the code to either ommit the descriptor or use a unique serial per device causing problems
* modifying the code to either omit the descriptor or use a unique serial per device causing problems
* when multiple units of the same device were plugged in at the same time
* - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host
* - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)
......@@ -289,7 +289,7 @@
* - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction
* size bits not required for the routines (improves compatibility with devices)
* - Fixed AudioInput demo - now correctly sends sampled audio to the host PC
* - Fixed AudioOutput demo oncemore -- apparently Windows requires endpoint packets to be >=192 bytes
* - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes
* - Shrunk round-robbin scheduler code slightly via the use of struct pointers rather than array indexes
* - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser
* - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder
......@@ -298,25 +298,25 @@
* - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently
* handled via interrupts while other endpoints are serviced through polling
* - Fixed device signature being sent in reverse order in the CDC bootloader
* - Host demos now have a seperate ConfigDescriptor.c/.h file for configuration descriptor processing
* - HostWithParser demos now have a seperate HIDReport.c/.h file for HID report processing and dumping
* - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing
* - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping
* - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value
* - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host
* - Updated demo descriptors to use VID/PID values donated by Atmel
* - Added DoxyGen documentation to the source files
* - Fixed Serial_IsCharRecieved() definition, was previously reversed
* - Removed seperate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
* - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
* - Removed unused Device Qualifier descriptor structure
* - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged
* - Fixed MassStorageHost demo reading in the block data in reverse
* - Removed outdated typedefs in StdRequestType.h, superceeded by the macro masks
* - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks
* - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products
* - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration
* - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete
* - USB_HOST_TIMEOUT_MS is now overridable in the user project makefile to a custom fixed timeout value
* - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()
* and USB_Host_IsBusSuspended()
* - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistant, Pipe_SetInterruptFreq() is now
* - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now
* Pipe_SetInterruptPeriod() to use the correct terminology
* - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC
* Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays
......@@ -361,7 +361,7 @@
* new comparator API
* - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct
* big-endian for SCSI devices
* - Fixed macro/function naming consistancy; USB_HOST is now USB_Host, USB_DEV is now USB_Device
* - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device
* - Added better error reporting to host demos
* - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls
*
......@@ -374,7 +374,7 @@
* GetLineCoding request had an incorrect RequestType mask preventing it from being processed
* - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
* - Device control endpoint size is now determined from the device's descriptors rather than being fixed
* - Seperated out SPI code into new SPI driver in AT90USBXXX driver directory
* - Separated out SPI code into new SPI driver in AT90USBXXX driver directory
* - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
* - Added support for the RZUSBSTICK board
* - Bicolour driver removed in favour of generic LEDs driver
......@@ -412,7 +412,7 @@
*
* \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008
*
* - Unneccesary control endpoint config removed from device mode
* - Unnecessary control endpoint config removed from device mode
* - Fixed device standard request interpreter accidentally processing some class-specific requests
* - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library
* to use descriptors stored in RAM or EEPROM rather than flash memory
......@@ -431,7 +431,7 @@
* - Added support for the STK525 and STK526 boards
* - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and
* placing board drivers in {Application Directory}/Board/
* - PLL is now stopped and USB clock is frozen when detatched from host in device mode, to save power
* - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power
* - Joystick defines are now in synch with the schematics - orientation will be rotated for the USBKEY
* - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register
* - Fixed data transfers to devices when in host mode
......@@ -479,4 +479,4 @@
* - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
* - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
* Endpoint_IsConfigured() after calling the config functions to determine success
*/
\ No newline at end of file
*/
......@@ -21,11 +21,11 @@
* the source code at compile time.
*
* <b>NUM_BLOCKS</b> - ( \ref Group_MemoryAllocator ) \n
* Sets the number of allocable blocks in the psudo-heap of the dynamic memory allocation driver. This should be
* Sets the number of allocable blocks in the pseudo-heap of the dynamic memory allocation driver. This should be
* defined as a constant larger than zero.
*
* <b>BLOCK_SIZE</b> - ( \ref Group_MemoryAllocator ) \n
* Sets the size of each allocable block in the psudo-heap of the dynamic memory allocation driver. This should be
* Sets the size of each allocable block in the pseudo-heap of the dynamic memory allocation driver. This should be
* defined as a constant larger than zero.
*
* <b>NUM_HANDLES</b> - ( \ref Group_MemoryAllocator ) \n
......@@ -42,7 +42,7 @@
* skipped when processing a device HID report.
*
* <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - ( \ref Group_HIDParser ) \n
* By default, constant data items (usually used as spacers to align seperate report items to a byte or word boundary)
* By default, constant data items (usually used as spacers to align separate report items to a byte or word boundary)
* in the HID report are skipped during report processing. It is highly unusual for an application to make any use of
* constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining
* this switch will put constant data items into the processed HID report structure.
......@@ -57,12 +57,12 @@
* HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession
* when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with
* different usages in a compact manner. This token may be defined to a non-zero value to set the maximum depth of the
* usage stack, indicating the maximum number of USAGE items which can be stored tempoarily until the next INPUT, OUTPUT
* usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT
* and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation.
*
* <b>HID_MAX_COLLECTIONS</b> - ( \ref Group_HIDParser ) \n
* HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information
* is stored seperately in the processed usage structure (and referred to by the data elements in the structure) to save space.
* is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space.
* This token may be defined to a non-zero value to set the maximum number of COLLECTION items which can be processed by the
* parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file
* documentation.
......@@ -71,8 +71,8 @@
* All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID
* device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which
* the report data should be interpreted by the host. This token may be defined to a non-zero value to set the maximum number of
* data elements which can be stored in the processed HID report strucuture, including INPUT, OUTPUT and (if enabled) FEATURE items.
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed seperately in the
* data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items.
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
*
*
......@@ -148,7 +148,7 @@
* <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n
* For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the
* mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevent on smaller USB AVRs which
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which
* do not support host mode.
*
* <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n
......@@ -165,5 +165,5 @@
* slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
* required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_IsConnected global
* can be accurately set and the USB_Connect and USB_Disconnect events manually raised by the RAISE_EVENT macro. When defined, this token disables
* the library's auto-detection of the connection state by the aformentioned suspension and wake up events.
* the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
*/
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