Added extra DoxyGen documentation to the new PrinterHost demo.
[pub/USBasp.git] / Demos / Host / LowLevel / PrinterHost / PrinterHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 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 * starts the scheduler to run the application tasks.
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
50 for (;;)
51 {
52 USB_Printer_Host();
53 USB_USBTask();
54 }
55 }
56
57 /** Configures the board hardware and chip peripherals for the demo's functionality. */
58 void SetupHardware(void)
59 {
60 /* Disable watchdog if enabled by bootloader/fuses */
61 MCUSR &= ~(1 << WDRF);
62 wdt_disable();
63
64 /* Disable clock division */
65 clock_prescale_set(clock_div_1);
66
67 /* Hardware Initialization */
68 SerialStream_Init(9600, false);
69 LEDs_Init();
70 USB_Init();
71 }
72
73 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
74 * starts the library USB task to begin the enumeration and USB management process.
75 */
76 void EVENT_USB_DeviceAttached(void)
77 {
78 puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
79 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
80 }
81
82 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
83 * stops the library USB task management process.
84 */
85 void EVENT_USB_DeviceUnattached(void)
86 {
87 puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
88 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
89 }
90
91 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
92 * enumerated by the host and is now ready to be used by the application.
93 */
94 void EVENT_USB_DeviceEnumerationComplete(void)
95 {
96 LEDs_SetAllLEDs(LEDMASK_USB_READY);
97 }
98
99 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
100 void EVENT_USB_HostError(uint8_t ErrorCode)
101 {
102 USB_ShutDown();
103
104 puts_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"));
105 printf_P(PSTR(" -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
106
107 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
108 for(;;);
109 }
110
111 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
112 * enumerating an attached USB device.
113 */
114 void EVENT_USB_DeviceEnumerationFailed(uint8_t ErrorCode, uint8_t SubErrorCode)
115 {
116 puts_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"));
117 printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
118 printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
119 printf_P(PSTR(" -- In State %d\r\n" ESC_FG_WHITE), USB_HostState);
120
121 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
122 }
123
124 /** Task to set the configuration of the attached device after it has been enumerated, and to send some test page
125 * data to the attached printer.
126 */
127 void USB_Printer_Host(void)
128 {
129 uint8_t ErrorCode;
130
131 switch (USB_HostState)
132 {
133 case HOST_STATE_Addressed:
134 puts_P(PSTR("Getting Config Data.\r\n"));
135
136 /* Select the control pipe for the request transfer */
137 Pipe_SelectPipe(PIPE_CONTROLPIPE);
138
139 /* Get and process the configuration descriptor data */
140 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
141 {
142 if (ErrorCode == ControlError)
143 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
144 else
145 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
146
147 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
148
149 /* Indicate error via status LEDs */
150 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
151
152 /* Wait until USB device disconnected */
153 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
154 break;
155 }
156
157 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
158 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
159 {
160 puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
161 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
162
163 /* Indicate error via status LEDs */
164 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
165
166 /* Wait until USB device disconnected */
167 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
168 break;
169 }
170
171 /* Some printers use alternate settings to determine the communication protocol used - if so, send a SetInterface
172 * request to switch to the interface alternate setting with the Bidirectional protocol */
173 if (PrinterAltSetting)
174 {
175 USB_ControlRequest = (USB_Request_Header_t)
176 {
177 bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_INTERFACE),
178 bRequest: REQ_SetInterface,
179 wValue: PrinterAltSetting,
180 wIndex: PrinterInterfaceNumber,
181 wLength: 0,
182 };
183
184 if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
185 {
186 puts_P(PSTR(ESC_FG_RED "Control Error (Set Interface).\r\n"));
187 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
188
189 /* Indicate error via status LEDs */
190 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
191
192 /* Wait until USB device disconnected */
193 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
194 break;
195 }
196 }
197
198 USB_HostState = HOST_STATE_Configured;
199 break;
200 case HOST_STATE_Configured:
201 puts_P(PSTR("Retrieving Device ID...\r\n"));
202
203 char DeviceIDString[256];
204 if ((ErrorCode = Printer_GetDeviceID(DeviceIDString, sizeof(DeviceIDString))) != HOST_SENDCONTROL_Successful)
205 {
206 puts_P(PSTR(ESC_FG_RED "Control Error (Get DeviceID).\r\n"));
207 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
208
209 /* Indicate error via status LEDs */
210 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
211
212 /* Wait until USB device disconnected */
213 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
214 break;
215 }
216
217 printf_P(PSTR("Printer Device ID: %s\r\n"), DeviceIDString);
218
219 puts_P(PSTR("Printer Enumerated.\r\n"));
220
221 USB_HostState = HOST_STATE_Ready;
222 break;
223 case HOST_STATE_Ready:
224 /* Indicate device busy via the status LEDs */
225 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
226
227 Printer_Data_t TestPageData =
228 {
229 // "\033%-12345X\033E LUFA PCL Test Page \033E\033%-12345X",
230 "\033@\033i\001\033X\001\060\000\r\nLUFA ESCP/2 Test Page\r\n",
231 (sizeof(TestPageData.Data) - 1)
232 };
233
234 printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageData.Length);
235
236 if ((ErrorCode = Printer_SendData(&TestPageData)) != PIPE_RWSTREAM_NoError)
237 {
238 puts_P(PSTR(ESC_FG_RED "Error Sending Test Page.\r\n"));
239 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
240
241 /* Indicate error via status LEDs */
242 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
243
244 /* Wait until USB device disconnected */
245 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
246 break;
247 }
248
249 puts_P(PSTR("Test Page Sent.\r\n"));
250
251 /* Indicate device no longer busy */
252 LEDs_SetAllLEDs(LEDMASK_USB_READY);
253
254 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
255 break;
256 }
257 }