Demos/Host/ClassDriver/PrinterHost/PrinterHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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 /** LUFA Printer Class driver interface configuration and state information. This structure is
  40  *  passed to all Printer Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_PRNT_Host_t Printer_PRNT_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                         },
  58         };
  59
  60
  61 /** Main program entry point. This routine configures the hardware required by the application, then
  62  *  enters a loop to run the application tasks in sequence.
  63  */
  64 int main(void)
  65 {
  66         SetupHardware();
  67
  68         puts_P(PSTR(ESC_FG_CYAN "Printer Host Demo running.\r\n" ESC_FG_WHITE));
  69
  70         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  71         GlobalInterruptEnable();
  72
  73         for (;;)
  74         {
  75                 PrinterHost_Task();
  76
  77                 PRNT_Host_USBTask(&Printer_PRNT_Interface);
  78                 USB_USBTask();
  79         }
  80 }
  81
  82 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  83 void SetupHardware(void)
  84 {
  85 #if (ARCH == ARCH_AVR8)
  86         /* Disable watchdog if enabled by bootloader/fuses */
  87         MCUSR &= ~(1 << WDRF);
  88         wdt_disable();
  89
  90         /* Disable clock division */
  91         clock_prescale_set(clock_div_1);
  92 #endif
  93
  94         /* Hardware Initialization */
  95         Serial_Init(9600, false);
  96         LEDs_Init();
  97         USB_Init();
  98
  99         /* Create a stdio stream for the serial port for stdin and stdout */
 100         Serial_CreateStream(NULL);
 101 }
 102
 103 /** Task to manage an enumerated USB printer once connected, to display device
 104  *  information and print a test PCL page.
 105  */
 106 void PrinterHost_Task(void)
 107 {
 108         if (USB_HostState != HOST_STATE_Configured)
 109           return;
 110
 111         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 112
 113         puts_P(PSTR("Retrieving Device ID...\r\n"));
 114
 115         char DeviceIDString[300];
 116         if (PRNT_Host_GetDeviceID(&Printer_PRNT_Interface, DeviceIDString,
 117                                   sizeof(DeviceIDString)) != HOST_SENDCONTROL_Successful)
 118         {
 119                 puts_P(PSTR("Error Getting Device ID.\r\n"));
 120                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 121                 USB_Host_SetDeviceConfiguration(0);
 122                 return;
 123         }
 124
 125         printf_P(PSTR("Device ID: %s.\r\n"), DeviceIDString);
 126
 127         char     TestPageData[] = "\033%-12345X\033E" "LUFA PCL Test Page" "\033E\033%-12345X";
 128         uint16_t TestPageLength = strlen(TestPageData);
 129
 130         printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageLength);
 131
 132         if (PRNT_Host_SendData(&Printer_PRNT_Interface, &TestPageData, TestPageLength) != PIPE_RWSTREAM_NoError)
 133         {
 134                 puts_P(PSTR("Error Sending Page Data.\r\n"));
 135                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 136                 USB_Host_SetDeviceConfiguration(0);
 137                 return;
 138         }
 139
 140         puts_P(PSTR("Test Page Sent.\r\n"));
 141
 142         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 143         USB_Host_SetDeviceConfiguration(0);
 144 }
 145
 146 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 147  *  starts the library USB task to begin the enumeration and USB management process.
 148  */
 149 void EVENT_USB_Host_DeviceAttached(void)
 150 {
 151         puts_P(PSTR("Device Attached.\r\n"));
 152         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 153 }
 154
 155 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 156  *  stops the library USB task management process.
 157  */
 158 void EVENT_USB_Host_DeviceUnattached(void)
 159 {
 160         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 161         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 162 }
 163
 164 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 165  *  enumerated by the host and is now ready to be used by the application.
 166  */
 167 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 168 {
 169         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 170
 171         uint16_t ConfigDescriptorSize;
 172         uint8_t  ConfigDescriptorData[512];
 173
 174         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 175                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 176         {
 177                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 178                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 179                 return;
 180         }
 181
 182         if (PRNT_Host_ConfigurePipes(&Printer_PRNT_Interface,
 183                                      ConfigDescriptorSize, ConfigDescriptorData) != PRNT_ENUMERROR_NoError)
 184         {
 185                 puts_P(PSTR("Attached Device Not a Valid Printer Class Device.\r\n"));
 186                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187                 return;
 188         }
 189
 190         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 191         {
 192                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 193                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 194                 return;
 195         }
 196
 197         if (PRNT_Host_SetBidirectionalMode(&Printer_PRNT_Interface) != HOST_SENDCONTROL_Successful)
 198         {
 199                 puts_P(PSTR("Error Setting Bidirectional Mode.\r\n"));
 200                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 201                 USB_Host_SetDeviceConfiguration(0);
 202                 return;
 203         }
 204
 205         puts_P(PSTR("Printer Device Enumerated.\r\n"));
 206         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 207 }
 208
 209 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 210 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 211 {
 212         USB_Disable();
 213
 214         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 215                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 216
 217         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 218         for(;;);
 219 }
 220
 221 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 222  *  enumerating an attached USB device.
 223  */
 224 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 225                                             const uint8_t SubErrorCode)
 226 {
 227         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 228                                  " -- Error Code %d\r\n"
 229                                  " -- Sub Error Code %d\r\n"
 230                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 231
 232         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 233 }
 234