LUFA/Drivers/USB/Class/MIDIClass.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 MIDI Class driver.
  33  *
  34  *  Master include file for the library USB MIDI 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_USBClassMIDI MIDI Class Driver
  42  *  \brief USB class driver for the USB-IF MIDI class standard.
  43  *
  44  *  \section Sec_USBClassMIDI_Dependencies Module Source Dependencies
  45  *  The following files must be built with any user project that uses this module:
  46  *    - LUFA/Drivers/USB/Class/Device/MIDIClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  47  *    - LUFA/Drivers/USB/Class/Host/MIDIClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  48  *
  49  *  \section Sec_USBClassMIDI_ModDescription Module Description
  50  *  MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device
  51  *  and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manually
  52  *  via the low-level LUFA APIs.
  53  *
  54  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  55  *  Hosts or Devices using the USB MIDI Class.
  56  *
  57  *  \note The USB MIDI class is actually a special case of the regular Audio class, thus this module depends on
  58  *        structure definitions from the \ref Group_USBClassAudioDevice class driver module.
  59  *
  60  *  @{
  61  */
  62
  63 #ifndef _MIDI_CLASS_H_
  64 #define _MIDI_CLASS_H_
  65
  66         /* Macros: */
  67                 #define __INCLUDE_FROM_USB_DRIVER
  68                 #define __INCLUDE_FROM_MIDI_DRIVER
  69
  70         /* Includes: */
  71                 #include "../Core/USBMode.h"
  72
  73                 #if defined(USB_CAN_BE_DEVICE)
  74                         #include "Device/MIDIClassDevice.h"
  75                 #endif
  76
  77                 #if defined(USB_CAN_BE_HOST)
  78                         #include "Host/MIDIClassHost.h"
  79                 #endif
  80
  81 #endif
  82
  83 /** @} */
  84