Merge commit '60b30c0363' as 'lib/lufa'

2017-07-07 11:55:23 -04:00 · 2017-07-07 11:55:23 -04:00 · 8655d4f494
commit 8655d4f494
parent 1896c76a29 60b30c0363
1455 changed files with 394541 additions and 0 deletions
--- a/lib/lufa/Demos/Host/LowLevel/PrinterHost/Lib/PrinterCommands.c
+++ b/lib/lufa/Demos/Host/LowLevel/PrinterHost/Lib/PrinterCommands.c
@ -0,0 +1,162 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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);
+}
+