LUFA/Drivers/USB/Class/Common/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 Common definitions and declarations for the library USB Printer Class driver.
  33  *
  34  *  Common definitions and declarations 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_USBClassPrinterCommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  Printer Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _PRINTER_CLASS_COMMON_H_
  51 #define _PRINTER_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../USB.h"
  55
  56                 #include <string.h>
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_PRINTER_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/Class/Printer.h instead.
  66                 #endif
  67
  68         /* Macros: */
  69                 /** Port status mask for a printer device, indicating that an error has *not* occurred. */
  70                 #define PRNT_PORTSTATUS_NOTERROR    (1 << 3)
  71
  72                 /** Port status mask for a printer device, indicating that the device is currently selected. */
  73                 #define PRNT_PORTSTATUS_SELECT      (1 << 4)
  74
  75                 /** Port status mask for a printer device, indicating that the device is currently out of paper. */
  76                 #define PRNT_PORTSTATUS_PAPEREMPTY  (1 << 5)
  77
  78         /* Disable C linkage for C++ Compilers: */
  79                 #if defined(__cplusplus)
  80                         }
  81                 #endif
  82
  83 #endif
  84
  85 /** @} */