Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the RNDISEthernet demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "RNDISEthernet.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         /* Webserver Initialization */
  47         TCP_Init();
  48         Webserver_Init();
  49
  50         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  51         GlobalInterruptEnable();
  52
  53         for (;;)
  54         {
  55                 Ethernet_Task();
  56                 TCP_Task();
  57                 RNDIS_Task();
  58                 USB_USBTask();
  59         }
  60 }
  61
  62 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  63 void SetupHardware(void)
  64 {
  65         /* Disable watchdog if enabled by bootloader/fuses */
  66         MCUSR &= ~(1 << WDRF);
  67         wdt_disable();
  68
  69         /* Disable clock division */
  70         clock_prescale_set(clock_div_1);
  71
  72         /* Hardware Initialization */
  73         LEDs_Init();
  74         Serial_Init(9600, false);
  75         USB_Init();
  76
  77         /* Create a stdio stream for the serial port for stdin and stdout */
  78         Serial_CreateStream(NULL);
  79 }
  80
  81 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  82  *  starts the library USB task to begin the enumeration and USB management process.
  83  */
  84 void EVENT_USB_Device_Connect(void)
  85 {
  86         /* Indicate USB enumerating */
  87         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  88 }
  89
  90 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  91  *  the status LEDs and stops all the relevant tasks.
  92  */
  93 void EVENT_USB_Device_Disconnect(void)
  94 {
  95         /* Indicate USB not ready */
  96         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  97 }
  98
  99 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 100  *  of the USB device after enumeration, and configures the RNDIS device endpoints and starts the relevant tasks.
 101  */
 102 void EVENT_USB_Device_ConfigurationChanged(void)
 103 {
 104         bool ConfigSuccess = true;
 105
 106         /* Setup RNDIS Data Endpoints */
 107         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_TX_EPADDR, EP_TYPE_BULK, CDC_TXRX_EPSIZE, 1);
 108         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_RX_EPADDR, EP_TYPE_BULK, CDC_TXRX_EPSIZE, 1);
 109         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPADDR, EP_TYPE_INTERRUPT, CDC_NOTIFICATION_EPSIZE, 1);
 110
 111         /* Indicate endpoint configuration success or failure */
 112         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 113 }
 114
 115 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 116  *  the device from the USB host before passing along unhandled control requests to the library for processing
 117  *  internally.
 118  */
 119 void EVENT_USB_Device_ControlRequest(void)
 120 {
 121         /* Process RNDIS class commands */
 122         switch (USB_ControlRequest.bRequest)
 123         {
 124                 case RNDIS_REQ_SendEncapsulatedCommand:
 125                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 126                         {
 127                                 Endpoint_ClearSETUP();
 128
 129                                 /* Read in the RNDIS message into the message buffer */
 130                                 Endpoint_Read_Control_Stream_LE(RNDISMessageBuffer, USB_ControlRequest.wLength);
 131                                 Endpoint_ClearIN();
 132
 133                                 /* Process the RNDIS message */
 134                                 ProcessRNDISControlMessage();
 135                         }
 136
 137                         break;
 138                 case RNDIS_REQ_GetEncapsulatedResponse:
 139                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 140                         {
 141                                 /* Check if a response to the last message is ready */
 142                                 if (!(MessageHeader->MessageLength))
 143                                 {
 144                                         /* Set the response to a single 0x00 byte to indicate that no response is ready */
 145                                         RNDISMessageBuffer[0] = 0;
 146                                         MessageHeader->MessageLength = 1;
 147                                 }
 148
 149                                 Endpoint_ClearSETUP();
 150
 151                                 /* Write the message response data to the endpoint */
 152                                 Endpoint_Write_Control_Stream_LE(RNDISMessageBuffer, MessageHeader->MessageLength);
 153                                 Endpoint_ClearOUT();
 154
 155                                 /* Reset the message header once again after transmission */
 156                                 MessageHeader->MessageLength = 0;
 157                         }
 158
 159                         break;
 160         }
 161 }
 162
 163 /** Task to manage the sending and receiving of encapsulated RNDIS data and notifications. This removes the RNDIS
 164  *  wrapper from received Ethernet frames and places them in the FrameIN global buffer, or adds the RNDIS wrapper
 165  *  to a frame in the FrameOUT global before sending the buffer contents to the host.
 166  */
 167 void RNDIS_Task(void)
 168 {
 169         /* Select the notification endpoint */
 170         Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPADDR);
 171
 172         /* Check if a message response is ready for the host */
 173         if (Endpoint_IsINReady() && ResponseReady)
 174         {
 175                 USB_Request_Header_t Notification = (USB_Request_Header_t)
 176                         {
 177                                 .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 178                                 .bRequest      = RNDIS_NOTIF_ResponseAvailable,
 179                                 .wValue        = 0,
 180                                 .wIndex        = 0,
 181                                 .wLength       = 0,
 182                         };
 183
 184                 /* Indicate that a message response is ready for the host */
 185                 Endpoint_Write_Stream_LE(&Notification, sizeof(Notification), NULL);
 186
 187                 /* Finalize the stream transfer to send the last packet */
 188                 Endpoint_ClearIN();
 189
 190                 /* Indicate a response is no longer ready */
 191                 ResponseReady = false;
 192         }
 193
 194         /* Don't process the data endpoints until the system is in the data initialized state, and the buffer is free */
 195         if ((CurrRNDISState == RNDIS_Data_Initialized) && !(MessageHeader->MessageLength))
 196         {
 197                 /* Create a new packet header for reading/writing */
 198                 RNDIS_Packet_Message_t RNDISPacketHeader;
 199
 200                 /* Select the data OUT endpoint */
 201                 Endpoint_SelectEndpoint(CDC_RX_EPADDR);
 202
 203                 /* Check if the data OUT endpoint contains data, and that the IN buffer is empty */
 204                 if (Endpoint_IsOUTReceived() && !(FrameIN.FrameLength))
 205                 {
 206                         /* Read in the packet message header */
 207                         Endpoint_Read_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_Packet_Message_t), NULL);
 208
 209                         /* Stall the request if the data is too large */
 210                         if (RNDISPacketHeader.DataLength > ETHERNET_FRAME_SIZE_MAX)
 211                         {
 212                                 Endpoint_StallTransaction();
 213                                 return;
 214                         }
 215
 216                         /* Read in the Ethernet frame into the buffer */
 217                         Endpoint_Read_Stream_LE(FrameIN.FrameData, RNDISPacketHeader.DataLength, NULL);
 218
 219                         /* Finalize the stream transfer to send the last packet */
 220                         Endpoint_ClearOUT();
 221
 222                         /* Store the size of the Ethernet frame */
 223                         FrameIN.FrameLength = RNDISPacketHeader.DataLength;
 224                 }
 225
 226                 /* Select the data IN endpoint */
 227                 Endpoint_SelectEndpoint(CDC_TX_EPADDR);
 228
 229                 /* Check if the data IN endpoint is ready for more data, and that the IN buffer is full */
 230                 if (Endpoint_IsINReady() && FrameOUT.FrameLength)
 231                 {
 232                         /* Clear the packet header with all 0s so that the relevant fields can be filled */
 233                         memset(&RNDISPacketHeader, 0, sizeof(RNDIS_Packet_Message_t));
 234
 235                         /* Construct the required packet header fields in the buffer */
 236                         RNDISPacketHeader.MessageType   = REMOTE_NDIS_PACKET_MSG;
 237                         RNDISPacketHeader.MessageLength = (sizeof(RNDIS_Packet_Message_t) + FrameOUT.FrameLength);
 238                         RNDISPacketHeader.DataOffset    = (sizeof(RNDIS_Packet_Message_t) - sizeof(RNDIS_Message_Header_t));
 239                         RNDISPacketHeader.DataLength    = FrameOUT.FrameLength;
 240
 241                         /* Send the packet header to the host */
 242                         Endpoint_Write_Stream_LE(&RNDISPacketHeader, sizeof(RNDIS_Packet_Message_t), NULL);
 243
 244                         /* Send the Ethernet frame data to the host */
 245                         Endpoint_Write_Stream_LE(FrameOUT.FrameData, RNDISPacketHeader.DataLength, NULL);
 246
 247                         /* Finalize the stream transfer to send the last packet */
 248                         Endpoint_ClearIN();
 249
 250                         /* Indicate Ethernet OUT buffer no longer full */
 251                         FrameOUT.FrameLength = 0;
 252                 }
 253         }
 254 }
 255
 256 /** Ethernet frame processing task. This task checks to see if a frame has been received, and if so hands off the processing
 257  *  of the frame to the Ethernet processing routines.
 258  */
 259 void Ethernet_Task(void)
 260 {
 261         /* Task for Ethernet processing. Incoming ethernet frames are loaded into the FrameIN structure, and
 262            outgoing frames should be loaded into the FrameOUT structure. Both structures can only hold a single
 263            Ethernet frame at a time, so the FrameInBuffer bool is used to indicate when the buffers contain data. */
 264
 265         /* Device must be connected and configured for the task to run */
 266         if (USB_DeviceState != DEVICE_STATE_Configured)
 267           return;
 268
 269         /* Check if a frame has been written to the IN frame buffer */
 270         if (FrameIN.FrameLength)
 271         {
 272                 /* Indicate packet processing started */
 273                 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 274
 275                 /* Process the ethernet frame - replace this with your own Ethernet handler code as desired */
 276                 Ethernet_ProcessPacket();
 277
 278                 /* Indicate packet processing complete */
 279                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 280         }
 281 }
 282