Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Host / MIDI.h @ 978b99e5

History | View | Annotate | Download (9.91 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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 disclaim 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 Host mode driver for the library USB MIDI Class driver.
33
 *
34
 *  Host mode driver for the library USB MIDI Class driver.
35
 *
36
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
37
 *        dispatch header located in LUFA/Drivers/USB.h.
38
 */
39

    
40
/** \ingroup Group_USBClassMIDI
41
 *  \defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver
42
 *
43
 *  \section Sec_Dependencies Module Source Dependencies
44
 *  The following files must be built with any user project that uses this module:
45
 *    - LUFA/Drivers/USB/Class/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
 *  Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
49
 *
50
 *  @{
51
 */
52

    
53
#ifndef __MIDI_CLASS_HOST_H__
54
#define __MIDI_CLASS_HOST_H__
55

    
56
        /* Includes: */
57
                #include "../../USB.h"
58
                #include "../Common/MIDI.h"
59

    
60
        /* Enable C linkage for C++ Compilers: */
61
                #if defined(__cplusplus)
62
                        extern "C" {
63
                #endif
64

    
65
        /* Preprocessor Checks: */
66
                #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
67
                        #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
68
                #endif
69

    
70
        /* Public Interface - May be used in end-application: */
71
                /* Type Defines: */
72
                        /** \brief MIDI Class Host Mode Configuration and State Structure.
73
                         *
74
                         *  Class state structure. An instance of this structure should be made within the user application,
75
                         *  and passed to each of the MIDI class driver functions as the \c MIDIInterfaceInfo parameter. This
76
                         *  stores each MIDI interface's configuration and state information.
77
                         */
78
                        typedef struct
79
                        {
80
                                const struct
81
                                {
82
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the MIDI interface's streaming IN data pipe. */
83
                                        bool     DataINPipeDoubleBank; /**< Indicates if the MIDI interface's IN data pipe should use double banking. */
84

    
85
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the MIDI interface's streaming OUT data pipe. */
86
                                        bool     DataOUTPipeDoubleBank; /**< Indicates if the MIDI interface's OUT data pipe should use double banking. */
87
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
88
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
89
                                           */
90
                                struct
91
                                {
92
                                        bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
93
                                                            *   after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the
94
                                                            *   Configured state.
95
                                                            */
96
                                        uint8_t  InterfaceNumber; /**< Interface index of the MIDI interface within the attached device. */
97

    
98
                                        uint16_t DataINPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's IN data pipe. */
99
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the MIDI Streaming Data interface's OUT data pipe. */
100
                                } State; /**< State data for the USB class interface within the device. All elements in this section
101
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
102
                                                  *   the interface is enumerated.
103
                                                  */
104
                        } USB_ClassInfo_MIDI_Host_t;
105

    
106
                /* Enums: */
107
                        /** Enum for the possible error codes returned by the \ref MIDI_Host_ConfigurePipes() function. */
108
                        enum MIDI_Host_EnumerationFailure_ErrorCodes_t
109
                        {
110
                                MIDI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
111
                                MIDI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
112
                                MIDI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor. */
113
                                MIDI_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
114
                        };
115

    
116
                /* Function Prototypes: */
117
                        /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration
118
                         *  Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's
119
                         *  state values and configures the pipes required to communicate with the interface if it is found within the device.
120
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
121
                         *  the Addressed state.
122
                         *
123
                         *  \param[in,out] MIDIInterfaceInfo       Pointer to a structure containing an MIDI Class host configuration and state.
124
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
125
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
126
                         *
127
                         *  \return A value from the \ref MIDI_Host_EnumerationFailure_ErrorCodes_t enum.
128
                         */
129
                        uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
130
                                                         uint16_t ConfigDescriptorSize,
131
                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
132

    
133
                        /** General management task for a given MIDI host class interface, required for the correct operation of the interface. This should
134
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
135
                         *
136
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state.
137
                         */
138
                        void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
139

    
140
                        /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded.
141
                         *
142
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
143
                         *       call will fail.
144
                         *
145
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
146
                         *  \param[in]     Event              Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send.
147
                         *
148
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
149
                         */
150
                        uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
151
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
152

    
153
                        /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
154
                         *  \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
155
                         *  pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
156
                         *  events to be packed into a single pipe packet, increasing data throughput.
157
                         *
158
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
159
                         *
160
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
161
                         */
162
                         uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
163

    
164
                        /** Receives a MIDI event packet from the device.
165
                         *
166
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
167
                         *       call will fail.
168
                         *
169
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
170
                         *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
171
                         *
172
                         *  \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
173
                         */
174
                        bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
175
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
176

    
177
        /* Private Interface - For use in library only: */
178
        #if !defined(__DOXYGEN__)
179
                /* Function Prototypes: */
180
                        #if defined(__INCLUDE_FROM_MIDI_HOST_C)
181
                                static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor)
182
                                                                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
183
                                static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor)
184
                                                                                             ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
185
                        #endif
186
        #endif
187

    
188
        /* Disable C linkage for C++ Compilers: */
189
                #if defined(__cplusplus)
190
                        }
191
                #endif
192

    
193
#endif
194

    
195
/** @} */
196