LUFA/Drivers/USB/Class/PrinterClass.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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 Master include file for the library USB Printer Class driver.
  33  *
  34  *  Master include file for the library USB Printer Class driver, for both host and device modes, where available.
  35  *
  36  *  This file should be included in all user projects making use of this optional class driver, instead of
  37  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  38  */
  39
  40 /** \ingroup Group_USBClassDrivers
  41  *  \defgroup Group_USBClassPrinter Printer Class Driver
  42  *  \brief USB class driver for the USB-IF Printer class standard.
  43  *
  44  *  \section Sec_USBClassPrinter_Dependencies Module Source Dependencies
  45  *  The following files must be built with any user project that uses this module:
  46  *    - LUFA/Drivers/USB/Class/Host/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  47  *    - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  48  *
  49  *  \section Sec_USBClassPrinter_ModDescription Module Description
  50  *  Printer Class Driver module. This module contains an internal implementation of the USB Printer Class, for the base
  51  *  USB Printer transport layer for USB Host mode only. Note that printers are free to implement whatever printer language
  52  *  they choose on top of this (e.g. Postscript), and so this driver exposes low level data transport functions only rather
  53  *  than high level raster or text functions. User applications can use this class driver instead of implementing the Printer
  54  *  class manually via the low-level LUFA APIs.
  55  *
  56  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  57  *  Devices using the USB Printer Class.
  58  *
  59  *  @{
  60  */
  61
  62 #ifndef _PRINTER_CLASS_H_
  63 #define _PRINTER_CLASS_H_
  64
  65         /* Macros: */
  66                 #define __INCLUDE_FROM_USB_DRIVER
  67                 #define __INCLUDE_FROM_PRINTER_DRIVER
  68
  69         /* Includes: */
  70                 #include "../Core/USBMode.h"
  71
  72                 #if defined(USB_CAN_BE_DEVICE)
  73                         #include "Device/PrinterClassDevice.h"
  74                 #endif
  75
  76                 #if defined(USB_CAN_BE_HOST)
  77                         #include "Host/PrinterClassHost.h"
  78                 #endif
  79
  80 #endif
  81
  82 /** @} */
  83