Added new RNDISHost Host LowLevel demo. Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction. Fixed CDCHost failing on devices with bidirectional endpoints.

Demos/Host/LowLevel/CDCHost/CDCHost.c

@@ -216,8 +216,9 @@ void CDC_Host_Task(void)
 			USB_HostState = HOST_STATE_Configured;
 			break;
 		case HOST_STATE_Configured:
-			/* Select and the data IN pipe */
+			/* Select the data IN pipe */
 			Pipe_SelectPipe(CDC_DATAPIPE_IN);
+			Pipe_SetPipeToken(PIPE_TOKEN_IN);
 			Pipe_Unfreeze();
 
 			/* Check to see if a packet has been received */

Demos/Host/LowLevel/CDCHost/ConfigDescriptor.c

@@ -145,6 +145,10 @@ uint8_t ProcessConfigurationDescriptor(void)
 			/* Check if the endpoint is a bulk IN or bulk OUT endpoint */
 			if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 			{
+				/* Kill the configured OUT pipe if the data endpoints are bidirectional */
+				if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
+				  Pipe_DisablePipe();
+
 				/* Configure the data IN pipe */
 				Pipe_ConfigurePipe(CDC_DATAPIPE_IN, EP_TYPE_BULK, PIPE_TOKEN_IN,
 								   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
@@ -154,9 +158,13 @@ uint8_t ProcessConfigurationDescriptor(void)
 			}
 			else
 			{
-				/* Configure the data OUT pipe */
-				Pipe_ConfigurePipe(CDC_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,
-								   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
+				/* Only configure the OUT data pipe if the data endpoints haev not shown to be bidirectional */
+				if (!(Pipe_IsEndpointBound(EndpointData->EndpointAddress)))
+				{
+					/* Configure the data OUT pipe */
+					Pipe_ConfigurePipe(CDC_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,
+									   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
+				}
 				
 				/* Set the flag indicating that the data OUT pipe has been found */
 				FoundEndpoints |= (1 << CDC_DATAPIPE_OUT);

Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.c

@@ -145,6 +145,10 @@ uint8_t ProcessConfigurationDescriptor(void)
 			/* Check if the endpoint is a bulk IN or bulk OUT endpoint */
 			if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
 			{
+				/* Kill the configured OUT pipe if the data endpoints are bidirectional */
+				if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
+				  Pipe_DisablePipe();
+
 				/* Configure the data IN pipe */
 				Pipe_ConfigurePipe(RNDIS_DATAPIPE_IN, EP_TYPE_BULK, PIPE_TOKEN_IN,
 								   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
@@ -154,9 +158,13 @@ uint8_t ProcessConfigurationDescriptor(void)
 			}
 			else
 			{
-				/* Configure the data OUT pipe */
-				Pipe_ConfigurePipe(RNDIS_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,
-								   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
+				/* Only configure the OUT data pipe if the data endpoints haev not shown to be bidirectional */
+				if (!(Pipe_IsEndpointBound(EndpointData->EndpointAddress)))
+				{
+					/* Configure the data OUT pipe */
+					Pipe_ConfigurePipe(RNDIS_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,
+									   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
+				}
 				
 				/* Set the flag indicating that the data OUT pipe has been found */
 				FoundEndpoints |= (1 << RNDIS_DATAPIPE_OUT);

Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.c

@@ -30,14 +30,23 @@
 
 /** \file
  *
- *  RNDOS Device commands, to issue RNDIS commands to the device for
+ *  RNDIS Device commands, to issue RNDIS commands to the device for
  *  the control and data transfer between the host and RNDIS device.
  */
 
 #include "RNDISCommands.h"
 
+/** Current RNDIS Request ID, for associating sent commands with received data */
 uint32_t RequestID = 0;
 
+
+/** Function to send the given encapsulated RNDIS command to the device.
+ *
+ *  \param[in] Buffer  Source command data buffer to send to the device
+ *  \param[in] Bytes   Number of bytes to send
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_SendEncapsulatedCommand(void* Buffer, uint16_t Length)
 {
 	USB_ControlRequest = (USB_Request_Header_t)
@@ -55,6 +64,13 @@ uint8_t RNDIS_SendEncapsulatedCommand(void* Buffer, uint16_t Length)
 	return USB_Host_SendControlRequest(Buffer);
 }
 
+/** Function to receive the given encapsulated RNDIS response from the device.
+ *
+ *  \param[out] Buffer  Destination command data buffer to write read data from the device to
+ *  \param[in] Bytes   Number of bytes to read
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_GetEncapsulatedResponse(void* Buffer, uint16_t Length)
 {
 	USB_ControlRequest = (USB_Request_Header_t)
@@ -72,6 +88,11 @@ uint8_t RNDIS_GetEncapsulatedResponse(void* Buffer, uint16_t Length)
 	return USB_Host_SendControlRequest(Buffer);
 }
 
+/** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods
+ *  of long inactivity.
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_SendKeepAlive(void)
 {
 	uint8_t ErrorCode;
@@ -98,6 +119,13 @@ uint8_t RNDIS_SendKeepAlive(void)
 	return HOST_SENDCONTROL_Successful;
 }
 
+/** 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
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_InitializeDevice(uint16_t HostMaxPacketSize, uint16_t* DeviceMaxPacketSize)
 {
 	uint8_t ErrorCode;
@@ -133,6 +161,14 @@ uint8_t RNDIS_InitializeDevice(uint16_t HostMaxPacketSize, uint16_t* DeviceMaxPa
 	return HOST_SENDCONTROL_Successful;
 }
 
+/** Sets a given RNDIS property of an attached RNDIS device.
+ *
+ *  \param[in] Oid  OID number of the parameter to set
+ *  \param[in] Buffer  Pointer to where the property data is to be sourced from
+ *  \param[in] Length  Length in bytes of the property data to sent to the device
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length)
 {
 	uint8_t ErrorCode;
@@ -174,6 +210,14 @@ uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length)
 	return HOST_SENDCONTROL_Successful;
 }
 
+/** Gets a given RNDIS property of an attached RNDIS device.
+ *
+ *  \param[in] Oid  OID number of the parameter to get
+ *  \param[in] Buffer  Pointer to where the property data is to be written to
+ *  \param[in] MaxLength  Length in bytes of the destination buffer size
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
 uint8_t RNDIS_QueryRNDISProperty(uint32_t Oid, void* Buffer, uint16_t MaxLength)
 {
 	uint8_t ErrorCode;
@@ -215,10 +259,28 @@ uint8_t RNDIS_QueryRNDISProperty(uint32_t Oid, void* Buffer, uint16_t MaxLength)
 	return HOST_SENDCONTROL_Successful;
 }
 
+/** Retrieves the size of a received packet, discarding the remainder of the RNDIS packet header to leave only the
+ *  packet contents for processing by the host.
+ *
+ *  \param[out] PacketLength  Size of the packet currently in the pipe
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
 uint8_t RNDIS_GetPacketLength(uint16_t* PacketLength)
 {
 	uint8_t ErrorCode;
 
+	Pipe_SelectPipe(RNDIS_DATAPIPE_IN);
+	Pipe_SetPipeToken(PIPE_TOKEN_IN);
+	Pipe_Unfreeze();
+	
+	if (!(Pipe_IsReadWriteAllowed()))
+	{
+		*PacketLength = 0;
+		Pipe_Freeze();
+		return PIPE_RWSTREAM_NoError;
+	}
+
 	RNDIS_Packet_Message_t DeviceMessage;
 	
 	if ((ErrorCode = Pipe_Read_Stream_LE(&DeviceMessage, sizeof(RNDIS_Packet_Message_t))) != PIPE_RWSTREAM_NoError)
@@ -230,5 +292,7 @@ uint8_t RNDIS_GetPacketLength(uint16_t* PacketLength)
 	
 	Pipe_Discard_Stream(DeviceMessage.DataOffset - (sizeof(RNDIS_Packet_Message_t) - sizeof(RNDIS_Message_Header_t)));
 	
+	Pipe_Freeze();
+	
 	return PIPE_RWSTREAM_NoError;
 }

Demos/Host/LowLevel/RNDISEthernetHost/RNDISEthernetHost.c

@@ -125,18 +125,7 @@ void PrintIncommingPackets(void)
 {
 	uint8_t ErrorCode;
 
-	Pipe_SelectPipe(RNDIS_DATAPIPE_IN);
-	Pipe_Unfreeze();
-	
-	if (!(Pipe_IsReadWriteAllowed()))
-	{
-		Pipe_Freeze();
-		return;
-	}
-
 	LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
-	
-	puts_P(PSTR("DATA IN\r\n"));
 
 	uint16_t PacketLength;
 	if ((ErrorCode = RNDIS_GetPacketLength(&PacketLength)) != HOST_SENDCONTROL_Successful)
@@ -145,6 +134,11 @@ void PrintIncommingPackets(void)
 								 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);		
 		return;
 	}
+	
+	if (!(PacketLength))
+	  return;
+	
+	Pipe_Unfreeze();
 
 	printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
 
@@ -163,12 +157,12 @@ void PrintIncommingPackets(void)
 		  printf("%02x ", PacketBuffer[i]);
 	}
 	
+	Pipe_ClearIN();
+	Pipe_Freeze();
+
 	printf("\r\n\r\n");
 
 	LEDs_SetAllLEDs(LEDMASK_USB_READY);
-
-	Pipe_ClearIN();
-	Pipe_Freeze();
 }
 
 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
@@ -246,25 +240,7 @@ void RNDIS_Host_Task(void)
 				USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 				break;
 			}
-
-			uint32_t RetrievedPacketFilter;
-			if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_CURRENT_PACKET_FILTER,
-			                                          &RetrievedPacketFilter, sizeof(RetrievedPacketFilter))) != HOST_SENDCONTROL_Successful)
-			{
-				printf_P(PSTR(ESC_FG_RED "Error Getting Packet Filter.\r\n"
-				                         " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
-
-				/* Indicate error via status LEDs */
-				LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-				/* Wait until USB device disconnected */
-				USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-				break;
-			}
 			
-			if (RetrievedPacketFilter != PacketFilter)
-				printf("ERROR: Retrieved Packet Filter 0x%08lx != Set Packet Filter 0x%08lx!\r\n", RetrievedPacketFilter, PacketFilter);
-
 			uint32_t VendorID;
 			if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_VENDOR_ID,
 			                                          &VendorID, sizeof(VendorID))) != HOST_SENDCONTROL_Successful)

Demos/Host/LowLevel/RNDISEthernetHost/RNDISHost.txt

@@ -0,0 +1,62 @@
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+ 
+/** \mainpage RNDIS Host Demo
+ *
+ *  \section SSec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  - Series 7 USB AVRs
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Host</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Communications Device Class (CDC)</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>Microsoft RNDIS Specification</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  RNDIS host demonstration application. This gives a simple reference
+ *  application for implementing a RNDIS Ethernet host, for USB devices such as
+ *  modems.
+ *  
+ *  This demo will enumerate an attached USB RNDIS device, print out its vendor ID
+ *  and any received packets in raw form through the serial USART.
+ *
+ *  \section SSec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */

Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c

@@ -78,7 +78,10 @@ void SImage_SendBlockHeader(void)
 	Pipe_Freeze();
 }
 
-/** Function to receive a PIMA event container from the attached still image device. */
+/** Function to receive a PIMA event container from the attached still image device.
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ /
 uint8_t SImage_ReceiveEventHeader(void)
 {
 	uint8_t ErrorCode;
@@ -99,7 +102,10 @@ uint8_t SImage_ReceiveEventHeader(void)
 	return ErrorCode;
 }
 
-/** Function to receive a PIMA response container from the attached still image device. */
+/** Function to receive a PIMA response container from the attached still image device.
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
 uint8_t SImage_ReceiveBlockHeader(void)
 {
 	uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;
@@ -189,6 +195,8 @@ uint8_t SImage_ReceiveBlockHeader(void)
  *
  *  \param[in] Buffer  Source data buffer to send to the device
  *  \param[in] Bytes   Number of bytes to send
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
  */
 uint8_t SImage_SendData(void* Buffer, uint16_t Bytes)
 {

Demos/Host/LowLevel/makefile

@@ -15,34 +15,37 @@
 
 all:
 	make -C CDCHost clean
-	make -C CDCHost all	
+	make -C CDCHost all
 
 	make -C GenericHIDHost clean
-	make -C GenericHIDHost all	
+	make -C GenericHIDHost all
 
 	make -C JoystickHostWithParser clean
-	make -C JoystickHostWithParser all	
+	make -C JoystickHostWithParser all
 
 	make -C KeyboardHost clean
-	make -C KeyboardHost all	
+	make -C KeyboardHost all
 
 	make -C MassStorageHost clean
-	make -C MassStorageHost all	
+	make -C MassStorageHost all
 
 	make -C MIDIHost clean
-	make -C MIDIHost all	
+	make -C MIDIHost all
 
 	make -C MouseHost clean
-	make -C MouseHost all	
+	make -C MouseHost all
 
 	make -C MouseHostWithParser clean
-	make -C MouseHostWithParser all	
+	make -C MouseHostWithParser all
 
 	make -C PrinterHost clean
-	make -C PrinterHost all	
+	make -C PrinterHost all
 
 	make -C StillImageHost clean
-	make -C StillImageHost all	
+	make -C StillImageHost all
+
+	make -C RNDISHost clean
+	make -C RNDISHost all
 
 %:
 	make -C CDCHost $@
@@ -56,3 +59,4 @@ all:
 	make -C MouseHostWithParser $@
 	make -C PrinterHost $@
 	make -C StillImageHost $@
+	make -C RNDISHost $@