blob: 2ff7fcc77b1104fe7d1ca1a2a9d5738ede27acb7 [file] [log] [blame]
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -03001/*
2 * helper functions for vmalloc video4linux capture buffers
3 *
Magnus Damm5d6aaf52008-07-16 21:27:49 -03004 * The functions expect the hardware being able to scatter gather
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -03005 * (i.e. the buffers are not linear in physical memory, but fragmented
6 * into PAGE_SIZE chunks). They also assume the driver does not need
7 * to touch the video data.
8 *
9 * (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2
14 */
15
16#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/moduleparam.h>
19#include <linux/slab.h>
20#include <linux/interrupt.h>
21
22#include <linux/pci.h>
23#include <linux/vmalloc.h>
24#include <linux/pagemap.h>
25#include <asm/page.h>
26#include <asm/pgtable.h>
27
28#include <media/videobuf-vmalloc.h>
29
30#define MAGIC_DMABUF 0x17760309
31#define MAGIC_VMAL_MEM 0x18221223
32
Pawel Osciak7a022642010-03-17 04:01:04 -030033#define MAGIC_CHECK(is, should) \
34 if (unlikely((is) != (should))) { \
35 printk(KERN_ERR "magic mismatch: %x (expected %x)\n", \
36 is, should); \
37 BUG(); \
38 }
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030039
Douglas Schilling Landgrafff699e62008-04-22 14:41:48 -030040static int debug;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030041module_param(debug, int, 0644);
42
43MODULE_DESCRIPTION("helper module to manage video4linux vmalloc buffers");
44MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
45MODULE_LICENSE("GPL");
46
Pawel Osciak7a022642010-03-17 04:01:04 -030047#define dprintk(level, fmt, arg...) \
48 if (debug >= level) \
49 printk(KERN_DEBUG "vbuf-vmalloc: " fmt , ## arg)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030050
51
52/***************************************************************************/
53
Pawel Osciak7a022642010-03-17 04:01:04 -030054static void videobuf_vm_open(struct vm_area_struct *vma)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030055{
56 struct videobuf_mapping *map = vma->vm_private_data;
57
Pawel Osciak7a022642010-03-17 04:01:04 -030058 dprintk(2, "vm_open %p [count=%u,vma=%08lx-%08lx]\n", map,
59 map->count, vma->vm_start, vma->vm_end);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030060
61 map->count++;
62}
63
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -030064static void videobuf_vm_close(struct vm_area_struct *vma)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030065{
66 struct videobuf_mapping *map = vma->vm_private_data;
67 struct videobuf_queue *q = map->q;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030068 int i;
69
Pawel Osciak7a022642010-03-17 04:01:04 -030070 dprintk(2, "vm_close %p [count=%u,vma=%08lx-%08lx]\n", map,
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -030071 map->count, vma->vm_start, vma->vm_end);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030072
Hans Verkuilcca36e22014-01-03 08:10:49 -030073 map->count--;
74 if (0 == map->count) {
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -030075 struct videobuf_vmalloc_memory *mem;
76
77 dprintk(1, "munmap %p q=%p\n", map, q);
Hans Verkuilcca36e22014-01-03 08:10:49 -030078 videobuf_queue_lock(q);
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -030079
80 /* We need first to cancel streams, before unmapping */
81 if (q->streaming)
82 videobuf_queue_cancel(q);
83
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030084 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
85 if (NULL == q->bufs[i])
86 continue;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030087
Mauro Carvalho Chehab851c0c92007-09-27 18:25:44 -030088 if (q->bufs[i]->map != map)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -030089 continue;
Mauro Carvalho Chehab123f8ef2007-09-06 20:11:35 -030090
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -030091 mem = q->bufs[i]->priv;
92 if (mem) {
93 /* This callback is called only if kernel has
94 allocated memory and this memory is mmapped.
95 In this case, memory should be freed,
96 in order to do memory unmap.
97 */
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -030098
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -030099 MAGIC_CHECK(mem->magic, MAGIC_VMAL_MEM);
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300100
101 /* vfree is not atomic - can't be
102 called with IRQ's disabled
103 */
104 dprintk(1, "%s: buf[%d] freeing (%p)\n",
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300105 __func__, i, mem->vaddr);
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300106
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300107 vfree(mem->vaddr);
108 mem->vaddr = NULL;
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -0300109 }
110
Mauro Carvalho Chehab851c0c92007-09-27 18:25:44 -0300111 q->bufs[i]->map = NULL;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300112 q->bufs[i]->baddr = 0;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300113 }
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300114
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300115 kfree(map);
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300116
Hans Verkuilcca36e22014-01-03 08:10:49 -0300117 videobuf_queue_unlock(q);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300118 }
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300119
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300120 return;
121}
122
Pawel Osciak7a022642010-03-17 04:01:04 -0300123static const struct vm_operations_struct videobuf_vm_ops = {
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300124 .open = videobuf_vm_open,
125 .close = videobuf_vm_close,
126};
127
128/* ---------------------------------------------------------------------
129 * vmalloc handlers for the generic methods
130 */
131
132/* Allocated area consists on 3 parts:
133 struct video_buffer
134 struct <driver>_buffer (cx88_buffer, saa7134_buf, ...)
Guennadi Liakhovetski07051352008-04-22 14:42:13 -0300135 struct videobuf_dma_sg_memory
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300136 */
137
Pawel Osciak33c38282010-05-11 10:36:28 -0300138static struct videobuf_buffer *__videobuf_alloc_vb(size_t size)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300139{
Brandon Philips384b8352008-02-04 20:52:21 -0300140 struct videobuf_vmalloc_memory *mem;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300141 struct videobuf_buffer *vb;
142
Pawel Osciak7a022642010-03-17 04:01:04 -0300143 vb = kzalloc(size + sizeof(*mem), GFP_KERNEL);
Pawel Osciakbee527f2010-02-22 13:10:06 -0300144 if (!vb)
145 return vb;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300146
Pawel Osciak7a022642010-03-17 04:01:04 -0300147 mem = vb->priv = ((char *)vb) + size;
148 mem->magic = MAGIC_VMAL_MEM;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300149
Pawel Osciak7a022642010-03-17 04:01:04 -0300150 dprintk(1, "%s: allocated at %p(%ld+%ld) & %p(%ld)\n",
151 __func__, vb, (long)sizeof(*vb), (long)size - sizeof(*vb),
152 mem, (long)sizeof(*mem));
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300153
154 return vb;
155}
156
Pawel Osciak7a022642010-03-17 04:01:04 -0300157static int __videobuf_iolock(struct videobuf_queue *q,
158 struct videobuf_buffer *vb,
159 struct v4l2_framebuffer *fbuf)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300160{
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300161 struct videobuf_vmalloc_memory *mem = vb->priv;
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300162 int pages;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300163
164 BUG_ON(!mem);
165
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300166 MAGIC_CHECK(mem->magic, MAGIC_VMAL_MEM);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300167
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300168 switch (vb->memory) {
169 case V4L2_MEMORY_MMAP:
170 dprintk(1, "%s memory method MMAP\n", __func__);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300171
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300172 /* All handling should be done by __videobuf_mmap_mapper() */
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300173 if (!mem->vaddr) {
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300174 printk(KERN_ERR "memory is not alloced/mmapped.\n");
175 return -EINVAL;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300176 }
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300177 break;
178 case V4L2_MEMORY_USERPTR:
Mauro Carvalho Chehabaa9479e2008-04-13 15:07:56 -0300179 pages = PAGE_ALIGN(vb->size);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300180
181 dprintk(1, "%s memory method USERPTR\n", __func__);
182
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300183 if (vb->baddr) {
184 printk(KERN_ERR "USERPTR is currently not supported\n");
185 return -EINVAL;
186 }
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300187
188 /* The only USERPTR currently supported is the one needed for
Pawel Osciak7a022642010-03-17 04:01:04 -0300189 * read() method.
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300190 */
191
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300192 mem->vaddr = vmalloc_user(pages);
193 if (!mem->vaddr) {
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300194 printk(KERN_ERR "vmalloc (%d pages) failed\n", pages);
195 return -ENOMEM;
196 }
197 dprintk(1, "vmalloc is at addr %p (%d pages)\n",
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300198 mem->vaddr, pages);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300199
200#if 0
201 int rc;
202 /* Kernel userptr is used also by read() method. In this case,
203 there's no need to remap, since data will be copied to user
204 */
205 if (!vb->baddr)
206 return 0;
207
208 /* FIXME: to properly support USERPTR, remap should occur.
Hans Verkuilde1e5752008-07-26 08:37:58 -0300209 The code below won't work, since mem->vma = NULL
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300210 */
211 /* Try to remap memory */
212 rc = remap_vmalloc_range(mem->vma, (void *)vb->baddr, 0);
213 if (rc < 0) {
Pawel Osciak7a022642010-03-17 04:01:04 -0300214 printk(KERN_ERR "mmap: remap failed with error %d", rc);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300215 return -ENOMEM;
216 }
217#endif
218
219 break;
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300220 case V4L2_MEMORY_OVERLAY:
221 default:
222 dprintk(1, "%s memory method OVERLAY/unknown\n", __func__);
223
224 /* Currently, doesn't support V4L2_MEMORY_OVERLAY */
225 printk(KERN_ERR "Memory method currently unsupported.\n");
226 return -EINVAL;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300227 }
228
229 return 0;
230}
231
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300232static int __videobuf_mmap_mapper(struct videobuf_queue *q,
Hans Verkuil0b62b732010-03-28 09:09:05 -0300233 struct videobuf_buffer *buf,
234 struct vm_area_struct *vma)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300235{
Brandon Philips384b8352008-02-04 20:52:21 -0300236 struct videobuf_vmalloc_memory *mem;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300237 struct videobuf_mapping *map;
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300238 int retval, pages;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300239
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300240 dprintk(1, "%s\n", __func__);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300241
242 /* create mapping + update buffer list */
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300243 map = kzalloc(sizeof(struct videobuf_mapping), GFP_KERNEL);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300244 if (NULL == map)
245 return -ENOMEM;
246
Hans Verkuil0b62b732010-03-28 09:09:05 -0300247 buf->map = map;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300248 map->q = q;
249
Hans Verkuil0b62b732010-03-28 09:09:05 -0300250 buf->baddr = vma->vm_start;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300251
Hans Verkuil0b62b732010-03-28 09:09:05 -0300252 mem = buf->priv;
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300253 BUG_ON(!mem);
254 MAGIC_CHECK(mem->magic, MAGIC_VMAL_MEM);
255
256 pages = PAGE_ALIGN(vma->vm_end - vma->vm_start);
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300257 mem->vaddr = vmalloc_user(pages);
258 if (!mem->vaddr) {
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300259 printk(KERN_ERR "vmalloc (%d pages) failed\n", pages);
260 goto error;
261 }
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300262 dprintk(1, "vmalloc is at addr %p (%d pages)\n", mem->vaddr, pages);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300263
264 /* Try to remap memory */
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300265 retval = remap_vmalloc_range(vma, mem->vaddr, 0);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300266 if (retval < 0) {
267 printk(KERN_ERR "mmap: remap failed with error %d. ", retval);
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300268 vfree(mem->vaddr);
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300269 goto error;
270 }
271
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300272 vma->vm_ops = &videobuf_vm_ops;
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -0700273 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300274 vma->vm_private_data = map;
275
Pawel Osciak7a022642010-03-17 04:01:04 -0300276 dprintk(1, "mmap %p: q=%p %08lx-%08lx (%lx) pgoff %08lx buf %d\n",
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300277 map, q, vma->vm_start, vma->vm_end,
Hans Verkuil0b62b732010-03-28 09:09:05 -0300278 (long int)buf->bsize,
279 vma->vm_pgoff, buf->i);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300280
281 videobuf_vm_open(vma);
282
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300283 return 0;
284
285error:
286 mem = NULL;
287 kfree(map);
288 return -ENOMEM;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300289}
290
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300291static struct videobuf_qtype_ops qops = {
292 .magic = MAGIC_QTYPE_OPS,
293
Pawel Osciak33c38282010-05-11 10:36:28 -0300294 .alloc_vb = __videobuf_alloc_vb,
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300295 .iolock = __videobuf_iolock,
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300296 .mmap_mapper = __videobuf_mmap_mapper,
Hans Verkuil037c75e2010-03-28 08:18:37 -0300297 .vaddr = videobuf_to_vmalloc,
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300298};
299
Pawel Osciak7a022642010-03-17 04:01:04 -0300300void videobuf_queue_vmalloc_init(struct videobuf_queue *q,
Jonathan Corbet38a54f32009-11-17 19:43:41 -0300301 const struct videobuf_queue_ops *ops,
Jonathan Corbetf8b0bca2009-11-23 14:29:35 -0300302 struct device *dev,
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300303 spinlock_t *irqlock,
304 enum v4l2_buf_type type,
305 enum v4l2_field field,
306 unsigned int msize,
Hans Verkuil08bff032010-09-20 17:39:46 -0300307 void *priv,
308 struct mutex *ext_lock)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300309{
Mauro Carvalho Chehabd4cae5a2007-10-08 12:20:02 -0300310 videobuf_queue_core_init(q, ops, dev, irqlock, type, field, msize,
Hans Verkuil08bff032010-09-20 17:39:46 -0300311 priv, &qops, ext_lock);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300312}
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300313EXPORT_SYMBOL_GPL(videobuf_queue_vmalloc_init);
314
Pawel Osciak7a022642010-03-17 04:01:04 -0300315void *videobuf_to_vmalloc(struct videobuf_buffer *buf)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300316{
Pawel Osciak7a022642010-03-17 04:01:04 -0300317 struct videobuf_vmalloc_memory *mem = buf->priv;
318 BUG_ON(!mem);
319 MAGIC_CHECK(mem->magic, MAGIC_VMAL_MEM);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300320
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300321 return mem->vaddr;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300322}
323EXPORT_SYMBOL_GPL(videobuf_to_vmalloc);
324
Pawel Osciak7a022642010-03-17 04:01:04 -0300325void videobuf_vmalloc_free(struct videobuf_buffer *buf)
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300326{
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300327 struct videobuf_vmalloc_memory *mem = buf->priv;
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300328
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -0300329 /* mmapped memory can't be freed here, otherwise mmapped region
330 would be released, while still needed. In this case, the memory
331 release should happen inside videobuf_vm_close().
332 So, it should free memory only if the memory were allocated for
333 read() operation.
334 */
Mauro Carvalho Chehab5993a662009-01-23 21:35:12 -0300335 if ((buf->memory != V4L2_MEMORY_USERPTR) || buf->baddr)
Mauro Carvalho Chehabaaea56a2008-04-13 14:58:43 -0300336 return;
337
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300338 if (!mem)
339 return;
340
341 MAGIC_CHECK(mem->magic, MAGIC_VMAL_MEM);
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300342
Laurent Pinchartbb6dbe72010-05-11 10:36:34 -0300343 vfree(mem->vaddr);
344 mem->vaddr = NULL;
Mauro Carvalho Chehab968ced72008-04-13 14:58:21 -0300345
Mauro Carvalho Chehab87b9ad02007-08-02 23:31:33 -0300346 return;
347}
348EXPORT_SYMBOL_GPL(videobuf_vmalloc_free);
349