cregit-Linux how code gets into the kernel

Release 4.8 sound/isa/sc6000.c

Directory: sound/isa
/*
 *  Driver for Gallant SC-6000 soundcard. This card is also known as
 *  Audio Excel DSP 16 or Zoltrix AV302.
 *  These cards use CompuMedia ASC-9308 chip + AD1848 codec.
 *  SC-6600 and SC-7000 cards are also supported. They are based on
 *  CompuMedia ASC-9408 chip and CS4231 codec.
 *
 *  Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
 *
 *  I don't have documentation for this card. I used the driver
 *  for OSS/Free included in the kernel source as reference.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/isa.h>
#include <linux/io.h>
#include <asm/dma.h>
#include <sound/core.h>
#include <sound/wss.h>
#include <sound/opl3.h>
#include <sound/mpu401.h>
#include <sound/control.h>

#define SNDRV_LEGACY_FIND_FREE_IRQ

#define SNDRV_LEGACY_FIND_FREE_DMA
#include <sound/initval.h>

MODULE_AUTHOR("Krzysztof Helt");
MODULE_DESCRIPTION("Gallant SC-6000");
MODULE_LICENSE("GPL");
MODULE_SUPPORTED_DEVICE("{{Gallant, SC-6000},"
			"{AudioExcel, Audio Excel DSP 16},"
			"{Zoltrix, AV302}}");


static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	
/* Index 0-MAX */

static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	
/* ID for this card */

static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	
/* Enable this card */

static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	
/* 0x220, 0x240 */

static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	
/* 5, 7, 9, 10, 11 */

static long mss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	
/* 0x530, 0xe80 */

static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
						/* 0x300, 0x310, 0x320, 0x330 */

static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	
/* 5, 7, 9, 10, 0 */

static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	
/* 0, 1, 3 */

static bool joystick[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = false };

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for sc-6000 based soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for sc-6000 based soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable sc-6000 based soundcard.");
module_param_array(port, long, NULL, 0444);
MODULE_PARM_DESC(port, "Port # for sc-6000 driver.");
module_param_array(mss_port, long, NULL, 0444);
MODULE_PARM_DESC(mss_port, "MSS Port # for sc-6000 driver.");
module_param_array(mpu_port, long, NULL, 0444);
MODULE_PARM_DESC(mpu_port, "MPU-401 port # for sc-6000 driver.");
module_param_array(irq, int, NULL, 0444);
MODULE_PARM_DESC(irq, "IRQ # for sc-6000 driver.");
module_param_array(mpu_irq, int, NULL, 0444);
MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for sc-6000 driver.");
module_param_array(dma, int, NULL, 0444);
MODULE_PARM_DESC(dma, "DMA # for sc-6000 driver.");
module_param_array(joystick, bool, NULL, 0444);
MODULE_PARM_DESC(joystick, "Enable gameport.");

/*
 * Commands of SC6000's DSP (SBPRO+special).
 * Some of them are COMMAND_xx, in the future they may change.
 */

#define WRITE_MDIRQ_CFG	0x50	
/* Set M&I&DRQ mask (the real config)   */

#define COMMAND_52	0x52	
/*                                      */

#define READ_HARD_CFG	0x58	
/* Read Hardware Config (I/O base etc)  */

#define COMMAND_5C	0x5c	
/*                                      */

#define COMMAND_60	0x60	
/*                                      */

#define COMMAND_66	0x66	
/*                                      */

#define COMMAND_6C	0x6c	
/*                                      */

#define COMMAND_6E	0x6e	
/*                                      */

#define COMMAND_88	0x88	
/* Unknown command                      */

#define DSP_INIT_MSS	0x8c	
/* Enable Microsoft Sound System mode   */

#define COMMAND_C5	0xc5	
/*                                      */

#define GET_DSP_VERSION	0xe1	
/* Get DSP Version                      */

#define GET_DSP_COPYRIGHT 0xe3	
/* Get DSP Copyright                    */

/*
 * Offsets of SC6000 DSP I/O ports. The offset is added to base I/O port
 * to have the actual I/O port.
 * Register permissions are:
 * (wo) == Write Only
 * (ro) == Read  Only
 * (w-) == Write
 * (r-) == Read
 */

