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