Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f6fa883b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: reorganize the kAPI v4l2 chapters 



Reorganize the order of the document, putting the chapters
on a more logical order and renaming some sections.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent f4a6bdd1

Documentation/media/kapi/v4l2-common.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
V4L2 common functions and data structures

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. kernel-doc:: include/media/v4l2-common.h

Documentation/media/kapi/v4l2-controls.rst

+2 −2
Original line number Diff line number Diff line
@@ -808,7 +808,7 @@ notify function is called. 
There can be only one notify function per control handler. Any attempt

to set another notify function will cause a WARN_ON.



V4L2 control kAPI

-----------------

v4l2_ctrl functions and data structures

---------------------------------------



.. kernel-doc:: include/media/v4l2-ctrls.h

Documentation/media/kapi/v4l2-core.rst

+6 −5
Original line number Diff line number Diff line
@@ -6,20 +6,21 @@ Video2Linux devices 


    v4l2-intro

    v4l2-dev

    v4l2-controls

    v4l2-device

    v4l2-fh

    v4l2-subdev

    v4l2-event

    v4l2-controls

    v4l2-videobuf

    v4l2-videobuf2

    v4l2-clocks

    v4l2-dv-timings

    v4l2-event

    v4l2-flash-led-class

    v4l2-mc

    v4l2-mediabus

    v4l2-mem2mem

    v4l2-of

    v4l2-rect

    v4l2-subdev

    v4l2-tuner

    v4l2-common

    v4l2-tveeprom
 
    v4l2-videobuf2

    v4l2-videobuf

Documentation/media/kapi/v4l2-dev.rst

+6 −6
Original line number Diff line number Diff line 
Video device creation

=====================

Video device' s internal representation

=======================================



The actual device nodes in the ``/dev`` directory are created using the

:c:type:`video_device` struct (``v4l2-dev.h``). This struct can either be
@@ -309,8 +309,8 @@ it has been initialized: 
This can be done from the release callback.





video_device helper functions

-----------------------------

helper functions

----------------



There are a few useful helper functions:
@@ -357,7 +357,7 @@ The name is used as a hint by userspace tools such as udev. The function 
should be used where possible instead of accessing the video_device::num and

video_device::minor fields.



video_device kAPI

-----------------

video_device functions and data structures

------------------------------------------



.. kernel-doc:: include/media/v4l2-dev.h

Documentation/media/kapi/v4l2-device.rst

+4 −4
Original line number Diff line number Diff line 
V4L2 Device register logic

--------------------------

V4L2 device instance

--------------------



Each device instance is represented by a struct :c:type:`v4l2_device`.

Very simple devices can just allocate this struct, but most of the time you
@@ -138,7 +138,7 @@ Since the initial refcount is 1 you also need to call 
or in the ``remove()`` callback (for e.g. PCI devices), otherwise the refcount

will never reach 0.



V4L2 device kAPI

^^^^^^^^^^^^^^^^

v4l2_device functions and data structures

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. kernel-doc:: include/media/v4l2-device.h