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

All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected.

Browse source
This commit is contained in:
Dean Camera 2009-04-01 13:53:58 +00:00
parent fb3fcb968e
commit 6933f2e1a5
95 changed files with 274 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Demos/Host/CDCHost/CDCHost.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"CDC Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -196,7 +196,7 @@ TASK(USB_CDC_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -248,7 +248,7 @@ TASK(USB_CDC_Host)
uint16_t BufferLength = Pipe_BytesInPipe();
uint8_t Buffer[BufferLength];
/* Read in the pipe data to the tempoary buffer */
/* Read in the pipe data to the temporary buffer */
Pipe_Read_Stream_LE(Buffer, BufferLength);
/* Clear the pipe after it is read, ready for the next packet */

2
Demos/Host/CDCHost/ConfigDescriptor.h
View file

@ -73,7 +73,7 @@
DescriptorTooLarge = 2, /**< The device's Configuration Descriptor is too large to process */
InvalidConfigDataReturned = 3, /**< The device returned an invalid Configuration Descriptor */
NoCDCInterfaceFound = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
NoEndpointFound = 5, /**< Cmpatible CDC endpoints were not found in the device's CDC interface */
NoEndpointFound = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
};
/* Configuration Descriptor Comparison Functions: */

6
Demos/Host/GenericHIDHost/GenericHIDHost.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Generic HID Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -288,7 +288,7 @@ TASK(USB_HID_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));

8
Demos/Host/KeyboardHost/KeyboardHost.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -263,7 +263,7 @@ TASK(USB_Keyboard_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -310,7 +310,7 @@ TASK(USB_Keyboard_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Protocol).\r\n"));

2
Demos/Host/KeyboardHostWithParser/HIDReport.h
View file

@ -51,7 +51,7 @@
{
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
ParseError = 1, /**< Failed to fully process the HID report descriptor */
ParseControlError = 2, /**< Control error occured while trying to read the device HID descriptor */
ParseControlError = 2, /**< Control error occurred while trying to read the device HID descriptor */
};
/* Type Defines: */

10
Demos/Host/KeyboardHostWithParser/KeyboardHostWithParser.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -199,7 +199,7 @@ TASK(USB_Keyboard_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -255,7 +255,7 @@ TASK(USB_Keyboard_Host)
break;
}
/* All LEDs off - ready to indicate keypresses */
/* All LEDs off - ready to indicate key presses */
UpdateStatus(Status_USBReady);
puts_P(PSTR("Keyboard Enumerated.\r\n"));
@ -282,7 +282,7 @@ TASK(USB_Keyboard_Host)
/* Check each HID report item in turn, looking for keyboard scan code reports */
for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
{
/* Create a tempoary item pointer to the next report item */
/* Create a temporary item pointer to the next report item */
HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
/* Check if the current report item is a keyboard scancode */

12
Demos/Host/MassStorageHost/MassStorageHost.c
View file

@ -74,7 +74,7 @@ int main(void)
/* Indicate USB not ready */
UpdateStatus(Status_USBNotReady);
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"MassStore Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -137,7 +137,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -170,7 +170,7 @@ TASK(USB_MassStore_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -222,7 +222,7 @@ TASK(USB_MassStore_Host)
break;
}
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)
{
ShowDiskReadError(PSTR("Get Max LUN"), ErrorCode);
@ -240,7 +240,7 @@ TASK(USB_MassStore_Host)
}
/* Get sense data from the device - many devices will not accept any other commands until the sense data
* is read - both on startup and after a failed command */
* is read - both on start-up and after a failed command */
SCSI_Request_Sense_Response_t SenseData;
if ((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0)
{
@ -397,7 +397,7 @@ void UpdateStatus(uint8_t CurrentStatus)
LEDs_SetAllLEDs(LEDMask);
}
/** Indicates that a communication error has ocurred with the attached Mass Storage Device,
/** Indicates that a communication error has occurred with the attached Mass Storage Device,
* printing error codes to the serial port and waiting until the device is removed before
* continuing.
*

2
Demos/Host/MassStorageHost/MassStorageHost.h
View file

@ -66,7 +66,7 @@
Status_EnumerationError = 3, /**< Software error while enumerating the attached USB device */
Status_HardwareError = 4, /**< Hardware error while enumerating the attached USB device */
Status_Busy = 5, /**< Busy reading or writing to the attached Mass Storage device */
Status_SCSICommandError = 6, /**< Error sending or recieving a command to or from the attached SCSI device */
Status_SCSICommandError = 6, /**< Error sending or receiving a command to or from the attached SCSI device */
};
/* Task Definitions: */

