summaryrefslogtreecommitdiff
path: root/include/arch/x86_64/linux/usb/midi.h
blob: e8da478fe8787ac0358997f6a3888e5be03fc969 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * <linux/usb/midi.h> -- USB MIDI definitions.
 *
 * Copyright (C) 2006 Thumtronics Pty Ltd.
 * Developed for Thumtronics by Grey Innovation
 * Ben Williamson <ben.williamson@greyinnovation.com>
 *
 * This software is distributed under the terms of the GNU General Public
 * License ("GPL") version 2, as published by the Free Software Foundation.
 *
 * This file holds USB constants and structures defined
 * by the USB Device Class Definition for MIDI Devices.
 * Comments below reference relevant sections of that document:
 *
 * http://www.usb.org/developers/devclass_docs/midi10.pdf
 */

#ifndef __LINUX_USB_MIDI_H
#define __LINUX_USB_MIDI_H

#include <linux/types.h>

/* A.1  MS Class-Specific Interface Descriptor Subtypes */
#define USB_MS_HEADER	     0x01
#define USB_MS_MIDI_IN_JACK  0x02
#define USB_MS_MIDI_OUT_JACK 0x03
#define USB_MS_ELEMENT	     0x04

/* A.2  MS Class-Specific Endpoint Descriptor Subtypes */
#define USB_MS_GENERAL 0x01

/* A.3  MS MIDI IN and OUT Jack Types */
#define USB_MS_EMBEDDED 0x01
#define USB_MS_EXTERNAL 0x02

/* 6.1.2.1  Class-Specific MS Interface Header Descriptor */
struct usb_ms_header_descriptor {
	__u8 bLength;
	__u8 bDescriptorType;
	__u8 bDescriptorSubtype;
	__le16 bcdMSC;
	__le16 wTotalLength;
} __attribute__((packed));

#define USB_DT_MS_HEADER_SIZE 7

/* 6.1.2.2  MIDI IN Jack Descriptor */
struct usb_midi_in_jack_descriptor {
	__u8 bLength;
	__u8 bDescriptorType;	 /* USB_DT_CS_INTERFACE */
	__u8 bDescriptorSubtype; /* USB_MS_MIDI_IN_JACK */
	__u8 bJackType;		 /* USB_MS_EMBEDDED/EXTERNAL */
	__u8 bJackID;
	__u8 iJack;
} __attribute__((packed));

#define USB_DT_MIDI_IN_SIZE 6

struct usb_midi_source_pin {
	__u8 baSourceID;
	__u8 baSourcePin;
} __attribute__((packed));

/* 6.1.2.3  MIDI OUT Jack Descriptor */
struct usb_midi_out_jack_descriptor {
	__u8 bLength;
	__u8 bDescriptorType;	 /* USB_DT_CS_INTERFACE */
	__u8 bDescriptorSubtype; /* USB_MS_MIDI_OUT_JACK */
	__u8 bJackType;		 /* USB_MS_EMBEDDED/EXTERNAL */
	__u8 bJackID;
	__u8 bNrInputPins;		   /* p */
	struct usb_midi_source_pin pins[]; /* [p] */
	/*__u8  iJack;  -- omitted due to variable-sized pins[] */
} __attribute__((packed));

#define USB_DT_MIDI_OUT_SIZE(p) (7 + 2 * (p))

/* As above, but more useful for defining your own descriptors: */
#define DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(p)     \
	struct usb_midi_out_jack_descriptor_##p {   \
		__u8 bLength;                       \
		__u8 bDescriptorType;               \
		__u8 bDescriptorSubtype;            \
		__u8 bJackType;                     \
		__u8 bJackID;                       \
		__u8 bNrInputPins;                  \
		struct usb_midi_source_pin pins[p]; \
		__u8 iJack;                         \
	} __attribute__((packed))

/* 6.2.2  Class-Specific MS Bulk Data Endpoint Descriptor */
struct usb_ms_endpoint_descriptor {
	__u8 bLength;		 /* 4+n */
	__u8 bDescriptorType;	 /* USB_DT_CS_ENDPOINT */
	__u8 bDescriptorSubtype; /* USB_MS_GENERAL */
	__u8 bNumEmbMIDIJack;	 /* n */
	__u8 baAssocJackID[];	 /* [n] */
} __attribute__((packed));

#define USB_DT_MS_ENDPOINT_SIZE(n) (4 + (n))

/* As above, but more useful for defining your own descriptors: */
#define DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(n)   \
	struct usb_ms_endpoint_descriptor_##n { \
		__u8 bLength;                   \
		__u8 bDescriptorType;           \
		__u8 bDescriptorSubtype;        \
		__u8 bNumEmbMIDIJack;           \
		__u8 baAssocJackID[n];          \
	} __attribute__((packed))

#endif /* __LINUX_USB_MIDI_H */