Minor documentation improvements.

[pub/USBasp.git] / Demos / Host / LowLevel / PrinterHost / PrinterHost.c

diff --git a/Demos/Host/LowLevel/PrinterHost/PrinterHost.c b/Demos/Host/LowLevel/PrinterHost/PrinterHost.c
index b6f3efa..31b0145 100644 (file)
--- a/Demos/Host/LowLevel/PrinterHost/PrinterHost.c
+++ b/Demos/Host/LowLevel/PrinterHost/PrinterHost.c
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2013.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -43,14 +43,15 @@ int main(void)
 {
        SetupHardware();
 
 {
        SetupHardware();
 

+       puts_P(PSTR(ESC_FG_CYAN "Printer Host Demo running.\r\n" ESC_FG_WHITE));
+

        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);

+       GlobalInterruptEnable();

 
 

-       puts_P(PSTR(ESC_FG_CYAN "Printer Host Demo running.\r\n" ESC_FG_WHITE));
-       sei();
-       

        for (;;)
        {
        for (;;)
        {

-               USB_Printer_Host();
+               PrinterHost_Task();
+

                USB_USBTask();
        }
 }
                USB_USBTask();
        }
 }


@@ -66,9 +67,12 @@ void SetupHardware(void)
        clock_prescale_set(clock_div_1);
 
        /* Hardware Initialization */
        clock_prescale_set(clock_div_1);
 
        /* Hardware Initialization */

-       SerialStream_Init(9600, false);
+       Serial_Init(9600, false);

        LEDs_Init();
        USB_Init();
        LEDs_Init();
        USB_Init();

+
+       /* Create a stdio stream for the serial port for stdin and stdout */
+       Serial_CreateStream(NULL);

 }
 
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 }
 
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and


