1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Universal MIDI Packet (UMP) Support 4 */ 5 #ifndef __SOUND_UMP_H 6 #define __SOUND_UMP_H 7 8 #include <sound/rawmidi.h> 9 10 struct snd_ump_endpoint; 11 struct snd_ump_block; 12 struct snd_ump_ops; 13 struct ump_cvt_to_ump; 14 struct snd_seq_ump_ops; 15 16 struct snd_ump_endpoint { 17 struct snd_rawmidi core; /* raw UMP access */ 18 19 struct snd_ump_endpoint_info info; 20 21 const struct snd_ump_ops *ops; /* UMP ops set by the driver */ 22 struct snd_rawmidi_substream *substreams[2]; /* opened substreams */ 23 24 void *private_data; 25 void (*private_free)(struct snd_ump_endpoint *ump); 26 27 /* UMP Stream message processing */ 28 u32 stream_wait_for; /* expected stream message status */ 29 bool stream_finished; /* set when message has been processed */ 30 bool parsed; /* UMP / FB parse finished? */ 31 bool no_process_stream; /* suppress UMP stream messages handling */ 32 wait_queue_head_t stream_wait; 33 struct snd_rawmidi_file stream_rfile; 34 35 struct list_head block_list; /* list of snd_ump_block objects */ 36 37 /* intermediate buffer for UMP input */ 38 u32 input_buf[4]; 39 int input_buf_head; 40 int input_pending; 41 42 struct mutex open_mutex; 43 44 #if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI) 45 spinlock_t legacy_locks[2]; 46 struct snd_rawmidi *legacy_rmidi; 47 struct snd_rawmidi_substream *legacy_substreams[2][SNDRV_UMP_MAX_GROUPS]; 48 49 /* for legacy output; need to open the actual substream unlike input */ 50 int legacy_out_opens; 51 struct snd_rawmidi_file legacy_out_rfile; 52 struct ump_cvt_to_ump *out_cvts; 53 #endif 54 55 #if IS_ENABLED(CONFIG_SND_SEQUENCER) 56 struct snd_seq_device *seq_dev; 57 const struct snd_seq_ump_ops *seq_ops; 58 void *seq_client; 59 #endif 60 }; 61 62 /* ops filled by UMP drivers */ 63 struct snd_ump_ops { 64 int (*open)(struct snd_ump_endpoint *ump, int dir); 65 void (*close)(struct snd_ump_endpoint *ump, int dir); 66 void (*trigger)(struct snd_ump_endpoint *ump, int dir, int up); 67 void (*drain)(struct snd_ump_endpoint *ump, int dir); 68 }; 69 70 /* ops filled by sequencer binding */ 71 struct snd_seq_ump_ops { 72 void (*input_receive)(struct snd_ump_endpoint *ump, 73 const u32 *data, int words); 74 int (*notify_fb_change)(struct snd_ump_endpoint *ump, 75 struct snd_ump_block *fb); 76 int (*switch_protocol)(struct snd_ump_endpoint *ump); 77 }; 78 79 struct snd_ump_block { 80 struct snd_ump_block_info info; 81 struct snd_ump_endpoint *ump; 82 83 void *private_data; 84 void (*private_free)(struct snd_ump_block *blk); 85 86 struct list_head list; 87 }; 88 89 #define rawmidi_to_ump(rmidi) container_of(rmidi, struct snd_ump_endpoint, core) 90 91 int snd_ump_endpoint_new(struct snd_card *card, char *id, int device, 92 int output, int input, 93 struct snd_ump_endpoint **ump_ret); 94 int snd_ump_parse_endpoint(struct snd_ump_endpoint *ump); 95 int snd_ump_block_new(struct snd_ump_endpoint *ump, unsigned int blk, 96 unsigned int direction, unsigned int first_group, 97 unsigned int num_groups, struct snd_ump_block **blk_ret); 98 int snd_ump_receive(struct snd_ump_endpoint *ump, const u32 *buffer, int count); 99 int snd_ump_transmit(struct snd_ump_endpoint *ump, u32 *buffer, int count); 100 101 #if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI) 102 int snd_ump_attach_legacy_rawmidi(struct snd_ump_endpoint *ump, 103 char *id, int device); 104 #else 105 static inline int snd_ump_attach_legacy_rawmidi(struct snd_ump_endpoint *ump, 106 char *id, int device) 107 { 108 return 0; 109 } 110 #endif 111 112 int snd_ump_switch_protocol(struct snd_ump_endpoint *ump, unsigned int protocol); 113 114 /* 115 * Some definitions for UMP 116 */ 117 118 /* MIDI 2.0 Message Type */ 119 enum { 120 UMP_MSG_TYPE_UTILITY = 0x00, 121 UMP_MSG_TYPE_SYSTEM = 0x01, 122 UMP_MSG_TYPE_MIDI1_CHANNEL_VOICE = 0x02, 123 UMP_MSG_TYPE_DATA = 0x03, 124 UMP_MSG_TYPE_MIDI2_CHANNEL_VOICE = 0x04, 125 UMP_MSG_TYPE_EXTENDED_DATA = 0x05, 126 UMP_MSG_TYPE_FLEX_DATA = 0x0d, 127 UMP_MSG_TYPE_STREAM = 0x0f, 128 }; 129 130 /* MIDI 2.0 SysEx / Data Status; same values for both 7-bit and 8-bit SysEx */ 131 enum { 132 UMP_SYSEX_STATUS_SINGLE = 0, 133 UMP_SYSEX_STATUS_START = 1, 134 UMP_SYSEX_STATUS_CONTINUE = 2, 135 UMP_SYSEX_STATUS_END = 3, 136 }; 137 138 /* UMP Utility Type Status (type 0x0) */ 139 enum { 140 UMP_UTILITY_MSG_STATUS_NOOP = 0x00, 141 UMP_UTILITY_MSG_STATUS_JR_CLOCK = 0x01, 142 UMP_UTILITY_MSG_STATUS_JR_TSTAMP = 0x02, 143 UMP_UTILITY_MSG_STATUS_DCTPQ = 0x03, 144 UMP_UTILITY_MSG_STATUS_DC = 0x04, 145 }; 146 147 /* UMP Stream Message Status (type 0xf) */ 148 enum { 149 UMP_STREAM_MSG_STATUS_EP_DISCOVERY = 0x00, 150 UMP_STREAM_MSG_STATUS_EP_INFO = 0x01, 151 UMP_STREAM_MSG_STATUS_DEVICE_INFO = 0x02, 152 UMP_STREAM_MSG_STATUS_EP_NAME = 0x03, 153 UMP_STREAM_MSG_STATUS_PRODUCT_ID = 0x04, 154 UMP_STREAM_MSG_STATUS_STREAM_CFG_REQUEST = 0x05, 155 UMP_STREAM_MSG_STATUS_STREAM_CFG = 0x06, 156 UMP_STREAM_MSG_STATUS_FB_DISCOVERY = 0x10, 157 UMP_STREAM_MSG_STATUS_FB_INFO = 0x11, 158 UMP_STREAM_MSG_STATUS_FB_NAME = 0x12, 159 UMP_STREAM_MSG_STATUS_START_CLIP = 0x20, 160 UMP_STREAM_MSG_STATUS_END_CLIP = 0x21, 161 }; 162 163 /* UMP Endpoint Discovery filter bitmap */ 164 enum { 165 UMP_STREAM_MSG_REQUEST_EP_INFO = (1U << 0), 166 UMP_STREAM_MSG_REQUEST_DEVICE_INFO = (1U << 1), 167 UMP_STREAM_MSG_REQUEST_EP_NAME = (1U << 2), 168 UMP_STREAM_MSG_REQUEST_PRODUCT_ID = (1U << 3), 169 UMP_STREAM_MSG_REQUEST_STREAM_CFG = (1U << 4), 170 }; 171 172 /* UMP Function Block Discovery filter bitmap */ 173 enum { 174 UMP_STREAM_MSG_REQUEST_FB_INFO = (1U << 0), 175 UMP_STREAM_MSG_REQUEST_FB_NAME = (1U << 1), 176 }; 177 178 /* UMP Endpoint Info capability bits (used for protocol request/notify, too) */ 179 enum { 180 UMP_STREAM_MSG_EP_INFO_CAP_TXJR = (1U << 0), /* Sending JRTS */ 181 UMP_STREAM_MSG_EP_INFO_CAP_RXJR = (1U << 1), /* Receiving JRTS */ 182 UMP_STREAM_MSG_EP_INFO_CAP_MIDI1 = (1U << 8), /* MIDI 1.0 */ 183 UMP_STREAM_MSG_EP_INFO_CAP_MIDI2 = (1U << 9), /* MIDI 2.0 */ 184 }; 185 186 /* UMP EP / FB name string format; same as SysEx string handling */ 187 enum { 188 UMP_STREAM_MSG_FORMAT_SINGLE = 0, 189 UMP_STREAM_MSG_FORMAT_START = 1, 190 UMP_STREAM_MSG_FORMAT_CONTINUE = 2, 191 UMP_STREAM_MSG_FORMAT_END = 3, 192 }; 193 194 /* 195 * Helpers for retrieving / filling bits from UMP 196 */ 197 /* get the message type (4bit) from a UMP packet (header) */ 198 static inline unsigned char ump_message_type(u32 data) 199 { 200 return data >> 28; 201 } 202 203 /* get the group number (0-based, 4bit) from a UMP packet (header) */ 204 static inline unsigned char ump_message_group(u32 data) 205 { 206 return (data >> 24) & 0x0f; 207 } 208 209 /* get the MIDI status code (4bit) from a UMP packet (header) */ 210 static inline unsigned char ump_message_status_code(u32 data) 211 { 212 return (data >> 20) & 0x0f; 213 } 214 215 /* get the MIDI channel number (0-based, 4bit) from a UMP packet (header) */ 216 static inline unsigned char ump_message_channel(u32 data) 217 { 218 return (data >> 16) & 0x0f; 219 } 220 221 /* get the MIDI status + channel combo byte (8bit) from a UMP packet (header) */ 222 static inline unsigned char ump_message_status_channel(u32 data) 223 { 224 return (data >> 16) & 0xff; 225 } 226 227 /* compose a UMP packet (header) from type, group and status values */ 228 static inline u32 ump_compose(unsigned char type, unsigned char group, 229 unsigned char status, unsigned char channel) 230 { 231 return ((u32)type << 28) | ((u32)group << 24) | ((u32)status << 20) | 232 ((u32)channel << 16); 233 } 234 235 /* get SysEx message status (for both 7 and 8bits) from a UMP packet (header) */ 236 static inline unsigned char ump_sysex_message_status(u32 data) 237 { 238 return (data >> 20) & 0xf; 239 } 240 241 /* get SysEx message length (for both 7 and 8bits) from a UMP packet (header) */ 242 static inline unsigned char ump_sysex_message_length(u32 data) 243 { 244 return (data >> 16) & 0xf; 245 } 246 247 /* For Stream Messages */ 248 static inline unsigned char ump_stream_message_format(u32 data) 249 { 250 return (data >> 26) & 0x03; 251 } 252 253 static inline unsigned int ump_stream_message_status(u32 data) 254 { 255 return (data >> 16) & 0x3ff; 256 } 257 258 static inline u32 ump_stream_compose(unsigned char status, unsigned short form) 259 { 260 return (UMP_MSG_TYPE_STREAM << 28) | ((u32)form << 26) | 261 ((u32)status << 16); 262 } 263 264 #define ump_is_groupless_msg(type) \ 265 ((type) == UMP_MSG_TYPE_UTILITY || (type) == UMP_MSG_TYPE_STREAM) 266 267 #endif /* __SOUND_UMP_H */ 268