Minor documentation cleanups.
[pub/USBasp.git] / Demos / Host / LowLevel / MIDIHost / MIDIHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 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 *
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 /** Main program entry point. This routine configures the hardware required by the application, then
40 * enters a loop to run the application tasks in sequence.
41 */
42 int main(void)
43 {
44 SetupHardware();
45
46 puts_P(PSTR(ESC_FG_CYAN "MIDI Host Demo running.\r\n" ESC_FG_WHITE));
47
48 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
49 sei();
50
51 for (;;)
52 {
53 MIDI_Host_Task();
54 USB_USBTask();
55 }
56 }
57
58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
59 void SetupHardware(void)
60 {
61 /* Disable watchdog if enabled by bootloader/fuses */
62 MCUSR &= ~(1 << WDRF);
63 wdt_disable();
64
65 /* Disable clock division */
66 clock_prescale_set(clock_div_1);
67
68 /* Hardware Initialization */
69 SerialStream_Init(9600, false);
70 LEDs_Init();
71 Buttons_Init();
72 Joystick_Init();
73 USB_Init();
74 }
75
76 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
77 * starts the library USB task to begin the enumeration and USB management process.
78 */
79 void EVENT_USB_Host_DeviceAttached(void)
80 {
81 puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
82 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
83 }
84
85 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
86 * stops the library USB task management process.
87 */
88 void EVENT_USB_Host_DeviceUnattached(void)
89 {
90 puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
91 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
92 }
93
94 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
95 * enumerated by the host and is now ready to be used by the application.
96 */
97 void EVENT_USB_Host_DeviceEnumerationComplete(void)
98 {
99 LEDs_SetAllLEDs(LEDMASK_USB_READY);
100 }
101
102 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
103 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
104 {
105 USB_ShutDown();
106
107 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
108 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
109
110 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
111 for(;;);
112 }
113
114 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
115 * enumerating an attached USB device.
116 */
117 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
118 {
119 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
120 " -- Error Code %d\r\n"
121 " -- Sub Error Code %d\r\n"
122 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
123
124 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
125 }
126
127 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
128 * note on/off messages from the attached MIDI device and print it to the serial port. When the board
129 * joystick or buttons are pressed, note on/off messages are sent to the attached device.
130 */
131 void MIDI_Host_Task(void)
132 {
133 uint8_t ErrorCode;
134
135 switch (USB_HostState)
136 {
137 case HOST_STATE_Addressed:
138 puts_P(PSTR("Getting Config Data.\r\n"));
139
140 /* Get and process the configuration descriptor data */
141 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
142 {
143 if (ErrorCode == ControlError)
144 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
145 else
146 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
147
148 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
149
150 /* Indicate error via status LEDs */
151 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
152
153 /* Wait until USB device disconnected */
154 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
155 break;
156 }
157
158 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
159 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
160 {
161 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
162 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
163
164 /* Indicate error via status LEDs */
165 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
166
167 /* Wait until USB device disconnected */
168 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
169 break;
170 }
171
172 puts_P(PSTR("MIDI Device Enumerated.\r\n"));
173
174 USB_HostState = HOST_STATE_Configured;
175 break;
176 case HOST_STATE_Configured:
177 Pipe_SelectPipe(MIDI_DATAPIPE_IN);
178
179 if (Pipe_IsINReceived())
180 {
181 USB_MIDI_EventPacket_t MIDIEvent;
182
183 Pipe_Read_Stream_LE(&MIDIEvent, sizeof(MIDIEvent));
184
185 bool NoteOnEvent = ((MIDIEvent.Command & 0x0F) == (MIDI_COMMAND_NOTE_ON >> 4));
186 bool NoteOffEvent = ((MIDIEvent.Command & 0x0F) == (MIDI_COMMAND_NOTE_OFF >> 4));
187
188 if (NoteOnEvent || NoteOffEvent)
189 {
190 printf_P(PSTR("MIDI Note %s - Channel %d, Pitch %d, Velocity %d\r\n"), NoteOnEvent ? "On" : "Off",
191 ((MIDIEvent.Data1 & 0x0F) + 1),
192 MIDIEvent.Data2, MIDIEvent.Data3);
193 }
194
195 Pipe_ClearIN();
196 }
197
198 Pipe_SelectPipe(MIDI_DATAPIPE_OUT);
199
200 static uint8_t PrevJoystickStatus;
201
202 if (Pipe_IsOUTReady())
203 {
204 uint8_t MIDICommand = 0;
205 uint8_t MIDIPitch;
206
207 uint8_t JoystickStatus = Joystick_GetStatus();
208 uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus);
209
210 /* Get board button status - if pressed use channel 10 (percussion), otherwise use channel 1 */
211 uint8_t Channel = ((Buttons_GetStatus() & BUTTONS_BUTTON1) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1));
212
213 if (JoystickChanges & JOY_LEFT)
214 {
215 MIDICommand = ((JoystickStatus & JOY_LEFT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
216 MIDIPitch = 0x3C;
217 }
218
219 if (JoystickChanges & JOY_UP)
220 {
221 MIDICommand = ((JoystickStatus & JOY_UP)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
222 MIDIPitch = 0x3D;
223 }
224
225 if (JoystickChanges & JOY_RIGHT)
226 {
227 MIDICommand = ((JoystickStatus & JOY_RIGHT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
228 MIDIPitch = 0x3E;
229 }
230
231 if (JoystickChanges & JOY_DOWN)
232 {
233 MIDICommand = ((JoystickStatus & JOY_DOWN)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
234 MIDIPitch = 0x3F;
235 }
236
237 if (JoystickChanges & JOY_PRESS)
238 {
239 MIDICommand = ((JoystickStatus & JOY_PRESS)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
240 MIDIPitch = 0x3B;
241 }
242
243 /* Check if a MIDI command is to be sent */
244 if (MIDICommand)
245 {
246 USB_MIDI_EventPacket_t MIDIEvent = (USB_MIDI_EventPacket_t)
247 {
248 .CableNumber = 0,
249 .Command = (MIDICommand >> 4),
250
251 .Data1 = MIDICommand | Channel,
252 .Data2 = MIDIPitch,
253 .Data3 = MIDI_STANDARD_VELOCITY,
254 };
255
256 /* Write the MIDI event packet to the pipe */
257 Pipe_Write_Stream_LE(&MIDIEvent, sizeof(MIDIEvent));
258
259 /* Send the data in the pipe to the device */
260 Pipe_ClearOUT();
261 }
262
263 /* Save previous joystick value for next joystick change detection */
264 PrevJoystickStatus = JoystickStatus;
265 }
266
267 break;
268 }
269 }