Add const attribute to class driver APIs.

Add new manual pages detailing the advantages of LUFA over the official Atmel USB AVR stack, and reasons why LUFA should be used over a built-from-scratch USB stack.

11 files changed, 41 insertions, 41 deletions

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 4865a1243..545b38d14 100644
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -74,7 +74,7 @@
 					uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */

 					uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */					

 					

-					void*    PrevReportINBuffer; /** Pointer to a buffer where the previously created HID input report can be

+					void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be

 					                              *  stored by the driver, for comparison purposes to detect report changes that

 					                              *  must be sent immediately to the host. This should point to a buffer big enough

 					                              *  to hold the largest HID input report sent from the HID interface. If this is set

@@ -86,7 +86,7 @@
 												  *        this buffer should be set to NULL and the decision to send reports made

 												  *        by the user application instead.

 					                              */

-					uint8_t  PrevReportINBufferSize; /** Size in bytes of the given input report buffer. This is used to create a

+					uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a

 					                                  *  second buffer of the same size within the driver so that subsequent reports

 					                                  *  can be compared.

 					                                  */

@@ -96,9 +96,9 @@
 				struct

 				{

 					bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */

-					uint16_t IdleCount; /**< Report idle period, in mS, set by the host */

-					uint16_t IdleMSRemaining; /**< Total number of mS remaining before the idle period elapsed - this should be

-											   *   decremented by the user application if non-zero each millisecond */	

+					uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */

+					uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this 

+											   *   should be decremented by the user application if non-zero each millisecond */	

 				} State; /**< State data for the USB class interface within the device. All elements in this section

 				          *   are reset to their defaults when the interface is enumerated.

 				          */

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.c b/LUFA/Drivers/USB/Class/Host/CDC.c
index adb9320a9..88d415614 100644
--- a/LUFA/Drivers/USB/Class/Host/CDC.c
+++ b/LUFA/Drivers/USB/Class/Host/CDC.c
@@ -132,7 +132,7 @@ uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo
 	return CDC_ENUMERROR_NoError;

 }

 

-static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)

+static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -150,7 +150,7 @@ static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor)
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)

+static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -168,7 +168,7 @@ static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor)
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* CurrentDescriptor)

+static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)

 	{

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 3fb04f301..51b00da3b 100644
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -227,11 +227,11 @@
 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)

 				void CDC_Host_Event_Stub(void);

-				void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)

+				void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)

 				                                           ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);

-				static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* CurrentDescriptor);

+				static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);

 			#endif	

 	#endif

 				

diff --git a/LUFA/Drivers/USB/Class/Host/HID.c b/LUFA/Drivers/USB/Class/Host/HID.c
index 992721927..7d6a6dcb2 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.c
+++ b/LUFA/Drivers/USB/Class/Host/HID.c
@@ -106,7 +106,7 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo
 	return HID_ENUMERROR_NoError;

 }

 

-static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)

+static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -120,7 +120,7 @@ static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-static uint8_t DComp_NextHID(void* CurrentDescriptor)

+static uint8_t DComp_NextHID(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_HID)

 	  return DESCRIPTOR_SEARCH_Found;

@@ -130,7 +130,7 @@ static uint8_t DComp_NextHID(void* CurrentDescriptor)
 	  return DESCRIPTOR_SEARCH_NotFound;	  

 }

 

-static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor)

+static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)

 	{

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 5cac00eb6..a852f10d9 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -252,9 +252,9 @@
 

 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_HID_CLASS_HOST_C)

-				static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_NextHID(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

 			#endif	

 	#endif	

 	

diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.c b/LUFA/Drivers/USB/Class/Host/MIDI.c
index 1cdfa498b..69118cd5b 100644
--- a/LUFA/Drivers/USB/Class/Host/MIDI.c
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.c
@@ -82,7 +82,7 @@ uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceI
 	return MIDI_ENUMERROR_NoError;

 }

 

-static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* CurrentDescriptor)

+static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -100,7 +100,7 @@ static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* CurrentDescripto
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* CurrentDescriptor)

+static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)

 	{

diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h
index 99e8ea177..b86699e2a 100644
--- a/LUFA/Drivers/USB/Class/Host/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.h
@@ -148,8 +148,8 @@
 

 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_MIDI_CLASS_HOST_C)

-				static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

 			#endif	

 	#endif

 				

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.c b/LUFA/Drivers/USB/Class/Host/MassStorage.c
index 047685cce..32518626d 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.c
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.c
@@ -86,7 +86,7 @@ uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, u
 	return MS_ENUMERROR_NoError;

 }

 

-static uint8_t DComp_NextMSInterface(void* CurrentDescriptor)

+static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -104,7 +104,7 @@ static uint8_t DComp_NextMSInterface(void* CurrentDescriptor)
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor)

+static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)

 	{

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index 8abe5734a..192e478dc 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -325,17 +325,17 @@
 			

 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_MS_CLASS_HOST_C)		

-				static uint8_t DComp_NextMSInterface(void* CurrentDescriptor);

-				static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor);

+				static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);

+				static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);

 				

-				static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,

-				                                   MS_CommandBlockWrapper_t* SCSICommandBlock,

+				static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,

+				                                   MS_CommandBlockWrapper_t* const SCSICommandBlock,

 				                                   void* BufferPtr);

-				static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);

-				static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, 

-                                                       MS_CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);

-				static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,

-				                                         MS_CommandStatusWrapper_t* SCSICommandStatus);

+				static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);

+				static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, 

+                                                       MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);

+				static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,

+				                                         MS_CommandStatusWrapper_t* const SCSICommandStatus);

 			#endif

 	#endif

 	

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.c b/LUFA/Drivers/USB/Class/Host/StillImage.c
index c176310b2..f98f508b2 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.c
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.c
@@ -101,7 +101,7 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, u
 	return SI_ENUMERROR_NoError;

 }

 

-uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor)

+uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)

 	{

@@ -119,7 +119,7 @@ uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor)
 	return DESCRIPTOR_SEARCH_NotFound;

 }

 

-uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor)

+uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor)

 {

 	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)

 	{

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index 9ba10e9b9..8a8552dab 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -228,13 +228,13 @@
 		

 		/* Function Prototypes: */

 			#if defined(INCLUDE_FROM_SI_CLASS_HOST_C)

-				static uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-				static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

+				static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

 

-				static uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,

-				                                           SI_PIMA_Container_t* PIMAHeader);

-				static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,

-				                                              SI_PIMA_Container_t* PIMAHeader);

+				static uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,

+				                                           SI_PIMA_Container_t* const PIMAHeader);

+				static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,

+				                                              SI_PIMA_Container_t* const PIMAHeader);

 			#endif

 	#endif