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