drivers/media/common/saa7146_core.c

   1 /*
   2     saa7146.o - driver for generic saa7146-based hardware
   3
   4     Copyright (C) 1998-2003 Michael Hunold <michael@mihu.de>
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  22
  23 #include <media/saa7146.h>
  24
  25 LIST_HEAD(saa7146_devices);
  26 DEFINE_MUTEX(saa7146_devices_lock);
  27
  28 static int saa7146_num;
  29
  30 unsigned int saa7146_debug;
  31
  32 module_param(saa7146_debug, uint, 0644);
  33 MODULE_PARM_DESC(saa7146_debug, "debug level (default: 0)");
  34
  35 #if 0
  36 static void dump_registers(struct saa7146_dev* dev)
  37 {
  38         int i = 0;
  39
  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));
  43 }
  44 #endif
  45
  46 /****************************************************************************
  47  * gpio and debi helper functions
  48  ****************************************************************************/
  49
  50 void saa7146_setgpio(struct saa7146_dev *dev, int port, u32 data)
  51 {
  52         u32 value = 0;
  53
  54         BUG_ON(port > 3);
  55
  56         value = saa7146_read(dev, GPIO_CTRL);
  57         value &= ~(0xff << (8*port));
  58         value |= (data << (8*port));
  59         saa7146_write(dev, GPIO_CTRL, value);
  60 }
  61
  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)
  65 {
  66         unsigned long timeout;
  67         int err;
  68
  69         /* wait for registers to be programmed */
  70         timeout = jiffies + usecs_to_jiffies(us1);
  71         while (1) {
  72                 err = time_after(jiffies, timeout);
  73                 if (saa7146_read(dev, MC2) & 2)
  74                         break;
  75                 if (err) {
  76                         pr_err("%s: %s timed out while waiting for registers getting programmed\n",
  77                                dev->name, __func__);
  78                         return -ETIMEDOUT;
  79                 }
  80                 msleep(1);
  81         }
  82
  83         /* wait for transfer to complete */
  84         timeout = jiffies + usecs_to_jiffies(us2);
  85         while (1) {
  86                 err = time_after(jiffies, timeout);
  87                 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
  88                         break;
  89                 saa7146_read(dev, MC2);
  90                 if (err) {
  91                         DEB_S("%s: %s timed out while waiting for transfer completion\n",
  92                               dev->name, __func__);
  93                         return -ETIMEDOUT;
  94                 }
  95                 msleep(1);
  96         }
  97
  98         return 0;
  99 }
 100
 101 static inline int saa7146_wait_for_debi_done_busyloop(struct saa7146_dev *dev,
 102                                 unsigned long us1, unsigned long us2)
 103 {
 104         unsigned long loops;
 105
 106         /* wait for registers to be programmed */
 107         loops = us1;
 108         while (1) {
 109                 if (saa7146_read(dev, MC2) & 2)
 110                         break;
 111                 if (!loops--) {
 112                         pr_err("%s: %s timed out while waiting for registers getting programmed\n",
 113                                dev->name, __func__);
 114                         return -ETIMEDOUT;
 115                 }
 116                 udelay(1);
 117         }
 118
 119         /* wait for transfer to complete */
 120         loops = us2 / 5;
 121         while (1) {
 122                 if (!(saa7146_read(dev, PSR) & SPCI_DEBI_S))
 123                         break;
 124                 saa7146_read(dev, MC2);
 125                 if (!loops--) {
 126                         DEB_S("%s: %s timed out while waiting for transfer completion\n",
 127                               dev->name, __func__);
 128                         return -ETIMEDOUT;
 129                 }
 130                 udelay(5);
 131         }
 132
 133         return 0;
 134 }
 135
 136 int saa7146_wait_for_debi_done(struct saa7146_dev *dev, int nobusyloop)
 137 {
 138         if (nobusyloop)
 139                 return saa7146_wait_for_debi_done_sleep(dev, 50000, 250000);
 140         else
 141                 return saa7146_wait_for_debi_done_busyloop(dev, 50000, 250000);
 142 }
 143
 144 /****************************************************************************
 145  * general helper functions
 146  ****************************************************************************/
 147
 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)
 152 {
 153         struct scatterlist *sglist;
 154         struct page *pg;
 155         int i;
 156
 157         sglist = kcalloc(nr_pages, sizeof(struct scatterlist), GFP_KERNEL);
 158         if (NULL == sglist)
 159                 return NULL;
 160         sg_init_table(sglist, nr_pages);
 161         for (i = 0; i < nr_pages; i++, virt += PAGE_SIZE) {
 162                 pg = vmalloc_to_page(virt);
 163                 if (NULL == pg)
 164                         goto err;
 165                 BUG_ON(PageHighMem(pg));
 166                 sg_set_page(&sglist[i], pg, PAGE_SIZE, 0);
 167         }
 168         return sglist;
 169
 170  err:
 171         kfree(sglist);
 172         return NULL;
 173 }
 174
 175 /********************************************************************************/
 176 /* common page table functions */
 177
 178 void *saa7146_vmalloc_build_pgtable(struct pci_dev *pci, long length, struct saa7146_pgtable *pt)
 179 {
 180         int pages = (length+PAGE_SIZE-1)/PAGE_SIZE;
 181         void *mem = vmalloc_32(length);
 182         int slen = 0;
 183
 184         if (NULL == mem)
 185                 goto err_null;
 186
 187         if (!(pt->slist = vmalloc_to_sg(mem, pages)))
 188                 goto err_free_mem;
 189
 190         if (saa7146_pgtable_alloc(pci, pt))
 191                 goto err_free_slist;
 192
 193         pt->nents = pages;
 194         slen = pci_map_sg(pci,pt->slist,pt->nents,PCI_DMA_FROMDEVICE);
 195         if (0 == slen)
 196                 goto err_free_pgtable;
 197
 198         if (0 != saa7146_pgtable_build_single(pci, pt, pt->slist, slen))
 199                 goto err_unmap_sg;
 200
 201         return mem;
 202
 203 err_unmap_sg:
 204         pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
 205 err_free_pgtable:
 206         saa7146_pgtable_free(pci, pt);
 207 err_free_slist:
 208         kfree(pt->slist);
 209         pt->slist = NULL;
 210 err_free_mem:
 211         vfree(mem);
 212 err_null:
 213         return NULL;
 214 }
 215
 216 void saa7146_vfree_destroy_pgtable(struct pci_dev *pci, void *mem, struct saa7146_pgtable *pt)
 217 {
 218         pci_unmap_sg(pci, pt->slist, pt->nents, PCI_DMA_FROMDEVICE);
 219         saa7146_pgtable_free(pci, pt);
 220         kfree(pt->slist);
 221         pt->slist = NULL;
 222         vfree(mem);
 223 }
 224
 225 void saa7146_pgtable_free(struct pci_dev *pci, struct saa7146_pgtable *pt)
 226 {
 227         if (NULL == pt->cpu)
 228                 return;
 229         pci_free_consistent(pci, pt->size, pt->cpu, pt->dma);
 230         pt->cpu = NULL;
 231 }
 232
 233 int saa7146_pgtable_alloc(struct pci_dev *pci, struct saa7146_pgtable *pt)
 234 {
 235         __le32       *cpu;
 236         dma_addr_t   dma_addr = 0;
 237
 238         cpu = pci_alloc_consistent(pci, PAGE_SIZE, &dma_addr);
 239         if (NULL == cpu) {
 240                 return -ENOMEM;
 241         }
 242         pt->size = PAGE_SIZE;
 243         pt->cpu  = cpu;
 244         pt->dma  = dma_addr;
 245
 246         return 0;
 247 }
 248
 249 int saa7146_pgtable_build_single(struct pci_dev *pci, struct saa7146_pgtable *pt,
 250         struct scatterlist *list, int sglen  )
 251 {
 252         __le32 *ptr, fill;
 253         int nr_pages = 0;
 254         int i,p;
 255
 256         BUG_ON(0 == sglen);
 257         BUG_ON(list->offset > PAGE_SIZE);
 258
 259         /* if we have a user buffer, the first page may not be
 260            aligned to a page boundary. */
 261         pt->offset = list->offset;
 262
 263         ptr = pt->cpu;
 264         for (i = 0; i < sglen; i++, list++) {
 265 /*
 266                 pr_debug("i:%d, adr:0x%08x, len:%d, offset:%d\n",
 267                          i, sg_dma_address(list), sg_dma_len(list),
 268                          list->offset);
 269 */
 270                 for (p = 0; p * 4096 < list->length; p++, ptr++) {
 271                         *ptr = cpu_to_le32(sg_dma_address(list) + p * 4096);
 272                         nr_pages++;
 273                 }
 274         }
 275
 276
 277         /* safety; fill the page table up with the last valid page */
 278         fill = *(ptr-1);
 279         for(i=nr_pages;i<1024;i++) {
 280                 *ptr++ = fill;
 281         }
 282
 283 /*
 284         ptr = pt->cpu;
 285         pr_debug("offset: %d\n", pt->offset);
 286         for(i=0;i<5;i++) {
 287                 pr_debug("ptr1 %d: 0x%08x\n", i, ptr[i]);
 288         }
 289 */
 290         return 0;
 291 }
 292
 293 /********************************************************************************/
 294 /* interrupt handler */
 295 static irqreturn_t interrupt_hw(int irq, void *dev_id)
 296 {
 297         struct saa7146_dev *dev = dev_id;
 298         u32 isr;
 299         u32 ack_isr;
 300
 301         /* read out the interrupt status register */
 302         ack_isr = isr = saa7146_read(dev, ISR);
 303
 304         /* is this our interrupt? */
 305         if ( 0 == isr ) {
 306                 /* nope, some other device */
 307                 return IRQ_NONE;
 308         }
 309
 310         if (dev->ext) {
 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;
 315                 }
 316         }
 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);
 321                 isr &= ~MASK_27;
 322         }
 323         if (0 != (isr & (MASK_28))) {
 324                 if (dev->vv_data && dev->vv_callback)
 325                         dev->vv_callback(dev,isr);
 326                 isr &= ~MASK_28;
 327         }
 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) {
 332                         dev->i2c_op = 0;
 333                         wake_up(&dev->i2c_wq);
 334                 } else {
 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);
 339                 }
 340                 isr &= ~(MASK_16|MASK_17);
 341         }
 342         if( 0 != isr ) {
 343                 ERR("warning: interrupt enabled, but not handled properly.(0x%08x)\n",
 344                     isr);
 345                 ERR("disabling interrupt source(s)!\n");
 346                 SAA7146_IER_DISABLE(dev,isr);
 347         }
 348         saa7146_write(dev, ISR, ack_isr);
 349         return IRQ_HANDLED;
 350 }
 351
 352 /*********************************************************************************/
 353 /* configuration-functions                                                       */
 354
 355 static int saa7146_init_one(struct pci_dev *pci, const struct pci_device_id *ent)
 356 {
 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;
 360         int err = -ENOMEM;
 361
 362         /* clear out mem for sure */
 363         dev = kzalloc(sizeof(struct saa7146_dev), GFP_KERNEL);
 364         if (!dev) {
 365                 ERR("out of memory\n");
 366                 goto out;
 367         }
 368
 369         DEB_EE("pci:%p\n", pci);
 370
 371         err = pci_enable_device(pci);
 372         if (err < 0) {
 373                 ERR("pci_enable_device() failed\n");
 374                 goto err_free;
 375         }
 376
 377         /* enable bus-mastering */
 378         pci_set_master(pci);
 379
 380         dev->pci = pci;
 381
 382         /* get chip-revision; this is needed to enable bug-fixes */
 383         dev->revision = pci->revision;
 384
 385         /* remap the memory from virtual to physical address */
 386
 387         err = pci_request_region(pci, 0, "saa7146");
 388         if (err < 0)
 389                 goto err_disable;
 390
 391         dev->mem = ioremap(pci_resource_start(pci, 0),
 392                            pci_resource_len(pci, 0));
 393         if (!dev->mem) {
 394                 ERR("ioremap() failed\n");
 395                 err = -ENODEV;
 396                 goto err_release;
 397         }
 398
 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
 401            values */
 402 /*
 403         saa7146_write(dev, MC1, MASK_31);
 404 */
 405
 406         /* disable all irqs */
 407         saa7146_write(dev, IER, 0);
 408
 409         /* shut down all dma transfers and rps tasks */
 410         saa7146_write(dev, MC1, 0x30ff0000);
 411
 412         /* clear out any rps-signals pending */
 413         saa7146_write(dev, MC2, 0xf8000000);
 414
 415         /* request an interrupt for the saa7146 */
 416         err = request_irq(pci->irq, interrupt_hw, IRQF_SHARED | IRQF_DISABLED,
 417                           dev->name, dev);
 418         if (err < 0) {
 419                 ERR("request_irq() failed\n");
 420                 goto err_unmap;
 421         }
 422
 423         err = -ENOMEM;
 424
 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)
 429                 goto err_free_irq;
 430         memset(dev->d_rps0.cpu_addr, 0x0, SAA7146_RPS_MEM);
 431
 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)
 435                 goto err_free_rps0;
 436         memset(dev->d_rps1.cpu_addr, 0x0, SAA7146_RPS_MEM);
 437
 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)
 441                 goto err_free_rps1;
 442         memset(dev->d_i2c.cpu_addr, 0x0, SAA7146_RPS_MEM);
 443
 444         /* the rest + print status message */
 445
 446         /* create a nice device name */
 447         sprintf(dev->name, "saa7146 (%d)", saa7146_num);
 448
 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);
 452         dev->ext = ext;
 453
 454         mutex_init(&dev->v4l2_lock);
 455         spin_lock_init(&dev->int_slock);
 456         spin_lock_init(&dev->slock);
 457
 458         mutex_init(&dev->i2c_lock);
 459
 460         dev->module = THIS_MODULE;
 461         init_waitqueue_head(&dev->i2c_wq);
 462
 463         /* set some sane pci arbitrition values */
 464         saa7146_write(dev, PCI_BT_V1, 0x1c00101f);
 465
 466         /* TODO: use the status code of the callback */
 467
 468         err = -ENODEV;
 469
 470         if (ext->probe && ext->probe(dev)) {
 471                 DEB_D("ext->probe() failed for %p. skipping device.\n", dev);
 472                 goto err_free_i2c;
 473         }
 474
 475         if (ext->attach(dev, pci_ext)) {
 476                 DEB_D("ext->attach() failed for %p. skipping device.\n", dev);
 477                 goto err_free_i2c;
 478         }
 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);
 483
 484         INIT_LIST_HEAD(&dev->item);
 485         list_add_tail(&dev->item,&saa7146_devices);
 486         saa7146_num++;
 487
 488         err = 0;
 489 out:
 490         return err;
 491
 492 err_free_i2c:
 493         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_i2c.cpu_addr,
 494                             dev->d_i2c.dma_handle);
 495 err_free_rps1:
 496         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps1.cpu_addr,
 497                             dev->d_rps1.dma_handle);
 498 err_free_rps0:
 499         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps0.cpu_addr,
 500                             dev->d_rps0.dma_handle);
 501 err_free_irq:
 502         free_irq(pci->irq, (void *)dev);
 503 err_unmap:
 504         iounmap(dev->mem);
 505 err_release:
 506         pci_release_region(pci, 0);
 507 err_disable:
 508         pci_disable_device(pci);
 509 err_free:
 510         kfree(dev);
 511         goto out;
 512 }
 513
 514 static void saa7146_remove_one(struct pci_dev *pdev)
 515 {
 516         struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
 517         struct saa7146_dev *dev = to_saa7146_dev(v4l2_dev);
 518         struct {
 519                 void *addr;
 520                 dma_addr_t dma;
 521         } dev_map[] = {
 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 },
 525                 { NULL, 0 }
 526         }, *p;
 527
 528         DEB_EE("dev:%p\n", dev);
 529
 530         dev->ext->detach(dev);
 531         /* Zero the PCI drvdata after use. */
 532         pci_set_drvdata(pdev, NULL);
 533
 534         /* shut down all video dma transfers */
 535         saa7146_write(dev, MC1, 0x00ff0000);
 536
 537         /* disable all irqs, release irq-routine */
 538         saa7146_write(dev, IER, 0);
 539
 540         free_irq(pdev->irq, dev);
 541
 542         for (p = dev_map; p->addr; p++)
 543                 pci_free_consistent(pdev, SAA7146_RPS_MEM, p->addr, p->dma);
 544
 545         iounmap(dev->mem);
 546         pci_release_region(pdev, 0);
 547         list_del(&dev->item);
 548         pci_disable_device(pdev);
 549         kfree(dev);
 550
 551         saa7146_num--;
 552 }
 553
 554 /*********************************************************************************/
 555 /* extension handling functions                                                  */
 556
 557 int saa7146_register_extension(struct saa7146_extension* ext)
 558 {
 559         DEB_EE("ext:%p\n", ext);
 560
 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;
 565
 566         pr_info("register extension '%s'\n", ext->name);
 567         return pci_register_driver(&ext->driver);
 568 }
 569
 570 int saa7146_unregister_extension(struct saa7146_extension* ext)
 571 {
 572         DEB_EE("ext:%p\n", ext);
 573         pr_info("unregister extension '%s'\n", ext->name);
 574         pci_unregister_driver(&ext->driver);
 575         return 0;
 576 }
 577
 578 EXPORT_SYMBOL_GPL(saa7146_register_extension);
 579 EXPORT_SYMBOL_GPL(saa7146_unregister_extension);
 580
 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);
 588
 589 EXPORT_SYMBOL_GPL(saa7146_setgpio);
 590
 591 EXPORT_SYMBOL_GPL(saa7146_i2c_adapter_prepare);
 592
 593 EXPORT_SYMBOL_GPL(saa7146_debug);
 594 EXPORT_SYMBOL_GPL(saa7146_devices);
 595 EXPORT_SYMBOL_GPL(saa7146_devices_lock);
 596
 597 MODULE_AUTHOR("Michael Hunold <michael@mihu.de>");
 598 MODULE_DESCRIPTION("driver for generic saa7146-based hardware");
 599 MODULE_LICENSE("GPL");