162306a36Sopenharmony_ci/* SPDX-License-Identifier: GPL-2.0-or-later */ 262306a36Sopenharmony_ci/* 362306a36Sopenharmony_ci * Universal MIDI Packet (UMP) Support 462306a36Sopenharmony_ci */ 562306a36Sopenharmony_ci#ifndef __SOUND_UMP_H 662306a36Sopenharmony_ci#define __SOUND_UMP_H 762306a36Sopenharmony_ci 862306a36Sopenharmony_ci#include <sound/rawmidi.h> 962306a36Sopenharmony_ci 1062306a36Sopenharmony_cistruct snd_ump_endpoint; 1162306a36Sopenharmony_cistruct snd_ump_block; 1262306a36Sopenharmony_cistruct snd_ump_ops; 1362306a36Sopenharmony_cistruct ump_cvt_to_ump; 1462306a36Sopenharmony_cistruct snd_seq_ump_ops; 1562306a36Sopenharmony_ci 1662306a36Sopenharmony_cistruct snd_ump_endpoint { 1762306a36Sopenharmony_ci struct snd_rawmidi core; /* raw UMP access */ 1862306a36Sopenharmony_ci 1962306a36Sopenharmony_ci struct snd_ump_endpoint_info info; 2062306a36Sopenharmony_ci 2162306a36Sopenharmony_ci const struct snd_ump_ops *ops; /* UMP ops set by the driver */ 2262306a36Sopenharmony_ci struct snd_rawmidi_substream *substreams[2]; /* opened substreams */ 2362306a36Sopenharmony_ci 2462306a36Sopenharmony_ci void *private_data; 2562306a36Sopenharmony_ci void (*private_free)(struct snd_ump_endpoint *ump); 2662306a36Sopenharmony_ci 2762306a36Sopenharmony_ci /* UMP Stream message processing */ 2862306a36Sopenharmony_ci u32 stream_wait_for; /* expected stream message status */ 2962306a36Sopenharmony_ci bool stream_finished; /* set when message has been processed */ 3062306a36Sopenharmony_ci bool parsed; /* UMP / FB parse finished? */ 3162306a36Sopenharmony_ci bool no_process_stream; /* suppress UMP stream messages handling */ 3262306a36Sopenharmony_ci wait_queue_head_t stream_wait; 3362306a36Sopenharmony_ci struct snd_rawmidi_file stream_rfile; 3462306a36Sopenharmony_ci 3562306a36Sopenharmony_ci struct list_head block_list; /* list of snd_ump_block objects */ 3662306a36Sopenharmony_ci 3762306a36Sopenharmony_ci /* intermediate buffer for UMP input */ 3862306a36Sopenharmony_ci u32 input_buf[4]; 3962306a36Sopenharmony_ci int input_buf_head; 4062306a36Sopenharmony_ci int input_pending; 4162306a36Sopenharmony_ci 4262306a36Sopenharmony_ci struct mutex open_mutex; 4362306a36Sopenharmony_ci 4462306a36Sopenharmony_ci#if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI) 4562306a36Sopenharmony_ci spinlock_t legacy_locks[2]; 4662306a36Sopenharmony_ci struct snd_rawmidi *legacy_rmidi; 4762306a36Sopenharmony_ci struct snd_rawmidi_substream *legacy_substreams[2][SNDRV_UMP_MAX_GROUPS]; 4862306a36Sopenharmony_ci unsigned char legacy_mapping[SNDRV_UMP_MAX_GROUPS]; 4962306a36Sopenharmony_ci 5062306a36Sopenharmony_ci /* for legacy output; need to open the actual substream unlike input */ 5162306a36Sopenharmony_ci int legacy_out_opens; 5262306a36Sopenharmony_ci struct snd_rawmidi_file legacy_out_rfile; 5362306a36Sopenharmony_ci struct ump_cvt_to_ump *out_cvts; 5462306a36Sopenharmony_ci#endif 5562306a36Sopenharmony_ci 5662306a36Sopenharmony_ci#if IS_ENABLED(CONFIG_SND_SEQUENCER) 5762306a36Sopenharmony_ci struct snd_seq_device *seq_dev; 5862306a36Sopenharmony_ci const struct snd_seq_ump_ops *seq_ops; 5962306a36Sopenharmony_ci void *seq_client; 6062306a36Sopenharmony_ci#endif 6162306a36Sopenharmony_ci}; 6262306a36Sopenharmony_ci 6362306a36Sopenharmony_ci/* ops filled by UMP drivers */ 6462306a36Sopenharmony_cistruct snd_ump_ops { 6562306a36Sopenharmony_ci int (*open)(struct snd_ump_endpoint *ump, int dir); 6662306a36Sopenharmony_ci void (*close)(struct snd_ump_endpoint *ump, int dir); 6762306a36Sopenharmony_ci void (*trigger)(struct snd_ump_endpoint *ump, int dir, int up); 6862306a36Sopenharmony_ci void (*drain)(struct snd_ump_endpoint *ump, int dir); 6962306a36Sopenharmony_ci}; 7062306a36Sopenharmony_ci 7162306a36Sopenharmony_ci/* ops filled by sequencer binding */ 7262306a36Sopenharmony_cistruct snd_seq_ump_ops { 7362306a36Sopenharmony_ci void (*input_receive)(struct snd_ump_endpoint *ump, 7462306a36Sopenharmony_ci const u32 *data, int words); 7562306a36Sopenharmony_ci int (*notify_fb_change)(struct snd_ump_endpoint *ump, 7662306a36Sopenharmony_ci struct snd_ump_block *fb); 7762306a36Sopenharmony_ci int (*switch_protocol)(struct snd_ump_endpoint *ump); 7862306a36Sopenharmony_ci}; 7962306a36Sopenharmony_ci 8062306a36Sopenharmony_cistruct snd_ump_block { 8162306a36Sopenharmony_ci struct snd_ump_block_info info; 8262306a36Sopenharmony_ci struct snd_ump_endpoint *ump; 8362306a36Sopenharmony_ci 8462306a36Sopenharmony_ci void *private_data; 8562306a36Sopenharmony_ci void (*private_free)(struct snd_ump_block *blk); 8662306a36Sopenharmony_ci 8762306a36Sopenharmony_ci struct list_head list; 8862306a36Sopenharmony_ci}; 8962306a36Sopenharmony_ci 9062306a36Sopenharmony_ci#define rawmidi_to_ump(rmidi) container_of(rmidi, struct snd_ump_endpoint, core) 9162306a36Sopenharmony_ci 9262306a36Sopenharmony_ciint snd_ump_endpoint_new(struct snd_card *card, char *id, int device, 9362306a36Sopenharmony_ci int output, int input, 9462306a36Sopenharmony_ci struct snd_ump_endpoint **ump_ret); 9562306a36Sopenharmony_ciint snd_ump_parse_endpoint(struct snd_ump_endpoint *ump); 9662306a36Sopenharmony_ciint snd_ump_block_new(struct snd_ump_endpoint *ump, unsigned int blk, 9762306a36Sopenharmony_ci unsigned int direction, unsigned int first_group, 9862306a36Sopenharmony_ci unsigned int num_groups, struct snd_ump_block **blk_ret); 9962306a36Sopenharmony_ciint snd_ump_receive(struct snd_ump_endpoint *ump, const u32 *buffer, int count); 10062306a36Sopenharmony_ciint snd_ump_transmit(struct snd_ump_endpoint *ump, u32 *buffer, int count); 10162306a36Sopenharmony_ci 10262306a36Sopenharmony_ci#if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI) 10362306a36Sopenharmony_ciint snd_ump_attach_legacy_rawmidi(struct snd_ump_endpoint *ump, 10462306a36Sopenharmony_ci char *id, int device); 10562306a36Sopenharmony_ci#else 10662306a36Sopenharmony_cistatic inline int snd_ump_attach_legacy_rawmidi(struct snd_ump_endpoint *ump, 10762306a36Sopenharmony_ci char *id, int device) 10862306a36Sopenharmony_ci{ 10962306a36Sopenharmony_ci return 0; 11062306a36Sopenharmony_ci} 11162306a36Sopenharmony_ci#endif 11262306a36Sopenharmony_ci 11362306a36Sopenharmony_ciint snd_ump_receive_ump_val(struct snd_ump_endpoint *ump, u32 val); 11462306a36Sopenharmony_ciint snd_ump_switch_protocol(struct snd_ump_endpoint *ump, unsigned int protocol); 11562306a36Sopenharmony_ci 11662306a36Sopenharmony_ci/* 11762306a36Sopenharmony_ci * Some definitions for UMP 11862306a36Sopenharmony_ci */ 11962306a36Sopenharmony_ci 12062306a36Sopenharmony_ci/* MIDI 2.0 Message Type */ 12162306a36Sopenharmony_cienum { 12262306a36Sopenharmony_ci UMP_MSG_TYPE_UTILITY = 0x00, 12362306a36Sopenharmony_ci UMP_MSG_TYPE_SYSTEM = 0x01, 12462306a36Sopenharmony_ci UMP_MSG_TYPE_MIDI1_CHANNEL_VOICE = 0x02, 12562306a36Sopenharmony_ci UMP_MSG_TYPE_DATA = 0x03, 12662306a36Sopenharmony_ci UMP_MSG_TYPE_MIDI2_CHANNEL_VOICE = 0x04, 12762306a36Sopenharmony_ci UMP_MSG_TYPE_EXTENDED_DATA = 0x05, 12862306a36Sopenharmony_ci UMP_MSG_TYPE_FLEX_DATA = 0x0d, 12962306a36Sopenharmony_ci UMP_MSG_TYPE_STREAM = 0x0f, 13062306a36Sopenharmony_ci}; 13162306a36Sopenharmony_ci 13262306a36Sopenharmony_ci/* MIDI 2.0 SysEx / Data Status; same values for both 7-bit and 8-bit SysEx */ 13362306a36Sopenharmony_cienum { 13462306a36Sopenharmony_ci UMP_SYSEX_STATUS_SINGLE = 0, 13562306a36Sopenharmony_ci UMP_SYSEX_STATUS_START = 1, 13662306a36Sopenharmony_ci UMP_SYSEX_STATUS_CONTINUE = 2, 13762306a36Sopenharmony_ci UMP_SYSEX_STATUS_END = 3, 13862306a36Sopenharmony_ci}; 13962306a36Sopenharmony_ci 14062306a36Sopenharmony_ci/* UMP Utility Type Status (type 0x0) */ 14162306a36Sopenharmony_cienum { 14262306a36Sopenharmony_ci UMP_UTILITY_MSG_STATUS_NOOP = 0x00, 14362306a36Sopenharmony_ci UMP_UTILITY_MSG_STATUS_JR_CLOCK = 0x01, 14462306a36Sopenharmony_ci UMP_UTILITY_MSG_STATUS_JR_TSTAMP = 0x02, 14562306a36Sopenharmony_ci UMP_UTILITY_MSG_STATUS_DCTPQ = 0x03, 14662306a36Sopenharmony_ci UMP_UTILITY_MSG_STATUS_DC = 0x04, 14762306a36Sopenharmony_ci}; 14862306a36Sopenharmony_ci 14962306a36Sopenharmony_ci/* UMP Stream Message Status (type 0xf) */ 15062306a36Sopenharmony_cienum { 15162306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_EP_DISCOVERY = 0x00, 15262306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_EP_INFO = 0x01, 15362306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_DEVICE_INFO = 0x02, 15462306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_EP_NAME = 0x03, 15562306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_PRODUCT_ID = 0x04, 15662306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_STREAM_CFG_REQUEST = 0x05, 15762306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_STREAM_CFG = 0x06, 15862306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_FB_DISCOVERY = 0x10, 15962306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_FB_INFO = 0x11, 16062306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_FB_NAME = 0x12, 16162306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_START_CLIP = 0x20, 16262306a36Sopenharmony_ci UMP_STREAM_MSG_STATUS_END_CLIP = 0x21, 16362306a36Sopenharmony_ci}; 16462306a36Sopenharmony_ci 16562306a36Sopenharmony_ci/* UMP Endpoint Discovery filter bitmap */ 16662306a36Sopenharmony_cienum { 16762306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_EP_INFO = (1U << 0), 16862306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_DEVICE_INFO = (1U << 1), 16962306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_EP_NAME = (1U << 2), 17062306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_PRODUCT_ID = (1U << 3), 17162306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_STREAM_CFG = (1U << 4), 17262306a36Sopenharmony_ci}; 17362306a36Sopenharmony_ci 17462306a36Sopenharmony_ci/* UMP Function Block Discovery filter bitmap */ 17562306a36Sopenharmony_cienum { 17662306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_FB_INFO = (1U << 0), 17762306a36Sopenharmony_ci UMP_STREAM_MSG_REQUEST_FB_NAME = (1U << 1), 17862306a36Sopenharmony_ci}; 17962306a36Sopenharmony_ci 18062306a36Sopenharmony_ci/* UMP Endpoint Info capability bits (used for protocol request/notify, too) */ 18162306a36Sopenharmony_cienum { 18262306a36Sopenharmony_ci UMP_STREAM_MSG_EP_INFO_CAP_TXJR = (1U << 0), /* Sending JRTS */ 18362306a36Sopenharmony_ci UMP_STREAM_MSG_EP_INFO_CAP_RXJR = (1U << 1), /* Receiving JRTS */ 18462306a36Sopenharmony_ci UMP_STREAM_MSG_EP_INFO_CAP_MIDI1 = (1U << 8), /* MIDI 1.0 */ 18562306a36Sopenharmony_ci UMP_STREAM_MSG_EP_INFO_CAP_MIDI2 = (1U << 9), /* MIDI 2.0 */ 18662306a36Sopenharmony_ci}; 18762306a36Sopenharmony_ci 18862306a36Sopenharmony_ci/* UMP EP / FB name string format; same as SysEx string handling */ 18962306a36Sopenharmony_cienum { 19062306a36Sopenharmony_ci UMP_STREAM_MSG_FORMAT_SINGLE = 0, 19162306a36Sopenharmony_ci UMP_STREAM_MSG_FORMAT_START = 1, 19262306a36Sopenharmony_ci UMP_STREAM_MSG_FORMAT_CONTINUE = 2, 19362306a36Sopenharmony_ci UMP_STREAM_MSG_FORMAT_END = 3, 19462306a36Sopenharmony_ci}; 19562306a36Sopenharmony_ci 19662306a36Sopenharmony_ci/* 19762306a36Sopenharmony_ci * Helpers for retrieving / filling bits from UMP 19862306a36Sopenharmony_ci */ 19962306a36Sopenharmony_ci/* get the message type (4bit) from a UMP packet (header) */ 20062306a36Sopenharmony_cistatic inline unsigned char ump_message_type(u32 data) 20162306a36Sopenharmony_ci{ 20262306a36Sopenharmony_ci return data >> 28; 20362306a36Sopenharmony_ci} 20462306a36Sopenharmony_ci 20562306a36Sopenharmony_ci/* get the group number (0-based, 4bit) from a UMP packet (header) */ 20662306a36Sopenharmony_cistatic inline unsigned char ump_message_group(u32 data) 20762306a36Sopenharmony_ci{ 20862306a36Sopenharmony_ci return (data >> 24) & 0x0f; 20962306a36Sopenharmony_ci} 21062306a36Sopenharmony_ci 21162306a36Sopenharmony_ci/* get the MIDI status code (4bit) from a UMP packet (header) */ 21262306a36Sopenharmony_cistatic inline unsigned char ump_message_status_code(u32 data) 21362306a36Sopenharmony_ci{ 21462306a36Sopenharmony_ci return (data >> 20) & 0x0f; 21562306a36Sopenharmony_ci} 21662306a36Sopenharmony_ci 21762306a36Sopenharmony_ci/* get the MIDI channel number (0-based, 4bit) from a UMP packet (header) */ 21862306a36Sopenharmony_cistatic inline unsigned char ump_message_channel(u32 data) 21962306a36Sopenharmony_ci{ 22062306a36Sopenharmony_ci return (data >> 16) & 0x0f; 22162306a36Sopenharmony_ci} 22262306a36Sopenharmony_ci 22362306a36Sopenharmony_ci/* get the MIDI status + channel combo byte (8bit) from a UMP packet (header) */ 22462306a36Sopenharmony_cistatic inline unsigned char ump_message_status_channel(u32 data) 22562306a36Sopenharmony_ci{ 22662306a36Sopenharmony_ci return (data >> 16) & 0xff; 22762306a36Sopenharmony_ci} 22862306a36Sopenharmony_ci 22962306a36Sopenharmony_ci/* compose a UMP packet (header) from type, group and status values */ 23062306a36Sopenharmony_cistatic inline u32 ump_compose(unsigned char type, unsigned char group, 23162306a36Sopenharmony_ci unsigned char status, unsigned char channel) 23262306a36Sopenharmony_ci{ 23362306a36Sopenharmony_ci return ((u32)type << 28) | ((u32)group << 24) | ((u32)status << 20) | 23462306a36Sopenharmony_ci ((u32)channel << 16); 23562306a36Sopenharmony_ci} 23662306a36Sopenharmony_ci 23762306a36Sopenharmony_ci/* get SysEx message status (for both 7 and 8bits) from a UMP packet (header) */ 23862306a36Sopenharmony_cistatic inline unsigned char ump_sysex_message_status(u32 data) 23962306a36Sopenharmony_ci{ 24062306a36Sopenharmony_ci return (data >> 20) & 0xf; 24162306a36Sopenharmony_ci} 24262306a36Sopenharmony_ci 24362306a36Sopenharmony_ci/* get SysEx message length (for both 7 and 8bits) from a UMP packet (header) */ 24462306a36Sopenharmony_cistatic inline unsigned char ump_sysex_message_length(u32 data) 24562306a36Sopenharmony_ci{ 24662306a36Sopenharmony_ci return (data >> 16) & 0xf; 24762306a36Sopenharmony_ci} 24862306a36Sopenharmony_ci 24962306a36Sopenharmony_ci/* For Stream Messages */ 25062306a36Sopenharmony_cistatic inline unsigned char ump_stream_message_format(u32 data) 25162306a36Sopenharmony_ci{ 25262306a36Sopenharmony_ci return (data >> 26) & 0x03; 25362306a36Sopenharmony_ci} 25462306a36Sopenharmony_ci 25562306a36Sopenharmony_cistatic inline unsigned int ump_stream_message_status(u32 data) 25662306a36Sopenharmony_ci{ 25762306a36Sopenharmony_ci return (data >> 16) & 0x3ff; 25862306a36Sopenharmony_ci} 25962306a36Sopenharmony_ci 26062306a36Sopenharmony_cistatic inline u32 ump_stream_compose(unsigned char status, unsigned short form) 26162306a36Sopenharmony_ci{ 26262306a36Sopenharmony_ci return (UMP_MSG_TYPE_STREAM << 28) | ((u32)form << 26) | 26362306a36Sopenharmony_ci ((u32)status << 16); 26462306a36Sopenharmony_ci} 26562306a36Sopenharmony_ci 26662306a36Sopenharmony_ci#define ump_is_groupless_msg(type) \ 26762306a36Sopenharmony_ci ((type) == UMP_MSG_TYPE_UTILITY || (type) == UMP_MSG_TYPE_STREAM) 26862306a36Sopenharmony_ci 26962306a36Sopenharmony_ci#endif /* __SOUND_UMP_H */ 270