lib/lufa/Demos/Host/ClassDriver/RNDISEthernetHost/RNDISEthernetHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 #if (ARCH == ARCH_AVR8)
 121         /* Disable watchdog if enabled by bootloader/fuses */
 122         MCUSR &= ~(1 << WDRF);
 123         wdt_disable();
 124
 125         /* Disable clock division */
 126         clock_prescale_set(clock_div_1);
 127 #endif
 128
 129         /* Hardware Initialization */
 130         Serial_Init(9600, false);
 131         LEDs_Init();
 132         USB_Init();
 133
 134         /* Create a stdio stream for the serial port for stdin and stdout */
 135         Serial_CreateStream(NULL);
 136 }
 137
 138 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 139  *  starts the library USB task to begin the enumeration and USB management process.
 140  */
 141 void EVENT_USB_Host_DeviceAttached(void)
 142 {
 143         puts_P(PSTR("Device Attached.\r\n"));
 144         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 145 }
 146
 147 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 148  *  stops the library USB task management process.
 149  */
 150 void EVENT_USB_Host_DeviceUnattached(void)
 151 {
 152         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 153         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 154 }
 155
 156 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 157  *  enumerated by the host and is now ready to be used by the application.
 158  */
 159 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 160 {
 161         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 162
 163         uint16_t ConfigDescriptorSize;
 164         uint8_t  ConfigDescriptorData[512];
 165
 166         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 167                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 168         {
 169                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 170                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 171                 return;
 172         }
 173
 174         if (RNDIS_Host_ConfigurePipes(&Ethernet_RNDIS_Interface,
 175                                       ConfigDescriptorSize, ConfigDescriptorData) != RNDIS_ENUMERROR_NoError)
 176         {
 177                 puts_P(PSTR("Attached Device Not a Valid RNDIS Class Device.\r\n"));
 178                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 179                 return;
 180         }
 181
 182         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 183         {
 184                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 185                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 186                 return;
 187         }
 188
 189         if (RNDIS_Host_InitializeDevice(&Ethernet_RNDIS_Interface) != HOST_SENDCONTROL_Successful)
 190         {
 191                 puts_P(PSTR("Error Initializing Device.\r\n"));
 192
 193                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 194                 USB_Host_SetDeviceConfiguration(0);
 195                 return;
 196         }
 197
 198         printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), Ethernet_RNDIS_Interface.State.DeviceMaxPacketSize);
 199
 200         uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
 201         if (RNDIS_Host_SetRNDISProperty(&Ethernet_RNDIS_Interface, OID_GEN_CURRENT_PACKET_FILTER,
 202                                         &PacketFilter, sizeof(PacketFilter)) != HOST_SENDCONTROL_Successful)
 203         {
 204                 puts_P(PSTR("Error Setting Device Packet Filter.\r\n"));
 205
 206                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 207                 USB_Host_SetDeviceConfiguration(0);
 208                 return;
 209         }
 210
 211         uint32_t VendorID;
 212         if (RNDIS_Host_QueryRNDISProperty(&Ethernet_RNDIS_Interface, OID_GEN_VENDOR_ID,
 213                                           &VendorID, sizeof(VendorID)) != HOST_SENDCONTROL_Successful)
 214         {
 215                 puts_P(PSTR("Error Getting Vendor ID.\r\n"));
 216
 217                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 218                 USB_Host_SetDeviceConfiguration(0);
 219                 return;
 220         }
 221
 222         printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
 223
 224         puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
 225         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 226 }
 227
 228 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 229 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 230 {
 231         USB_Disable();
 232
 233         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 234                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 235
 236         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 237         for(;;);
 238 }
 239
 240 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 241  *  enumerating an attached USB device.
 242  */
 243 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 244                                             const uint8_t SubErrorCode)
 245 {
 246         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 247                                  " -- Error Code %d\r\n"
 248                                  " -- Sub Error Code %d\r\n"
 249                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 250
 251         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 252 }
 253