eqmk
/
qmk_firmware
forked from mfulz_github/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.

This commit is contained in:
Dean Camera 2011-06-05 13:55:56 +00:00
parent 0210fa5648
commit 7dffa15c16
93 changed files with 1750 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Bootloaders/CDC/BootloaderCDC.txt
View File

@ -95,24 +95,24 @@
* <td>NO_BLOCK_SUPPORT</td>
* <td>Makefile LUFA_OPTS</td>
* <td>Define to disable memory block read/write support in the bootloader, requiring all reads and writes to be made
* using the byte-level commands.
* using the byte-level commands.</td>
* </tr>
* <tr>
* <td>NO_EEPROM_BYTE_SUPPORT</td>
* <td>Makefile LUFA_OPTS</td>
* <td>Define to disable EEPROM memory byte read/write support in the bootloader, requiring all EEPROM reads and writes
* to be made using the block-level commands.
* to be made using the block-level commands.</td>
* </tr>
* <tr>
* <td>NO_FLASH_BYTE_SUPPORT</td>
* <td>Makefile LUFA_OPTS</td>
* <td>Define to disable FLASH memory byte read/write support in the bootloader, requiring all FLASH reads and writes
* to be made using the block-level commands.
* to be made using the block-level commands.</td>
* </tr>
* <tr>
* <td>NO_LOCK_BYTE_WRITE_SUPPORT</td>
* <td>Makefile LUFA_OPTS</td>
* <td>Define to disable lock byte write support in the bootloader, preventing the lock bits from being set progmatically.
* <td>Define to disable lock byte write support in the bootloader, preventing the lock bits from being set programmatically.</td>
* </tr>
* </table>
*/

2
Bootloaders/DFU/BootloaderDFU.c
View File

@ -87,7 +87,7 @@ static uint8_t Flash64KBPage = 0;
*/
static uint16_t StartAddr = 0x0000;
/** Memory end address, indicating the end address to read to/write from in the memory being addressed (either FLASH
/** Memory end address, indicating the end address to read from/write to in the memory being addressed (either FLASH
* of EEPROM depending on the issued command from the host).
*/
static uint16_t EndAddr = 0x0000;

2
Demos/Device/ClassDriver/AudioInput/AudioInput.h
View File

@ -57,7 +57,7 @@
/** ADC channel MUX mask for the microphone input. */
#define MIC_IN_ADC_MUX_MASK ADC_CHANNEL2
/** Maximum ADC sample value for the microphone input. */
/** Maximum audio sample value for the microphone input. */
#define SAMPLE_MAX_RANGE 0xFFFF
/** Maximum ADC range for the microphone input. */

2
Demos/Device/ClassDriver/GenericHID/GenericHID.c
View File

@ -165,7 +165,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/ClassDriver/Joystick/Joystick.c
View File

@ -175,7 +175,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/ClassDriver/Keyboard/Keyboard.c
View File

@ -177,7 +177,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
View File

@ -232,7 +232,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c
View File

@ -198,7 +198,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/ClassDriver/MIDI/MIDI.h
View File

@ -30,7 +30,7 @@
/** \file
*
* Header file for AudioOutput.c.
* Header file for MIDI.c.
*/
#ifndef _AUDIO_OUTPUT_H_

4
Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c
View File

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

4
Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c
View File

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

2
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
View File

@ -222,7 +222,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

6
Demos/Device/ClassDriver/Mouse/Mouse.c
View File

