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