Added const modifiers to device mode class drivers.

Added parameter directions to function parameter documentation.

Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).

4 files changed, 15 insertions, 15 deletions

diff --git a/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h b/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h
index 4cc7c32c3..4110a508c 100644
--- a/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h
+++ b/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h
@@ -115,7 +115,7 @@
 				 *  The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and

 				 *  prescaler masks.

 				 *

-				 *  \param Mode  Mask of ADC settings, including adjustment, prescale, mode and reference

+				 *  \param[in] Mode  Mask of ADC settings, including adjustment, prescale, mode and reference

 				 */

 				static inline void ADC_Init(uint8_t Mode);

 				

@@ -159,7 +159,7 @@
 			 *  associated port pin as an input and disables the digital portion of the I/O to reduce

 			 *  power consumption.

 			 *

-			 *  \param Channel  ADC channel number to set up for conversions

+			 *  \param[in] Channel  ADC channel number to set up for conversions

 			 */

 			static inline void ADC_SetupChannel(const uint8_t Channel)

 			{

@@ -196,7 +196,7 @@
 			 *  Once executed, the conversion status can be determined via the \ref ADC_IsReadingComplete() macro and

 			 *  the result read via the \ref ADC_GetResult() macro.

 			 *

-			 *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask

+			 *  \param[in] MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask

 			 */

 			static inline void ADC_StartReading(const uint8_t MUXMask)

 			{

@@ -208,7 +208,7 @@
 			/** Performs a complete single reading from channel, including a polling spinloop to wait for the

 			 *  conversion to complete, and the returning of the converted value.

 			 *

-			 *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask

+			 *  \param[in] MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask

 			 */

 			static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;

 			static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask)

diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
index 66cdaf513..dc8661ad5 100644
--- a/LUFA/Drivers/Peripheral/SPI.h
+++ b/LUFA/Drivers/Peripheral/SPI.h
@@ -90,8 +90,8 @@
 			/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other

 			 *  SPI routines.

 			 *

-			 *  \param PrescalerMask  Prescaler mask to set the SPI clock speed

-			 *  \param Master         If true, sets the SPI system to use master mode, slave if false

+			 *  \param[in] PrescalerMask  Prescaler mask to set the SPI clock speed

+			 *  \param[in] Master         If true, sets the SPI system to use master mode, slave if false

 			 */

 			static inline void SPI_Init(const uint8_t PrescalerMask, const bool Master)

 			{

@@ -109,7 +109,7 @@
 			

 			/** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.

 			 *

-			 *  \param Byte  Byte to send through the SPI interface

+			 *  \param[in] Byte  Byte to send through the SPI interface

 			 *

 			 *  \return Response byte from the attached SPI device

 			 */

@@ -124,7 +124,7 @@
 			/** Sends a byte through the SPI interface, blocking until the transfer is complete. The response

 			 *  byte sent to from the attached SPI device is ignored.

 			 *

-			 *  \param Byte Byte to send through the SPI interface

+			 *  \param[in] Byte Byte to send through the SPI interface

 			 */

 			static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;

 			static inline void SPI_SendByte(const uint8_t Byte)

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index 7e718fe0c..82cbcfc2c 100644
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -88,13 +88,13 @@
 		/* Function Prototypes: */

 			/** Transmits a given string located in program space (FLASH) through the USART.

 			 *

-			 *  \param FlashStringPtr  Pointer to a string located in program space

+			 *  \param[in] FlashStringPtr  Pointer to a string located in program space

 			 */

 			void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);

 

 			/** Transmits a given string located in SRAM memory through the USART.

 			 *

-			 *  \param StringPtr  Pointer to a string located in SRAM space

+			 *  \param[in] StringPtr  Pointer to a string located in SRAM space

 			 */

 			void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);

 

@@ -102,8 +102,8 @@
 			/** Initializes the USART, ready for serial data transmission and reception. This initialises the interface to

 			 *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.

 			 *

-			 *  \param BaudRate     Serial baud rate, in bits per second

-			 *  \param DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate

+			 *  \param[in] BaudRate     Serial baud rate, in bits per second

+			 *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate

 			 */

 			static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)

 			{

@@ -119,7 +119,7 @@
 

 			/** Transmits a given byte through the USART.

 			 *

-			 *  \param DataByte  Byte to transmit through the USART

+			 *  \param[in] DataByte  Byte to transmit through the USART

 			 */

 			static inline void Serial_TxByte(const char DataByte)

 			{

diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index 275313589..d3f0014bc 100644
--- a/LUFA/Drivers/Peripheral/SerialStream.h
+++ b/LUFA/Drivers/Peripheral/SerialStream.h
@@ -79,8 +79,8 @@
 			/** Initializes the serial stream (and regular USART driver) so that both the stream and regular

 			 *  USART driver functions can be used. Must be called before any stream or regular USART functions.

 			 *

-			 *  \param BaudRate     Baud rate to configure the USART to

-			 *  \param DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate

+			 *  \param[in] BaudRate     Baud rate to configure the USART to

+			 *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate

 			 */

 			static inline void SerialStream_Init(const uint32_t BaudRate, const bool DoubleSpeed)

 			{