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>
24 #include <linux/module.h>
26 LIST_HEAD(saa7146_devices);
27 DEFINE_MUTEX(saa7146_devices_lock);
29 static int saa7146_num;
31 unsigned int saa7146_debug;
33 module_param(saa7146_debug, uint, 0644);
34 MODULE_PARM_DESC(saa7146_debug, "debug level (default: 0)");
37 static void dump_registers(struct saa7146_dev* dev)
41 pr_info(" @ %li jiffies:\n", jiffies);
42 for (i = 0; i <= 0x148; i += 4)
43 pr_info("0x%03x: 0x%08x\n", i, saa7146_read(dev, i));
47 /****************************************************************************
48 * gpio and debi helper functions
49 ****************************************************************************/
51 void saa7146_setgpio(struct saa7146_dev *dev, int port, u32 data)
57 value = saa7146_read(dev, GPIO_CTRL);
58 value &= ~(0xff << (8*port));
59 value |= (data << (8*port));
60 saa7146_write(dev, GPIO_CTRL, value);
63 /* This DEBI code is based on the saa7146 Stradis driver by Nathan Laredo */
64 static inline int saa7146_wait_for_debi_done_sleep(struct saa7146_dev *dev,
65 unsigned long us1, unsigned long us2)
67 unsigned long timeout;
70 /* wait for registers to be programmed */
71 timeout = jiffies + usecs_to_jiffies(us1);
73 err = time_after(jiffies, timeout);
74 if (saa7146_read(dev, MC2) & 2)
77 pr_err("%s: %s timed out while waiting for registers getting programmed\n",
84 /* wait for transfer to complete */
85 timeout = jiffies + usecs_to_jiffies(us2);
87 err = time_after(jiffies, timeout);
88 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
90 saa7146_read(dev, MC2);
92 DEB_S("%s: %s timed out while waiting for transfer completion\n",
102 static inline int saa7146_wait_for_debi_done_busyloop(struct saa7146_dev *dev,
103 unsigned long us1, unsigned long us2)
107 /* wait for registers to be programmed */
110 if (saa7146_read(dev, MC2) & 2)
113 pr_err("%s: %s timed out while waiting for registers getting programmed\n",
114 dev->name, __func__);
120 /* wait for transfer to complete */
123 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
125 saa7146_read(dev, MC2);
127 DEB_S("%s: %s timed out while waiting for transfer completion\n",
128 dev->name, __func__);
137 int saa7146_wait_for_debi_done(struct saa7146_dev *dev, int nobusyloop)
140 return saa7146_wait_for_debi_done_sleep(dev, 50000, 250000);
142 return saa7146_wait_for_debi_done_busyloop(dev, 50000, 250000);
145 /****************************************************************************
146 * general helper functions
147 ****************************************************************************/
149 /* this is videobuf_vmalloc_to_sg() from videobuf-dma-sg.c
150 make sure virt has been allocated with vmalloc_32(), otherwise the BUG()
151 may be triggered on highmem machines */
152 static struct scatterlist* vmalloc_to_sg(unsigned char *virt, int nr_pages)
154 struct scatterlist *sglist;
158 sglist = kcalloc(nr_pages, sizeof(struct scatterlist), GFP_KERNEL);
161 sg_init_table(sglist, nr_pages);
162 for (i = 0; i < nr_pages; i++, virt += PAGE_SIZE) {
163 pg = vmalloc_to_page(virt);
166 BUG_ON(PageHighMem(pg));
167 sg_set_page(&sglist[i], pg, PAGE_SIZE, 0);
176 /********************************************************************************/
177 /* common page table functions */
179 void *saa7146_vmalloc_build_pgtable(struct pci_dev *pci, long length, struct saa7146_pgtable *pt)
181 int pages = (length+PAGE_SIZE-1)/PAGE_SIZE;
182 void *mem = vmalloc_32(length);
188 if (!(pt->slist = vmalloc_to_sg(mem, pages)))
191 if (saa7146_pgtable_alloc(pci, pt))
195 slen = pci_map_sg(pci,pt->slist,pt->nents,PCI_DMA_FROMDEVICE);
197 goto err_free_pgtable;
199 if (0 != saa7146_pgtable_build_single(pci, pt, pt->slist, slen))
205 pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
207 saa7146_pgtable_free(pci, pt);
217 void saa7146_vfree_destroy_pgtable(struct pci_dev *pci, void *mem, struct saa7146_pgtable *pt)
219 pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
220 saa7146_pgtable_free(pci, pt);
226 void saa7146_pgtable_free(struct pci_dev *pci, struct saa7146_pgtable *pt)
230 pci_free_consistent(pci, pt->size, pt->cpu, pt->dma);
234 int saa7146_pgtable_alloc(struct pci_dev *pci, struct saa7146_pgtable *pt)
237 dma_addr_t dma_addr = 0;
239 cpu = pci_alloc_consistent(pci, PAGE_SIZE, &dma_addr);
243 pt->size = PAGE_SIZE;
250 int saa7146_pgtable_build_single(struct pci_dev *pci, struct saa7146_pgtable *pt,
251 struct scatterlist *list, int sglen )
258 BUG_ON(list->offset > PAGE_SIZE);
260 /* if we have a user buffer, the first page may not be
261 aligned to a page boundary. */
262 pt->offset = list->offset;
265 for (i = 0; i < sglen; i++, list++) {
267 pr_debug("i:%d, adr:0x%08x, len:%d, offset:%d\n",
268 i, sg_dma_address(list), sg_dma_len(list),
271 for (p = 0; p * 4096 < list->length; p++, ptr++) {
272 *ptr = cpu_to_le32(sg_dma_address(list) + p * 4096);
278 /* safety; fill the page table up with the last valid page */
280 for(i=nr_pages;i<1024;i++) {
286 pr_debug("offset: %d\n", pt->offset);
288 pr_debug("ptr1 %d: 0x%08x\n", i, ptr[i]);
294 /********************************************************************************/
295 /* interrupt handler */
296 static irqreturn_t interrupt_hw(int irq, void *dev_id)
298 struct saa7146_dev *dev = dev_id;
302 /* read out the interrupt status register */
303 ack_isr = isr = saa7146_read(dev, ISR);
305 /* is this our interrupt? */
307 /* nope, some other device */
312 if (dev->ext->irq_mask & isr) {
313 if (dev->ext->irq_func)
314 dev->ext->irq_func(dev, &isr);
315 isr &= ~dev->ext->irq_mask;
318 if (0 != (isr & (MASK_27))) {
319 DEB_INT("irq: RPS0 (0x%08x)\n", isr);
320 if (dev->vv_data && dev->vv_callback)
321 dev->vv_callback(dev,isr);
324 if (0 != (isr & (MASK_28))) {
325 if (dev->vv_data && dev->vv_callback)
326 dev->vv_callback(dev,isr);
329 if (0 != (isr & (MASK_16|MASK_17))) {
330 SAA7146_IER_DISABLE(dev, MASK_16|MASK_17);
331 /* only wake up if we expect something */
332 if (0 != dev->i2c_op) {
334 wake_up(&dev->i2c_wq);
336 u32 psr = saa7146_read(dev, PSR);
337 u32 ssr = saa7146_read(dev, SSR);
338 pr_warn("%s: unexpected i2c irq: isr %08x psr %08x ssr %08x\n",
339 dev->name, isr, psr, ssr);
341 isr &= ~(MASK_16|MASK_17);
344 ERR("warning: interrupt enabled, but not handled properly.(0x%08x)\n",
346 ERR("disabling interrupt source(s)!\n");
347 SAA7146_IER_DISABLE(dev,isr);
349 saa7146_write(dev, ISR, ack_isr);
353 /*********************************************************************************/
354 /* configuration-functions */
356 static int saa7146_init_one(struct pci_dev *pci, const struct pci_device_id *ent)
358 struct saa7146_pci_extension_data *pci_ext = (struct saa7146_pci_extension_data *)ent->driver_data;
359 struct saa7146_extension *ext = pci_ext->ext;
360 struct saa7146_dev *dev;
363 /* clear out mem for sure */
364 dev = kzalloc(sizeof(struct saa7146_dev), GFP_KERNEL);
366 ERR("out of memory\n");
370 DEB_EE("pci:%p\n", pci);
372 err = pci_enable_device(pci);
374 ERR("pci_enable_device() failed\n");
378 /* enable bus-mastering */
383 /* get chip-revision; this is needed to enable bug-fixes */
384 dev->revision = pci->revision;
386 /* remap the memory from virtual to physical address */
388 err = pci_request_region(pci, 0, "saa7146");
392 dev->mem = ioremap(pci_resource_start(pci, 0),
393 pci_resource_len(pci, 0));
395 ERR("ioremap() failed\n");
400 /* we don't do a master reset here anymore, it screws up
401 some boards that don't have an i2c-eeprom for configuration
404 saa7146_write(dev, MC1, MASK_31);
407 /* disable all irqs */
408 saa7146_write(dev, IER, 0);
410 /* shut down all dma transfers and rps tasks */
411 saa7146_write(dev, MC1, 0x30ff0000);
413 /* clear out any rps-signals pending */
414 saa7146_write(dev, MC2, 0xf8000000);
416 /* request an interrupt for the saa7146 */
417 err = request_irq(pci->irq, interrupt_hw, IRQF_SHARED | IRQF_DISABLED,
420 ERR("request_irq() failed\n");
426 /* get memory for various stuff */
427 dev->d_rps0.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
428 &dev->d_rps0.dma_handle);
429 if (!dev->d_rps0.cpu_addr)
431 memset(dev->d_rps0.cpu_addr, 0x0, SAA7146_RPS_MEM);
433 dev->d_rps1.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
434 &dev->d_rps1.dma_handle);
435 if (!dev->d_rps1.cpu_addr)
437 memset(dev->d_rps1.cpu_addr, 0x0, SAA7146_RPS_MEM);
439 dev->d_i2c.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
440 &dev->d_i2c.dma_handle);
441 if (!dev->d_i2c.cpu_addr)
443 memset(dev->d_i2c.cpu_addr, 0x0, SAA7146_RPS_MEM);
445 /* the rest + print status message */
447 /* create a nice device name */
448 sprintf(dev->name, "saa7146 (%d)", saa7146_num);
450 pr_info("found saa7146 @ mem %p (revision %d, irq %d) (0x%04x,0x%04x)\n",
451 dev->mem, dev->revision, pci->irq,
452 pci->subsystem_vendor, pci->subsystem_device);
455 mutex_init(&dev->v4l2_lock);
456 spin_lock_init(&dev->int_slock);
457 spin_lock_init(&dev->slock);
459 mutex_init(&dev->i2c_lock);
461 dev->module = THIS_MODULE;
462 init_waitqueue_head(&dev->i2c_wq);
464 /* set some sane pci arbitrition values */
465 saa7146_write(dev, PCI_BT_V1, 0x1c00101f);
467 /* TODO: use the status code of the callback */
471 if (ext->probe && ext->probe(dev)) {
472 DEB_D("ext->probe() failed for %p. skipping device.\n", dev);
476 if (ext->attach(dev, pci_ext)) {
477 DEB_D("ext->attach() failed for %p. skipping device.\n", dev);
480 /* V4L extensions will set the pci drvdata to the v4l2_device in the
481 attach() above. So for those cards that do not use V4L we have to
482 set it explicitly. */
483 pci_set_drvdata(pci, &dev->v4l2_dev);
485 INIT_LIST_HEAD(&dev->item);
486 list_add_tail(&dev->item,&saa7146_devices);
494 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_i2c.cpu_addr,
495 dev->d_i2c.dma_handle);
497 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps1.cpu_addr,
498 dev->d_rps1.dma_handle);
500 pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps0.cpu_addr,
501 dev->d_rps0.dma_handle);
503 free_irq(pci->irq, (void *)dev);
507 pci_release_region(pci, 0);
509 pci_disable_device(pci);
515 static void saa7146_remove_one(struct pci_dev *pdev)
517 struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
518 struct saa7146_dev *dev = to_saa7146_dev(v4l2_dev);
523 { dev->d_i2c.cpu_addr, dev->d_i2c.dma_handle },
524 { dev->d_rps1.cpu_addr, dev->d_rps1.dma_handle },
525 { dev->d_rps0.cpu_addr, dev->d_rps0.dma_handle },
529 DEB_EE("dev:%p\n", dev);
531 dev->ext->detach(dev);
532 /* Zero the PCI drvdata after use. */
533 pci_set_drvdata(pdev, NULL);
535 /* shut down all video dma transfers */
536 saa7146_write(dev, MC1, 0x00ff0000);
538 /* disable all irqs, release irq-routine */
539 saa7146_write(dev, IER, 0);
541 free_irq(pdev->irq, dev);
543 for (p = dev_map; p->addr; p++)
544 pci_free_consistent(pdev, SAA7146_RPS_MEM, p->addr, p->dma);
547 pci_release_region(pdev, 0);
548 list_del(&dev->item);
549 pci_disable_device(pdev);
555 /*********************************************************************************/
556 /* extension handling functions */
558 int saa7146_register_extension(struct saa7146_extension* ext)
560 DEB_EE("ext:%p\n", ext);
562 ext->driver.name = ext->name;
563 ext->driver.id_table = ext->pci_tbl;
564 ext->driver.probe = saa7146_init_one;
565 ext->driver.remove = saa7146_remove_one;
567 pr_info("register extension '%s'\n", ext->name);
568 return pci_register_driver(&ext->driver);
571 int saa7146_unregister_extension(struct saa7146_extension* ext)
573 DEB_EE("ext:%p\n", ext);
574 pr_info("unregister extension '%s'\n", ext->name);
575 pci_unregister_driver(&ext->driver);
579 EXPORT_SYMBOL_GPL(saa7146_register_extension);
580 EXPORT_SYMBOL_GPL(saa7146_unregister_extension);
582 /* misc functions used by extension modules */
583 EXPORT_SYMBOL_GPL(saa7146_pgtable_alloc);
584 EXPORT_SYMBOL_GPL(saa7146_pgtable_free);
585 EXPORT_SYMBOL_GPL(saa7146_pgtable_build_single);
586 EXPORT_SYMBOL_GPL(saa7146_vmalloc_build_pgtable);
587 EXPORT_SYMBOL_GPL(saa7146_vfree_destroy_pgtable);
588 EXPORT_SYMBOL_GPL(saa7146_wait_for_debi_done);
590 EXPORT_SYMBOL_GPL(saa7146_setgpio);
592 EXPORT_SYMBOL_GPL(saa7146_i2c_adapter_prepare);
594 EXPORT_SYMBOL_GPL(saa7146_debug);
595 EXPORT_SYMBOL_GPL(saa7146_devices);
596 EXPORT_SYMBOL_GPL(saa7146_devices_lock);
598 MODULE_AUTHOR("Michael Hunold <michael@mihu.de>");
599 MODULE_DESCRIPTION("driver for generic saa7146-based hardware");
600 MODULE_LICENSE("GPL");