Commit d2210f9e2e269975db413b8fe4de2f07e6a09b05

Authored by Hans Verkuil
Committed by Mauro Carvalho Chehab
1 parent 90d0fc4985

[media] Add vfl_dir field documentation

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

Showing 1 changed file with 9 additions and 1 deletions Side-by-side Diff

Documentation/video4linux/v4l2-framework.txt
... ... @@ -583,11 +583,19 @@
583 583  
584 584 - name: set to something descriptive and unique.
585 585  
  586 +- vfl_dir: set this to VFL_DIR_RX for capture devices (VFL_DIR_RX has value 0,
  587 + so this is normally already the default), set to VFL_DIR_TX for output
  588 + devices and VFL_DIR_M2M for mem2mem (codec) devices.
  589 +
586 590 - fops: set to the v4l2_file_operations struct.
587 591  
588 592 - ioctl_ops: if you use the v4l2_ioctl_ops to simplify ioctl maintenance
589 593 (highly recommended to use this and it might become compulsory in the
590   - future!), then set this to your v4l2_ioctl_ops struct.
  594 + future!), then set this to your v4l2_ioctl_ops struct. The vfl_type and
  595 + vfl_dir fields are used to disable ops that do not match the type/dir
  596 + combination. E.g. VBI ops are disabled for non-VBI nodes, and output ops
  597 + are disabled for a capture device. This makes it possible to provide
  598 + just one v4l2_ioctl_ops struct for both vbi and video nodes.
591 599  
592 600 - lock: leave to NULL if you want to do all the locking in the driver.
593 601 Otherwise you give it a pointer to a struct mutex_lock and before the