X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/3cbdcd36868693cfc1863231a1ec64507ce3d29f..fc31973daffea3506051ce51a5f79383ce0867d6:/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 dfeadb05b..aa843827b 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, provided that the above copyright notice appear in all - copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + Copyright 2010 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 + without fee, provided that the above copyright notice appear in + all copies and that both that the copyright notice and this + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -28,13 +28,31 @@ this software. */ +/** \file + * \brief 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. + */ + /** \ingroup Group_USBClassMIDI + * @defgroup Group_USBClassMIDICommon Common Class Definitions + * + * \section Module Description + * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB + * MIDI Class. + * * @{ */ #ifndef _MIDI_CLASS_COMMON_H_ #define _MIDI_CLASS_COMMON_H_ + /* Macros: */ + #define __INCLUDE_FROM_AUDIO_DRIVER + /* Includes: */ #include "../../USB.h" #include "Audio.h" @@ -46,6 +64,11 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_MIDI_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead. + #endif + /* Macros: */ /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */ #define DSUBTYPE_InputJack 0x02 @@ -71,12 +94,14 @@ /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address. * - * \param channel MIDI channel number to address + * \param[in] channel MIDI channel number to address */ - #define MIDI_CHANNEL(channel) (channel - 1) + #define MIDI_CHANNEL(channel) ((channel) - 1) /* Type Defines: */ - /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host + /** \brief MIDI Class Specific Streaming Interface Descriptor. + * + * Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host * how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors. * See the USB Audio specification for more details. */ @@ -89,7 +114,9 @@ uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */ } USB_MIDI_AudioInterface_AS_t; - /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either + /** \brief MIDI Class Specific Input Jack Descriptor. + * + * Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint). */ typedef struct @@ -103,7 +130,9 @@ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_MIDI_In_Jack_t; - /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either + /** \brief MIDI Class Specific Output Jack Descriptor. + * + * Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint). */ typedef struct @@ -121,7 +150,9 @@ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_MIDI_Out_Jack_t; - /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information + /** \brief Audio Class Specific Jack Endpoint Descriptor. + * + * Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio * class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details. */ @@ -134,10 +165,13 @@ uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */ } USB_MIDI_Jack_Endpoint_t; - /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */ + /** \brief MIDI Class Driver Event Packet. + * + * Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. + */ typedef struct { - unsigned char Command : 4; /**< MIDI command being sent or received in the event packet */ + unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */ unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */ uint8_t Data1; /**< First byte of data in the MIDI event */