lib/lufa/LUFA/Drivers/USB/Class/Host/PrinterClassHost.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 disclaims 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  *  \brief Host mode driver for the library USB Printer Class driver.
  33  *
  34  *  Host mode driver for the library USB Printer Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassPrinter
  41  *  \defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver
  42  *
  43  *  \section Sec_USBClassPrinterHost_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_USBClassPrinterHost_ModDescription Module Description
  48  *  Host Mode USB Class driver framework interface, for the Printer USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __PRINTER_CLASS_HOST_H__
  54 #define __PRINTER_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/PrinterClassCommon.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Type Defines: */
  72                         /** \brief Printer Class Host Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made within the user application,
  75                          *  and passed to each of the Printer class driver functions as the \c PRNTInterfaceInfo parameter. This
  76                          *  stores each Printer interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 struct
  81                                 {
  82                                         USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
  83                                         USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */
  84                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  85                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  86                                            */
  87                                 struct
  88                                 {
  89                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  90                                                         *   after \ref PRNT_Host_ConfigurePipes() is called and the Host state machine is in the
  91                                                         *   Configured state.
  92                                                         */
  93                                         uint8_t InterfaceNumber; /**< Interface index of the Printer interface within the attached device. */
  94                                         uint8_t AlternateSetting; /**< Alternate setting within the Printer Interface in the attached device. */
  95                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  96                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  97                                                   *   the interface is enumerated.
  98                                                   */
  99                         } USB_ClassInfo_PRNT_Host_t;
 100
 101                 /* Enums: */
 102                         /** Enum for the possible error codes returned by the \ref PRNT_Host_ConfigurePipes() function. */
 103                         enum PRNT_Host_EnumerationFailure_ErrorCodes_t
 104                         {
 105                                 PRNT_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 106                                 PRNT_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 107                                 PRNT_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Printer interface was not found in the device's Configuration Descriptor. */
 108                                 PRNT_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 109                         };
 110
 111                 /* Function Prototypes: */
 112                         /** Host interface configuration routine, to configure a given Printer host interface instance using the
 113                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer
 114                          *  instance's state values and configures the pipes required to communicate with the interface if it is found within
 115                          *  the device. This should be called once after the stack has enumerated the attached device, while the host state
 116                          *  machine is in the Addressed state.
 117                          *
 118                          *  \param[in,out] PRNTInterfaceInfo     Pointer to a structure containing a Printer Class host configuration and state.
 119                          *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
 120                          *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
 121                          *
 122                          *  \return A value from the \ref PRNT_Host_EnumerationFailure_ErrorCodes_t enum.
 123                          */
 124                         uint8_t PRNT_Host_ConfigurePipes(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 125                                                          uint16_t ConfigDescriptorSize,
 126                                                          void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 127
 128                         /** General management task for a given Printer host class interface, required for the correct operation of
 129                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 130                          *  \ref USB_USBTask().
 131                          *
 132                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 133                          */
 134                         void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 135
 136                         /** Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called
 137                          *  once the connected device's configuration has been set, to ensure the printer is ready to accept commands.
 138                          *
 139                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 140                          *
 141                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 142                          */
 143                         uint8_t PRNT_Host_SetBidirectionalMode(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 144
 145                         /** Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the
 146                          *  \c PRNT_PORTSTATUS_* macros to determine the printer port's status.
 147                          *
 148                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 149                          *  \param[out]    PortStatus         Location where the retrieved port status should be stored.
 150                          *
 151                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 152                          */
 153                         uint8_t PRNT_Host_GetPortStatus(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 154                                                         uint8_t* const PortStatus)
 155                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 156
 157                         /** Soft-resets the attached printer, readying it for new commands.
 158                          *
 159                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 160                          *
 161                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 162                          */
 163                         uint8_t PRNT_Host_SoftReset(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 164
 165                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 166                          *
 167                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 168                          *       call will fail.
 169                          *
 170                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 171                          *
 172                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 173                          */
 174                         uint8_t PRNT_Host_Flush(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 175
 176                         /** Sends the given null terminated string to the attached printer's input endpoint.
 177                          *
 178                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 179                          *       call will fail.
 180                          *
 181                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 182                          *  \param[in]     String             Pointer to a null terminated string to send.
 183                          *
 184                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 185                          */
 186                         uint8_t PRNT_Host_SendString(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 187                                                      const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 188
 189                         /** Sends the given raw data stream to the attached printer's input endpoint. This should contain commands that the
 190                          *  printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see
 191                          *  \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.
 192                          *
 193                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 194                          *       call will fail.
 195                          *
 196                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 197                          *  \param[in]     Buffer             Pointer to a buffer containing the raw command stream to send to the printer.
 198                          *  \param[in]     Length             Size in bytes of the command stream to be sent.
 199                          *
 200                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 201                          */
 202                         uint8_t PRNT_Host_SendData(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 203                                                    const void* Buffer,
 204                                                    const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 205
 206                         /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
 207                          *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 208                          *  \ref PRNT_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 209                          *  packed into a single pipe packet, increasing data throughput.
 210                          *
 211                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 212                          *       call will fail.
 213                          *
 214                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 215                          *  \param[in]     Data               Byte of data to send to the device.
 216                          *
 217                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 218                          */
 219                         uint8_t PRNT_Host_SendByte(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 220                                                    const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 221
 222                         /** Determines the number of bytes received by the printer interface from the device, waiting to be read. This indicates the number
 223                          *  of bytes in the IN pipe bank only, and thus the number of calls to \ref PRNT_Host_ReceiveByte() which are guaranteed to succeed
 224                          *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
 225                          *  released back to the USB controller until all bytes are read.
 226                          *
 227                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 228                          *       call will fail.
 229                          *
 230                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 231                          *
 232                          *  \return Total number of buffered bytes received from the device.
 233                          */
 234                         uint16_t PRNT_Host_BytesReceived(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 235
 236                         /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function
 237                          *  returns a negative value. The \ref PRNT_Host_BytesReceived() function may be queried in advance to determine how many bytes
 238                          *  are currently buffered in the Printer interface's data receive pipe.
 239                          *
 240                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 241                          *       call will fail.
 242                          *
 243                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 244                          *
 245                          *  \return Next received byte from the device, or a negative value if no data received.
 246                          */
 247                         int16_t PRNT_Host_ReceiveByte(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 248
 249                         /** Retrieves the attached printer device's ID string, formatted according to IEEE 1284. This string is sent as a
 250                          *  Unicode string from the device and is automatically converted to an ASCII encoded C string by this function, thus
 251                          *  the maximum reportable string length is two less than the size given (to accommodate the Unicode string length
 252                          *  bytes which are removed).
 253                          *
 254                          *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.
 255                          *
 256                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
 257                          *  \param[out]    DeviceIDString     Pointer to a buffer where the Device ID string should be stored, in ASCII format.
 258                          *  \param[in]     BufferSize         Size in bytes of the buffer allocated for the Device ID string.
 259                          *
 260                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 261                          */
 262                         uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
 263                                                       char* const DeviceIDString,
 264                                                       const uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 265
 266         /* Private Interface - For use in library only: */
 267         #if !defined(__DOXYGEN__)
 268                 /* Function Prototypes: */
 269                         #if defined(__INCLUDE_FROM_PRINTER_HOST_C)
 270                                 static uint8_t DCOMP_PRNT_Host_NextPRNTInterface(void* const CurrentDescriptor)
 271                                                                                  ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 272                                 static uint8_t DCOMP_PRNT_Host_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor)
 273                                                                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 274                         #endif
 275         #endif
 276
 277         /* Disable C linkage for C++ Compilers: */
 278                 #if defined(__cplusplus)
 279                         }
 280                 #endif
 281
 282 #endif
 283
 284 /** @} */
 285