LUFA/Drivers/USB/Class/CCIDClass.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2021  Filipe Rodrigues (filipepazrodrigues [at] gmail [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaims all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *  \brief Master include file for the library USB CCID Class driver.
  34  *
  35  *  Master include file for the library USB CCID Class driver, for both host and device modes, where available.
  36  *
  37  *  This file should be included in all user projects making use of this optional class driver, instead of
  38  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  39  */
  40
  41 /** \ingroup Group_USBClassDrivers
  42  *  \defgroup Group_USBClassCCID CCID Class Driver
  43  *  \brief USB class driver for the USB-IF CCID class standard.
  44  *
  45  *  \section Sec_USBClassCCID_Dependencies Module Source Dependencies
  46  *  The following files must be built with any user project that uses this module:
  47  *    - LUFA/Drivers/USB/Class/Device/CCIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  48  *
  49  *  \section Sec_USBClassCCID_ModDescription Module Description
  50  *  CCID Class Driver module. This module contains an internal implementation of the USB CCID Class, for Device USB
  51  *  mode. User applications can use this class driver instead of implementing the CCID class manually via the low-level
  52  *  LUFA APIs.
  53  *
  54  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  55  *  Devices using the USB CCID Class.
  56  *
  57  *  \warning
  58  *  LUFA is not a secure USB stack, and has not undergone, not is it expected to pass, any form of security audit. The
  59  *  CCID class here is presented as-is and is intended for research purposes only, and *should not* be used in a security
  60  *  critical application under any circumstances.
  61  *
  62  *  @{
  63  */
  64
  65 #ifndef _CCID_CLASS_H_
  66 #define _CCID_CLASS_H_
  67
  68         /* Macros: */
  69                 #define __INCLUDE_FROM_USB_DRIVER
  70                 #define __INCLUDE_FROM_CCID_DRIVER
  71
  72         /* Includes: */
  73                 #include "../Core/USBMode.h"
  74
  75                 #if defined(USB_CAN_BE_DEVICE)
  76                         #include "Device/CCIDClassDevice.h"
  77                 #endif
  78
  79 #endif
  80
  81 /** @} */
  82