1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 #ifndef __SOUND_RAWMIDI_H 3 #define __SOUND_RAWMIDI_H 4 5 /* 6 * Abstract layer for MIDI v1.0 stream 7 * Copyright (c) by Jaroslav Kysela <perex@perex.cz> 8 */ 9 10 #include <sound/asound.h> 11 #include <linux/interrupt.h> 12 #include <linux/spinlock.h> 13 #include <linux/wait.h> 14 #include <linux/mutex.h> 15 #include <linux/workqueue.h> 16 #include <linux/device.h> 17 18 #if IS_ENABLED(CONFIG_SND_SEQUENCER) 19 #include <sound/seq_device.h> 20 #endif 21 22 /* 23 * Raw MIDI interface 24 */ 25 26 #define SNDRV_RAWMIDI_DEVICES 8 27 28 #define SNDRV_RAWMIDI_LFLG_OUTPUT (1<<0) 29 #define SNDRV_RAWMIDI_LFLG_INPUT (1<<1) 30 #define SNDRV_RAWMIDI_LFLG_OPEN (3<<0) 31 #define SNDRV_RAWMIDI_LFLG_APPEND (1<<2) 32 33 struct snd_rawmidi; 34 struct snd_rawmidi_substream; 35 struct snd_seq_port_info; 36 struct pid; 37 38 struct snd_rawmidi_ops { 39 int (*open) (struct snd_rawmidi_substream * substream); 40 int (*close) (struct snd_rawmidi_substream * substream); 41 void (*trigger) (struct snd_rawmidi_substream * substream, int up); 42 void (*drain) (struct snd_rawmidi_substream * substream); 43 }; 44 45 struct snd_rawmidi_global_ops { 46 int (*dev_register) (struct snd_rawmidi * rmidi); 47 int (*dev_unregister) (struct snd_rawmidi * rmidi); 48 void (*get_port_info)(struct snd_rawmidi *rmidi, int number, 49 struct snd_seq_port_info *info); 50 long (*ioctl)(struct snd_rawmidi *rmidi, unsigned int cmd, 51 void __user *argp); 52 }; 53 54 struct snd_rawmidi_runtime { 55 struct snd_rawmidi_substream *substream; 56 unsigned int drain: 1, /* drain stage */ 57 oss: 1; /* OSS compatible mode */ 58 /* midi stream buffer */ 59 unsigned char *buffer; /* buffer for MIDI data */ 60 size_t buffer_size; /* size of buffer */ 61 size_t appl_ptr; /* application pointer */ 62 size_t hw_ptr; /* hardware pointer */ 63 size_t avail_min; /* min avail for wakeup */ 64 size_t avail; /* max used buffer for wakeup */ 65 size_t xruns; /* over/underruns counter */ 66 int buffer_ref; /* buffer reference count */ 67 /* misc */ 68 wait_queue_head_t sleep; 69 /* event handler (new bytes, input only) */ 70 void (*event)(struct snd_rawmidi_substream *substream); 71 /* defers calls to event [input] or ops->trigger [output] */ 72 struct work_struct event_work; 73 /* private data */ 74 void *private_data; 75 void (*private_free)(struct snd_rawmidi_substream *substream); 76 }; 77 78 struct snd_rawmidi_substream { 79 struct list_head list; /* list of all substream for given stream */ 80 int stream; /* direction */ 81 int number; /* substream number */ 82 bool opened; /* open flag */ 83 bool append; /* append flag (merge more streams) */ 84 bool active_sensing; /* send active sensing when close */ 85 unsigned int framing; /* whether to frame input data */ 86 unsigned int clock_type; /* clock source to use for input framing */ 87 int use_count; /* use counter (for output) */ 88 size_t bytes; 89 spinlock_t lock; 90 struct snd_rawmidi *rmidi; 91 struct snd_rawmidi_str *pstr; 92 char name[32]; 93 struct snd_rawmidi_runtime *runtime; 94 struct pid *pid; 95 /* hardware layer */ 96 const struct snd_rawmidi_ops *ops; 97 }; 98 99 struct snd_rawmidi_file { 100 struct snd_rawmidi *rmidi; 101 struct snd_rawmidi_substream *input; 102 struct snd_rawmidi_substream *output; 103 unsigned int user_pversion; /* supported protocol version */ 104 }; 105 106 struct snd_rawmidi_str { 107 unsigned int substream_count; 108 unsigned int substream_opened; 109 struct list_head substreams; 110 }; 111 112 struct snd_rawmidi { 113 struct snd_card *card; 114 struct list_head list; 115 unsigned int device; /* device number */ 116 unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 117 char id[64]; 118 char name[80]; 119 120 #ifdef CONFIG_SND_OSSEMUL 121 int ossreg; 122 #endif 123 124 const struct snd_rawmidi_global_ops *ops; 125 126 struct snd_rawmidi_str streams[2]; 127 128 void *private_data; 129 void (*private_free) (struct snd_rawmidi *rmidi); 130 131 struct mutex open_mutex; 132 wait_queue_head_t open_wait; 133 134 struct device dev; 135 136 struct snd_info_entry *proc_entry; 137 138 #if IS_ENABLED(CONFIG_SND_SEQUENCER) 139 struct snd_seq_device *seq_dev; 140 #endif 141 }; 142 143 /* main rawmidi functions */ 144 145 int snd_rawmidi_new(struct snd_card *card, char *id, int device, 146 int output_count, int input_count, 147 struct snd_rawmidi **rmidi); 148 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream, 149 const struct snd_rawmidi_ops *ops); 150 151 /* callbacks */ 152 153 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream, 154 const unsigned char *buffer, int count); 155 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream); 156 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 157 unsigned char *buffer, int count); 158 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count); 159 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream, 160 unsigned char *buffer, int count); 161 int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream); 162 163 /* main midi functions */ 164 165 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info); 166 int snd_rawmidi_kernel_open(struct snd_rawmidi *rmidi, int subdevice, 167 int mode, struct snd_rawmidi_file *rfile); 168 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile); 169 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream, 170 struct snd_rawmidi_params *params); 171 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream, 172 struct snd_rawmidi_params *params); 173 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream); 174 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream); 175 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream); 176 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream, 177 unsigned char *buf, long count); 178 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream, 179 const unsigned char *buf, long count); 180 181 #endif /* __SOUND_RAWMIDI_H */ 182