[PATCH] dvb: ttpci: fix timeout handling to be save with PREEMPT
[linux-2.6.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 DECLARE_MUTEX(saa7146_devices_lock);
25
26 static int saa7146_num;
27
28 unsigned int saa7146_debug;
29
30 module_param(saa7146_debug, int, 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 video-buf.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 = kmalloc(sizeof(struct scatterlist)*nr_pages, GFP_KERNEL);
113         if (NULL == sglist)
114                 return NULL;
115         memset(sglist,0,sizeof(struct scatterlist)*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                 if (PageHighMem(pg))
121                         BUG();
122                 sglist[i].page   = pg;
123                 sglist[i].length = PAGE_SIZE;
124         }
125         return sglist;
126
127  err:
128         kfree(sglist);
129         return NULL;
130 }
131
132 /********************************************************************************/
133 /* common page table functions */
134
135 char *saa7146_vmalloc_build_pgtable(struct pci_dev *pci, long length, struct saa7146_pgtable *pt)
136 {
137         int pages = (length+PAGE_SIZE-1)/PAGE_SIZE;
138         char *mem = vmalloc_32(length);
139         int slen = 0;
140
141         if (NULL == mem) {
142                 return NULL;
143         }
144
145         if (!(pt->slist = vmalloc_to_sg(mem, pages))) {
146                 vfree(mem);
147                 return NULL;
148         }
149
150         if (saa7146_pgtable_alloc(pci, pt)) {
151                 kfree(pt->slist);
152                 pt->slist = NULL;
153                 vfree(mem);
154                 return NULL;
155         }
156
157         slen = pci_map_sg(pci,pt->slist,pages,PCI_DMA_FROMDEVICE);
158         if (0 != saa7146_pgtable_build_single(pci, pt, pt->slist, slen)) {
159                 return NULL;
160         }
161
162         return mem;
163 }
164
165 void saa7146_pgtable_free(struct pci_dev *pci, struct saa7146_pgtable *pt)
166 {
167         if (NULL == pt->cpu)
168                 return;
169         pci_free_consistent(pci, pt->size, pt->cpu, pt->dma);
170         pt->cpu = NULL;
171         if (NULL != pt->slist) {
172                 kfree(pt->slist);
173                 pt->slist = NULL;
174         }
175 }
176
177 int saa7146_pgtable_alloc(struct pci_dev *pci, struct saa7146_pgtable *pt)
178 {
179         u32          *cpu;
180         dma_addr_t   dma_addr;
181
182         cpu = pci_alloc_consistent(pci, PAGE_SIZE, &dma_addr);
183         if (NULL == cpu) {
184                 return -ENOMEM;
185         }
186         pt->size = PAGE_SIZE;
187         pt->cpu  = cpu;
188         pt->dma  = dma_addr;
189
190         return 0;
191 }
192
193 int saa7146_pgtable_build_single(struct pci_dev *pci, struct saa7146_pgtable *pt,
194         struct scatterlist *list, int sglen  )
195 {
196         u32 *ptr, fill;
197         int nr_pages = 0;
198         int i,p;
199
200         BUG_ON(0 == sglen);
201         BUG_ON(list->offset > PAGE_SIZE);
202
203         /* if we have a user buffer, the first page may not be
204            aligned to a page boundary. */
205         pt->offset = list->offset;
206
207         ptr = pt->cpu;
208         for (i = 0; i < sglen; i++, list++) {
209 /*
210                 printk("i:%d, adr:0x%08x, len:%d, offset:%d\n", i,sg_dma_address(list), sg_dma_len(list), list->offset);
211 */
212                 for (p = 0; p * 4096 < list->length; p++, ptr++) {
213                         *ptr = cpu_to_le32(sg_dma_address(list) + p * 4096);
214                         nr_pages++;
215                 }
216         }
217
218
219         /* safety; fill the page table up with the last valid page */
220         fill = *(ptr-1);
221         for(i=nr_pages;i<1024;i++) {
222                 *ptr++ = fill;
223         }
224
225 /*
226         ptr = pt->cpu;
227         printk("offset: %d\n",pt->offset);
228         for(i=0;i<5;i++) {
229                 printk("ptr1 %d: 0x%08x\n",i,ptr[i]);
230         }
231 */
232         return 0;
233 }
234
235 /********************************************************************************/
236 /* interrupt handler */
237 static irqreturn_t interrupt_hw(int irq, void *dev_id, struct pt_regs *regs)
238 {
239         struct saa7146_dev *dev = dev_id;
240         u32 isr = 0;
241
242         /* read out the interrupt status register */
243         isr = saa7146_read(dev, ISR);
244
245         /* is this our interrupt? */
246         if ( 0 == isr ) {
247                 /* nope, some other device */
248                 return IRQ_NONE;
249         }
250
251         saa7146_write(dev, ISR, isr);
252
253         if( 0 != (dev->ext)) {
254                 if( 0 != (dev->ext->irq_mask & isr )) {
255                         if( 0 != dev->ext->irq_func ) {
256                                 dev->ext->irq_func(dev, &isr);
257                         }
258                         isr &= ~dev->ext->irq_mask;
259                 }
260         }
261         if (0 != (isr & (MASK_27))) {
262                 DEB_INT(("irq: RPS0 (0x%08x).\n",isr));
263                 if( 0 != dev->vv_data && 0 != dev->vv_callback) {
264                         dev->vv_callback(dev,isr);
265                 }
266                 isr &= ~MASK_27;
267         }
268         if (0 != (isr & (MASK_28))) {
269                 if( 0 != dev->vv_data && 0 != dev->vv_callback) {
270                         dev->vv_callback(dev,isr);
271                 }
272                 isr &= ~MASK_28;
273         }
274         if (0 != (isr & (MASK_16|MASK_17))) {
275                 u32 status = saa7146_read(dev, I2C_STATUS);
276                 if( (0x3 == (status & 0x3)) || (0 == (status & 0x1)) ) {
277                         SAA7146_IER_DISABLE(dev, MASK_16|MASK_17);
278                         /* only wake up if we expect something */
279                         if( 0 != dev->i2c_op ) {
280                                 u32 psr = (saa7146_read(dev, PSR) >> 16) & 0x2;
281                                 u32 ssr = (saa7146_read(dev, SSR) >> 17) & 0x1f;
282                                 DEB_I2C(("irq: i2c, status: 0x%08x, psr:0x%02x, ssr:0x%02x).\n",status,psr,ssr));
283                                 dev->i2c_op = 0;
284                                 wake_up(&dev->i2c_wq);
285                         } else {
286                                 DEB_I2C(("unexpected irq: i2c, status: 0x%08x, isr %#x\n",status, isr));
287                         }
288                 } else {
289                         DEB_I2C(("unhandled irq: i2c, status: 0x%08x, isr %#x\n",status, isr));
290                 }
291                 isr &= ~(MASK_16|MASK_17);
292         }
293         if( 0 != isr ) {
294                 ERR(("warning: interrupt enabled, but not handled properly.(0x%08x)\n",isr));
295                 ERR(("disabling interrupt source(s)!\n"));
296                 SAA7146_IER_DISABLE(dev,isr);
297         }
298         return IRQ_HANDLED;
299 }
300
301 /*********************************************************************************/
302 /* configuration-functions                                                       */
303
304 static int saa7146_init_one(struct pci_dev *pci, const struct pci_device_id *ent)
305 {
306         struct saa7146_pci_extension_data *pci_ext = (struct saa7146_pci_extension_data *)ent->driver_data;
307         struct saa7146_extension *ext = pci_ext->ext;
308         struct saa7146_dev *dev;
309         int err = -ENOMEM;
310
311         dev = kmalloc(sizeof(struct saa7146_dev), GFP_KERNEL);
312         if (!dev) {
313                 ERR(("out of memory.\n"));
314                 goto out;
315         }
316
317         /* clear out mem for sure */
318         memset(dev, 0x0, sizeof(struct saa7146_dev));
319
320         DEB_EE(("pci:%p\n",pci));
321
322         err = pci_enable_device(pci);
323         if (err < 0) {
324                 ERR(("pci_enable_device() failed.\n"));
325                 goto err_free;
326         }
327
328         /* enable bus-mastering */
329         pci_set_master(pci);
330
331         dev->pci = pci;
332
333         /* get chip-revision; this is needed to enable bug-fixes */
334         err = pci_read_config_dword(pci, PCI_CLASS_REVISION, &dev->revision);
335         if (err < 0) {
336                 ERR(("pci_read_config_dword() failed.\n"));
337                 goto err_disable;
338         }
339         dev->revision &= 0xf;
340
341         /* remap the memory from virtual to physical adress */
342
343         err = pci_request_region(pci, 0, "saa7146");
344         if (err < 0)
345                 goto err_disable;
346
347         dev->mem = ioremap(pci_resource_start(pci, 0),
348                            pci_resource_len(pci, 0));
349         if (!dev->mem) {
350                 ERR(("ioremap() failed.\n"));
351                 err = -ENODEV;
352                 goto err_release;
353         }
354
355         /* we don't do a master reset here anymore, it screws up
356            some boards that don't have an i2c-eeprom for configuration
357            values */
358 /*
359         saa7146_write(dev, MC1, MASK_31);
360 */
361
362         /* disable all irqs */
363         saa7146_write(dev, IER, 0);
364
365         /* shut down all dma transfers and rps tasks */
366         saa7146_write(dev, MC1, 0x30ff0000);
367
368         /* clear out any rps-signals pending */
369         saa7146_write(dev, MC2, 0xf8000000);
370
371         /* request an interrupt for the saa7146 */
372         err = request_irq(pci->irq, interrupt_hw, SA_SHIRQ | SA_INTERRUPT,
373                           dev->name, dev);
374         if (err < 0) {
375                 ERR(("request_irq() failed.\n"));
376                 goto err_unmap;
377         }
378
379         err = -ENOMEM;
380
381         /* get memory for various stuff */
382         dev->d_rps0.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
383                                                     &dev->d_rps0.dma_handle);
384         if (!dev->d_rps0.cpu_addr)
385                 goto err_free_irq;
386         memset(dev->d_rps0.cpu_addr, 0x0, SAA7146_RPS_MEM);
387
388         dev->d_rps1.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
389                                                     &dev->d_rps1.dma_handle);
390         if (!dev->d_rps1.cpu_addr)
391                 goto err_free_rps0;
392         memset(dev->d_rps1.cpu_addr, 0x0, SAA7146_RPS_MEM);
393
394         dev->d_i2c.cpu_addr = pci_alloc_consistent(pci, SAA7146_RPS_MEM,
395                                                    &dev->d_i2c.dma_handle);
396         if (!dev->d_i2c.cpu_addr)
397                 goto err_free_rps1;
398         memset(dev->d_i2c.cpu_addr, 0x0, SAA7146_RPS_MEM);
399
400         /* the rest + print status message */
401
402         /* create a nice device name */
403         sprintf(dev->name, "saa7146 (%d)", saa7146_num);
404
405         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));
406         dev->ext = ext;
407
408         pci_set_drvdata(pci, dev);
409
410         init_MUTEX(&dev->lock);
411         spin_lock_init(&dev->int_slock);
412         spin_lock_init(&dev->slock);
413
414         init_MUTEX(&dev->i2c_lock);
415
416         dev->module = THIS_MODULE;
417         init_waitqueue_head(&dev->i2c_wq);
418
419         /* set some sane pci arbitrition values */
420         saa7146_write(dev, PCI_BT_V1, 0x1c00101f);
421
422         /* TODO: use the status code of the callback */
423
424         err = -ENODEV;
425
426         if (ext->probe && ext->probe(dev)) {
427                 DEB_D(("ext->probe() failed for %p. skipping device.\n",dev));
428                 goto err_free_i2c;
429         }
430
431         if (ext->attach(dev, pci_ext)) {
432                 DEB_D(("ext->attach() failed for %p. skipping device.\n",dev));
433                 goto err_unprobe;
434         }
435
436         INIT_LIST_HEAD(&dev->item);
437         list_add_tail(&dev->item,&saa7146_devices);
438         saa7146_num++;
439
440         err = 0;
441 out:
442         return err;
443
444 err_unprobe:
445         pci_set_drvdata(pci, NULL);
446 err_free_i2c:
447         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_i2c.cpu_addr,
448                             dev->d_i2c.dma_handle);
449 err_free_rps1:
450         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps1.cpu_addr,
451                             dev->d_rps1.dma_handle);
452 err_free_rps0:
453         pci_free_consistent(pci, SAA7146_RPS_MEM, dev->d_rps0.cpu_addr,
454                             dev->d_rps0.dma_handle);
455 err_free_irq:
456         free_irq(pci->irq, (void *)dev);
457 err_unmap:
458         iounmap(dev->mem);
459 err_release:
460         pci_release_region(pci, 0);
461 err_disable:
462         pci_disable_device(pci);
463 err_free:
464         kfree(dev);
465         goto out;
466 }
467
468 static void saa7146_remove_one(struct pci_dev *pdev)
469 {
470         struct saa7146_dev* dev = pci_get_drvdata(pdev);
471         struct {
472                 void *addr;
473                 dma_addr_t dma;
474         } dev_map[] = {
475                 { dev->d_i2c.cpu_addr, dev->d_i2c.dma_handle },
476                 { dev->d_rps1.cpu_addr, dev->d_rps1.dma_handle },
477                 { dev->d_rps0.cpu_addr, dev->d_rps0.dma_handle },
478                 { NULL, 0 }
479         }, *p;
480
481         DEB_EE(("dev:%p\n",dev));
482
483         dev->ext->detach(dev);
484
485         /* shut down all video dma transfers */
486         saa7146_write(dev, MC1, 0x00ff0000);
487
488         /* disable all irqs, release irq-routine */
489         saa7146_write(dev, IER, 0);
490
491         free_irq(pdev->irq, dev);
492
493         for (p = dev_map; p->addr; p++)
494                 pci_free_consistent(pdev, SAA7146_RPS_MEM, p->addr, p->dma);
495
496         iounmap(dev->mem);
497         pci_release_region(pdev, 0);
498         list_del(&dev->item);
499         pci_disable_device(pdev);
500         kfree(dev);
501
502         saa7146_num--;
503 }
504
505 /*********************************************************************************/
506 /* extension handling functions                                                  */
507
508 int saa7146_register_extension(struct saa7146_extension* ext)
509 {
510         DEB_EE(("ext:%p\n",ext));
511
512         ext->driver.name = ext->name;
513         ext->driver.id_table = ext->pci_tbl;
514         ext->driver.probe = saa7146_init_one;
515         ext->driver.remove = saa7146_remove_one;
516
517         printk("saa7146: register extension '%s'.\n",ext->name);
518         return pci_register_driver(&ext->driver);
519 }
520
521 int saa7146_unregister_extension(struct saa7146_extension* ext)
522 {
523         DEB_EE(("ext:%p\n",ext));
524         printk("saa7146: unregister extension '%s'.\n",ext->name);
525         pci_unregister_driver(&ext->driver);
526         return 0;
527 }
528
529 EXPORT_SYMBOL_GPL(saa7146_register_extension);
530 EXPORT_SYMBOL_GPL(saa7146_unregister_extension);
531
532 /* misc functions used by extension modules */
533 EXPORT_SYMBOL_GPL(saa7146_pgtable_alloc);
534 EXPORT_SYMBOL_GPL(saa7146_pgtable_free);
535 EXPORT_SYMBOL_GPL(saa7146_pgtable_build_single);
536 EXPORT_SYMBOL_GPL(saa7146_vmalloc_build_pgtable);
537 EXPORT_SYMBOL_GPL(saa7146_wait_for_debi_done);
538
539 EXPORT_SYMBOL_GPL(saa7146_setgpio);
540
541 EXPORT_SYMBOL_GPL(saa7146_i2c_transfer);
542 EXPORT_SYMBOL_GPL(saa7146_i2c_adapter_prepare);
543
544 EXPORT_SYMBOL_GPL(saa7146_debug);
545 EXPORT_SYMBOL_GPL(saa7146_devices);
546 EXPORT_SYMBOL_GPL(saa7146_devices_lock);
547
548 MODULE_AUTHOR("Michael Hunold <michael@mihu.de>");
549 MODULE_DESCRIPTION("driver for generic saa7146-based hardware");
550 MODULE_LICENSE("GPL");