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 211da177e4SLinus Torvalds 221da177e4SLinus Torvalds /* 231da177e4SLinus Torvalds * Raw MIDI interface 241da177e4SLinus Torvalds */ 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #define SNDRV_RAWMIDI_DEVICES 8 271da177e4SLinus Torvalds 281da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_OUTPUT (1<<0) 291da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_INPUT (1<<1) 301da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_OPEN (3<<0) 311da177e4SLinus Torvalds #define SNDRV_RAWMIDI_LFLG_APPEND (1<<2) 321da177e4SLinus Torvalds 3348c9d417STakashi Iwai struct snd_rawmidi; 3448c9d417STakashi Iwai struct snd_rawmidi_substream; 35a7b928acSClemens Ladisch struct snd_seq_port_info; 367584af10SClemens Ladisch struct pid; 371da177e4SLinus Torvalds 3848c9d417STakashi Iwai struct snd_rawmidi_ops { 3948c9d417STakashi Iwai int (*open) (struct snd_rawmidi_substream * substream); 4048c9d417STakashi Iwai int (*close) (struct snd_rawmidi_substream * substream); 4148c9d417STakashi Iwai void (*trigger) (struct snd_rawmidi_substream * substream, int up); 4248c9d417STakashi Iwai void (*drain) (struct snd_rawmidi_substream * substream); 4348c9d417STakashi Iwai }; 441da177e4SLinus Torvalds 4548c9d417STakashi Iwai struct snd_rawmidi_global_ops { 4648c9d417STakashi Iwai int (*dev_register) (struct snd_rawmidi * rmidi); 4748c9d417STakashi Iwai int (*dev_unregister) (struct snd_rawmidi * rmidi); 48a7b928acSClemens Ladisch void (*get_port_info)(struct snd_rawmidi *rmidi, int number, 49a7b928acSClemens Ladisch struct snd_seq_port_info *info); 50fb3bd121STakashi Iwai long (*ioctl)(struct snd_rawmidi *rmidi, unsigned int cmd, 51fb3bd121STakashi Iwai void __user *argp); 5248c9d417STakashi Iwai }; 531da177e4SLinus Torvalds 5448c9d417STakashi Iwai struct snd_rawmidi_runtime { 55b3c705aaSTakashi Iwai struct snd_rawmidi_substream *substream; 561da177e4SLinus Torvalds unsigned int drain: 1, /* drain stage */ 571da177e4SLinus Torvalds oss: 1; /* OSS compatible mode */ 581da177e4SLinus Torvalds /* midi stream buffer */ 591da177e4SLinus Torvalds unsigned char *buffer; /* buffer for MIDI data */ 601da177e4SLinus Torvalds size_t buffer_size; /* size of buffer */ 611da177e4SLinus Torvalds size_t appl_ptr; /* application pointer */ 621da177e4SLinus Torvalds size_t hw_ptr; /* hardware pointer */ 631da177e4SLinus Torvalds size_t avail_min; /* min avail for wakeup */ 641da177e4SLinus Torvalds size_t avail; /* max used buffer for wakeup */ 651da177e4SLinus Torvalds size_t xruns; /* over/underruns counter */ 66*e3a8a5b7STakashi Iwai size_t align; /* alignment (0 = byte stream, 3 = UMP) */ 67c1f6e3c8STakashi Iwai int buffer_ref; /* buffer reference count */ 681da177e4SLinus Torvalds /* misc */ 691da177e4SLinus Torvalds wait_queue_head_t sleep; 701da177e4SLinus Torvalds /* event handler (new bytes, input only) */ 7148c9d417STakashi Iwai void (*event)(struct snd_rawmidi_substream *substream); 721da177e4SLinus Torvalds /* defers calls to event [input] or ops->trigger [output] */ 73b3c705aaSTakashi Iwai struct work_struct event_work; 741da177e4SLinus Torvalds /* private data */ 751da177e4SLinus Torvalds void *private_data; 7648c9d417STakashi Iwai void (*private_free)(struct snd_rawmidi_substream *substream); 771da177e4SLinus Torvalds }; 781da177e4SLinus Torvalds 7948c9d417STakashi Iwai struct snd_rawmidi_substream { 801da177e4SLinus Torvalds struct list_head list; /* list of all substream for given stream */ 811da177e4SLinus Torvalds int stream; /* direction */ 821da177e4SLinus Torvalds int number; /* substream number */ 83dfa9a5efSTakashi Iwai bool opened; /* open flag */ 84dfa9a5efSTakashi Iwai bool append; /* append flag (merge more streams) */ 85dfa9a5efSTakashi Iwai bool active_sensing; /* send active sensing when close */ 8608fdced6SDavid Henningsson unsigned int framing; /* whether to frame input data */ 8708fdced6SDavid Henningsson unsigned int clock_type; /* clock source to use for input framing */ 881da177e4SLinus Torvalds int use_count; /* use counter (for output) */ 891da177e4SLinus Torvalds size_t bytes; 90f1d40433STakashi Iwai spinlock_t lock; 9148c9d417STakashi Iwai struct snd_rawmidi *rmidi; 9248c9d417STakashi Iwai struct snd_rawmidi_str *pstr; 931da177e4SLinus Torvalds char name[32]; 9448c9d417STakashi Iwai struct snd_rawmidi_runtime *runtime; 957584af10SClemens Ladisch struct pid *pid; 961da177e4SLinus Torvalds /* hardware layer */ 976ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops; 981da177e4SLinus Torvalds }; 991da177e4SLinus Torvalds 10048c9d417STakashi Iwai struct snd_rawmidi_file { 10148c9d417STakashi Iwai struct snd_rawmidi *rmidi; 10248c9d417STakashi Iwai struct snd_rawmidi_substream *input; 10348c9d417STakashi Iwai struct snd_rawmidi_substream *output; 10409d23174SJaroslav Kysela unsigned int user_pversion; /* supported protocol version */ 10548c9d417STakashi Iwai }; 1061da177e4SLinus Torvalds 10748c9d417STakashi Iwai struct snd_rawmidi_str { 1081da177e4SLinus Torvalds unsigned int substream_count; 1091da177e4SLinus Torvalds unsigned int substream_opened; 1101da177e4SLinus Torvalds struct list_head substreams; 1111da177e4SLinus Torvalds }; 1121da177e4SLinus Torvalds 11348c9d417STakashi Iwai struct snd_rawmidi { 11448c9d417STakashi Iwai struct snd_card *card; 115f87135f5SClemens Ladisch struct list_head list; 1161da177e4SLinus Torvalds unsigned int device; /* device number */ 1171da177e4SLinus Torvalds unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 1181da177e4SLinus Torvalds char id[64]; 1191da177e4SLinus Torvalds char name[80]; 1201da177e4SLinus Torvalds 1211da177e4SLinus Torvalds #ifdef CONFIG_SND_OSSEMUL 1221da177e4SLinus Torvalds int ossreg; 1231da177e4SLinus Torvalds #endif 1241da177e4SLinus Torvalds 125efdbe3c3SJulia Lawall const struct snd_rawmidi_global_ops *ops; 1261da177e4SLinus Torvalds 12748c9d417STakashi Iwai struct snd_rawmidi_str streams[2]; 1281da177e4SLinus Torvalds 1291da177e4SLinus Torvalds void *private_data; 13048c9d417STakashi Iwai void (*private_free) (struct snd_rawmidi *rmidi); 1311da177e4SLinus Torvalds 1321a60d4c5SIngo Molnar struct mutex open_mutex; 1331da177e4SLinus Torvalds wait_queue_head_t open_wait; 1341da177e4SLinus Torvalds 135aee5012fSTakashi Iwai struct device dev; 136aee5012fSTakashi Iwai 13748c9d417STakashi Iwai struct snd_info_entry *proc_entry; 1381da177e4SLinus Torvalds 1396d2412b8STakashi Iwai #if IS_ENABLED(CONFIG_SND_SEQUENCER) 14048c9d417STakashi Iwai struct snd_seq_device *seq_dev; 1411da177e4SLinus Torvalds #endif 1421da177e4SLinus Torvalds }; 1431da177e4SLinus Torvalds 1441da177e4SLinus Torvalds /* main rawmidi functions */ 1451da177e4SLinus Torvalds 14648c9d417STakashi Iwai int snd_rawmidi_new(struct snd_card *card, char *id, int device, 1471da177e4SLinus Torvalds int output_count, int input_count, 14848c9d417STakashi Iwai struct snd_rawmidi **rmidi); 14948c9d417STakashi Iwai void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream, 1506ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops); 1511da177e4SLinus Torvalds 152*e3a8a5b7STakashi Iwai /* internal */ 153*e3a8a5b7STakashi Iwai int snd_rawmidi_init(struct snd_rawmidi *rmidi, 154*e3a8a5b7STakashi Iwai struct snd_card *card, char *id, int device, 155*e3a8a5b7STakashi Iwai int output_count, int input_count, 156*e3a8a5b7STakashi Iwai unsigned int info_flags); 157*e3a8a5b7STakashi Iwai int snd_rawmidi_free(struct snd_rawmidi *rmidi); 158*e3a8a5b7STakashi Iwai 1591da177e4SLinus Torvalds /* callbacks */ 1601da177e4SLinus Torvalds 16148c9d417STakashi Iwai int snd_rawmidi_receive(struct snd_rawmidi_substream *substream, 16248c9d417STakashi Iwai const unsigned char *buffer, int count); 16348c9d417STakashi Iwai int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream); 16448c9d417STakashi Iwai int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 16548c9d417STakashi Iwai unsigned char *buffer, int count); 16648c9d417STakashi Iwai int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count); 16748c9d417STakashi Iwai int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream, 16848c9d417STakashi Iwai unsigned char *buffer, int count); 1696aea5702STakashi Iwai int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream); 1701da177e4SLinus Torvalds 1711da177e4SLinus Torvalds /* main midi functions */ 1721da177e4SLinus Torvalds 17348c9d417STakashi Iwai int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info); 17409b62892STakashi Iwai int snd_rawmidi_kernel_open(struct snd_rawmidi *rmidi, int subdevice, 175f87135f5SClemens Ladisch int mode, struct snd_rawmidi_file *rfile); 17648c9d417STakashi Iwai int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile); 17748c9d417STakashi Iwai int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream, 17848c9d417STakashi Iwai struct snd_rawmidi_params *params); 17948c9d417STakashi Iwai int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream, 18048c9d417STakashi Iwai struct snd_rawmidi_params *params); 18148c9d417STakashi Iwai int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream); 18248c9d417STakashi Iwai int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream); 18348c9d417STakashi Iwai int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream); 18448c9d417STakashi Iwai long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream, 18548c9d417STakashi Iwai unsigned char *buf, long count); 18648c9d417STakashi Iwai long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream, 18748c9d417STakashi Iwai const unsigned char *buf, long count); 1881da177e4SLinus Torvalds 1891da177e4SLinus Torvalds #endif /* __SOUND_RAWMIDI_H */ 190