Demos/Host/ClassDriver/RNDISEthernetHost/RNDISEthernetHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 /** Buffer to hold incoming and outgoing Ethernet packets. */
  40 static int8_t PacketBuffer[1024];
  41
  42 /** LUFA RNDIS Class driver interface configuration and state information. This structure is
  43  *  passed to all RNDIS Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_RNDIS_Host_t Ethernet_RNDIS_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .DataINPipeNumber           = 1,
  51                                 .DataINPipeDoubleBank       = false,
  52
  53                                 .DataOUTPipeNumber          = 2,
  54                                 .DataOUTPipeDoubleBank      = false,
  55
  56                                 .NotificationPipeNumber     = 3,
  57                                 .NotificationPipeDoubleBank = false,
  58
  59                                 .HostMaxPacketSize          = sizeof(PacketBuffer),
  60                         },
  61         };
  62
  63
  64 /** Main program entry point. This routine configures the hardware required by the application, then
  65  *  enters a loop to run the application tasks in sequence.
  66  */
  67 int main(void)
  68 {
  69         SetupHardware();
  70
  71         puts_P(PSTR(ESC_FG_CYAN "RNDIS Host Demo running.\r\n" ESC_FG_WHITE));
  72
  73         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  74         sei();
  75
  76         for (;;)
  77         {
  78                 RNDISHost_Task();
  79
  80                 RNDIS_Host_USBTask(&Ethernet_RNDIS_Interface);
  81                 USB_USBTask();
  82         }
  83 }
  84
  85 /** Task to manage an enumerated USB RNDIS device once connected, to display device
  86  *  received data packets.
  87  */
  88 void RNDISHost_Task(void)
  89 {
  90         if (USB_HostState != HOST_STATE_Configured)
  91           return;
  92
  93         if (RNDIS_Host_IsPacketReceived(&Ethernet_RNDIS_Interface))
  94         {
  95                 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
  96
  97                 uint16_t PacketLength;
  98                 RNDIS_Host_ReadPacket(&Ethernet_RNDIS_Interface, &PacketBuffer, &PacketLength);
  99
 100                 printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
 101
 102                 for (uint16_t i = 0; i < PacketLength; i++)
 103                   printf("0x%02x ", PacketBuffer[i]);
 104
 105                 printf_P(PSTR("\r\n\r\n"));
 106
 107                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 108         }
 109 }
 110
 111 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 112 void SetupHardware(void)
 113 {
 114         /* Disable watchdog if enabled by bootloader/fuses */
 115         MCUSR &= ~(1 << WDRF);
 116         wdt_disable();
 117
 118         /* Disable clock division */
 119         clock_prescale_set(clock_div_1);
 120
 121         /* Hardware Initialization */
 122         Serial_Init(9600, false);
 123         LEDs_Init();
 124         USB_Init();
 125
 126         /* Create a stdio stream for the serial port for stdin and stdout */
 127         Serial_CreateStream(NULL);
 128 }
 129
 130 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 131  *  starts the library USB task to begin the enumeration and USB management process.
 132  */
 133 void EVENT_USB_Host_DeviceAttached(void)
 134 {
 135         puts_P(PSTR("Device Attached.\r\n"));
 136         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 137 }
 138
 139 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 140  *  stops the library USB task management process.
 141  */
 142 void EVENT_USB_Host_DeviceUnattached(void)
 143 {
 144         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 145         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 146 }
 147
 148 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 149  *  enumerated by the host and is now ready to be used by the application.
 150  */
 151 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 152 {
 153         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 154
 155         uint16_t ConfigDescriptorSize;
 156         uint8_t  ConfigDescriptorData[512];
 157
 158         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 159                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 160         {
 161                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 162                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 163                 return;
 164         }
 165
 166         if (RNDIS_Host_ConfigurePipes(&Ethernet_RNDIS_Interface,
 167                                       ConfigDescriptorSize, ConfigDescriptorData) != RNDIS_ENUMERROR_NoError)
 168         {
 169                 puts_P(PSTR("Attached Device Not a Valid RNDIS Class Device.\r\n"));
 170                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 171                 return;
 172         }
 173
 174         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 175         {
 176                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 177                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 178                 return;
 179         }
 180
 181         if (RNDIS_Host_InitializeDevice(&Ethernet_RNDIS_Interface) != HOST_SENDCONTROL_Successful)
 182         {
 183                 puts_P(PSTR("Error Initializing Device.\r\n"));
 184
 185                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 186                 USB_Host_SetDeviceConfiguration(0);
 187                 return;
 188         }
 189
 190         printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), Ethernet_RNDIS_Interface.State.DeviceMaxPacketSize);
 191
 192         uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
 193         if (RNDIS_Host_SetRNDISProperty(&Ethernet_RNDIS_Interface, OID_GEN_CURRENT_PACKET_FILTER,
 194                                         &PacketFilter, sizeof(PacketFilter)) != HOST_SENDCONTROL_Successful)
 195         {
 196                 puts_P(PSTR("Error Setting Device Packet Filter.\r\n"));
 197
 198                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 199                 USB_Host_SetDeviceConfiguration(0);
 200                 return;
 201         }
 202
 203         uint32_t VendorID;
 204         if (RNDIS_Host_QueryRNDISProperty(&Ethernet_RNDIS_Interface, OID_GEN_VENDOR_ID,
 205                                           &VendorID, sizeof(VendorID)) != HOST_SENDCONTROL_Successful)
 206         {
 207                 puts_P(PSTR("Error Getting Vendor ID.\r\n"));
 208
 209                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 210                 USB_Host_SetDeviceConfiguration(0);
 211                 return;
 212         }
 213
 214         printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
 215
 216         puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
 217         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 218 }
 219
 220 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 221 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 222 {
 223         USB_Disable();
 224
 225         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 226                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 227
 228         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 229         for(;;);
 230 }
 231
 232 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 233  *  enumerating an attached USB device.
 234  */
 235 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 236                                             const uint8_t SubErrorCode)
 237 {
 238         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 239                                  " -- Error Code %d\r\n"
 240                                  " -- Sub Error Code %d\r\n"
 241                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 242
 243         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 244 }
 245