Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Host / Printer.h @ 978b99e5

History | View | Annotate | Download (15.8 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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 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_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 <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_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/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/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
                                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 for the possible error codes returned by the \ref PRNT_Host_ConfigurePipes() function. */
109
                        enum PRNT_Host_EnumerationFailure_ErrorCodes_t
110
                        {
111
                                PRNT_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
112
                                PRNT_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
113
                                PRNT_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Printer interface was not found in the device's Configuration Descriptor. */
114
                                PRNT_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
115
                        };
116

    
117
                /* Function Prototypes: */
118
                        /** Host interface configuration routine, to configure a given Printer host interface instance using the
119
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer
120
                         *  instance's state values and configures the pipes required to communicate with the interface if it is found within
121
                         *  the device. This should be called once after the stack has enumerated the attached device, while the host state
122
                         *  machine is in the Addressed state.
123
                         *
124
                         *  \param[in,out] PRNTInterfaceInfo       Pointer to a structure containing a Printer Class host configuration and state.
125
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
126
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
127
                         *
128
                         *  \return A value from the \ref PRNT_Host_EnumerationFailure_ErrorCodes_t enum.
129
                         */
130
                        uint8_t PRNT_Host_ConfigurePipes(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
131
                                                         uint16_t ConfigDescriptorSize,
132
                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
133

    
134
                        /** General management task for a given Printer host class interface, required for the correct operation of
135
                         *  the interface. This should be called frequently in the main program loop, before the master USB management task
136
                         *  \ref USB_USBTask().
137
                         *
138
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
139
                         */
140
                        void PRNT_Host_USBTask(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
141

    
142
                        /** Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called
143
                         *  once the connected device's configuration has been set, to ensure the printer is ready to accept commands.
144
                         *
145
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
146
                         *
147
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
148
                         */
149
                        uint8_t PRNT_Host_SetBidirectionalMode(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
150

    
151
                        /** Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the
152
                         *  \c PRNT_PORTSTATUS_* macros to determine the printer port's status.
153
                         *
154
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
155
                         *  \param[out]    PortStatus         Location where the retrieved port status should be stored.
156
                         *
157
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
158
                         */
159
                        uint8_t PRNT_Host_GetPortStatus(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
160
                                                        uint8_t* const PortStatus)
161
                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
162

    
163
                        /** Soft-resets the attached printer, readying it for new commands.
164
                         *
165
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
166
                         *
167
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
168
                         */
169
                        uint8_t PRNT_Host_SoftReset(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
170

    
171
                        /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
172
                         *
173
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
174
                         *       call will fail.
175
                         *
176
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
177
                         *
178
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
179
                         */
180
                        uint8_t PRNT_Host_Flush(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
181

    
182
                        /** Sends the given null terminated string to the attached printer's input endpoint.
183
                         *
184
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
185
                         *       call will fail.
186
                         *
187
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
188
                         *  \param[in]     String             Pointer to a null terminated string to send.
189
                         *
190
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
191
                         */
192
                        uint8_t PRNT_Host_SendString(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
193
                                                     void* String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
194

    
195
                        /** Sends the given raw data stream to the attached printer's input endpoint. This should contain commands that the
196
                         *  printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see
197
                         *  \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.
198
                         *
199
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
200
                         *       call will fail.
201
                         *
202
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
203
                         *  \param[in]     Buffer             Pointer to a buffer containing the raw command stream to send to the printer.
204
                         *  \param[in]     Length             Size in bytes of the command stream to be sent.
205
                         *
206
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
207
                         */
208
                        uint8_t PRNT_Host_SendData(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
209
                                                   void* Buffer,
210
                                                   const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
211

    
212
                        /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
213
                         *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
214
                         *  \ref PRNT_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
215
                         *  packed into a single pipe packet, increasing data throughput.
216
                         *
217
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
218
                         *       call will fail.
219
                         *
220
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
221
                         *  \param[in]     Data               Byte of data to send to the device.
222
                         *
223
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
224
                         */
225
                        uint8_t PRNT_Host_SendByte(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
226
                                                   const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
227

    
228
                        /** Determines the number of bytes received by the printer interface from the device, waiting to be read. This indicates the number
229
                         *  of bytes in the IN pipe bank only, and thus the number of calls to \ref PRNT_Host_ReceiveByte() which are guaranteed to succeed
230
                         *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
231
                         *  released back to the USB controller until all bytes are read.
232
                         *
233
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
234
                         *       call will fail.
235
                         *
236
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
237
                         *
238
                         *  \return Total number of buffered bytes received from the device.
239
                         */
240
                        uint16_t PRNT_Host_BytesReceived(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo);
241

    
242
                        /** 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
243
                         *  returns a negative value. The \ref PRNT_Host_BytesReceived() function may be queried in advance to determine how many bytes
244
                         *  are currently buffered in the Printer interface's data receive pipe.
245
                         *
246
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
247
                         *       call will fail.
248
                         *
249
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
250
                         *
251
                         *  \return Next received byte from the device, or a negative value if no data received.
252
                         */
253
                        int16_t PRNT_Host_ReceiveByte(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo);
254

    
255
                        /** Retrieves the attached printer device's ID string, formatted according to IEEE 1284. This string is sent as a
256
                         *  Unicode string from the device and is automatically converted to an ASCII encoded C string by this function, thus
257
                         *  the maximum reportable string length is two less than the size given (to accommodate the Unicode string length
258
                         *  bytes which are removed).
259
                         *
260
                         *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.
261
                         *
262
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state.
263
                         *  \param[out]    DeviceIDString     Pointer to a buffer where the Device ID string should be stored, in ASCII format.
264
                         *  \param[in]     BufferSize         Size in bytes of the buffer allocated for the Device ID string.
265
                         *
266
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
267
                         */
268
                        uint8_t PRNT_Host_GetDeviceID(USB_ClassInfo_PRNT_Host_t* const PRNTInterfaceInfo,
269
                                                      char* const DeviceIDString,
270
                                                      const uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
271

    
272
        /* Private Interface - For use in library only: */
273
        #if !defined(__DOXYGEN__)
274
                /* Function Prototypes: */
275
                        #if defined(__INCLUDE_FROM_PRINTER_HOST_C)
276
                                static uint8_t DCOMP_PRNT_Host_NextPRNTInterface(void* const CurrentDescriptor)
277
                                                                                 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
278
                                static uint8_t DCOMP_PRNT_Host_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor)
279
                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
280
                        #endif
281
        #endif
282

    
283
        /* Disable C linkage for C++ Compilers: */
284
                #if defined(__cplusplus)
285
                        }
286
                #endif
287

    
288
#endif
289

    
290
/** @} */
291