ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Spell checked non-source documentation pages.

Browse source
This commit is contained in:
Dean Camera 2009-04-19 14:29:57 +00:00
parent 663f449c10
commit 619b0b7b6b
27 changed files with 100 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Demos/Device/AudioInput/AudioInput.txt
View 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>
*/
*/

6
Demos/Device/AudioOutput/AudioOutput.txt
View 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>
*/
*/

6
Demos/Device/GenericHID/GenericHID.txt
View 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>
*/
*/

8
Demos/Device/Keyboard/Keyboard.txt
View 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>
*/
*/

8
Demos/Device/KeyboardMouse/KeyboardMouse.txt
View 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>
*/
*/

4
Demos/Device/MIDI/MIDI.txt
View 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>
*/
*/

6
Demos/Device/MassStorage/MassStorage.txt
View 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>
*/
*/

4
Demos/Device/Mouse/Mouse.txt
View 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>
*/
*/

6
Demos/Host/CDCHost/CDCHost.txt
View 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>
*/
*/

4
Demos/Host/GenericHIDHost/GenericHIDHost.txt
View 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>
*/
*/

4
Demos/Host/KeyboardHost/KeyboardHost.txt
View 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>
*/
*/

4
Demos/Host/MouseHost/MouseHost.txt
View 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>
*/
*/

4
Demos/Host/StillImageHost/StillImageCommands.c
View 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,
};

2
Demos/Host/StillImageHost/StillImageCommands.h
View file

@ -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

2
Demos/Host/StillImageHost/StillImageHost.c
View file

@ -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)
{

4
Demos/OTG/TestApp/TestApp.txt
View file

@ -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>
*/
*/