Renamed all driver termination *_ShutDown() functions to the more logical name *_Disa...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MIDI.h

diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h
index ef3f8fc..3aea637 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Common/MIDI.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.

 
   dean [at] fourwalledcubicle [dot] com
 
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -33,14 +33,14 @@
  *
  *  Common definitions and declarations for the library USB MIDI Class driver.
  *
  *
  *  Common definitions and declarations for the library USB MIDI Class driver.
  *

- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.

  */
 
 /** \ingroup Group_USBClassMIDI
  *  @defgroup Group_USBClassMIDICommon  Common Class Definitions
  *
  */
 
 /** \ingroup Group_USBClassMIDI
  *  @defgroup Group_USBClassMIDICommon  Common Class Definitions
  *

- *  \section Module Description
+ *  \section Sec_ModDescription Module Description

  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  MIDI Class.
  *
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  MIDI Class.
  *


@@ -54,7 +54,7 @@
                #define __INCLUDE_FROM_AUDIO_DRIVER
 
        /* Includes: */
                #define __INCLUDE_FROM_AUDIO_DRIVER
 
        /* Includes: */

-               #include "../../USB.h"
+               #include "../../HighLevel/StdDescriptors.h"

                #include "Audio.h"
 
                #include <string.h>
                #include "Audio.h"
 
                #include <string.h>


@@ -66,15 +66,18 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MIDI_DRIVER)

-                       #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

                #endif
 
        /* Macros: */
                #endif
 
        /* Macros: */

+               /** \name MIDI Command Values */
+               //@{

                /** MIDI command for a note on (activation) event. */
                #define MIDI_COMMAND_NOTE_ON        0x90
 
                /** MIDI command for a note off (deactivation) event. */
                #define MIDI_COMMAND_NOTE_OFF       0x80
                /** MIDI command for a note on (activation) event. */
                #define MIDI_COMMAND_NOTE_ON        0x90
 
                /** MIDI command for a note off (deactivation) event. */
                #define MIDI_COMMAND_NOTE_OFF       0x80

+               //@}

 
                /** Standard key press velocity value used for all note events. */
                #define MIDI_STANDARD_VELOCITY      64
 
                /** Standard key press velocity value used for all note events. */
                #define MIDI_STANDARD_VELOCITY      64


@@ -87,6 +90,7 @@
                #define MIDI_CHANNEL(channel)        ((channel) - 1)
 
        /* Enums: */
                #define MIDI_CHANNEL(channel)        ((channel) - 1)
 
        /* Enums: */

+               /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */

                enum MIDI_JackTypes_t
                {
                        MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
                enum MIDI_JackTypes_t
                {
                        MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */


@@ -147,7 +151,7 @@
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 

-                       uint8_t                 JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+                       uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */

                        uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
                        uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */


@@ -170,7 +174,7 @@
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 

-                       uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+                       uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */

                        uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
                        uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */


@@ -188,7 +192,7 @@
                        USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
                        uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
                        USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
                        uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 

-                       uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+                       uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */

                        uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
                        uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */


@@ -215,7 +219,7 @@
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 

-                       uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+                       uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */

                        uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
                        uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
                        uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */