More work on the Mass Storage Host mode Class driver.

Added  ATTR_NON_NULL_PTR_ARG() attributes to the class drivers to improve user code reliability by disallowing explicit NULL pointers as pointer parameters in function calls where the parameter must not be NULL.

Disabled building of the Demos/Host/ClassDriver directory until Host Mode Class drivers are complete to prevent build errors in the meantime.

1 files changed, 21 insertions, 21 deletions

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 5baafafe5..f3abb296e 100644
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -122,9 +122,9 @@
 			/** General management task for a given CDC host 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] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.

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

 			 */

-			void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 			

 			/** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration

 			 *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's

@@ -132,63 +132,63 @@
 			 *  This should be called once after the stack has enumerated the attached device, while the host state machine is in

 			 *  the Addressed state.

 			 *

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

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

 			 *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor

 			 *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor

 			 */

 			uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,

-			                                uint8_t* DeviceConfigDescriptor);

+			                                uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);

 			

 			/** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding

 			 *  values of the interface have been changed to push the new settings to the USB device.

 			 *

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

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

 			 */

-			uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 

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

 			 *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second

 			 *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated

 			 *  to push the new states to the USB device.

 			 *

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

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

 			 */

-			uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 			

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

 			 *  string is discarded.

 			 *

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

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

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

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

 			 */

-			void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);

+			void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1, 2);

 			

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

 			 *  byte is discarded.

 			 *

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

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

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

 			 */

-			void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);

+			void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);

 

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

 			 *

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

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

 			 *

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

 			 */

-			uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 

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

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

 			 *  underflow occurs.

 			 *

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

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

 			 *

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

 			 */

-			uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 			

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

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

@@ -196,9 +196,9 @@
 			 *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as

 			 *  a mask of CDC_CONTROL_LINE_IN_* masks.

 			 *

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

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

 			 */

-			void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);

+			void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

 

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

 	#if !defined(__DOXYGEN__)

@@ -218,9 +218,9 @@
 			#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)

-				                                           ATTR_WEAK ATTR_ALIAS(CDC_Host_Event_Stub);

-				static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);

-				static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);

+				                                           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_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);

 			#endif	

 	#endif