LUFA/Drivers/USB/Class/Host/Printer.h

   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 /** \ingroup Group_USBClassPrinter
  32  *  @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Host/Printer.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the Printer USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __PRINTER_CLASS_HOST_H__
  45 #define __PRINTER_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/Printer.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Preprocessor Checks: */
  57                 #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)
  58                         #error Do not include this file directly. Include LUFA/Drivers/Class/Printer.h instead.
  59                 #endif
  60
  61         /* Public Interface - May be used in end-application: */
  62                 /* Type Defines: */
  63                         /** Class state structure. An instance of this structure should be made within the user application,
  64                          *  and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This
  65                          *  stores each Printer interface's configuration and state information.
  66                          */
  67                         typedef struct
  68                         {
  69                                 const struct
  70                                 {
  71                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Printer interface's IN data pipe */
  72                                         bool     DataINPipeDoubleBank; /** Indicates if the Printer interface's IN data pipe should use double banking */
  73
  74                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Printer interface's OUT data pipe */
  75                                         bool     DataOUTPipeDoubleBank; /** Indicates if the Printer interface's OUT data pipe should use double banking */
  76                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  77                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  78                                            */
  79                                 struct
  80                                 {
  81                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  82                                                         *   after \ref PRNT_Host_ConfigurePipes() is called and the Host state machine is in the
  83                                                         *   Configured state
  84                                                         */
  85                                         uint8_t InterfaceNumber; /**< Interface index of the Printer interface within the attached device */
  86                                         uint8_t AlternateSetting; /**< Alternate setting within the Printer Interface in the attached device */
  87
  88                                         uint16_t DataINPipeSize; /**< Size in bytes of the Printer interface's IN data pipe */
  89                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Printer interface's OUT data pipe */
  90                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  91                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  92                                                   *   the interface is enumerated.
  93                                                   */
  94                         } USB_ClassInfo_PRNT_Host_t;
  95
  96                 /* Enums: */
  97                         enum PRNTHost_EnumerationFailure_ErrorCodes_t
  98                         {
  99                                 PRNT_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 100                                 PRNT_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 101                                 PRNT_ENUMERROR_NoPrinterInterfaceFound    = 2, /**< A compatible Printer interface was not found in the device's Configuration Descriptor */
 102                                 PRNT_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Printer endpoints were not found in the device's interfaces */
 103                         };
 104
 105                 /* Function Prototypes: */
 106                         /** Host interface configuration routine, to configure a given Printer host interface instance using the
 107                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer
 108                          *  instance's state values and configures the pipes required to communicate with the interface if it is found within
 109                          *  the device. This should be called once after the stack has enumerated the attached device, while the host state
 110                          *  machine is in the Addressed state.
 111                          *
 112                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 113                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 114                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 115                          *
 116                          *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum
 117                          */
 118                         uint8_t PRNT_Host_ConfigurePipes(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint16_t ConfigDescriptorSize,
 119                                                          void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 120
 121                         /** Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called
 122                          *  once the connected device's configuration has been set, to ensure the printer is ready to accept commands.
 123                          *
 124                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 125                          *
 126                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 127                          */
 128                         uint8_t PRNT_Host_SetBidirectionalMode(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 129
 130                         /** Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the
 131                          *  PRNT_PORTSTATUS_* macros to determine the printer port's status.
 132                          *
 133                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 134                          *  \param[out]  PortStatus  Location where the retrieved port status should be stored
 135                          *
 136                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 137                          */
 138                         uint8_t PRNT_Host_GetPortStatus(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, uint8_t* const PortStatus)
 139                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 140
 141                         /** Soft-resets the attached printer, readying it for new commands.
 142                          *
 143                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 144                          *
 145                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 146                          */
 147                         uint8_t PRNT_Host_SoftReset(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 148
 149                         /** Sends the given raw data stream to the attached printer's input endpoint. This should contain commands that the
 150                          *  printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see
 151                          *  \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.
 152                          *
 153                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 154                          *        call will fail.
 155                          *
 156                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 157                          *  \param[in] PrinterCommands  Pointer to a buffer containing the raw command stream to send to the printer
 158                          *  \param[in] CommandSize  Size in bytes of the command stream to be sent
 159                          *
 160                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 161                          */
 162                         uint8_t PRNT_Host_SendData(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, void* PrinterCommands,
 163                                                    uint16_t CommandSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 164
 165                         /** Retrieves the attached printer device's ID string, formatted according to IEEE 1284. This string is sent as a
 166                          *  Unicode string from the device and is automatically converted to an ASCII encoded C string by this function, thus
 167                          *  the maximum reportable string length is two less than the size given (to accommodate the Unicode string length
 168                          *  bytes which are removed).
 169                          *
 170                          *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.
 171                          *
 172                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 173                          *  \param[out] DeviceIDString  Pointer to a buffer where the Device ID string should be stored, in ASCII format
 174                          *  \param[in] BufferSize  Size in bytes of the buffer allocated for the Device ID string
 175                          *
 176                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 177                          */
 178                         uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo, char* DeviceIDString,
 179                                                       uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1);
 180
 181                 /* Inline Functions: */
 182                         /** General management task for a given Printer host class interface, required for the correct operation of
 183                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 184                          *  \ref USB_USBTask().
 185                          *
 186                          *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
 187                          */
 188                         static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo);
 189                         static inline void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo)
 190                         {
 191                                 (void)PRNTInterfaceInfo;
 192                         }
 193
 194         /* Private Interface - For use in library only: */
 195         #if !defined(__DOXYGEN__)
 196                 /* Macros: */
 197                         #define PRINTER_CLASS                  0x07
 198                         #define PRINTER_SUBCLASS               0x01
 199                         #define PRINTER_PROTOCOL               0x02
 200
 201                         #define REQ_GetDeviceID                0
 202                         #define REQ_GetPortStatus              1
 203                         #define REQ_SoftReset                  2
 204
 205                         #define PRNT_FOUND_DATAPIPE_IN         (1 << 0)
 206                         #define PRNT_FOUND_DATAPIPE_OUT        (1 << 1)
 207
 208                 /* Function Prototypes: */
 209                         #if defined(__INCLUDE_FROM_PRINTER_CLASS_HOST_C)
 210                                 static uint8_t DComp_NextPRNTInterface(void* const CurrentDescriptor);
 211                                 static uint8_t DComp_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor);
 212                         #endif
 213         #endif
 214
 215         /* Disable C linkage for C++ Compilers: */
 216                 #if defined(__cplusplus)
 217                         }
 218                 #endif
 219
 220 #endif
 221
 222 /** @} */