@@ -94,13 +98,72 @@ void EVENT_USB_Host_DeviceUnattached(void)
  */
 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 {
  */
 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 {

+       puts_P(PSTR("Getting Config Data.\r\n"));
+
+       uint8_t ErrorCode;
+
+       /* Get and process the configuration descriptor data */
+       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
+       {
+               if (ErrorCode == ControlError)
+                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
+               else
+                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
+
+               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
+
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               return;
+       }
+
+       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
+       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
+       {
+               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
+                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               return;
+       }
+
+       /* Some printers use alternate settings to determine the communication protocol used - if so, send a SetInterface
+        * request to switch to the interface alternate setting with the Bidirectional protocol */
+       if (PrinterAltSetting)
+       {
+               if ((ErrorCode = USB_Host_SetInterfaceAltSetting(PrinterInterfaceNumber, PrinterAltSetting)) != HOST_SENDCONTROL_Successful)
+               {
+                       printf_P(PSTR(ESC_FG_RED "Control Error (Set Interface).\r\n"
+                                                " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+                       USB_Host_SetDeviceConfiguration(0);
+                       return;
+               }
+       }
+
+       puts_P(PSTR("Retrieving Device ID...\r\n"));
+
+       char DeviceIDString[300];
+       if ((ErrorCode = Printer_GetDeviceID(DeviceIDString, sizeof(DeviceIDString))) != HOST_SENDCONTROL_Successful)
+       {
+               printf_P(PSTR(ESC_FG_RED "Control Error (Get Device ID).\r\n"
+                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               USB_Host_SetDeviceConfiguration(0);
+               return;
+       }
+
+       printf_P(PSTR("Printer Device ID: %s\r\n"), DeviceIDString);
+
+       puts_P(PSTR("Printer Enumerated.\r\n"));

        LEDs_SetAllLEDs(LEDMASK_USB_READY);
 }
 
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
        LEDs_SetAllLEDs(LEDMASK_USB_READY);
 }
 
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */

-void EVENT_USB_Host_HostError(uint8_t ErrorCode)
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)

 {
 {

-       USB_ShutDown();
+       USB_Disable();

 
        printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
                                 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 
        printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
                                 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);


@@ -112,7 +175,8 @@ void EVENT_USB_Host_HostError(uint8_t ErrorCode)
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
  *  enumerating an attached USB device.
  */
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
  *  enumerating an attached USB device.
  */

-void EVENT_USB_Host_DeviceEnumerationFailed(uint8_t ErrorCode, uint8_t SubErrorCode)
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
+                                            const uint8_t SubErrorCode)

 {
        printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
                                 " -- Error Code %d\r\n"
 {
        printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
                                 " -- Error Code %d\r\n"


@@ -122,130 +186,39 @@ void EVENT_USB_Host_DeviceEnumerationFailed(uint8_t ErrorCode, uint8_t SubErrorC
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 }
 
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 }
 

-/** Task to set the configuration of the attached device after it has been enumerated, and to send some test page
- *  data to the attached printer.
+/** Task to manage an enumerated USB printer once connected, to display device
+ *  information and print a test PCL page.

  */
  */

-void USB_Printer_Host(void)
+void PrinterHost_Task(void)

 {
 {

+       if (USB_HostState != HOST_STATE_Configured)
+         return;
+

        uint8_t ErrorCode;
 
        uint8_t ErrorCode;
 

-       switch (USB_HostState)
+       /* Indicate device busy via the status LEDs */
+       LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
+
+       char  TestPageData[]    = "\033%-12345X\033E" "LUFA PCL Test Page" "\033E\033%-12345X";
+       uint16_t TestPageLength = strlen(TestPageData);
+
+       printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageLength);
+
+       /* Send the test page to the attached printer */
+       if ((ErrorCode = Printer_SendData(&TestPageData, TestPageLength)) != PIPE_RWSTREAM_NoError)

        {
        {

-               case HOST_STATE_Addressed:
-                       puts_P(PSTR("Getting Config Data.\r\n"));
-                       
-                       /* Select the control pipe for the request transfer */
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);                      
-               
-                       /* Get and process the configuration descriptor data */
-                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
-                       {
-                               if (ErrorCode == ControlError)
-                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
-                               else
-                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
-
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
-                               
-                               /* Indicate error via status LEDs */
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-                               /* Wait until USB device disconnected */
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                               break;
-                       }
-                               
-                       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
-                       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
-                       {
-                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
-                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
-
-                               /* Indicate error via status LEDs */
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-                               /* Wait until USB device disconnected */
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                               break;
-                       }
-                       
-                       /* Some printers use alternate settings to determine the communication protocol used - if so, send a SetInterface
-                        * request to switch to the interface alternate setting with the Bidirectional protocol */
-                       if (PrinterAltSetting)
-                       {
-                               USB_ControlRequest = (USB_Request_Header_t)
-                                       {
-                                               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_INTERFACE),
-                                               .bRequest      = REQ_SetInterface,
-                                               .wValue        = PrinterAltSetting,
-                                               .wIndex        = PrinterInterfaceNumber,
-                                               .wLength       = 0,
-                                       };
-                                       
-                               if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
-                               {
-                                       printf_P(PSTR(ESC_FG_RED "Control Error (Set Interface).\r\n"
-                                                                " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
-
-                                       /* Indicate error via status LEDs */
-                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-                                       /* Wait until USB device disconnected */
-                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                                       break;                                  
-                               }
-                       }
-                       
-                       puts_P(PSTR("Retrieving Device ID...\r\n"));
-               
-                       char DeviceIDString[300];
-                       if ((ErrorCode = Printer_GetDeviceID(DeviceIDString, sizeof(DeviceIDString))) != HOST_SENDCONTROL_Successful)
-                       {
-                               printf_P(PSTR(ESC_FG_RED "Control Error (Get Device ID).\r\n"
-                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
-
-                               /* Indicate error via status LEDs */
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-                               /* Wait until USB device disconnected */
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                               break;
-                       }
-
-                       printf_P(PSTR("Printer Device ID: %s\r\n"), DeviceIDString);
-
-                       puts_P(PSTR("Printer Enumerated.\r\n"));
-
-                       USB_HostState = HOST_STATE_Configured;
-                       break;
-               case HOST_STATE_Configured:
-                       /* Indicate device busy via the status LEDs */
-                       LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
-               
-                       char  TestPageData[]    = "\033%-12345X\033E" "LUFA PCL Test Page" "\033E\033%-12345X";
-                       uint16_t TestPageLength = strlen(TestPageData);
-               
-                       printf_P(PSTR("Sending Test Page (%d bytes)...\r\n"), TestPageLength);
-
-                       if ((ErrorCode = Printer_SendData(&TestPageData, TestPageLength)) != PIPE_RWSTREAM_NoError)
-                       {
-                               printf_P(PSTR(ESC_FG_RED "Error Sending Test Page.\r\n"
-                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
-
-                               /* Indicate error via status LEDs */
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-
-                               /* Wait until USB device disconnected */
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                               break;
-                       }
-
-                       puts_P(PSTR("Test Page Sent.\r\n"));
-               
-                       /* Indicate device no longer busy */
-                       LEDs_SetAllLEDs(LEDMASK_USB_READY);
-
-                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                       break;
+               printf_P(PSTR(ESC_FG_RED "Error Sending Test Page.\r\n"
+                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               USB_Host_SetDeviceConfiguration(0);
+               return;

        }
        }

+
+       puts_P(PSTR("Test Page Sent.\r\n"));
+
+       /* Indicate device no longer busy */
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);
+       USB_Host_SetDeviceConfiguration(0);

 }
 }

+