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