Demos/Host/LowLevel/PrinterHost/PrinterHost.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 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         puts_P(PSTR(ESC_FG_CYAN "Printer Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         GlobalInterruptEnable();
  50
  51         for (;;)
  52         {
  53                 PrinterHost_Task();
  54
  55                 USB_USBTask();
  56         }
  57 }
  58
  59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  60 void SetupHardware(void)
  61 {
  62 #if (ARCH == ARCH_AVR8)
  63         /* Disable watchdog if enabled by bootloader/fuses */
  64         MCUSR &= ~(1 << WDRF);
  65         wdt_disable();
  66
  67         /* Disable clock division */
  68         clock_prescale_set(clock_div_1);
  69 #endif
  70
  71         /* Hardware Initialization */
  72         Serial_Init(9600, false);
  73         LEDs_Init();
  74         USB_Init();
  75
  76         /* Create a stdio stream for the serial port for stdin and stdout */
  77         Serial_CreateStream(NULL);
  78 }
  79
  80 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  81  *  starts the library USB task to begin the enumeration and USB management process.
  82  */
  83 void EVENT_USB_Host_DeviceAttached(void)
  84 {
  85         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  86         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  87 }
  88
  89 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  90  *  stops the library USB task management process.
  91  */
  92 void EVENT_USB_Host_DeviceUnattached(void)
  93 {
  94         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  95         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  96 }
  97
  98 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  99  *  enumerated by the host and is now ready to be used by the application.
 100  */
 101 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 102 {
 103         puts_P(PSTR("Getting Config Data.\r\n"));
 104
 105         uint8_t ErrorCode;
 106
 107         /* Get and process the configuration descriptor data */
 108         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 109         {
 110                 if (ErrorCode == ControlError)
 111                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 112                 else
 113                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 114
 115                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 116
 117                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 118                 return;
 119         }
 120
 121         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 122         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 123         {
 124                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 125                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 126
 127                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 128                 return;
 129         }
 130
 131         /* Some printers use alternate settings to determine the communication protocol used - if so, send a SetInterface
 132          * request to switch to the interface alternate setting with the Bidirectional protocol */
 133         if (PrinterAltSetting)
 134         {
 135                 if ((ErrorCode = USB_Host_SetInterfaceAltSetting(PrinterInterfaceNumber, PrinterAltSetting)) != HOST_SENDCONTROL_Successful)
 136                 {
 137                         printf_P(PSTR(ESC_FG_RED "Control Error (Set Interface).\r\n"
 138                                                  " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 139
 140                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 141                         USB_Host_SetDeviceConfiguration(0);
 142                         return;
 143                 }
 144         }
 145
 146         puts_P(PSTR("Retrieving Device ID...\r\n"));
 147
 148         char DeviceIDString[300];
 149         if ((ErrorCode = Printer_GetDeviceID(DeviceIDString, sizeof(DeviceIDString))) != HOST_SENDCONTROL_Successful)
 150         {
 151                 printf_P(PSTR(ESC_FG_RED "Control Error (Get Device ID).\r\n"
 152                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 153
 154                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 155                 USB_Host_SetDeviceConfiguration(0);
 156                 return;
 157         }
 158
 159         printf_P(PSTR("Printer Device ID: %s\r\n"), DeviceIDString);
 160
 161         puts_P(PSTR("Printer Enumerated.\r\n"));
 162         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 163 }
 164
 165 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 166 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 167 {
 168         USB_Disable();
 169
 170         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 171                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 172
 173         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 174         for(;;);
 175 }
 176
 177 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 178  *  enumerating an attached USB device.
 179  */
 180 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 181                                             const uint8_t SubErrorCode)
 182 {
 183         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 184                                  " -- Error Code %d\r\n"
 185                                  " -- Sub Error Code %d\r\n"
 186                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 187
 188         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 189 }
 190
 191 /** Task to manage an enumerated USB printer once connected, to display device
 192  *  information and print a test PCL page.
 193  */
 194 void PrinterHost_Task(void)
 195 {
 196         if (USB_HostState != HOST_STATE_Configured)
 197           return;
 198
 199         uint8_t ErrorCode;
 200
 201         /* Indicate device busy via the status LEDs */
 202         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 203
 204         char  TestPageData[]    = "\033%-12345X\033E" "LUFA PCL Test Page" "\033E\033%-12345X";
 205         uint16_t TestPageLength = strlen(TestPageData);
 206
 207         printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageLength);
 208
 209         /* Send the test page to the attached printer */
 210         if ((ErrorCode = Printer_SendData(&TestPageData, TestPageLength)) != PIPE_RWSTREAM_NoError)
 211         {
 212                 printf_P(PSTR(ESC_FG_RED "Error Sending Test Page.\r\n"
 213                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 214
 215                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 216                 USB_Host_SetDeviceConfiguration(0);
 217                 return;
 218         }
 219
 220         puts_P(PSTR("Test Page Sent.\r\n"));
 221
 222         /* Indicate device no longer busy */
 223         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 224         USB_Host_SetDeviceConfiguration(0);
 225 }
 226