Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / RNDISEthernet / RNDISEthernet.c
diff --git a/Demos/RNDISEthernet/RNDISEthernet.c b/Demos/RNDISEthernet/RNDISEthernet.c
deleted file mode 100644 (file)
index 3f9bb18..0000000
+++ /dev/null
@@ -1,357 +0,0 @@
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the RNDISEthernet demo. This file contains the main tasks of the demo and\r
- *  is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "RNDISEthernet.h"\r
-\r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA RNDIS App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
-       { Task: Ethernet_Task        , TaskStatus: TASK_STOP },\r
-       { Task: TCP_Task             , TaskStatus: TASK_STOP },\r
-       { Task: RNDIS_Task           , TaskStatus: TASK_STOP },\r
-};\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  starts the scheduler to run the USB management task.\r
- */\r
-int main(void)\r
-{\r
-       /* Disable watchdog if enabled by bootloader/fuses */\r
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       LEDs_Init();\r
-       SerialStream_Init(9600, false);\r
-       \r
-       /* Webserver Initialization */\r
-       TCP_Init();\r
-       Webserver_Init();\r
-\r
-       printf_P(PSTR("\r\n\r\n****** RNDIS Demo running. ******\r\n"));\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-       \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r
-       USB_Init();\r
-\r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r
-}\r
-\r
-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
- *  starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-EVENT_HANDLER(USB_Connect)\r
-{\r
-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r
-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- *  the status LEDs and stops all the relevent tasks.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
-       /* Stop running TCP/IP and USB management tasks */\r
-       Scheduler_SetTaskMode(RNDIS_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(Ethernet_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(TCP_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration\r
- *  of the USB device after enumeration, and configures the RNDIS device endpoints and starts the relevent tasks.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
-       /* Setup CDC Notification, Rx and Tx Endpoints */\r
-       Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
-\r
-       /* Start TCP/IP tasks */\r
-       Scheduler_SetTaskMode(RNDIS_Task, TASK_RUN);\r
-       Scheduler_SetTaskMode(Ethernet_Task, TASK_RUN);\r
-       Scheduler_SetTaskMode(TCP_Task, TASK_RUN);\r
-}\r
-\r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- *  control requests that are not handled internally by the USB library (including the RNDIS control commands,\r
- *  which set up the USB RNDIS network adapter), so that they can be handled appropriately for the application.\r
- */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
-       /* Discard the unused wValue parameter */\r
-       Endpoint_Discard_Word();\r
-\r
-       /* Discard the unused wIndex parameter */\r
-       Endpoint_Discard_Word();\r
-\r
-       /* Read in the wLength parameter */\r
-       uint16_t wLength = Endpoint_Read_Word_LE();\r
-\r
-       /* Process RNDIS class commands */\r
-       switch (bRequest)\r
-       {\r
-               case SEND_ENCAPSULATED_COMMAND:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Clear the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
-                               \r
-                               /* Read in the RNDIS message into the message buffer */\r
-                               Endpoint_Read_Control_Stream_LE(RNDISMessageBuffer, wLength);\r
-\r
-                               /* Finalize the stream transfer to clear the last packet from the host */\r
-                               Endpoint_ClearSetupIN();\r
-\r
-                               /* Process the RNDIS message */\r
-                               ProcessRNDISControlMessage();\r
-                       }\r
-                       \r
-                       break;\r
-               case GET_ENCAPSULATED_RESPONSE:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Check if a response to the last message is ready */\r
-                               if (!(MessageHeader->MessageLength))\r
-                               {\r
-                                       /* Set the response to a single 0x00 byte to indicate that no response is ready */\r
-                                       RNDISMessageBuffer[0] = 0;\r
-                                       MessageHeader->MessageLength = 1;\r
-                               }\r
-\r
-                               /* Check if less than the requested number of bytes to transfer */\r
-                               if (MessageHeader->MessageLength < wLength)\r
-                                 wLength = MessageHeader->MessageLength;\r
-\r
-                               /* Clear the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
-                               \r
-                               /* Write the message response data to the endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(RNDISMessageBuffer, wLength);\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearSetupOUT();\r
-\r
-                               /* Reset the message header once again after transmission */\r
-                               MessageHeader->MessageLength = 0;\r
-                       }\r
-       \r
-                       break;\r
-       }\r
-}\r
-\r
-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- *  \param CurrentStatus  Current status of the system, from the RNDISEthernet_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
-                       break;\r
-               case Status_ProcessingEthernetFrame:\r
-                       LEDMask = (LEDS_LED2 | LEDS_LED3);\r
-                       break;          \r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Task to manage the sending and receiving of encapsulated RNDIS data and notifications. This removes the RNDIS\r
- *  wrapper from recieved Ethernet frames and places them in the FrameIN global buffer, or adds the RNDIS wrapper\r
- *  to a frame in the FrameOUT global before sending the buffer contents to the host.\r
- */\r
-TASK(RNDIS_Task)\r
-{\r
-       /* Select the notification endpoint */\r
-       Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
-\r
-       /* Check if a message response is ready for the host */\r
-       if (Endpoint_ReadWriteAllowed() && ResponseReady)\r
-       {\r
-               USB_Notification_t Notification = (USB_Notification_t)\r
-                       {\r
-                               bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                               bNotification: NOTIF_RESPONSE_AVAILABLE,\r
-                               wValue:        0,\r
-                               wIndex:        0,\r
-                               wLength:       0,\r
-                       };\r
-               \r
-               /* Indicate that a message response is ready for the host */\r
-               Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
-\r
-               /* Finalize the stream transfer to send the last packet */\r
-               Endpoint_ClearCurrentBank();\r
-\r
-               /* Indicate a response is no longer ready */\r
-               ResponseReady = false;\r
-       }\r
-       \r
-       /* Don't process the data endpoints until the system is in the data initialized state, and the buffer is free */\r
-       if ((CurrRNDISState == RNDIS_Data_Initialized) && !(MessageHeader->MessageLength))\r
-       {\r
-               /* Create a new packet header for reading/writing */\r
-               RNDIS_PACKET_MSG_t RNDISPacketHeader;\r
-\r
-               /* Select the data OUT endpoint */\r
-               Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
-               \r
-               /* Check if the data OUT endpoint contains data, and that the IN buffer is empty */\r
-               if (Endpoint_ReadWriteAllowed() && !(FrameIN.FrameInBuffer))\r
-               {\r
-                       /* Read in the packet message header */\r
-                       Endpoint_Read_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_PACKET_MSG_t));\r
-\r
-                       /* Stall the request if the data is too large */\r
-                       if (RNDISPacketHeader.MessageLength > ETHERNET_FRAME_SIZE_MAX)\r
-                       {\r
-                               Endpoint_StallTransaction();\r
-                               return;\r
-                       }\r
-                       \r
-                       /* Read in the Ethernet frame into the buffer */\r
-                       Endpoint_Read_Stream_LE(FrameIN.FrameData, RNDISPacketHeader.DataLength);\r
-\r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearCurrentBank();\r
-                       \r
-                       /* Store the size of the Ethernet frame */\r
-                       FrameIN.FrameLength = RNDISPacketHeader.DataLength;\r
-\r
-                       /* Indicate Ethernet IN buffer full */\r
-                       FrameIN.FrameInBuffer = true;\r
-               }\r
-               \r
-               /* Select the data IN endpoint */\r
-               Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
-               \r
-               /* Check if the data IN endpoint is ready for more data, and that the IN buffer is full */\r
-               if (Endpoint_ReadWriteAllowed() && FrameOUT.FrameInBuffer)\r
-               {\r
-                       /* Clear the packet header with all 0s so that the relevant fields can be filled */\r
-                       memset(&RNDISPacketHeader, 0, sizeof(RNDIS_PACKET_MSG_t));\r
-\r
-                       /* Construct the required packet header fields in the buffer */\r
-                       RNDISPacketHeader.MessageType   = REMOTE_NDIS_PACKET_MSG;\r
-                       RNDISPacketHeader.MessageLength = (sizeof(RNDIS_PACKET_MSG_t) + FrameOUT.FrameLength);\r
-                       RNDISPacketHeader.DataOffset    = (sizeof(RNDIS_PACKET_MSG_t) - sizeof(RNDIS_Message_Header_t));\r
-                       RNDISPacketHeader.DataLength    = FrameOUT.FrameLength;\r
-\r
-                       /* Send the packet header to the host */\r
-                       Endpoint_Write_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_PACKET_MSG_t));\r
-\r
-                       /* Send the Ethernet frame data to the host */\r
-                       Endpoint_Write_Stream_LE(FrameOUT.FrameData, RNDISPacketHeader.DataLength);\r
-                       \r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearCurrentBank();\r
-                       \r
-                       /* Indicate Ethernet OUT buffer no longer full */\r
-                       FrameOUT.FrameInBuffer = false;\r
-               }\r
-       }\r
-}\r
-\r
-/** Ethernet frame processing task. This task checks to see if a frame has been received, and if so hands off the processing\r
- *  of the frame to the Ethernet processing routines.\r
- */\r
-TASK(Ethernet_Task)\r
-{\r
-       /* Task for Ethernet processing. Incoming ethernet frames are loaded into the FrameIN structure, and\r
-          outgoing frames should be loaded into the FrameOUT structure. Both structures can only hold a single\r
-          Ethernet frame at a time, so the FrameInBuffer bool is used to indicate when the buffers contain data. */\r
-\r
-       /* Check if a frame has been written to the IN frame buffer */\r
-       if (FrameIN.FrameInBuffer)\r
-       {\r
-               /* Indicate packet processing started */\r
-               UpdateStatus(Status_ProcessingEthernetFrame);\r
-\r
-               /* Process the ethernet frame - replace this with your own Ethernet handler code as desired */\r
-               Ethernet_ProcessPacket();\r
-\r
-               /* Indicate packet processing complete */\r
-               UpdateStatus(Status_USBReady);\r
-       }\r
-}\r