@ -93,13 +93,13 @@ void SetupHardware(void)
USB_Init();
}
/** Event handler for the library USB WakeUp event. */
/** Event handler for the library USB Connection event. */
void EVENT_USB_Device_Connect(void)
{
LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
}
/** Event handler for the library USB Suspend event. */
/** Event handler for the library USB Disconnection event. */
void EVENT_USB_Device_Disconnect(void)
{
LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
@ -175,7 +175,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

8
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
View File

@ -170,7 +170,7 @@ void TCP_Init(void)
/** Sets the state and callback handler of the given port, specified in big endian to the given state.
*
* \param[in] Port Port whose state and callback function to set, specified in big endian
* \param[in] State New state of the port, a value from the TCP_PortStates_t enum
* \param[in] State New state of the port, a value from the \ref TCP_PortStates_t enum
* \param[in] Handler Application callback handler for the port
*
* \return Boolean true if the port state was set, false otherwise (no more space in the port state table)
@ -222,7 +222,7 @@ bool TCP_SetPortState(const uint16_t Port,
*
* \param[in] Port TCP port whose state is to be retrieved, given in big-endian
*
* \return A value from the TCP_PortStates_t enum
* \return A value from the \ref TCP_PortStates_t enum
*/
uint8_t TCP_GetPortState(const uint16_t Port)
{
@ -245,7 +245,7 @@ uint8_t TCP_GetPortState(const uint16_t Port)
* \param[in] Port TCP port of the connection on the device, specified in big endian
* \param[in] RemoteAddress Remote protocol IP address of the connected device
* \param[in] RemotePort TCP port of the remote device in the connection, specified in big endian
* \param[in] State TCP connection state, a value from the TCP_ConnectionStates_t enum
* \param[in] State TCP connection state, a value from the \ref TCP_ConnectionStates_t enum
*
* \return Boolean true if the connection was updated or created, false otherwise (no more space in the connection state table)
*/
@ -290,7 +290,7 @@ bool TCP_SetConnectionState(const uint16_t Port,
* \param[in] RemoteAddress Remote protocol IP address of the connected host
* \param[in] RemotePort Remote TCP port of the connected host, specified in big endian
*
* \return A value from the TCP_ConnectionStates_t enum
* \return A value from the \ref TCP_ConnectionStates_t enum
*/
uint8_t TCP_GetConnectionState(const uint16_t Port,
const IP_Address_t RemoteAddress,

4
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
View File

@ -197,14 +197,14 @@
uint16_t RemotePort; /**< Connection port number on the host */
IP_Address_t RemoteAddress; /**< Connection protocol IP address of the host */
TCP_ConnectionInfo_t Info; /**< Connection information, including application buffer */
uint8_t State; /**< Current connection state, a value from the TCP_ConnectionStates_t enum */
uint8_t State; /**< Current connection state, a value from the \ref TCP_ConnectionStates_t enum */
} TCP_ConnectionState_t;
/** Type define for a TCP port state. */
typedef struct
{
uint16_t Port; /**< TCP port number on the device */
uint8_t State; /**< Current port state, a value from the TCP_PortStates_t enum */
uint8_t State; /**< Current port state, a value from the \ref TCP_PortStates_t enum */
void (*ApplicationHandler) (TCP_ConnectionState_t* ConnectionState,
TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */
} TCP_PortState_t;

2
Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h
View File

@ -30,7 +30,7 @@
/** \file
*
* Header file for IP.c.
* Header file for UDP.c.
*/
#ifndef _UDP_H_

4
Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c
View File

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

2
Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
View File

@ -234,7 +234,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Device/LowLevel/AudioInput/AudioInput.h
View File

@ -57,7 +57,7 @@
/** ADC channel MUX mask for the microphone input. */
#define MIC_IN_ADC_MUX_MASK ADC_CHANNEL2
/** Maximum ADC sample value for the microphone input. */
/** Maximum audio sample value for the microphone input. */
#define SAMPLE_MAX_RANGE 0xFFFF
/** Maximum ADC range for the microphone input. */

4
Demos/Device/LowLevel/GenericHID/GenericHID.c
View File

@ -148,9 +148,9 @@ void EVENT_USB_Device_ControlRequest(void)
}
}
/** Function to process the lest received report from the host.
/** Function to process the last received report from the host.
*
* \param[in] DataArray Pointer to a buffer where the last report data is stored
* \param[in] DataArray Pointer to a buffer where the last received report has been stored
*/
void ProcessGenericHIDReport(uint8_t* DataArray)
{

2
Demos/Device/LowLevel/Keyboard/Keyboard.c
View File

@ -122,7 +122,7 @@ void EVENT_USB_Device_ConfigurationChanged(void)
ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);
/* Turn on Start-of-Frame events for tracking HID report period exiry */
/* Turn on Start-of-Frame events for tracking HID report period expiry */
USB_Device_EnableSOFEvents();
/* Indicate endpoint configuration success or failure */

4
Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c
View File

@ -155,7 +155,7 @@ void DataflashManager_WriteBlocks(const uint32_t BlockAddress,
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -367,7 +367,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

2
Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
View File

@ -89,7 +89,7 @@ RNDIS_Message_Header_t* MessageHeader = (RNDIS_Message_Header_t*)&RNDISMessageBu
/** Indicates if a RNDIS message response is ready to be sent back to the host. */
bool ResponseReady = false;
/** Current RNDIS adapter state, a value from the RNDIS_States_t enum. */
/** Current RNDIS adapter state, a value from the \ref RNDIS_States_t enum. */
uint8_t CurrRNDISState = RNDIS_Uninitialized;
/** Current Ethernet packet filter mask. This is non-zero when the adapter is initialized, or zero when disabled. */

8
Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
View File

@ -169,7 +169,7 @@ void TCP_Init(void)
/** Sets the state and callback handler of the given port, specified in big endian to the given state.
*
* \param[in] Port Port whose state and callback function to set, specified in big endian
* \param[in] State New state of the port, a value from the TCP_PortStates_t enum
* \param[in] State New state of the port, a value from the \ref TCP_PortStates_t enum
* \param[in] Handler Application callback handler for the port
*
* \return Boolean true if the port state was set, false otherwise (no more space in the port state table)
@ -221,7 +221,7 @@ bool TCP_SetPortState(const uint16_t Port,
*
* \param[in] Port TCP port whose state is to be retrieved, given in big-endian
*
* \return A value from the TCP_PortStates_t enum
* \return A value from the \ref TCP_PortStates_t enum
*/
uint8_t TCP_GetPortState(const uint16_t Port)
{
@ -244,7 +244,7 @@ uint8_t TCP_GetPortState(const uint16_t Port)
* \param[in] Port TCP port of the connection on the device, specified in big endian
* \param[in] RemoteAddress Remote protocol IP address of the connected device
* \param[in] RemotePort TCP port of the remote device in the connection, specified in big endian
* \param[in] State TCP connection state, a value from the TCP_ConnectionStates_t enum
* \param[in] State TCP connection state, a value from the \ref TCP_ConnectionStates_t enum
*
* \return Boolean true if the connection was updated or created, false otherwise (no more space in the connection state table)
*/
@ -289,7 +289,7 @@ bool TCP_SetConnectionState(const uint16_t Port,
* \param[in] RemoteAddress Remote protocol IP address of the connected host
* \param[in] RemotePort Remote TCP port of the connected host, specified in big endian
*
* \return A value from the TCP_ConnectionStates_t enum
* \return A value from the \ref TCP_ConnectionStates_t enum
*/
uint8_t TCP_GetConnectionState(const uint16_t Port,
const IP_Address_t RemoteAddress,

4
Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h
View File

@ -198,14 +198,14 @@
uint16_t RemotePort; /**< Connection port number on the host */
IP_Address_t RemoteAddress; /**< Connection protocol IP address of the host */
TCP_ConnectionInfo_t Info; /**< Connection information, including application buffer */
uint8_t State; /**< Current connection state, a value from the TCP_ConnectionStates_t enum */
uint8_t State; /**< Current connection state, a value from the \ref TCP_ConnectionStates_t enum */
} TCP_ConnectionState_t;
/** Type define for a TCP port state. */
typedef struct
{
uint16_t Port; /**< TCP port number on the device */
uint8_t State; /**< Current port state, a value from the TCP_PortStates_t enum */
uint8_t State; /**< Current port state, a value from the \ref TCP_PortStates_t enum */
void (*ApplicationHandler) (TCP_ConnectionState_t* ConnectionState,
TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */
} TCP_PortState_t;

2
Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h
View File

@ -30,7 +30,7 @@
/** \file
*
* Header file for IP.c.
* Header file for UDP.c.
*/
#ifndef _UDP_H_

2
Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
View File

@ -140,7 +140,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

2
Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
View File

@ -42,7 +42,7 @@
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
* application for implementing a USB keyboard host, for USB keyboards using
* the standard keyboard HID profile.
*
* Pressed alpha-numeric, enter or space key is transmitted through the serial

2
Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt
View File

@ -46,7 +46,7 @@
*
* This demo prints out received CDC data through the serial port.
*
* Not that this demo is only compatible with devices which report the correct CDC
* Note 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-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.

2
Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c
View File

@ -78,7 +78,7 @@ uint8_t ProcessConfigurationDescriptor(void)
while (!(DataINEndpoint) || !(DataOUTEndpoint))
{
/* Get the next Still Image interface's data endpoint descriptor */
/* Get the next Bluetooth interface's data endpoint descriptor */
if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
DComp_NextInterfaceBluetoothDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
{

2
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
View File

@ -146,7 +146,7 @@
/** Configuration Request signaling command structure, for channel configuration requests. */
typedef struct
{
uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */
uint16_t DestinationChannel; /**< Destination channel address which is to be configured */
uint16_t Flags; /**< Configuration flags for the request, including command continuation */
} BT_Signal_ConfigurationReq_t;

4
Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h
View File

@ -70,7 +70,7 @@
uint16_t B; /**< Bits 32-47 of the UUID. */
uint16_t C; /**< Bits 48-63 of the UUID. */
uint16_t D; /**< Bits 64-79 of the UUID. */
uint8_t E[6]; /**< Bits 80-128 of the UUID. */
uint8_t E[6]; /**< Bits 80-127 of the UUID. */
} UUID_t;
/** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these
@ -152,7 +152,7 @@
struct
{
ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */
Item16Bit_t Channel; /**< 8-Bit Parameter associated with the service */
Item16Bit_t Channel; /**< 16-Bit Parameter associated with the service */
} Protocol;
} ItemProtocol_16BitParam_t;

2
Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h
View File

@ -30,7 +30,7 @@
/** \file
*
* Header file for MouseHost.c.
* Header file for GenericHIDHost.c.
*/
#ifndef _GENERICHID_HOST_H_

2
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
View File

@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo;
/** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read
* structures via the HID parser routines in the LUFA library.
*
* \return A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum
* \return A value from the \ref JoystickHostWithParser_GetHIDReportDataCodes_t enum
*/
uint8_t GetHIDReportData(void)
{

2
Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt
View File

@ -44,7 +44,7 @@
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
* application for implementing a USB keyboard host, for USB keyboards using
* the standard keyboard HID profile.
*
* Pressed alpha-numeric, enter or space key is transmitted through the serial

2
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
View File

@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo;
/** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read
* structures via the HID parser routines in the LUFA library.
*
* \return A value from the KeyboardHostWithParser_GetHIDReportDataCodes_t enum
* \return A value from the \ref KeyboardHostWithParser_GetHIDReportDataCodes_t enum
*/
uint8_t GetHIDReportData(void)
{

2
Demos/Host/LowLevel/MouseHost/MouseHost.c
View File

@ -137,7 +137,7 @@ void ReadNextReport(void)
/* Select mouse data pipe */
Pipe_SelectPipe(MOUSE_DATA_IN_PIPE);
/* Unfreeze keyboard data pipe */
/* Unfreeze mouse data pipe */
Pipe_Unfreeze();
/* Check to see if a packet has been received */

2
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
View File

@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo;
/** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read
* structures via the HID parser routines in the LUFA library.
*
* \return A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum
* \return A value from the \ref MouseHostWithParser_GetHIDReportDataCodes_t enum
*/
uint8_t GetHIDReportData(void)
{

2
Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
View File

@ -219,7 +219,7 @@ uint8_t SImage_SendData(void* const Buffer,
return ErrorCode;
}
/** Function to receive the given data to the device, after a response block has been received.
/** Function to receive the given data from the device, after a response block has been received.
*
* \param[out] Buffer Destination data buffer to put read bytes from the device
* \param[in] Bytes Number of bytes to receive

2
Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt
View File

@ -46,7 +46,7 @@
*
* This demo prints out received CDC data through the serial port.
*
* Not that this demo is only compatible with devices which report the correct CDC
* Note 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-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.

2
LUFA.pnproj
View File

File diff suppressed because one or more lines are too long

4
LUFA/CodeTemplates/DriverStubs/Dataflash.h
View File

@ -124,7 +124,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -166,7 +166,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

4
LUFA/Drivers/Board/AVR8/BUMBLEB/Joystick.h
View File

@ -29,7 +29,7 @@
*/
/** \file
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB.
* \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
* \copydetails Group_Joystick_BUMBLEB
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
@ -38,7 +38,7 @@
/** \ingroup Group_Joystick
* \defgroup Group_Joystick_BUMBLEB BUMBLEB
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB.
* \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
*
* Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral

10
LUFA/Drivers/Board/AVR8/CULV3/Buttons.h
View File

@ -32,15 +32,15 @@
* \brief Board specific LED driver header for the Busware CULV3.
* \copydetails Group_LEDs_CULV3
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/
/** \ingroup Group_LEDs
* \defgroup Group_LEDs_CULV3 CULV3
* \brief Board specific LED driver header for the Busware CULV3.
/** \ingroup Group_Buttons
* \defgroup Group_Buttons_CULV3 CULV3
* \brief Board specific Buttons driver header for the Busware CULV3.
*
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
* Board specific Buttons driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
*
* @{
*/

4
LUFA/Drivers/Board/AVR8/EVK527/Dataflash.h
View File

@ -128,7 +128,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -163,7 +163,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

4
LUFA/Drivers/Board/AVR8/STK525/Dataflash.h
View File

@ -128,7 +128,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -163,7 +163,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

4
LUFA/Drivers/Board/AVR8/STK526/Dataflash.h
View File

@ -128,7 +128,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -163,7 +163,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

4
LUFA/Drivers/Board/AVR8/USBKEY/Dataflash.h
View File

@ -131,7 +131,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -169,7 +169,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

4
LUFA/Drivers/Board/AVR8/XPLAIN/Dataflash.h
View File

@ -134,7 +134,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{
@ -169,7 +169,7 @@
}
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

2
LUFA/Drivers/Board/Buttons.h
View File

@ -56,7 +56,7 @@
* It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
* actions can be taken.
*
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
*
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.

4
LUFA/Drivers/Board/Dataflash.h
View File

@ -176,7 +176,7 @@
* are deselected.
*
* \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
@ -191,7 +191,7 @@
static inline void Dataflash_WaitWhileBusy(void);
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address.
* dataflash commands which require a complete 24-bit address.
*
* \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer

2
LUFA/Drivers/Board/Joystick.h
View File

@ -55,7 +55,7 @@
* Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
* located on many boards.
*
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
*
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.

2
LUFA/Drivers/Board/LEDs.h
View File

@ -55,7 +55,7 @@
* Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
* provides an interface to configure, test and change the status of all the board LEDs.
*
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file. If the BOARD value
* is set to \c BOARD_NONE, this driver is silently disabled.
*

2
LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h
View File

@ -145,7 +145,7 @@
/** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */
#define SPI_ORDER_MSB_FIRST (0 << DORD)
/** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */
/** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out LSB first. */
#define SPI_ORDER_LSB_FIRST (1 << DORD)
//@}

23
LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.c
View File

@ -1,10 +1,33 @@
/*
LUFA Library
Copyright (C) Dean Camera, 2011.
dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
*/
/*
Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that the copyright notice and this
permission notice and warranty disclaimer appear in supporting
documentation, and that the name of the author not be used in
advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
The author disclaim all warranties with regard to this
software, including all implied warranties of merchantability
and fitness. In no event shall the author be liable for any
special, indirect or consequential damages or any damages
whatsoever resulting from loss of use, data or profits, whether
in an action of contract, negligence or other tortious action,
arising out of or in connection with the use or performance of
this software.
*/
#define __INCLUDE_FROM_TWI_C
#include "../TWI.h"

4
LUFA/Drivers/USB/Class/Common/Audio.h
View File

@ -477,7 +477,7 @@
uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */
uint8_t ControlSize; /**< Size of each element in the \c ChanelControlls array. */
uint8_t ControlSize; /**< Size of each element in the \c ChannelControls array. */
uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
@ -506,7 +506,7 @@
uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */
uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */
uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */

2
LUFA/Drivers/USB/Class/Common/MassStorage.h
View File

@ -132,7 +132,7 @@
/** SCSI Sense Code to indicate an error whilst accessing the medium. */
#define SCSI_SENSE_KEY_MEDIUM_ERROR 0x03
/** SCSI Sense Code to indicate a hardware has occurred. */
/** SCSI Sense Code to indicate a hardware error has occurred. */
#define SCSI_SENSE_KEY_HARDWARE_ERROR 0x04
/** SCSI Sense Code to indicate that an illegal request has been issued. */

2
LUFA/Drivers/USB/Class/Device/Audio.h
View File

@ -218,7 +218,7 @@
/** Reads the next 8-bit audio sample from the current audio interface.
*
* \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
* ensure the correct endpoint is selected and ready for data.
* that the correct endpoint is selected and ready for data.
*
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
*

10
LUFA/Drivers/USB/Class/Device/MIDI.h
View File

@ -81,13 +81,13 @@
{
uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */
uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */
uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI IN data, if available (zero if unused). */
uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI IN data endpoint, if available (zero if unused). */
bool DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */
bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI OUT data, if available (zero if unused). */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI OUT data endpoint, if available (zero if unused). */
bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's OUT data endpoint should use double banking. */
} Config; /**< Config data for the USB class interface within the device. All elements in this section
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.
*/

20
LUFA/Drivers/USB/Class/Device/RNDIS.h
View File

@ -79,23 +79,23 @@
{
const struct
{
uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */
uint8_t ControlInterfaceNumber; /**< Interface number of the RNDIS control interface within the device. */
uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */
uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */
uint8_t DataINEndpointNumber; /**< Endpoint number of the RNDIS interface's IN data endpoint. */
uint16_t DataINEndpointSize; /**< Size in bytes of the RNDIS interface's IN data endpoint. */
bool DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the RNDIS interface's OUT data endpoint. */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the RNDIS interface's OUT data endpoint. */
bool DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */
uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */
uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */
uint8_t NotificationEndpointNumber; /**< Endpoint number of the RNDIS interface's IN notification endpoint, if used. */
uint16_t NotificationEndpointSize; /**< Size in bytes of the RNDIS interface's IN notification endpoint, if used. */
bool NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */
char* AdapterVendorDescription; /**< String description of the adapter vendor. */
MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */
} Config; /**< Config data for the USB class interface within the device. All elements in this section.
} Config; /**< Config data for the USB class interface within the device. All elements in this section
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.
*/
struct
@ -114,7 +114,7 @@
/* Function Prototypes: */
/** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given HID interface is selected.
* containing the given RNDIS interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
@ -133,7 +133,7 @@
*/
void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** General management task for a given HID class interface, required for the correct operation of the interface. This should
/** General management task for a given RNDIS class interface, required for the correct operation of the interface. This should
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
*
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.

2
LUFA/Drivers/USB/Class/Host/CDC.h
View File

@ -185,7 +185,7 @@
*/
uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition
/** Sends a Send Break request to the device. This is generally used to separate data or to indicate a special condition
* to the receiving device.
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.

6
LUFA/Drivers/USB/Class/Host/StillImage.h
View File

@ -100,7 +100,7 @@
* after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the
* Configured state.
*/
uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */
uint8_t InterfaceNumber; /**< Interface index of the Still Image interface within the attached device. */
uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */
uint16_t DataOUTPipeSize; /**< Size in bytes of the Still Image interface's OUT data pipe. */
@ -188,7 +188,7 @@
PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(2);
/** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
/** Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with
* or without parameters.
*
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
@ -221,7 +221,7 @@
const uint8_t TotalParams,
uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);
/** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
/** Receives and checks a response block from the attached Still Image device, once a command has been issued and all data
* associated with the command has been transferred.
*
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the

4
LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
View File

@ -452,7 +452,7 @@
uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);
/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
/** EEPROM buffer destination version of \ref Endpoint_Read_Stream_LE().
*
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
* \param[in] Length Number of bytes to send via the currently selected endpoint.
@ -465,7 +465,7 @@
uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);
/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
/** EEPROM buffer destination version of \ref Endpoint_Read_Stream_BE().
*
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
* \param[in] Length Number of bytes to send via the currently selected endpoint.

2
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
View File

@ -625,7 +625,7 @@
return UEDATX;
}
/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
/** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
*
* \ingroup Group_EndpointPrimitiveRW_AVR8
*

2
LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h
View File

@ -133,7 +133,7 @@
OTGCON &= ~(1 << HNPREQ);
}
/** Indicates if the connected device is not currently sending a HNP request.
/** Indicates if the connected device is currently sending a HNP request.
*
* \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise.
*/

2
LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h
View File

@ -590,7 +590,7 @@
return UPDATX;
}
/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
/** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
*
* \ingroup Group_PipePrimitiveRW_AVR8
*

2
LUFA/Drivers/USB/Core/Events.h
View File

@ -78,7 +78,7 @@
/** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
* mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
* before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect
* event has fired (if connected before the role change).
* event has fired (if disconnected before the role change).
*
* \note This event only exists on microcontrollers that support dual role USB modes.
* \n\n

2
LUFA/Drivers/USB/Core/StdRequestType.h
View File

@ -222,7 +222,7 @@
{
FEATURE_SEL_EndpointHalt = 0x00, /**< Feature selector for Clear Feature or Set Feature commands. When
* used in a Set Feature or Clear Feature request this indicates that an
* endpoint (whose address is given elsewhere in the request should have
* endpoint (whose address is given elsewhere in the request) should have
* its stall condition changed.
*/
FEATURE_SEL_DeviceRemoteWakeup = 0x01, /**< Feature selector for Device level Remote Wakeup enable set or clear.

2
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
View File

@ -633,7 +633,7 @@
return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
}
/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
/** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
*
* \ingroup Group_EndpointPrimitiveRW_UC3
*

2
LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h
View File

@ -614,7 +614,7 @@
return *(USB_PipeFIFOPos[USB_SelectedPipe]++);
}
/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
/** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
*
* \ingroup Group_PipePrimitiveRW_UC3
*

2
LUFA/Drivers/USB/USB.h
View File

@ -176,7 +176,7 @@
*
* To initialize the Class driver instance, the driver's <tt><i>{Class Name}</i>_Device_ConfigureEndpoints()</tt> function
* should be called in response to the \ref EVENT_USB_Device_ConfigurationChanged() event. This function will return a
* boolean value if the driver successfully initialized the instance. Like all the class driver functions, this function
* boolean true value if the driver successfully initialized the instance. Like all the class driver functions, this function
* takes in the address of the specific instance you wish to initialize - in this manner, multiple separate instances of
* the same class type can be initialized like this:
*

2
LUFA/ManPages/ChangeLog.txt
View File

@ -33,7 +33,7 @@
*
* <b>Fixed:</b>
* - Core:
* - <i>None</i>
* - Large number of documentation and code comment corrections (thanks to Andrewy from Microsin.ru)
* - Library Applications:
* - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2
* - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed

9
LUFA/ManPages/DirectorySummaries.txt
View File

@ -112,7 +112,7 @@
* located in the parent Board directory should be included instead.
*
* \dir LUFA/Drivers/Board/AVR8/EVK527
* \brief XPLAIN board hardware driver files.
* \brief EVK527 board hardware driver files.
*
* This folder contains drivers for hardware on the Atmel EVK527 development board. The header files in this folder should
* not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
@ -188,6 +188,13 @@
* files in this folder should not be included directly in user applications; the similarly named dispatch header files located
* in the parent Board directory should be included instead.
*
* \dir LUFA/Drivers/Board/AVR8/TUL
* \brief TUL board hardware driver files.
*
* This folder contains drivers for hardware on the Busware TUL (http://busware.de/tiki-index.php?page=TUL).
* The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
* located in the parent Board directory should be included instead.
*
* \dir LUFA/Drivers/Board/AVR8/UDIP
* \brief UDIP board hardware driver files.
*

3
LUFA/ManPages/LibraryResources.txt
View File

@ -7,6 +7,9 @@
/**
* \page Page_Resources Library Resources
*
* \section Sec_UnofficialResources Unofficial Resources
* Unofficial Russian LUFA documentation translation: http://microsin.ru/Download.cnt/doc/LUFA/ \n
*
* \section Sec_ProjectPages LUFA Related Webpages
* Project Homepage: http://www.lufa-lib.org \n
* Commercial Licenses: http://www.lufa-lib.org/license \n

4
LUFA/ManPages/MigrationInformation.txt
View File

@ -154,7 +154,7 @@
*
* <b>Host Mode</b>
* - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
* received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact
* received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact
* number of queued bytes received is not needed.
* - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
* flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().
@ -339,7 +339,7 @@
* - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API.
*
* <b>Dual Role Mode</b>
* - The \c USB_PowerOnFail even has been renamed to \c USB_InitFailure.
* - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure.
* - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more
* details.
*

10
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
View File

@ -161,7 +161,7 @@ void ISPTarget_EnableTargetISP(void)
DDRB |= ((1 << 1) | (1 << 2));
PORTB |= ((1 << 0) | (1 << 3));
ISPTarget_ConfigureSoftwareISP(SCKDuration);
ISPTarget_ConfigureSoftwareSPI(SCKDuration);
}
}
@ -185,7 +185,7 @@ void ISPTarget_DisableTargetISP(void)
}
}
/** Configures the AVR to produce a .5MHz rescue clock out of the OCR1A pin of the AVR, so
/** Configures the AVR to produce a 4MHz rescue clock out of the OCR1A pin of the AVR, so
* that it can be fed into the XTAL1 pin of an AVR whose fuses have been mis-configured for
* an external clock rather than a crystal. When used, the ISP speed must be 125KHz for this
* functionality to work correctly.
@ -217,14 +217,14 @@ void ISPTarget_ConfigureRescueClock(void)
#endif
}
/** Configures the AVR's timer ready to produce software ISP for the slower ISP speeds that
/** Configures the AVR's timer ready to produce software SPI for the slower ISP speeds that
* cannot be obtained when using the AVR's hardware SPI module.
*
* \param[in] SCKDuration Duration of the desired software ISP SCK clock
*/
void ISPTarget_ConfigureSoftwareISP(const uint8_t SCKDuration)
void ISPTarget_ConfigureSoftwareSPI(const uint8_t SCKDuration)
{
/* Configure Timer 1 for software ISP using the specified SCK duration */
/* Configure Timer 1 for software SPI using the specified SCK duration */
TIMSK1 = (1 << OCIE1A);
TCNT1 = 0;
OCR1A = pgm_read_word(&TimerCompareFromSCKDuration[SCKDuration - sizeof(SPIMaskFromSCKDuration)]);

2
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h
View File

@ -72,7 +72,7 @@
void ISPTarget_EnableTargetISP(void);
void ISPTarget_DisableTargetISP(void);
void ISPTarget_ConfigureRescueClock(void);
void ISPTarget_ConfigureSoftwareISP(const uint8_t SCKDuration);
void ISPTarget_ConfigureSoftwareSPI(const uint8_t SCKDuration);
uint8_t ISPTarget_TransferSoftSPIByte(const uint8_t Byte);
void ISPTarget_ChangeTargetResetLine(const bool ResetTarget);
uint8_t ISPTarget_WaitWhileTargetBusy(void);

4
Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
View File

@ -206,7 +206,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
if (WriteLength & 0x01)
WriteBuffer[WriteLength++] = 0xFF;
/* Set the NVM control register to the WORD WRITE command for memory reading */
/* Set the NVM control register to the WORD WRITE command for memory writing */
TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
@ -227,7 +227,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
XPROGTarget_SendByte(*(WriteBuffer++));
/* Need to decrement the write length twice, since we read out a whole word */
/* Need to decrement the write length twice, since we wrote a whole two-byte word */
WriteLength -= 2;
}

2
Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.c
View File

@ -140,7 +140,7 @@ void XPROGTarget_SendByte(const uint8_t Byte)
UDR1 = Byte;
}
/** Receives a byte via the software USART, blocking until data is received.
/** Receives a byte via the hardware USART, blocking until data is received or timeout expired.
*
* \return Received byte from the USART
*/

4
Projects/Incomplete/StandaloneProgrammer/Lib/DataflashManager.c
View File

@ -158,7 +158,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -372,7 +372,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

1565
Projects/MIDIToneGenerator/Doxygen.conf Normal file
View File

File diff suppressed because it is too large Load Diff

2
Projects/Magstripe/Lib/CircularBitBuffer.h
View File

@ -87,7 +87,7 @@
/** Retrieves a bit from the next location inside a given bit buffer.
*
* \param[in,out] Buffer Bit buffer to store a bit into
* \param[in,out] Buffer Bit buffer to retrieve a bit from
*
* \return Next bit from the buffer
*/

10
Projects/Magstripe/Magstripe.txt
View File

@ -87,13 +87,11 @@
* </tr>
* </table>
*
* This project is based on the LUFA Keyboard projectnstration application,
* written by Denver Gingerich.
* This project is based on the LUFA Keyboard project demonstration application, written by Denver Gingerich.
*
* This application uses a keyboard HID driver to communicate the data collected
* a TTL magnetic stripe reader to the connected computer. The raw bitstream
* obtained from the magnetic stripe reader is "typed" through the keyboard
* driver as 0's and 1's. After every card swipe, the project will send a return key.
* This application uses a keyboard HID driver to communicate the data collected a TTL magnetic stripe reader
* to the connected computer. The raw bitstream obtained from the magnetic stripe reader is "typed" through
* the keyboard driver as 0's and 1's. After every card swipe, the project will send a return key.
*
* \section Sec_Options Project Options
*

2
Projects/MediaController/MediaController.c
View File

@ -164,7 +164,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

4
Projects/TempDataLogger/Lib/DataflashManager.c
View File

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

2
Projects/TempDataLogger/TempDataLogger.c
View File

@ -294,7 +294,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

1
Projects/Webserver/Lib/DHCPServerApp.c
View File

@ -154,6 +154,7 @@ void DHCPServerApp_Callback(void)
* \param[out] DHCPHeader Location in the packet buffer where the BOOTP header should be written to
* \param[in] DHCPMessageType DHCP Message type, such as DHCP_DISCOVER
* \param[in] ClientHardwareAddress Client MAC address the created transaction should be directed to
* \param[in] PreferredClientIP Preferred IP that should be given to the client if it is unallocated
* \param[in] TransactionID Transaction ID the created transaction should be associated with
*
* \return Size in bytes of the created DHCP packet

4
Projects/Webserver/Lib/DataflashManager.c
View File

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

2
Projects/Webserver/Lib/HTTPServerApp.c
View File

@ -47,7 +47,7 @@ const char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
"Content-Type: ";
/** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
* given URL is invalid, and gives extra error information.
* URL is invalid, and gives extra error information.
*/
const char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
"Server: LUFA " LUFA_VERSION_STRING "\r\n"

2
Projects/Webserver/Lib/TELNETServerApp.c
View File

@ -54,7 +54,7 @@ const char PROGMEM TELNETMenu[] = "\r\n"
/** Header to print before the current connections are printed to the client */
const char PROGMEM CurrentConnectionsHeader[] = "\r\n* Current TCP Connections: *\r\n";
/** Initialization function for the simple HTTP webserver. */
/** Initialization function for the simple TELNET webserver. */
void TELNETServerApp_Init(void)
{
/* Listen on port 23 for TELNET connections from hosts */

2
Projects/Webserver/Lib/uip/timer.c
View File

@ -74,7 +74,7 @@ timer_set(struct timer *t, clock_time_t interval)
* given to the timer_set() function. The start point of the interval
* is the exact time that the timer last expired. Therefore, this
* function will cause the timer to be stable over time, unlike the
* timer_rester() function.
* timer_restart() function.
*
* \param t A pointer to the timer.
*

2
Projects/Webserver/Lib/uip/uip.h
View File

@ -933,7 +933,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
} while(0)
/**
* Construct an IPv6 address from eight 8-bit words.
* Construct an IPv6 address from sixteen 8-bit words.
*
* This function constructs an IPv6 address.
*

6
Projects/Webserver/Lib/uip/uipopt.h
View File

@ -282,15 +282,15 @@
*/
/**
* Toggles whether UDP support should be compiled in or not.
* Toggles whether TCP support should be compiled in or not.
*
* \hideinitializer
*/
#ifdef UIP_CONF_TCP
#define UIP_TCP UIP_CONF_TCP
#else /* UIP_CONF_UDP */
#else /* UIP_CONF_TCP */
#define UIP_TCP 1
#endif /* UIP_CONF_UDP */
#endif /* UIP_CONF_TCP */
/**
* Determines if support for opening connections from uIP should be