Demos/Host/LowLevel/PrinterHost/Lib/PrinterCommands.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  *  Printer Device commands, to send/recieve 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 a structure containing the commands and length of the data to send
  43  *
  44  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
  45  */
  46 uint8_t Printer_SendData(Printer_Data_t* PrinterCommands)
  47 {
  48         uint8_t ErrorCode;
  49
  50         Pipe_SelectPipe(PRINTER_DATA_OUT_PIPE);
  51         Pipe_Unfreeze();
  52
  53         if ((ErrorCode = Pipe_Write_Stream_LE(PrinterCommands->Data, PrinterCommands->Length)) != PIPE_RWSTREAM_NoError)
  54           return ErrorCode;
  55
  56         Pipe_ClearOUT();
  57         while (!(Pipe_IsOUTReady()));
  58
  59         Pipe_Freeze();
  60
  61         return PIPE_RWSTREAM_NoError;
  62 }
  63
  64 /** Issues a Printer class Get Device ID command to the attached device, to retrieve the device ID string (which indicates
  65  *  the accepted printer languages, the printer's model and other pertinent information).
  66  *
  67  *  \param[out] DeviceIDString Pointer to the destination where the returned string should be stored
  68  *  \param[in] BufferSize  Size in bytes of the allocated buffer for the returned Device ID string
  69  *
  70  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
  71  */
  72 uint8_t Printer_GetDeviceID(char* DeviceIDString, uint16_t BufferSize)
  73 {
  74         uint8_t  ErrorCode = HOST_SENDCONTROL_Successful;
  75         uint16_t DeviceIDStringLength;
  76
  77         USB_ControlRequest = (USB_Request_Header_t)
  78                 {
  79                         bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
  80                         bRequest:      GET_DEVICE_ID,
  81                         wValue:        0,
  82                         wIndex:        0,
  83                         wLength:       sizeof(DeviceIDStringLength),
  84                 };
  85
  86         if ((ErrorCode = USB_Host_SendControlRequest(&DeviceIDStringLength)) != HOST_SENDCONTROL_Successful)
  87           return ErrorCode;
  88
  89         DeviceIDStringLength = SwapEndian_16(DeviceIDStringLength);
  90
  91         if (DeviceIDStringLength > BufferSize)
  92           DeviceIDStringLength = BufferSize;
  93
  94         USB_ControlRequest.wLength = DeviceIDStringLength;
  95
  96         if ((ErrorCode = USB_Host_SendControlRequest(DeviceIDString)) != HOST_SENDCONTROL_Successful)
  97           return ErrorCode;
  98
  99         /* Move string back two characters to remove the string length value from the start of the array */
 100         memmove(&DeviceIDString[0], &DeviceIDString[2], DeviceIDStringLength - 2);
 101
 102         DeviceIDString[DeviceIDStringLength - 2] = 0x00;
 103
 104         return HOST_SENDCONTROL_Successful;
 105 }
 106
 107 /** Issues a Printer class Get Port Status command to the attached device, to retrieve the current status flags of the
 108  *  printer.
 109  *
 110  *  \param[out] PortStatus  Pointer to the destination where the printer's status flag values should be stored
 111  *
 112  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
 113  */
 114 uint8_t Printer_GetPortStatus(uint8_t* PortStatus)
 115 {
 116         USB_ControlRequest = (USB_Request_Header_t)
 117                 {
 118                         bmRequestType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 119                         bRequest:      GET_PORT_STATUS,
 120                         wValue:        0,
 121                         wIndex:        0,
 122                         wLength:       sizeof(uint8_t),
 123                 };
 124
 125         return USB_Host_SendControlRequest(PortStatus);
 126 }
 127
 128 /** Issues a Printer class Soft Reset command to the attached device, to reset the printer ready for new input without
 129  *  physically cycling the printer's power.
 130  *
 131  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
 132  */
 133 uint8_t Printer_SoftReset(void)
 134 {
 135         USB_ControlRequest = (USB_Request_Header_t)
 136                 {
 137                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 138                         bRequest:      SOFT_RESET,
 139                         wValue:        0,
 140                         wIndex:        0,
 141                         wLength:       0,
 142                 };
 143
 144         return USB_Host_SendControlRequest(NULL);
 145 }
 146