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