LUFA (Formerly MyUSB) Library 100807
Data Structures | Enumerations | Functions

Printer Class Host Mode Driver

Printer Class Driver - LUFA/Drivers/Class/Printer.h

Data Structures

struct  USB_ClassInfo_PRNT_Host_t
 Printer Class Host Mode Configuration and State Structure. More...

Enumerations

enum  PRNTHost_EnumerationFailure_ErrorCodes_t {
  PRNT_ENUMERROR_NoError = 0,
  PRNT_ENUMERROR_InvalidConfigDescriptor = 1,
  PRNT_ENUMERROR_NoPrinterInterfaceFound = 2,
  PRNT_ENUMERROR_EndpointsNotFound = 3
}

Functions

uint8_t PRNT_Host_ConfigurePipes (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo, uint16_t ConfigDescriptorSize, void *DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3)
uint8_t PRNT_Host_SetBidirectionalMode (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1)
uint8_t PRNT_Host_GetPortStatus (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo, uint8_t *const PortStatus) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)
uint8_t PRNT_Host_SoftReset (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1)
uint8_t PRNT_Host_SendData (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo, void *PrinterCommands, const uint16_t CommandSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)
uint8_t PRNT_Host_GetDeviceID (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo, char *const DeviceIDString, const uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)
static void PRNT_Host_USBTask (USB_ClassInfo_PRNT_Host_t *const PRNTInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1)

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this module:

Description

Host Mode USB Class driver framework interface, for the Printer USB Class driver.

Enumeration Type Documentation

enum PRNTHost_EnumerationFailure_ErrorCodes_t
Enumerator:
PRNT_ENUMERROR_NoError 

Configuration Descriptor was processed successfully.

PRNT_ENUMERROR_InvalidConfigDescriptor 

The device returned an invalid Configuration Descriptor.

PRNT_ENUMERROR_NoPrinterInterfaceFound 

A compatible Printer interface was not found in the device's Configuration Descriptor.

PRNT_ENUMERROR_EndpointsNotFound 

Compatible Printer endpoints were not found in the device's interfaces.

Function Documentation

uint8_t PRNT_Host_ConfigurePipes ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo,
uint16_t  ConfigDescriptorSize,
void *  DeviceConfigDescriptor 
)

Host interface configuration routine, to configure a given Printer host interface instance using the Configuration Descriptor read from an attached USB device. This function automatically updates the given Printer instance's state values and configures the pipes required to communicate with the interface if it is found within the device. This should be called once after the stack has enumerated the attached device, while the host state machine is in the Addressed state.

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
[in]ConfigDescriptorSizeLength of the attached device's Configuration Descriptor.
[in]DeviceConfigDescriptorPointer to a buffer containing the attached device's Configuration Descriptor.
Returns:
A value from the PRNTHost_EnumerationFailure_ErrorCodes_t enum.
uint8_t PRNT_Host_GetDeviceID ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo,
char *const  DeviceIDString,
const uint16_t  BufferSize 
)

Retrieves the attached printer device's ID string, formatted according to IEEE 1284. This string is sent as a Unicode string from the device and is automatically converted to an ASCII encoded C string by this function, thus the maximum reportable string length is two less than the size given (to accommodate the Unicode string length bytes which are removed).

This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
[out]DeviceIDStringPointer to a buffer where the Device ID string should be stored, in ASCII format.
[in]BufferSizeSize in bytes of the buffer allocated for the Device ID string.
Returns:
A value from the Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t PRNT_Host_GetPortStatus ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo,
uint8_t *const  PortStatus 
)

Retrieves the status of the virtual Printer port's inbound status lines. The result can then be masked against the PRNT_PORTSTATUS_* macros to determine the printer port's status.

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
[out]PortStatusLocation where the retrieved port status should be stored.
Returns:
A value from the USB_Host_SendControlErrorCodes_t enum.
uint8_t PRNT_Host_SendData ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo,
void *  PrinterCommands,
const uint16_t  CommandSize 
)

Sends the given raw data stream to the attached printer's input endpoint. This should contain commands that the printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.

Precondition:
This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the call will fail.
Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
[in]PrinterCommandsPointer to a buffer containing the raw command stream to send to the printer.
[in]CommandSizeSize in bytes of the command stream to be sent.
Returns:
A value from the Pipe_Stream_RW_ErrorCodes_t enum.
uint8_t PRNT_Host_SetBidirectionalMode ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo)

Configures the printer to enable Bidirectional mode, if it is not already in this mode. This should be called once the connected device's configuration has been set, to ensure the printer is ready to accept commands.

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
Returns:
A value from the USB_Host_SendControlErrorCodes_t enum.
uint8_t PRNT_Host_SoftReset ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo)

Soft-resets the attached printer, readying it for new commands.

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
Returns:
A value from the USB_Host_SendControlErrorCodes_t enum.
static void PRNT_Host_USBTask ( USB_ClassInfo_PRNT_Host_t *const  PRNTInterfaceInfo) [inline, static]

General management task for a given Printer host class interface, required for the correct operation of the interface. This should be called frequently in the main program loop, before the master USB management task USB_USBTask().

Parameters:
[in,out]PRNTInterfaceInfoPointer to a structure containing a Printer Class host configuration and state.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines