Minor documentation improvements.
[pub/USBasp.git] / Demos / Host / ClassDriver / MIDIHost / MIDIHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2012.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2012 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 *
33 * Main source file for the MIDIHost demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "MIDIHost.h"
38
39 /** LUFA MIDI Class driver interface configuration and state information. This structure is
40 * passed to all MIDI Class driver functions, so that multiple instances of the same class
41 * within a device can be differentiated from one another.
42 */
43 USB_ClassInfo_MIDI_Host_t Keyboard_MIDI_Interface =
44 {
45 .Config =
46 {
47 .DataINPipe =
48 {
49 .Address = (PIPE_DIR_IN | 1),
50 .Banks = 1,
51 },
52 .DataOUTPipe =
53 {
54 .Address = (PIPE_DIR_OUT | 2),
55 .Banks = 1,
56 },
57 },
58 };
59
60
61 /** Main program entry point. This routine configures the hardware required by the application, then
62 * enters a loop to run the application tasks in sequence.
63 */
64 int main(void)
65 {
66 SetupHardware();
67
68 puts_P(PSTR(ESC_FG_CYAN "MIDI Host Demo running.\r\n" ESC_FG_WHITE));
69
70 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
71 GlobalInterruptEnable();
72
73 for (;;)
74 {
75 JoystickHost_Task();
76
77 MIDI_Host_USBTask(&Keyboard_MIDI_Interface);
78 USB_USBTask();
79 }
80 }
81
82 /** Configures the board hardware and chip peripherals for the demo's functionality. */
83 void SetupHardware(void)
84 {
85 /* Disable watchdog if enabled by bootloader/fuses */
86 MCUSR &= ~(1 << WDRF);
87 wdt_disable();
88
89 /* Disable clock division */
90 clock_prescale_set(clock_div_1);
91
92 /* Hardware Initialization */
93 Serial_Init(9600, false);
94 LEDs_Init();
95 Buttons_Init();
96 Joystick_Init();
97 USB_Init();
98
99 /* Create a stdio stream for the serial port for stdin and stdout */
100 Serial_CreateStream(NULL);
101 }
102
103 /** Task to manage an enumerated USB MIDI device once connected, to display received
104 * note events from the host and send note changes in response to the board's joystick.
105 */
106 void JoystickHost_Task(void)
107 {
108 if (USB_HostState != HOST_STATE_Configured)
109 return;
110
111 MIDI_EventPacket_t MIDIEvent;
112 while (MIDI_Host_ReceiveEventPacket(&Keyboard_MIDI_Interface, &MIDIEvent))
113 {
114 bool NoteOnEvent = (MIDIEvent.Event == MIDI_EVENT(0, MIDI_COMMAND_NOTE_ON));
115 bool NoteOffEvent = (MIDIEvent.Event == MIDI_EVENT(0, MIDI_COMMAND_NOTE_OFF));
116
117 /* Display note events from the host */
118 if (NoteOnEvent || NoteOffEvent)
119 {
120 printf_P(PSTR("MIDI Note %s - Channel %d, Pitch %d, Velocity %d\r\n"), NoteOnEvent ? "On" : "Off",
121 ((MIDIEvent.Data1 & 0x0F) + 1),
122 MIDIEvent.Data2, MIDIEvent.Data3);
123 }
124 }
125
126 CheckJoystickMovement();
127 }
128
129 /** Checks for movement of the board's joystick, and sends corresponding MIDI note on/off
130 * messages to the host.
131 */
132 void CheckJoystickMovement(void)
133 {
134 static uint8_t PrevJoystickStatus;
135
136 uint8_t MIDICommand = 0;
137 uint8_t MIDIPitch;
138
139 /* Get current joystick mask, XOR with previous to detect joystick changes */
140 uint8_t JoystickStatus = Joystick_GetStatus();
141 uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus);
142
143 /* Get board button status - if pressed use channel 10 (percussion), otherwise use channel 1 */
144 uint8_t Channel = ((Buttons_GetStatus() & BUTTONS_BUTTON1) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1));
145
146 if (JoystickChanges & JOY_LEFT)
147 {
148 MIDICommand = ((JoystickStatus & JOY_LEFT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
149 MIDIPitch = 0x3C;
150 }
151 else if (JoystickChanges & JOY_UP)
152 {
153 MIDICommand = ((JoystickStatus & JOY_UP)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
154 MIDIPitch = 0x3D;
155 }
156 else if (JoystickChanges & JOY_RIGHT)
157 {
158 MIDICommand = ((JoystickStatus & JOY_RIGHT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
159 MIDIPitch = 0x3E;
160 }
161 else if (JoystickChanges & JOY_DOWN)
162 {
163 MIDICommand = ((JoystickStatus & JOY_DOWN)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
164 MIDIPitch = 0x3F;
165 }
166 else if (JoystickChanges & JOY_PRESS)
167 {
168 MIDICommand = ((JoystickStatus & JOY_PRESS)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
169 MIDIPitch = 0x3B;
170 }
171
172 if (MIDICommand)
173 {
174 MIDI_EventPacket_t MIDIEvent = (MIDI_EventPacket_t)
175 {
176 .Event = MIDI_EVENT(0, MIDICommand),
177
178 .Data1 = MIDICommand | Channel,
179 .Data2 = MIDIPitch,
180 .Data3 = MIDI_STANDARD_VELOCITY,
181 };
182
183 MIDI_Host_SendEventPacket(&Keyboard_MIDI_Interface, &MIDIEvent);
184 MIDI_Host_Flush(&Keyboard_MIDI_Interface);
185 }
186
187 PrevJoystickStatus = JoystickStatus;
188 }
189
190 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
191 * starts the library USB task to begin the enumeration and USB management process.
192 */
193 void EVENT_USB_Host_DeviceAttached(void)
194 {
195 puts_P(PSTR("Device Attached.\r\n"));
196 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
197 }
198
199 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
200 * stops the library USB task management process.
201 */
202 void EVENT_USB_Host_DeviceUnattached(void)
203 {
204 puts_P(PSTR("\r\nDevice Unattached.\r\n"));
205 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
206 }
207
208 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
209 * enumerated by the host and is now ready to be used by the application.
210 */
211 void EVENT_USB_Host_DeviceEnumerationComplete(void)
212 {
213 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
214
215 uint16_t ConfigDescriptorSize;
216 uint8_t ConfigDescriptorData[512];
217
218 if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
219 sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
220 {
221 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
222 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
223 return;
224 }
225
226 if (MIDI_Host_ConfigurePipes(&Keyboard_MIDI_Interface,
227 ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError)
228 {
229 puts_P(PSTR("Attached Device Not a Valid MIDI Class Device.\r\n"));
230 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
231 return;
232 }
233
234 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
235 {
236 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
237 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
238 return;
239 }
240
241 puts_P(PSTR("MIDI Device Enumerated.\r\n"));
242 LEDs_SetAllLEDs(LEDMASK_USB_READY);
243 }
244
245 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
246 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
247 {
248 USB_Disable();
249
250 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
251 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
252
253 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
254 for(;;);
255 }
256
257 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
258 * enumerating an attached USB device.
259 */
260 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
261 const uint8_t SubErrorCode)
262 {
263 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
264 " -- Error Code %d\r\n"
265 " -- Sub Error Code %d\r\n"
266 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
267
268 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
269 }
270