Demos/Host/LowLevel/PrinterHost/Lib/PrinterCommands.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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  *  Printer Device commands, to send/receive data to and from an attached USB
  34  *  printer, and to send and receive Printer Class control requests.
  35  */
  36
  37 #include "PrinterCommands.h"
  38
  39 /** Sends the given data directly to the printer via the data endpoints, for the sending of print commands in printer
  40  *  languages accepted by the attached printer (e.g. PCL).
  41  *
  42  *  \param[in] PrinterCommands  Pointer to the data to send to the attached printer
  43  *  \param[in] CommandSize  Size of the data to send to the attached printer
  44  *
  45  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
  46  */
  47 uint8_t Printer_SendData(const void* const PrinterCommands,
  48                          const uint16_t CommandSize)
  49 {
  50         uint8_t ErrorCode;
  51
  52         Pipe_SelectPipe(PRINTER_DATA_OUT_PIPE);
  53         Pipe_Unfreeze();
  54
  55         if ((ErrorCode = Pipe_Write_Stream_LE(PrinterCommands, CommandSize)) != PIPE_RWSTREAM_NoError)
  56           return ErrorCode;
  57
  58         Pipe_ClearOUT();
  59         while (!(Pipe_IsOUTReady()))
  60         {
  61                 if (USB_HostState == HOST_STATE_Unattached)
  62                   return PIPE_RWSTREAM_DeviceDisconnected;
  63         }
  64
  65         Pipe_Freeze();
  66
  67         return PIPE_RWSTREAM_NoError;
  68 }
  69
  70 /** Issues a Printer class Get Device ID command to the attached device, to retrieve the device ID string (which indicates
  71  *  the accepted printer languages, the printer's model and other pertinent information).
  72  *
  73  *  \param[out] DeviceIDString Pointer to the destination where the returned string should be stored
  74  *  \param[in] BufferSize  Size in bytes of the allocated buffer for the returned Device ID string
  75  *
  76  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
  77  */
  78 uint8_t Printer_GetDeviceID(char* DeviceIDString,
  79                             const uint16_t BufferSize)
  80 {
  81         uint8_t  ErrorCode = HOST_SENDCONTROL_Successful;
  82         uint16_t DeviceIDStringLength = 0;
  83
  84         USB_ControlRequest = (USB_Request_Header_t)
  85                 {
  86                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
  87                         .bRequest      = REQ_GetDeviceID,
  88                         .wValue        = 0,
  89                         .wIndex        = 0,
  90                         .wLength       = sizeof(DeviceIDStringLength),
  91                 };
  92
  93         Pipe_SelectPipe(PIPE_CONTROLPIPE);
  94
  95         if ((ErrorCode = USB_Host_SendControlRequest(&DeviceIDStringLength)) != HOST_SENDCONTROL_Successful)
  96           return ErrorCode;
  97
  98         if (!(DeviceIDStringLength))
  99         {
 100                 DeviceIDString[0] = 0x00;
 101                 return HOST_SENDCONTROL_Successful;
 102         }
 103
 104         DeviceIDStringLength = SwapEndian_16(DeviceIDStringLength);
 105
 106         if (DeviceIDStringLength > BufferSize)
 107           DeviceIDStringLength = BufferSize;
 108
 109         USB_ControlRequest.wLength = DeviceIDStringLength;
 110
 111         if ((ErrorCode = USB_Host_SendControlRequest(DeviceIDString)) != HOST_SENDCONTROL_Successful)
 112           return ErrorCode;
 113
 114         /* Move string back two characters to remove the string length value from the start of the array */
 115         memmove(&DeviceIDString[0], &DeviceIDString[2], DeviceIDStringLength - 2);
 116
 117         DeviceIDString[DeviceIDStringLength - 2] = 0x00;
 118
 119         return HOST_SENDCONTROL_Successful;
 120 }
 121
 122 /** Issues a Printer class Get Port Status command to the attached device, to retrieve the current status flags of the
 123  *  printer.
 124  *
 125  *  \param[out] PortStatus  Pointer to the destination where the printer's status flag values should be stored
 126  *
 127  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
 128  */
 129 uint8_t Printer_GetPortStatus(uint8_t* const PortStatus)
 130 {
 131         USB_ControlRequest = (USB_Request_Header_t)
 132                 {
 133                         bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 134                         bRequest:      REQ_GetPortStatus,
 135                         wValue:        0,
 136                         wIndex:        0,
 137                         wLength:       sizeof(uint8_t),
 138                 };
 139
 140         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 141
 142         return USB_Host_SendControlRequest(PortStatus);
 143 }
 144
 145 /** Issues a Printer class Soft Reset command to the attached device, to reset the printer ready for new input without
 146  *  physically cycling the printer's power.
 147  *
 148  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
 149  */
 150 uint8_t Printer_SoftReset(void)
 151 {
 152         USB_ControlRequest = (USB_Request_Header_t)
 153                 {
 154                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 155                         .bRequest      = REQ_SoftReset,
 156                         .wValue        = 0,
 157                         .wIndex        = 0,
 158                         .wLength       = 0,
 159                 };
 160
 161         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 162
 163         return USB_Host_SendControlRequest(NULL);
 164 }
 165