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); 5048c9d417STakashi Iwai }; 511da177e4SLinus Torvalds 5248c9d417STakashi Iwai struct snd_rawmidi_runtime { 53b3c705aaSTakashi Iwai struct snd_rawmidi_substream *substream; 541da177e4SLinus Torvalds unsigned int drain: 1, /* drain stage */ 551da177e4SLinus Torvalds oss: 1; /* OSS compatible mode */ 561da177e4SLinus Torvalds /* midi stream buffer */ 571da177e4SLinus Torvalds unsigned char *buffer; /* buffer for MIDI data */ 581da177e4SLinus Torvalds size_t buffer_size; /* size of buffer */ 591da177e4SLinus Torvalds size_t appl_ptr; /* application pointer */ 601da177e4SLinus Torvalds size_t hw_ptr; /* hardware pointer */ 611da177e4SLinus Torvalds size_t avail_min; /* min avail for wakeup */ 621da177e4SLinus Torvalds size_t avail; /* max used buffer for wakeup */ 631da177e4SLinus Torvalds size_t xruns; /* over/underruns counter */ 64c1f6e3c8STakashi Iwai int buffer_ref; /* buffer reference count */ 651da177e4SLinus Torvalds /* misc */ 661da177e4SLinus Torvalds spinlock_t lock; 671da177e4SLinus Torvalds wait_queue_head_t sleep; 681da177e4SLinus Torvalds /* event handler (new bytes, input only) */ 6948c9d417STakashi Iwai void (*event)(struct snd_rawmidi_substream *substream); 701da177e4SLinus Torvalds /* defers calls to event [input] or ops->trigger [output] */ 71b3c705aaSTakashi Iwai struct work_struct event_work; 721da177e4SLinus Torvalds /* private data */ 731da177e4SLinus Torvalds void *private_data; 7448c9d417STakashi Iwai void (*private_free)(struct snd_rawmidi_substream *substream); 751da177e4SLinus Torvalds }; 761da177e4SLinus Torvalds 7748c9d417STakashi Iwai struct snd_rawmidi_substream { 781da177e4SLinus Torvalds struct list_head list; /* list of all substream for given stream */ 791da177e4SLinus Torvalds int stream; /* direction */ 801da177e4SLinus Torvalds int number; /* substream number */ 81dfa9a5efSTakashi Iwai bool opened; /* open flag */ 82dfa9a5efSTakashi Iwai bool append; /* append flag (merge more streams) */ 83dfa9a5efSTakashi Iwai bool active_sensing; /* send active sensing when close */ 8408fdced6SDavid Henningsson unsigned int framing; /* whether to frame input data */ 8508fdced6SDavid Henningsson unsigned int clock_type; /* clock source to use for input framing */ 861da177e4SLinus Torvalds int use_count; /* use counter (for output) */ 871da177e4SLinus Torvalds size_t bytes; 8848c9d417STakashi Iwai struct snd_rawmidi *rmidi; 8948c9d417STakashi Iwai struct snd_rawmidi_str *pstr; 901da177e4SLinus Torvalds char name[32]; 9148c9d417STakashi Iwai struct snd_rawmidi_runtime *runtime; 927584af10SClemens Ladisch struct pid *pid; 931da177e4SLinus Torvalds /* hardware layer */ 946ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops; 951da177e4SLinus Torvalds }; 961da177e4SLinus Torvalds 9748c9d417STakashi Iwai struct snd_rawmidi_file { 9848c9d417STakashi Iwai struct snd_rawmidi *rmidi; 9948c9d417STakashi Iwai struct snd_rawmidi_substream *input; 10048c9d417STakashi Iwai struct snd_rawmidi_substream *output; 101*09d23174SJaroslav Kysela unsigned int user_pversion; /* supported protocol version */ 10248c9d417STakashi Iwai }; 1031da177e4SLinus Torvalds 10448c9d417STakashi Iwai struct snd_rawmidi_str { 1051da177e4SLinus Torvalds unsigned int substream_count; 1061da177e4SLinus Torvalds unsigned int substream_opened; 1071da177e4SLinus Torvalds struct list_head substreams; 1081da177e4SLinus Torvalds }; 1091da177e4SLinus Torvalds 11048c9d417STakashi Iwai struct snd_rawmidi { 11148c9d417STakashi Iwai struct snd_card *card; 112f87135f5SClemens Ladisch struct list_head list; 1131da177e4SLinus Torvalds unsigned int device; /* device number */ 1141da177e4SLinus Torvalds unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 1151da177e4SLinus Torvalds char id[64]; 1161da177e4SLinus Torvalds char name[80]; 1171da177e4SLinus Torvalds 1181da177e4SLinus Torvalds #ifdef CONFIG_SND_OSSEMUL 1191da177e4SLinus Torvalds int ossreg; 1201da177e4SLinus Torvalds #endif 1211da177e4SLinus Torvalds 122efdbe3c3SJulia Lawall const struct snd_rawmidi_global_ops *ops; 1231da177e4SLinus Torvalds 12448c9d417STakashi Iwai struct snd_rawmidi_str streams[2]; 1251da177e4SLinus Torvalds 1261da177e4SLinus Torvalds void *private_data; 12748c9d417STakashi Iwai void (*private_free) (struct snd_rawmidi *rmidi); 1281da177e4SLinus Torvalds 1291a60d4c5SIngo Molnar struct mutex open_mutex; 1301da177e4SLinus Torvalds wait_queue_head_t open_wait; 1311da177e4SLinus Torvalds 132aee5012fSTakashi Iwai struct device dev; 133aee5012fSTakashi Iwai 13448c9d417STakashi Iwai struct snd_info_entry *proc_entry; 1351da177e4SLinus Torvalds 1366d2412b8STakashi Iwai #if IS_ENABLED(CONFIG_SND_SEQUENCER) 13748c9d417STakashi Iwai struct snd_seq_device *seq_dev; 1381da177e4SLinus Torvalds #endif 1391da177e4SLinus Torvalds }; 1401da177e4SLinus Torvalds 1411da177e4SLinus Torvalds /* main rawmidi functions */ 1421da177e4SLinus Torvalds 14348c9d417STakashi Iwai int snd_rawmidi_new(struct snd_card *card, char *id, int device, 1441da177e4SLinus Torvalds int output_count, int input_count, 14548c9d417STakashi Iwai struct snd_rawmidi **rmidi); 14648c9d417STakashi Iwai void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream, 1476ba79b85STakashi Iwai const struct snd_rawmidi_ops *ops); 1481da177e4SLinus Torvalds 1491da177e4SLinus Torvalds /* callbacks */ 1501da177e4SLinus Torvalds 15148c9d417STakashi Iwai int snd_rawmidi_receive(struct snd_rawmidi_substream *substream, 15248c9d417STakashi Iwai const unsigned char *buffer, int count); 15348c9d417STakashi Iwai int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream); 15448c9d417STakashi Iwai int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 15548c9d417STakashi Iwai unsigned char *buffer, int count); 15648c9d417STakashi Iwai int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count); 15748c9d417STakashi Iwai int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream, 15848c9d417STakashi Iwai unsigned char *buffer, int count); 15906ab3003STakashi Iwai int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 16006ab3003STakashi Iwai unsigned char *buffer, int count); 16106ab3003STakashi Iwai int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, 16206ab3003STakashi Iwai int count); 1636aea5702STakashi Iwai int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream); 1641da177e4SLinus Torvalds 1651da177e4SLinus Torvalds /* main midi functions */ 1661da177e4SLinus Torvalds 16748c9d417STakashi Iwai int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info); 168f87135f5SClemens Ladisch int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice, 169f87135f5SClemens Ladisch int mode, struct snd_rawmidi_file *rfile); 17048c9d417STakashi Iwai int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile); 17148c9d417STakashi Iwai int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream, 17248c9d417STakashi Iwai struct snd_rawmidi_params *params); 17348c9d417STakashi Iwai int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream, 17448c9d417STakashi Iwai struct snd_rawmidi_params *params); 17548c9d417STakashi Iwai int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream); 17648c9d417STakashi Iwai int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream); 17748c9d417STakashi Iwai int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream); 17848c9d417STakashi Iwai long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream, 17948c9d417STakashi Iwai unsigned char *buf, long count); 18048c9d417STakashi Iwai long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream, 18148c9d417STakashi Iwai const unsigned char *buf, long count); 1821da177e4SLinus Torvalds 1831da177e4SLinus Torvalds #endif /* __SOUND_RAWMIDI_H */ 184