1 /*
2 * cx18 firmware functions
3 *
4 * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
5 * Copyright (C) 2008 Andy Walls <awalls@md.metrocast.net>
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
20 * 02111-1307 USA
21 */
22
23 #include "cx18-driver.h"
24 #include "cx18-io.h"
25 #include "cx18-scb.h"
26 #include "cx18-irq.h"
27 #include "cx18-firmware.h"
28 #include "cx18-cards.h"
29 #include <linux/firmware.h>
30
31 #define CX18_PROC_SOFT_RESET 0xc70010
32 #define CX18_DDR_SOFT_RESET 0xc70014
33 #define CX18_CLOCK_SELECT1 0xc71000
34 #define CX18_CLOCK_SELECT2 0xc71004
35 #define CX18_HALF_CLOCK_SELECT1 0xc71008
36 #define CX18_HALF_CLOCK_SELECT2 0xc7100C
37 #define CX18_CLOCK_POLARITY1 0xc71010
38 #define CX18_CLOCK_POLARITY2 0xc71014
39 #define CX18_ADD_DELAY_ENABLE1 0xc71018
40 #define CX18_ADD_DELAY_ENABLE2 0xc7101C
41 #define CX18_CLOCK_ENABLE1 0xc71020
42 #define CX18_CLOCK_ENABLE2 0xc71024
43
44 #define CX18_REG_BUS_TIMEOUT_EN 0xc72024
45
46 #define CX18_FAST_CLOCK_PLL_INT 0xc78000
47 #define CX18_FAST_CLOCK_PLL_FRAC 0xc78004
48 #define CX18_FAST_CLOCK_PLL_POST 0xc78008
49 #define CX18_FAST_CLOCK_PLL_PRESCALE 0xc7800C
50 #define CX18_FAST_CLOCK_PLL_ADJUST_BANDWIDTH 0xc78010
51
52 #define CX18_SLOW_CLOCK_PLL_INT 0xc78014
53 #define CX18_SLOW_CLOCK_PLL_FRAC 0xc78018
54 #define CX18_SLOW_CLOCK_PLL_POST 0xc7801C
55 #define CX18_MPEG_CLOCK_PLL_INT 0xc78040
56 #define CX18_MPEG_CLOCK_PLL_FRAC 0xc78044
57 #define CX18_MPEG_CLOCK_PLL_POST 0xc78048
58 #define CX18_PLL_POWER_DOWN 0xc78088
59 #define CX18_SW1_INT_STATUS 0xc73104
60 #define CX18_SW1_INT_ENABLE_PCI 0xc7311C
61 #define CX18_SW2_INT_SET 0xc73140
62 #define CX18_SW2_INT_STATUS 0xc73144
63 #define CX18_ADEC_CONTROL 0xc78120
64
65 #define CX18_DDR_REQUEST_ENABLE 0xc80000
66 #define CX18_DDR_CHIP_CONFIG 0xc80004
67 #define CX18_DDR_REFRESH 0xc80008
68 #define CX18_DDR_TIMING1 0xc8000C
69 #define CX18_DDR_TIMING2 0xc80010
70 #define CX18_DDR_POWER_REG 0xc8001C
71
72 #define CX18_DDR_TUNE_LANE 0xc80048
73 #define CX18_DDR_INITIAL_EMRS 0xc80054
74 #define CX18_DDR_MB_PER_ROW_7 0xc8009C
75 #define CX18_DDR_BASE_63_ADDR 0xc804FC
76
77 #define CX18_WMB_CLIENT02 0xc90108
78 #define CX18_WMB_CLIENT05 0xc90114
79 #define CX18_WMB_CLIENT06 0xc90118
80 #define CX18_WMB_CLIENT07 0xc9011C
81 #define CX18_WMB_CLIENT08 0xc90120
82 #define CX18_WMB_CLIENT09 0xc90124
83 #define CX18_WMB_CLIENT10 0xc90128
84 #define CX18_WMB_CLIENT11 0xc9012C
85 #define CX18_WMB_CLIENT12 0xc90130
86 #define CX18_WMB_CLIENT13 0xc90134
87 #define CX18_WMB_CLIENT14 0xc90138
88
89 #define CX18_DSP0_INTERRUPT_MASK 0xd0004C
90
91 #define APU_ROM_SYNC1 0x6D676553 /* "mgeS" */
92 #define APU_ROM_SYNC2 0x72646548 /* "rdeH" */
93
94 struct cx18_apu_rom_seghdr {
95 u32 sync1;
96 u32 sync2;
97 u32 addr;
98 u32 size;
99 };
100
load_cpu_fw_direct(const char * fn,u8 __iomem * mem,struct cx18 * cx)101 static int load_cpu_fw_direct(const char *fn, u8 __iomem *mem, struct cx18 *cx)
102 {
103 const struct firmware *fw = NULL;
104 int i, j;
105 unsigned size;
106 u32 __iomem *dst = (u32 __iomem *)mem;
107 const u32 *src;
108
109 if (request_firmware(&fw, fn, &cx->pci_dev->dev)) {
110 CX18_ERR("Unable to open firmware %s\n", fn);
111 CX18_ERR("Did you put the firmware in the hotplug firmware directory?\n");
112 return -ENOMEM;
113 }
114
115 src = (const u32 *)fw->data;
116
117 for (i = 0; i < fw->size; i += 4096) {
118 cx18_setup_page(cx, i);
119 for (j = i; j < fw->size && j < i + 4096; j += 4) {
120 /* no need for endianness conversion on the ppc */
121 cx18_raw_writel(cx, *src, dst);
122 if (cx18_raw_readl(cx, dst) != *src) {
123 CX18_ERR("Mismatch at offset %x\n", i);
124 release_firmware(fw);
125 cx18_setup_page(cx, 0);
126 return -EIO;
127 }
128 dst++;
129 src++;
130 }
131 }
132 if (!test_bit(CX18_F_I_LOADED_FW, &cx->i_flags))
133 CX18_INFO("loaded %s firmware (%zd bytes)\n", fn, fw->size);
134 size = fw->size;
135 release_firmware(fw);
136 cx18_setup_page(cx, SCB_OFFSET);
137 return size;
138 }
139
load_apu_fw_direct(const char * fn,u8 __iomem * dst,struct cx18 * cx,u32 * entry_addr)140 static int load_apu_fw_direct(const char *fn, u8 __iomem *dst, struct cx18 *cx,
141 u32 *entry_addr)
142 {
143 const struct firmware *fw = NULL;
144 int i, j;
145 unsigned size;
146 const u32 *src;
147 struct cx18_apu_rom_seghdr seghdr;
148 const u8 *vers;
149 u32 offset = 0;
150 u32 apu_version = 0;
151 int sz;
152
153 if (request_firmware(&fw, fn, &cx->pci_dev->dev)) {
154 CX18_ERR("unable to open firmware %s\n", fn);
155 CX18_ERR("did you put the firmware in the hotplug firmware directory?\n");
156 cx18_setup_page(cx, 0);
157 return -ENOMEM;
158 }
159
160 *entry_addr = 0;
161 src = (const u32 *)fw->data;
162 vers = fw->data + sizeof(seghdr);
163 sz = fw->size;
164
165 apu_version = (vers[0] << 24) | (vers[4] << 16) | vers[32];
166 while (offset + sizeof(seghdr) < fw->size) {
167 /* TODO: byteswapping */
168 memcpy(&seghdr, src + offset / 4, sizeof(seghdr));
169 offset += sizeof(seghdr);
170 if (seghdr.sync1 != APU_ROM_SYNC1 ||
171 seghdr.sync2 != APU_ROM_SYNC2) {
172 offset += seghdr.size;
173 continue;
174 }
175 CX18_DEBUG_INFO("load segment %x-%x\n", seghdr.addr,
176 seghdr.addr + seghdr.size - 1);
177 if (*entry_addr == 0)
178 *entry_addr = seghdr.addr;
179 if (offset + seghdr.size > sz)
180 break;
181 for (i = 0; i < seghdr.size; i += 4096) {
182 cx18_setup_page(cx, seghdr.addr + i);
183 for (j = i; j < seghdr.size && j < i + 4096; j += 4) {
184 /* no need for endianness conversion on the ppc */
185 cx18_raw_writel(cx, src[(offset + j) / 4],
186 dst + seghdr.addr + j);
187 if (cx18_raw_readl(cx, dst + seghdr.addr + j)
188 != src[(offset + j) / 4]) {
189 CX18_ERR("Mismatch at offset %x\n",
190 offset + j);
191 release_firmware(fw);
192 cx18_setup_page(cx, 0);
193 return -EIO;
194 }
195 }
196 }
197 offset += seghdr.size;
198 }
199 if (!test_bit(CX18_F_I_LOADED_FW, &cx->i_flags))
200 CX18_INFO("loaded %s firmware V%08x (%zd bytes)\n",
201 fn, apu_version, fw->size);
202 size = fw->size;
203 release_firmware(fw);
204 cx18_setup_page(cx, 0);
205 return size;
206 }
207
cx18_halt_firmware(struct cx18 * cx)208 void cx18_halt_firmware(struct cx18 *cx)
209 {
210 CX18_DEBUG_INFO("Preparing for firmware halt.\n");
211 cx18_write_reg_expect(cx, 0x000F000F, CX18_PROC_SOFT_RESET,
212 0x0000000F, 0x000F000F);
213 cx18_write_reg_expect(cx, 0x00020002, CX18_ADEC_CONTROL,
214 0x00000002, 0x00020002);
215 }
216
cx18_init_power(struct cx18 * cx,int lowpwr)217 void cx18_init_power(struct cx18 *cx, int lowpwr)
218 {
219 /* power-down Spare and AOM PLLs */
220 /* power-up fast, slow and mpeg PLLs */
221 cx18_write_reg(cx, 0x00000008, CX18_PLL_POWER_DOWN);
222
223 /* ADEC out of sleep */
224 cx18_write_reg_expect(cx, 0x00020000, CX18_ADEC_CONTROL,
225 0x00000000, 0x00020002);
226
227 /*
228 * The PLL parameters are based on the external crystal frequency that
229 * would ideally be:
230 *
231 * NTSC Color subcarrier freq * 8 =
232 * 4.5 MHz/286 * 455/2 * 8 = 28.63636363... MHz
233 *
234 * The accidents of history and rationale that explain from where this
235 * combination of magic numbers originate can be found in:
236 *
237 * [1] Abrahams, I. C., "Choice of Chrominance Subcarrier Frequency in
238 * the NTSC Standards", Proceedings of the I-R-E, January 1954, pp 79-80
239 *
240 * [2] Abrahams, I. C., "The 'Frequency Interleaving' Principle in the
241 * NTSC Standards", Proceedings of the I-R-E, January 1954, pp 81-83
242 *
243 * As Mike Bradley has rightly pointed out, it's not the exact crystal
244 * frequency that matters, only that all parts of the driver and
245 * firmware are using the same value (close to the ideal value).
246 *
247 * Since I have a strong suspicion that, if the firmware ever assumes a
248 * crystal value at all, it will assume 28.636360 MHz, the crystal
249 * freq used in calculations in this driver will be:
250 *
251 * xtal_freq = 28.636360 MHz
252 *
253 * an error of less than 0.13 ppm which is way, way better than any off
254 * the shelf crystal will have for accuracy anyway.
255 *
256 * Below I aim to run the PLLs' VCOs near 400 MHz to minimze errors.
257 *
258 * Many thanks to Jeff Campbell and Mike Bradley for their extensive
259 * investigation, experimentation, testing, and suggested solutions of
260 * of audio/video sync problems with SVideo and CVBS captures.
261 */
262
263 /* the fast clock is at 200/245 MHz */
264 /* 1 * xtal_freq * 0x0d.f7df9b8 / 2 = 200 MHz: 400 MHz pre post-divide*/
265 /* 1 * xtal_freq * 0x11.1c71eb8 / 2 = 245 MHz: 490 MHz pre post-divide*/
266 cx18_write_reg(cx, lowpwr ? 0xD : 0x11, CX18_FAST_CLOCK_PLL_INT);
267 cx18_write_reg(cx, lowpwr ? 0x1EFBF37 : 0x038E3D7,
268 CX18_FAST_CLOCK_PLL_FRAC);
269
270 cx18_write_reg(cx, 2, CX18_FAST_CLOCK_PLL_POST);
271 cx18_write_reg(cx, 1, CX18_FAST_CLOCK_PLL_PRESCALE);
272 cx18_write_reg(cx, 4, CX18_FAST_CLOCK_PLL_ADJUST_BANDWIDTH);
273
274 /* set slow clock to 125/120 MHz */
275 /* xtal_freq * 0x0d.1861a20 / 3 = 125 MHz: 375 MHz before post-divide */
276 /* xtal_freq * 0x0c.92493f8 / 3 = 120 MHz: 360 MHz before post-divide */
277 cx18_write_reg(cx, lowpwr ? 0xD : 0xC, CX18_SLOW_CLOCK_PLL_INT);
278 cx18_write_reg(cx, lowpwr ? 0x30C344 : 0x124927F,
279 CX18_SLOW_CLOCK_PLL_FRAC);
280 cx18_write_reg(cx, 3, CX18_SLOW_CLOCK_PLL_POST);
281
282 /* mpeg clock pll 54MHz */
283 /* xtal_freq * 0xf.15f17f0 / 8 = 54 MHz: 432 MHz before post-divide */
284 cx18_write_reg(cx, 0xF, CX18_MPEG_CLOCK_PLL_INT);
285 cx18_write_reg(cx, 0x2BE2FE, CX18_MPEG_CLOCK_PLL_FRAC);
286 cx18_write_reg(cx, 8, CX18_MPEG_CLOCK_PLL_POST);
287
288 /* Defaults */
289 /* APU = SC or SC/2 = 125/62.5 */
290 /* EPU = SC = 125 */
291 /* DDR = FC = 180 */
292 /* ENC = SC = 125 */
293 /* AI1 = SC = 125 */
294 /* VIM2 = disabled */
295 /* PCI = FC/2 = 90 */
296 /* AI2 = disabled */
297 /* DEMUX = disabled */
298 /* AO = SC/2 = 62.5 */
299 /* SER = 54MHz */
300 /* VFC = disabled */
301 /* USB = disabled */
302
303 if (lowpwr) {
304 cx18_write_reg_expect(cx, 0xFFFF0020, CX18_CLOCK_SELECT1,
305 0x00000020, 0xFFFFFFFF);
306 cx18_write_reg_expect(cx, 0xFFFF0004, CX18_CLOCK_SELECT2,
307 0x00000004, 0xFFFFFFFF);
308 } else {
309 /* This doesn't explicitly set every clock select */
310 cx18_write_reg_expect(cx, 0x00060004, CX18_CLOCK_SELECT1,
311 0x00000004, 0x00060006);
312 cx18_write_reg_expect(cx, 0x00060006, CX18_CLOCK_SELECT2,
313 0x00000006, 0x00060006);
314 }
315
316 cx18_write_reg_expect(cx, 0xFFFF0002, CX18_HALF_CLOCK_SELECT1,
317 0x00000002, 0xFFFFFFFF);
318 cx18_write_reg_expect(cx, 0xFFFF0104, CX18_HALF_CLOCK_SELECT2,
319 0x00000104, 0xFFFFFFFF);
320 cx18_write_reg_expect(cx, 0xFFFF9026, CX18_CLOCK_ENABLE1,
321 0x00009026, 0xFFFFFFFF);
322 cx18_write_reg_expect(cx, 0xFFFF3105, CX18_CLOCK_ENABLE2,
323 0x00003105, 0xFFFFFFFF);
324 }
325
cx18_init_memory(struct cx18 * cx)326 void cx18_init_memory(struct cx18 *cx)
327 {
328 cx18_msleep_timeout(10, 0);
329 cx18_write_reg_expect(cx, 0x00010000, CX18_DDR_SOFT_RESET,
330 0x00000000, 0x00010001);
331 cx18_msleep_timeout(10, 0);
332
333 cx18_write_reg(cx, cx->card->ddr.chip_config, CX18_DDR_CHIP_CONFIG);
334
335 cx18_msleep_timeout(10, 0);
336
337 cx18_write_reg(cx, cx->card->ddr.refresh, CX18_DDR_REFRESH);
338 cx18_write_reg(cx, cx->card->ddr.timing1, CX18_DDR_TIMING1);
339 cx18_write_reg(cx, cx->card->ddr.timing2, CX18_DDR_TIMING2);
340
341 cx18_msleep_timeout(10, 0);
342
343 /* Initialize DQS pad time */
344 cx18_write_reg(cx, cx->card->ddr.tune_lane, CX18_DDR_TUNE_LANE);
345 cx18_write_reg(cx, cx->card->ddr.initial_emrs, CX18_DDR_INITIAL_EMRS);
346
347 cx18_msleep_timeout(10, 0);
348
349 cx18_write_reg_expect(cx, 0x00020000, CX18_DDR_SOFT_RESET,
350 0x00000000, 0x00020002);
351 cx18_msleep_timeout(10, 0);
352
353 /* use power-down mode when idle */
354 cx18_write_reg(cx, 0x00000010, CX18_DDR_POWER_REG);
355
356 cx18_write_reg_expect(cx, 0x00010001, CX18_REG_BUS_TIMEOUT_EN,
357 0x00000001, 0x00010001);
358
359 cx18_write_reg(cx, 0x48, CX18_DDR_MB_PER_ROW_7);
360 cx18_write_reg(cx, 0xE0000, CX18_DDR_BASE_63_ADDR);
361
362 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT02); /* AO */
363 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT09); /* AI2 */
364 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT05); /* VIM1 */
365 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT06); /* AI1 */
366 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT07); /* 3D comb */
367 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT10); /* ME */
368 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT12); /* ENC */
369 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT13); /* PK */
370 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT11); /* RC */
371 cx18_write_reg(cx, 0x00000101, CX18_WMB_CLIENT14); /* AVO */
372 }
373
cx18_firmware_init(struct cx18 * cx)374 int cx18_firmware_init(struct cx18 *cx)
375 {
376 u32 fw_entry_addr;
377 int sz, retries;
378 u32 api_args[MAX_MB_ARGUMENTS];
379
380 /* Allow chip to control CLKRUN */
381 cx18_write_reg(cx, 0x5, CX18_DSP0_INTERRUPT_MASK);
382
383 /* Stop the firmware */
384 cx18_write_reg_expect(cx, 0x000F000F, CX18_PROC_SOFT_RESET,
385 0x0000000F, 0x000F000F);
386
387 cx18_msleep_timeout(1, 0);
388
389 /* If the CPU is still running */
390 if ((cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 8) == 0) {
391 CX18_ERR("%s: couldn't stop CPU to load firmware\n", __func__);
392 return -EIO;
393 }
394
395 cx18_sw1_irq_enable(cx, IRQ_CPU_TO_EPU | IRQ_APU_TO_EPU);
396 cx18_sw2_irq_enable(cx, IRQ_CPU_TO_EPU_ACK | IRQ_APU_TO_EPU_ACK);
397
398 sz = load_cpu_fw_direct("v4l-cx23418-cpu.fw", cx->enc_mem, cx);
399 if (sz <= 0)
400 return sz;
401
402 /* The SCB & IPC area *must* be correct before starting the firmwares */
403 cx18_init_scb(cx);
404
405 fw_entry_addr = 0;
406 sz = load_apu_fw_direct("v4l-cx23418-apu.fw", cx->enc_mem, cx,
407 &fw_entry_addr);
408 if (sz <= 0)
409 return sz;
410
411 /* Start the CPU. The CPU will take care of the APU for us. */
412 cx18_write_reg_expect(cx, 0x00080000, CX18_PROC_SOFT_RESET,
413 0x00000000, 0x00080008);
414
415 /* Wait up to 500 ms for the APU to come out of reset */
416 for (retries = 0;
417 retries < 50 && (cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 1) == 1;
418 retries++)
419 cx18_msleep_timeout(10, 0);
420
421 cx18_msleep_timeout(200, 0);
422
423 if (retries == 50 &&
424 (cx18_read_reg(cx, CX18_PROC_SOFT_RESET) & 1) == 1) {
425 CX18_ERR("Could not start the CPU\n");
426 return -EIO;
427 }
428
429 /*
430 * The CPU had once before set up to receive an interrupt for it's
431 * outgoing IRQ_CPU_TO_EPU_ACK to us. If it ever does this, we get an
432 * interrupt when it sends us an ack, but by the time we process it,
433 * that flag in the SW2 status register has been cleared by the CPU
434 * firmware. We'll prevent that not so useful condition from happening
435 * by clearing the CPU's interrupt enables for Ack IRQ's we want to
436 * process.
437 */
438 cx18_sw2_irq_disable_cpu(cx, IRQ_CPU_TO_EPU_ACK | IRQ_APU_TO_EPU_ACK);
439
440 /* Try a benign command to see if the CPU is alive and well */
441 sz = cx18_vapi_result(cx, api_args, CX18_CPU_DEBUG_PEEK32, 1, 0);
442 if (sz < 0)
443 return sz;
444
445 /* initialize GPIO */
446 cx18_write_reg_expect(cx, 0x14001400, 0xc78110, 0x00001400, 0x14001400);
447 return 0;
448 }
449