Update UC3 platform driver support to use the bitmasks defined in the header files...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / Printer.h

diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h
index 7e89b41..3d52be3 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/Printer.h
+++ b/LUFA/Drivers/USB/Class/Common/Printer.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -33,14 +33,14 @@
  *
  *  Common definitions and declarations for the library USB Printer Class driver.
  *
  *
  *  Common definitions and declarations for the library USB Printer Class driver.
  *

- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/Printer.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.

  */
 
 /** \ingroup Group_USBClassPrinter
  */
 
 /** \ingroup Group_USBClassPrinter

- *  @defgroup Group_USBClassPrinterCommon  Common Class Definitions
+ *  \defgroup Group_USBClassPrinterCommon  Common Class Definitions

  *
  *

- *  \section Module Description
+ *  \section Sec_ModDescription Module Description

  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  Printer Class.
  *
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  Printer Class.
  *


@@ -51,9 +51,7 @@
 #define _PRINTER_CLASS_COMMON_H_
 
        /* Includes: */
 #define _PRINTER_CLASS_COMMON_H_
 
        /* Includes: */

-               #include "../../USB.h"
-
-               #include <string.h>
+               #include "../../Core/StdDescriptors.h"

 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)


@@ -62,10 +60,12 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)

-                       #error Do not include this file directly. Include LUFA/Drivers/Class/Printer.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

                #endif
                #endif

-               
+

        /* Macros: */
        /* Macros: */

+               /** \name Virtual Printer Status Line Masks */
+               //@{

                /** Port status mask for a printer device, indicating that an error has *not* occurred. */
                #define PRNT_PORTSTATUS_NOTERROR    (1 << 3)
 
                /** Port status mask for a printer device, indicating that an error has *not* occurred. */
                #define PRNT_PORTSTATUS_NOTERROR    (1 << 3)
 


@@ -74,12 +74,46 @@
 
                /** Port status mask for a printer device, indicating that the device is currently out of paper. */
                #define PRNT_PORTSTATUS_PAPEREMPTY  (1 << 5)
 
                /** Port status mask for a printer device, indicating that the device is currently out of paper. */
                #define PRNT_PORTSTATUS_PAPEREMPTY  (1 << 5)

+               //@}
+
+       /* Enums: */
+               /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Printer
+                *  device class.
+                */
+               enum PRNT_Descriptor_ClassSubclassProtocol_t
+               {
+                       PRNT_CSCP_PrinterClass          = 0x07, /**< Descriptor Class value indicating that the device or interface
+                                                                *   belongs to the Printer class.
+                                                                */
+                       PRNT_CSCP_PrinterSubclass       = 0x01, /**< Descriptor Subclass value indicating that the device or interface
+                                                                *   belongs to the Printer subclass.
+                                                                */
+                       PRNT_CSCP_BidirectionalProtocol = 0x02, /**< Descriptor Protocol value indicating that the device or interface
+                                                                *   belongs to the Bidirectional protocol of the Printer class.
+                                                                */
+               };

        
        

+               /** Enum for the Printer class specific control requests that can be issued by the USB bus host. */
+               enum PRNT_ClassRequests_t
+               {
+                       PRNT_REQ_GetDeviceID            = 0x00, /**< Printer class-specific request to retrieve the Unicode ID
+                                                                *   string of the device, containing the device's name, manufacturer
+                                                                *   and supported printer languages.
+                                                                */
+                       PRNT_REQ_GetPortStatus          = 0x01, /**< Printer class-specific request to get the current status of the
+                                                                *   virtual printer port, for device selection and ready states.
+                                                                */
+                       PRNT_REQ_SoftReset              = 0x02, /**< Printer class-specific request to reset the device, ready for new
+                                                                *   printer commands.
+                                                                */
+               };              
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-               
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+