V4L/DVB (10757): cx18, v4l2-chip-ident: Finish conversion of AV decoder core to v4l2_...
[pandora-kernel.git] / drivers / media / video / cx18 / cx18-firmware.c
index 5153442..83cd559 100644 (file)
@@ -2,6 +2,7 @@
  *  cx18 firmware functions
  *
  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
+ *  Copyright (C) 2008  Andy Walls <awalls@radix.net>
  *
  *  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
@@ -105,7 +106,7 @@ static int load_cpu_fw_direct(const char *fn, u8 __iomem *mem, struct cx18 *cx)
        u32 __iomem *dst = (u32 __iomem *)mem;
        const u32 *src;
 
-       if (request_firmware(&fw, fn, &cx->dev->dev)) {
+       if (request_firmware(&fw, fn, &cx->pci_dev->dev)) {
                CX18_ERR("Unable to open firmware %s\n", fn);
                CX18_ERR("Did you put the firmware in the hotplug firmware directory?\n");
                return -ENOMEM;
@@ -121,6 +122,7 @@ static int load_cpu_fw_direct(const char *fn, u8 __iomem *mem, struct cx18 *cx)
                        if (cx18_raw_readl(cx, dst) != *src) {
                                CX18_ERR("Mismatch at offset %x\n", i);
                                release_firmware(fw);
+                               cx18_setup_page(cx, 0);
                                return -EIO;
                        }
                        dst++;
@@ -131,10 +133,12 @@ static int load_cpu_fw_direct(const char *fn, u8 __iomem *mem, struct cx18 *cx)
                CX18_INFO("loaded %s firmware (%zd bytes)\n", fn, fw->size);
        size = fw->size;
        release_firmware(fw);
+       cx18_setup_page(cx, SCB_OFFSET);
        return size;
 }
 
-static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx)
+static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx,
+                               u32 *entry_addr)
 {
        const struct firmware *fw = NULL;
        int i, j;
@@ -146,12 +150,14 @@ static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx)
        u32 apu_version = 0;
        int sz;
 
-       if (request_firmware(&fw, fn, &cx->dev->dev)) {
+       if (request_firmware(&fw, fn, &cx->pci_dev->dev)) {
                CX18_ERR("unable to open firmware %s\n", fn);
                CX18_ERR("did you put the firmware in the hotplug firmware directory?\n");
+               cx18_setup_page(cx, 0);
                return -ENOMEM;
        }
 
+       *entry_addr = 0;
        src = (const u32 *)fw->data;
        vers = fw->data + sizeof(seghdr);
        sz = fw->size;
@@ -168,10 +174,12 @@ static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx)
                }
                CX18_DEBUG_INFO("load segment %x-%x\n", seghdr.addr,
                                seghdr.addr + seghdr.size - 1);
+               if (*entry_addr == 0)
+                       *entry_addr = seghdr.addr;
                if (offset + seghdr.size > sz)
                        break;
                for (i = 0; i < seghdr.size; i += 4096) {
-                       cx18_setup_page(cx, offset + i);
+                       cx18_setup_page(cx, seghdr.addr + i);
                        for (j = i; j < seghdr.size && j < i + 4096; j += 4) {
                                /* no need for endianness conversion on the ppc */
                                cx18_raw_writel(cx, src[(offset + j) / 4],
@@ -181,6 +189,7 @@ static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx)
                                        CX18_ERR("Mismatch at offset %x\n",
                                                 offset + j);
                                        release_firmware(fw);
+                                       cx18_setup_page(cx, 0);
                                        return -EIO;
                                }
                        }
@@ -192,16 +201,17 @@ static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx)
                                fn, apu_version, fw->size);
        size = fw->size;
        release_firmware(fw);
-       /* Clear bit0 for APU to start from 0 */
-       cx18_write_reg(cx, cx18_read_reg(cx, 0xc72030) & ~1, 0xc72030);
+       cx18_setup_page(cx, 0);
        return size;
 }
 
 void cx18_halt_firmware(struct cx18 *cx)
 {
        CX18_DEBUG_INFO("Preparing for firmware halt.\n");
-       cx18_write_reg(cx, 0x000F000F, CX18_PROC_SOFT_RESET); /* stop the fw */
-       cx18_write_reg(cx, 0x00020002, CX18_ADEC_CONTROL);
+       cx18_write_reg_expect(cx, 0x000F000F, CX18_PROC_SOFT_RESET,
+                                 0x0000000F, 0x000F000F);
+       cx18_write_reg_expect(cx, 0x00020002, CX18_ADEC_CONTROL,
+                                 0x00000002, 0x00020002);
 }
 
 void cx18_init_power(struct cx18 *cx, int lowpwr)
