drivers/media/video/ivtv/ivtv-firmware.c

   1 /*
   2     ivtv firmware functions.
   3     Copyright (C) 2003-2004  Kevin Thayer <nufan_wfk at yahoo.com>
   4     Copyright (C) 2004  Chris Kennedy <c@groovy.org>
   5     Copyright (C) 2005-2007  Hans Verkuil <hverkuil@xs4all.nl>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include "ivtv-driver.h"
  23 #include "ivtv-mailbox.h"
  24 #include "ivtv-firmware.h"
  25 #include <linux/firmware.h>
  26
  27 #define IVTV_MASK_SPU_ENABLE            0xFFFFFFFE
  28 #define IVTV_MASK_VPU_ENABLE15          0xFFFFFFF6
  29 #define IVTV_MASK_VPU_ENABLE16          0xFFFFFFFB
  30 #define IVTV_CMD_VDM_STOP               0x00000000
  31 #define IVTV_CMD_AO_STOP                0x00000005
  32 #define IVTV_CMD_APU_PING               0x00000000
  33 #define IVTV_CMD_VPU_STOP15             0xFFFFFFFE
  34 #define IVTV_CMD_VPU_STOP16             0xFFFFFFEE
  35 #define IVTV_CMD_HW_BLOCKS_RST          0xFFFFFFFF
  36 #define IVTV_CMD_SPU_STOP               0x00000001
  37 #define IVTV_CMD_SDRAM_PRECHARGE_INIT   0x0000001A
  38 #define IVTV_CMD_SDRAM_REFRESH_INIT     0x80000640
  39 #define IVTV_SDRAM_SLEEPTIME            600
  40
  41 #define IVTV_DECODE_INIT_MPEG_FILENAME  "v4l-cx2341x-init.mpg"
  42 #define IVTV_DECODE_INIT_MPEG_SIZE      (152*1024)
  43
  44 /* Encoder/decoder firmware sizes */
  45 #define IVTV_FW_ENC_SIZE                (376836)
  46 #define IVTV_FW_DEC_SIZE                (256*1024)
  47
  48 static int load_fw_direct(const char *fn, volatile u8 __iomem *mem, struct ivtv *itv, long size)
  49 {
  50         const struct firmware *fw = NULL;
  51         int retries = 3;
  52
  53 retry:
  54         if (retries && request_firmware(&fw, fn, &itv->dev->dev) == 0) {
  55                 int i;
  56                 volatile u32 __iomem *dst = (volatile u32 __iomem *)mem;
  57                 const u32 *src = (const u32 *)fw->data;
  58
  59                 if (fw->size != size) {
  60                         /* Due to race conditions in firmware loading (esp. with udev <0.95)
  61                            the wrong file was sometimes loaded. So we check filesizes to
  62                            see if at least the right-sized file was loaded. If not, then we
  63                            retry. */
  64                         IVTV_INFO("Retry: file loaded was not %s (expected size %ld, got %zd)\n", fn, size, fw->size);
  65                         release_firmware(fw);
  66                         retries--;
  67                         goto retry;
  68                 }
  69                 for (i = 0; i < fw->size; i += 4) {
  70                         /* no need for endianness conversion on the ppc */
  71                         __raw_writel(*src, dst);
  72                         dst++;
  73                         src++;
  74                 }
  75                 release_firmware(fw);
  76                 IVTV_INFO("Loaded %s firmware (%zd bytes)\n", fn, fw->size);
  77                 return size;
  78         }
  79         IVTV_ERR("Unable to open firmware %s (must be %ld bytes)\n", fn, size);
  80         IVTV_ERR("Did you put the firmware in the hotplug firmware directory?\n");
  81         return -ENOMEM;
  82 }
  83
  84 void ivtv_halt_firmware(struct ivtv *itv)
  85 {
  86         IVTV_DEBUG_INFO("Preparing for firmware halt.\n");
  87         if (itv->has_cx23415 && itv->dec_mbox.mbox)
  88                 ivtv_vapi(itv, CX2341X_DEC_HALT_FW, 0);
  89         if (itv->enc_mbox.mbox)
  90                 ivtv_vapi(itv, CX2341X_ENC_HALT_FW, 0);
  91
  92         ivtv_msleep_timeout(10, 0);
  93         itv->enc_mbox.mbox = itv->dec_mbox.mbox = NULL;
  94
  95         IVTV_DEBUG_INFO("Stopping VDM\n");
  96         write_reg(IVTV_CMD_VDM_STOP, IVTV_REG_VDM);
  97
  98         IVTV_DEBUG_INFO("Stopping AO\n");
  99         write_reg(IVTV_CMD_AO_STOP, IVTV_REG_AO);
 100
 101         IVTV_DEBUG_INFO("pinging (?) APU\n");
 102         write_reg(IVTV_CMD_APU_PING, IVTV_REG_APU);
 103
 104         IVTV_DEBUG_INFO("Stopping VPU\n");
 105         if (!itv->has_cx23415)
 106                 write_reg(IVTV_CMD_VPU_STOP16, IVTV_REG_VPU);
 107         else
 108                 write_reg(IVTV_CMD_VPU_STOP15, IVTV_REG_VPU);
 109
 110         IVTV_DEBUG_INFO("Resetting Hw Blocks\n");
 111         write_reg(IVTV_CMD_HW_BLOCKS_RST, IVTV_REG_HW_BLOCKS);
 112
 113         IVTV_DEBUG_INFO("Stopping SPU\n");
 114         write_reg(IVTV_CMD_SPU_STOP, IVTV_REG_SPU);
 115
 116         ivtv_msleep_timeout(10, 0);
 117
 118         IVTV_DEBUG_INFO("init Encoder SDRAM pre-charge\n");
 119         write_reg(IVTV_CMD_SDRAM_PRECHARGE_INIT, IVTV_REG_ENC_SDRAM_PRECHARGE);
 120
 121         IVTV_DEBUG_INFO("init Encoder SDRAM refresh to 1us\n");
 122         write_reg(IVTV_CMD_SDRAM_REFRESH_INIT, IVTV_REG_ENC_SDRAM_REFRESH);
 123
 124         if (itv->has_cx23415) {
 125                 IVTV_DEBUG_INFO("init Decoder SDRAM pre-charge\n");
 126                 write_reg(IVTV_CMD_SDRAM_PRECHARGE_INIT, IVTV_REG_DEC_SDRAM_PRECHARGE);
 127
 128                 IVTV_DEBUG_INFO("init Decoder SDRAM refresh to 1us\n");
 129                 write_reg(IVTV_CMD_SDRAM_REFRESH_INIT, IVTV_REG_DEC_SDRAM_REFRESH);
 130         }
 131
 132         IVTV_DEBUG_INFO("Sleeping for %dms\n", IVTV_SDRAM_SLEEPTIME);
 133         ivtv_msleep_timeout(IVTV_SDRAM_SLEEPTIME, 0);
 134 }
 135
 136 void ivtv_firmware_versions(struct ivtv *itv)
 137 {
 138         u32 data[CX2341X_MBOX_MAX_DATA];
 139
 140         /* Encoder */
 141         ivtv_vapi_result(itv, data, CX2341X_ENC_GET_VERSION, 0);
 142         IVTV_INFO("Encoder revision: 0x%08x\n", data[0]);
 143
 144         if (data[0] != 0x02060039)
 145                 IVTV_WARN("Recommended firmware version is 0x02060039.\n");
 146
 147         if (itv->has_cx23415) {
 148                 /* Decoder */
 149                 ivtv_vapi_result(itv, data, CX2341X_DEC_GET_VERSION, 0);
 150                 IVTV_INFO("Decoder revision: 0x%08x\n", data[0]);
 151         }
 152 }
 153
 154 static int ivtv_firmware_copy(struct ivtv *itv)
 155 {
 156         IVTV_DEBUG_INFO("Loading encoder image\n");
 157         if (load_fw_direct(CX2341X_FIRM_ENC_FILENAME,
 158                    itv->enc_mem, itv, IVTV_FW_ENC_SIZE) != IVTV_FW_ENC_SIZE) {
 159                 IVTV_DEBUG_WARN("failed loading encoder firmware\n");
 160                 return -3;
 161         }
 162         if (!itv->has_cx23415)
 163                 return 0;
 164
 165         IVTV_DEBUG_INFO("Loading decoder image\n");
 166         if (load_fw_direct(CX2341X_FIRM_DEC_FILENAME,
 167                    itv->dec_mem, itv, IVTV_FW_DEC_SIZE) != IVTV_FW_DEC_SIZE) {
 168                 IVTV_DEBUG_WARN("failed loading decoder firmware\n");
 169                 return -1;
 170         }
 171         return 0;
 172 }
 173
 174 static volatile struct ivtv_mailbox __iomem *ivtv_search_mailbox(const volatile u8 __iomem *mem, u32 size)
 175 {
 176         int i;
 177
 178         /* mailbox is preceeded by a 16 byte 'magic cookie' starting at a 256-byte
 179            address boundary */
 180         for (i = 0; i < size; i += 0x100) {
 181                 if (readl(mem + i)      == 0x12345678 &&
 182                     readl(mem + i + 4)  == 0x34567812 &&
 183                     readl(mem + i + 8)  == 0x56781234 &&
 184                     readl(mem + i + 12) == 0x78123456) {
 185                         return (volatile struct ivtv_mailbox __iomem *)(mem + i + 16);
 186                 }
 187         }
 188         return NULL;
 189 }
 190
 191 int ivtv_firmware_init(struct ivtv *itv)
 192 {
 193         int err;
 194
 195         ivtv_halt_firmware(itv);
 196
 197         /* load firmware */
 198         err = ivtv_firmware_copy(itv);
 199         if (err) {
 200                 IVTV_DEBUG_WARN("Error %d loading firmware\n", err);
 201                 return err;
 202         }
 203
 204         /* start firmware */
 205         write_reg(read_reg(IVTV_REG_SPU) & IVTV_MASK_SPU_ENABLE, IVTV_REG_SPU);
 206         ivtv_msleep_timeout(100, 0);
 207         if (itv->has_cx23415)
 208                 write_reg(read_reg(IVTV_REG_VPU) & IVTV_MASK_VPU_ENABLE15, IVTV_REG_VPU);
 209         else
 210                 write_reg(read_reg(IVTV_REG_VPU) & IVTV_MASK_VPU_ENABLE16, IVTV_REG_VPU);
 211         ivtv_msleep_timeout(100, 0);
 212
 213         /* find mailboxes and ping firmware */
 214         itv->enc_mbox.mbox = ivtv_search_mailbox(itv->enc_mem, IVTV_ENCODER_SIZE);
 215         if (itv->enc_mbox.mbox == NULL)
 216                 IVTV_ERR("Encoder mailbox not found\n");
 217         else if (ivtv_vapi(itv, CX2341X_ENC_PING_FW, 0)) {
 218                 IVTV_ERR("Encoder firmware dead!\n");
 219                 itv->enc_mbox.mbox = NULL;
 220         }
 221         if (itv->enc_mbox.mbox == NULL)
 222                 return -ENODEV;
 223
 224         if (!itv->has_cx23415)
 225                 return 0;
 226
 227         itv->dec_mbox.mbox = ivtv_search_mailbox(itv->dec_mem, IVTV_DECODER_SIZE);
 228         if (itv->dec_mbox.mbox == NULL)
 229                 IVTV_ERR("Decoder mailbox not found\n");
 230         else if (itv->has_cx23415 && ivtv_vapi(itv, CX2341X_DEC_PING_FW, 0)) {
 231                 IVTV_ERR("Decoder firmware dead!\n");
 232                 itv->dec_mbox.mbox = NULL;
 233         }
 234         return itv->dec_mbox.mbox ? 0 : -ENODEV;
 235 }
 236
 237 void ivtv_init_mpeg_decoder(struct ivtv *itv)
 238 {
 239         u32 data[CX2341X_MBOX_MAX_DATA];
 240         long readbytes;
 241         volatile u8 __iomem *mem_offset;
 242
 243         data[0] = 0;
 244         data[1] = itv->params.width;    /* YUV source width */
 245         data[2] = itv->params.height;
 246         data[3] = itv->params.audio_properties; /* Audio settings to use,
 247                                                            bitmap. see docs. */
 248         if (ivtv_api(itv, CX2341X_DEC_SET_DECODER_SOURCE, 4, data)) {
 249                 IVTV_ERR("ivtv_init_mpeg_decoder failed to set decoder source\n");
 250                 return;
 251         }
 252
 253         if (ivtv_vapi(itv, CX2341X_DEC_START_PLAYBACK, 2, 0, 1) != 0) {
 254                 IVTV_ERR("ivtv_init_mpeg_decoder failed to start playback\n");
 255                 return;
 256         }
 257         ivtv_api_get_data(&itv->dec_mbox, IVTV_MBOX_DMA, data);
 258         mem_offset = itv->dec_mem + data[1];
 259
 260         if ((readbytes = load_fw_direct(IVTV_DECODE_INIT_MPEG_FILENAME,
 261                 mem_offset, itv, IVTV_DECODE_INIT_MPEG_SIZE)) <= 0) {
 262                 IVTV_DEBUG_WARN("failed to read mpeg decoder initialisation file %s\n",
 263                                 IVTV_DECODE_INIT_MPEG_FILENAME);
 264         } else {
 265                 ivtv_vapi(itv, CX2341X_DEC_SCHED_DMA_FROM_HOST, 3, 0, readbytes, 0);
 266                 ivtv_msleep_timeout(100, 0);
 267         }
 268         ivtv_vapi(itv, CX2341X_DEC_STOP_PLAYBACK, 4, 0, 0, 0, 1);
 269 }