circuitpython/shared-module/usb_midi/__init__.c

228 lines
9.4 KiB
C
Raw Normal View History

/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2018 hathach for Adafruit Industries
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#include "shared-bindings/usb_midi/__init__.h"
#include "genhdr/autogen_usb_descriptor.h"
#include "py/obj.h"
#include "py/mphal.h"
#include "py/runtime.h"
#include "py/objtuple.h"
#include "shared-bindings/usb_midi/PortIn.h"
#include "shared-bindings/usb_midi/PortOut.h"
#include "supervisor/memory.h"
#include "tusb.h"
2021-03-15 09:57:36 -04:00
supervisor_allocation *usb_midi_allocation;
2021-04-20 22:20:34 -04:00
static const uint8_t usb_midi_descriptor_template[] = {
// Audio Interface Descriptor
0x09, // 0 bLength
0x04, // 1 bDescriptorType (Interface)
0xFF, // 2 bInterfaceNumber [SET AT RUNTIME]
#define MIDI_AUDIO_CONTROL_INTERFACE_NUMBER_INDEX 2
0x00, // 3 bAlternateSetting
0x00, // 4 bNumEndpoints 0
0x01, // 5 bInterfaceClass (Audio)
0x01, // 6 bInterfaceSubClass (Audio Control)
0x00, // 7 bInterfaceProtocol
0xFF, // 8 iInterface (String Index) [SET AT RUNTIME]
#define MIDI_AUDIO_CONTROL_INTERFACE_STRING_INDEX 8
// Audio10 Control Interface Descriptor
0x09, // 9 bLength
0x24, // 10 bDescriptorType (See Next Line)
0x01, // 11 bDescriptorSubtype (CS_INTERFACE -> HEADER)
0x00, 0x01, // 12,13 bcdADC 1.00
0x09, 0x00, // 14,15 wTotalLength 9
0x01, // 16 binCollection 0x01
0xFF, // 17 baInterfaceNr [SET AT RUNTIME: one-element list: same as 20]
#define MIDI_STREAMING_INTERFACE_NUMBER_INDEX_2 17
// MIDI Streaming Interface Descriptor
0x09, // 18 bLength
0x04, // 19 bDescriptorType (Interface)
0xFF, // 20 bInterfaceNumber [SET AT RUNTIME]
#define MIDI_STREAMING_INTERFACE_NUMBER_INDEX 20
0x00, // 21 bAlternateSetting
0x02, // 22 bNumEndpoints 2
0x01, // 23 bInterfaceClass (Audio)
0x03, // 24 bInterfaceSubClass (MIDI Streaming)
0x00, // 25 bInterfaceProtocol
0xFF, // 26 iInterface (String Index) [SET AT RUNTIME]
#define MIDI_STREAMING_INTERFACE_STRING_INDEX 26
// MIDI Header Descriptor
0x07, // 27 bLength
0x24, // 28 bDescriptorType: CLASS SPECIFIC INTERFACE
0x01, // 29 bDescriptorSubtype: MIDI STREAMING HEADER
0x00, 0x01, // 30,31 bsdMSC (MIDI STREAMING) version 1.0
0x25, 0x00 // 32,33 wLength
// MIDI Embedded In Jack Descriptor
0x06, // 34 bLength
0x24, // 35 bDescriptorType: CLASS SPECIFIC INTERFACE
0x02, // 36 bDescriptorSubtype: MIDI IN JACK
0x01, // 37 bJackType: EMBEDDED
0x01, // 38 id (always 1)
0xFF, // 39 iJack (String Index) [SET AT RUNTIME]
#define MIDI_IN_JACK_STRING_INDEX 39
// MIDI External In Jack Descriptor
0x06, // 40 bLength
2021-04-20 22:20:34 -04:00
0x24, // 41 bDescriptorType: CLASS SPECIFIC INTERFACE
0x02, // 42 bDescriptorSubtype: MIDI IN JACK
0x02, // 43 bJackType: EXTERNAL
0x02, // 44 bJackId (always 2)
0x00, // 45 iJack (String Index)
// MIDI Embedded Out Jack Descriptor
0x09, // 46 bLength
2021-04-20 22:20:34 -04:00
0x24, // 47 bDescriptorType: CLASS SPECIFIC INTERFACE
0x03, // 48 bDescriptorSubtype: MIDI OUT JACK
0x01, // 49 bJackType: EMBEDDED
0x03, // 50 bJackID (always 3)
0x01, // 51 bNrInputPins (always 1)
0x02, // 52 BaSourceID(1) (always 2)
0x01, // 53 BaSourcePin(1) (always 1)
0xFF, // 54 iJack (String Index) [SET AT RUNTIME]
#define MIDI_OUT_JACK_STRING_INDEX 54
// MIDI External Out Jack Descriptor
0x09, // 55 bLength
0x24, // 56 bDescriptorType: CLASS SPECIFIC INTERFACE
0x03, // 57 bDescriptorSubtype: MIDI OUT JACK
0x02, // 58 bJackType: EXTERNAL
0x04, // 59 bJackID (always 4)
0x01, // 60 bNrInputPins (always 1)
0x01, // 61 BaSourceID(1) (always 1)
0x01, // 62 BaSourcePin(1) (always 1)
0x00, // 63 iJack (String Index)
// MIDI Streaming Endpoint OUT Descriptor
0x07, // 64 bLength
0x05, // 65 bDescriptorType (EndPoint)
0xFF, // 66 bEndpointAddress (OUT/H2D) [SET AT RUNTIME]
#define MIDI_STREAMING_OUT_ENDPOINT_INDEX 66
0x02, // 67 bmAttributes (Bulk)
0x40, 0x00, // 68,69 wMaxPacketSize 64
0x00, // 70 bInterval 0 (unit depends on device speed)
// MIDI Data Endpoint Descriptor
0x05, // 71 bLength
0x25, // 72 bDescriptorType: CLASS SPECIFIC ENDPOINT
0x01, // 73 bDescriptorSubtype: MIDI STREAMING 1.0
0x01, // 74 bNumGrpTrmBlock (always 1)
0x01, // 75 baAssoGrpTrmBlkID(1) (always 1)
// MIDI IN Data Endpoint
0x07, // 76 bLength
0x05, // 77 bDescriptorType: Endpoint
0xFF, // 78 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x8 | number]
#define MIDI_STREAMING_IN_ENDPOINT_INDEX 78
0x02, // 79 bmAttributes (Bulk)
0x40, 0x00, // 8081 wMaxPacketSize 64
0x00, // 82 bInterval 0 (unit depends on device speed)
// MIDI Data Endpoint Descriptor
0x05, // 83 bLength
0x25, // 84 bDescriptorType: CLASS SPECIFIC ENDPOINT
0x01, // 85 bDescriptorSubtype: MIDI STREAMING 1.0
0x01, // 86 bNumGrpTrmBlock (always 1)
0x03, // 87 baAssoGrpTrmBlkID(1) (always 3)
};
// Is the USB MIDI device enabled?
bool usb_midi_enabled;
2021-04-20 22:20:34 -04:00
size_t usb_midi_descriptor_length(void) {
return sizeof(usb_midi_descriptor_template);
}
2021-04-20 22:20:34 -04:00
size_t usb_midi_add_descriptor(uint8_t *descriptor_buf,
uint8_t audio_control_interface, uint8_t midi_streaming_interface, uint8_t midi_streaming_in_endpoint, uint8_t midi_streaming_out_endpoint, uint8_t audio_control_interface_string, uint8_t midi_streaming_interface_string, uint8_t in_jack_string, uint8_t out_jack_string) {
memcpy(descriptor_buf, usb_midi_descriptor_template, sizeof(usb_midi_descriptor_template));
descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_NUMBER_INDEX] = audio_control_interface_number;
descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_STRING_INDEX] = audio_control_interface_string;
2021-04-20 22:20:34 -04:00
descriptor_buf[MSC_IN_ENDPOINT_INDEX] = midi_streaming_in_endpoint;
descriptor_buf[MSC_OUT_ENDPOINT_INDEX] = 0x80 | midi_streaming_out_endpoint;
2021-04-20 22:20:34 -04:00
descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX] = midi_streaming_interface_number;
descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX_2] = midi_streaming_interface_number;
descriptor_buf[MIDI_STREAMING_INTERFACE_STRING_INDEX] = midi_streaming_interface_string;
2021-04-20 22:20:34 -04:00
descriptor_buf[MIDI_IN_JACK_STRING_INDEX] = in_jack_string;
descriptor_buf[MIDI_OUT_JACK_STRING_INDEX] = out_jack_string;
2021-04-20 22:20:34 -04:00
return sizeof(usb_midi_descriptor_template);
}
void usb_midi_init(void) {
usb_midi_enabled = true;
}
void usb_midi_usb_init(void) {
mp_obj_tuple_t *ports;
if (usb_midi_enabled) {
// TODO(tannewt): Make this dynamic.
size_t tuple_size = align32_size(sizeof(mp_obj_tuple_t) + sizeof(mp_obj_t *) * 2);
size_t portin_size = align32_size(sizeof(usb_midi_portin_obj_t));
size_t portout_size = align32_size(sizeof(usb_midi_portout_obj_t));
// For each embedded MIDI Jack in the descriptor we create a Port
usb_midi_allocation = allocate_memory(tuple_size + portin_size + portout_size, false, false);
ports = (mp_obj_tuple_t *)usb_midi_allocation->ptr;
ports->base.type = &mp_type_tuple;
ports->len = 2;
usb_midi_portin_obj_t *in = (usb_midi_portin_obj_t *)(usb_midi_allocation->ptr + tuple_size / 4);
in->base.type = &usb_midi_portin_type;
ports->items[0] = MP_OBJ_FROM_PTR(in);
usb_midi_portout_obj_t *out = (usb_midi_portout_obj_t *)(usb_midi_allocation->ptr + tuple_size / 4 + portin_size / 4);
out->base.type = &usb_midi_portout_type;
ports->items[1] = MP_OBJ_FROM_PTR(out);
} else {
ports = mp_const_empty_tuple;
}
mp_map_lookup(&usb_midi_module_globals.map, MP_ROM_QSTR(MP_QSTR_ports), MP_MAP_LOOKUP)->value = MP_OBJ_FROM_PTR(ports);
}
2021-04-14 22:10:09 -04:00
bool common_hal_usb_midi_configure_usb(bool enabled) {
// We can't change the descriptors once we're connected.
2021-04-14 22:10:09 -04:00
if (tud_connected()) {
return false;
}
usb_midi_enabled = enabled;
return true;
}