2 saa7146.o - driver for generic saa7146-based hardware
4 Copyright (C) 1998-2003 Michael Hunold <michael@mihu.de>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
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.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <media/saa7146.h>
25 LIST_HEAD(saa7146_devices);
26 DEFINE_MUTEX(saa7146_devices_lock);
28 static int saa7146_num;
30 unsigned int saa7146_debug;
32 module_param(saa7146_debug, uint, 0644);
33 MODULE_PARM_DESC(saa7146_debug, "debug level (default: 0)");
36 static void dump_registers(struct saa7146_dev* dev)
40 pr_info(" @ %li jiffies:\n", jiffies);
41 for (i = 0; i <= 0x148; i += 4)
42 pr_info("0x%03x: 0x%08x\n", i, saa7146_read(dev, i));
46 /****************************************************************************
47 * gpio and debi helper functions
48 ****************************************************************************/
50 void saa7146_setgpio(struct saa7146_dev *dev, int port, u32 data)
56 value = saa7146_read(dev, GPIO_CTRL);
57 value &= ~(0xff << (8*port));
58 value |= (data << (8*port));
59 saa7146_write(dev, GPIO_CTRL, value);
62 /* This DEBI code is based on the saa7146 Stradis driver by Nathan Laredo */
63 static inline int saa7146_wait_for_debi_done_sleep(struct saa7146_dev *dev,
64 unsigned long us1, unsigned long us2)
66 unsigned long timeout;
69 /* wait for registers to be programmed */
70 timeout = jiffies + usecs_to_jiffies(us1);
72 err = time_after(jiffies, timeout);
73 if (saa7146_read(dev, MC2) & 2)
76 pr_err("%s: %s timed out while waiting for registers getting programmed\n",
83 /* wait for transfer to complete */
84 timeout = jiffies + usecs_to_jiffies(us2);
86 err = time_after(jiffies, timeout);
87 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
89 saa7146_read(dev, MC2);
91 DEB_S("%s: %s timed out while waiting for transfer completion\n",
101 static inline int saa7146_wait_for_debi_done_busyloop(struct saa7146_dev *dev,
102 unsigned long us1, unsigned long us2)
106 /* wait for registers to be programmed */
109 if (saa7146_read(dev, MC2) & 2)
112 pr_err("%s: %s timed out while waiting for registers getting programmed\n",
113 dev->name, __func__);
119 /* wait for transfer to complete */
122 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
124 saa7146_read(dev, MC2);
126 DEB_S("%s: %s timed out while waiting for transfer completion\n",
127 dev->name, __func__);
136 int saa7146_wait_for_debi_done(struct saa7146_dev *dev, int nobusyloop)
139 return saa7146_wait_for_debi_done_sleep(dev, 50000, 250000);
141 return saa7146_wait_for_debi_done_busyloop(dev, 50000, 250000);
144 /****************************************************************************
145 * general helper functions
146 ****************************************************************************/
148 /* this is videobuf_vmalloc_to_sg() from videobuf-dma-sg.c
149 make sure virt has been allocated with vmalloc_32(), otherwise the BUG()
150 may be triggered on highmem machines */
151 static struct scatterlist* vmalloc_to_sg(unsigned char *virt, int nr_pages)
153 struct scatterlist *sglist;
157 sglist = kcalloc(nr_pages, sizeof(struct scatterlist), GFP_KERNEL);
160 sg_init_table(sglist, nr_pages);
161 for (i = 0; i < nr_pages; i++, virt += PAGE_SIZE) {
162 pg = vmalloc_to_page(virt);
165 BUG_ON(PageHighMem(pg));
166 sg_set_page(&sglist[i], pg, PAGE_SIZE, 0);
175 /********************************************************************************/
176 /* common page table functions */
178 void *saa7146_vmalloc_build_pgtable(struct pci_dev *pci, long length, struct saa7146_pgtable *pt)
180 int pages = (length+PAGE_SIZE-1)/PAGE_SIZE;
181 void *mem = vmalloc_32(length);
187 if (!(pt->slist = vmalloc_to_sg(mem, pages)))
190 if (saa7146_pgtable_alloc(pci, pt))
194 slen = pci_map_sg(pci,pt->slist,pt->nents,PCI_DMA_FROMDEVICE);
196 goto err_free_pgtable;
198 if (0 != saa7146_pgtable_build_single(pci, pt, pt->slist, slen))
204 pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
206 saa7146_pgtable_free(pci, pt);
216 void saa7146_vfree_destroy_pgtable(struct pci_dev *pci, void *mem, struct saa7146_pgtable *pt)
218 pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
219 saa7146_pgtable_free(pci, pt);
225 void saa7146_pgtable_free(struct pci_dev *pci, struct saa7146_pgtable *pt)
229 pci_free_consistent(pci, pt->size, pt->cpu, pt->dma);
233 int saa7146_pgtable_alloc(struct pci_dev *pci, struct saa7146_pgtable *pt)
236 dma_addr_t dma_addr = 0;
238 cpu = pci_alloc_consistent(pci, PAGE_SIZE, &dma_addr);
242 pt->size = PAGE_SIZE;
249 int saa7146_pgtable_build_single(struct pci_dev *pci, struct saa7146_pgtable *pt,
250 struct scatterlist *list, int sglen )
257 BUG_ON(list->offset > PAGE_SIZE);
259 /* if we have a user buffer, the first page may not be
260 aligned to a page boundary. */
261 pt->offset = list->offset;
264 for (i = 0; i < sglen; i++, list++) {
266 pr_debug("i:%d, adr:0x%08x, len:%d, offset:%d\n",
267 i, sg_dma_address(list), sg_dma_len(list),
270 for (p = 0; p * 4096 < list->length; p++, ptr++) {
271 *ptr = cpu_to_le32(sg_dma_address(list) + p * 4096);
277 /* safety; fill the page table up with the last valid page */
279 for(i=nr_pages;i<1024;i++) {
285 pr_debug("offset: %d\n", pt->offset);
287 pr_debug("ptr1 %d: 0x%08x\n", i, ptr[i]);
293 /********************************************************************************/
294 /* interrupt handler */
295 static irqreturn_t interrupt_hw(int irq, void *dev_id)
297 struct saa7146_dev *dev = dev_id;
301 /* read out the interrupt status register */
302 ack_isr = isr = saa7146_read(dev, ISR);
304 /* is this our interrupt? */
306 /* nope, some other device */
311 if (dev->ext->irq_mask & isr) {
312 if (dev->ext->irq_func)
313 dev->ext->irq_func(dev, &isr);
314 isr &= ~dev->ext->irq_mask;
317 if (0 != (isr & (MASK_27))) {
318 DEB_INT("irq: RPS0 (0x%08x)\n", isr);
319 if (dev->vv_data && dev->vv_callback)
320 dev->vv_callback(dev,isr);
323 if (0 != (isr & (MASK_28))) {
324 if (dev->vv_data && dev->vv_callback)
325 dev->vv_callback(dev,isr);
328 if (0 != (isr & (MASK_16|MASK_17))) {
329 SAA7146_IER_DISABLE(dev, MASK_16|MASK_17);
330 /* only wake up if we expect something */
331 if (0 != dev->i2c_op) {
333 wake_up(&dev->i2c_wq);
335 u32 psr = saa7146_read(dev, PSR);
336 u32 ssr = saa7146_read(dev, SSR);
337 pr_warn("%s: unexpected i2c irq: isr %08x psr %08x ssr %08x\n",
338 dev->name, isr, psr, ssr);
340 isr &= ~(MASK_16|MASK_17);
343 ERR("warning: interrupt enabled, but not handled properly.(0x%08x)\n",
345 ERR("disabling interrupt source(s)!\n");
346 SAA7146_IER_DISABLE(dev,isr);
348 saa7146_write(dev, ISR, ack_isr);
352 /*********************************************************************************/
353 /* configuration-functions */
355 static int saa7146_init_one(struct pci_dev *pci, const struct pci_device_id *ent)
357 struct saa7146_pci_extension_data *pci_ext = (struct saa7146_pci_extension_data *)ent->driver_data;
358 struct saa7146_extension *ext = pci_ext->ext;
359 struct saa7146_dev *dev;
362 /* clear out mem for sure */
363 dev = kzalloc(sizeof(struct saa7146_dev), GFP_KERNEL);
365 ERR("out of memory\n");
369 DEB_EE("pci:%p\n", pci);
371 err = pci_enable_device(pci);
373 ERR("pci_enable_device() failed\n");
377 /* enable bus-mastering */
382 /* get chip-revision; this is needed to enable bug-fixes */
383 dev->revision = pci->revision;
385 /* remap the memory from virtual to physical address */
387 err = pci_request_region(pci, 0, "saa7146");
391 dev->mem = ioremap(pci_resource_start(pci, 0),
392 pci_resource_len(pci, 0));
394 ERR("ioremap() failed\n");
399 /* we don't do a master reset here anymore, it screws up
400 some boards that don't have an i2c-eeprom for configuration
403 saa7146_write(dev, MC1, MASK_31);
406 /* disable all irqs */
407 saa7146_write(dev, IER, 0);
409 /* shut down all dma transfers and rps tasks */
410 saa7146_write(dev, MC1, 0x30ff0000);
412 /* clear out any rps-signals pending */
413 saa7146_write(dev, MC2, 0xf8000000);
415 /* request an interrupt for the saa7146 */
416 err = request_irq(pci->irq, interrupt_hw, IRQF_SHARED | IRQF_DISABLED,
419 ERR("request_irq() failed\n");
425 /* get memory for various stuff */
426 dev->d_rps0.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
427 &dev->d_rps0.dma_handle);
428 if (!dev->d_rps0.cpu_addr)
430 memset(dev->d_rps0.cpu_addr, 0x0, SAA7146_RPS_MEM);
432 dev->d_rps1.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
433 &dev->d_rps1.dma_handle);
434 if (!dev->d_rps1.cpu_addr)
436 memset(dev->d_rps1.cpu_addr, 0x0, SAA7146_RPS_MEM);
438 dev->d_i2c.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
439 &dev->d_i2c.dma_handle);
440 if (!dev->d_i2c.cpu_addr)
442 memset(dev->d_i2c.cpu_addr, 0x0, SAA7146_RPS_MEM);
444 /* the rest + print status message */
446 /* create a nice device name */
447 sprintf(dev->name, "saa7146 (%d)", saa7146_num);
449 pr_info("found saa7146 @ mem %p (revision %d, irq %d) (0x%04x,0x%04x)\n",
450 dev->mem, dev->revision, pci->irq,
451 pci->subsystem_vendor, pci->subsystem_device);
454 mutex_init(&dev->v4l2_lock);
455 spin_lock_init(&dev->int_slock);
456 spin_lock_init(&dev->slock);
458 mutex_init(&dev->i2c_lock);
460 dev->module = THIS_MODULE;
461 init_waitqueue_head(&dev->i2c_wq);
463 /* set some sane pci arbitrition values */
464 saa7146_write(dev, PCI_BT_V1, 0x1c00101f);
466 /* TODO: use the status code of the callback */
470 if (ext->probe && ext->probe(dev)) {
471 DEB_D("ext->probe() failed for %p. skipping device.\n", dev);
475 if (ext->attach(dev, pci_ext)) {
476 DEB_D("ext->attach() failed for %p. skipping device.\n", dev);
479 /* V4L extensions will set the pci drvdata to the v4l2_device in the
480 attach() above. So for those cards that do not use V4L we have to
481 set it explicitly. */
482 pci_set_drvdata(pci, &dev->v4l2_dev);
484 INIT_LIST_HEAD(&dev->item);
485 list_add_tail(&dev->item,&saa7146_devices);
493 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_i2c.cpu_addr,
494 dev->d_i2c.dma_handle);
496 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps1.cpu_addr,
497 dev->d_rps1.dma_handle);
499 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps0.cpu_addr,
500 dev->d_rps0.dma_handle);
502 free_irq(pci->irq, (void *)dev);
506 pci_release_region(pci, 0);
508 pci_disable_device(pci);
514 static void saa7146_remove_one(struct pci_dev *pdev)
516 struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
517 struct saa7146_dev *dev = to_saa7146_dev(v4l2_dev);
522 { dev->d_i2c.cpu_addr, dev->d_i2c.dma_handle },
523 { dev->d_rps1.cpu_addr, dev->d_rps1.dma_handle },
524 { dev->d_rps0.cpu_addr, dev->d_rps0.dma_handle },
528 DEB_EE("dev:%p\n", dev);
530 dev->ext->detach(dev);
531 /* Zero the PCI drvdata after use. */
532 pci_set_drvdata(pdev, NULL);
534 /* shut down all video dma transfers */
535 saa7146_write(dev, MC1, 0x00ff0000);
537 /* disable all irqs, release irq-routine */
538 saa7146_write(dev, IER, 0);
540 free_irq(pdev->irq, dev);
542 for (p = dev_map; p->addr; p++)
543 pci_free_consistent(pdev, SAA7146_RPS_MEM, p->addr, p->dma);
546 pci_release_region(pdev, 0);
547 list_del(&dev->item);
548 pci_disable_device(pdev);
554 /*********************************************************************************/
555 /* extension handling functions */
557 int saa7146_register_extension(struct saa7146_extension* ext)
559 DEB_EE("ext:%p\n", ext);
561 ext->driver.name = ext->name;
562 ext->driver.id_table = ext->pci_tbl;
563 ext->driver.probe = saa7146_init_one;
564 ext->driver.remove = saa7146_remove_one;
566 pr_info("register extension '%s'\n", ext->name);
567 return pci_register_driver(&ext->driver);
570 int saa7146_unregister_extension(struct saa7146_extension* ext)
572 DEB_EE("ext:%p\n", ext);
573 pr_info("unregister extension '%s'\n", ext->name);
574 pci_unregister_driver(&ext->driver);
578 EXPORT_SYMBOL_GPL(saa7146_register_extension);
579 EXPORT_SYMBOL_GPL(saa7146_unregister_extension);
581 /* misc functions used by extension modules */
582 EXPORT_SYMBOL_GPL(saa7146_pgtable_alloc);
583 EXPORT_SYMBOL_GPL(saa7146_pgtable_free);
584 EXPORT_SYMBOL_GPL(saa7146_pgtable_build_single);
585 EXPORT_SYMBOL_GPL(saa7146_vmalloc_build_pgtable);
586 EXPORT_SYMBOL_GPL(saa7146_vfree_destroy_pgtable);
587 EXPORT_SYMBOL_GPL(saa7146_wait_for_debi_done);
589 EXPORT_SYMBOL_GPL(saa7146_setgpio);
591 EXPORT_SYMBOL_GPL(saa7146_i2c_adapter_prepare);
593 EXPORT_SYMBOL_GPL(saa7146_debug);
594 EXPORT_SYMBOL_GPL(saa7146_devices);
595 EXPORT_SYMBOL_GPL(saa7146_devices_lock);
597 MODULE_AUTHOR("Michael Hunold <michael@mihu.de>");
598 MODULE_DESCRIPTION("driver for generic saa7146-based hardware");
599 MODULE_LICENSE("GPL");