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

[media] doc-rst: use the right markup for footnotes

According with ReST spec, footnotes should be like:
[#name], and not [name]. So, change them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+94 -94
+2 -2
Documentation/media/uapi/v4l/audio.rst
··· 11 11 each. Radio devices have no audio inputs or outputs. They have exactly 12 12 one tuner which in fact *is* an audio source, but this API associates 13 13 tuners with video inputs or outputs only, and radio devices have none of 14 - these. [1]_ A connector on a TV card to loop back the received audio 14 + these. [#f1]_ A connector on a TV card to loop back the received audio 15 15 signal to a sound card is not considered an audio output. 16 16 17 17 Audio and video inputs and outputs are associated. Selecting a video ··· 88 88 exit(EXIT_FAILURE); 89 89 } 90 90 91 - .. [1] 91 + .. [#f1] 92 92 Actually struct :ref:`v4l2_audio <v4l2-audio>` ought to have a 93 93 ``tuner`` field like struct :ref:`v4l2_input <v4l2-input>`, not 94 94 only making the API more consistent but also permitting radio devices
+2 -2
Documentation/media/uapi/v4l/control.rst
··· 17 17 18 18 All controls are accessed using an ID value. V4L2 defines several IDs 19 19 for specific purposes. Drivers can also implement their own custom 20 - controls using ``V4L2_CID_PRIVATE_BASE`` [1]_ and higher values. The 20 + controls using ``V4L2_CID_PRIVATE_BASE`` [#f1]_ and higher values. The 21 21 pre-defined control IDs have the prefix ``V4L2_CID_``, and are listed in 22 22 :ref:`control-id`. The ID is used when querying the attributes of a 23 23 control, and when getting or setting the current value. ··· 522 522 /* Errors ignored */ 523 523 ioctl(fd, VIDIOC_S_CTRL, &control); 524 524 525 - .. [1] 525 + .. [#f1] 526 526 The use of ``V4L2_CID_PRIVATE_BASE`` is problematic because different 527 527 drivers may use the same ``V4L2_CID_PRIVATE_BASE`` ID for different 528 528 controls. This makes it hard to programatically set such controls
+8 -8
Documentation/media/uapi/v4l/dev-overlay.rst
··· 33 33 overlay. This must be supported by all drivers capable of simultaneous 34 34 capturing and overlay. Optionally these drivers may also permit 35 35 capturing and overlay with a single file descriptor for compatibility 36 - with V4L and earlier versions of V4L2. [1]_ 36 + with V4L and earlier versions of V4L2. [#f1]_ 37 37 38 38 39 39 Querying Capabilities ··· 216 216 217 217 ((__u8 *) bitmap)[w.width * y + x / 8] & (1 << (x & 7)) 218 218 219 - where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_ 219 + where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [#f2]_ 220 220 221 221 When a clipping bit mask is not supported the driver ignores this field, 222 222 its contents after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are ··· 227 227 both, or despite negotiating chroma-keying, the results are undefined. 228 228 Regardless of the chosen method, the clipping abilities of the hardware 229 229 may be limited in quantity or quality. The results when these limits are 230 - exceeded are undefined. [3]_ 230 + exceeded are undefined. [#f3]_ 231 231 232 232 ``__u8 global_alpha`` 233 233 The global alpha value used to blend the framebuffer with video ··· 244 244 245 245 .. _v4l2-clip: 246 246 247 - struct v4l2_clip [4]_ 247 + struct v4l2_clip [#f4]_ 248 248 --------------------- 249 249 250 250 ``struct v4l2_rect c`` ··· 284 284 To start or stop the frame buffer overlay applications call the 285 285 :ref:`VIDIOC_OVERLAY` ioctl. 286 286 287 - .. [1] 287 + .. [#f1] 288 288 A common application of two file descriptors is the XFree86 289 289 :ref:`Xv/V4L <xvideo>` interface driver and a V4L2 application. 290 290 While the X server controls video overlay, the application can take ··· 301 301 Hence as a complexity trade-off drivers *must* support two file 302 302 descriptors and *may* support single fd operation. 303 303 304 - .. [2] 304 + .. [#f2] 305 305 Should we require ``w.width`` to be a multiple of eight? 306 306 307 - .. [3] 307 + .. [#f3] 308 308 When the image is written into frame buffer memory it will be 309 309 undesirable if the driver clips out less pixels than expected, 310 310 because the application and graphics system are not aware these 311 311 regions need to be refreshed. The driver should clip out more pixels 312 312 or not write the image at all. 313 313 314 - .. [4] 314 + .. [#f4] 315 315 The X Window system defines "regions" which are vectors of ``struct 316 316 BoxRec { short x1, y1, x2, y2; }`` with ``width = x2 - x1`` and 317 317 ``height = y2 - y1``, so one cannot pass X11 clip lists directly.
+9 -9
Documentation/media/uapi/v4l/dev-raw-vbi.rst
··· 11 11 information is transmitted, allowing some time while the electron beam 12 12 of a cathode ray tube TV returns to the top of the screen. Using an 13 13 oscilloscope you will find here the vertical synchronization pulses and 14 - short data packages ASK modulated [1]_ onto the video signal. These are 14 + short data packages ASK modulated [#f1]_ onto the video signal. These are 15 15 transmissions of services such as Teletext or Closed Caption. 16 16 17 17 Subject of this interface type is raw VBI data, as sampled off a video ··· 143 143 - ``sample_format`` 144 144 145 145 - Defines the sample format as in :ref:`pixfmt`, a 146 - four-character-code. [2]_ Usually this is ``V4L2_PIX_FMT_GREY``, 146 + four-character-code. [#f2]_ Usually this is ``V4L2_PIX_FMT_GREY``, 147 147 i. e. each sample consists of 8 bits with lower values oriented 148 148 towards the black level. Do not assume any other correlation of 149 149 values with the signal level. For example, the MSB does not ··· 155 155 156 156 - __u32 157 157 158 - - ``start``\ [2]_ 158 + - ``start``\ [#f2]_ 159 159 160 160 - This is the scanning system line number associated with the first 161 161 line of the VBI image, of the first and the second field ··· 173 173 174 174 - __u32 175 175 176 - - ``count``\ [2]_ 176 + - ``count``\ [#f2]_ 177 177 178 178 - The number of lines in the first and second field image, 179 179 respectively. ··· 218 218 219 219 - __u32 220 220 221 - - ``reserved``\ [2]_ 221 + - ``reserved``\ [#f2]_ 222 222 223 223 - This array is reserved for future extensions. Drivers and 224 224 applications must set it to zero. ··· 245 245 or bottom field depending on the video standard. When this flag is 246 246 set the first or second field may be stored first, however the 247 247 fields are still in correct temporal order with the older field 248 - first in memory. [3]_ 248 + first in memory. [#f3]_ 249 249 250 250 - .. row 2 251 251 ··· 336 336 are temporarily unavailable, for example the device is already in use by 337 337 another process. 338 338 339 - .. [1] 339 + .. [#f1] 340 340 ASK: Amplitude-Shift Keying. A high signal level represents a '1' 341 341 bit, a low level a '0' bit. 342 342 343 - .. [2] 343 + .. [#f2] 344 344 A few devices may be unable to sample VBI data at all but can extend 345 345 the video capture window to the VBI region. 346 346 347 - .. [3] 347 + .. [#f3] 348 348 Most VBI services transmit on both fields, but some have different 349 349 semantics depending on the field number. These cannot be reliable 350 350 decoded or encoded when ``V4L2_VBI_UNSYNC`` is set.
+2 -2
Documentation/media/uapi/v4l/dev-sliced-vbi.rst
··· 126 126 specified in this field. For example, if ``service_set`` is 127 127 initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``, 128 128 a driver for the cx25840 video decoder sets lines 7-22 of both 129 - fields [1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first 129 + fields [#f1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first 130 130 field to ``V4L2_SLICED_WSS_625``. If ``service_set`` is set to 131 131 zero, then the values of ``service_lines`` will be used instead. 132 132 ··· 817 817 818 818 819 819 820 - .. [1] 820 + .. [#f1] 821 821 According to :ref:`ETS 300 706 <ets300706>` lines 6-22 of the first 822 822 field and lines 5-22 of the second field may carry Teletext data.
+18 -18
Documentation/media/uapi/v4l/diff-v4l.rst
··· 52 52 53 53 - Video capture and overlay 54 54 55 - - ``/dev/video`` and ``/dev/bttv0``\ [1]_, ``/dev/video0`` to 55 + - ``/dev/video`` and ``/dev/bttv0``\ [#f1]_, ``/dev/video0`` to 56 56 ``/dev/video63`` 57 57 58 58 - 0-63 ··· 61 61 62 62 - Radio receiver 63 63 64 - - ``/dev/radio``\ [2]_, ``/dev/radio0`` to ``/dev/radio63`` 64 + - ``/dev/radio``\ [#f2]_, ``/dev/radio0`` to ``/dev/radio63`` 65 65 66 66 - 64-127 67 67 ··· 457 457 458 458 - ``VIDEO_PALETTE_HI240`` 459 459 460 - - :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [3]_ 460 + - :ref:`V4L2_PIX_FMT_HI240 <pixfmt-reserved>` [#f3]_ 461 461 462 462 - .. row 4 463 463 ··· 481 481 482 482 - ``VIDEO_PALETTE_RGB32`` 483 483 484 - - :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [4]_ 484 + - :ref:`V4L2_PIX_FMT_BGR32 <pixfmt-rgb>` [#f4]_ 485 485 486 486 - .. row 8 487 487 ··· 491 491 492 492 - .. row 9 493 493 494 - - ``VIDEO_PALETTE_YUYV``\ [5]_ 494 + - ``VIDEO_PALETTE_YUYV``\ [#f5]_ 495 495 496 496 - :ref:`V4L2_PIX_FMT_YUYV <V4L2-PIX-FMT-YUYV>` 497 497 ··· 511 511 512 512 - ``VIDEO_PALETTE_YUV411`` 513 513 514 - - :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [6]_ 514 + - :ref:`V4L2_PIX_FMT_Y41P <V4L2-PIX-FMT-Y41P>` [#f6]_ 515 515 516 516 - .. row 13 517 517 518 518 - ``VIDEO_PALETTE_RAW`` 519 519 520 - - None [7]_ 520 + - None [#f7]_ 521 521 522 522 - .. row 14 523 523 ··· 529 529 530 530 - ``VIDEO_PALETTE_YUV411P`` 531 531 532 - - :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [8]_ 532 + - :ref:`V4L2_PIX_FMT_YUV411P <V4L2-PIX-FMT-YUV411P>` [#f8]_ 533 533 534 534 - .. row 16 535 535 ··· 876 876 877 877 - count[] 878 878 879 - - 16, 16 [9]_ 879 + - 16, 16 [#f9]_ 880 880 881 881 - .. row 8 882 882 ··· 915 915 microcode programming. A new interface for MPEG compression and playback 916 916 devices is documented in :ref:`extended-controls`. 917 917 918 - .. [1] 918 + .. [#f1] 919 919 According to Documentation/devices.txt these should be symbolic links 920 920 to ``/dev/video0``. Note the original bttv interface is not 921 921 compatible with V4L or V4L2. 922 922 923 - .. [2] 923 + .. [#f2] 924 924 According to ``Documentation/devices.txt`` a symbolic link to 925 925 ``/dev/radio0``. 926 926 927 - .. [3] 927 + .. [#f3] 928 928 This is a custom format used by the BTTV driver, not one of the V4L2 929 929 standard formats. 930 930 931 - .. [4] 931 + .. [#f4] 932 932 Presumably all V4L RGB formats are little-endian, although some 933 933 drivers might interpret them according to machine endianness. V4L2 934 934 defines little-endian, big-endian and red/blue swapped variants. For 935 935 details see :ref:`pixfmt-rgb`. 936 936 937 - .. [5] 937 + .. [#f5] 938 938 ``VIDEO_PALETTE_YUV422`` and ``VIDEO_PALETTE_YUYV`` are the same 939 939 formats. Some V4L drivers respond to one, some to the other. 940 940 941 - .. [6] 941 + .. [#f6] 942 942 Not to be confused with ``V4L2_PIX_FMT_YUV411P``, which is a planar 943 943 format. 944 944 945 - .. [7] 945 + .. [#f7] 946 946 V4L explains this as: "RAW capture (BT848)" 947 947 948 - .. [8] 948 + .. [#f8] 949 949 Not to be confused with ``V4L2_PIX_FMT_Y41P``, which is a packed 950 950 format. 951 951 952 - .. [9] 952 + .. [#f9] 953 953 Old driver versions used different values, eventually the custom 954 954 ``BTTV_VBISIZE`` ioctl was added to query the correct values.
+2 -2
Documentation/media/uapi/v4l/extended-controls.rst
··· 3183 3183 of the illumination varies significantly throughout the scene, i.e. 3184 3184 there are simultaneously very dark and very bright areas. It is most 3185 3185 commonly realized in cameras by combining two subsequent frames with 3186 - different exposure times. [1]_ 3186 + different exposure times. [#f1]_ 3187 3187 3188 3188 .. _v4l2-image-stabilization: 3189 3189 ··· 4526 4526 Is synthesizer PLL locked? RF tuner is receiving given frequency 4527 4527 when that control is set. This is a read-only control. 4528 4528 4529 - .. [1] 4529 + .. [#f1] 4530 4530 This control may be changed to a menu control in the future, if more 4531 4531 options are required.
+2 -2
Documentation/media/uapi/v4l/format.rst
··· 73 73 74 74 Apart of the generic format negotiation functions a special ioctl to 75 75 enumerate all image formats supported by video capture, overlay or 76 - output devices is available. [1]_ 76 + output devices is available. [#f1]_ 77 77 78 78 The :ref:`VIDIOC_ENUM_FMT` ioctl must be supported 79 79 by all drivers exchanging image data with applications. ··· 85 85 If necessary driver writers should publish an example conversion 86 86 routine or library for integration into applications. 87 87 88 - .. [1] 88 + .. [#f1] 89 89 Enumerating formats an application has no a-priori knowledge of 90 90 (otherwise it could explicitly ask for them and need not enumerate) 91 91 seems useless, but there are applications serving as proxy between
+2 -2
Documentation/media/uapi/v4l/func-select.rst
··· 50 50 :ref:`VIDIOC_STREAMON` yet the :ref:`select() <func-select>` 51 51 function succeeds, setting the bit of the file descriptor in ``readfds`` 52 52 or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` 53 - calls will fail. [1]_ 53 + calls will fail. [#f1]_ 54 54 55 55 When use of the :ref:`read() <func-read>` function has been negotiated and the 56 56 driver does not capture yet, the :ref:`select() <func-select>` function starts ··· 100 100 The ``nfds`` argument is less than zero or greater than 101 101 ``FD_SETSIZE``. 102 102 103 - .. [1] 103 + .. [#f1] 104 104 The Linux kernel implements :ref:`select() <func-select>` like the 105 105 :ref:`poll() <func-poll>` function, but :ref:`select() <func-select>` cannot 106 106 return a ``POLLERR``.
+2 -2
Documentation/media/uapi/v4l/hist-v4l2.rst
··· 1391 1391 scope is similar to V4L2, an API to video capture and output devices for 1392 1392 X clients. Xv allows applications to display live video in a window, 1393 1393 send window contents to a TV output, and capture or output still images 1394 - in XPixmaps [1]_. With their implementation XFree86 makes the extension 1394 + in XPixmaps [#f1]_. With their implementation XFree86 makes the extension 1395 1395 available across many operating systems and architectures. 1396 1396 1397 1397 Because the driver is embedded into the X server Xv has a number of ··· 1476 1476 ``VIDIOC_SUBDEV_G_SELECTION`` and ``VIDIOC_SUBDEV_S_SELECTION``, 1477 1477 :ref:`VIDIOC_SUBDEV_G_SELECTION`. 1478 1478 1479 - .. [1] 1479 + .. [#f1] 1480 1480 This is not implemented in XFree86.
+6 -6
Documentation/media/uapi/v4l/mmap.rst
··· 26 26 A driver can support many sets of buffers. Each set is identified by a 27 27 unique buffer type value. The sets are independent and each set can hold 28 28 a different type of data. To access different sets at the same time 29 - different file descriptors must be used. [1]_ 29 + different file descriptors must be used. [#f1]_ 30 30 31 31 To allocate device buffers applications call the 32 32 :ref:`VIDIOC_REQBUFS` ioctl with the desired number ··· 217 217 to function, apart of this no limit exists on the number of buffers 218 218 applications can enqueue in advance, or dequeue and process. They can 219 219 also enqueue in a different order than buffers have been dequeued, and 220 - the driver can *fill* enqueued *empty* buffers in any order. [2]_ The 220 + the driver can *fill* enqueued *empty* buffers in any order. [#f2]_ The 221 221 index number of a buffer (struct :ref:`v4l2_buffer <v4l2-buffer>` 222 222 ``index``) plays no role here, it only identifies the buffer. 223 223 ··· 260 260 <VIDIOC_QBUF>`, :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` 261 261 and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the :ref:`mmap() 262 262 <func-mmap>`, :ref:`munmap() <func-munmap>`, :ref:`select() 263 - <func-select>` and :ref:`poll() <func-poll>` function. [3]_ 263 + <func-select>` and :ref:`poll() <func-poll>` function. [#f3]_ 264 264 265 265 [capture example] 266 266 267 - .. [1] 267 + .. [#f1] 268 268 One could use one file descriptor and set the buffer type field 269 269 accordingly when calling :ref:`VIDIOC_QBUF` etc., 270 270 but it makes the :ref:`select() <func-select>` function ambiguous. We also ··· 272 272 Video overlay for example is also a logical stream, although the CPU 273 273 is not needed for continuous operation. 274 274 275 - .. [2] 275 + .. [#f2] 276 276 Random enqueue order permits applications processing images out of 277 277 order (such as video codecs) to return buffers earlier, reducing the 278 278 probability of data loss. Random fill order allows drivers to reuse 279 279 buffers on a LIFO-basis, taking advantage of caches holding 280 280 scatter-gather lists and the like. 281 281 282 - .. [3] 282 + .. [#f3] 283 283 At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are 284 284 the same, and :ref:`select() <func-select>` is too important to be optional. 285 285 The rest should be evident.
+6 -6
Documentation/media/uapi/v4l/open.rst
··· 99 99 Multiple Opens 100 100 ============== 101 101 102 - V4L2 devices can be opened more than once. [1]_ When this is supported 102 + V4L2 devices can be opened more than once. [#f1]_ When this is supported 103 103 by the driver, users can for example start a "panel" application to 104 104 change controls like brightness or audio volume, while another 105 105 application captures video and audio. In other words, panel applications 106 106 are comparable to an ALSA audio mixer application. Just opening a V4L2 107 - device should not change the state of the device. [2]_ 107 + device should not change the state of the device. [#f2]_ 108 108 109 109 Once an application has allocated the memory buffers needed for 110 110 streaming data (by calling the :ref:`VIDIOC_REQBUFS` ··· 117 117 no longer allowed to allocate buffers or start or stop streaming. The 118 118 EBUSY error code will be returned instead. 119 119 120 - Merely opening a V4L2 device does not grant exclusive access. [3]_ 120 + Merely opening a V4L2 device does not grant exclusive access. [#f3]_ 121 121 Initiating data exchange however assigns the right to read or write the 122 122 requested type of data, and to change related properties, to this file 123 123 descriptor. Applications can request additional access privileges using ··· 142 142 :ref:`ioctl() <func-ioctl>` function as explained in the following 143 143 sections. 144 144 145 - .. [1] 145 + .. [#f1] 146 146 There are still some old and obscure drivers that have not been 147 147 updated to allow for multiple opens. This implies that for such 148 148 drivers :ref:`open() <func-open>` can return an ``EBUSY`` error code 149 149 when the device is already in use. 150 150 151 - .. [2] 151 + .. [#f2] 152 152 Unfortunately, opening a radio device often switches the state of the 153 153 device to radio mode in many drivers. This behavior should be fixed 154 154 eventually as it violates the V4L2 specification. 155 155 156 - .. [3] 156 + .. [#f3] 157 157 Drivers could recognize the ``O_EXCL`` open flag. Presently this is 158 158 not required, so applications cannot know if it really works.
+4 -4
Documentation/media/uapi/v4l/rw.rst
··· 31 31 To read from the device applications use the :ref:`read() <func-read>` 32 32 function, to write the :ref:`write() <func-write>` function. Drivers 33 33 must implement one I/O method if they exchange data with applications, 34 - but it need not be this. [1]_ When reading or writing is supported, the 34 + but it need not be this. [#f1]_ When reading or writing is supported, the 35 35 driver must also support the :ref:`select() <func-select>` and 36 - :ref:`poll() <func-poll>` function. [2]_ 36 + :ref:`poll() <func-poll>` function. [#f2]_ 37 37 38 - .. [1] 38 + .. [#f1] 39 39 It would be desirable if applications could depend on drivers 40 40 supporting all I/O interfaces, but as much as the complex memory 41 41 mapping I/O can be inadequate for some devices we have no reason to 42 42 require this interface, which is most useful for simple applications 43 43 capturing still images. 44 44 45 - .. [2] 45 + .. [#f2] 46 46 At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are 47 47 the same, and :ref:`select() <func-select>` is too important to be optional.
+2 -2
Documentation/media/uapi/v4l/standard.rst
··· 33 33 automatically depending on the selected radio frequency in UHF or VHF 34 34 band. Enumeration gives a "PAL-B/G" or "PAL-I" choice. Similar a 35 35 Composite input may collapse standards, enumerating "PAL-B/G/H/I", 36 - "NTSC-M" and "SECAM-D/K". [1]_ 36 + "NTSC-M" and "SECAM-D/K". [#f1]_ 37 37 38 38 To query and select the standard used by the current video input or 39 39 output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and ··· 177 177 exit(EXIT_FAILURE); 178 178 } 179 179 180 - .. [1] 180 + .. [#f1] 181 181 Some users are already confused by technical terms PAL, NTSC and 182 182 SECAM. There is no point asking them to distinguish between B, G, D, 183 183 or K when the software or hardware can do that automatically.
+4 -4
Documentation/media/uapi/v4l/userp.rst
··· 54 54 area of memory. This happens transparently to the application in the 55 55 virtual memory subsystem of the kernel. When buffer pages have been 56 56 swapped out to disk they are brought back and finally locked in physical 57 - memory for DMA. [1]_ 57 + memory for DMA. [#f1]_ 58 58 59 59 Filled or displayed buffers are dequeued with the 60 60 :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the ··· 99 99 :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`, 100 100 :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` 101 101 and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls, the 102 - :ref:`select() <func-select>` and :ref:`poll() <func-poll>` function. [2]_ 102 + :ref:`select() <func-select>` and :ref:`poll() <func-poll>` function. [#f2]_ 103 103 104 - .. [1] 104 + .. [#f1] 105 105 We expect that frequently used buffers are typically not swapped out. 106 106 Anyway, the process of swapping, locking or generating scatter-gather 107 107 lists may be time consuming. The delay can be masked by the depth of ··· 113 113 disk. Output buffers must be saved on the incoming and outgoing queue 114 114 because an application may share them with other processes. 115 115 116 - .. [2] 116 + .. [#f2] 117 117 At the driver level :ref:`select() <func-select>` and :ref:`poll() <func-poll>` are 118 118 the same, and :ref:`select() <func-select>` is too important to be optional. 119 119 The rest should be evident.
+13 -13
Documentation/media/uapi/v4l/vidioc-enumstd.rst
··· 41 41 bounds. To enumerate all standards applications shall begin at index 42 42 zero, incrementing by one until the driver returns ``EINVAL``. Drivers may 43 43 enumerate a different set of standards after switching the video input 44 - or output. [1]_ 44 + or output. [#f1]_ 45 45 46 46 47 47 .. _v4l2-standard: ··· 278 278 279 279 - Characteristics 280 280 281 - - M/NTSC [2]_ 281 + - M/NTSC [#f2]_ 282 282 283 283 - M/PAL 284 284 285 - - N/PAL [3]_ 285 + - N/PAL [#f3]_ 286 286 287 287 - B, B1, G/PAL 288 288 ··· 369 369 370 370 - + 4.5 371 371 372 - - + 5.5 ± 0.001 [4]_ [5]_ [6]_ [7]_ 372 + - + 5.5 ± 0.001 [#f4]_ [#f5]_ [#f6]_ [#f7]_ 373 373 374 374 - + 6.5 ± 0.001 375 375 ··· 383 383 384 384 - + 6.5 385 385 386 - - + 6.5 [8]_ 386 + - + 6.5 [#f8]_ 387 387 388 388 389 389 Return Value ··· 400 400 ENODATA 401 401 Standard video timings are not supported for this input or output. 402 402 403 - .. [1] 403 + .. [#f1] 404 404 The supported standards may overlap and we need an unambiguous set to 405 405 find the current standard returned by :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`. 406 406 407 - .. [2] 407 + .. [#f2] 408 408 Japan uses a standard similar to M/NTSC (V4L2_STD_NTSC_M_JP). 409 409 410 - .. [3] 410 + .. [#f3] 411 411 The values in brackets apply to the combination N/PAL a.k.a. 412 412 N\ :sub:`C` used in Argentina (V4L2_STD_PAL_Nc). 413 413 414 - .. [4] 414 + .. [#f4] 415 415 In the Federal Republic of Germany, Austria, Italy, the Netherlands, 416 416 Slovakia and Switzerland a system of two sound carriers is used, the 417 417 frequency of the second carrier being 242.1875 kHz above the 418 418 frequency of the first sound carrier. For stereophonic sound 419 419 transmissions a similar system is used in Australia. 420 420 421 - .. [5] 421 + .. [#f5] 422 422 New Zealand uses a sound carrier displaced 5.4996 ± 0.0005 MHz from 423 423 the vision carrier. 424 424 425 - .. [6] 425 + .. [#f6] 426 426 In Denmark, Finland, New Zealand, Sweden and Spain a system of two 427 427 sound carriers is used. In Iceland, Norway and Poland the same system 428 428 is being introduced. The second carrier is 5.85 MHz above the vision 429 429 carrier and is DQPSK modulated with 728 kbit/s sound and data 430 430 multiplex. (NICAM system) 431 431 432 - .. [7] 432 + .. [#f7] 433 433 In the United Kingdom, a system of two sound carriers is used. The 434 434 second sound carrier is 6.552 MHz above the vision carrier and is 435 435 DQPSK modulated with a 728 kbit/s sound and data multiplex able to 436 436 carry two sound channels. (NICAM system) 437 437 438 - .. [8] 438 + .. [#f8] 439 439 In France, a digital carrier 5.85 MHz away from the vision carrier 440 440 may be used in addition to the main sound carrier. It is modulated in 441 441 differentially encoded QPSK with a 728 kbit/s sound and data
+2 -2
Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
··· 112 112 113 113 - 114 114 - Physical base address of the framebuffer, that is the address of 115 - the pixel in the top left corner of the framebuffer. [1]_ 115 + the pixel in the top left corner of the framebuffer. [#f1]_ 116 116 117 117 - .. row 4 118 118 ··· 492 492 EINVAL 493 493 The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` parameters are unsuitable. 494 494 495 - .. [1] 495 + .. [#f1] 496 496 A physical base address may not suit all platforms. GK notes in 497 497 theory we should pass something like PCI device + memory region + 498 498 offset instead. If you encounter problems please discuss on the
+4 -4
Documentation/media/uapi/v4l/vidioc-g-tuner.rst
··· 622 622 623 623 - ``LANG2 = SAP`` 624 624 625 - - ``LANG1_LANG2``\ [1]_ 625 + - ``LANG1_LANG2``\ [#f1]_ 626 626 627 627 - .. row 3 628 628 ··· 686 686 687 687 - Language 1 688 688 689 - - Lang1/Lang2 (deprecated [2]_) or Lang1/Lang1 689 + - Lang1/Lang2 (deprecated [#f2]_) or Lang1/Lang1 690 690 691 691 - Language 1 692 692 ··· 706 706 The struct :ref:`v4l2_tuner <v4l2-tuner>` ``index`` is out of 707 707 bounds. 708 708 709 - .. [1] 709 + .. [#f1] 710 710 This mode has been added in Linux 2.6.17 and may not be supported by 711 711 older drivers. 712 712 713 - .. [2] 713 + .. [#f2] 714 714 Playback of both languages in ``MODE_STEREO`` is deprecated. In the 715 715 future drivers should produce only the primary language in this mode. 716 716 Applications should request ``MODE_LANG1_LANG2`` to record both
+2 -2
Documentation/media/uapi/v4l/vidioc-querycap.rst
··· 301 301 secondary function of video output devices and overlays an image 302 302 onto an outgoing video signal. When the driver sets this flag, it 303 303 must clear the ``V4L2_CAP_VIDEO_OVERLAY`` flag and vice 304 - versa. [1]_ 304 + versa. [#f1]_ 305 305 306 306 - .. row 14 307 307 ··· 428 428 appropriately. The generic error codes are described at the 429 429 :ref:`Generic Error Codes <gen-errors>` chapter. 430 430 431 - .. [1] 431 + .. [#f1] 432 432 The struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` lacks an 433 433 enum :ref:`v4l2_buf_type <v4l2-buf-type>` field, therefore the 434 434 type of overlay is implied by the driver capabilities.
+2 -2
Documentation/media/uapi/v4l/vidioc-queryctrl.rst
··· 53 53 54 54 In both cases, when the driver sets the ``V4L2_CTRL_FLAG_DISABLED`` flag 55 55 in the ``flags`` field this control is permanently disabled and should 56 - be ignored by the application. [1]_ 56 + be ignored by the application. [#f1]_ 57 57 58 58 When the application ORs ``id`` with ``V4L2_CTRL_FLAG_NEXT_CTRL`` the 59 59 driver returns the next supported non-compound control, or ``EINVAL`` if ··· 776 776 EACCES 777 777 An attempt was made to read a write-only control. 778 778 779 - .. [1] 779 + .. [#f1] 780 780 ``V4L2_CTRL_FLAG_DISABLED`` was intended for two purposes: Drivers 781 781 can skip predefined controls not supported by the hardware (although 782 782 returning ``EINVAL`` would do as well), or disable predefined and private