fedora core 6 1.2949 + vserver 2.2.0
[linux-2.6.git] / include / media / video-buf.h
index 3c17bdf..1115a25 100644 (file)
@@ -1,14 +1,20 @@
 /*
+ *
  * generic helper functions for video4linux capture buffers, to handle
- * memory management and PCI DMA.  Right now bttv + saa7134 use it.
+ * memory management and PCI DMA.
+ * Right now, bttv, saa7134, saa7146 and cx88 use it.
  *
  * The functions expect the hardware being able to scatter gatter
  * (i.e. the buffers are not linear in physical memory, but fragmented
  * into PAGE_SIZE chunks).  They also assume the driver does not need
- * to touch the video data (thus it is probably not useful for USB as
- * data often must be uncompressed by the drivers).
- * 
+ * to touch the video data.
+ *
+ * device specific map/unmap/sync stuff now are mapped as file operations
+ * to allow its usage by USB and virtual devices.
+ *
  * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
+ * (c) 2006 Mauro Carvalho Chehab, <mchehab@infradead.org>
+ * (c) 2006 Ted Walther and John Sokol
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -16,7 +22,8 @@
  * (at your option) any later version.
  */
 
-#include <linux/videodev.h>
+#include <linux/videodev2.h>
+#include <linux/poll.h>
 
 #define UNSET (-1U)
 
@@ -37,6 +44,9 @@ struct scatterlist* videobuf_vmalloc_to_sg(unsigned char *virt, int nr_pages);
 struct scatterlist* videobuf_pages_to_sg(struct page **pages, int nr_pages,
                                         int offset);
 
+struct videobuf_buffer;
+struct videobuf_queue;
+
 /* --------------------------------------------------------------------- */
 
 /*
@@ -48,7 +58,7 @@ struct scatterlist* videobuf_pages_to_sg(struct page **pages, int nr_pages,
  *     pointer + length.  The kernel version just wants the size and
  *     does memory allocation too using vmalloc_32().
  *
- * videobuf_dma_pci_*()
+ * videobuf_dma_*()
  *     see Documentation/DMA-mapping.txt, these functions to
  *     basically the same.  The map function does also build a
  *     scatterlist for the buffer (and unmap frees it ...)
@@ -85,12 +95,18 @@ int videobuf_dma_init_kernel(struct videobuf_dmabuf *dma, int direction,
                             int nr_pages);
 int videobuf_dma_init_overlay(struct videobuf_dmabuf *dma, int direction,
                              dma_addr_t addr, int nr_pages);
-int videobuf_dma_pci_map(struct pci_dev *dev, struct videobuf_dmabuf *dma);
-int videobuf_dma_pci_sync(struct pci_dev *dev,
-                         struct videobuf_dmabuf *dma);
-int videobuf_dma_pci_unmap(struct pci_dev *dev, struct videobuf_dmabuf *dma);
 int videobuf_dma_free(struct videobuf_dmabuf *dma);
 
+int videobuf_dma_map(struct videobuf_queue* q,struct videobuf_dmabuf *dma);
+int videobuf_dma_sync(struct videobuf_queue* q,struct videobuf_dmabuf *dma);
+int videobuf_dma_unmap(struct videobuf_queue* q,struct videobuf_dmabuf *dma);
+
+       /*FIXME: these variants are used only on *-alsa code, where videobuf is
+        * used without queue
+        */
+int videobuf_pci_dma_map(struct pci_dev *pci,struct videobuf_dmabuf *dma);
+int videobuf_pci_dma_unmap(struct pci_dev *pci,struct videobuf_dmabuf *dma);
+
 /* --------------------------------------------------------------------- */
 
 /*
@@ -100,7 +116,7 @@ int videobuf_dma_free(struct videobuf_dmabuf *dma);
  * functions, additionally some commonly used fields for v4l buffers
  * (width, height, lists, waitqueue) are in there.  That struct should
  * be used as first element in the drivers buffer struct.
- * 
+ *
  * about the mmap helpers (videobuf_mmap_*):
  *
  * The mmaper function allows to map any subset of contingous buffers.
@@ -114,12 +130,8 @@ int videobuf_dma_free(struct videobuf_dmabuf *dma);
  *
  */
 
