Demos/Host/LowLevel/PrinterHost/PrinterHost.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 PrinterHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "PrinterHost.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         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  47
  48         puts_P(PSTR(ESC_FG_CYAN "Printer Host Demo running.\r\n" ESC_FG_WHITE));
  49         sei();
  50
  51         for (;;)
  52         {
  53                 USB_Printer_Host();
  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 /** Task to set the configuration of the attached device after it has been enumerated, and to send some test page
 130  *  data to the attached printer.
 131  */
 132 void USB_Printer_Host(void)
 133 {
 134         uint8_t ErrorCode;
 135
 136         switch (USB_HostState)
 137         {
 138                 case HOST_STATE_Addressed:
 139                         puts_P(PSTR("Getting Config Data.\r\n"));
 140
 141                         /* Select the control pipe for the request transfer */
 142                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 143
 144                         /* Get and process the configuration descriptor data */
 145                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 146                         {
 147                                 if (ErrorCode == ControlError)
 148                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 149                                 else
 150                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 151
 152                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 153
 154                                 /* Indicate error via status LEDs */
 155                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 156
 157                                 /* Wait until USB device disconnected */
 158                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 159                                 break;
 160                         }
 161
 162                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 163                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 164                         {
 165                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 166                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 167
 168                                 /* Indicate error via status LEDs */
 169                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 170
 171                                 /* Wait until USB device disconnected */
 172                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 173                                 break;
 174                         }
 175
 176                         /* Some printers use alternate settings to determine the communication protocol used - if so, send a SetInterface
 177                          * request to switch to the interface alternate setting with the Bidirectional protocol */
 178                         if (PrinterAltSetting)
 179                         {
 180                                 USB_ControlRequest = (USB_Request_Header_t)
 181                                         {
 182                                                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_INTERFACE),
 183                                                 .bRequest      = REQ_SetInterface,
 184                                                 .wValue        = PrinterAltSetting,
 185                                                 .wIndex        = PrinterInterfaceNumber,
 186                                                 .wLength       = 0,
 187                                         };
 188
 189                                 if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 190                                 {
 191                                         printf_P(PSTR(ESC_FG_RED "Control Error (Set Interface).\r\n"
 192                                                                  " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 193
 194                                         /* Indicate error via status LEDs */
 195                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 196
 197                                         /* Wait until USB device disconnected */
 198                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 199                                         break;
 200                                 }
 201                         }
 202
 203                         puts_P(PSTR("Retrieving Device ID...\r\n"));
 204
 205                         char DeviceIDString[300];
 206                         if ((ErrorCode = Printer_GetDeviceID(DeviceIDString, sizeof(DeviceIDString))) != HOST_SENDCONTROL_Successful)
 207                         {
 208                                 printf_P(PSTR(ESC_FG_RED "Control Error (Get Device ID).\r\n"
 209                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 210
 211                                 /* Indicate error via status LEDs */
 212                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 213
 214                                 /* Wait until USB device disconnected */
 215                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 216                                 break;
 217                         }
 218
 219                         printf_P(PSTR("Printer Device ID: %s\r\n"), DeviceIDString);
 220
 221                         puts_P(PSTR("Printer Enumerated.\r\n"));
 222
 223                         USB_HostState = HOST_STATE_Configured;
 224                         break;
 225                 case HOST_STATE_Configured:
 226                         /* Indicate device busy via the status LEDs */
 227                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 228
 229                         char  TestPageData[]    = "\033%-12345X\033E" "LUFA PCL Test Page" "\033E\033%-12345X";
 230                         uint16_t TestPageLength = strlen(TestPageData);
 231
 232                         printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageLength);
 233
 234                         if ((ErrorCode = Printer_SendData(&TestPageData, TestPageLength)) != PIPE_RWSTREAM_NoError)
 235                         {
 236                                 printf_P(PSTR(ESC_FG_RED "Error Sending Test Page.\r\n"
 237                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 238
 239                                 /* Indicate error via status LEDs */
 240                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 241
 242                                 /* Wait until USB device disconnected */
 243                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 244                                 break;
 245                         }
 246
 247                         puts_P(PSTR("Test Page Sent.\r\n"));
 248
 249                         /* Indicate device no longer busy */
 250                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 251
 252                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 253                         break;
 254         }
 255 }
 256