11a59d1b8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 21da177e4SLinus Torvalds #ifndef __SOUND_RAWMIDI_H 31da177e4SLinus Torvalds #define __SOUND_RAWMIDI_H 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds /* 61da177e4SLinus Torvalds * Abstract layer for MIDI v1.0 stream 7c1017a4cSJaroslav Kysela * Copyright (c) by Jaroslav Kysela <perex@perex.cz> 81da177e4SLinus Torvalds */ 91da177e4SLinus Torvalds 101da177e4SLinus Torvalds #include <sound/asound.h> 111da177e4SLinus Torvalds #include <linux/interrupt.h> 121da177e4SLinus Torvalds #include <linux/spinlock.h> 131da177e4SLinus Torvalds #include <linux/wait.h> 141a60d4c5SIngo Molnar #include <linux/mutex.h> 15b3c705aaSTakashi Iwai #include <linux/workqueue.h> 16aee5012fSTakashi Iwai #include <linux/device.h> 171da177e4SLinus Torvalds 186d2412b8STakashi Iwai #if IS_ENABLED(CONFIG_SND_SEQUENCER) 19a1ce3928SDavid Howells #include <sound/seq_device.h> 201da177e4SLinus Torvalds #endif 21*fa030f66STakashi Iwai #include <sound/info.h> 221da177e4SLinus Torvalds 231da177e4SLinus Torvalds /* 241da177e4SLinus Torvalds * Raw MIDI interface 251da177e4SLinus Torvalds */ 261da177e4SLinus Torvalds 271da177e4SLinus Torvalds #define SNDRV_RAWMIDI_DEVICES 8 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_OUTPUT (1<<0) 301da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_INPUT (1<<1) 311da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_OPEN (3<<0) 321da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_APPEND (1<<2) 331da177e4SLinus Torvalds 3448c9d417STakashi Iwai struct snd_rawmidi; 3548c9d417STakashi Iwai struct snd_rawmidi_substream; 36a7b928acSClemens Ladisch struct snd_seq_port_info; 377584af10SClemens Ladisch struct pid; 381da177e4SLinus Torvalds 3948c9d417STakashi Iwai struct snd_rawmidi_ops { 4048c9d417STakashi Iwai int (*open) (struct snd_rawmidi_substream * substream); 4148c9d417STakashi Iwai int (*close) (struct snd_rawmidi_substream * substream); 4248c9d417STakashi Iwai void (*trigger) (struct snd_rawmidi_substream * substream, int up); 4348c9d417STakashi Iwai void (*drain) (struct snd_rawmidi_substream * substream); 4448c9d417STakashi Iwai }; 451da177e4SLinus Torvalds 4648c9d417STakashi Iwai struct snd_rawmidi_global_ops { 4748c9d417STakashi Iwai int (*dev_register) (struct snd_rawmidi * rmidi); 4848c9d417STakashi Iwai int (*dev_unregister) (struct snd_rawmidi * rmidi); 49a7b928acSClemens Ladisch void (*get_port_info)(struct snd_rawmidi *rmidi, int number, 50a7b928acSClemens Ladisch struct snd_seq_port_info *info); 51fb3bd121STakashi Iwai long (*ioctl)(struct snd_rawmidi *rmidi, unsigned int cmd, 52fb3bd121STakashi Iwai void __user *argp); 53*fa030f66STakashi Iwai void (*proc_read)(struct snd_info_entry *entry, 54*fa030f66STakashi Iwai struct snd_info_buffer *buf); 5548c9d417STakashi Iwai }; 561da177e4SLinus Torvalds 5748c9d417STakashi Iwai struct snd_rawmidi_runtime { 58b3c705aaSTakashi Iwai struct snd_rawmidi_substream *substream; 591da177e4SLinus Torvalds unsigned int drain: 1, /* drain stage */ 601da177e4SLinus Torvalds oss: 1; /* OSS compatible mode */ 611da177e4SLinus Torvalds /* midi stream buffer */ 621da177e4SLinus Torvalds unsigned char *buffer; /* buffer for MIDI data */ 631da177e4SLinus Torvalds size_t buffer_size; /* size of buffer */ 641da177e4SLinus Torvalds size_t appl_ptr; /* application pointer */ 651da177e4SLinus Torvalds size_t hw_ptr; /* hardware pointer */ 661da177e4SLinus Torvalds size_t avail_min; /* min avail for wakeup */ 671da177e4SLinus Torvalds size_t avail; /* max used buffer for wakeup */ 681da177e4SLinus Torvalds size_t xruns; /* over/underruns counter */ 69e3a8a5b7STakashi Iwai size_t align; /* alignment (0 = byte stream, 3 = UMP) */ 70c1f6e3c8STakashi Iwai int buffer_ref; /* buffer reference count */ 711da177e4SLinus Torvalds /* misc */ 721da177e4SLinus Torvalds wait_queue_head_t sleep; 731da177e4SLinus Torvalds /* event handler (new bytes, input only) */ 7448c9d417STakashi Iwai void (*event)(struct snd_rawmidi_substream *substream); 751da177e4SLinus Torvalds /* defers calls to event [input] or ops->trigger [output] */ 76b3c705aaSTakashi Iwai struct work_struct event_work; 771da177e4SLinus Torvalds /* private data */ 781da177e4SLinus Torvalds void *private_data; 7948c9d417STakashi Iwai void (*private_free)(struct snd_rawmidi_substream *substream); 801da177e4SLinus Torvalds }; 811da177e4SLinus Torvalds 8248c9d417STakashi Iwai struct snd_rawmidi_substream { 831da177e4SLinus Torvalds struct list_head list; /* list of all substream for given stream */ 841da177e4SLinus Torvalds int stream; /* direction */ 851da177e4SLinus Torvalds int number; /* substream number */ 86dfa9a5efSTakashi Iwai bool opened; /* open flag */ 87dfa9a5efSTakashi Iwai bool append; /* append flag (merge more streams) */ 88dfa9a5efSTakashi Iwai bool active_sensing; /* send active sensing when close */ 8908fdced6SDavid Henningsson unsigned int framing; /* whether to frame input data */ 9008fdced6SDavid Henningsson unsigned int clock_type; /* clock source to use for input framing */ 911da177e4SLinus Torvalds int use_count; /* use counter (for output) */ 921da177e4SLinus Torvalds size_t bytes; 93f1d40433STakashi Iwai spinlock_t lock; 9448c9d417STakashi Iwai struct snd_rawmidi *rmidi; 9548c9d417STakashi Iwai struct snd_rawmidi_str *pstr; 961da177e4SLinus Torvalds char name[32]; 9748c9d417STakashi Iwai struct snd_rawmidi_runtime *runtime; 987584af10SClemens Ladisch struct pid *pid; 991da177e4SLinus Torvalds /* hardware layer */ 1006ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops; 1011da177e4SLinus Torvalds }; 1021da177e4SLinus Torvalds 10348c9d417STakashi Iwai struct snd_rawmidi_file { 10448c9d417STakashi Iwai struct snd_rawmidi *rmidi; 10548c9d417STakashi Iwai struct snd_rawmidi_substream *input; 10648c9d417STakashi Iwai struct snd_rawmidi_substream *output; 10709d23174SJaroslav Kysela unsigned int user_pversion; /* supported protocol version */ 10848c9d417STakashi Iwai }; 1091da177e4SLinus Torvalds 11048c9d417STakashi Iwai struct snd_rawmidi_str { 1111da177e4SLinus Torvalds unsigned int substream_count; 1121da177e4SLinus Torvalds unsigned int substream_opened; 1131da177e4SLinus Torvalds struct list_head substreams; 1141da177e4SLinus Torvalds }; 1151da177e4SLinus Torvalds 11648c9d417STakashi Iwai struct snd_rawmidi { 11748c9d417STakashi Iwai struct snd_card *card; 118f87135f5SClemens Ladisch struct list_head list; 1191da177e4SLinus Torvalds unsigned int device; /* device number */ 1201da177e4SLinus Torvalds unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 1211da177e4SLinus Torvalds char id[64]; 1221da177e4SLinus Torvalds char name[80]; 1231da177e4SLinus Torvalds 1241da177e4SLinus Torvalds #ifdef CONFIG_SND_OSSEMUL 1251da177e4SLinus Torvalds int ossreg; 1261da177e4SLinus Torvalds #endif 1271da177e4SLinus Torvalds 128efdbe3c3SJulia Lawall const struct snd_rawmidi_global_ops *ops; 1291da177e4SLinus Torvalds 13048c9d417STakashi Iwai struct snd_rawmidi_str streams[2]; 1311da177e4SLinus Torvalds 1321da177e4SLinus Torvalds void *private_data; 13348c9d417STakashi Iwai void (*private_free) (struct snd_rawmidi *rmidi); 1341da177e4SLinus Torvalds 1351a60d4c5SIngo Molnar struct mutex open_mutex; 1361da177e4SLinus Torvalds wait_queue_head_t open_wait; 1371da177e4SLinus Torvalds 138aee5012fSTakashi Iwai struct device dev; 139aee5012fSTakashi Iwai 14048c9d417STakashi Iwai struct snd_info_entry *proc_entry; 1411da177e4SLinus Torvalds 1426d2412b8STakashi Iwai #if IS_ENABLED(CONFIG_SND_SEQUENCER) 14348c9d417STakashi Iwai struct snd_seq_device *seq_dev; 1441da177e4SLinus Torvalds #endif 1451da177e4SLinus Torvalds }; 1461da177e4SLinus Torvalds 1471da177e4SLinus Torvalds /* main rawmidi functions */ 1481da177e4SLinus Torvalds 14948c9d417STakashi Iwai int snd_rawmidi_new(struct snd_card *card, char *id, int device, 1501da177e4SLinus Torvalds int output_count, int input_count, 15148c9d417STakashi Iwai struct snd_rawmidi **rmidi); 15248c9d417STakashi Iwai void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream, 1536ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops); 1541da177e4SLinus Torvalds 155e3a8a5b7STakashi Iwai /* internal */ 156e3a8a5b7STakashi Iwai int snd_rawmidi_init(struct snd_rawmidi *rmidi, 157e3a8a5b7STakashi Iwai struct snd_card *card, char *id, int device, 158e3a8a5b7STakashi Iwai int output_count, int input_count, 159e3a8a5b7STakashi Iwai unsigned int info_flags); 160e3a8a5b7STakashi Iwai int snd_rawmidi_free(struct snd_rawmidi *rmidi); 161e3a8a5b7STakashi Iwai 1621da177e4SLinus Torvalds /* callbacks */ 1631da177e4SLinus Torvalds 16448c9d417STakashi Iwai int snd_rawmidi_receive(struct snd_rawmidi_substream *substream, 16548c9d417STakashi Iwai const unsigned char *buffer, int count); 16648c9d417STakashi Iwai int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream); 16748c9d417STakashi Iwai int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 16848c9d417STakashi Iwai unsigned char *buffer, int count); 16948c9d417STakashi Iwai int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count); 17048c9d417STakashi Iwai int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream, 17148c9d417STakashi Iwai unsigned char *buffer, int count); 1726aea5702STakashi Iwai int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream); 1731da177e4SLinus Torvalds 1741da177e4SLinus Torvalds /* main midi functions */ 1751da177e4SLinus Torvalds 17648c9d417STakashi Iwai int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info); 17709b62892STakashi Iwai int snd_rawmidi_kernel_open(struct snd_rawmidi *rmidi, int subdevice, 178f87135f5SClemens Ladisch int mode, struct snd_rawmidi_file *rfile); 17948c9d417STakashi Iwai int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile); 18048c9d417STakashi Iwai int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream, 18148c9d417STakashi Iwai struct snd_rawmidi_params *params); 18248c9d417STakashi Iwai int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream, 18348c9d417STakashi Iwai struct snd_rawmidi_params *params); 18448c9d417STakashi Iwai int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream); 18548c9d417STakashi Iwai int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream); 18648c9d417STakashi Iwai int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream); 18748c9d417STakashi Iwai long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream, 18848c9d417STakashi Iwai unsigned char *buf, long count); 18948c9d417STakashi Iwai long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream, 19048c9d417STakashi Iwai const unsigned char *buf, long count); 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds #endif /* __SOUND_RAWMIDI_H */ 193