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 size_t align; /* alignment (0 = byte stream, 3 = UMP) */ 67 int buffer_ref; /* buffer reference count */ 68 /* misc */ 69 wait_queue_head_t sleep; 70 /* event handler (new bytes, input only) */ 71 void (*event)(struct snd_rawmidi_substream *substream); 72 /* defers calls to event [input] or ops->trigger [output] */ 73 struct work_struct event_work; 74 /* private data */ 75 void *private_data; 76 void (*private_free)(struct snd_rawmidi_substream *substream); 77 }; 78 79 struct snd_rawmidi_substream { 80 struct list_head list; /* list of all substream for given stream */ 81 int stream; /* direction */ 82 int number; /* substream number */ 83 bool opened; /* open flag */ 84 bool append; /* append flag (merge more streams) */ 85 bool active_sensing; /* send active sensing when close */ 86 unsigned int framing; /* whether to frame input data */ 87 unsigned int clock_type; /* clock source to use for input framing */ 88 int use_count; /* use counter (for output) */ 89 size_t bytes; 90 spinlock_t lock; 91 struct snd_rawmidi *rmidi; 92 struct snd_rawmidi_str *pstr; 93 char name[32]; 94 struct snd_rawmidi_runtime *runtime; 95 struct pid *pid; 96 /* hardware layer */ 97 const struct snd_rawmidi_ops *ops; 98 }; 99 100 struct snd_rawmidi_file { 101 struct snd_rawmidi *rmidi; 102 struct snd_rawmidi_substream *input; 103 struct snd_rawmidi_substream *output; 104 unsigned int user_pversion; /* supported protocol version */ 105 }; 106 107 struct snd_rawmidi_str { 108 unsigned int substream_count; 109 unsigned int substream_opened; 110 struct list_head substreams; 111 }; 112 113 struct snd_rawmidi { 114 struct snd_card *card; 115 struct list_head list; 116 unsigned int device; /* device number */ 117 unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 118 char id[64]; 119 char name[80]; 120 121 #ifdef CONFIG_SND_OSSEMUL 122 int ossreg; 123 #endif 124 125 const struct snd_rawmidi_global_ops *ops; 126 127 struct snd_rawmidi_str streams[2]; 128 129 void *private_data; 130 void (*private_free) (struct snd_rawmidi *rmidi); 131 132 struct mutex open_mutex; 133 wait_queue_head_t open_wait; 134 135 struct device dev; 136 137 struct snd_info_entry *proc_entry; 138 139 #if IS_ENABLED(CONFIG_SND_SEQUENCER) 140 struct snd_seq_device *seq_dev; 141 #endif 142 }; 143 144 /* main rawmidi functions */ 145 146 int snd_rawmidi_new(struct snd_card *card, char *id, int device, 147 int output_count, int input_count, 148 struct snd_rawmidi **rmidi); 149 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream, 150 const struct snd_rawmidi_ops *ops); 151 152 /* internal */ 153 int snd_rawmidi_init(struct snd_rawmidi *rmidi, 154 struct snd_card *card, char *id, int device, 155 int output_count, int input_count, 156 unsigned int info_flags); 157 int snd_rawmidi_free(struct snd_rawmidi *rmidi); 158 159 /* callbacks */ 160 161 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream, 162 const unsigned char *buffer, int count); 163 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream); 164 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream, 165 unsigned char *buffer, int count); 166 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count); 167 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream, 168 unsigned char *buffer, int count); 169 int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream); 170 171 /* main midi functions */ 172 173 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info); 174 int snd_rawmidi_kernel_open(struct snd_rawmidi *rmidi, int subdevice, 175 int mode, struct snd_rawmidi_file *rfile); 176 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile); 177 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream, 178 struct snd_rawmidi_params *params); 179 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream, 180 struct snd_rawmidi_params *params); 181 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream); 182 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream); 183 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream); 184 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream, 185 unsigned char *buf, long count); 186 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream, 187 const unsigned char *buf, long count); 188 189 #endif /* __SOUND_RAWMIDI_H */ 190