Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[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: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+51 -62
+4
Documentation/media/kapi/v4l2-common.rst
··· 1 + V4L2 common functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 + 4 + .. kernel-doc:: include/media/v4l2-common.h
+2 -2
Documentation/media/kapi/v4l2-controls.rst
··· 808 808 There can be only one notify function per control handler. Any attempt 809 809 to set another notify function will cause a WARN_ON. 810 810 811 - V4L2 control kAPI 812 - ----------------- 811 + v4l2_ctrl functions and data structures 812 + --------------------------------------- 813 813 814 814 .. kernel-doc:: include/media/v4l2-ctrls.h
+6 -5
Documentation/media/kapi/v4l2-core.rst
··· 6 6 7 7 v4l2-intro 8 8 v4l2-dev 9 - v4l2-controls 10 9 v4l2-device 11 10 v4l2-fh 11 + v4l2-subdev 12 + v4l2-event 13 + v4l2-controls 14 + v4l2-videobuf 15 + v4l2-videobuf2 12 16 v4l2-clocks 13 17 v4l2-dv-timings 14 - v4l2-event 15 18 v4l2-flash-led-class 16 19 v4l2-mc 17 20 v4l2-mediabus 18 21 v4l2-mem2mem 19 22 v4l2-of 20 23 v4l2-rect 21 - v4l2-subdev 22 24 v4l2-tuner 25 + v4l2-common 23 26 v4l2-tveeprom 24 - v4l2-videobuf2 25 - v4l2-videobuf
+6 -6
Documentation/media/kapi/v4l2-dev.rst
··· 1 - Video device creation 2 - ===================== 1 + Video device' s internal representation 2 + ======================================= 3 3 4 4 The actual device nodes in the ``/dev`` directory are created using the 5 5 :c:type:`video_device` struct (``v4l2-dev.h``). This struct can either be ··· 309 309 This can be done from the release callback. 310 310 311 311 312 - video_device helper functions 313 - ----------------------------- 312 + helper functions 313 + ---------------- 314 314 315 315 There are a few useful helper functions: 316 316 ··· 357 357 should be used where possible instead of accessing the video_device::num and 358 358 video_device::minor fields. 359 359 360 - video_device kAPI 361 - ----------------- 360 + video_device functions and data structures 361 + ------------------------------------------ 362 362 363 363 .. kernel-doc:: include/media/v4l2-dev.h
+4 -4
Documentation/media/kapi/v4l2-device.rst
··· 1 - V4L2 Device register logic 2 - -------------------------- 1 + V4L2 device instance 2 + -------------------- 3 3 4 4 Each device instance is represented by a struct :c:type:`v4l2_device`. 5 5 Very simple devices can just allocate this struct, but most of the time you ··· 138 138 or in the ``remove()`` callback (for e.g. PCI devices), otherwise the refcount 139 139 will never reach 0. 140 140 141 - V4L2 device kAPI 142 - ^^^^^^^^^^^^^^^^ 141 + v4l2_device functions and data structures 142 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 143 143 144 144 .. kernel-doc:: include/media/v4l2-device.h
+2 -2
Documentation/media/kapi/v4l2-dv-timings.rst
··· 1 - V4L2 DV Timings kAPI 2 - ^^^^^^^^^^^^^^^^^^^^ 1 + V4L2 DV Timings functions 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/v4l2-dv-timings.h
+3 -2
Documentation/media/kapi/v4l2-event.rst
··· 130 130 the subdev that sends the event to the video node(s) associated with the 131 131 subdev that need to be informed about such an event. 132 132 133 - V4L2 event kAPI 134 - ^^^^^^^^^^^^^^^ 133 + V4L2 event functions and data structures 134 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 135 135 136 136 .. kernel-doc:: include/media/v4l2-event.h 137 +
+3 -2
Documentation/media/kapi/v4l2-fh.rst
··· 133 133 - Same, but it calls v4l2_fh_is_singular with filp->private_data. 134 134 135 135 136 - V4L2 File Handler kAPI 137 - ^^^^^^^^^^^^^^^^^^^^^^ 136 + V4L2 fh functions and data structures 137 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 138 + 138 139 .. kernel-doc:: include/media/v4l2-fh.h
+2 -2
Documentation/media/kapi/v4l2-flash-led-class.rst
··· 1 - V4L2 Flash and LED class kAPI 2 - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1 + V4L2 flash functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/v4l2-flash-led-class.h
+4 -11
Documentation/media/kapi/v4l2-intro.rst
··· 1 - Overview of the V4L2 driver framework 2 - ===================================== 3 - 4 - This text documents the various structures provided by the V4L2 framework and 5 - their relationships. 6 - 7 - 8 1 Introduction 9 2 ------------ 10 3 ··· 32 39 a PCI capture card, and demonstrates how to use the V4L2 driver 33 40 framework. It can be used as a template for real PCI video capture driver. 34 41 35 - Structure of a driver 36 - --------------------- 42 + Structure of a V4L driver 43 + ------------------------- 37 44 38 45 All drivers have the following structure: 39 46 ··· 61 68 \-filehandle instances 62 69 63 70 64 - Structure of the framework 65 - -------------------------- 71 + Structure of the V4L2 framework 72 + ------------------------------- 66 73 67 74 The framework closely resembles the driver structure: it has a v4l2_device 68 75 struct for the device instance data, a v4l2_subdev struct to refer to
+2 -2
Documentation/media/kapi/v4l2-mc.rst
··· 1 - V4L2 Media Controller kAPI 2 - ^^^^^^^^^^^^^^^^^^^^^^^^^^ 1 + V4L2 Media Controller functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/v4l2-mc.h
+2 -2
Documentation/media/kapi/v4l2-mediabus.rst
··· 1 - V4L2 Media Bus kAPI 2 - ^^^^^^^^^^^^^^^^^^^ 1 + V4L2 Media Bus functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/v4l2-mediabus.h
+3 -2
Documentation/media/kapi/v4l2-mem2mem.rst
··· 1 - V4L2 Memory to Memory kAPI 2 - ^^^^^^^^^^^^^^^^^^^^^^^^^^ 1 + V4L2 Memory to Memory functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 + 3 4 .. kernel-doc:: include/media/v4l2-mem2mem.h
+2 -2
Documentation/media/kapi/v4l2-rect.rst
··· 1 - V4L2 rect kAPI 2 - ^^^^^^^^^^^^^^ 1 + V4L2 rect helper functions 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/v4l2-rect.h
-12
Documentation/media/kapi/v4l2-subdev.rst
··· 440 440 V4L2 sub-device functions and data structures 441 441 --------------------------------------------- 442 442 443 - V4L2 sub-device kAPI 444 - ^^^^^^^^^^^^^^^^^^^^ 445 - 446 443 .. kernel-doc:: include/media/v4l2-subdev.h 447 444 448 - V4L2 sub-device asynchronous kAPI 449 - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 450 - 451 445 .. kernel-doc:: include/media/v4l2-async.h 452 - 453 - 454 - V4L2 common kAPI 455 - ^^^^^^^^^^^^^^^^ 456 - 457 - .. kernel-doc:: include/media/v4l2-common.h
+2 -2
Documentation/media/kapi/v4l2-tuner.rst
··· 1 - Tuner kAPI 2 - ^^^^^^^^^^ 1 + Tuner functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/tuner.h 5 5
+2 -2
Documentation/media/kapi/v4l2-tveeprom.rst
··· 1 - Hauppauge TV EEPROM kAPI 2 - ^^^^^^^^^^^^^^^^^^^^^^^^ 1 + Hauppauge TV EEPROM functions and data structures 2 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 3 4 4 .. kernel-doc:: include/media/tveeprom.h
+2 -2
Documentation/media/kapi/v4l2-videobuf2.rst
··· 1 1 .. _vb2_framework: 2 2 3 - V4L2 videobuf2 kAPI 4 - ^^^^^^^^^^^^^^^^^^^ 3 + V4L2 videobuf2 functions and data structures 4 + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 5 5 6 6 .. kernel-doc:: include/media/videobuf2-core.h 7 7