blob: 1cd2908e4f12cf1f59b895e8b2f2142edfb10e2e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Krzysztof Heltacd471002009-10-01 00:10:34 +02002 * Low-level ALSA driver for the ENSONIQ SoundScape
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * Copyright (c) by Chris Rankin
4 *
5 * This driver was written in part using information obtained from
6 * the OSS/Free SoundScape driver, written by Hannu Savolainen.
7 *
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 */
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/init.h>
Takashi Iwai277e9262005-11-17 17:13:12 +010025#include <linux/err.h>
Arnd Bergmann37419582015-01-28 16:04:46 +010026#include <linux/io.h>
Takashi Iwai5e24c1c2007-02-22 12:50:54 +010027#include <linux/isa.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/delay.h>
Krzysztof Heltacd471002009-10-01 00:10:34 +020029#include <linux/firmware.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/pnp.h>
31#include <linux/spinlock.h>
Paul Gortmaker65a77212011-07-15 13:13:37 -040032#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <asm/dma.h>
34#include <sound/core.h>
Krzysztof Helt61ef19d2008-07-31 21:02:42 +020035#include <sound/wss.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <sound/mpu401.h>
37#include <sound/initval.h>
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40MODULE_AUTHOR("Chris Rankin");
Krzysztof Heltacd471002009-10-01 00:10:34 +020041MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
Linus Torvalds1da177e2005-04-16 15:20:36 -070042MODULE_LICENSE("GPL");
Krzysztof Heltacd471002009-10-01 00:10:34 +020043MODULE_FIRMWARE("sndscape.co0");
44MODULE_FIRMWARE("sndscape.co1");
45MODULE_FIRMWARE("sndscape.co2");
46MODULE_FIRMWARE("sndscape.co3");
47MODULE_FIRMWARE("sndscape.co4");
48MODULE_FIRMWARE("scope.cod");
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Takashi Iwaied76f652009-10-05 18:27:28 +020050static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
51static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
52static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
53static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
54static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
55static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
56static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
57static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
58static bool joystick[SNDRV_CARDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60module_param_array(index, int, NULL, 0444);
61MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
62
63module_param_array(id, charp, NULL, 0444);
64MODULE_PARM_DESC(id, "Description for SoundScape card");
65
David Howellse992ef52017-04-04 16:54:30 +010066module_param_hw_array(port, long, ioport, NULL, 0444);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
68
David Howellse992ef52017-04-04 16:54:30 +010069module_param_hw_array(wss_port, long, ioport, NULL, 0444);
Krzysztof Helt4996bca2007-09-17 16:23:13 +020070MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
71
David Howellse992ef52017-04-04 16:54:30 +010072module_param_hw_array(irq, int, irq, NULL, 0444);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
74
David Howellse992ef52017-04-04 16:54:30 +010075module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
77
David Howellse992ef52017-04-04 16:54:30 +010078module_param_hw_array(dma, int, dma, NULL, 0444);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
Clemens Ladischf7a92752005-12-07 09:13:42 +010080
David Howellse992ef52017-04-04 16:54:30 +010081module_param_hw_array(dma2, int, dma, NULL, 0444);
Krzysztof Helt4996bca2007-09-17 16:23:13 +020082MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
83
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +020084module_param_array(joystick, bool, NULL, 0444);
85MODULE_PARM_DESC(joystick, "Enable gameport.");
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#ifdef CONFIG_PNP
Rene Herman609d7692007-05-15 11:42:56 +020088static int isa_registered;
Takashi Iwai59b1b342006-01-04 15:06:44 +010089static int pnp_registered;
Rene Herman609d7692007-05-15 11:42:56 +020090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091static struct pnp_card_device_id sscape_pnpids[] = {
Krzysztof Helt4996bca2007-09-17 16:23:13 +020092 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
93 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 { .id = "" } /* end */
95};
96
97MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
98#endif
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#define HOST_CTRL_IO(i) ((i) + 2)
102#define HOST_DATA_IO(i) ((i) + 3)
103#define ODIE_ADDR_IO(i) ((i) + 4)
104#define ODIE_DATA_IO(i) ((i) + 5)
105#define CODEC_IO(i) ((i) + 8)
106
107#define IC_ODIE 1
108#define IC_OPUS 2
109
110#define RX_READY 0x01
111#define TX_READY 0x02
112
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200113#define CMD_ACK 0x80
114#define CMD_SET_MIDI_VOL 0x84
115#define CMD_GET_MIDI_VOL 0x85
116#define CMD_XXX_MIDI_VOL 0x86
117#define CMD_SET_EXTMIDI 0x8a
118#define CMD_GET_EXTMIDI 0x8b
119#define CMD_SET_MT32 0x8c
120#define CMD_GET_MT32 0x8d
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122enum GA_REG {
123 GA_INTSTAT_REG = 0,
124 GA_INTENA_REG,
125 GA_DMAA_REG,
126 GA_DMAB_REG,
127 GA_INTCFG_REG,
128 GA_DMACFG_REG,
129 GA_CDCFG_REG,
130 GA_SMCFGA_REG,
131 GA_SMCFGB_REG,
132 GA_HMCTL_REG
133};
134
135#define DMA_8BIT 0x80
136
137
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200138enum card_type {
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200139 MEDIA_FX, /* Sequoia S-1000 */
140 SSCAPE, /* Sequoia S-2000 */
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200141 SSCAPE_PNP,
142 SSCAPE_VIVO,
143};
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145struct soundscape {
146 spinlock_t lock;
147 unsigned io_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 int ic_type;
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200149 enum card_type type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct resource *io_res;
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200151 struct resource *wss_res;
Krzysztof Helt7779f752008-07-31 21:03:41 +0200152 struct snd_wss *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 unsigned char midi_vol;
155};
156
157#define INVALID_IRQ ((unsigned)-1)
158
159
Takashi Iwaibe624532005-11-17 14:42:05 +0100160static inline struct soundscape *get_card_soundscape(struct snd_card *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
162 return (struct soundscape *) (c->private_data);
163}
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165/*
166 * Allocates some kernel memory that we can use for DMA.
167 * I think this means that the memory has to map to
168 * contiguous pages of physical memory.
169 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200170static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf,
171 unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
173 if (buf) {
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200174 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
175 snd_dma_isa_data(),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 size, buf) < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200177 snd_printk(KERN_ERR "sscape: Failed to allocate "
178 "%lu bytes for DMA\n",
179 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 return NULL;
181 }
182 }
183
184 return buf;
185}
186
187/*
188 * Release the DMA-able kernel memory ...
189 */
190static void free_dmabuf(struct snd_dma_buffer *buf)
191{
192 if (buf && buf->area)
193 snd_dma_free_pages(buf);
194}
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196/*
197 * This function writes to the SoundScape's control registers,
198 * but doesn't do any locking. It's up to the caller to do that.
199 * This is why this function is "unsafe" ...
200 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200201static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
202 unsigned char val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
204 outb(reg, ODIE_ADDR_IO(io_base));
205 outb(val, ODIE_DATA_IO(io_base));
206}
207
208/*
209 * Write to the SoundScape's control registers, and do the
210 * necessary locking ...
211 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200212static void sscape_write(struct soundscape *s, enum GA_REG reg,
213 unsigned char val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
215 unsigned long flags;
216
217 spin_lock_irqsave(&s->lock, flags);
218 sscape_write_unsafe(s->io_base, reg, val);
219 spin_unlock_irqrestore(&s->lock, flags);
220}
221
222/*
223 * Read from the SoundScape's control registers, but leave any
224 * locking to the caller. This is why the function is "unsafe" ...
225 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200226static inline unsigned char sscape_read_unsafe(unsigned io_base,
227 enum GA_REG reg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 outb(reg, ODIE_ADDR_IO(io_base));
230 return inb(ODIE_DATA_IO(io_base));
231}
232
233/*
234 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
235 */
236static inline void set_host_mode_unsafe(unsigned io_base)
237{
238 outb(0x0, HOST_CTRL_IO(io_base));
239}
240
241/*
242 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
243 */
244static inline void set_midi_mode_unsafe(unsigned io_base)
245{
246 outb(0x3, HOST_CTRL_IO(io_base));
247}
248
249/*
250 * Read the SoundScape's host-mode control register, but leave
251 * any locking issues to the caller ...
252 */
253static inline int host_read_unsafe(unsigned io_base)
254{
255 int data = -1;
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200256 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 data = inb(HOST_DATA_IO(io_base));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259 return data;
260}
261
262/*
263 * Read the SoundScape's host-mode control register, performing
264 * a limited amount of busy-waiting if the register isn't ready.
265 * Also leaves all locking-issues to the caller ...
266 */
267static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
268{
269 int data;
270
271 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
272 udelay(100);
273 --timeout;
274 } /* while */
275
276 return data;
277}
278
279/*
280 * Write to the SoundScape's host-mode control registers, but
281 * leave any locking issues to the caller ...
282 */
283static inline int host_write_unsafe(unsigned io_base, unsigned char data)
284{
285 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
286 outb(data, HOST_DATA_IO(io_base));
287 return 1;
288 }
289
290 return 0;
291}
292
293/*
294 * Write to the SoundScape's host-mode control registers, performing
295 * a limited amount of busy-waiting if the register isn't ready.
296 * Also leaves all locking-issues to the caller ...
297 */
298static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200299 unsigned timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
301 int err;
302
303 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
304 udelay(100);
305 --timeout;
306 } /* while */
307
308 return err;
309}
310
311
312/*
313 * Check that the MIDI subsystem is operational. If it isn't,
314 * then we will hang the computer if we try to use it ...
315 *
316 * NOTE: This check is based upon observation, not documentation.
317 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200318static inline int verify_mpu401(const struct snd_mpu401 *mpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319{
Krzysztof Heltc9864fd2009-01-21 08:19:27 +0100320 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
322
323/*
324 * This is apparently the standard way to initailise an MPU-401
325 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200326static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327{
Krzysztof Heltc9864fd2009-01-21 08:19:27 +0100328 outb(0, MPU401D(mpu));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329}
330
331/*
332 * Tell the SoundScape to activate the AD1845 chip (I think).
333 * The AD1845 detection fails if we *don't* do this, so I
334 * think that this is a good idea ...
335 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200336static void activate_ad1845_unsafe(unsigned io_base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200338 unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
339 sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
341}
342
343/*
344 * Do the necessary ALSA-level cleanup to deallocate our driver ...
345 */
Takashi Iwaibe624532005-11-17 14:42:05 +0100346static void soundscape_free(struct snd_card *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347{
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200348 struct soundscape *sscape = get_card_soundscape(c);
Takashi Iwaib1d57762005-10-10 11:56:31 +0200349 release_and_free_resource(sscape->io_res);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200350 release_and_free_resource(sscape->wss_res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 free_dma(sscape->chip->dma1);
352}
353
354/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 * Tell the SoundScape to begin a DMA tranfer using the given channel.
356 * All locking issues are left to the caller.
357 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200358static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359{
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200360 sscape_write_unsafe(io_base, reg,
361 sscape_read_unsafe(io_base, reg) | 0x01);
362 sscape_write_unsafe(io_base, reg,
363 sscape_read_unsafe(io_base, reg) & 0xfe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364}
365
366/*
367 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
368 * and all locking issues are left to the caller.
369 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200370static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
371 unsigned timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
373 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
374 udelay(100);
375 --timeout;
376 } /* while */
377
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200378 return sscape_read_unsafe(io_base, reg) & 0x01;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
380
381/*
382 * Wait for the On-Board Processor to return its start-up
383 * acknowledgement sequence. This wait is too long for
384 * us to perform "busy-waiting", and so we must sleep.
385 * This in turn means that we must not be holding any
386 * spinlocks when we call this function.
387 */
388static int obp_startup_ack(struct soundscape *s, unsigned timeout)
389{
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100390 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
391
392 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 unsigned long flags;
Krzysztof Heltacd471002009-10-01 00:10:34 +0200394 int x;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 spin_lock_irqsave(&s->lock, flags);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200397 x = host_read_unsafe(s->io_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 spin_unlock_irqrestore(&s->lock, flags);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200399 if (x == 0xfe || x == 0xff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 return 1;
401
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100402 msleep(10);
403 } while (time_before(jiffies, end_time));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 return 0;
406}
407
408/*
409 * Wait for the host to return its start-up acknowledgement
410 * sequence. This wait is too long for us to perform
411 * "busy-waiting", and so we must sleep. This in turn means
412 * that we must not be holding any spinlocks when we call
413 * this function.
414 */
415static int host_startup_ack(struct soundscape *s, unsigned timeout)
416{
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100417 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
418
419 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 unsigned long flags;
Krzysztof Heltacd471002009-10-01 00:10:34 +0200421 int x;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 spin_lock_irqsave(&s->lock, flags);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200424 x = host_read_unsafe(s->io_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 spin_unlock_irqrestore(&s->lock, flags);
426 if (x == 0xfe)
427 return 1;
428
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100429 msleep(10);
430 } while (time_before(jiffies, end_time));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 return 0;
433}
434
435/*
436 * Upload a byte-stream into the SoundScape using DMA channel A.
437 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200438static int upload_dma_data(struct soundscape *s, const unsigned char *data,
439 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 unsigned long flags;
442 struct snd_dma_buffer dma;
443 int ret;
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200444 unsigned char val;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Krzysztof Heltacd471002009-10-01 00:10:34 +0200446 if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 return -ENOMEM;
448
449 spin_lock_irqsave(&s->lock, flags);
450
451 /*
452 * Reset the board ...
453 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200454 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
455 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 /*
458 * Enable the DMA channels and configure them ...
459 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200460 val = (s->chip->dma1 << 4) | DMA_8BIT;
461 sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
463
464 /*
465 * Take the board out of reset ...
466 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200467 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
468 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470 /*
Krzysztof Heltacd471002009-10-01 00:10:34 +0200471 * Upload the firmware to the SoundScape
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 * board through the DMA channel ...
473 */
474 while (size != 0) {
475 unsigned long len;
476
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 len = min(size, dma.bytes);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200478 memcpy(dma.area, data, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 data += len;
480 size -= len;
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
483 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
484 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
485 /*
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200486 * Don't forget to release this spinlock we're holding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 */
488 spin_unlock_irqrestore(&s->lock, flags);
489
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200490 snd_printk(KERN_ERR
491 "sscape: DMA upload has timed out\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 ret = -EAGAIN;
493 goto _release_dma;
494 }
495 } /* while */
496
497 set_host_mode_unsafe(s->io_base);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200498 outb(0x0, s->io_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500 /*
501 * Boot the board ... (I think)
502 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200503 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
504 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 spin_unlock_irqrestore(&s->lock, flags);
506
507 /*
508 * If all has gone well, then the board should acknowledge
509 * the new upload and tell us that it has rebooted OK. We
510 * give it 5 seconds (max) ...
511 */
512 ret = 0;
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100513 if (!obp_startup_ack(s, 5000)) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200514 snd_printk(KERN_ERR "sscape: No response "
515 "from on-board processor after upload\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 ret = -EAGAIN;
Krzysztof Helt554b91e2009-01-12 21:25:04 +0100517 } else if (!host_startup_ack(s, 5000)) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200518 snd_printk(KERN_ERR
519 "sscape: SoundScape failed to initialise\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 ret = -EAGAIN;
521 }
522
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200523_release_dma:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 /*
525 * NOTE!!! We are NOT holding any spinlocks at this point !!!
526 */
Krzysztof Heltacd471002009-10-01 00:10:34 +0200527 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 free_dmabuf(&dma);
529
530 return ret;
531}
532
533/*
534 * Upload the bootblock(?) into the SoundScape. The only
535 * purpose of this block of code seems to be to tell
536 * us which version of the microcode we should be using.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Krzysztof Heltacd471002009-10-01 00:10:34 +0200538static int sscape_upload_bootblock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
Krzysztof Heltacd471002009-10-01 00:10:34 +0200540 struct soundscape *sscape = get_card_soundscape(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 unsigned long flags;
Krzysztof Heltacd471002009-10-01 00:10:34 +0200542 const struct firmware *init_fw = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 int data = 0;
544 int ret;
545
Krzysztof Heltacd471002009-10-01 00:10:34 +0200546 ret = request_firmware(&init_fw, "scope.cod", card->dev);
547 if (ret < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200548 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
Krzysztof Heltacd471002009-10-01 00:10:34 +0200549 return ret;
550 }
551 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
552
553 release_firmware(init_fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
555 spin_lock_irqsave(&sscape->lock, flags);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200556 if (ret == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 data = host_read_ctrl_unsafe(sscape->io_base, 100);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200558
559 if (data & 0x10)
560 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 spin_unlock_irqrestore(&sscape->lock, flags);
563
Krzysztof Heltacd471002009-10-01 00:10:34 +0200564 data &= 0xf;
565 if (ret == 0 && data > 7) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200566 snd_printk(KERN_ERR
567 "sscape: timeout reading firmware version\n");
Krzysztof Heltacd471002009-10-01 00:10:34 +0200568 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 }
570
Krzysztof Heltacd471002009-10-01 00:10:34 +0200571 return (ret == 0) ? data : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
573
574/*
Krzysztof Heltacd471002009-10-01 00:10:34 +0200575 * Upload the microcode into the SoundScape.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 */
Krzysztof Heltacd471002009-10-01 00:10:34 +0200577static int sscape_upload_microcode(struct snd_card *card, int version)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Krzysztof Heltacd471002009-10-01 00:10:34 +0200579 struct soundscape *sscape = get_card_soundscape(card);
580 const struct firmware *init_fw = NULL;
581 char name[14];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 int err;
583
Krzysztof Heltacd471002009-10-01 00:10:34 +0200584 snprintf(name, sizeof(name), "sndscape.co%d", version);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Krzysztof Heltacd471002009-10-01 00:10:34 +0200586 err = request_firmware(&init_fw, name, card->dev);
587 if (err < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200588 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
589 version);
Krzysztof Heltacd471002009-10-01 00:10:34 +0200590 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 }
Krzysztof Heltacd471002009-10-01 00:10:34 +0200592 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
593 if (err == 0)
William Breathitt Graydc5027a2016-04-11 09:25:52 -0400594 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %zu KBs\n",
Krzysztof Heltacd471002009-10-01 00:10:34 +0200595 init_fw->size >> 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Krzysztof Heltacd471002009-10-01 00:10:34 +0200597 release_firmware(init_fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599 return err;
600}
601
602/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 * Mixer control for the SoundScape's MIDI device.
604 */
Takashi Iwaibe624532005-11-17 14:42:05 +0100605static int sscape_midi_info(struct snd_kcontrol *ctl,
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200606 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
609 uinfo->count = 1;
610 uinfo->value.integer.min = 0;
611 uinfo->value.integer.max = 127;
612 return 0;
613}
614
Takashi Iwaibe624532005-11-17 14:42:05 +0100615static int sscape_midi_get(struct snd_kcontrol *kctl,
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200616 struct snd_ctl_elem_value *uctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
Krzysztof Helt7779f752008-07-31 21:03:41 +0200618 struct snd_wss *chip = snd_kcontrol_chip(kctl);
Takashi Iwaibe624532005-11-17 14:42:05 +0100619 struct snd_card *card = chip->card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 register struct soundscape *s = get_card_soundscape(card);
621 unsigned long flags;
622
623 spin_lock_irqsave(&s->lock, flags);
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100624 uctl->value.integer.value[0] = s->midi_vol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 spin_unlock_irqrestore(&s->lock, flags);
626 return 0;
627}
628
Takashi Iwaibe624532005-11-17 14:42:05 +0100629static int sscape_midi_put(struct snd_kcontrol *kctl,
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200630 struct snd_ctl_elem_value *uctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
Krzysztof Helt7779f752008-07-31 21:03:41 +0200632 struct snd_wss *chip = snd_kcontrol_chip(kctl);
Takashi Iwaibe624532005-11-17 14:42:05 +0100633 struct snd_card *card = chip->card;
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200634 struct soundscape *s = get_card_soundscape(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 unsigned long flags;
636 int change;
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200637 unsigned char new_val;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 spin_lock_irqsave(&s->lock, flags);
640
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200641 new_val = uctl->value.integer.value[0] & 127;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 /*
643 * We need to put the board into HOST mode before we
644 * can send any volume-changing HOST commands ...
645 */
646 set_host_mode_unsafe(s->io_base);
647
648 /*
649 * To successfully change the MIDI volume setting, you seem to
650 * have to write a volume command, write the new volume value,
651 * and then perform another volume-related command. Perhaps the
652 * first command is an "open" and the second command is a "close"?
653 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200654 if (s->midi_vol == new_val) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 change = 0;
656 goto __skip_change;
657 }
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200658 change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
659 && host_write_ctrl_unsafe(s->io_base, new_val, 100)
660 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
661 && host_write_ctrl_unsafe(s->io_base, new_val, 100);
662 s->midi_vol = new_val;
663__skip_change:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
665 /*
666 * Take the board out of HOST mode and back into MIDI mode ...
667 */
668 set_midi_mode_unsafe(s->io_base);
669
670 spin_unlock_irqrestore(&s->lock, flags);
671 return change;
672}
673
Bhumika Goyal3a84d6c2017-05-17 17:08:56 +0530674static const struct snd_kcontrol_new midi_mixer_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
676 .name = "MIDI",
677 .info = sscape_midi_info,
678 .get = sscape_midi_get,
679 .put = sscape_midi_put
680};
681
682/*
683 * The SoundScape can use two IRQs from a possible set of four.
684 * These IRQs are encoded as bit patterns so that they can be
685 * written to the control registers.
686 */
Bill Pemberton1bff2922012-12-06 12:35:21 -0500687static unsigned get_irq_config(int sscape_type, int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688{
689 static const int valid_irq[] = { 9, 5, 7, 10 };
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200690 static const int old_irq[] = { 9, 7, 5, 15 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 unsigned cfg;
692
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200693 if (sscape_type == MEDIA_FX) {
694 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
695 if (irq == old_irq[cfg])
696 return cfg;
697 } else {
698 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
699 if (irq == valid_irq[cfg])
700 return cfg;
701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
703 return INVALID_IRQ;
704}
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/*
707 * Perform certain arcane port-checks to see whether there
708 * is a SoundScape board lurking behind the given ports.
709 */
Bill Pemberton1bff2922012-12-06 12:35:21 -0500710static int detect_sscape(struct soundscape *s, long wss_io)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
712 unsigned long flags;
713 unsigned d;
714 int retval = 0;
715
716 spin_lock_irqsave(&s->lock, flags);
717
718 /*
719 * The following code is lifted from the original OSS driver,
720 * and as I don't have a datasheet I cannot really comment
721 * on what it is doing...
722 */
723 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
724 goto _done;
725
726 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
727 if ((d & 0x80) != 0)
728 goto _done;
729
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100730 if (d == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 s->ic_type = IC_ODIE;
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100732 else if ((d & 0x60) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 s->ic_type = IC_OPUS;
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100734 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 goto _done;
736
737 outb(0xfa, ODIE_ADDR_IO(s->io_base));
738 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
739 goto _done;
740
741 outb(0xfe, ODIE_ADDR_IO(s->io_base));
742 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
743 goto _done;
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200744
745 outb(0xfe, ODIE_ADDR_IO(s->io_base));
746 d = inb(ODIE_DATA_IO(s->io_base));
747 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 goto _done;
749
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200750 if (s->ic_type == IC_OPUS)
751 activate_ad1845_unsafe(s->io_base);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200752
753 if (s->type == SSCAPE_VIVO)
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100754 wss_io += 4;
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200755
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200756 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200757 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
758
759 /* wait for WSS codec */
760 for (d = 0; d < 500; d++) {
761 if ((inb(wss_io) & 0x80) == 0)
762 break;
763 spin_unlock_irqrestore(&s->lock, flags);
764 msleep(1);
765 spin_lock_irqsave(&s->lock, flags);
766 }
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200767
768 if ((inb(wss_io) & 0x80) != 0)
769 goto _done;
770
771 if (inb(wss_io + 2) == 0xff)
772 goto _done;
773
774 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
775 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
776
777 if ((inb(wss_io) & 0x80) != 0)
778 s->type = MEDIA_FX;
779
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200780 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200781 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200782 /* wait for WSS codec */
783 for (d = 0; d < 500; d++) {
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100784 if ((inb(wss_io) & 0x80) == 0)
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200785 break;
786 spin_unlock_irqrestore(&s->lock, flags);
787 msleep(1);
788 spin_lock_irqsave(&s->lock, flags);
789 }
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 /*
792 * SoundScape successfully detected!
793 */
794 retval = 1;
795
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200796_done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 spin_unlock_irqrestore(&s->lock, flags);
798 return retval;
799}
800
801/*
802 * ALSA callback function, called when attempting to open the MIDI device.
803 * Check that the MIDI firmware has been loaded, because we don't want
804 * to crash the machine. Also check that someone isn't using the hardware
805 * IOCTL device.
806 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200807static int mpu401_open(struct snd_mpu401 *mpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 if (!verify_mpu401(mpu)) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200810 snd_printk(KERN_ERR "sscape: MIDI disabled, "
811 "please load firmware\n");
812 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
814
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200815 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
817
818/*
819 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
820 */
Bill Pemberton1bff2922012-12-06 12:35:21 -0500821static int create_mpu401(struct snd_card *card, int devnum,
822 unsigned long port, int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
824 struct soundscape *sscape = get_card_soundscape(card);
Takashi Iwaibe624532005-11-17 14:42:05 +0100825 struct snd_rawmidi *rawmidi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 int err;
827
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200828 err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
Clemens Ladischdba8b462011-09-13 11:24:41 +0200829 MPU401_INFO_INTEGRATED, irq, &rawmidi);
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200830 if (err == 0) {
831 struct snd_mpu401 *mpu = rawmidi->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 mpu->open_input = mpu401_open;
833 mpu->open_output = mpu401_open;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 mpu->private_data = sscape;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 initialise_mpu401(mpu);
837 }
838
839 return err;
840}
841
842
843/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
845 * is very much like a CS4231, with a few extra bits. We will
846 * try to support at least some of the extra bits by overriding
847 * some of the CS4231 callback.
848 */
Bill Pemberton1bff2922012-12-06 12:35:21 -0500849static int create_ad1845(struct snd_card *card, unsigned port,
850 int irq, int dma1, int dma2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
852 register struct soundscape *sscape = get_card_soundscape(card);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200853 struct snd_wss *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 int err;
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +0200855 int codec_type = WSS_HW_DETECT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +0200857 switch (sscape->type) {
858 case MEDIA_FX:
859 case SSCAPE:
860 /*
861 * There are some freak examples of early Soundscape cards
862 * with CS4231 instead of AD1848/CS4248. Unfortunately, the
863 * CS4231 works only in CS4248 compatibility mode on
864 * these cards so force it.
865 */
866 if (sscape->ic_type != IC_OPUS)
867 codec_type = WSS_HW_AD1848;
868 break;
869
870 case SSCAPE_VIVO:
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200871 port += 4;
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +0200872 break;
873 default:
874 break;
875 }
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200876
Krzysztof Helt7779f752008-07-31 21:03:41 +0200877 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +0200878 codec_type, WSS_HWSHARE_DMA1, &chip);
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200879 if (!err) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200882 if (sscape->type != SSCAPE_VIVO) {
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200883 /*
884 * The input clock frequency on the SoundScape must
885 * be 14.31818 MHz, because we must set this register
886 * to get the playback to sound correct ...
887 */
Krzysztof Helt7779f752008-07-31 21:03:41 +0200888 snd_wss_mce_up(chip);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200889 spin_lock_irqsave(&chip->reg_lock, flags);
Krzysztof Helt199f7972009-01-09 23:10:52 +0100890 snd_wss_out(chip, AD1845_CLOCK, 0x20);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200891 spin_unlock_irqrestore(&chip->reg_lock, flags);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200892 snd_wss_mce_down(chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200894 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Lars-Peter Clausenfa60c062015-01-02 12:24:43 +0100896 err = snd_wss_pcm(chip, 0);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200897 if (err < 0) {
898 snd_printk(KERN_ERR "sscape: No PCM device "
899 "for AD1845 chip\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 goto _error;
901 }
902
Krzysztof Helt7779f752008-07-31 21:03:41 +0200903 err = snd_wss_mixer(chip);
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200904 if (err < 0) {
905 snd_printk(KERN_ERR "sscape: No mixer device "
906 "for AD1845 chip\n");
907 goto _error;
908 }
Krzysztof Helt199f7972009-01-09 23:10:52 +0100909 if (chip->hardware != WSS_HW_AD1848) {
Lars-Peter Clausenfa60c062015-01-02 12:24:43 +0100910 err = snd_wss_timer(chip, 0);
Krzysztof Helt199f7972009-01-09 23:10:52 +0100911 if (err < 0) {
912 snd_printk(KERN_ERR "sscape: No timer device "
913 "for AD1845 chip\n");
914 goto _error;
915 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 }
917
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200918 if (sscape->type != SSCAPE_VIVO) {
919 err = snd_ctl_add(card,
920 snd_ctl_new1(&midi_mixer_ctl, chip));
921 if (err < 0) {
922 snd_printk(KERN_ERR "sscape: Could not create "
923 "MIDI mixer control\n");
924 goto _error;
925 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 }
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 sscape->chip = chip;
929 }
930
Krzysztof Helt6fcfa392009-10-10 10:27:58 +0200931_error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 return err;
933}
934
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936/*
937 * Create an ALSA soundcard entry for the SoundScape, using
938 * the given list of port, IRQ and DMA resources.
939 */
Bill Pemberton1bff2922012-12-06 12:35:21 -0500940static int create_sscape(int dev, struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941{
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200942 struct soundscape *sscape = get_card_soundscape(card);
943 unsigned dma_cfg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 unsigned irq_cfg;
945 unsigned mpu_irq_cfg;
946 struct resource *io_res;
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200947 struct resource *wss_res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 unsigned long flags;
949 int err;
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +0200950 int val;
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200951 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953 /*
954 * Grab IO ports that we will need to probe so that we
955 * can detect and control this hardware ...
956 */
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100957 io_res = request_region(port[dev], 8, "SoundScape");
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200958 if (!io_res) {
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100959 snd_printk(KERN_ERR
960 "sscape: can't grab port 0x%lx\n", port[dev]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 return -EBUSY;
962 }
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200963 wss_res = NULL;
964 if (sscape->type == SSCAPE_VIVO) {
965 wss_res = request_region(wss_port[dev], 4, "SoundScape");
966 if (!wss_res) {
967 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
968 wss_port[dev]);
969 err = -EBUSY;
970 goto _release_region;
971 }
972 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
974 /*
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200975 * Grab one DMA channel ...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200977 err = request_dma(dma[dev], "SoundScape");
978 if (err < 0) {
Takashi Iwai277e9262005-11-17 17:13:12 +0100979 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 goto _release_region;
981 }
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 spin_lock_init(&sscape->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 sscape->io_res = io_res;
Krzysztof Heltec1e7942007-09-17 17:57:37 +0200985 sscape->wss_res = wss_res;
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100986 sscape->io_base = port[dev];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Krzysztof Helt453e37b2009-02-04 17:41:32 +0100988 if (!detect_sscape(sscape, wss_port[dev])) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +0200989 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
990 sscape->io_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 err = -ENODEV;
Krzysztof Helt4996bca2007-09-17 16:23:13 +0200992 goto _release_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 }
994
Krzysztof Heltf0968e32009-09-27 23:08:40 +0200995 switch (sscape->type) {
996 case MEDIA_FX:
997 name = "MediaFX/SoundFX";
998 break;
999 case SSCAPE:
1000 name = "Soundscape";
1001 break;
1002 case SSCAPE_PNP:
1003 name = "Soundscape PnP";
1004 break;
1005 case SSCAPE_VIVO:
1006 name = "Soundscape VIVO";
1007 break;
1008 default:
1009 name = "unknown Soundscape";
1010 break;
1011 }
1012
1013 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1014 name, sscape->io_base, irq[dev], dma[dev]);
1015
1016 /*
1017 * Check that the user didn't pass us garbage data ...
1018 */
1019 irq_cfg = get_irq_config(sscape->type, irq[dev]);
1020 if (irq_cfg == INVALID_IRQ) {
1021 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
Julia Lawall38be95d2012-04-09 10:16:35 +02001022 err = -ENXIO;
1023 goto _release_dma;
Krzysztof Heltf0968e32009-09-27 23:08:40 +02001024 }
1025
1026 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1027 if (mpu_irq_cfg == INVALID_IRQ) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001028 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
Julia Lawall38be95d2012-04-09 10:16:35 +02001029 err = -ENXIO;
1030 goto _release_dma;
Krzysztof Heltf0968e32009-09-27 23:08:40 +02001031 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 /*
1034 * Tell the on-board devices where their resources are (I think -
1035 * I can't be sure without a datasheet ... So many magic values!)
1036 */
1037 spin_lock_irqsave(&sscape->lock, flags);
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1040 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1041
1042 /*
1043 * Enable and configure the DMA channels ...
1044 */
1045 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
Krzysztof Heltf0968e32009-09-27 23:08:40 +02001046 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1048 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1049
Krzysztof Heltf0968e32009-09-27 23:08:40 +02001050 mpu_irq_cfg |= mpu_irq_cfg << 2;
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +02001051 val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1052 if (joystick[dev])
1053 val |= 8;
1054 sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
Krzysztof Heltf0968e32009-09-27 23:08:40 +02001055 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 sscape_write_unsafe(sscape->io_base,
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001057 GA_CDCFG_REG, 0x09 | DMA_8BIT
1058 | (dma[dev] << 4) | (irq_cfg << 1));
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001059 /*
1060 * Enable the master IRQ ...
1061 */
1062 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
1064 spin_unlock_irqrestore(&sscape->lock, flags);
1065
1066 /*
1067 * We have now enabled the codec chip, and so we should
1068 * detect the AD1845 device ...
1069 */
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001070 err = create_ad1845(card, wss_port[dev], irq[dev],
1071 dma[dev], dma2[dev]);
1072 if (err < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001073 snd_printk(KERN_ERR
1074 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1075 wss_port[dev], irq[dev]);
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001076 goto _release_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 }
Krzysztof Heltacd471002009-10-01 00:10:34 +02001078 strcpy(card->driver, "SoundScape");
1079 strcpy(card->shortname, name);
1080 snprintf(card->longname, sizeof(card->longname),
1081 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1082 name, sscape->chip->port, sscape->chip->irq,
1083 sscape->chip->dma1, sscape->chip->dma2);
1084
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085#define MIDI_DEVNUM 0
Krzysztof Heltec1e7942007-09-17 17:57:37 +02001086 if (sscape->type != SSCAPE_VIVO) {
Krzysztof Heltacd471002009-10-01 00:10:34 +02001087 err = sscape_upload_bootblock(card);
1088 if (err >= 0)
1089 err = sscape_upload_microcode(card, err);
1090
1091 if (err == 0) {
1092 err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1093 mpu_irq[dev]);
1094 if (err < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001095 snd_printk(KERN_ERR "sscape: Failed to create "
Krzysztof Heltacd471002009-10-01 00:10:34 +02001096 "MPU-401 device at 0x%lx\n",
1097 port[dev]);
1098 goto _release_dma;
1099 }
1100
1101 /*
Krzysztof Heltacd471002009-10-01 00:10:34 +02001102 * Initialize mixer
1103 */
1104 spin_lock_irqsave(&sscape->lock, flags);
1105 sscape->midi_vol = 0;
1106 host_write_ctrl_unsafe(sscape->io_base,
1107 CMD_SET_MIDI_VOL, 100);
1108 host_write_ctrl_unsafe(sscape->io_base,
1109 sscape->midi_vol, 100);
1110 host_write_ctrl_unsafe(sscape->io_base,
1111 CMD_XXX_MIDI_VOL, 100);
1112 host_write_ctrl_unsafe(sscape->io_base,
1113 sscape->midi_vol, 100);
1114 host_write_ctrl_unsafe(sscape->io_base,
1115 CMD_SET_EXTMIDI, 100);
1116 host_write_ctrl_unsafe(sscape->io_base,
1117 0, 100);
1118 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1119
1120 set_midi_mode_unsafe(sscape->io_base);
1121 spin_unlock_irqrestore(&sscape->lock, flags);
Krzysztof Heltec1e7942007-09-17 17:57:37 +02001122 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
1124
1125 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 * Now that we have successfully created this sound card,
1127 * it is safe to store the pointer.
1128 * NOTE: we only register the sound card's "destructor"
1129 * function now that our "constructor" has completed.
1130 */
1131 card->private_free = soundscape_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132
1133 return 0;
1134
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001135_release_dma:
Takashi Iwai277e9262005-11-17 17:13:12 +01001136 free_dma(dma[dev]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001138_release_region:
Krzysztof Heltec1e7942007-09-17 17:57:37 +02001139 release_and_free_resource(wss_res);
Takashi Iwaib1d57762005-10-10 11:56:31 +02001140 release_and_free_resource(io_res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
1142 return err;
1143}
1144
1145
Bill Pemberton1bff2922012-12-06 12:35:21 -05001146static int snd_sscape_match(struct device *pdev, unsigned int i)
Takashi Iwai277e9262005-11-17 17:13:12 +01001147{
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001148 /*
1149 * Make sure we were given ALL of the other parameters.
1150 */
1151 if (port[i] == SNDRV_AUTO_PORT)
1152 return 0;
1153
1154 if (irq[i] == SNDRV_AUTO_IRQ ||
1155 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1156 dma[i] == SNDRV_AUTO_DMA) {
1157 printk(KERN_INFO
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001158 "sscape: insufficient parameters, "
1159 "need IO, IRQ, MPU-IRQ and DMA\n");
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001160 return 0;
1161 }
1162
1163 return 1;
1164}
1165
Bill Pemberton1bff2922012-12-06 12:35:21 -05001166static int snd_sscape_probe(struct device *pdev, unsigned int dev)
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001167{
Takashi Iwai277e9262005-11-17 17:13:12 +01001168 struct snd_card *card;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001169 struct soundscape *sscape;
Takashi Iwai277e9262005-11-17 17:13:12 +01001170 int ret;
1171
Takashi Iwai4323cc42014-01-29 13:03:56 +01001172 ret = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
1173 sizeof(struct soundscape), &card);
Takashi Iwaic95eadd2008-12-28 16:43:35 +01001174 if (ret < 0)
1175 return ret;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001176
1177 sscape = get_card_soundscape(card);
1178 sscape->type = SSCAPE;
1179
Takashi Iwai277e9262005-11-17 17:13:12 +01001180 dma[dev] &= 0x03;
Krzysztof Heltacd471002009-10-01 00:10:34 +02001181
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001182 ret = create_sscape(dev, card);
Takashi Iwai277e9262005-11-17 17:13:12 +01001183 if (ret < 0)
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001184 goto _release_card;
1185
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001186 ret = snd_card_register(card);
1187 if (ret < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001188 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001189 goto _release_card;
Takashi Iwai277e9262005-11-17 17:13:12 +01001190 }
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001191 dev_set_drvdata(pdev, card);
Takashi Iwai277e9262005-11-17 17:13:12 +01001192 return 0;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001193
1194_release_card:
1195 snd_card_free(card);
1196 return ret;
Takashi Iwai277e9262005-11-17 17:13:12 +01001197}
1198
Bill Pemberton1bff2922012-12-06 12:35:21 -05001199static int snd_sscape_remove(struct device *devptr, unsigned int dev)
Takashi Iwai277e9262005-11-17 17:13:12 +01001200{
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001201 snd_card_free(dev_get_drvdata(devptr));
Takashi Iwai277e9262005-11-17 17:13:12 +01001202 return 0;
1203}
1204
Rene Herman83c51c02007-03-20 11:33:46 +01001205#define DEV_NAME "sscape"
Takashi Iwai277e9262005-11-17 17:13:12 +01001206
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001207static struct isa_driver snd_sscape_driver = {
1208 .match = snd_sscape_match,
Takashi Iwai277e9262005-11-17 17:13:12 +01001209 .probe = snd_sscape_probe,
Bill Pemberton1bff2922012-12-06 12:35:21 -05001210 .remove = snd_sscape_remove,
Takashi Iwai277e9262005-11-17 17:13:12 +01001211 /* FIXME: suspend/resume */
1212 .driver = {
Rene Herman83c51c02007-03-20 11:33:46 +01001213 .name = DEV_NAME
Takashi Iwai277e9262005-11-17 17:13:12 +01001214 },
1215};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
1217#ifdef CONFIG_PNP
Bill Pemberton1bff2922012-12-06 12:35:21 -05001218static inline int get_next_autoindex(int i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Takashi Iwai277e9262005-11-17 17:13:12 +01001220 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 ++i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 return i;
1223}
1224
1225
Bill Pemberton1bff2922012-12-06 12:35:21 -05001226static int sscape_pnp_detect(struct pnp_card_link *pcard,
1227 const struct pnp_card_device_id *pid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 static int idx = 0;
Takashi Iwai277e9262005-11-17 17:13:12 +01001230 struct pnp_dev *dev;
1231 struct snd_card *card;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001232 struct soundscape *sscape;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 int ret;
1234
1235 /*
1236 * Allow this function to fail *quietly* if all the ISA PnP
1237 * devices were configured using module parameters instead.
1238 */
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001239 idx = get_next_autoindex(idx);
1240 if (idx >= SNDRV_CARDS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242
1243 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 * Check that we still have room for another sound card ...
1245 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001247 if (!dev)
Takashi Iwai277e9262005-11-17 17:13:12 +01001248 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Takashi Iwai277e9262005-11-17 17:13:12 +01001250 if (!pnp_is_active(dev)) {
1251 if (pnp_activate_dev(dev) < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001252 snd_printk(KERN_INFO "sscape: device is inactive\n");
Takashi Iwai277e9262005-11-17 17:13:12 +01001253 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 }
1255 }
1256
Takashi Iwai277e9262005-11-17 17:13:12 +01001257 /*
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001258 * Create a new ALSA sound card entry, in anticipation
1259 * of detecting our hardware ...
1260 */
Takashi Iwai4323cc42014-01-29 13:03:56 +01001261 ret = snd_card_new(&pcard->card->dev,
1262 index[idx], id[idx], THIS_MODULE,
1263 sizeof(struct soundscape), &card);
Takashi Iwaic95eadd2008-12-28 16:43:35 +01001264 if (ret < 0)
1265 return ret;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001266
1267 sscape = get_card_soundscape(card);
1268
1269 /*
1270 * Identify card model ...
1271 */
1272 if (!strncmp("ENS4081", pid->id, 7))
1273 sscape->type = SSCAPE_VIVO;
1274 else
1275 sscape->type = SSCAPE_PNP;
1276
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001277 /*
Takashi Iwai277e9262005-11-17 17:13:12 +01001278 * Read the correct parameters off the ISA PnP bus ...
1279 */
1280 port[idx] = pnp_port_start(dev, 0);
1281 irq[idx] = pnp_irq(dev, 0);
1282 mpu_irq[idx] = pnp_irq(dev, 1);
1283 dma[idx] = pnp_dma(dev, 0) & 0x03;
Krzysztof Heltec1e7942007-09-17 17:57:37 +02001284 if (sscape->type == SSCAPE_PNP) {
1285 dma2[idx] = dma[idx];
1286 wss_port[idx] = CODEC_IO(port[idx]);
1287 } else {
1288 wss_port[idx] = pnp_port_start(dev, 1);
1289 dma2[idx] = pnp_dma(dev, 1);
1290 }
Takashi Iwai277e9262005-11-17 17:13:12 +01001291
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001292 ret = create_sscape(idx, card);
Takashi Iwai277e9262005-11-17 17:13:12 +01001293 if (ret < 0)
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001294 goto _release_card;
1295
Krzysztof Helt6fcfa392009-10-10 10:27:58 +02001296 ret = snd_card_register(card);
1297 if (ret < 0) {
Krzysztof Heltbcde1f82009-10-02 18:41:29 +02001298 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001299 goto _release_card;
Takashi Iwai277e9262005-11-17 17:13:12 +01001300 }
1301
1302 pnp_set_card_drvdata(pcard, card);
1303 ++idx;
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001304 return 0;
Takashi Iwai277e9262005-11-17 17:13:12 +01001305
Krzysztof Helt4996bca2007-09-17 16:23:13 +02001306_release_card:
1307 snd_card_free(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 return ret;
1309}
1310
Bill Pemberton1bff2922012-12-06 12:35:21 -05001311static void sscape_pnp_remove(struct pnp_card_link *pcard)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312{
Takashi Iwai277e9262005-11-17 17:13:12 +01001313 snd_card_free(pnp_get_card_drvdata(pcard));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 pnp_set_card_drvdata(pcard, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315}
1316
1317static struct pnp_card_driver sscape_pnpc_driver = {
1318 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1319 .name = "sscape",
1320 .id_table = sscape_pnpids,
1321 .probe = sscape_pnp_detect,
Bill Pemberton1bff2922012-12-06 12:35:21 -05001322 .remove = sscape_pnp_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323};
1324
1325#endif /* CONFIG_PNP */
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327static int __init sscape_init(void)
1328{
Rene Herman609d7692007-05-15 11:42:56 +02001329 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Rene Herman609d7692007-05-15 11:42:56 +02001331 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
Takashi Iwai59b1b342006-01-04 15:06:44 +01001332#ifdef CONFIG_PNP
Rene Herman609d7692007-05-15 11:42:56 +02001333 if (!err)
1334 isa_registered = 1;
1335
1336 err = pnp_register_card_driver(&sscape_pnpc_driver);
1337 if (!err)
Clemens Ladischf7a92752005-12-07 09:13:42 +01001338 pnp_registered = 1;
Rene Herman609d7692007-05-15 11:42:56 +02001339
1340 if (isa_registered)
1341 err = 0;
Takashi Iwai59b1b342006-01-04 15:06:44 +01001342#endif
Rene Herman609d7692007-05-15 11:42:56 +02001343 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344}
1345
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001346static void __exit sscape_exit(void)
1347{
1348#ifdef CONFIG_PNP
1349 if (pnp_registered)
1350 pnp_unregister_card_driver(&sscape_pnpc_driver);
Rene Herman609d7692007-05-15 11:42:56 +02001351 if (isa_registered)
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001352#endif
Rene Herman609d7692007-05-15 11:42:56 +02001353 isa_unregister_driver(&snd_sscape_driver);
Takashi Iwai5e24c1c2007-02-22 12:50:54 +01001354}
1355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356module_init(sscape_init);
1357module_exit(sscape_exit);