@@ -211,9 +221,48 @@ void cx18_init_power(struct cx18 *cx, int lowpwr)
        cx18_write_reg(cx, 0x00000008, CX18_PLL_POWER_DOWN);
 
        /* ADEC out of sleep */
-       cx18_write_reg(cx, 0x00020000, CX18_ADEC_CONTROL);
-
-       /* The fast clock is at 200/245 MHz */
+       cx18_write_reg_expect(cx, 0x00020000, CX18_ADEC_CONTROL,
+                                 0x00000000, 0x00020002);
+
+       /*
+        * The PLL parameters are based on the external crystal frequency that
+        * would ideally be:
+        *
+        * NTSC Color subcarrier freq * 8 =
+        *      4.5 MHz/286 * 455/2 * 8 = 28.63636363... MHz
+        *
+        * The accidents of history and rationale that explain from where this
+        * combination of magic numbers originate can be found in:
+        *
+        * [1] Abrahams, I. C., "Choice of Chrominance Subcarrier Frequency in
+        * the NTSC Standards", Proceedings of the I-R-E, January 1954, pp 79-80
+        *
+        * [2] Abrahams, I. C., "The 'Frequency Interleaving' Principle in the
+        * NTSC Standards", Proceedings of the I-R-E, January 1954, pp 81-83
+        *
+        * As Mike Bradley has rightly pointed out, it's not the exact crystal
+        * frequency that matters, only that all parts of the driver and
+        * firmware are using the same value (close to the ideal value).
+        *
+        * Since I have a strong suspicion that, if the firmware ever assumes a
+        * crystal value at all, it will assume 28.636360 MHz, the crystal
+        * freq used in calculations in this driver will be:
+        *
+        *      xtal_freq = 28.636360 MHz
+        *
+        * an error of less than 0.13 ppm which is way, way better than any off
+        * the shelf crystal will have for accuracy anyway.
+        *
+        * Below I aim to run the PLLs' VCOs near 400 MHz to minimze errors.
+        *
+        * Many thanks to Jeff Campbell and Mike Bradley for their extensive
+        * investigation, experimentation, testing, and suggested solutions of
+        * of audio/video sync problems with SVideo and CVBS captures.
+        */
+
+       /* the fast clock is at 200/245 MHz */
+       /* 1 * xtal_freq * 0x0d.f7df9b8 / 2 = 200 MHz: 400 MHz pre post-divide*/
+       /* 1 * xtal_freq * 0x11.1c71eb8 / 2 = 245 MHz: 490 MHz pre post-divide*/
        cx18_write_reg(cx, lowpwr ? 0xD : 0x11, CX18_FAST_CLOCK_PLL_INT);
        cx18_write_reg(cx, lowpwr ? 0x1EFBF37 : 0x038E3D7,
                                                CX18_FAST_CLOCK_PLL_FRAC);
@@ -223,14 +272,17 @@ void cx18_init_power(struct cx18 *cx, int lowpwr)
        cx18_write_reg(cx, 4, CX18_FAST_CLOCK_PLL_ADJUST_BANDWIDTH);
 
        /* set slow clock to 125/120 MHz */
