forked from mfulz_github/qmk_firmware
Spell check library source code files.
This commit is contained in:
parent
6d2a08f1b7
commit
f01a05415c
|
@ -153,7 +153,7 @@ void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
|
|||
}
|
||||
}
|
||||
|
||||
/** Initialises the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
|
||||
/** Initializes the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
|
||||
* processed.
|
||||
*/
|
||||
void TCP_Init(void)
|
||||
|
|
|
@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] =
|
|||
"</html>";
|
||||
|
||||
|
||||
/** Initialises the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
|
||||
/** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
|
||||
* callback routine for packets sent to the HTTP protocol port.
|
||||
*/
|
||||
void Webserver_Init(void)
|
||||
|
|
|
@ -152,7 +152,7 @@ void TCP_Task(void)
|
|||
}
|
||||
}
|
||||
|
||||
/** Initialises the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
|
||||
/** Initializes the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
|
||||
* processed.
|
||||
*/
|
||||
void TCP_Init(void)
|
||||
|
|
|
@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] =
|
|||
"</html>";
|
||||
|
||||
|
||||
/** Initialises the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
|
||||
/** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
|
||||
* callback routine for packets sent to the HTTP protocol port.
|
||||
*/
|
||||
void Webserver_Init(void)
|
||||
|
|
|
@ -142,7 +142,7 @@ void Android_Host_Task(void)
|
|||
/* Save whether the Android device needs to be mode-switched later on */
|
||||
bool RequiresModeSwitch = (ErrorCode == NonAccessoryModeAndroidDevice);
|
||||
|
||||
/* Error out if the device is not an Android device or an error ocurred */
|
||||
/* Error out if the device is not an Android device or an error occurred */
|
||||
if ((ErrorCode != AccessoryModeAndroidDevice) && !(RequiresModeSwitch))
|
||||
{
|
||||
if (ErrorCode == DevControlError)
|
||||
|
|
|
@ -65,7 +65,7 @@ const uint8_t CRC8_Table[256] PROGMEM =
|
|||
RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
|
||||
|
||||
|
||||
/** Initialises the RFCOMM service, ready for new connections from a SDP client. */
|
||||
/** Initializes the RFCOMM service, ready for new connections from a SDP client. */
|
||||
void RFCOMM_Initialize(void)
|
||||
{
|
||||
/* Reset the RFCOMM channel structures, to invalidate any configured RFCOMM channels */
|
||||
|
|
|
@ -122,7 +122,7 @@ uint8_t RNDIS_SendKeepAlive(void)
|
|||
return HOST_SENDCONTROL_Successful;
|
||||
}
|
||||
|
||||
/** Initialises the attached RNDIS device's RNDIS interface.
|
||||
/** Initializes the attached RNDIS device's RNDIS interface.
|
||||
*
|
||||
* \param[in] HostMaxPacketSize Size of the packet buffer on the host
|
||||
* \param[out] DeviceMaxPacketSize Pointer to where the packet buffer size of the device is to be stored
|
||||
|
|
|
@ -79,7 +79,7 @@
|
|||
#define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -42,7 +42,7 @@
|
|||
* \brief GCC special function/variable attribute macros.
|
||||
*
|
||||
* This module contains macros for applying GCC specific attributes to functions and variables to control various
|
||||
* optimiser and code generation features of the compiler. Attributes may be placed in the function prototype
|
||||
* optimizer and code generation features of the compiler. Attributes may be placed in the function prototype
|
||||
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space
|
||||
* separated list.
|
||||
*
|
||||
|
@ -85,13 +85,13 @@
|
|||
*/
|
||||
#define ATTR_NAKED __attribute__ ((naked))
|
||||
|
||||
/** Prevents the compiler from considering a specified function for inlining. When applied, the given
|
||||
* function will not be inlined under any circumstances.
|
||||
/** Prevents the compiler from considering a specified function for in-lining. When applied, the given
|
||||
* function will not be in-lined under any circumstances.
|
||||
*/
|
||||
#define ATTR_NO_INLINE __attribute__ ((noinline))
|
||||
|
||||
/** Forces the compiler to inline the specified function. When applied, the given function will be
|
||||
* inlined under all circumstances.
|
||||
* in-lined under all circumstances.
|
||||
*/
|
||||
#define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))
|
||||
|
||||
|
|
|
@ -163,7 +163,7 @@
|
|||
|
||||
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
|
||||
/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
|
||||
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
|
||||
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
|
||||
* removes/reorders code to the point where break points cannot reliably be set.
|
||||
*
|
||||
* \note This macro is not available for all architectures.
|
||||
|
|
|
@ -83,7 +83,7 @@
|
|||
#define DATAFLASH_PAGES 8192
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -83,7 +83,7 @@
|
|||
#define DATAFLASH_PAGES 8192
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -83,7 +83,7 @@
|
|||
#define DATAFLASH_PAGES 8192
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -86,7 +86,7 @@
|
|||
#define DATAFLASH_PAGES 8192
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -89,7 +89,7 @@
|
|||
#endif
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
static inline void Dataflash_Init(void)
|
||||
|
|
|
@ -66,7 +66,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the button driver before first use
|
||||
* // Initialize the button driver before first use
|
||||
* Buttons_Init();
|
||||
*
|
||||
* printf("Waiting for button press...\r\n");
|
||||
|
@ -131,7 +131,7 @@
|
|||
|
||||
/* Pseudo-Functions for Doxygen: */
|
||||
#if defined(__DOXYGEN__)
|
||||
/** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate
|
||||
/** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate
|
||||
* I/O pins to an inputs with pull-ups enabled.
|
||||
*
|
||||
* This must be called before any Button driver functions are used.
|
||||
|
|
|
@ -66,7 +66,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the SPI and board Dataflash drivers before first use
|
||||
* // Initialize the SPI and board Dataflash drivers before first use
|
||||
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
|
||||
* SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
|
||||
* Dataflash_Init();
|
||||
|
@ -146,7 +146,7 @@
|
|||
#define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index)
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
*
|
||||
* \note The microcontroller's SPI driver must be initialized before any of the dataflash commands are used.
|
||||
*/
|
||||
|
|
|
@ -65,7 +65,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the board Joystick driver before first use
|
||||
* // Initialize the board Joystick driver before first use
|
||||
* Joystick_Init();
|
||||
*
|
||||
* printf("Waiting for joystick movement...\r\n");
|
||||
|
@ -119,7 +119,7 @@
|
|||
|
||||
/* Pseudo-Functions for Doxygen: */
|
||||
#if defined(__DOXYGEN__)
|
||||
/** Initialises the joystick driver so that the joystick position can be read. This sets the appropriate
|
||||
/** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
|
||||
* I/O pins to inputs with their pull-ups enabled.
|
||||
*/
|
||||
static inline void Joystick_Init(void);
|
||||
|
|
|
@ -74,7 +74,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the board LED driver before first use
|
||||
* // Initialize the board LED driver before first use
|
||||
* LEDs_Init();
|
||||
*
|
||||
* // Turn on each of the four LEDs in turn
|
||||
|
@ -187,7 +187,7 @@
|
|||
|
||||
/* Pseudo-Functions for Doxygen: */
|
||||
#if defined(__DOXYGEN__)
|
||||
/** Initialises the board LED driver so that the LEDs can be controlled. This sets the appropriate port
|
||||
/** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
|
||||
* I/O pins as outputs, and sets the LEDs to default to off.
|
||||
*/
|
||||
static inline void LEDs_Init(void);
|
||||
|
|
|
@ -53,7 +53,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the ADC and board temperature sensor drivers before first use
|
||||
* // Initialize the ADC and board temperature sensor drivers before first use
|
||||
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
|
||||
* Temperature_Init();
|
||||
*
|
||||
|
@ -102,7 +102,7 @@
|
|||
#define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES)
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the temperature sensor driver, including setting up the appropriate ADC channel.
|
||||
/** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
|
||||
* This must be called before any other temperature sensor routines.
|
||||
*
|
||||
* \pre The ADC itself (not the ADC channel) must be configured separately before calling the
|
||||
|
|
|
@ -66,7 +66,7 @@
|
|||
* RingBuffer_t Buffer;
|
||||
* uint8_t BufferData[128];
|
||||
*
|
||||
* // Initialise the buffer with the created storage array
|
||||
* // Initialize the buffer with the created storage array
|
||||
* RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));
|
||||
*
|
||||
* // Insert some data into the buffer
|
||||
|
|
|
@ -53,7 +53,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the ADC driver before first use
|
||||
* // Initialize the ADC driver before first use
|
||||
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);
|
||||
*
|
||||
* // Must setup the ADC channel to read beforehand
|
||||
|
@ -411,7 +411,7 @@
|
|||
return ADC_GetResult();
|
||||
}
|
||||
|
||||
/** Initialises the ADC, ready for conversions. This must be called before any other ADC operations.
|
||||
/** Initializes the ADC, ready for conversions. This must be called before any other ADC operations.
|
||||
* The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
|
||||
* prescaler masks.
|
||||
*
|
||||
|
|
|
@ -53,7 +53,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the SPI driver before first use
|
||||
* // Initialize the SPI driver before first use
|
||||
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
|
||||
* SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
|
||||
*
|
||||
|
@ -159,7 +159,7 @@
|
|||
//@}
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other
|
||||
/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
|
||||
* SPI routines.
|
||||
*
|
||||
* \param[in] SPIOptions SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,
|
||||
|
|
|
@ -51,7 +51,7 @@
|
|||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
|
||||
* // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode)
|
||||
* Serial_Init(9600, false);
|
||||
*
|
||||
* // Send a string through the USART
|
||||
|
|
|
@ -52,7 +52,7 @@
|
|||
*
|
||||
* <b>Low Level API Example:</b>
|
||||
* \code
|
||||
* // Initialise the TWI driver before first use
|
||||
* // Initialize the TWI driver before first use
|
||||
* TWI_Init(TWI_BIT_PRESCALE_1, 10);
|
||||
*
|
||||
* // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
|
||||
|
@ -91,7 +91,7 @@
|
|||
*
|
||||
* <b>High Level API Example:</b>
|
||||
* \code
|
||||
* // Initialise the TWI driver before first use
|
||||
* // Initialize the TWI driver before first use
|
||||
* TWI_Init(TWI_BIT_PRESCALE_1, 10);
|
||||
*
|
||||
* // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
|
||||
|
@ -171,7 +171,7 @@
|
|||
/** Enum for the possible return codes of the TWI transfer start routine and other dependant TWI functions. */
|
||||
enum TWI_ErrorCodes_t
|
||||
{
|
||||
TWI_ERROR_NoError = 0, /**< Indicates that the command completed sucessfully. */
|
||||
TWI_ERROR_NoError = 0, /**< Indicates that the command completed successfully. */
|
||||
TWI_ERROR_BusFault = 1, /**< A TWI bus fault occurred while attempting to capture the bus. */
|
||||
TWI_ERROR_BusCaptureTimeout = 2, /**< A timeout occurred whilst waiting for the bus to be ready. */
|
||||
TWI_ERROR_SlaveResponseTimeout = 3, /**< No ACK received at the nominated slave address within the timeout period. */
|
||||
|
@ -180,7 +180,7 @@
|
|||
};
|
||||
|
||||
/* Inline Functions: */
|
||||
/** Initialises the TWI hardware into master mode, ready for data transmission and reception. This must be
|
||||
/** Initializes the TWI hardware into master mode, ready for data transmission and reception. This must be
|
||||
* before any other TWI operations.
|
||||
*
|
||||
* The generated SCL frequency will be according to the formula <pre>F_CPU / (16 + 2 * BitLength + 4 ^ Prescale)</pre>.
|
||||
|
|
|
@ -102,7 +102,7 @@
|
|||
#define HID_KEYBOARD_LED_KATANA (1 << 3)
|
||||
//@}
|
||||
|
||||
/** \name Keyboard Standard Report Key Scancodes */
|
||||
/** \name Keyboard Standard Report Key Scan-codes */
|
||||
//@{
|
||||
#define HID_KEYBOARD_SC_ERROR_ROLLOVER 0x01
|
||||
#define HID_KEYBOARD_SC_POST_FAIL 0x02
|
||||
|
@ -483,11 +483,11 @@
|
|||
|
||||
/** \hideinitializer
|
||||
* A list of HID report item array elements that describe a typical Vendor Defined byte array HID report descriptor,
|
||||
* used for transporting abitrary data between the USB host and device via HID reports. The resulting report should be
|
||||
* used for transporting arbitrary data between the USB host and device via HID reports. The resulting report should be
|
||||
* a uint8_t byte array of the specified length in both Device to Host (IN) and Host to Device (OUT) directions.
|
||||
*
|
||||
* \param[in] VendorPageNum Vendor Defined HID Usage Page index, ranging from 0x00 to 0xFF.
|
||||
* \param[in] CollectionUsage Vendor Usage for the encompasing report IN and OUT collection, ranging from 0x00 to 0xFF.
|
||||
* \param[in] CollectionUsage Vendor Usage for the encompassing report IN and OUT collection, ranging from 0x00 to 0xFF.
|
||||
* \param[in] DataINUsage Vendor Usage for the IN report data, ranging from 0x00 to 0xFF.
|
||||
* \param[in] DataOUTUsage Vendor Usage for the OUT report data, ranging from 0x00 to 0xFF.
|
||||
* \param[in] NumBytes Length of the data IN and OUT reports.
|
||||
|
|
|
@ -54,11 +54,11 @@
|
|||
* of data exchanged between a HID device and a host, including both the physical encoding of each item
|
||||
* (such as a button, key press or joystick axis) in the sent and received data packets - known as "reports" -
|
||||
* as well as other information about each item such as the usages, data range, physical location and other
|
||||
* characterstics. In this way a HID device can retain a high degree of flexibility in its capabilities, as it
|
||||
* is not forced to comply with a given report layout or featureset.
|
||||
* characteristics. In this way a HID device can retain a high degree of flexibility in its capabilities, as it
|
||||
* is not forced to comply with a given report layout or feature-set.
|
||||
*
|
||||
* This module also contains routines for the processing of data in an actual HID report, using the parsed report
|
||||
* descritor data as a guide for the encoding.
|
||||
* descriptor data as a guide for the encoding.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
|
|
@ -155,7 +155,7 @@
|
|||
*/
|
||||
uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||||
|
||||
/** Initialises the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
|
||||
/** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
|
||||
* configured via the call to \ref RNDIS_Host_ConfigurePipes().
|
||||
*
|
||||
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_EndpointPrimitiveRW
|
||||
* \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
|
||||
* \brief Endpoint primative read/write definitions for the Atmel AVR8 architecture.
|
||||
* \brief Endpoint primitive read/write definitions for the Atmel AVR8 architecture.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to endpoints.
|
||||
|
@ -182,7 +182,7 @@
|
|||
#define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
|
||||
#endif
|
||||
|
||||
/** Retrives the maximum bank size in bytes of a given endpoint.
|
||||
/** Retrieves the maximum bank size in bytes of a given endpoint.
|
||||
*
|
||||
* \note This macro will only work correctly on endpoint indexes that are compile-time constants
|
||||
* defined by the preprocessor.
|
||||
|
|
|
@ -330,7 +330,7 @@
|
|||
*/
|
||||
uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);
|
||||
|
||||
/** Selects a given alternative setting for the specfied interface, via a SET INTERFACE standard request to
|
||||
/** Selects a given alternative setting for the specified interface, via a SET INTERFACE standard request to
|
||||
* the attached device.
|
||||
*
|
||||
* \note After this routine returns, the control pipe will be selected.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_PipePrimitiveRW
|
||||
* \defgroup Group_PipePrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
|
||||
* \brief Pipe primative data read/write definitions for the Atmel AVR8 architecture.
|
||||
* \brief Pipe primitive data read/write definitions for the Atmel AVR8 architecture.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to pipes.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_EndpointRW
|
||||
* \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
|
||||
* \brief Endpoint data primative read/write definitions.
|
||||
* \brief Endpoint data primitive read/write definitions.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to endpoints.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_PipeRW
|
||||
* \defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types
|
||||
* \brief Pipe data primative read/write definitions.
|
||||
* \brief Pipe data primitive read/write definitions.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to pipes.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_EndpointPrimitiveRW
|
||||
* \defgroup Group_EndpointPrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
|
||||
* \brief Endpoint primative read/write definitions for the Atmel AVR32 UC3 architecture.
|
||||
* \brief Endpoint primitive read/write definitions for the Atmel AVR32 UC3 architecture.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to endpoints.
|
||||
|
@ -198,7 +198,7 @@
|
|||
#define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
|
||||
#endif
|
||||
|
||||
/** Retrives the maximum bank size in bytes of a given endpoint.
|
||||
/** Retrieves the maximum bank size in bytes of a given endpoint.
|
||||
*
|
||||
* \note This macro will only work correctly on endpoint indexes that are compile-time constants
|
||||
* defined by the preprocessor.
|
||||
|
|
|
@ -331,7 +331,7 @@
|
|||
*/
|
||||
uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);
|
||||
|
||||
/** Selects a given alternative setting for the specfied interface, via a SET INTERFACE standard request to
|
||||
/** Selects a given alternative setting for the specified interface, via a SET INTERFACE standard request to
|
||||
* the attached device.
|
||||
*
|
||||
* \note After this routine returns, the control pipe will be selected.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
/** \ingroup Group_PipePrimitiveRW
|
||||
* \defgroup Group_PipePrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
|
||||
* \brief Pipe primative data read/write definitions for the Atmel AVR32 UC3 architecture.
|
||||
* \brief Pipe primitive data read/write definitions for the Atmel AVR32 UC3 architecture.
|
||||
*
|
||||
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
||||
* from and to pipes.
|
||||
|
|
|
@ -55,8 +55,8 @@
|
|||
* - Added TWI baud rate prescaler and bit length parameters to the TWI_Init() function (thanks to Thomas Herlinghaus)
|
||||
* - Internal restructuring for eventual multiple architecture ports
|
||||
* - Added AVR32 UC3 architecture port (currently incomplete/experimental)
|
||||
* - Added new architecture independant functions to enable, disable, save and restore the Global Interrupt Enable flags
|
||||
* - Added new RNDIS Device Classs Driver packet send and receive functions
|
||||
* - Added new architecture independent functions to enable, disable, save and restore the Global Interrupt Enable flags
|
||||
* - Added new RNDIS Device Class Driver packet send and receive functions
|
||||
* - Library Applications:
|
||||
* - Added ability to write protect Mass Storage disk write operations from the host OS
|
||||
* - Added new MIDIToneGenerator project
|
||||
|
@ -97,7 +97,7 @@
|
|||
* a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
|
||||
* - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of
|
||||
* a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
|
||||
* - Seperated out board drivers by architecture in the library internals for better organisation
|
||||
* - Separated out board drivers by architecture in the library internals for better organisation
|
||||
* - Library Applications:
|
||||
* - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode
|
||||
* via the Input Capture register, to reduce user confusion
|
||||
|
@ -108,7 +108,7 @@
|
|||
* - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition
|
||||
* - Changed AVRISP-MKII project to use the Watchdog interrupt for command timeouts, to reduce CPU usage and free timer 0
|
||||
* for other uses
|
||||
* - Updated the software USART code in the XPLAIN Bridge application so that the incomming bits are sampled at their mid-point
|
||||
* - Updated the software USART code in the XPLAIN Bridge application so that the incoming bits are sampled at their mid-point
|
||||
* instead of starting point, to give maximum reliability (thanks to Anton Staaf)
|
||||
*
|
||||
* <b>Fixed:</b>
|
||||
|
@ -123,7 +123,7 @@
|
|||
* - Fixed several functions in the Host mode Still Image Class driver returning an error code from the incorrect
|
||||
* error code enum (thanks to Daniel Seibert)
|
||||
* - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used
|
||||
* - Fixed incorect BUTTONS_BUTTON1 definition for the Minimus board
|
||||
* - Fixed incorrect BUTTONS_BUTTON1 definition for the Minimus board
|
||||
* - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe)
|
||||
* is found
|
||||
* - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine
|
||||
|
@ -168,7 +168,7 @@
|
|||
* - Added board hardware driver support for the Minimus board (thanks to the PSGroove team)
|
||||
* - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management
|
||||
* tasks for each driver is called
|
||||
* - Added standard keyboard HID report scancode defines (thanks to Laszlo Monda)
|
||||
* - Added standard keyboard HID report scan-code defines (thanks to Laszlo Monda)
|
||||
* - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions
|
||||
* - Library Applications:
|
||||
* - Added default test tone generation mode to the Device mode AudioInput demos
|
||||
|
|
|
@ -83,8 +83,8 @@
|
|||
*
|
||||
* <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - <i>AVR8 Only</i> \n
|
||||
* The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to
|
||||
* prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialisation. This compile
|
||||
* time token may be used to restrict the intialisation order to ascending indexes only in exchange for a smaller compiled binary size.
|
||||
* prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialization. This compile
|
||||
* time token may be used to restrict the initialization order to ascending indexes only in exchange for a smaller compiled binary size.
|
||||
*
|
||||
* <b>USE_STATIC_OPTIONS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
|
||||
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
|
||||
|
|
|
@ -19,7 +19,7 @@
|
|||
* -# Re-add interrupt Pipe/Endpoint support
|
||||
* -# Add makefile includes to reduce boilerplate in user makefiles
|
||||
* -# Update stream APIs to use DMA transfers on supported architectures
|
||||
* -# Pull out third party libraries into a seperate folder and reference them as required
|
||||
* -# Pull out third party libraries into a separate folder and reference them as required
|
||||
* -# Add a LUFA_YIELD macro for integration into a third-party RTOS
|
||||
* -# Abstract out Mass Storage byte send/receive to prevent low level API use in projects
|
||||
* - Documentation/Support
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
*
|
||||
* <b>USB Core</b>
|
||||
* - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of
|
||||
* reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program
|
||||
* reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimize the compiled program
|
||||
* size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering
|
||||
* in exchange for a smaller compiled binary size.
|
||||
* - The previous F_CLOCK symbol, required in the project makefile, has been renamed to F_USB. This is due to the previous name
|
||||
|
|
|
@ -230,7 +230,7 @@ void ISPProtocol_ProgramMemory(uint8_t V2Command)
|
|||
if (ProgrammingStatus != STATUS_CMD_OK)
|
||||
break;
|
||||
|
||||
/* Must reset the polling address afterwards, so it is not erronously used for the next byte */
|
||||
/* Must reset the polling address afterwards, so it is not erroneously used for the next byte */
|
||||
PollAddress = 0;
|
||||
}
|
||||
|
||||
|
|
|
@ -140,7 +140,7 @@ ISR(TIMER1_COMPA_vect, ISR_BLOCK)
|
|||
PINB |= (1 << 1);
|
||||
}
|
||||
|
||||
/** Initialises the appropriate SPI driver (hardware or software, depending on the selected ISP speed) ready for
|
||||
/** Initializes the appropriate SPI driver (hardware or software, depending on the selected ISP speed) ready for
|
||||
* communication with the attached target.
|
||||
*/
|
||||
void ISPTarget_EnableTargetISP(void)
|
||||
|
@ -186,7 +186,7 @@ void ISPTarget_DisableTargetISP(void)
|
|||
}
|
||||
|
||||
/** Configures the AVR to produce a .5MHz 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 misconfigured for
|
||||
* 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.
|
||||
*/
|
||||
|
|
|
@ -50,7 +50,7 @@ ISR(WDT_vect, ISR_BLOCK)
|
|||
wdt_disable();
|
||||
}
|
||||
|
||||
/** Initialises the hardware and software associated with the V2 protocol command handling. */
|
||||
/** Initializes the hardware and software associated with the V2 protocol command handling. */
|
||||
void V2Protocol_Init(void)
|
||||
{
|
||||
#if defined(ADC)
|
||||
|
|
|
@ -147,7 +147,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
|
|||
uint8_t JoyStatus_LCL = Joystick_GetStatus();
|
||||
uint8_t ButtonStatus_LCL = Buttons_GetStatus();
|
||||
|
||||
/* Update the Media Control report with the user button pressess */
|
||||
/* Update the Media Control report with the user button presses */
|
||||
MediaReport->Mute = ((ButtonStatus_LCL & BUTTONS_BUTTON1) ? true : false);
|
||||
MediaReport->PlayPause = ((JoyStatus_LCL & JOY_PRESS) ? true : false);
|
||||
MediaReport->VolumeUp = ((JoyStatus_LCL & JOY_UP) ? true : false);
|
||||
|
|
|
@ -164,7 +164,7 @@ void uIPManagement_UDPCallback(void)
|
|||
/** Processes Incoming packets to the server from the connected RNDIS device, creating responses as needed. */
|
||||
static void uIPManagement_ProcessIncomingPacket(void)
|
||||
{
|
||||
/* Determine which USB mode the system is currently initialised in */
|
||||
/* Determine which USB mode the system is currently initialized in */
|
||||
if (USB_CurrentMode == USB_MODE_Device)
|
||||
{
|
||||
/* If no packet received, exit processing routine */
|
||||
|
|
|
@ -52,7 +52,7 @@ static uint8_t RX_BitsRemaining;
|
|||
static uint8_t RX_Data;
|
||||
|
||||
|
||||
/** Initialises the software UART, ready for data transmission and reception into the global ring buffers. */
|
||||
/** Initializes the software UART, ready for data transmission and reception into the global ring buffers. */
|
||||
void SoftUART_Init(void)
|
||||
{
|
||||
/* Set TX pin to output high, enable RX pull-up */
|
||||
|
|
Loading…
Reference in New Issue