sound/pci/pcxhr/pcxhr_hwdep.c

   1 /*
   2  * Driver for Digigram pcxhr compatible soundcards
   3  *
   4  * hwdep device manager
   5  *
   6  * Copyright (c) 2004 by Digigram <alsa@digigram.com>
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  */
  22
  23 #include <linux/interrupt.h>
  24 #include <linux/vmalloc.h>
  25 #include <linux/firmware.h>
  26 #include <linux/pci.h>
  27 #include <asm/io.h>
  28 #include <sound/core.h>
  29 #include <sound/hwdep.h>
  30 #include "pcxhr.h"
  31 #include "pcxhr_mixer.h"
  32 #include "pcxhr_hwdep.h"
  33 #include "pcxhr_core.h"
  34
  35
  36 #if defined(CONFIG_FW_LOADER) || defined(CONFIG_FW_LOADER_MODULE)
  37 #if !defined(CONFIG_USE_PCXHRLOADER) && !defined(CONFIG_SND_PCXHR) /* built-in kernel */
  38 #define SND_PCXHR_FW_LOADER     /* use the standard firmware loader */
  39 #endif
  40 #endif
  41
  42
  43 /*
  44  * get basic information and init pcxhr card
  45  */
  46
  47 static int pcxhr_init_board(struct pcxhr_mgr *mgr)
  48 {
  49         int err;
  50         struct pcxhr_rmh rmh;
  51         int card_streams;
  52
  53         /* calc the number of all streams used */
  54         if (mgr->mono_capture)
  55                 card_streams = mgr->capture_chips * 2;
  56         else
  57                 card_streams = mgr->capture_chips;
  58         card_streams += mgr->playback_chips * PCXHR_PLAYBACK_STREAMS;
  59
  60         /* enable interrupts */
  61         pcxhr_enable_dsp(mgr);
  62
  63         pcxhr_init_rmh(&rmh, CMD_SUPPORTED);
  64         err = pcxhr_send_msg(mgr, &rmh);
  65         if (err)
  66                 return err;
  67         /* test 8 or 12 phys out */
  68         snd_assert((rmh.stat[0] & MASK_FIRST_FIELD) == mgr->playback_chips*2,
  69                    return -EINVAL);
  70         /* test 8 or 2 phys in */
  71         snd_assert(((rmh.stat[0] >> (2*FIELD_SIZE)) & MASK_FIRST_FIELD) ==
  72                    mgr->capture_chips * 2, return -EINVAL);
  73         /* test max nb substream per board */
  74         snd_assert((rmh.stat[1] & 0x5F) >= card_streams, return -EINVAL);
  75         /* test max nb substream per pipe */
  76         snd_assert(((rmh.stat[1]>>7)&0x5F) >= PCXHR_PLAYBACK_STREAMS, return -EINVAL);
  77
  78         pcxhr_init_rmh(&rmh, CMD_VERSION);
  79         /* firmware num for DSP */
  80         rmh.cmd[0] |= mgr->firmware_num;
  81         /* transfer granularity in samples (should be multiple of 48) */
  82         rmh.cmd[1] = (1<<23) + PCXHR_GRANULARITY;
  83         rmh.cmd_len = 2;
  84         err = pcxhr_send_msg(mgr, &rmh);
  85         if (err)
  86                 return err;
  87         snd_printdd("PCXHR DSP version is %d.%d.%d\n",
  88                     (rmh.stat[0]>>16)&0xff, (rmh.stat[0]>>8)&0xff, rmh.stat[0]&0xff);
  89         mgr->dsp_version = rmh.stat[0];
  90
  91         /* get options */
  92         pcxhr_init_rmh(&rmh, CMD_ACCESS_IO_READ);
  93         rmh.cmd[0] |= IO_NUM_REG_STATUS;
  94         rmh.cmd[1]  = REG_STATUS_OPTIONS;
  95         rmh.cmd_len = 2;
  96         err = pcxhr_send_msg(mgr, &rmh);
  97         if (err)
  98                 return err;
  99
 100         if ((rmh.stat[1] & REG_STATUS_OPT_DAUGHTER_MASK) == REG_STATUS_OPT_ANALOG_BOARD)
 101                 mgr->board_has_analog = 1;      /* analog addon board available */
 102         else
 103                 /* analog addon board not available -> no support for instance */
 104                 return -EINVAL;
 105
 106         /* unmute inputs */
 107         err = pcxhr_write_io_num_reg_cont(mgr, REG_CONT_UNMUTE_INPUTS,
 108                                           REG_CONT_UNMUTE_INPUTS, NULL);
 109         if (err)
 110                 return err;
 111         /* unmute outputs */
 112         pcxhr_init_rmh(&rmh, CMD_ACCESS_IO_READ); /* a write to IO_NUM_REG_MUTE_OUT mutes! */
 113         rmh.cmd[0] |= IO_NUM_REG_MUTE_OUT;
 114         err = pcxhr_send_msg(mgr, &rmh);
 115         return err;
 116 }
 117
 118 void pcxhr_reset_board(struct pcxhr_mgr *mgr)
 119 {
 120         struct pcxhr_rmh rmh;
 121
 122         if (mgr->dsp_loaded & (1 << PCXHR_FIRMWARE_DSP_MAIN_INDEX)) {
 123                 /* mute outputs */
 124                 /* a read to IO_NUM_REG_MUTE_OUT register unmutes! */
 125                 pcxhr_init_rmh(&rmh, CMD_ACCESS_IO_WRITE);
 126                 rmh.cmd[0] |= IO_NUM_REG_MUTE_OUT;
 127                 pcxhr_send_msg(mgr, &rmh);
 128                 /* mute inputs */
 129                 pcxhr_write_io_num_reg_cont(mgr, REG_CONT_UNMUTE_INPUTS, 0, NULL);
 130         }
 131         /* reset pcxhr dsp */
 132         if (mgr->dsp_loaded & ( 1 << PCXHR_FIRMWARE_DSP_EPRM_INDEX))
 133                 pcxhr_reset_dsp(mgr);
 134         /* reset second xilinx */
 135         if (mgr->dsp_loaded & ( 1 << PCXHR_FIRMWARE_XLX_COM_INDEX))
 136                 pcxhr_reset_xilinx_com(mgr);
 137         return;
 138 }
 139
 140
 141 /*
 142  *  allocate a playback/capture pipe (pcmp0/pcmc0)
 143  */
 144 static int pcxhr_dsp_allocate_pipe( struct pcxhr_mgr *mgr, struct pcxhr_pipe *pipe,
 145                                     int is_capture, int pin)
 146 {
 147         int stream_count, audio_count;
 148         int err;
 149         struct pcxhr_rmh rmh;
 150
 151         if (is_capture) {
 152                 stream_count = 1;
 153                 if (mgr->mono_capture)
 154                         audio_count = 1;
 155                 else
 156                         audio_count = 2;
 157         } else {
 158                 stream_count = PCXHR_PLAYBACK_STREAMS;
 159                 audio_count = 2;        /* always stereo */
 160         }
 161         snd_printdd("snd_add_ref_pipe pin(%d) pcm%c0\n", pin, is_capture ? 'c' : 'p');
 162         pipe->is_capture = is_capture;
 163         pipe->first_audio = pin;
 164         /* define pipe (P_PCM_ONLY_MASK (0x020000) is not necessary) */
 165         pcxhr_init_rmh(&rmh, CMD_RES_PIPE);
 166         pcxhr_set_pipe_cmd_params(&rmh, is_capture, pin, audio_count, stream_count);
 167         err = pcxhr_send_msg(mgr, &rmh);
 168         if (err < 0) {
 169                 snd_printk(KERN_ERR "error pipe allocation (CMD_RES_PIPE) err=%x!\n", err );
 170                 return err;
 171         }
 172         pipe->status = PCXHR_PIPE_DEFINED;
 173
 174         return 0;
 175 }
 176
 177 /*
 178  *  free playback/capture pipe (pcmp0/pcmc0)
 179  */
 180 #if 0
 181 static int pcxhr_dsp_free_pipe( struct pcxhr_mgr *mgr, struct pcxhr_pipe *pipe)
 182 {
 183         struct pcxhr_rmh rmh;
 184         int capture_mask = 0;
 185         int playback_mask = 0;
 186         int err = 0;
 187
 188         if (pipe->is_capture)
 189                 capture_mask  = (1 << pipe->first_audio);
 190         else
 191                 playback_mask = (1 << pipe->first_audio);
 192
 193         /* stop one pipe */
 194         err = pcxhr_set_pipe_state(mgr, playback_mask, capture_mask, 0);
 195         if (err < 0)
 196                 snd_printk(KERN_ERR "error stopping pipe!\n");
 197         /* release the pipe */
 198         pcxhr_init_rmh(&rmh, CMD_FREE_PIPE);
 199         pcxhr_set_pipe_cmd_params(&rmh, pipe->is_capture, pipe->first_audio, 0, 0);
 200         err = pcxhr_send_msg(mgr, &rmh);
 201         if (err < 0)
 202                 snd_printk(KERN_ERR "error pipe release (CMD_FREE_PIPE) err(%x)\n", err);
 203         pipe->status = PCXHR_PIPE_UNDEFINED;
 204         return err;
 205 }
 206 #endif
 207
 208
 209 static int pcxhr_config_pipes(struct pcxhr_mgr *mgr)
 210 {
 211         int err, i, j;
 212         struct snd_pcxhr *chip;
 213         struct pcxhr_pipe *pipe;
 214
 215         /* allocate the pipes on the dsp */
 216         for (i = 0; i < mgr->num_cards; i++) {
 217                 chip = mgr->chip[i];
 218                 if (chip->nb_streams_play) {
 219                         pipe = &chip->playback_pipe;
 220                         err = pcxhr_dsp_allocate_pipe( mgr, pipe, 0, i*2);
 221                         if (err)
 222                                 return err;
 223                         for(j = 0; j < chip->nb_streams_play; j++)
 224                                 chip->playback_stream[j].pipe = pipe;
 225                 }
 226                 for (j = 0; j < chip->nb_streams_capt; j++) {
 227                         pipe = &chip->capture_pipe[j];
 228                         err = pcxhr_dsp_allocate_pipe(mgr, pipe, 1, i*2 + j);
 229                         if (err)
 230                                 return err;
 231                         chip->capture_stream[j].pipe = pipe;
 232                 }
 233         }
 234         return 0;
 235 }
 236
 237 static int pcxhr_start_pipes(struct pcxhr_mgr *mgr)
 238 {
 239         int i, j;
 240         struct snd_pcxhr *chip;
 241         int playback_mask = 0;
 242         int capture_mask = 0;
 243
 244         /* start all the pipes on the dsp */
 245         for (i = 0; i < mgr->num_cards; i++) {
 246                 chip = mgr->chip[i];
 247                 if (chip->nb_streams_play)
 248                         playback_mask |= (1 << chip->playback_pipe.first_audio);
 249                 for (j = 0; j < chip->nb_streams_capt; j++)
 250                         capture_mask |= (1 << chip->capture_pipe[j].first_audio);
 251         }
 252         return pcxhr_set_pipe_state(mgr, playback_mask, capture_mask, 1);
 253 }
 254
 255
 256 static int pcxhr_dsp_load(struct pcxhr_mgr *mgr, int index, const struct firmware *dsp)
 257 {
 258         int err, card_index;
 259
 260         snd_printdd("loading dsp [%d] size = %Zd\n", index, dsp->size);
 261
 262         switch (index) {
 263         case PCXHR_FIRMWARE_XLX_INT_INDEX:
 264                 pcxhr_reset_xilinx_com(mgr);
 265                 return pcxhr_load_xilinx_binary(mgr, dsp, 0);
 266
 267         case PCXHR_FIRMWARE_XLX_COM_INDEX:
 268                 pcxhr_reset_xilinx_com(mgr);
 269                 return pcxhr_load_xilinx_binary(mgr, dsp, 1);
 270
 271         case PCXHR_FIRMWARE_DSP_EPRM_INDEX:
 272                 pcxhr_reset_dsp(mgr);
 273                 return pcxhr_load_eeprom_binary(mgr, dsp);
 274
 275         case PCXHR_FIRMWARE_DSP_BOOT_INDEX:
 276                 return pcxhr_load_boot_binary(mgr, dsp);
 277
 278         case PCXHR_FIRMWARE_DSP_MAIN_INDEX:
 279                 err = pcxhr_load_dsp_binary(mgr, dsp);
 280                 if (err)
 281                         return err;
 282                 break;  /* continue with first init */
 283         default:
 284                 snd_printk(KERN_ERR "wrong file index\n");
 285                 return -EFAULT;
 286         } /* end of switch file index*/
 287
 288         /* first communication with embedded */
 289         err = pcxhr_init_board(mgr);
 290         if (err < 0) {
 291                 snd_printk(KERN_ERR "pcxhr could not be set up\n");
 292                 return err;
 293         }
 294         err = pcxhr_config_pipes(mgr);
 295         if (err < 0) {
 296                 snd_printk(KERN_ERR "pcxhr pipes could not be set up\n");
 297                 return err;
 298         }
 299         /* create devices and mixer in accordance with HW options*/
 300         for (card_index = 0; card_index < mgr->num_cards; card_index++) {
 301                 struct snd_pcxhr *chip = mgr->chip[card_index];
 302
 303                 if ((err = pcxhr_create_pcm(chip)) < 0)
 304                         return err;
 305
 306                 if (card_index == 0) {
 307                         if ((err = pcxhr_create_mixer(chip->mgr)) < 0)
 308                                 return err;
 309                 }
 310                 if ((err = snd_card_register(chip->card)) < 0)
 311                         return err;
 312         }
 313         err = pcxhr_start_pipes(mgr);
 314         if (err < 0) {
 315                 snd_printk(KERN_ERR "pcxhr pipes could not be started\n");
 316                 return err;
 317         }
 318         snd_printdd("pcxhr firmware downloaded and successfully set up\n");
 319
 320         return 0;
 321 }
 322
 323 /*
 324  * fw loader entry
 325  */
 326 #ifdef SND_PCXHR_FW_LOADER
 327
 328 int pcxhr_setup_firmware(struct pcxhr_mgr *mgr)
 329 {
 330         static char *fw_files[5] = {
 331                 "xi_1_882.dat",
 332                 "xc_1_882.dat",
 333                 "e321_512.e56",
 334                 "b321_512.b56",
 335                 "d321_512.d56"
 336         };
 337         char path[32];
 338
 339         const struct firmware *fw_entry;
 340         int i, err;
 341
 342         for (i = 0; i < ARRAY_SIZE(fw_files); i++) {
 343                 sprintf(path, "pcxhr/%s", fw_files[i]);
 344                 if (request_firmware(&fw_entry, path, &mgr->pci->dev)) {
 345                         snd_printk(KERN_ERR "pcxhr: can't load firmware %s\n", path);
 346                         return -ENOENT;
 347                 }
 348                 /* fake hwdep dsp record */
 349                 err = pcxhr_dsp_load(mgr, i, fw_entry);
 350                 release_firmware(fw_entry);
 351                 if (err < 0)
 352                         return err;
 353                 mgr->dsp_loaded |= 1 << i;
 354         }
 355         return 0;
 356 }
 357
 358 MODULE_FIRMWARE("pcxhr/xi_1_882.dat");
 359 MODULE_FIRMWARE("pcxhr/xc_1_882.dat");
 360 MODULE_FIRMWARE("pcxhr/e321_512.e56");
 361 MODULE_FIRMWARE("pcxhr/b321_512.b56");
 362 MODULE_FIRMWARE("pcxhr/d321_512.d56");
 363
 364 #else /* old style firmware loading */
 365
 366 /* pcxhr hwdep interface id string */
 367 #define PCXHR_HWDEP_ID       "pcxhr loader"
 368
 369
 370 static int pcxhr_hwdep_dsp_status(struct snd_hwdep *hw,
 371                                   struct snd_hwdep_dsp_status *info)
 372 {
 373         strcpy(info->id, "pcxhr");
 374         info->num_dsps = PCXHR_FIRMWARE_FILES_MAX_INDEX;
 375
 376         if (hw->dsp_loaded & (1 << PCXHR_FIRMWARE_DSP_MAIN_INDEX))
 377                 info->chip_ready = 1;
 378
 379         info->version = PCXHR_DRIVER_VERSION;
 380         return 0;
 381 }
 382
 383 static int pcxhr_hwdep_dsp_load(struct snd_hwdep *hw,
 384                                 struct snd_hwdep_dsp_image *dsp)
 385 {
 386         struct pcxhr_mgr *mgr = hw->private_data;
 387         int err;
 388         struct firmware fw;
 389
 390         fw.size = dsp->length;
 391         fw.data = vmalloc(fw.size);
 392         if (! fw.data) {
 393                 snd_printk(KERN_ERR "pcxhr: cannot allocate dsp image (%lu bytes)\n",
 394                            (unsigned long)fw.size);
 395                 return -ENOMEM;
 396         }
 397         if (copy_from_user(fw.data, dsp->image, dsp->length)) {
 398                 vfree(fw.data);
 399                 return -EFAULT;
 400         }
 401         err = pcxhr_dsp_load(mgr, dsp->index, &fw);
 402         vfree(fw.data);
 403         if (err < 0)
 404                 return err;
 405         mgr->dsp_loaded |= 1 << dsp->index;
 406         return 0;
 407 }
 408
 409 static int pcxhr_hwdep_open(struct snd_hwdep *hw, struct file *file)
 410 {
 411         return 0;
 412 }
 413
 414 static int pcxhr_hwdep_release(struct snd_hwdep *hw, struct file *file)
 415 {
 416         return 0;
 417 }
 418
 419 int pcxhr_setup_firmware(struct pcxhr_mgr *mgr)
 420 {
 421         int err;
 422         struct snd_hwdep *hw;
 423
 424         /* only create hwdep interface for first cardX (see "index" module parameter)*/
 425         if ((err = snd_hwdep_new(mgr->chip[0]->card, PCXHR_HWDEP_ID, 0, &hw)) < 0)
 426                 return err;
 427
 428         hw->iface = SNDRV_HWDEP_IFACE_PCXHR;
 429         hw->private_data = mgr;
 430         hw->ops.open = pcxhr_hwdep_open;
 431         hw->ops.release = pcxhr_hwdep_release;
 432         hw->ops.dsp_status = pcxhr_hwdep_dsp_status;
 433         hw->ops.dsp_load = pcxhr_hwdep_dsp_load;
 434         hw->exclusive = 1;
 435         mgr->dsp_loaded = 0;
 436         sprintf(hw->name, PCXHR_HWDEP_ID);
 437
 438         if ((err = snd_card_register(mgr->chip[0]->card)) < 0)
 439                 return err;
 440         return 0;
 441 }
 442
 443 #endif /* SND_PCXHR_FW_LOADER */