Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Low-level ALSA driver for the ENSONIQ SoundScape PnP |
| 3 | * 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 | |
| 24 | #include <sound/driver.h> |
| 25 | #include <linux/init.h> |
| 26 | #include <linux/delay.h> |
| 27 | #include <linux/pnp.h> |
| 28 | #include <linux/spinlock.h> |
| 29 | #include <linux/moduleparam.h> |
| 30 | #include <asm/dma.h> |
| 31 | #include <sound/core.h> |
| 32 | #include <sound/hwdep.h> |
| 33 | #include <sound/cs4231.h> |
| 34 | #include <sound/mpu401.h> |
| 35 | #include <sound/initval.h> |
| 36 | |
| 37 | #include <sound/sscape_ioctl.h> |
| 38 | |
| 39 | |
| 40 | MODULE_AUTHOR("Chris Rankin"); |
| 41 | MODULE_DESCRIPTION("ENSONIQ SoundScape PnP driver"); |
| 42 | MODULE_LICENSE("GPL"); |
| 43 | |
| 44 | static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX; |
| 45 | static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR; |
| 46 | static long port[SNDRV_CARDS] __devinitdata = { [0 ... (SNDRV_CARDS-1)] = SNDRV_AUTO_PORT }; |
| 47 | static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ; |
| 48 | static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ; |
| 49 | static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA; |
| 50 | |
| 51 | module_param_array(index, int, NULL, 0444); |
| 52 | MODULE_PARM_DESC(index, "Index number for SoundScape soundcard"); |
| 53 | |
| 54 | module_param_array(id, charp, NULL, 0444); |
| 55 | MODULE_PARM_DESC(id, "Description for SoundScape card"); |
| 56 | |
| 57 | module_param_array(port, long, NULL, 0444); |
| 58 | MODULE_PARM_DESC(port, "Port # for SoundScape driver."); |
| 59 | |
| 60 | module_param_array(irq, int, NULL, 0444); |
| 61 | MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver."); |
| 62 | |
| 63 | module_param_array(mpu_irq, int, NULL, 0444); |
| 64 | MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver."); |
| 65 | |
| 66 | module_param_array(dma, int, NULL, 0444); |
| 67 | MODULE_PARM_DESC(dma, "DMA # for SoundScape driver."); |
| 68 | |
| 69 | #ifdef CONFIG_PNP |
| 70 | static struct pnp_card_device_id sscape_pnpids[] = { |
| 71 | { .id = "ENS3081", .devs = { { "ENS0000" } } }, |
| 72 | { .id = "" } /* end */ |
| 73 | }; |
| 74 | |
| 75 | MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids); |
| 76 | #endif |
| 77 | |
| 78 | static snd_card_t *sscape_card[SNDRV_CARDS]; |
| 79 | |
| 80 | |
| 81 | #define MPU401_IO(i) ((i) + 0) |
| 82 | #define MIDI_DATA_IO(i) ((i) + 0) |
| 83 | #define MIDI_CTRL_IO(i) ((i) + 1) |
| 84 | #define HOST_CTRL_IO(i) ((i) + 2) |
| 85 | #define HOST_DATA_IO(i) ((i) + 3) |
| 86 | #define ODIE_ADDR_IO(i) ((i) + 4) |
| 87 | #define ODIE_DATA_IO(i) ((i) + 5) |
| 88 | #define CODEC_IO(i) ((i) + 8) |
| 89 | |
| 90 | #define IC_ODIE 1 |
| 91 | #define IC_OPUS 2 |
| 92 | |
| 93 | #define RX_READY 0x01 |
| 94 | #define TX_READY 0x02 |
| 95 | |
| 96 | #define CMD_ACK 0x80 |
| 97 | #define CMD_SET_MIDI_VOL 0x84 |
| 98 | #define CMD_GET_MIDI_VOL 0x85 |
| 99 | #define CMD_XXX_MIDI_VOL 0x86 |
| 100 | #define CMD_SET_EXTMIDI 0x8a |
| 101 | #define CMD_GET_EXTMIDI 0x8b |
| 102 | #define CMD_SET_MT32 0x8c |
| 103 | #define CMD_GET_MT32 0x8d |
| 104 | |
| 105 | enum GA_REG { |
| 106 | GA_INTSTAT_REG = 0, |
| 107 | GA_INTENA_REG, |
| 108 | GA_DMAA_REG, |
| 109 | GA_DMAB_REG, |
| 110 | GA_INTCFG_REG, |
| 111 | GA_DMACFG_REG, |
| 112 | GA_CDCFG_REG, |
| 113 | GA_SMCFGA_REG, |
| 114 | GA_SMCFGB_REG, |
| 115 | GA_HMCTL_REG |
| 116 | }; |
| 117 | |
| 118 | #define DMA_8BIT 0x80 |
| 119 | |
| 120 | |
| 121 | #define AD1845_FREQ_SEL_MSB 0x16 |
| 122 | #define AD1845_FREQ_SEL_LSB 0x17 |
| 123 | |
| 124 | struct soundscape { |
| 125 | spinlock_t lock; |
| 126 | unsigned io_base; |
| 127 | int codec_type; |
| 128 | int ic_type; |
| 129 | struct resource *io_res; |
| 130 | cs4231_t *chip; |
| 131 | mpu401_t *mpu; |
| 132 | snd_hwdep_t *hw; |
| 133 | |
| 134 | /* |
| 135 | * The MIDI device won't work until we've loaded |
| 136 | * its firmware via a hardware-dependent device IOCTL |
| 137 | */ |
| 138 | spinlock_t fwlock; |
| 139 | int hw_in_use; |
| 140 | unsigned long midi_usage; |
| 141 | unsigned char midi_vol; |
| 142 | }; |
| 143 | |
| 144 | #define INVALID_IRQ ((unsigned)-1) |
| 145 | |
| 146 | |
| 147 | static inline struct soundscape *get_card_soundscape(snd_card_t * c) |
| 148 | { |
| 149 | return (struct soundscape *) (c->private_data); |
| 150 | } |
| 151 | |
| 152 | static inline struct soundscape *get_mpu401_soundscape(mpu401_t * mpu) |
| 153 | { |
| 154 | return (struct soundscape *) (mpu->private_data); |
| 155 | } |
| 156 | |
| 157 | static inline struct soundscape *get_hwdep_soundscape(snd_hwdep_t * hw) |
| 158 | { |
| 159 | return (struct soundscape *) (hw->private_data); |
| 160 | } |
| 161 | |
| 162 | |
| 163 | /* |
| 164 | * Allocates some kernel memory that we can use for DMA. |
| 165 | * I think this means that the memory has to map to |
| 166 | * contiguous pages of physical memory. |
| 167 | */ |
| 168 | static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size) |
| 169 | { |
| 170 | if (buf) { |
| 171 | if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(), |
| 172 | size, buf) < 0) { |
| 173 | snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size); |
| 174 | return NULL; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | return buf; |
| 179 | } |
| 180 | |
| 181 | /* |
| 182 | * Release the DMA-able kernel memory ... |
| 183 | */ |
| 184 | static void free_dmabuf(struct snd_dma_buffer *buf) |
| 185 | { |
| 186 | if (buf && buf->area) |
| 187 | snd_dma_free_pages(buf); |
| 188 | } |
| 189 | |
| 190 | |
| 191 | /* |
| 192 | * This function writes to the SoundScape's control registers, |
| 193 | * but doesn't do any locking. It's up to the caller to do that. |
| 194 | * This is why this function is "unsafe" ... |
| 195 | */ |
| 196 | static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val) |
| 197 | { |
| 198 | outb(reg, ODIE_ADDR_IO(io_base)); |
| 199 | outb(val, ODIE_DATA_IO(io_base)); |
| 200 | } |
| 201 | |
| 202 | /* |
| 203 | * Write to the SoundScape's control registers, and do the |
| 204 | * necessary locking ... |
| 205 | */ |
| 206 | static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val) |
| 207 | { |
| 208 | unsigned long flags; |
| 209 | |
| 210 | spin_lock_irqsave(&s->lock, flags); |
| 211 | sscape_write_unsafe(s->io_base, reg, val); |
| 212 | spin_unlock_irqrestore(&s->lock, flags); |
| 213 | } |
| 214 | |
| 215 | /* |
| 216 | * Read from the SoundScape's control registers, but leave any |
| 217 | * locking to the caller. This is why the function is "unsafe" ... |
| 218 | */ |
| 219 | static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg) |
| 220 | { |
| 221 | outb(reg, ODIE_ADDR_IO(io_base)); |
| 222 | return inb(ODIE_DATA_IO(io_base)); |
| 223 | } |
| 224 | |
| 225 | /* |
| 226 | * Puts the SoundScape into "host" mode, as compared to "MIDI" mode |
| 227 | */ |
| 228 | static inline void set_host_mode_unsafe(unsigned io_base) |
| 229 | { |
| 230 | outb(0x0, HOST_CTRL_IO(io_base)); |
| 231 | } |
| 232 | |
| 233 | /* |
| 234 | * Puts the SoundScape into "MIDI" mode, as compared to "host" mode |
| 235 | */ |
| 236 | static inline void set_midi_mode_unsafe(unsigned io_base) |
| 237 | { |
| 238 | outb(0x3, HOST_CTRL_IO(io_base)); |
| 239 | } |
| 240 | |
| 241 | /* |
| 242 | * Read the SoundScape's host-mode control register, but leave |
| 243 | * any locking issues to the caller ... |
| 244 | */ |
| 245 | static inline int host_read_unsafe(unsigned io_base) |
| 246 | { |
| 247 | int data = -1; |
| 248 | if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) { |
| 249 | data = inb(HOST_DATA_IO(io_base)); |
| 250 | } |
| 251 | |
| 252 | return data; |
| 253 | } |
| 254 | |
| 255 | /* |
| 256 | * Read the SoundScape's host-mode control register, performing |
| 257 | * a limited amount of busy-waiting if the register isn't ready. |
| 258 | * Also leaves all locking-issues to the caller ... |
| 259 | */ |
| 260 | static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout) |
| 261 | { |
| 262 | int data; |
| 263 | |
| 264 | while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) { |
| 265 | udelay(100); |
| 266 | --timeout; |
| 267 | } /* while */ |
| 268 | |
| 269 | return data; |
| 270 | } |
| 271 | |
| 272 | /* |
| 273 | * Write to the SoundScape's host-mode control registers, but |
| 274 | * leave any locking issues to the caller ... |
| 275 | */ |
| 276 | static inline int host_write_unsafe(unsigned io_base, unsigned char data) |
| 277 | { |
| 278 | if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) { |
| 279 | outb(data, HOST_DATA_IO(io_base)); |
| 280 | return 1; |
| 281 | } |
| 282 | |
| 283 | return 0; |
| 284 | } |
| 285 | |
| 286 | /* |
| 287 | * Write to the SoundScape's host-mode control registers, performing |
| 288 | * a limited amount of busy-waiting if the register isn't ready. |
| 289 | * Also leaves all locking-issues to the caller ... |
| 290 | */ |
| 291 | static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data, |
| 292 | unsigned timeout) |
| 293 | { |
| 294 | int err; |
| 295 | |
| 296 | while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) { |
| 297 | udelay(100); |
| 298 | --timeout; |
| 299 | } /* while */ |
| 300 | |
| 301 | return err; |
| 302 | } |
| 303 | |
| 304 | |
| 305 | /* |
| 306 | * Check that the MIDI subsystem is operational. If it isn't, |
| 307 | * then we will hang the computer if we try to use it ... |
| 308 | * |
| 309 | * NOTE: This check is based upon observation, not documentation. |
| 310 | */ |
| 311 | static inline int verify_mpu401(const mpu401_t * mpu) |
| 312 | { |
| 313 | return ((inb(MIDI_CTRL_IO(mpu->port)) & 0xc0) == 0x80); |
| 314 | } |
| 315 | |
| 316 | /* |
| 317 | * This is apparently the standard way to initailise an MPU-401 |
| 318 | */ |
| 319 | static inline void initialise_mpu401(const mpu401_t * mpu) |
| 320 | { |
| 321 | outb(0, MIDI_DATA_IO(mpu->port)); |
| 322 | } |
| 323 | |
| 324 | /* |
| 325 | * Tell the SoundScape to activate the AD1845 chip (I think). |
| 326 | * The AD1845 detection fails if we *don't* do this, so I |
| 327 | * think that this is a good idea ... |
| 328 | */ |
| 329 | static inline void activate_ad1845_unsafe(unsigned io_base) |
| 330 | { |
| 331 | sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10); |
| 332 | sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80); |
| 333 | } |
| 334 | |
| 335 | /* |
| 336 | * Do the necessary ALSA-level cleanup to deallocate our driver ... |
| 337 | */ |
| 338 | static void soundscape_free(snd_card_t * c) |
| 339 | { |
| 340 | register struct soundscape *sscape = get_card_soundscape(c); |
Takashi Iwai | b1d5776 | 2005-10-10 11:56:31 +0200 | [diff] [blame] | 341 | release_and_free_resource(sscape->io_res); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 342 | free_dma(sscape->chip->dma1); |
| 343 | } |
| 344 | |
| 345 | /* |
| 346 | * Put this process into an idle wait-state for a certain number |
| 347 | * of "jiffies". The process can almost certainly be rescheduled |
| 348 | * while we're waiting, and so we must NOT be holding any spinlocks |
| 349 | * when we call this function. If we are then we risk DEADLOCK in |
| 350 | * SMP (Ha!) or pre-emptible kernels. |
| 351 | */ |
| 352 | static inline void sleep(long jiffs, int state) |
| 353 | { |
| 354 | set_current_state(state); |
| 355 | schedule_timeout(jiffs); |
| 356 | } |
| 357 | |
| 358 | /* |
| 359 | * Tell the SoundScape to begin a DMA tranfer using the given channel. |
| 360 | * All locking issues are left to the caller. |
| 361 | */ |
| 362 | static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg) |
| 363 | { |
| 364 | sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01); |
| 365 | sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe); |
| 366 | } |
| 367 | |
| 368 | /* |
| 369 | * Wait for a DMA transfer to complete. This is a "limited busy-wait", |
| 370 | * and all locking issues are left to the caller. |
| 371 | */ |
| 372 | static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout) |
| 373 | { |
| 374 | while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) { |
| 375 | udelay(100); |
| 376 | --timeout; |
| 377 | } /* while */ |
| 378 | |
| 379 | return (sscape_read_unsafe(io_base, reg) & 0x01); |
| 380 | } |
| 381 | |
| 382 | /* |
| 383 | * Wait for the On-Board Processor to return its start-up |
| 384 | * acknowledgement sequence. This wait is too long for |
| 385 | * us to perform "busy-waiting", and so we must sleep. |
| 386 | * This in turn means that we must not be holding any |
| 387 | * spinlocks when we call this function. |
| 388 | */ |
| 389 | static int obp_startup_ack(struct soundscape *s, unsigned timeout) |
| 390 | { |
| 391 | while (timeout != 0) { |
| 392 | unsigned long flags; |
| 393 | unsigned char x; |
| 394 | |
| 395 | sleep(1, TASK_INTERRUPTIBLE); |
| 396 | |
| 397 | spin_lock_irqsave(&s->lock, flags); |
| 398 | x = inb(HOST_DATA_IO(s->io_base)); |
| 399 | spin_unlock_irqrestore(&s->lock, flags); |
| 400 | if ((x & 0xfe) == 0xfe) |
| 401 | return 1; |
| 402 | |
| 403 | --timeout; |
| 404 | } /* while */ |
| 405 | |
| 406 | return 0; |
| 407 | } |
| 408 | |
| 409 | /* |
| 410 | * Wait for the host to return its start-up acknowledgement |
| 411 | * sequence. This wait is too long for us to perform |
| 412 | * "busy-waiting", and so we must sleep. This in turn means |
| 413 | * that we must not be holding any spinlocks when we call |
| 414 | * this function. |
| 415 | */ |
| 416 | static int host_startup_ack(struct soundscape *s, unsigned timeout) |
| 417 | { |
| 418 | while (timeout != 0) { |
| 419 | unsigned long flags; |
| 420 | unsigned char x; |
| 421 | |
| 422 | sleep(1, TASK_INTERRUPTIBLE); |
| 423 | |
| 424 | spin_lock_irqsave(&s->lock, flags); |
| 425 | x = inb(HOST_DATA_IO(s->io_base)); |
| 426 | spin_unlock_irqrestore(&s->lock, flags); |
| 427 | if (x == 0xfe) |
| 428 | return 1; |
| 429 | |
| 430 | --timeout; |
| 431 | } /* while */ |
| 432 | |
| 433 | return 0; |
| 434 | } |
| 435 | |
| 436 | /* |
| 437 | * Upload a byte-stream into the SoundScape using DMA channel A. |
| 438 | */ |
| 439 | static int upload_dma_data(struct soundscape *s, |
| 440 | const unsigned char __user *data, |
| 441 | size_t size) |
| 442 | { |
| 443 | unsigned long flags; |
| 444 | struct snd_dma_buffer dma; |
| 445 | int ret; |
| 446 | |
| 447 | if (!get_dmabuf(&dma, PAGE_ALIGN(size))) |
| 448 | return -ENOMEM; |
| 449 | |
| 450 | spin_lock_irqsave(&s->lock, flags); |
| 451 | |
| 452 | /* |
| 453 | * Reset the board ... |
| 454 | */ |
| 455 | sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f); |
| 456 | |
| 457 | /* |
| 458 | * Enable the DMA channels and configure them ... |
| 459 | */ |
| 460 | sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50); |
| 461 | sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT); |
| 462 | sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20); |
| 463 | |
| 464 | /* |
| 465 | * Take the board out of reset ... |
| 466 | */ |
| 467 | sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80); |
| 468 | |
| 469 | /* |
| 470 | * Upload the user's data (firmware?) to the SoundScape |
| 471 | * board through the DMA channel ... |
| 472 | */ |
| 473 | while (size != 0) { |
| 474 | unsigned long len; |
| 475 | |
| 476 | /* |
| 477 | * Apparently, copying to/from userspace can sleep. |
| 478 | * We are therefore forbidden from holding any |
| 479 | * spinlocks while we copy ... |
| 480 | */ |
| 481 | spin_unlock_irqrestore(&s->lock, flags); |
| 482 | |
| 483 | /* |
| 484 | * Remember that the data that we want to DMA |
| 485 | * comes from USERSPACE. We have already verified |
| 486 | * the userspace pointer ... |
| 487 | */ |
| 488 | len = min(size, dma.bytes); |
| 489 | len -= __copy_from_user(dma.area, data, len); |
| 490 | data += len; |
| 491 | size -= len; |
| 492 | |
| 493 | /* |
| 494 | * Grab that spinlock again, now that we've |
| 495 | * finished copying! |
| 496 | */ |
| 497 | spin_lock_irqsave(&s->lock, flags); |
| 498 | |
| 499 | snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE); |
| 500 | sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG); |
| 501 | if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) { |
| 502 | /* |
| 503 | * Don't forget to release this spinlock we're holding ... |
| 504 | */ |
| 505 | spin_unlock_irqrestore(&s->lock, flags); |
| 506 | |
| 507 | snd_printk(KERN_ERR "sscape: DMA upload has timed out\n"); |
| 508 | ret = -EAGAIN; |
| 509 | goto _release_dma; |
| 510 | } |
| 511 | } /* while */ |
| 512 | |
| 513 | set_host_mode_unsafe(s->io_base); |
| 514 | |
| 515 | /* |
| 516 | * Boot the board ... (I think) |
| 517 | */ |
| 518 | sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40); |
| 519 | spin_unlock_irqrestore(&s->lock, flags); |
| 520 | |
| 521 | /* |
| 522 | * If all has gone well, then the board should acknowledge |
| 523 | * the new upload and tell us that it has rebooted OK. We |
| 524 | * give it 5 seconds (max) ... |
| 525 | */ |
| 526 | ret = 0; |
| 527 | if (!obp_startup_ack(s, 5)) { |
| 528 | snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n"); |
| 529 | ret = -EAGAIN; |
| 530 | } else if (!host_startup_ack(s, 5)) { |
| 531 | snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n"); |
| 532 | ret = -EAGAIN; |
| 533 | } |
| 534 | |
| 535 | _release_dma: |
| 536 | /* |
| 537 | * NOTE!!! We are NOT holding any spinlocks at this point !!! |
| 538 | */ |
| 539 | sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40)); |
| 540 | free_dmabuf(&dma); |
| 541 | |
| 542 | return ret; |
| 543 | } |
| 544 | |
| 545 | /* |
| 546 | * Upload the bootblock(?) into the SoundScape. The only |
| 547 | * purpose of this block of code seems to be to tell |
| 548 | * us which version of the microcode we should be using. |
| 549 | * |
| 550 | * NOTE: The boot-block data resides in USER-SPACE!!! |
| 551 | * However, we have already verified its memory |
| 552 | * addresses by the time we get here. |
| 553 | */ |
| 554 | static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb) |
| 555 | { |
| 556 | unsigned long flags; |
| 557 | int data = 0; |
| 558 | int ret; |
| 559 | |
| 560 | ret = upload_dma_data(sscape, bb->code, sizeof(bb->code)); |
| 561 | |
| 562 | spin_lock_irqsave(&sscape->lock, flags); |
| 563 | if (ret == 0) { |
| 564 | data = host_read_ctrl_unsafe(sscape->io_base, 100); |
| 565 | } |
| 566 | set_midi_mode_unsafe(sscape->io_base); |
| 567 | spin_unlock_irqrestore(&sscape->lock, flags); |
| 568 | |
| 569 | if (ret == 0) { |
| 570 | if (data < 0) { |
| 571 | snd_printk(KERN_ERR "sscape: timeout reading firmware version\n"); |
| 572 | ret = -EAGAIN; |
| 573 | } |
| 574 | else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) { |
| 575 | ret = -EFAULT; |
| 576 | } |
| 577 | } |
| 578 | |
| 579 | return ret; |
| 580 | } |
| 581 | |
| 582 | /* |
| 583 | * Upload the microcode into the SoundScape. The |
| 584 | * microcode is 64K of data, and if we try to copy |
| 585 | * it into a local variable then we will SMASH THE |
| 586 | * KERNEL'S STACK! We therefore leave it in USER |
| 587 | * SPACE, and save ourselves from copying it at all. |
| 588 | */ |
| 589 | static int sscape_upload_microcode(struct soundscape *sscape, |
| 590 | const struct sscape_microcode __user *mc) |
| 591 | { |
| 592 | unsigned long flags; |
| 593 | char __user *code; |
| 594 | int err; |
| 595 | |
| 596 | /* |
| 597 | * We are going to have to copy this data into a special |
| 598 | * DMA-able buffer before we can upload it. We shall therefore |
| 599 | * just check that the data pointer is valid for now. |
| 600 | * |
| 601 | * NOTE: This buffer is 64K long! That's WAY too big to |
| 602 | * copy into a stack-temporary anyway. |
| 603 | */ |
| 604 | if ( get_user(code, &mc->code) || |
| 605 | !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) ) |
| 606 | return -EFAULT; |
| 607 | |
| 608 | if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) { |
| 609 | snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n"); |
| 610 | } |
| 611 | |
| 612 | spin_lock_irqsave(&sscape->lock, flags); |
| 613 | set_midi_mode_unsafe(sscape->io_base); |
| 614 | spin_unlock_irqrestore(&sscape->lock, flags); |
| 615 | |
| 616 | initialise_mpu401(sscape->mpu); |
| 617 | |
| 618 | return err; |
| 619 | } |
| 620 | |
| 621 | /* |
| 622 | * Hardware-specific device functions, to implement special |
| 623 | * IOCTLs for the SoundScape card. This is how we upload |
| 624 | * the microcode into the card, for example, and so we |
| 625 | * must ensure that no two processes can open this device |
| 626 | * simultaneously, and that we can't open it at all if |
| 627 | * someone is using the MIDI device. |
| 628 | */ |
| 629 | static int sscape_hw_open(snd_hwdep_t * hw, struct file *file) |
| 630 | { |
| 631 | register struct soundscape *sscape = get_hwdep_soundscape(hw); |
| 632 | unsigned long flags; |
| 633 | int err; |
| 634 | |
| 635 | spin_lock_irqsave(&sscape->fwlock, flags); |
| 636 | |
| 637 | if ((sscape->midi_usage != 0) || sscape->hw_in_use) { |
| 638 | err = -EBUSY; |
| 639 | } else { |
| 640 | sscape->hw_in_use = 1; |
| 641 | err = 0; |
| 642 | } |
| 643 | |
| 644 | spin_unlock_irqrestore(&sscape->fwlock, flags); |
| 645 | return err; |
| 646 | } |
| 647 | |
| 648 | static int sscape_hw_release(snd_hwdep_t * hw, struct file *file) |
| 649 | { |
| 650 | register struct soundscape *sscape = get_hwdep_soundscape(hw); |
| 651 | unsigned long flags; |
| 652 | |
| 653 | spin_lock_irqsave(&sscape->fwlock, flags); |
| 654 | sscape->hw_in_use = 0; |
| 655 | spin_unlock_irqrestore(&sscape->fwlock, flags); |
| 656 | return 0; |
| 657 | } |
| 658 | |
| 659 | static int sscape_hw_ioctl(snd_hwdep_t * hw, struct file *file, |
| 660 | unsigned int cmd, unsigned long arg) |
| 661 | { |
| 662 | struct soundscape *sscape = get_hwdep_soundscape(hw); |
| 663 | int err = -EBUSY; |
| 664 | |
| 665 | switch (cmd) { |
| 666 | case SND_SSCAPE_LOAD_BOOTB: |
| 667 | { |
| 668 | register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg; |
| 669 | |
| 670 | /* |
| 671 | * We are going to have to copy this data into a special |
| 672 | * DMA-able buffer before we can upload it. We shall therefore |
| 673 | * just check that the data pointer is valid for now ... |
| 674 | */ |
| 675 | if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) ) |
| 676 | return -EFAULT; |
| 677 | |
| 678 | /* |
| 679 | * Now check that we can write the firmware version number too... |
| 680 | */ |
| 681 | if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) ) |
| 682 | return -EFAULT; |
| 683 | |
| 684 | err = sscape_upload_bootblock(sscape, bb); |
| 685 | } |
| 686 | break; |
| 687 | |
| 688 | case SND_SSCAPE_LOAD_MCODE: |
| 689 | { |
| 690 | register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg; |
| 691 | |
| 692 | err = sscape_upload_microcode(sscape, mc); |
| 693 | } |
| 694 | break; |
| 695 | |
| 696 | default: |
| 697 | err = -EINVAL; |
| 698 | break; |
| 699 | } /* switch */ |
| 700 | |
| 701 | return err; |
| 702 | } |
| 703 | |
| 704 | |
| 705 | /* |
| 706 | * Mixer control for the SoundScape's MIDI device. |
| 707 | */ |
| 708 | static int sscape_midi_info(snd_kcontrol_t * ctl, |
| 709 | snd_ctl_elem_info_t * uinfo) |
| 710 | { |
| 711 | uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; |
| 712 | uinfo->count = 1; |
| 713 | uinfo->value.integer.min = 0; |
| 714 | uinfo->value.integer.max = 127; |
| 715 | return 0; |
| 716 | } |
| 717 | |
| 718 | static int sscape_midi_get(snd_kcontrol_t * kctl, |
| 719 | snd_ctl_elem_value_t * uctl) |
| 720 | { |
| 721 | cs4231_t *chip = snd_kcontrol_chip(kctl); |
| 722 | snd_card_t *card = chip->card; |
| 723 | register struct soundscape *s = get_card_soundscape(card); |
| 724 | unsigned long flags; |
| 725 | |
| 726 | spin_lock_irqsave(&s->lock, flags); |
| 727 | set_host_mode_unsafe(s->io_base); |
| 728 | |
| 729 | if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) { |
| 730 | uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100); |
| 731 | } |
| 732 | |
| 733 | set_midi_mode_unsafe(s->io_base); |
| 734 | spin_unlock_irqrestore(&s->lock, flags); |
| 735 | return 0; |
| 736 | } |
| 737 | |
| 738 | static int sscape_midi_put(snd_kcontrol_t * kctl, |
| 739 | snd_ctl_elem_value_t * uctl) |
| 740 | { |
| 741 | cs4231_t *chip = snd_kcontrol_chip(kctl); |
| 742 | snd_card_t *card = chip->card; |
| 743 | register struct soundscape *s = get_card_soundscape(card); |
| 744 | unsigned long flags; |
| 745 | int change; |
| 746 | |
| 747 | spin_lock_irqsave(&s->lock, flags); |
| 748 | |
| 749 | /* |
| 750 | * We need to put the board into HOST mode before we |
| 751 | * can send any volume-changing HOST commands ... |
| 752 | */ |
| 753 | set_host_mode_unsafe(s->io_base); |
| 754 | |
| 755 | /* |
| 756 | * To successfully change the MIDI volume setting, you seem to |
| 757 | * have to write a volume command, write the new volume value, |
| 758 | * and then perform another volume-related command. Perhaps the |
| 759 | * first command is an "open" and the second command is a "close"? |
| 760 | */ |
| 761 | if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) { |
| 762 | change = 0; |
| 763 | goto __skip_change; |
| 764 | } |
| 765 | change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100) |
| 766 | && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100) |
| 767 | && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)); |
| 768 | __skip_change: |
| 769 | |
| 770 | /* |
| 771 | * Take the board out of HOST mode and back into MIDI mode ... |
| 772 | */ |
| 773 | set_midi_mode_unsafe(s->io_base); |
| 774 | |
| 775 | spin_unlock_irqrestore(&s->lock, flags); |
| 776 | return change; |
| 777 | } |
| 778 | |
| 779 | static snd_kcontrol_new_t midi_mixer_ctl = { |
| 780 | .iface = SNDRV_CTL_ELEM_IFACE_MIXER, |
| 781 | .name = "MIDI", |
| 782 | .info = sscape_midi_info, |
| 783 | .get = sscape_midi_get, |
| 784 | .put = sscape_midi_put |
| 785 | }; |
| 786 | |
| 787 | /* |
| 788 | * The SoundScape can use two IRQs from a possible set of four. |
| 789 | * These IRQs are encoded as bit patterns so that they can be |
| 790 | * written to the control registers. |
| 791 | */ |
| 792 | static unsigned __devinit get_irq_config(int irq) |
| 793 | { |
| 794 | static const int valid_irq[] = { 9, 5, 7, 10 }; |
| 795 | unsigned cfg; |
| 796 | |
| 797 | for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) { |
| 798 | if (irq == valid_irq[cfg]) |
| 799 | return cfg; |
| 800 | } /* for */ |
| 801 | |
| 802 | return INVALID_IRQ; |
| 803 | } |
| 804 | |
| 805 | |
| 806 | /* |
| 807 | * Perform certain arcane port-checks to see whether there |
| 808 | * is a SoundScape board lurking behind the given ports. |
| 809 | */ |
| 810 | static int __devinit detect_sscape(struct soundscape *s) |
| 811 | { |
| 812 | unsigned long flags; |
| 813 | unsigned d; |
| 814 | int retval = 0; |
| 815 | |
| 816 | spin_lock_irqsave(&s->lock, flags); |
| 817 | |
| 818 | /* |
| 819 | * The following code is lifted from the original OSS driver, |
| 820 | * and as I don't have a datasheet I cannot really comment |
| 821 | * on what it is doing... |
| 822 | */ |
| 823 | if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0) |
| 824 | goto _done; |
| 825 | |
| 826 | d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0; |
| 827 | if ((d & 0x80) != 0) |
| 828 | goto _done; |
| 829 | |
| 830 | if (d == 0) { |
| 831 | s->codec_type = 1; |
| 832 | s->ic_type = IC_ODIE; |
| 833 | } else if ((d & 0x60) != 0) { |
| 834 | s->codec_type = 2; |
| 835 | s->ic_type = IC_OPUS; |
| 836 | } else |
| 837 | goto _done; |
| 838 | |
| 839 | outb(0xfa, ODIE_ADDR_IO(s->io_base)); |
| 840 | if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a) |
| 841 | goto _done; |
| 842 | |
| 843 | outb(0xfe, ODIE_ADDR_IO(s->io_base)); |
| 844 | if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e) |
| 845 | goto _done; |
| 846 | if ((inb(ODIE_DATA_IO(s->io_base)) & 0x9f) != 0x0e) |
| 847 | goto _done; |
| 848 | |
| 849 | /* |
| 850 | * SoundScape successfully detected! |
| 851 | */ |
| 852 | retval = 1; |
| 853 | |
| 854 | _done: |
| 855 | spin_unlock_irqrestore(&s->lock, flags); |
| 856 | return retval; |
| 857 | } |
| 858 | |
| 859 | /* |
| 860 | * ALSA callback function, called when attempting to open the MIDI device. |
| 861 | * Check that the MIDI firmware has been loaded, because we don't want |
| 862 | * to crash the machine. Also check that someone isn't using the hardware |
| 863 | * IOCTL device. |
| 864 | */ |
| 865 | static int mpu401_open(mpu401_t * mpu) |
| 866 | { |
| 867 | int err; |
| 868 | |
| 869 | if (!verify_mpu401(mpu)) { |
| 870 | snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n"); |
| 871 | err = -ENODEV; |
| 872 | } else { |
| 873 | register struct soundscape *sscape = get_mpu401_soundscape(mpu); |
| 874 | unsigned long flags; |
| 875 | |
| 876 | spin_lock_irqsave(&sscape->fwlock, flags); |
| 877 | |
| 878 | if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) { |
| 879 | err = -EBUSY; |
| 880 | } else { |
| 881 | ++(sscape->midi_usage); |
| 882 | err = 0; |
| 883 | } |
| 884 | |
| 885 | spin_unlock_irqrestore(&sscape->fwlock, flags); |
| 886 | } |
| 887 | |
| 888 | return err; |
| 889 | } |
| 890 | |
| 891 | static void mpu401_close(mpu401_t * mpu) |
| 892 | { |
| 893 | register struct soundscape *sscape = get_mpu401_soundscape(mpu); |
| 894 | unsigned long flags; |
| 895 | |
| 896 | spin_lock_irqsave(&sscape->fwlock, flags); |
| 897 | --(sscape->midi_usage); |
| 898 | spin_unlock_irqrestore(&sscape->fwlock, flags); |
| 899 | } |
| 900 | |
| 901 | /* |
| 902 | * Initialse an MPU-401 subdevice for MIDI support on the SoundScape. |
| 903 | */ |
| 904 | static int __devinit create_mpu401(snd_card_t * card, int devnum, unsigned long port, int irq) |
| 905 | { |
| 906 | struct soundscape *sscape = get_card_soundscape(card); |
| 907 | snd_rawmidi_t *rawmidi; |
| 908 | int err; |
| 909 | |
| 910 | #define MPU401_SHARE_HARDWARE 1 |
| 911 | if ((err = snd_mpu401_uart_new(card, devnum, |
| 912 | MPU401_HW_MPU401, |
| 913 | port, MPU401_SHARE_HARDWARE, |
| 914 | irq, SA_INTERRUPT, |
| 915 | &rawmidi)) == 0) { |
| 916 | mpu401_t *mpu = (mpu401_t *) rawmidi->private_data; |
| 917 | mpu->open_input = mpu401_open; |
| 918 | mpu->open_output = mpu401_open; |
| 919 | mpu->close_input = mpu401_close; |
| 920 | mpu->close_output = mpu401_close; |
| 921 | mpu->private_data = sscape; |
| 922 | sscape->mpu = mpu; |
| 923 | |
| 924 | initialise_mpu401(mpu); |
| 925 | } |
| 926 | |
| 927 | return err; |
| 928 | } |
| 929 | |
| 930 | |
| 931 | /* |
| 932 | * Override for the CS4231 playback format function. |
| 933 | * The AD1845 has much simpler format and rate selection. |
| 934 | */ |
| 935 | static void ad1845_playback_format(cs4231_t * chip, snd_pcm_hw_params_t * params, unsigned char format) |
| 936 | { |
| 937 | unsigned long flags; |
| 938 | unsigned rate = params_rate(params); |
| 939 | |
| 940 | /* |
| 941 | * The AD1845 can't handle sample frequencies |
| 942 | * outside of 4 kHZ to 50 kHZ |
| 943 | */ |
| 944 | if (rate > 50000) |
| 945 | rate = 50000; |
| 946 | else if (rate < 4000) |
| 947 | rate = 4000; |
| 948 | |
| 949 | spin_lock_irqsave(&chip->reg_lock, flags); |
| 950 | |
| 951 | /* |
| 952 | * Program the AD1845 correctly for the playback stream. |
| 953 | * Note that we do NOT need to toggle the MCE bit because |
| 954 | * the PLAYBACK_ENABLE bit of the Interface Configuration |
| 955 | * register is set. |
| 956 | * |
| 957 | * NOTE: We seem to need to write to the MSB before the LSB |
| 958 | * to get the correct sample frequency. |
| 959 | */ |
| 960 | snd_cs4231_out(chip, CS4231_PLAYBK_FORMAT, (format & 0xf0)); |
| 961 | snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8)); |
| 962 | snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate); |
| 963 | |
| 964 | spin_unlock_irqrestore(&chip->reg_lock, flags); |
| 965 | } |
| 966 | |
| 967 | /* |
| 968 | * Override for the CS4231 capture format function. |
| 969 | * The AD1845 has much simpler format and rate selection. |
| 970 | */ |
| 971 | static void ad1845_capture_format(cs4231_t * chip, snd_pcm_hw_params_t * params, unsigned char format) |
| 972 | { |
| 973 | unsigned long flags; |
| 974 | unsigned rate = params_rate(params); |
| 975 | |
| 976 | /* |
| 977 | * The AD1845 can't handle sample frequencies |
| 978 | * outside of 4 kHZ to 50 kHZ |
| 979 | */ |
| 980 | if (rate > 50000) |
| 981 | rate = 50000; |
| 982 | else if (rate < 4000) |
| 983 | rate = 4000; |
| 984 | |
| 985 | spin_lock_irqsave(&chip->reg_lock, flags); |
| 986 | |
| 987 | /* |
| 988 | * Program the AD1845 correctly for the playback stream. |
| 989 | * Note that we do NOT need to toggle the MCE bit because |
| 990 | * the CAPTURE_ENABLE bit of the Interface Configuration |
| 991 | * register is set. |
| 992 | * |
| 993 | * NOTE: We seem to need to write to the MSB before the LSB |
| 994 | * to get the correct sample frequency. |
| 995 | */ |
| 996 | snd_cs4231_out(chip, CS4231_REC_FORMAT, (format & 0xf0)); |
| 997 | snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8)); |
| 998 | snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate); |
| 999 | |
| 1000 | spin_unlock_irqrestore(&chip->reg_lock, flags); |
| 1001 | } |
| 1002 | |
| 1003 | /* |
| 1004 | * Create an AD1845 PCM subdevice on the SoundScape. The AD1845 |
| 1005 | * is very much like a CS4231, with a few extra bits. We will |
| 1006 | * try to support at least some of the extra bits by overriding |
| 1007 | * some of the CS4231 callback. |
| 1008 | */ |
| 1009 | static int __devinit create_ad1845(snd_card_t * card, unsigned port, int irq, int dma1) |
| 1010 | { |
| 1011 | register struct soundscape *sscape = get_card_soundscape(card); |
| 1012 | cs4231_t *chip; |
| 1013 | int err; |
| 1014 | |
| 1015 | #define CS4231_SHARE_HARDWARE (CS4231_HWSHARE_DMA1 | CS4231_HWSHARE_DMA2) |
| 1016 | /* |
| 1017 | * The AD1845 PCM device is only half-duplex, and so |
| 1018 | * we only give it one DMA channel ... |
| 1019 | */ |
| 1020 | if ((err = snd_cs4231_create(card, |
| 1021 | port, -1, irq, dma1, dma1, |
| 1022 | CS4231_HW_DETECT, |
| 1023 | CS4231_HWSHARE_DMA1, &chip)) == 0) { |
| 1024 | unsigned long flags; |
| 1025 | snd_pcm_t *pcm; |
| 1026 | |
| 1027 | #define AD1845_FREQ_SEL_ENABLE 0x08 |
| 1028 | |
| 1029 | #define AD1845_PWR_DOWN_CTRL 0x1b |
| 1030 | #define AD1845_CRYS_CLOCK_SEL 0x1d |
| 1031 | |
| 1032 | /* |
| 1033 | * It turns out that the PLAYBACK_ENABLE bit is set |
| 1034 | * by the lowlevel driver ... |
| 1035 | * |
| 1036 | #define AD1845_IFACE_CONFIG \ |
| 1037 | (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE) |
| 1038 | snd_cs4231_mce_up(chip); |
| 1039 | spin_lock_irqsave(&chip->reg_lock, flags); |
| 1040 | snd_cs4231_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG); |
| 1041 | spin_unlock_irqrestore(&chip->reg_lock, flags); |
| 1042 | snd_cs4231_mce_down(chip); |
| 1043 | */ |
| 1044 | |
| 1045 | /* |
| 1046 | * The input clock frequency on the SoundScape must |
| 1047 | * be 14.31818 MHz, because we must set this register |
| 1048 | * to get the playback to sound correct ... |
| 1049 | */ |
| 1050 | snd_cs4231_mce_up(chip); |
| 1051 | spin_lock_irqsave(&chip->reg_lock, flags); |
| 1052 | snd_cs4231_out(chip, AD1845_CRYS_CLOCK_SEL, 0x20); |
| 1053 | spin_unlock_irqrestore(&chip->reg_lock, flags); |
| 1054 | snd_cs4231_mce_down(chip); |
| 1055 | |
| 1056 | /* |
| 1057 | * More custom configuration: |
| 1058 | * a) select "mode 2", and provide a current drive of 8 mA |
| 1059 | * b) enable frequency selection (for capture/playback) |
| 1060 | */ |
| 1061 | spin_lock_irqsave(&chip->reg_lock, flags); |
| 1062 | snd_cs4231_out(chip, CS4231_MISC_INFO, (CS4231_MODE2 | 0x10)); |
| 1063 | snd_cs4231_out(chip, AD1845_PWR_DOWN_CTRL, snd_cs4231_in(chip, AD1845_PWR_DOWN_CTRL) | AD1845_FREQ_SEL_ENABLE); |
| 1064 | spin_unlock_irqrestore(&chip->reg_lock, flags); |
| 1065 | |
| 1066 | if ((err = snd_cs4231_pcm(chip, 0, &pcm)) < 0) { |
| 1067 | snd_printk(KERN_ERR "sscape: No PCM device for AD1845 chip\n"); |
| 1068 | goto _error; |
| 1069 | } |
| 1070 | |
| 1071 | if ((err = snd_cs4231_mixer(chip)) < 0) { |
| 1072 | snd_printk(KERN_ERR "sscape: No mixer device for AD1845 chip\n"); |
| 1073 | goto _error; |
| 1074 | } |
| 1075 | |
| 1076 | if ((err = snd_ctl_add(card, snd_ctl_new1(&midi_mixer_ctl, chip))) < 0) { |
| 1077 | snd_printk(KERN_ERR "sscape: Could not create MIDI mixer control\n"); |
| 1078 | goto _error; |
| 1079 | } |
| 1080 | |
| 1081 | strcpy(card->driver, "SoundScape"); |
| 1082 | strcpy(card->shortname, pcm->name); |
| 1083 | snprintf(card->longname, sizeof(card->longname), |
| 1084 | "%s at 0x%lx, IRQ %d, DMA %d\n", |
| 1085 | pcm->name, chip->port, chip->irq, chip->dma1); |
| 1086 | chip->set_playback_format = ad1845_playback_format; |
| 1087 | chip->set_capture_format = ad1845_capture_format; |
| 1088 | sscape->chip = chip; |
| 1089 | } |
| 1090 | |
| 1091 | _error: |
| 1092 | return err; |
| 1093 | } |
| 1094 | |
| 1095 | |
| 1096 | struct params |
| 1097 | { |
| 1098 | int index; |
| 1099 | const char *id; |
| 1100 | unsigned port; |
| 1101 | int irq; |
| 1102 | int mpu_irq; |
| 1103 | int dma1; |
| 1104 | }; |
| 1105 | |
| 1106 | |
| 1107 | static inline struct params* |
| 1108 | init_params(struct params *params, |
| 1109 | int index, |
| 1110 | const char *id, |
| 1111 | unsigned port, |
| 1112 | int irq, |
| 1113 | int mpu_irq, |
| 1114 | int dma1) |
| 1115 | { |
| 1116 | params->index = index; |
| 1117 | params->id = id; |
| 1118 | params->port = port; |
| 1119 | params->irq = irq; |
| 1120 | params->mpu_irq = mpu_irq; |
| 1121 | params->dma1 = (dma1 & 0x03); |
| 1122 | |
| 1123 | return params; |
| 1124 | } |
| 1125 | |
| 1126 | |
| 1127 | /* |
| 1128 | * Create an ALSA soundcard entry for the SoundScape, using |
| 1129 | * the given list of port, IRQ and DMA resources. |
| 1130 | */ |
| 1131 | static int __devinit create_sscape(const struct params *params, snd_card_t **rcardp) |
| 1132 | { |
| 1133 | snd_card_t *card; |
| 1134 | register struct soundscape *sscape; |
| 1135 | register unsigned dma_cfg; |
| 1136 | unsigned irq_cfg; |
| 1137 | unsigned mpu_irq_cfg; |
| 1138 | struct resource *io_res; |
| 1139 | unsigned long flags; |
| 1140 | int err; |
| 1141 | |
| 1142 | /* |
| 1143 | * Check that the user didn't pass us garbage data ... |
| 1144 | */ |
| 1145 | irq_cfg = get_irq_config(params->irq); |
| 1146 | if (irq_cfg == INVALID_IRQ) { |
| 1147 | snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", params->irq); |
| 1148 | return -ENXIO; |
| 1149 | } |
| 1150 | |
| 1151 | mpu_irq_cfg = get_irq_config(params->mpu_irq); |
| 1152 | if (mpu_irq_cfg == INVALID_IRQ) { |
| 1153 | printk(KERN_ERR "sscape: Invalid IRQ %d\n", params->mpu_irq); |
| 1154 | return -ENXIO; |
| 1155 | } |
| 1156 | |
| 1157 | /* |
| 1158 | * Grab IO ports that we will need to probe so that we |
| 1159 | * can detect and control this hardware ... |
| 1160 | */ |
| 1161 | if ((io_res = request_region(params->port, 8, "SoundScape")) == NULL) { |
| 1162 | snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", params->port); |
| 1163 | return -EBUSY; |
| 1164 | } |
| 1165 | |
| 1166 | /* |
| 1167 | * Grab both DMA channels (OK, only one for now) ... |
| 1168 | */ |
| 1169 | if ((err = request_dma(params->dma1, "SoundScape")) < 0) { |
| 1170 | snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", params->dma1); |
| 1171 | goto _release_region; |
| 1172 | } |
| 1173 | |
| 1174 | /* |
| 1175 | * Create a new ALSA sound card entry, in anticipation |
| 1176 | * of detecting our hardware ... |
| 1177 | */ |
| 1178 | if ((card = snd_card_new(params->index, params->id, THIS_MODULE, sizeof(struct soundscape))) == NULL) { |
| 1179 | err = -ENOMEM; |
| 1180 | goto _release_dma; |
| 1181 | } |
| 1182 | |
| 1183 | sscape = get_card_soundscape(card); |
| 1184 | spin_lock_init(&sscape->lock); |
| 1185 | spin_lock_init(&sscape->fwlock); |
| 1186 | sscape->io_res = io_res; |
| 1187 | sscape->io_base = params->port; |
| 1188 | |
| 1189 | if (!detect_sscape(sscape)) { |
| 1190 | printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base); |
| 1191 | err = -ENODEV; |
| 1192 | goto _release_card; |
| 1193 | } |
| 1194 | |
| 1195 | printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n", |
| 1196 | sscape->io_base, params->irq, params->dma1); |
| 1197 | |
| 1198 | /* |
| 1199 | * Now create the hardware-specific device so that we can |
| 1200 | * load the microcode into the on-board processor. |
| 1201 | * We cannot use the MPU-401 MIDI system until this firmware |
| 1202 | * has been loaded into the card. |
| 1203 | */ |
| 1204 | if ((err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw))) < 0) { |
| 1205 | printk(KERN_ERR "sscape: Failed to create firmware device\n"); |
| 1206 | goto _release_card; |
| 1207 | } |
| 1208 | strlcpy(sscape->hw->name, "SoundScape M68K", sizeof(sscape->hw->name)); |
| 1209 | sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0'; |
| 1210 | sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE; |
| 1211 | sscape->hw->ops.open = sscape_hw_open; |
| 1212 | sscape->hw->ops.release = sscape_hw_release; |
| 1213 | sscape->hw->ops.ioctl = sscape_hw_ioctl; |
| 1214 | sscape->hw->private_data = sscape; |
| 1215 | |
| 1216 | /* |
| 1217 | * Tell the on-board devices where their resources are (I think - |
| 1218 | * I can't be sure without a datasheet ... So many magic values!) |
| 1219 | */ |
| 1220 | spin_lock_irqsave(&sscape->lock, flags); |
| 1221 | |
| 1222 | activate_ad1845_unsafe(sscape->io_base); |
| 1223 | |
| 1224 | sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */ |
| 1225 | sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e); |
| 1226 | sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00); |
| 1227 | |
| 1228 | /* |
| 1229 | * Enable and configure the DMA channels ... |
| 1230 | */ |
| 1231 | sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50); |
| 1232 | dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40); |
| 1233 | sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg); |
| 1234 | sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20); |
| 1235 | |
| 1236 | sscape_write_unsafe(sscape->io_base, |
| 1237 | GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg); |
| 1238 | sscape_write_unsafe(sscape->io_base, |
| 1239 | GA_CDCFG_REG, 0x09 | DMA_8BIT | (params->dma1 << 4) | (irq_cfg << 1)); |
| 1240 | |
| 1241 | spin_unlock_irqrestore(&sscape->lock, flags); |
| 1242 | |
| 1243 | /* |
| 1244 | * We have now enabled the codec chip, and so we should |
| 1245 | * detect the AD1845 device ... |
| 1246 | */ |
| 1247 | if ((err = create_ad1845(card, CODEC_IO(params->port), params->irq, params->dma1)) < 0) { |
| 1248 | printk(KERN_ERR "sscape: No AD1845 device at 0x%x, IRQ %d\n", |
| 1249 | CODEC_IO(params->port), params->irq); |
| 1250 | goto _release_card; |
| 1251 | } |
| 1252 | #define MIDI_DEVNUM 0 |
| 1253 | if ((err = create_mpu401(card, MIDI_DEVNUM, MPU401_IO(params->port), params->mpu_irq)) < 0) { |
| 1254 | printk(KERN_ERR "sscape: Failed to create MPU-401 device at 0x%x\n", |
| 1255 | MPU401_IO(params->port)); |
| 1256 | goto _release_card; |
| 1257 | } |
| 1258 | |
| 1259 | /* |
| 1260 | * Enable the master IRQ ... |
| 1261 | */ |
| 1262 | sscape_write(sscape, GA_INTENA_REG, 0x80); |
| 1263 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1264 | /* |
| 1265 | * Initialize mixer |
| 1266 | */ |
| 1267 | sscape->midi_vol = 0; |
| 1268 | host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100); |
| 1269 | host_write_ctrl_unsafe(sscape->io_base, 0, 100); |
| 1270 | host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100); |
| 1271 | |
| 1272 | /* |
| 1273 | * Now that we have successfully created this sound card, |
| 1274 | * it is safe to store the pointer. |
| 1275 | * NOTE: we only register the sound card's "destructor" |
| 1276 | * function now that our "constructor" has completed. |
| 1277 | */ |
| 1278 | card->private_free = soundscape_free; |
| 1279 | *rcardp = card; |
| 1280 | |
| 1281 | return 0; |
| 1282 | |
| 1283 | _release_card: |
| 1284 | snd_card_free(card); |
| 1285 | |
| 1286 | _release_dma: |
| 1287 | free_dma(params->dma1); |
| 1288 | |
| 1289 | _release_region: |
Takashi Iwai | b1d5776 | 2005-10-10 11:56:31 +0200 | [diff] [blame] | 1290 | release_and_free_resource(io_res); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1291 | |
| 1292 | return err; |
| 1293 | } |
| 1294 | |
| 1295 | |
| 1296 | static int sscape_cards __devinitdata; |
| 1297 | static struct params sscape_params[SNDRV_CARDS] __devinitdata; |
| 1298 | |
| 1299 | #ifdef CONFIG_PNP |
| 1300 | static inline int __devinit get_next_autoindex(int i) |
| 1301 | { |
| 1302 | while ((i < SNDRV_CARDS) && (port[i] != SNDRV_AUTO_PORT)) { |
| 1303 | ++i; |
| 1304 | } /* while */ |
| 1305 | |
| 1306 | return i; |
| 1307 | } |
| 1308 | |
| 1309 | |
| 1310 | static inline int __devinit is_port_known(unsigned io, struct params *params, int cards) |
| 1311 | { |
| 1312 | while (--cards >= 0) { |
| 1313 | if (params[cards].port == io) |
| 1314 | return 1; |
| 1315 | } /* while */ |
| 1316 | |
| 1317 | return 0; |
| 1318 | } |
| 1319 | |
| 1320 | static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard, |
| 1321 | const struct pnp_card_device_id *pid) |
| 1322 | { |
| 1323 | struct pnp_dev *dev; |
| 1324 | static int idx = 0; |
| 1325 | int ret; |
| 1326 | |
| 1327 | /* |
| 1328 | * Allow this function to fail *quietly* if all the ISA PnP |
| 1329 | * devices were configured using module parameters instead. |
| 1330 | */ |
| 1331 | if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS) { |
| 1332 | return -ENOSPC; |
| 1333 | } |
| 1334 | |
| 1335 | /* |
| 1336 | * We have found a candidate ISA PnP card. Now we |
| 1337 | * have to check that it has the devices that we |
| 1338 | * expect it to have. |
| 1339 | * |
| 1340 | * We will NOT try and autoconfigure all of the resources |
| 1341 | * needed and then activate the card as we are assuming that |
| 1342 | * has already been done at boot-time using /proc/isapnp. |
| 1343 | * We shall simply try to give each active card the resources |
| 1344 | * that it wants. This is a sensible strategy for a modular |
| 1345 | * system where unused modules are unloaded regularly. |
| 1346 | * |
| 1347 | * This strategy is utterly useless if we compile the driver |
| 1348 | * into the kernel, of course. |
| 1349 | */ |
| 1350 | // printk(KERN_INFO "sscape: %s\n", card->name); |
| 1351 | |
| 1352 | /* |
| 1353 | * Check that we still have room for another sound card ... |
| 1354 | */ |
| 1355 | if (sscape_cards >= SNDRV_CARDS) { |
| 1356 | printk(KERN_ERR "sscape: No room for another ALSA device\n"); |
| 1357 | return -ENOSPC; |
| 1358 | } |
| 1359 | |
| 1360 | ret = -ENODEV; |
| 1361 | |
| 1362 | dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL); |
| 1363 | if (dev) { |
| 1364 | struct params *this; |
| 1365 | if (!pnp_is_active(dev)) { |
| 1366 | if (pnp_activate_dev(dev) < 0) { |
| 1367 | printk(KERN_INFO "sscape: device is inactive\n"); |
| 1368 | return -EBUSY; |
| 1369 | } |
| 1370 | } |
| 1371 | /* |
| 1372 | * Read the correct parameters off the ISA PnP bus ... |
| 1373 | */ |
| 1374 | this = init_params(&sscape_params[sscape_cards], |
| 1375 | index[idx], |
| 1376 | id[idx], |
| 1377 | pnp_port_start(dev, 0), |
| 1378 | pnp_irq(dev, 0), |
| 1379 | pnp_irq(dev, 1), |
| 1380 | pnp_dma(dev, 0)); |
| 1381 | |
| 1382 | /* |
| 1383 | * Do we know about this sound card already? |
| 1384 | */ |
| 1385 | if ( !is_port_known(this->port, sscape_params, sscape_cards) ) { |
| 1386 | snd_card_t *card; |
| 1387 | |
| 1388 | ret = create_sscape(this, &card); |
| 1389 | if (ret < 0) |
| 1390 | return ret; |
| 1391 | snd_card_set_dev(card, &pcard->card->dev); |
Takashi Iwai | 43bcd97 | 2005-09-05 17:19:20 +0200 | [diff] [blame] | 1392 | |
| 1393 | if ((ret = snd_card_register(card)) < 0) { |
| 1394 | printk(KERN_ERR "sscape: Failed to register sound card\n"); |
| 1395 | snd_card_free(card); |
| 1396 | return ret; |
| 1397 | } |
| 1398 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1399 | pnp_set_card_drvdata(pcard, card); |
| 1400 | ++sscape_cards; |
| 1401 | ++idx; |
| 1402 | } |
| 1403 | } |
| 1404 | |
| 1405 | return ret; |
| 1406 | } |
| 1407 | |
| 1408 | static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard) |
| 1409 | { |
| 1410 | snd_card_t *card = (snd_card_t *) pnp_get_card_drvdata(pcard); |
| 1411 | |
| 1412 | pnp_set_card_drvdata(pcard, NULL); |
| 1413 | snd_card_disconnect(card); |
| 1414 | snd_card_free_in_thread(card); |
| 1415 | } |
| 1416 | |
| 1417 | static struct pnp_card_driver sscape_pnpc_driver = { |
| 1418 | .flags = PNP_DRIVER_RES_DO_NOT_CHANGE, |
| 1419 | .name = "sscape", |
| 1420 | .id_table = sscape_pnpids, |
| 1421 | .probe = sscape_pnp_detect, |
| 1422 | .remove = __devexit_p(sscape_pnp_remove), |
| 1423 | }; |
| 1424 | |
| 1425 | #endif /* CONFIG_PNP */ |
| 1426 | |
| 1427 | static int __init sscape_manual_probe(struct params *params) |
| 1428 | { |
| 1429 | int ret; |
| 1430 | unsigned i; |
| 1431 | snd_card_t *card; |
| 1432 | |
| 1433 | for (i = 0; i < SNDRV_CARDS; ++i) { |
| 1434 | /* |
| 1435 | * We do NOT probe for ports. |
| 1436 | * If we're not given a port number for this |
| 1437 | * card then we completely ignore this line |
| 1438 | * of parameters. |
| 1439 | */ |
| 1440 | if (port[i] == SNDRV_AUTO_PORT) |
| 1441 | continue; |
| 1442 | |
| 1443 | /* |
| 1444 | * Make sure we were given ALL of the other parameters. |
| 1445 | */ |
| 1446 | if ( (irq[i] == SNDRV_AUTO_IRQ) || |
| 1447 | (mpu_irq[i] == SNDRV_AUTO_IRQ) || |
| 1448 | (dma[i] == SNDRV_AUTO_DMA) ) { |
| 1449 | printk(KERN_INFO |
| 1450 | "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n"); |
| 1451 | return -ENXIO; |
| 1452 | } |
| 1453 | |
| 1454 | /* |
| 1455 | * This cards looks OK ... |
| 1456 | */ |
| 1457 | init_params(params, index[i], id[i], port[i], irq[i], mpu_irq[i], dma[i]); |
| 1458 | |
| 1459 | ret = create_sscape(params, &card); |
| 1460 | if (ret < 0) |
| 1461 | return ret; |
| 1462 | |
Takashi Iwai | 43bcd97 | 2005-09-05 17:19:20 +0200 | [diff] [blame] | 1463 | if ((ret = snd_card_set_generic_dev(card)) < 0) { |
| 1464 | snd_card_free(card); |
| 1465 | return ret; |
| 1466 | } |
| 1467 | if ((ret = snd_card_register(card)) < 0) { |
| 1468 | printk(KERN_ERR "sscape: Failed to register sound card\n"); |
| 1469 | snd_card_free(card); |
| 1470 | return ret; |
| 1471 | } |
| 1472 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1473 | sscape_card[sscape_cards] = card; |
| 1474 | params++; |
| 1475 | sscape_cards++; |
| 1476 | } /* for */ |
| 1477 | |
| 1478 | return 0; |
| 1479 | } |
| 1480 | |
| 1481 | |
| 1482 | static void sscape_exit(void) |
| 1483 | { |
| 1484 | unsigned i; |
| 1485 | |
| 1486 | #ifdef CONFIG_PNP |
| 1487 | pnp_unregister_card_driver(&sscape_pnpc_driver); |
| 1488 | #endif |
| 1489 | for (i = 0; i < ARRAY_SIZE(sscape_card); ++i) { |
| 1490 | snd_card_free(sscape_card[i]); |
| 1491 | } /* for */ |
| 1492 | } |
| 1493 | |
| 1494 | |
| 1495 | static int __init sscape_init(void) |
| 1496 | { |
| 1497 | int ret; |
| 1498 | |
| 1499 | /* |
| 1500 | * First check whether we were passed any parameters. |
| 1501 | * These MUST take precedence over ANY automatic way |
| 1502 | * of allocating cards, because the operator is |
| 1503 | * S-P-E-L-L-I-N-G it out for us... |
| 1504 | */ |
| 1505 | ret = sscape_manual_probe(sscape_params); |
| 1506 | if (ret < 0) { |
| 1507 | int i; |
| 1508 | for (i = 0; i < sscape_cards; ++i) |
| 1509 | snd_card_free(sscape_card[i]); |
| 1510 | return ret; |
| 1511 | } |
| 1512 | |
| 1513 | #ifdef CONFIG_PNP |
| 1514 | if (sscape_cards < SNDRV_CARDS) { |
| 1515 | ret = pnp_register_card_driver(&sscape_pnpc_driver); |
| 1516 | if (ret < 0) { |
| 1517 | sscape_exit(); |
| 1518 | return ret; |
| 1519 | } |
| 1520 | } |
| 1521 | #endif |
| 1522 | |
| 1523 | return 0; |
| 1524 | } |
| 1525 | |
| 1526 | module_init(sscape_init); |
| 1527 | module_exit(sscape_exit); |