Update Studio Integration DLL, to include package logging.
[pub/USBasp.git] / Demos / Host / LowLevel / PrinterHost / Lib / PrinterCommands.c
index cb051cd..cbca613 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Printer Device commands, to send/recieve data to and from an attached USB\r
- *  printer, and to send and receive Printer Class control requests.\r
- */\r
-\r
-#include "PrinterCommands.h"\r
-\r
-/** Sends the given data directly to the printer via the data endpoints, for the sending of print commands in printer\r
- *  languages accepted by the attached printer (e.g. PCL).\r
- *\r
- *  \param[in] PrinterCommands  Pointer to a structure containing the commands and length of the data to send\r
- *\r
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-uint8_t Printer_SendData(Printer_Data_t* PrinterCommands)\r
-{\r
-       uint8_t ErrorCode;\r
-\r
-       Pipe_SelectPipe(PRINTER_DATA_OUT_PIPE);\r
-       Pipe_Unfreeze();\r
-       \r
-       if ((ErrorCode = Pipe_Write_Stream_LE(PrinterCommands->Data, PrinterCommands->Length)) != PIPE_RWSTREAM_NoError)\r
-         return ErrorCode;\r
-\r
-       Pipe_ClearOUT();\r
-       while (!(Pipe_IsOUTReady()))\r
-       {\r
-               if (USB_HostState == HOST_STATE_Unattached)\r
-                 return PIPE_RWSTREAM_DeviceDisconnected;\r
-       }\r
-       \r
-       Pipe_Freeze();\r
-\r
-       return PIPE_RWSTREAM_NoError;\r
-}\r
-\r
-/** Issues a Printer class Get Device ID command to the attached device, to retrieve the device ID string (which indicates\r
- *  the accepted printer languages, the printer's model and other pertinent information).\r
- *\r
- *  \param[out] DeviceIDString Pointer to the destination where the returned string should be stored\r
- *  \param[in] BufferSize  Size in bytes of the allocated buffer for the returned Device ID string\r
- *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
- */\r
-uint8_t Printer_GetDeviceID(char* DeviceIDString, uint16_t BufferSize)\r
-{\r
-       uint8_t  ErrorCode = HOST_SENDCONTROL_Successful;\r
-       uint16_t DeviceIDStringLength;\r
-\r
-       USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                       bRequest:      GET_DEVICE_ID,\r
-                       wValue:        0,\r
-                       wIndex:        0,\r
-                       wLength:       sizeof(DeviceIDStringLength),\r
-               };\r
-               \r
-       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-       if ((ErrorCode = USB_Host_SendControlRequest(&DeviceIDStringLength)) != HOST_SENDCONTROL_Successful)\r
-         return ErrorCode;\r
-       \r
-       DeviceIDStringLength = SwapEndian_16(DeviceIDStringLength);\r
-\r
-       if (DeviceIDStringLength > BufferSize)\r
-         DeviceIDStringLength = BufferSize;\r
-\r
-       USB_ControlRequest.wLength = DeviceIDStringLength;\r
-       \r
-       if ((ErrorCode = USB_Host_SendControlRequest(DeviceIDString)) != HOST_SENDCONTROL_Successful)\r
-         return ErrorCode;\r
-         \r
-       /* Move string back two characters to remove the string length value from the start of the array */\r
-       memmove(&DeviceIDString[0], &DeviceIDString[2], DeviceIDStringLength - 2);\r
-\r
-       DeviceIDString[DeviceIDStringLength - 2] = 0x00;\r
-       \r
-       return HOST_SENDCONTROL_Successful;\r
-}\r
-\r
-/** Issues a Printer class Get Port Status command to the attached device, to retrieve the current status flags of the\r
- *  printer.\r
- *\r
- *  \param[out] PortStatus  Pointer to the destination where the printer's status flag values should be stored\r
- *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
- */\r
-uint8_t Printer_GetPortStatus(uint8_t* PortStatus)\r
-{\r
-       USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                       bRequest:      GET_PORT_STATUS,\r
-                       wValue:        0,\r
-                       wIndex:        0,\r
-                       wLength:       sizeof(uint8_t),\r
-               };\r
-\r
-       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-       return USB_Host_SendControlRequest(PortStatus);\r
-}\r
-\r
-/** Issues a Printer class Soft Reset command to the attached device, to reset the printer ready for new input without\r
- *  physically cycling the printer's power.\r
- *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
- */\r
-uint8_t Printer_SoftReset(void)\r
-{\r
-       USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                       bRequest:      SOFT_RESET,\r
-                       wValue:        0,\r
-                       wIndex:        0,\r
-                       wLength:       0,\r
-               };\r
-\r
-       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-       return USB_Host_SendControlRequest(NULL);\r
-}\r
-\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2015.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2015  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  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
+  software without specific, written prior permission.
+
+  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
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Printer Device commands, to send/receive data to and from an attached USB
+ *  printer, and to send and receive Printer Class control requests.
+ */
+
+#include "PrinterCommands.h"
+
+/** Sends the given data directly to the printer via the data endpoints, for the sending of print commands in printer
+ *  languages accepted by the attached printer (e.g. PCL).
+ *
+ *  \param[in] PrinterCommands  Pointer to the data to send to the attached printer
+ *  \param[in] CommandSize  Size of the data to send to the attached printer
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+uint8_t Printer_SendData(const void* const PrinterCommands,
+                         const uint16_t CommandSize)
+{
+       uint8_t ErrorCode;
+
+       Pipe_SelectPipe(PRINTER_DATA_OUT_PIPE);
+       Pipe_Unfreeze();
+
+       if ((ErrorCode = Pipe_Write_Stream_LE(PrinterCommands, CommandSize, NULL)) != PIPE_RWSTREAM_NoError)
+         return ErrorCode;
+
+       Pipe_ClearOUT();
+
+       Pipe_WaitUntilReady();
+
+       Pipe_Freeze();
+
+       return PIPE_RWSTREAM_NoError;
+}
+
+/** Issues a Printer class Get Device ID command to the attached device, to retrieve the device ID string (which indicates
+ *  the accepted printer languages, the printer's model and other pertinent information).
+ *
+ *  \param[out] DeviceIDString Pointer to the destination where the returned string should be stored
+ *  \param[in] BufferSize  Size in bytes of the allocated buffer for the returned Device ID string
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
+uint8_t Printer_GetDeviceID(char* DeviceIDString,
+                            const uint16_t BufferSize)
+{
+       uint8_t  ErrorCode;
+       uint16_t DeviceIDStringLength = 0;
+
+       USB_ControlRequest = (USB_Request_Header_t)
+               {
+                       .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
+                       .bRequest      = PRNT_REQ_GetDeviceID,
+                       .wValue        = 0,
+                       .wIndex        = PrinterInterfaceNumber,
+                       .wLength       = sizeof(DeviceIDStringLength),
+               };
+
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+       if ((ErrorCode = USB_Host_SendControlRequest(&DeviceIDStringLength)) != HOST_SENDCONTROL_Successful)
+         return ErrorCode;
+
+       if (!(DeviceIDStringLength))
+       {
+               DeviceIDString[0] = 0x00;
+               return HOST_SENDCONTROL_Successful;
+       }
+
+       DeviceIDStringLength = SwapEndian_16(DeviceIDStringLength);
+
+       if (DeviceIDStringLength > BufferSize)
+         DeviceIDStringLength = BufferSize;
+
+       USB_ControlRequest.wLength = DeviceIDStringLength;
+
+       if ((ErrorCode = USB_Host_SendControlRequest(DeviceIDString)) != HOST_SENDCONTROL_Successful)
+         return ErrorCode;
+
+       /* Move string back two characters to remove the string length value from the start of the array */
+       memmove(&DeviceIDString[0], &DeviceIDString[2], DeviceIDStringLength - 2);
+
+       DeviceIDString[DeviceIDStringLength - 2] = 0x00;
+
+       return HOST_SENDCONTROL_Successful;
+}
+
+/** Issues a Printer class Get Port Status command to the attached device, to retrieve the current status flags of the
+ *  printer.
+ *
+ *  \param[out] PortStatus  Pointer to the destination where the printer's status flag values should be stored
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
+uint8_t Printer_GetPortStatus(uint8_t* const PortStatus)
+{
+       USB_ControlRequest = (USB_Request_Header_t)
+               {
+                       .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
+                       .bRequest      = PRNT_REQ_GetPortStatus,
+                       .wValue        = 0,
+                       .wIndex        = PrinterInterfaceNumber,
+                       .wLength       = sizeof(uint8_t),
+               };
+
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+       return USB_Host_SendControlRequest(PortStatus);
+}
+
+/** Issues a Printer class Soft Reset command to the attached device, to reset the printer ready for new input without
+ *  physically cycling the printer's power.
+ *
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum
+ */
+uint8_t Printer_SoftReset(void)
+{
+       USB_ControlRequest = (USB_Request_Header_t)
+               {
+                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
+                       .bRequest      = PRNT_REQ_SoftReset,
+                       .wValue        = 0,
+                       .wIndex        = PrinterInterfaceNumber,
+                       .wLength       = 0,
+               };
+
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+       return USB_Host_SendControlRequest(NULL);
+}
+