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