Merge with Linus' kernel.
[linux-2.6] / sound / drivers / opl4 / opl4_lib.c
1 /*
2  * Functions for accessing OPL4 devices
3  * Copyright (c) 2003 by Clemens Ladisch <clemens@ladisch.de>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18  */
19
20 #include "opl4_local.h"
21 #include <sound/initval.h>
22 #include <linux/ioport.h>
23 #include <linux/init.h>
24 #include <asm/io.h>
25
26 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
27 MODULE_DESCRIPTION("OPL4 driver");
28 MODULE_LICENSE("GPL");
29
30 static void inline snd_opl4_wait(struct snd_opl4 *opl4)
31 {
32         int timeout = 10;
33         while ((inb(opl4->fm_port) & OPL4_STATUS_BUSY) && --timeout > 0)
34                 ;
35 }
36
37 void snd_opl4_write(struct snd_opl4 *opl4, u8 reg, u8 value)
38 {
39         snd_opl4_wait(opl4);
40         outb(reg, opl4->pcm_port);
41
42         snd_opl4_wait(opl4);
43         outb(value, opl4->pcm_port + 1);
44 }
45
46 u8 snd_opl4_read(struct snd_opl4 *opl4, u8 reg)
47 {
48         snd_opl4_wait(opl4);
49         outb(reg, opl4->pcm_port);
50
51         snd_opl4_wait(opl4);
52         return inb(opl4->pcm_port + 1);
53 }
54
55 void snd_opl4_read_memory(struct snd_opl4 *opl4, char *buf, int offset, int size)
56 {
57         unsigned long flags;
58         u8 memcfg;
59
60         spin_lock_irqsave(&opl4->reg_lock, flags);
61
62         memcfg = snd_opl4_read(opl4, OPL4_REG_MEMORY_CONFIGURATION);
63         snd_opl4_write(opl4, OPL4_REG_MEMORY_CONFIGURATION, memcfg | OPL4_MODE_BIT);
64
65         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_HIGH, offset >> 16);
66         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_MID, offset >> 8);
67         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_LOW, offset);
68
69         snd_opl4_wait(opl4);
70         outb(OPL4_REG_MEMORY_DATA, opl4->pcm_port);
71         snd_opl4_wait(opl4);
72         insb(opl4->pcm_port + 1, buf, size);
73
74         snd_opl4_write(opl4, OPL4_REG_MEMORY_CONFIGURATION, memcfg);
75
76         spin_unlock_irqrestore(&opl4->reg_lock, flags);
77 }
78
79 void snd_opl4_write_memory(struct snd_opl4 *opl4, const char *buf, int offset, int size)
80 {
81         unsigned long flags;
82         u8 memcfg;
83
84         spin_lock_irqsave(&opl4->reg_lock, flags);
85
86         memcfg = snd_opl4_read(opl4, OPL4_REG_MEMORY_CONFIGURATION);
87         snd_opl4_write(opl4, OPL4_REG_MEMORY_CONFIGURATION, memcfg | OPL4_MODE_BIT);
88
89         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_HIGH, offset >> 16);
90         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_MID, offset >> 8);
91         snd_opl4_write(opl4, OPL4_REG_MEMORY_ADDRESS_LOW, offset);
92
93         snd_opl4_wait(opl4);
94         outb(OPL4_REG_MEMORY_DATA, opl4->pcm_port);
95         snd_opl4_wait(opl4);
96         outsb(opl4->pcm_port + 1, buf, size);
97
98         snd_opl4_write(opl4, OPL4_REG_MEMORY_CONFIGURATION, memcfg);
99
100         spin_unlock_irqrestore(&opl4->reg_lock, flags);
101 }
102
103 static void snd_opl4_enable_opl4(struct snd_opl4 *opl4)
104 {
105         outb(OPL3_REG_MODE, opl4->fm_port + 2);
106         inb(opl4->fm_port);
107         inb(opl4->fm_port);
108         outb(OPL3_OPL3_ENABLE | OPL3_OPL4_ENABLE, opl4->fm_port + 3);
109         inb(opl4->fm_port);
110         inb(opl4->fm_port);
111 }
112
113 static int snd_opl4_detect(struct snd_opl4 *opl4)
114 {
115         u8 id1, id2;
116
117         snd_opl4_enable_opl4(opl4);
118
119         id1 = snd_opl4_read(opl4, OPL4_REG_MEMORY_CONFIGURATION);
120         snd_printdd("OPL4[02]=%02x\n", id1);
121         switch (id1 & OPL4_DEVICE_ID_MASK) {
122         case 0x20:
123                 opl4->hardware = OPL3_HW_OPL4;
124                 break;
125         case 0x40:
126                 opl4->hardware = OPL3_HW_OPL4_ML;
127                 break;
128         default:
129                 return -ENODEV;
130         }
131
132         snd_opl4_write(opl4, OPL4_REG_MIX_CONTROL_FM, 0x00);
133         snd_opl4_write(opl4, OPL4_REG_MIX_CONTROL_PCM, 0xff);
134         id1 = snd_opl4_read(opl4, OPL4_REG_MIX_CONTROL_FM);
135         id2 = snd_opl4_read(opl4, OPL4_REG_MIX_CONTROL_PCM);
136         snd_printdd("OPL4 id1=%02x id2=%02x\n", id1, id2);
137         if (id1 != 0x00 || id2 != 0xff)
138                 return -ENODEV;
139
140         snd_opl4_write(opl4, OPL4_REG_MIX_CONTROL_FM, 0x3f);
141         snd_opl4_write(opl4, OPL4_REG_MIX_CONTROL_PCM, 0x3f);
142         snd_opl4_write(opl4, OPL4_REG_MEMORY_CONFIGURATION, 0x00);
143         return 0;
144 }
145
146 #if defined(CONFIG_SND_SEQUENCER) || (defined(MODULE) && defined(CONFIG_SND_SEQUENCER_MODULE))
147 static void snd_opl4_seq_dev_free(struct snd_seq_device *seq_dev)
148 {
149         struct snd_opl4 *opl4 = seq_dev->private_data;
150         opl4->seq_dev = NULL;
151 }
152
153 static int snd_opl4_create_seq_dev(struct snd_opl4 *opl4, int seq_device)
154 {
155         opl4->seq_dev_num = seq_device;
156         if (snd_seq_device_new(opl4->card, seq_device, SNDRV_SEQ_DEV_ID_OPL4,
157                                sizeof(struct snd_opl4 *), &opl4->seq_dev) >= 0) {
158                 strcpy(opl4->seq_dev->name, "OPL4 Wavetable");
159                 *(struct snd_opl4 **)SNDRV_SEQ_DEVICE_ARGPTR(opl4->seq_dev) = opl4;
160                 opl4->seq_dev->private_data = opl4;
161                 opl4->seq_dev->private_free = snd_opl4_seq_dev_free;
162         }
163         return 0;
164 }
165 #endif
166
167 static void snd_opl4_free(struct snd_opl4 *opl4)
168 {
169 #ifdef CONFIG_PROC_FS
170         snd_opl4_free_proc(opl4);
171 #endif
172         release_and_free_resource(opl4->res_fm_port);
173         release_and_free_resource(opl4->res_pcm_port);
174         kfree(opl4);
175 }
176
177 static int snd_opl4_dev_free(struct snd_device *device)
178 {
179         struct snd_opl4 *opl4 = device->device_data;
180         snd_opl4_free(opl4);
181         return 0;
182 }
183
184 int snd_opl4_create(struct snd_card *card,
185                     unsigned long fm_port, unsigned long pcm_port,
186                     int seq_device,
187                     struct snd_opl3 **ropl3, struct snd_opl4 **ropl4)
188 {
189         struct snd_opl4 *opl4;
190         struct snd_opl3 *opl3;
191         int err;
192         static struct snd_device_ops ops = {
193                 .dev_free = snd_opl4_dev_free
194         };
195
196         if (ropl3)
197                 *ropl3 = NULL;
198         if (ropl4)
199                 *ropl4 = NULL;
200
201         opl4 = kzalloc(sizeof(*opl4), GFP_KERNEL);
202         if (!opl4)
203                 return -ENOMEM;
204
205         opl4->res_fm_port = request_region(fm_port, 8, "OPL4 FM");
206         opl4->res_pcm_port = request_region(pcm_port, 8, "OPL4 PCM/MIX");
207         if (!opl4->res_fm_port || !opl4->res_pcm_port) {
208                 snd_printk(KERN_ERR "opl4: can't grab ports 0x%lx, 0x%lx\n", fm_port, pcm_port);
209                 snd_opl4_free(opl4);
210                 return -EBUSY;
211         }
212
213         opl4->card = card;
214         opl4->fm_port = fm_port;
215         opl4->pcm_port = pcm_port;
216         spin_lock_init(&opl4->reg_lock);
217         init_MUTEX(&opl4->access_mutex);
218
219         err = snd_opl4_detect(opl4);
220         if (err < 0) {
221                 snd_opl4_free(opl4);
222                 snd_printd("OPL4 chip not detected at %#lx/%#lx\n", fm_port, pcm_port);
223                 return err;
224         }
225
226         err = snd_device_new(card, SNDRV_DEV_CODEC, opl4, &ops);
227         if (err < 0) {
228                 snd_opl4_free(opl4);
229                 return err;
230         }
231
232         err = snd_opl3_create(card, fm_port, fm_port + 2, opl4->hardware, 1, &opl3);
233         if (err < 0) {
234                 snd_device_free(card, opl4);
235                 return err;
236         }
237
238         /* opl3 initialization disabled opl4, so reenable */
239         snd_opl4_enable_opl4(opl4);
240
241         snd_opl4_create_mixer(opl4);
242 #ifdef CONFIG_PROC_FS
243         snd_opl4_create_proc(opl4);
244 #endif
245
246 #if defined(CONFIG_SND_SEQUENCER) || (defined(MODULE) && defined(CONFIG_SND_SEQUENCER_MODULE))
247         opl4->seq_client = -1;
248         if (opl4->hardware < OPL3_HW_OPL4_ML)
249                 snd_opl4_create_seq_dev(opl4, seq_device);
250 #endif
251
252         if (ropl3)
253                 *ropl3 = opl3;
254         if (ropl4)
255                 *ropl4 = opl4;
256         return 0;
257 }
258
259 EXPORT_SYMBOL(snd_opl4_write);
260 EXPORT_SYMBOL(snd_opl4_read);
261 EXPORT_SYMBOL(snd_opl4_write_memory);
262 EXPORT_SYMBOL(snd_opl4_read_memory);
263 EXPORT_SYMBOL(snd_opl4_create);
264
265 static int __init alsa_opl4_init(void)
266 {
267         return 0;
268 }
269
270 static void __exit alsa_opl4_exit(void)
271 {
272 }
273
274 module_init(alsa_opl4_init)
275 module_exit(alsa_opl4_exit)