xref: /openbmc/linux/sound/drivers/opl3/opl3_oss.c (revision 9cfc5c90)
1 /*
2  *  Interface for OSS sequencer emulation
3  *
4  *  Copyright (C) 2000 Uros Bizjak <uros@kss-loka.si>
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  */
20 
21 #include <linux/export.h>
22 #include "opl3_voice.h"
23 
24 static int snd_opl3_open_seq_oss(struct snd_seq_oss_arg *arg, void *closure);
25 static int snd_opl3_close_seq_oss(struct snd_seq_oss_arg *arg);
26 static int snd_opl3_ioctl_seq_oss(struct snd_seq_oss_arg *arg, unsigned int cmd, unsigned long ioarg);
27 static int snd_opl3_load_patch_seq_oss(struct snd_seq_oss_arg *arg, int format, const char __user *buf, int offs, int count);
28 static int snd_opl3_reset_seq_oss(struct snd_seq_oss_arg *arg);
29 
30 /* */
31 
32 static inline mm_segment_t snd_enter_user(void)
33 {
34 	mm_segment_t fs = get_fs();
35 	set_fs(get_ds());
36 	return fs;
37 }
38 
39 static inline void snd_leave_user(mm_segment_t fs)
40 {
41 	set_fs(fs);
42 }
43 
44 /* operators */
45 
46 extern struct snd_midi_op opl3_ops;
47 
48 static struct snd_seq_oss_callback oss_callback = {
49 	.owner = 	THIS_MODULE,
50 	.open =		snd_opl3_open_seq_oss,
51 	.close =	snd_opl3_close_seq_oss,
52 	.ioctl =	snd_opl3_ioctl_seq_oss,
53 	.load_patch =	snd_opl3_load_patch_seq_oss,
54 	.reset =	snd_opl3_reset_seq_oss,
55 };
56 
57 static int snd_opl3_oss_event_input(struct snd_seq_event *ev, int direct,
58 				    void *private_data, int atomic, int hop)
59 {
60 	struct snd_opl3 *opl3 = private_data;
61 
62 	if (ev->type != SNDRV_SEQ_EVENT_OSS)
63 		snd_midi_process_event(&opl3_ops, ev, opl3->oss_chset);
64 	return 0;
65 }
66 
67 /* ------------------------------ */
68 
69 static void snd_opl3_oss_free_port(void *private_data)
70 {
71 	struct snd_opl3 *opl3 = private_data;
72 
73 	snd_midi_channel_free_set(opl3->oss_chset);
74 }
75 
76 static int snd_opl3_oss_create_port(struct snd_opl3 * opl3)
77 {
78 	struct snd_seq_port_callback callbacks;
79 	char name[32];
80 	int voices, opl_ver;
81 
82 	voices = (opl3->hardware < OPL3_HW_OPL3) ?
83 		MAX_OPL2_VOICES : MAX_OPL3_VOICES;
84 	opl3->oss_chset = snd_midi_channel_alloc_set(voices);
85 	if (opl3->oss_chset == NULL)
86 		return -ENOMEM;
87 	opl3->oss_chset->private_data = opl3;
88 
89 	memset(&callbacks, 0, sizeof(callbacks));
90 	callbacks.owner = THIS_MODULE;
91 	callbacks.event_input = snd_opl3_oss_event_input;
92 	callbacks.private_free = snd_opl3_oss_free_port;
93 	callbacks.private_data = opl3;
94 
95 	opl_ver = (opl3->hardware & OPL3_HW_MASK) >> 8;
96 	sprintf(name, "OPL%i OSS Port", opl_ver);
97 
98 	opl3->oss_chset->client = opl3->seq_client;
99 	opl3->oss_chset->port = snd_seq_event_port_attach(opl3->seq_client, &callbacks,
100 							  SNDRV_SEQ_PORT_CAP_WRITE,
101 							  SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
102 							  SNDRV_SEQ_PORT_TYPE_MIDI_GM |
103 							  SNDRV_SEQ_PORT_TYPE_HARDWARE |
104 							  SNDRV_SEQ_PORT_TYPE_SYNTHESIZER,
105 							  voices, voices,
106 							  name);
107 	if (opl3->oss_chset->port < 0) {
108 		int port;
109 		port = opl3->oss_chset->port;
110 		snd_midi_channel_free_set(opl3->oss_chset);
111 		return port;
112 	}
113 	return 0;
114 }
115 
116 /* ------------------------------ */
117 
118 /* register OSS synth */
119 void snd_opl3_init_seq_oss(struct snd_opl3 *opl3, char *name)
120 {
121 	struct snd_seq_oss_reg *arg;
122 	struct snd_seq_device *dev;
123 
124 	if (snd_seq_device_new(opl3->card, 0, SNDRV_SEQ_DEV_ID_OSS,
125 			       sizeof(struct snd_seq_oss_reg), &dev) < 0)
126 		return;
127 
128 	opl3->oss_seq_dev = dev;
129 	strlcpy(dev->name, name, sizeof(dev->name));
130 	arg = SNDRV_SEQ_DEVICE_ARGPTR(dev);
131 	arg->type = SYNTH_TYPE_FM;
132 	if (opl3->hardware < OPL3_HW_OPL3) {
133 		arg->subtype = FM_TYPE_ADLIB;
134 		arg->nvoices = MAX_OPL2_VOICES;
135 	} else {
136 		arg->subtype = FM_TYPE_OPL3;
137 		arg->nvoices = MAX_OPL3_VOICES;
138 	}
139 	arg->oper = oss_callback;
140 	arg->private_data = opl3;
141 
142 	if (snd_opl3_oss_create_port(opl3)) {
143 		/* register to OSS synth table */
144 		snd_device_register(opl3->card, dev);
145 	}
146 }
147 
148 /* unregister */
149 void snd_opl3_free_seq_oss(struct snd_opl3 *opl3)
150 {
151 	if (opl3->oss_seq_dev) {
152 		/* The instance should have been released in prior */
153 		opl3->oss_seq_dev = NULL;
154 	}
155 }
156 
157 /* ------------------------------ */
158 
159 /* open OSS sequencer */
160 static int snd_opl3_open_seq_oss(struct snd_seq_oss_arg *arg, void *closure)
161 {
162 	struct snd_opl3 *opl3 = closure;
163 	int err;
164 
165 	if (snd_BUG_ON(!arg))
166 		return -ENXIO;
167 
168 	if ((err = snd_opl3_synth_setup(opl3)) < 0)
169 		return err;
170 
171 	/* fill the argument data */
172 	arg->private_data = opl3;
173 	arg->addr.client = opl3->oss_chset->client;
174 	arg->addr.port = opl3->oss_chset->port;
175 
176 	if ((err = snd_opl3_synth_use_inc(opl3)) < 0)
177 		return err;
178 
179 	opl3->synth_mode = SNDRV_OPL3_MODE_SYNTH;
180 	return 0;
181 }
182 
183 /* close OSS sequencer */
184 static int snd_opl3_close_seq_oss(struct snd_seq_oss_arg *arg)
185 {
186 	struct snd_opl3 *opl3;
187 
188 	if (snd_BUG_ON(!arg))
189 		return -ENXIO;
190 	opl3 = arg->private_data;
191 
192 	snd_opl3_synth_cleanup(opl3);
193 
194 	snd_opl3_synth_use_dec(opl3);
195 	return 0;
196 }
197 
198 /* load patch */
199 
200 /* from sound_config.h */
201 #define SBFM_MAXINSTR	256
202 
203 static int snd_opl3_load_patch_seq_oss(struct snd_seq_oss_arg *arg, int format,
204 				       const char __user *buf, int offs, int count)
205 {
206 	struct snd_opl3 *opl3;
207 	struct sbi_instrument sbi;
208 	char name[32];
209 	int err, type;
210 
211 	if (snd_BUG_ON(!arg))
212 		return -ENXIO;
213 	opl3 = arg->private_data;
214 
215 	if (format == FM_PATCH)
216 		type = FM_PATCH_OPL2;
217 	else if (format == OPL3_PATCH)
218 		type = FM_PATCH_OPL3;
219 	else
220 		return -EINVAL;
221 
222 	if (count < (int)sizeof(sbi)) {
223 		snd_printk(KERN_ERR "FM Error: Patch record too short\n");
224 		return -EINVAL;
225 	}
226 	if (copy_from_user(&sbi, buf, sizeof(sbi)))
227 		return -EFAULT;
228 
229 	if (sbi.channel < 0 || sbi.channel >= SBFM_MAXINSTR) {
230 		snd_printk(KERN_ERR "FM Error: Invalid instrument number %d\n",
231 			   sbi.channel);
232 		return -EINVAL;
233 	}
234 
235 	memset(name, 0, sizeof(name));
236 	sprintf(name, "Chan%d", sbi.channel);
237 
238 	err = snd_opl3_load_patch(opl3, sbi.channel, 127, type, name, NULL,
239 				  sbi.operators);
240 	if (err < 0)
241 		return err;
242 
243 	return sizeof(sbi);
244 }
245 
246 /* ioctl */
247 static int snd_opl3_ioctl_seq_oss(struct snd_seq_oss_arg *arg, unsigned int cmd,
248 				  unsigned long ioarg)
249 {
250 	struct snd_opl3 *opl3;
251 
252 	if (snd_BUG_ON(!arg))
253 		return -ENXIO;
254 	opl3 = arg->private_data;
255 	switch (cmd) {
256 		case SNDCTL_FM_LOAD_INSTR:
257 			snd_printk(KERN_ERR "OPL3: "
258 				   "Obsolete ioctl(SNDCTL_FM_LOAD_INSTR) used. "
259 				   "Fix the program.\n");
260 			return -EINVAL;
261 
262 		case SNDCTL_SYNTH_MEMAVL:
263 			return 0x7fffffff;
264 
265 		case SNDCTL_FM_4OP_ENABLE:
266 			// handled automatically by OPL instrument type
267 			return 0;
268 
269 		default:
270 			return -EINVAL;
271 	}
272 	return 0;
273 }
274 
275 /* reset device */
276 static int snd_opl3_reset_seq_oss(struct snd_seq_oss_arg *arg)
277 {
278 	struct snd_opl3 *opl3;
279 
280 	if (snd_BUG_ON(!arg))
281 		return -ENXIO;
282 	opl3 = arg->private_data;
283 
284 	return 0;
285 }
286