#define DSP_RESET	0x06	
/* offset of DSP RESET          (wo) */

#define DSP_READ	0x0a	
/* offset of DSP READ           (ro) */

#define DSP_WRITE	0x0c	
/* offset of DSP WRITE          (w-) */

#define DSP_COMMAND	0x0c	
/* offset of DSP COMMAND        (w-) */

#define DSP_STATUS	0x0c	
/* offset of DSP STATUS         (r-) */

#define DSP_DATAVAIL	0x0e	
/* offset of DSP DATA AVAILABLE (ro) */


#define PFX "sc6000: "

#define DRV_NAME "SC-6000"

/* hardware dependent functions */

/*
 * sc6000_irq_to_softcfg - Decode irq number into cfg code.
 */

static unsigned char sc6000_irq_to_softcfg(int irq) { unsigned char val = 0; switch (irq) { case 5: val = 0x28; break; case 7: val = 0x8; break; case 9: val = 0x10; break; case 10: val = 0x18; break; case 11: val = 0x20; break; default: break; } return val; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt67100.00%1100.00%
Total67100.00%1100.00%

/* * sc6000_dma_to_softcfg - Decode dma number into cfg code. */
static unsigned char sc6000_dma_to_softcfg(int dma) { unsigned char val = 0; switch (dma) { case 0: val = 1; break; case 1: val = 2; break; case 3: val = 3; break; default: break; } return val; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt51100.00%1100.00%
Total51100.00%1100.00%

/* * sc6000_mpu_irq_to_softcfg - Decode MPU-401 irq number into cfg code. */
static unsigned char sc6000_mpu_irq_to_softcfg(int mpu_irq) { unsigned char val = 0; switch (mpu_irq) { case 5: val = 4; break; case 7: val = 0x44; break; case 9: val = 0x84; break; case 10: val = 0xc4; break; default: break; } return val; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt59100.00%1100.00%
Total59100.00%1100.00%


static int sc6000_wait_data(char __iomem *vport) { int loop = 1000; unsigned char val = 0; do { val = ioread8(vport + DSP_DATAVAIL); if (val & 0x80) return 0; cpu_relax(); } while (loop--); return -EAGAIN; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt56100.00%1100.00%
Total56100.00%1100.00%


static int sc6000_read(char __iomem *vport) { if (sc6000_wait_data(vport)) return -EBUSY; return ioread8(vport + DSP_READ); }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt30100.00%1100.00%
Total30100.00%1100.00%


static int sc6000_write(char __iomem *vport, int cmd) { unsigned char val; int loop = 500000; do { val = ioread8(vport + DSP_STATUS); /* * DSP ready to receive data if bit 7 of val == 0 */ if (!(val & 0x80)) { iowrite8(cmd, vport + DSP_COMMAND); return 0; } cpu_relax(); } while (loop--); snd_printk(KERN_ERR "DSP Command (0x%x) timeout.\n", cmd); return -EIO; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt80100.00%1100.00%
Total80100.00%1100.00%


static int sc6000_dsp_get_answer(char __iomem *vport, int command, char *data, int data_len) { int len = 0; if (sc6000_write(vport, command)) { snd_printk(KERN_ERR "CMD 0x%x: failed!\n", command); return -EIO; } do { int val = sc6000_read(vport); if (val < 0) break; data[len++] = val; } while (len < data_len); /* * If no more data available, return to the caller, no error if len>0. * We have no other way to know when the string is finished. */ return len ? len : -EIO; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt91100.00%1100.00%
Total91100.00%1100.00%


static int sc6000_dsp_reset(char __iomem *vport) { iowrite8(1, vport + DSP_RESET); udelay(10); iowrite8(0, vport + DSP_RESET); udelay(20); if (sc6000_read(vport) == 0xaa) return 0; return -ENODEV; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt55100.00%1100.00%
Total55100.00%1100.00%

/* detection and initialization */
static int sc6000_hw_cfg_write(char __iomem *vport, const int *cfg) { if (sc6000_write(vport, COMMAND_6C) < 0) { snd_printk(KERN_WARNING "CMD 0x%x: failed!\n", COMMAND_6C); return -EIO; } if (sc6000_write(vport, COMMAND_5C) < 0) { snd_printk(KERN_ERR "CMD 0x%x: failed!\n", COMMAND_5C); return -EIO; } if (sc6000_write(vport, cfg[0]) < 0) { snd_printk(KERN_ERR "DATA 0x%x: failed!\n", cfg[0]); return -EIO; } if (sc6000_write(vport, cfg[1]) < 0) { snd_printk(KERN_ERR "DATA 0x%x: failed!\n", cfg[1]); return -EIO; } if (sc6000_write(vport, COMMAND_C5) < 0) { snd_printk(KERN_ERR "CMD 0x%x: failed!\n", COMMAND_C5); return -EIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt156100.00%2100.00%
Total156100.00%2100.00%


static int sc6000_cfg_write(char __iomem *vport, unsigned char softcfg) { if (sc6000_write(vport, WRITE_MDIRQ_CFG)) { snd_printk(KERN_ERR "CMD 0x%x: failed!\n", WRITE_MDIRQ_CFG); return -EIO; } if (sc6000_write(vport, softcfg)) { snd_printk(KERN_ERR "sc6000_cfg_write: failed!\n"); return -EIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt62100.00%2100.00%
Total62100.00%2100.00%


static int sc6000_setup_board(char __iomem *vport, int config) { int loop = 10; do { if (sc6000_write(vport, COMMAND_88)) { snd_printk(KERN_ERR "CMD 0x%x: failed!\n", COMMAND_88); return -EIO; } } while ((sc6000_wait_data(vport) < 0) && loop--); if (sc6000_read(vport) < 0) { snd_printk(KERN_ERR "sc6000_read after CMD 0x%x: failed\n", COMMAND_88); return -EIO; } if (sc6000_cfg_write(vport, config)) return -ENODEV; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt99100.00%1100.00%
Total99100.00%1100.00%


static int sc6000_init_mss(char __iomem *vport, int config, char __iomem *vmss_port, int mss_config) { if (sc6000_write(vport, DSP_INIT_MSS)) { snd_printk(KERN_ERR "sc6000_init_mss [0x%x]: failed!\n", DSP_INIT_MSS); return -EIO; } msleep(10); if (sc6000_cfg_write(vport, config)) return -EIO; iowrite8(mss_config, vmss_port); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt73100.00%1100.00%
Total73100.00%1100.00%


static void sc6000_hw_cfg_encode(char __iomem *vport, int *cfg, long xport, long xmpu, long xmss_port, int joystick) { cfg[0] = 0; cfg[1] = 0; if (xport == 0x240) cfg[0] |= 1; if (xmpu != SNDRV_AUTO_PORT) { cfg[0] |= (xmpu & 0x30) >> 2; cfg[1] |= 0x20; } if (xmss_port == 0xe80) cfg[0] |= 0x10; cfg[0] |= 0x40; /* always set */ if (!joystick) cfg[0] |= 0x02; cfg[1] |= 0x80; /* enable WSS system */ cfg[1] &= ~0x40; /* disable IDE */ snd_printd("hw cfg %x, %x\n", cfg[0], cfg[1]); }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt147100.00%3100.00%
Total147100.00%3100.00%


static int sc6000_init_board(char __iomem *vport, char __iomem *vmss_port, int dev) { char answer[15]; char version[2]; int mss_config = sc6000_irq_to_softcfg(irq[dev]) | sc6000_dma_to_softcfg(dma[dev]); int config = mss_config | sc6000_mpu_irq_to_softcfg(mpu_irq[dev]); int err; int old = 0; err = sc6000_dsp_reset(vport); if (err < 0) { snd_printk(KERN_ERR "sc6000_dsp_reset: failed!\n"); return err; } memset(answer, 0, sizeof(answer)); err = sc6000_dsp_get_answer(vport, GET_DSP_COPYRIGHT, answer, 15); if (err <= 0) { snd_printk(KERN_ERR "sc6000_dsp_copyright: failed!\n"); return -ENODEV; } /* * My SC-6000 card return "SC-6000" in DSPCopyright, so * if we have something different, we have to be warned. */ if (strncmp("SC-6000", answer, 7)) snd_printk(KERN_WARNING "Warning: non SC-6000 audio card!\n"); if (sc6000_dsp_get_answer(vport, GET_DSP_VERSION, version, 2) < 2) { snd_printk(KERN_ERR "sc6000_dsp_version: failed!\n"); return -ENODEV; } printk(KERN_INFO PFX "Detected model: %s, DSP version %d.%d\n", answer, version[0], version[1]); /* set configuration */ sc6000_write(vport, COMMAND_5C); if (sc6000_read(vport) < 0) old = 1; if (!old) { int cfg[2]; sc6000_hw_cfg_encode(vport, &cfg[0], port[dev], mpu_port[dev], mss_port[dev], joystick[dev]); if (sc6000_hw_cfg_write(vport, cfg) < 0) { snd_printk(KERN_ERR "sc6000_hw_cfg_write: failed!\n"); return -EIO; } } err = sc6000_setup_board(vport, config); if (err < 0) { snd_printk(KERN_ERR "sc6000_setup_board: failed!\n"); return -ENODEV; } sc6000_dsp_reset(vport); if (!old) { sc6000_write(vport, COMMAND_60); sc6000_write(vport, 0x02); sc6000_dsp_reset(vport); } err = sc6000_setup_board(vport, config); if (err < 0) { snd_printk(KERN_ERR "sc6000_setup_board: failed!\n"); return -ENODEV; } err = sc6000_init_mss(vport, config, vmss_port, mss_config); if (err < 0) { snd_printk(KERN_ERR "Cannot initialize " "Microsoft Sound System mode.\n"); return -ENODEV; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt407100.00%5100.00%
Total407100.00%5100.00%


static int snd_sc6000_mixer(struct snd_wss *chip) { struct snd_card *card = chip->card; struct snd_ctl_elem_id id1, id2; int err; memset(&id1, 0, sizeof(id1)); memset(&id2, 0, sizeof(id2)); id1.iface = SNDRV_CTL_ELEM_IFACE_MIXER; id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER; /* reassign AUX0 to FM */ strcpy(id1.name, "Aux Playback Switch"); strcpy(id2.name, "FM Playback Switch"); err = snd_ctl_rename_id(card, &id1, &id2); if (err < 0) return err; strcpy(id1.name, "Aux Playback Volume"); strcpy(id2.name, "FM Playback Volume"); err = snd_ctl_rename_id(card, &id1, &id2); if (err < 0) return err; /* reassign AUX1 to CD */ strcpy(id1.name, "Aux Playback Switch"); id1.index = 1; strcpy(id2.name, "CD Playback Switch"); err = snd_ctl_rename_id(card, &id1, &id2); if (err < 0) return err; strcpy(id1.name, "Aux Playback Volume"); strcpy(id2.name, "CD Playback Volume"); err = snd_ctl_rename_id(card, &id1, &id2); if (err < 0) return err; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt238100.00%2100.00%
Total238100.00%2100.00%


static int snd_sc6000_match(struct device *devptr, unsigned int dev) { if (!enable[dev]) return 0; if (port[dev] == SNDRV_AUTO_PORT) { printk(KERN_ERR PFX "specify IO port\n"); return 0; } if (mss_port[dev] == SNDRV_AUTO_PORT) { printk(KERN_ERR PFX "specify MSS port\n"); return 0; } if (port[dev] != 0x220 && port[dev] != 0x240) { printk(KERN_ERR PFX "Port must be 0x220 or 0x240\n"); return 0; } if (mss_port[dev] != 0x530 && mss_port[dev] != 0xe80) { printk(KERN_ERR PFX "MSS port must be 0x530 or 0xe80\n"); return 0; } if (irq[dev] != SNDRV_AUTO_IRQ && !sc6000_irq_to_softcfg(irq[dev])) { printk(KERN_ERR PFX "invalid IRQ %d\n", irq[dev]); return 0; } if (dma[dev] != SNDRV_AUTO_DMA && !sc6000_dma_to_softcfg(dma[dev])) { printk(KERN_ERR PFX "invalid DMA %d\n", dma[dev]); return 0; } if (mpu_port[dev] != SNDRV_AUTO_PORT && (mpu_port[dev] & ~0x30L) != 0x300) { printk(KERN_ERR PFX "invalid MPU-401 port %lx\n", mpu_port[dev]); return 0; } if (mpu_port[dev] != SNDRV_AUTO_PORT && mpu_irq[dev] != SNDRV_AUTO_IRQ && mpu_irq[dev] != 0 && !sc6000_mpu_irq_to_softcfg(mpu_irq[dev])) { printk(KERN_ERR PFX "invalid MPU-401 IRQ %d\n", mpu_irq[dev]); return 0; } return 1; }

Contributors

PersonTokensPropCommitsCommitProp
krzysztof heltkrzysztof helt264100.00%1100.00%
Total264100.00%1100.00%


static int snd_sc6000_probe(struct device *devptr, unsigned int dev) { static int possible_irqs[] = { 5, 7, 9, 10, 11, -1 }; static int possible_dmas[] = { 1, 3, 0, -1 }; int err; int xirq = irq[dev]; int xdma = dma[dev]; struct snd_card *card; struct snd_wss *chip; struct snd_opl3 *opl3; char __iomem **vport; char __iomem *vmss_port; err = snd_card_new(devptr, index[dev], id[dev], THIS_MODULE, sizeof(vport), &card); if (err < 0) return err; vport = card->private_data; if (xirq == SNDRV_AUTO_IRQ) { xirq = snd_legacy_find_free_irq(possible_irqs); if (xirq < 0) { snd_printk(KERN_ERR PFX "unable to find a free IRQ\n"); err = -EBUSY; goto err_exit; } } if (xdma == SNDRV_AUTO_DMA) { xdma = snd_legacy_find_free_dma(possible_dmas); if (xdma < 0) { snd_printk(KERN_ERR PFX "unable to find a free DMA\n"); err = -EBUSY; goto err_exit; } } if (!request_region(port[dev], 0x10, DRV_NAME)) { snd_printk(KERN_ERR PFX "I/O port region is already in use.\n"); err = -EBUSY; goto err_exit; } *vport = devm_ioport_map(devptr, port[dev], 0x10); if (*vport == NULL) { snd_printk(KERN_ERR PFX "I/O port cannot be iomaped.\n"); err = -EBUSY; goto err_unmap1; } /* to make it marked as used */ if (!request_region(mss_port[dev], 4, DRV_NAME)) { snd_printk(KERN_ERR PFX "SC-6000 port I/O port region is already in use.\n"); err = -EBUSY; goto err_unmap1; } vmss_port = devm_ioport_map(devptr, mss_port[dev], 4); if (!vmss_port) { snd_printk(KERN_ERR PFX "MSS port I/O cannot be iomaped.\n"); err = -EBUSY; goto err_unmap2; } snd_printd("Initializing BASE[0x%lx] IRQ[%d] DMA[%d] MIRQ[%d]\n", port[dev], xirq, xdma, mpu_irq[dev] == SNDRV_AUTO_IRQ ? 0 : mpu_irq[dev]); err = sc6000_init_board(*vport, vmss_port, dev); if (err < 0) goto err_unmap2; err = snd_wss_create(card, mss_port[dev] + 4, -1, xirq, xdma, -1, WSS_HW_DETECT, 0, &chip); if (err < 0) goto err_unmap2; err = snd_wss_pcm(chip, 0); if (err < 0) { snd_printk(KERN_ERR PFX "error creating new WSS PCM device\n"); goto err_unmap2; } err = snd_wss_mixer(chip); if (err < 0) { snd_printk(KERN_ERR PFX "error creating new WSS mixer\n"); goto err_unmap2; } err = snd_sc6000_mixer(chip); if (err < 0) { snd_printk(KERN_ERR PFX "the mixer rewrite failed\n"); goto err_unmap2; } if (snd_opl3_create(card, 0x388, 0x388 + 2, OPL3_HW_AUTO, 0, &opl3) < 0) { snd_printk(KERN_ERR PFX "no OPL device at 0x%x-0x%x ?\n", 0x388, 0x388 + 2); } else { err = snd_opl3_hwdep_new(opl3, 0, 1, NULL); if (err < 0) goto err_unmap2; } if (mpu_port[dev] != SNDRV_AUTO_PORT) { if (mpu_irq[dev] == SNDRV_AUTO_IRQ) mpu_irq[dev] = -1; if (snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401, mpu_port[dev], 0, mpu_irq[dev], NULL) < 0) snd_printk(KERN_ERR "no MPU-401 device at 0x%lx ?\n",