-struct videobuf_buffer;
-struct videobuf_queue;
-
 struct videobuf_mapping {
        unsigned int count;
-       int highmem_ok;
        unsigned long start;
        unsigned long end;
        struct videobuf_queue *q;
@@ -164,19 +176,34 @@ struct videobuf_buffer {
        struct timeval          ts;
 };
 
+typedef int (vb_map_sg_t)(void *dev,struct scatterlist *sglist,int nr_pages,
+                                       int direction);
+
+
 struct videobuf_queue_ops {
-       int (*buf_setup)(struct file *file,
+       int (*buf_setup)(struct videobuf_queue *q,
                         unsigned int *count, unsigned int *size);
-       int (*buf_prepare)(struct file *file,struct videobuf_buffer *vb,
+       int (*buf_prepare)(struct videobuf_queue *q,
+                          struct videobuf_buffer *vb,
                           enum v4l2_field field);
-       void (*buf_queue)(struct file *file,struct videobuf_buffer *vb);
-       void (*buf_release)(struct file *file,struct videobuf_buffer *vb);
+       void (*buf_queue)(struct videobuf_queue *q,
+                         struct videobuf_buffer *vb);
+       void (*buf_release)(struct videobuf_queue *q,
+                           struct videobuf_buffer *vb);
+
+       /* Helper operations - device dependent.
+        * If null, videobuf_init defaults all to PCI handling
+        */
+
+       vb_map_sg_t     *vb_map_sg;
+       vb_map_sg_t     *vb_dma_sync_sg;
+       vb_map_sg_t     *vb_unmap_sg;
 };
 
 struct videobuf_queue {
-        struct semaphore           lock;
+       struct mutex               lock;
        spinlock_t                 *irqlock;
-       struct pci_dev             *pci;
+       void                       *dev; /* on pci, points to struct pci_dev */
 
        enum v4l2_buf_type         type;
        unsigned int               inputs; /* for V4L2_BUF_FLAG_INPUT */
@@ -194,52 +221,61 @@ struct videobuf_queue {
        unsigned int               reading;
        unsigned int               read_off;
        struct videobuf_buffer     *read_buf;
+
+       /* driver private data */
+       void                       *priv_data;
 };
 
 void* videobuf_alloc(unsigned int size);
 int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr);
-int videobuf_iolock(struct pci_dev *pci, struct videobuf_buffer *vb,
-                   struct v4l2_framebuffer *fbuf);
+int videobuf_iolock(struct videobuf_queue* q, struct videobuf_buffer *vb,
+               struct v4l2_framebuffer *fbuf);
+
+/* Maps fops to PCI stuff */
+void videobuf_queue_pci(struct videobuf_queue* q);
 
 void videobuf_queue_init(struct videobuf_queue *q,
                         struct videobuf_queue_ops *ops,
-                        struct pci_dev *pci, spinlock_t *irqlock,
+                        void *dev,
+                        spinlock_t *irqlock,
                         enum v4l2_buf_type type,
                         enum v4l2_field field,
-                        unsigned int msize);
+                        unsigned int msize,
+                        void *priv);
 int  videobuf_queue_is_busy(struct videobuf_queue *q);
-void videobuf_queue_cancel(struct file *file, struct videobuf_queue *q);
+void videobuf_queue_cancel(struct videobuf_queue *q);
 
 enum v4l2_field videobuf_next_field(struct videobuf_queue *q);
 void videobuf_status(struct v4l2_buffer *b, struct videobuf_buffer *vb,
                     enum v4l2_buf_type type);
-int videobuf_reqbufs(struct file *file, struct videobuf_queue *q,
+int videobuf_reqbufs(struct videobuf_queue *q,
                     struct v4l2_requestbuffers *req);
 int videobuf_querybuf(struct videobuf_queue *q, struct v4l2_buffer *b);
-int videobuf_qbuf(struct file *file, struct videobuf_queue *q,
+int videobuf_qbuf(struct videobuf_queue *q,
                  struct v4l2_buffer *b);
-int videobuf_dqbuf(struct file *file, struct videobuf_queue *q,
-                  struct v4l2_buffer *b);
-int videobuf_streamon(struct file *file, struct videobuf_queue *q);
-int videobuf_streamoff(struct file *file, struct videobuf_queue *q);
-
-int videobuf_read_start(struct file *file, struct videobuf_queue *q);
-void videobuf_read_stop(struct file *file, struct videobuf_queue *q);
-ssize_t videobuf_read_stream(struct file *file, struct videobuf_queue *q,
+int videobuf_dqbuf(struct videobuf_queue *q,
+                  struct v4l2_buffer *b, int nonblocking);
+int videobuf_streamon(struct videobuf_queue *q);
+int videobuf_streamoff(struct videobuf_queue *q);
+
+int videobuf_read_start(struct videobuf_queue *q);
+void videobuf_read_stop(struct videobuf_queue *q);
+ssize_t videobuf_read_stream(struct videobuf_queue *q,
                             char __user *data, size_t count, loff_t *ppos,
-                            int vbihack);
-ssize_t videobuf_read_one(struct file *file, struct videobuf_queue *q,
-                         char __user *data, size_t count, loff_t *ppos);
+                            int vbihack, int nonblocking);
+ssize_t videobuf_read_one(struct videobuf_queue *q,
+                         char __user *data, size_t count, loff_t *ppos,
+                         int nonblocking);
 unsigned int videobuf_poll_stream(struct file *file,
                                  struct videobuf_queue *q,
                                  poll_table *wait);
 
-int videobuf_mmap_setup(struct file *file, struct videobuf_queue *q,
+int videobuf_mmap_setup(struct videobuf_queue *q,
                        unsigned int bcount, unsigned int bsize,
                        enum v4l2_memory memory);
-int videobuf_mmap_free(struct file *file, struct videobuf_queue *q);
-int videobuf_mmap_mapper(struct vm_area_struct *vma,
-                        struct videobuf_queue *q);
+int videobuf_mmap_free(struct videobuf_queue *q);
+int videobuf_mmap_mapper(struct videobuf_queue *q,
+                        struct vm_area_struct *vma);
 
 /* --------------------------------------------------------------------- */