sys/dev/sound/isa/i386/css/cs4232.c

   1 /*
   2  * sound/cs4232.c
   3  *
   4  * The low level driver for Crystal CS4232 based cards. The CS4232 is a PnP
   5  * compatible chip which contains a CS4231A codec, SB emulation, a MPU401
   6  * compatible MIDI port, joystick and synthesizer and IDE CD-ROM interfaces.
   7  * This is just a temporary driver until full PnP support gets inplemented.
   8  * Just the WSS codec, FM synth and the MIDI ports are supported. Other
   9  * interfaces are left uninitialized.
  10  *
  11  * Copyright by Hannu Savolainen 1995
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions are
  15  * met: 1. Redistributions of source code must retain the above copyright
  16  * notice, this list of conditions and the following disclaimer. 2.
  17  * Redistributions in binary form must reproduce the above copyright notice,
  18  * this list of conditions and the following disclaimer in the documentation
  19  * and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
  22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/sys/i386/isa/sound/cs4232.c,v 1.6 2000/01/24 08:16:15 bde Exp $
  34  */
  35
  36 #include <i386/isa/sound/sound_config.h>
  37
  38 #if defined(CONFIG_CS4232)
  39
  40 #define KEY_PORT        0x279   /* Same as LPT1 status port */
  41 #define CSN_NUM         0x99    /* Just a random number */
  42
  43 #define CS_OUT(a)               outb( KEY_PORT,  a)
  44 #define CS_OUT2(a, b)           {CS_OUT(a);CS_OUT(b);}
  45 #define CS_OUT3(a, b, c)        {CS_OUT(a);CS_OUT(b);CS_OUT(c);}
  46
  47 static int      mpu_base = 0, mpu_irq = 0;
  48
  49 int
  50 probe_cs4232_mpu(struct address_info * hw_config)
  51 {
  52     /*
  53      * Just write down the config values.
  54      */
  55
  56     mpu_base = hw_config->io_base;
  57     mpu_irq = hw_config->irq;
  58     return 0;
  59 }
  60
  61 void
  62 attach_cs4232_mpu(struct address_info * hw_config)
  63 {
  64 }
  65
  66 static unsigned char crystal_key[] =    /* A 32 byte magic key sequence */
  67 {
  68     0x96, 0x35, 0x9a, 0xcd, 0xe6, 0xf3, 0x79, 0xbc,
  69     0x5e, 0xaf, 0x57, 0x2b, 0x15, 0x8a, 0xc5, 0xe2,
  70     0xf1, 0xf8, 0x7c, 0x3e, 0x9f, 0x4f, 0x27, 0x13,
  71     0x09, 0x84, 0x42, 0xa1, 0xd0, 0x68, 0x34, 0x1a
  72 };
  73
  74 int
  75 probe_cs4232(struct address_info * hw_config)
  76 {
  77     int             i;
  78     int             base = hw_config->io_base, irq = hw_config->irq;
  79     int             dma1 = hw_config->dma, dma2 = hw_config->dma2;
  80
  81     /*
  82      * Verify that the I/O port range is free.
  83      */
  84
  85     if (0) {
  86         printf("cs4232.c: I/O port 0x%03x not free\n", base);
  87         return 0;
  88     }
  89     /*
  90      * This version of the driver doesn't use the PnP method when
  91      * configuring the card but a simplified method defined by Crystal.
  92      * This means that just one CS4232 compatible device can exist on the
  93      * system. Also this method conflicts with possible PnP support in
  94      * the OS. For this reason driver is just a temporary kludge.
  95      */
  96
  97     /*
  98      * Wake up the card by sending a 32 byte Crystal key to the key port.
  99      */
 100     for (i = 0; i < 32; i++)
 101         CS_OUT(crystal_key[i]);
 102
 103     /*
 104      * Now set the CSN (Card Select Number).
 105      */
 106
 107     CS_OUT2(0x06, CSN_NUM);
 108
 109     /*
 110      * Ensure that there is no other codec using the same address.
 111      */
 112
 113     CS_OUT2(0x15, 0x00);        /* Select logical device 0 (WSS/SB/FM) */
 114     CS_OUT2(0x33, 0x00);        /* Inactivate logical dev 0 */
 115
 116     /*
 117      * Then set some config bytes. First logical device 0
 118      */
 119
 120     CS_OUT2(0x15, 0x00);        /* Select logical device 0 (WSS/SB/FM) */
 121     CS_OUT3(0x47, (base >> 8) & 0xff, base & 0xff);     /* WSSbase */
 122
 123     if (0)                      /* Not free */
 124         CS_OUT3(0x48, 0x00, 0x00)       /* FMbase off */
 125     else
 126         CS_OUT3(0x48, 0x03, 0x88);      /* FMbase 0x388 */
 127
 128     CS_OUT3(0x42, 0x00, 0x00);  /* SBbase off */
 129     CS_OUT2(0x22, irq); /* SB+WSS IRQ */
 130     CS_OUT2(0x2a, dma1);        /* SB+WSS DMA */
 131
 132     if (dma2 != -1)
 133         CS_OUT2(0x25, dma2)     /* WSS DMA2 */
 134     else
 135         CS_OUT2(0x25, 4);       /* No WSS DMA2 */
 136
 137     CS_OUT2(0x33, 0x01);        /* Activate logical dev 0 */
 138
 139     /*
 140      * Initialize logical device 3 (MPU)
 141      */
 142
 143 #if (defined(CONFIG_MPU401) || defined(CONFIG_MPU_EMU)) && defined(CONFIG_MIDI)
 144     if (mpu_base != 0 && mpu_irq != 0) {
 145         CS_OUT2(0x15, 0x03);    /* Select logical device 3 (MPU) */
 146         CS_OUT3(0x47, (mpu_base >> 8) & 0xff, mpu_base & 0xff); /* MPUbase */
 147         CS_OUT2(0x22, mpu_irq); /* MPU IRQ */
 148         CS_OUT2(0x33, 0x01);    /* Activate logical dev 3 */
 149     }
 150 #endif
 151
 152     /*
 153      * Finally activate the chip
 154      */
 155     CS_OUT(0x79);
 156
 157     /*
 158      * Then try to detect the codec part of the chip
 159      */
 160
 161     return ad1848_detect(hw_config->io_base, NULL, hw_config->osp);
 162 }
 163
 164 void
 165 attach_cs4232(struct address_info * hw_config)
 166 {
 167     int             base = hw_config->io_base, irq = hw_config->irq;
 168     int             dma1 = hw_config->dma, dma2 = hw_config->dma2;
 169
 170     if (dma2 == -1)
 171         dma2 = dma1;
 172
 173     ad1848_init("CS4232", base,
 174         irq,
 175         dma1,   /* Playback DMA */
 176         dma2,   /* Capture DMA */
 177         0,
 178         hw_config->osp);
 179
 180 #if (defined(CONFIG_MPU401) || defined(CONFIG_MPU_EMU)) && defined(CONFIG_MIDI)
 181     if (mpu_base != 0 && mpu_irq != 0) {
 182         static struct address_info hw_config2 =
 183         {0};            /* Ensure it's initialized */
 184
 185         hw_config2.io_base = mpu_base;
 186         hw_config2.irq = mpu_irq;
 187         hw_config2.dma = -1;
 188         hw_config2.dma2 = -1;
 189         hw_config2.always_detect = 0;
 190         hw_config2.name = NULL;
 191         hw_config2.card_subtype = 0;
 192         hw_config2.osp = hw_config->osp;
 193
 194         if (probe_mpu401(&hw_config2))
 195             attach_mpu401(&hw_config2);
 196         else
 197             mpu_base = mpu_irq = 0;
 198     }
 199 #endif
 200 }
 201
 202 #endif