PrinterClass.h 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. /*
  2. LUFA Library
  3. Copyright (C) Dean Camera, 2018.
  4. dean [at] fourwalledcubicle [dot] com
  5. www.lufa-lib.org
  6. */
  7. /*
  8. Copyright 2018 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  9. Permission to use, copy, modify, distribute, and sell this
  10. software and its documentation for any purpose is hereby granted
  11. without fee, provided that the above copyright notice appear in
  12. all copies and that both that the copyright notice and this
  13. permission notice and warranty disclaimer appear in supporting
  14. documentation, and that the name of the author not be used in
  15. advertising or publicity pertaining to distribution of the
  16. software without specific, written prior permission.
  17. The author disclaims all warranties with regard to this
  18. software, including all implied warranties of merchantability
  19. and fitness. In no event shall the author be liable for any
  20. special, indirect or consequential damages or any damages
  21. whatsoever resulting from loss of use, data or profits, whether
  22. in an action of contract, negligence or other tortious action,
  23. arising out of or in connection with the use or performance of
  24. this software.
  25. */
  26. /** \file
  27. * \brief Master include file for the library USB Printer Class driver.
  28. *
  29. * Master include file for the library USB Printer Class driver, for both host and device modes, where available.
  30. *
  31. * This file should be included in all user projects making use of this optional class driver, instead of
  32. * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  33. */
  34. /** \ingroup Group_USBClassDrivers
  35. * \defgroup Group_USBClassPrinter Printer Class Driver
  36. * \brief USB class driver for the USB-IF Printer class standard.
  37. *
  38. * \section Sec_USBClassPrinter_Dependencies Module Source Dependencies
  39. * The following files must be built with any user project that uses this module:
  40. * - LUFA/Drivers/USB/Class/Host/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  41. * - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  42. *
  43. * \section Sec_USBClassPrinter_ModDescription Module Description
  44. * Printer Class Driver module. This module contains an internal implementation of the USB Printer Class, for the base
  45. * USB Printer transport layer for USB Host mode only. Note that printers are free to implement whatever printer language
  46. * they choose on top of this (e.g. Postscript), and so this driver exposes low level data transport functions only rather
  47. * than high level raster or text functions. User applications can use this class driver instead of implementing the Printer
  48. * class manually via the low-level LUFA APIs.
  49. *
  50. * This module is designed to simplify the user code by exposing only the required interface needed to interface with
  51. * Devices using the USB Printer Class.
  52. *
  53. * @{
  54. */
  55. #ifndef _PRINTER_CLASS_H_
  56. #define _PRINTER_CLASS_H_
  57. /* Macros: */
  58. #define __INCLUDE_FROM_USB_DRIVER
  59. #define __INCLUDE_FROM_PRINTER_DRIVER
  60. /* Includes: */
  61. #include "../Core/USBMode.h"
  62. #if defined(USB_CAN_BE_DEVICE)
  63. #include "Device/PrinterClassDevice.h"
  64. #endif
  65. #if defined(USB_CAN_BE_HOST)
  66. #include "Host/PrinterClassHost.h"
  67. #endif
  68. #endif
  69. /** @} */