sound/pci/asihpi/hpidspcd.c

   1 /***********************************************************************/
   2 /**
   3
   4     AudioScience HPI driver
   5     Copyright (C) 1997-2011  AudioScience Inc. <support@audioscience.com>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of version 2 of the GNU General Public License as
   9     published by the Free Software Foundation;
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20 \file
  21 Functions for reading DSP code using
  22 hotplug firmware loader from individual dsp code files
  23 */
  24 /***********************************************************************/
  25 #define SOURCEFILE_NAME "hpidspcd.c"
  26 #include "hpidspcd.h"
  27 #include "hpidebug.h"
  28
  29 struct dsp_code_private {
  30         /**  Firmware descriptor */
  31         const struct firmware *firmware;
  32         struct pci_dev *dev;
  33 };
  34
  35 #define HPI_VER_DECIMAL ((int)(HPI_VER_MAJOR(HPI_VER) * 10000 + \
  36             HPI_VER_MINOR(HPI_VER) * 100 + HPI_VER_RELEASE(HPI_VER)))
  37
  38 /*-------------------------------------------------------------------*/
  39 short hpi_dsp_code_open(u32 adapter, void *os_data, struct dsp_code *dsp_code,
  40         u32 *os_error_code)
  41 {
  42         const struct firmware *firmware;
  43         struct pci_dev *dev = os_data;
  44         struct code_header header;
  45         char fw_name[20];
  46         int err;
  47
  48         sprintf(fw_name, "asihpi/dsp%04x.bin", adapter);
  49
  50         err = request_firmware(&firmware, fw_name, &dev->dev);
  51
  52         if (err || !firmware) {
  53                 dev_printk(KERN_ERR, &dev->dev,
  54                         "%d, request_firmware failed for  %s\n", err,
  55                         fw_name);
  56                 goto error1;
  57         }
  58         if (firmware->size < sizeof(header)) {
  59                 dev_printk(KERN_ERR, &dev->dev, "Header size too small %s\n",
  60                         fw_name);
  61                 goto error2;
  62         }
  63         memcpy(&header, firmware->data, sizeof(header));
  64
  65         if ((header.type != 0x45444F43) ||      /* "CODE" */
  66                 (header.adapter != adapter)
  67                 || (header.size != firmware->size)) {
  68                 dev_printk(KERN_ERR, &dev->dev, "Invalid firmware file\n");
  69                 goto error2;
  70         }
  71
  72         if ((header.version / 100 & ~1) != (HPI_VER_DECIMAL / 100 & ~1)) {
  73                 dev_printk(KERN_ERR, &dev->dev,
  74                         "Incompatible firmware version "
  75                         "DSP image %d != Driver %d\n", header.version,
  76                         HPI_VER_DECIMAL);
  77                 goto error2;
  78         }
  79
  80         if (header.version != HPI_VER_DECIMAL) {
  81                 dev_printk(KERN_WARNING, &dev->dev,
  82                         "Firmware: release version mismatch  DSP image %d != Driver %d\n",
  83                         header.version, HPI_VER_DECIMAL);
  84         }
  85
  86         HPI_DEBUG_LOG(DEBUG, "dsp code %s opened\n", fw_name);
  87         dsp_code->pvt = kmalloc(sizeof(*dsp_code->pvt), GFP_KERNEL);
  88         if (!dsp_code->pvt)
  89                 return HPI_ERROR_MEMORY_ALLOC;
  90
  91         dsp_code->pvt->dev = dev;
  92         dsp_code->pvt->firmware = firmware;
  93         dsp_code->header = header;
  94         dsp_code->block_length = header.size / sizeof(u32);
  95         dsp_code->word_count = sizeof(header) / sizeof(u32);
  96         return 0;
  97
  98 error2:
  99         release_firmware(firmware);
 100 error1:
 101         dsp_code->block_length = 0;
 102         return HPI_ERROR_DSP_FILE_NOT_FOUND;
 103 }
 104
 105 /*-------------------------------------------------------------------*/
 106 void hpi_dsp_code_close(struct dsp_code *dsp_code)
 107 {
 108         if (dsp_code->pvt->firmware) {
 109                 HPI_DEBUG_LOG(DEBUG, "dsp code closed\n");
 110                 release_firmware(dsp_code->pvt->firmware);
 111                 dsp_code->pvt->firmware = NULL;
 112         }
 113         kfree(dsp_code->pvt);
 114 }
 115
 116 /*-------------------------------------------------------------------*/
 117 void hpi_dsp_code_rewind(struct dsp_code *dsp_code)
 118 {
 119         /* Go back to start of  data, after header */
 120         dsp_code->word_count = sizeof(struct code_header) / sizeof(u32);
 121 }
 122
 123 /*-------------------------------------------------------------------*/
 124 short hpi_dsp_code_read_word(struct dsp_code *dsp_code, u32 *pword)
 125 {
 126         if (dsp_code->word_count + 1 > dsp_code->block_length)
 127                 return HPI_ERROR_DSP_FILE_FORMAT;
 128
 129         *pword = ((u32 *)(dsp_code->pvt->firmware->data))[dsp_code->
 130                 word_count];
 131         dsp_code->word_count++;
 132         return 0;
 133 }
 134
 135 /*-------------------------------------------------------------------*/
 136 short hpi_dsp_code_read_block(size_t words_requested,
 137         struct dsp_code *dsp_code, u32 **ppblock)
 138 {
 139         if (dsp_code->word_count + words_requested > dsp_code->block_length)
 140                 return HPI_ERROR_DSP_FILE_FORMAT;
 141
 142         *ppblock =
 143                 ((u32 *)(dsp_code->pvt->firmware->data)) +
 144                 dsp_code->word_count;
 145         dsp_code->word_count += words_requested;
 146         return 0;
 147 }