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).

1 files changed, 25 insertions, 25 deletions

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index 157b35003..7b232fc89 100644
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -108,34 +108,34 @@
 			 *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the

 			 *  given CDC interface is selected.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 *

 			 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise

 			 */

-			bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 

 			/** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be

 			 *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 */

-			void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 

 			/** General management task for a given CDC 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 CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 */

-			void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 

 			/** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a

 			 *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the

 			 *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding

 			 *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 */

-			void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 			

 			/** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a

 			 *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the

@@ -143,62 +143,62 @@
 			 *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as

 			 *  a mask of CDC_CONTROL_LINE_OUT_* masks.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 */		

-			void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 

 			/** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the

 			 *  string is discarded.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

-			 *  \param Data  Pointer to the string to send to the host

-			 *  \param Length  Size in bytes of the string to send to the host

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in] Data  Pointer to the string to send to the host

+			 *  \param[in] Length  Size in bytes of the string to send to the host

 			 */

-			void CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, char* Data, uint16_t Length);

+			void CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length);

 			

 			/** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the

 			 *  byte is discarded.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

-			 *  \param Data  Byte of data to send to the host

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in] Data  Byte of data to send to the host

 			 */

-			void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, uint8_t Data);

+			void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data);

 			

 			/** Determines the number of bytes received by the CDC interface from the host, waiting to be read.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 *

 			 *  \return Total number of buffered bytes received from the host

 			 */

-			uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 			

 			/** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function

 			 *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data

 			 *  underflow occurs.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 *

 			 *  \return Next received byte from the host, or 0 if no data received

 			 */

-			uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 			

 			/** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial

 			 *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist

 			 *  until they are cleared via a second notification. This should be called each time the CDC class driver's 

 			 *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.

 			 *

-			 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

+			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.

 			 */

-			void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);

+			void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);

 

 	/* Private Interface - For use in library only: */

 	#if !defined(__DOXYGEN__)

 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)

 				void CDC_Device_Event_Stub(void);

-				void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)

+				void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)

 														  ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);

-				void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)

+				void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)

 															 ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);

 			#endif