Demos/Host/LowLevel/RNDISEthernetHost/RNDISEthernetHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 disclaim 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 RNDISEthernetHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "RNDISEthernetHost.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         puts_P(PSTR(ESC_FG_CYAN "RNDIS Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 RNDIS_Host_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         Serial_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72
  73         /* Create a stdio stream for the serial port for stdin and stdout */
  74         Serial_CreateStream(NULL);
  75 }
  76
  77 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  78  *  starts the library USB task to begin the enumeration and USB management process.
  79  */
  80 void EVENT_USB_Host_DeviceAttached(void)
  81 {
  82         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  83         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  84 }
  85
  86 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  87  *  stops the library USB task management process.
  88  */
  89 void EVENT_USB_Host_DeviceUnattached(void)
  90 {
  91         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  92         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  93 }
  94
  95 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  96  *  enumerated by the host and is now ready to be used by the application.
  97  */
  98 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  99 {
 100         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 101 }
 102
 103 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 104 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 105 {
 106         USB_Disable();
 107
 108         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 109                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 110
 111         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 112         for(;;);
 113 }
 114
 115 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 116  *  enumerating an attached USB device.
 117  */
 118 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 119                                             const uint8_t SubErrorCode)
 120 {
 121         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 122                                  " -- Error Code %d\r\n"
 123                                  " -- Sub Error Code %d\r\n"
 124                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 125
 126         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 127 }
 128
 129 void PrintIncomingPackets(void)
 130 {
 131         uint8_t ErrorCode;
 132
 133         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 134
 135         uint16_t PacketLength;
 136         if ((ErrorCode = RNDIS_GetPacketLength(&PacketLength)) != HOST_SENDCONTROL_Successful)
 137         {
 138                 printf_P(PSTR(ESC_FG_RED "Packet Reception Error.\r\n"
 139                                                                  " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 140                 return;
 141         }
 142
 143         if (!(PacketLength))
 144           return;
 145
 146         Pipe_Unfreeze();
 147
 148         printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
 149
 150         if (PacketLength > 1024)
 151         {
 152                 puts_P(PSTR(ESC_FG_RED "Packet too large.\r\n" ESC_FG_WHITE));
 153                 Pipe_Discard_Stream(PacketLength, NULL);
 154         }
 155         else
 156         {
 157                 uint8_t PacketBuffer[PacketLength];
 158
 159                 Pipe_Read_Stream_LE(&PacketBuffer, PacketLength, NULL);
 160
 161                 for (uint16_t i = 0; i < PacketLength; i++)
 162                   printf("0x%02x ", PacketBuffer[i]);
 163         }
 164
 165         Pipe_ClearIN();
 166         Pipe_Freeze();
 167
 168         printf("\r\n\r\n");
 169
 170         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 171 }
 172
 173 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
 174  *  data received from the attached RNDIS device and print it to the serial port.
 175  */
 176 void RNDIS_Host_Task(void)
 177 {
 178         uint8_t ErrorCode;
 179
 180         switch (USB_HostState)
 181         {
 182                 case HOST_STATE_Addressed:
 183                         puts_P(PSTR("Getting Config Data.\r\n"));
 184
 185                         /* Get and process the configuration descriptor data */
 186                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 187                         {
 188                                 if (ErrorCode == ControlError)
 189                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 190                                 else
 191                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 192
 193                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 194
 195                                 /* Indicate error via status LEDs */
 196                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 197
 198                                 /* Wait until USB device disconnected */
 199                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 200                                 break;
 201                         }
 202
 203                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 204                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 205                         {
 206                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 207                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 208
 209                                 /* Indicate error via status LEDs */
 210                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 211
 212                                 /* Wait until USB device disconnected */
 213                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 214                                 break;
 215                         }
 216
 217                         uint16_t DeviceMaxPacketSize;
 218                         if ((ErrorCode = RNDIS_InitializeDevice(1024, &DeviceMaxPacketSize)) != HOST_SENDCONTROL_Successful)
 219                         {
 220                                 printf_P(PSTR(ESC_FG_RED "Error Initializing Device.\r\n"
 221                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 222
 223                                 /* Indicate error via status LEDs */
 224                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 225
 226                                 /* Wait until USB device disconnected */
 227                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 228                                 break;
 229                         }
 230
 231                         printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), DeviceMaxPacketSize);
 232
 233                         /* We set the default filter to only receive packets we would be interested in */
 234                         uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
 235                         if ((ErrorCode = RNDIS_SetRNDISProperty(OID_GEN_CURRENT_PACKET_FILTER,
 236                                                                 &PacketFilter, sizeof(PacketFilter))) != HOST_SENDCONTROL_Successful)
 237                         {
 238                                 printf_P(PSTR(ESC_FG_RED "Error Setting Device Packet Filter.\r\n"
 239                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 240
 241                                 /* Indicate error via status LEDs */
 242                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 243
 244                                 /* Wait until USB device disconnected */
 245                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 246                                 break;
 247                         }
 248
 249                         uint32_t VendorID;
 250                         if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_VENDOR_ID,
 251                                                                   &VendorID, sizeof(VendorID))) != HOST_SENDCONTROL_Successful)
 252                         {
 253                                 printf_P(PSTR(ESC_FG_RED "Error Getting Vendor ID.\r\n"
 254                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 255
 256                                 /* Indicate error via status LEDs */
 257                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 258
 259                                 /* Wait until USB device disconnected */
 260                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 261                                 break;
 262                         }
 263
 264                         printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
 265
 266                         puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
 267
 268                         USB_HostState = HOST_STATE_Configured;
 269                         break;
 270                 case HOST_STATE_Configured:
 271                         PrintIncomingPackets();
 272
 273                         break;
 274         }
 275 }
 276