-       cx18_write_reg(cx, lowpwr ? 0x11 : 0x10, CX18_SLOW_CLOCK_PLL_INT);
-       cx18_write_reg(cx, lowpwr ? 0xEBAF05 : 0x18618A8,
+       /* xtal_freq * 0x0d.1861a20 / 3 = 125 MHz: 375 MHz before post-divide */
+       /* xtal_freq * 0x0c.92493f8 / 3 = 120 MHz: 360 MHz before post-divide */
+       cx18_write_reg(cx, lowpwr ? 0xD : 0xC, CX18_SLOW_CLOCK_PLL_INT);
+       cx18_write_reg(cx, lowpwr ? 0x30C344 : 0x124927F,
                                                CX18_SLOW_CLOCK_PLL_FRAC);
-       cx18_write_reg(cx, 4, CX18_SLOW_CLOCK_PLL_POST);
+       cx18_write_reg(cx, 3, CX18_SLOW_CLOCK_PLL_POST);
 
        /* mpeg clock pll 54MHz */
+       /* xtal_freq * 0xf.15f17f0 / 8 = 54 MHz: 432 MHz before post-divide */
        cx18_write_reg(cx, 0xF, CX18_MPEG_CLOCK_PLL_INT);
-       cx18_write_reg(cx, 0x2BCFEF, CX18_MPEG_CLOCK_PLL_FRAC);
+       cx18_write_reg(cx, 0x2BE2FE, CX18_MPEG_CLOCK_PLL_FRAC);
        cx18_write_reg(cx, 8, CX18_MPEG_CLOCK_PLL_POST);
 
        /* Defaults */
@@ -248,22 +300,34 @@ void cx18_init_power(struct cx18 *cx, int lowpwr)
        /* VFC = disabled */
        /* USB = disabled */
 
-       cx18_write_reg(cx, lowpwr ? 0xFFFF0020 : 0x00060004,
-                                                       CX18_CLOCK_SELECT1);
-       cx18_write_reg(cx, lowpwr ? 0xFFFF0004 : 0x00060006,
-                                                       CX18_CLOCK_SELECT2);
-
-       cx18_write_reg(cx, 0xFFFF0002, CX18_HALF_CLOCK_SELECT1);
-       cx18_write_reg(cx, 0xFFFF0104, CX18_HALF_CLOCK_SELECT2);
+       if (lowpwr) {
+               cx18_write_reg_expect(cx, 0xFFFF0020, CX18_CLOCK_SELECT1,
+                                         0x00000020, 0xFFFFFFFF);
+               cx18_write_reg_expect(cx, 0xFFFF0004, CX18_CLOCK_SELECT2,
+                                         0x00000004, 0xFFFFFFFF);
+       } else {
+               /* This doesn't explicitly set every clock select */
+               cx18_write_reg_expect(cx, 0x00060004, CX18_CLOCK_SELECT1,
+                                         0x00000004, 0x00060006);
+               cx18_write_reg_expect(cx, 0x00060006, CX18_CLOCK_SELECT2,
+                                         0x00000006, 0x00060006);
+       }
 
-       cx18_write_reg(cx, 0xFFFF9026, CX18_CLOCK_ENABLE1);
-       cx18_write_reg(cx, 0xFFFF3105, CX18_CLOCK_ENABLE2);
+       cx18_write_reg_expect(cx, 0xFFFF0002, CX18_HALF_CLOCK_SELECT1,
+                                 0x00000002, 0xFFFFFFFF);
+       cx18_write_reg_expect(cx, 0xFFFF0104, CX18_HALF_CLOCK_SELECT2,
+                                 0x00000104, 0xFFFFFFFF);
+       cx18_write_reg_expect(cx, 0xFFFF9026, CX18_CLOCK_ENABLE1,
+                                 0x00009026, 0xFFFFFFFF);
+       cx18_write_reg_expect(cx, 0xFFFF3105, CX18_CLOCK_ENABLE2,
+                                 0x00003105, 0xFFFFFFFF);
 }
 
 void cx18_init_memory(struct cx18 *cx)
 {
        cx18_msleep_timeout(10, 0);
-       cx18_write_reg(cx, 0x10000, CX18_DDR_SOFT_RESET);
+       cx18_write_reg_expect(cx, 0x00010000, CX18_DDR_SOFT_RESET,
+                                 0x00000000, 0x00010001);
        cx18_msleep_timeout(10, 0);
 
        cx18_write_reg(cx, cx->card->ddr.chip_config, CX18_DDR_CHIP_CONFIG);
@@ -282,13 +346,15 @@ void cx18_init_memory(struct cx18 *cx)
 
        cx18_msleep_timeout(10, 0);
 
-       cx18_write_reg(cx, 0x20000, CX18_DDR_SOFT_RESET);
+       cx18_write_reg_expect(cx, 0x00020000, CX18_DDR_SOFT_RESET,
+                                 0x00000000, 0x00020002);
        cx18_msleep_timeout(10, 0);
 
        /* use power-down mode when idle */
        cx18_write_reg(cx, 0x00000010, CX18_DDR_POWER_REG);
 
-       cx18_write_reg(cx, 0x10001, CX18_REG_BUS_TIMEOUT_EN);
+       cx18_write_reg_expect(cx, 0x00010001, CX18_REG_BUS_TIMEOUT_EN,
+                                 0x00000001, 0x00010001);
 
        cx18_write_reg(cx, 0x48, CX18_DDR_MB_PER_ROW_7);
        cx18_write_reg(cx, 0xE0000, CX18_DDR_BASE_63_ADDR);
@@ -307,51 +373,76 @@ void cx18_init_memory(struct cx18 *cx)
 
 int cx18_firmware_init(struct cx18 *cx)
 {
+       u32 fw_entry_addr;
+       int sz, retries;
+       u32 api_args[MAX_MB_ARGUMENTS];
+
        /* Allow chip to control CLKRUN */
        cx18_write_reg(cx, 0x5, CX18_DSP0_INTERRUPT_MASK);
 
-       cx18_write_reg(cx, 0x000F000F, CX18_PROC_SOFT_RESET); /* stop the fw */
+       /* Stop the firmware */
+       cx18_write_reg_expect(cx, 0x000F000F, CX18_PROC_SOFT_RESET,
+                                 0x0000000F, 0x000F000F);
 
        cx18_msleep_timeout(1, 0);
 
+       /* If the CPU is still running */
+       if ((cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 8) == 0) {
+               CX18_ERR("%s: couldn't stop CPU to load firmware\n", __func__);
+               return -EIO;
+       }
+
        cx18_sw1_irq_enable(cx, IRQ_CPU_TO_EPU | IRQ_APU_TO_EPU);
        cx18_sw2_irq_enable(cx, IRQ_CPU_TO_EPU_ACK | IRQ_APU_TO_EPU_ACK);
 
-       /* Only if the processor is not running */
-       if (cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 8) {
-               int sz = load_apu_fw_direct("v4l-cx23418-apu.fw",
-                              cx->enc_mem, cx);
-
-               cx18_write_enc(cx, 0xE51FF004, 0);
-               cx18_write_enc(cx, 0xa00000, 4);  /* todo: not hardcoded */
-               /* Start APU */
-               cx18_write_reg(cx, 0x00010000, CX18_PROC_SOFT_RESET);
-               cx18_msleep_timeout(500, 0);
-
-               sz = sz <= 0 ? sz : load_cpu_fw_direct("v4l-cx23418-cpu.fw",
-                                       cx->enc_mem, cx);
-
-               if (sz > 0) {
-                       int retries = 0;
-
-                       /* start the CPU */
-                       cx18_write_reg(cx, 0x00080000, CX18_PROC_SOFT_RESET);
-                       while (retries++ < 50) { /* Loop for max 500mS */
-                               if ((cx18_read_reg(cx, CX18_PROC_SOFT_RESET)
-                                    & 1) == 0)
-                                       break;
-                               cx18_msleep_timeout(10, 0);
-                       }
-                       cx18_msleep_timeout(200, 0);
-                       if (retries == 51) {
-                               CX18_ERR("Could not start the CPU\n");
-                               return -EIO;
-                       }
-               }
-               if (sz <= 0)
-                       return -EIO;
+       sz = load_cpu_fw_direct("v4l-cx23418-cpu.fw", cx->enc_mem, cx);
+       if (sz <= 0)
+               return sz;
+
+       /* The SCB & IPC area *must* be correct before starting the firmwares */
+       cx18_init_scb(cx);
+
+       fw_entry_addr = 0;
+       sz = load_apu_fw_direct("v4l-cx23418-apu.fw", cx->enc_mem, cx,
+                               &fw_entry_addr);
+       if (sz <= 0)
+               return sz;
+
+       /* Start the CPU. The CPU will take care of the APU for us. */
+       cx18_write_reg_expect(cx, 0x00080000, CX18_PROC_SOFT_RESET,
+                                 0x00000000, 0x00080008);
+
+       /* Wait up to 500 ms for the APU to come out of reset */
+       for (retries = 0;
+            retries < 50 && (cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 1) == 1;
+            retries++)
+               cx18_msleep_timeout(10, 0);
+
+       cx18_msleep_timeout(200, 0);
+
+       if (retries == 50 &&
+           (cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 1) == 1) {
+               CX18_ERR("Could not start the CPU\n");
+               return -EIO;
        }
+
+       /*
+        * The CPU had once before set up to receive an interrupt for it's
+        * outgoing IRQ_CPU_TO_EPU_ACK to us.  If it ever does this, we get an
+        * interrupt when it sends us an ack, but by the time we process it,
+        * that flag in the SW2 status register has been cleared by the CPU
+        * firmware.  We'll prevent that not so useful condition from happening
+        * by clearing the CPU's interrupt enables for Ack IRQ's we want to
+        * process.
+        */
+       cx18_sw2_irq_disable_cpu(cx, IRQ_CPU_TO_EPU_ACK | IRQ_APU_TO_EPU_ACK);
+
+       /* Try a benign command to see if the CPU is alive and well */
+       sz = cx18_vapi_result(cx, api_args, CX18_CPU_DEBUG_PEEK32, 1, 0);
+       if (sz < 0)
+               return sz;
+
        /* initialize GPIO */
-       cx18_write_reg(cx, 0x14001400, 0xC78110);
+       cx18_write_reg_expect(cx, 0x14001400, 0xc78110, 0x00001400, 0x14001400);
        return 0;
 }