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