12
Demos/Host/MassStorageHost/MassStoreCommands.c
View file

@ -37,8 +37,8 @@
* to a FAT library to give file-level access to an attached device's contents.
*
* \note Many Mass Storage devices on the market are non-compliant to the
* specifications and thus can proove difficult to interface with. It
* may be neccesary to retry the functions in the module several times
* specifications and thus can prove difficult to interface with. It
* may be necessary to retry the functions in the module several times
* after they have returned and error to successfully send the command
* to the device. Some devices may also need to have the stream function
* timeout period extended beyond 100ms (some badly designed devices exceeding
@ -52,17 +52,17 @@
/* Globals: */
/** Current CBW to send to the device. This is automatically filled by the routines
* in this file and is not externally accessable.
* in this file and is not externally accessible.
*/
static CommandBlockWrapper_t SCSICommandBlock;
/** Current CSW received from the device. This is automatically filled by the routines
* in this file and is externally accessable so that the return codes may be checked.
* in this file and is externally accessible so that the return codes may be checked.
*/
CommandStatusWrapper_t SCSICommandStatus;
/** Current Tag value used in issued CBWs to the device. This is automatically incremented
* by the routines in this file, and is not externally accessable.
* by the routines in this file, and is not externally accessible.
*/
static uint32_t MassStore_Tag = 1;
@ -122,7 +122,7 @@ static uint8_t MassStore_WaitForDataReceived(void)
/* Check to see if a new frame has been issued (1ms elapsed) */
if (USB_INT_HasOccurred(USB_INT_HSOFI))
{
/* Clear the flag and decrement the timout period counter */
/* Clear the flag and decrement the timeout period counter */
USB_INT_Clear(USB_INT_HSOFI);
TimeoutMSRem--;

6
Demos/Host/MassStorageHost/MassStoreCommands.h
View file

@ -54,7 +54,7 @@
/** Command Block Wrapper signature byte, for verification of valid CBW blocks */
#define CBW_SIGNATURE 0x43425355UL
/** Command Statuc Wrapper signature byte, for verification of valid CSW blocks */
/** Command Static Wrapper signature byte, for verification of valid CSW blocks */
#define CSW_SIGNATURE 0x53425355UL
/** Data direction mask for the Flags field of a CBW, indicating Host-to-Device transfer direction */
@ -98,13 +98,13 @@
{
uint32_t Signature; /**< Command status signature, always equal to CSW_SIGNATURE */
uint32_t Tag; /**< Current CBW tag, to positively associate a CBW with a CSW */
uint32_t DataTransferResidue; /**< Length of data not transfered */
uint32_t DataTransferResidue; /**< Length of data not transferred */
uint8_t Status; /**< Command status, a value from the MassStorageHost_CommandStatusCodes_t enum */
} CommandStatusWrapper_t;
/** Type define for a SCSI Sense structure. Structures of this type are filled out by the
* device via the MassStore_RequestSense() function, indicating the current sense data of the
* device (giving explitic error codes for the last issued command). For details of the
* device (giving explicit error codes for the last issued command). For details of the
* structure contents, refer to the SCSI specifications.
*/
typedef struct

8
Demos/Host/MouseHost/MouseHost.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -259,7 +259,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -306,7 +306,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Protocol).\r\n"));

2
Demos/Host/MouseHostWithParser/HIDReport.h
View file

@ -60,7 +60,7 @@
{
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
ParseError = 1, /**< Failed to fully process the HID report descriptor */
ParseControlError = 2, /**< Control error occured while trying to read the device HID descriptor */
ParseControlError = 2, /**< Control error occurred while trying to read the device HID descriptor */
};
/* Type Defines: */

10
Demos/Host/MouseHostWithParser/MouseHostWithParser.c
View file

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -200,7 +200,7 @@ TASK(USB_Mouse_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control Error (Set Configuration).\r\n"));
@ -256,7 +256,7 @@ TASK(USB_Mouse_Host)
break;
}
/* All LEDs off - ready to indicate keypresses */
/* All LEDs off - ready to indicate key presses */
UpdateStatus(Status_USBReady);
puts_P(PSTR("Mouse Enumerated.\r\n"));
@ -285,7 +285,7 @@ TASK(USB_Mouse_Host)
/* Check each HID report item in turn, looking for mouse X/Y/button reports */
for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
{
/* Create a tempoary item pointer to the next report item */
/* Create a temporary item pointer to the next report item */
HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
bool FoundData;

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

@ -111,7 +111,7 @@ uint8_t SImage_RecieveBlockHeader(void)
/* Check to see if a new frame has been issued (1ms elapsed) */
if (USB_INT_HasOccurred(USB_INT_HSOFI))
{
/* Clear the flag and decrement the timout period counter */
/* Clear the flag and decrement the timeout period counter */
USB_INT_Clear(USB_INT_HSOFI);
TimeoutMSRem--;

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

@ -62,7 +62,7 @@
(params * sizeof(PIMA_SendBlock.Params[0])))
/* Type Defines: */
/** Type define for a PIMA container, use to send commands and receieve responses to and from an
/** Type define for a PIMA container, use to send commands and receive responses to and from an
* attached Still Image device.
*/
typedef struct

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

@ -75,7 +75,7 @@ int main(void)
/* Initialize USB Subsystem */
USB_Init();
/* Startup message */
/* Start-up message */
puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
"Still Image Host Demo running.\r\n" ESC_INVERSE_OFF));
@ -132,7 +132,7 @@ EVENT_HANDLER(USB_HostError)
for(;;);
}
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
* enumerating an attached USB device.
*/
EVENT_HANDLER(USB_DeviceEnumerationFailed)
@ -165,7 +165,7 @@ TASK(USB_SImage_Host)
wLength: 0,
};
/* Send the request, display error and wait for device detatch if request fails */
/* Send the request, display error and wait for device detach if request fails */
if (USB_Host_SendControlRequest(NULL) != HOST_SENDCONTROL_Successful)
{
puts_P(PSTR("Control error.\r\n"));
@ -223,7 +223,7 @@ TASK(USB_SImage_Host)
/* Send the GETDEVICEINFO block */
SImage_SendBlockHeader();
/* Recieve the response data block */
/* Receive the response data block */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
@ -274,7 +274,7 @@ TASK(USB_SImage_Host)
UnicodeToASCII(DeviceInfoPos, DeviceVersion);
printf_P(PSTR(" Device Version: %s\r\n"), DeviceVersion);
/* Recieve the final response block from the device */
/* Receive the final response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
@ -302,7 +302,7 @@ TASK(USB_SImage_Host)
/* Send the OPENSESSION block, open a session with an ID of 0x0001 */
SImage_SendBlockHeader();
/* Recieve the response block from the device */
/* Receive the response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);
@ -330,7 +330,7 @@ TASK(USB_SImage_Host)
/* Send the CLOSESESSION block, close the session with an ID of 0x0001 */
SImage_SendBlockHeader();
/* Recieve the response block from the device */
/* Receive the response block from the device */
if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)
{
ShowCommandError(ErrorCode, false);