media: docs: add an uAPI chapter for driver-specific stuff
There are some uAPI stuff that are driver-specific. Add them to the main media uAPI body. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
		
							parent
							
								
									577a7ad33a
								
							
						
					
					
						commit
						b36343861b
					
				| @ -15,8 +15,6 @@ Linux Media Subsystem Documentation | ||||
|    ../userspace-api/media/index | ||||
|    ../driver-api/media/index | ||||
| 
 | ||||
|    v4l-drivers/index | ||||
| 
 | ||||
| .. only:: html and subproject | ||||
| 
 | ||||
|    Indices | ||||
|  | ||||
| @ -2,7 +2,7 @@ | ||||
| 
 | ||||
| .. include:: <isonum.txt> | ||||
| 
 | ||||
| .. _v4l-drivers: | ||||
| .. _v4l-drivers_uapi: | ||||
| 
 | ||||
| ################################################ | ||||
| Video4Linux (V4L)  driver-specific documentation | ||||
| @ -31,10 +31,9 @@ For more details see the file COPYING in the source distribution of Linux. | ||||
| 	:maxdepth: 5 | ||||
| 	:numbered: | ||||
| 
 | ||||
| 	max2175 | ||||
| 	uvcvideo | ||||
| 
 | ||||
| 	cx2341x-uapi | ||||
| 	imx-uapi | ||||
| 	max2175 | ||||
| 	meye-uapi | ||||
| 	omap3isp-uapi | ||||
| 	uvcvideo | ||||
| @ -31,3 +31,5 @@ entitled "GNU Free Documentation License". | ||||
|     cec/cec-api | ||||
|     gen-errors | ||||
|     fdl-appendix | ||||
| 
 | ||||
|     drivers/index | ||||
|  | ||||
| @ -438,7 +438,7 @@ MPEG stream. | ||||
| *Historical context*: This format specification originates from a | ||||
| custom, embedded, sliced VBI data format used by the ``ivtv`` driver. | ||||
| This format has already been informally specified in the kernel sources | ||||
| in the file ``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` . The | ||||
| in the file ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst`` . The | ||||
| maximum size of the payload and other aspects of this format are driven | ||||
| by the CX23415 MPEG decoder's capabilities and limitations with respect | ||||
| to extracting, decoding, and displaying sliced VBI data embedded within | ||||
|  | ||||
| @ -116,7 +116,7 @@ enum v4l2_mpeg_stream_vbi_fmt - | ||||
|     * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV`` | ||||
|       - VBI in private packets, IVTV format (documented in the kernel | ||||
| 	sources in the file | ||||
| 	``Documentation/media/v4l-drivers/cx2341x-uapi.rst``) | ||||
| 	``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``) | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|  | ||||
| @ -58,7 +58,7 @@ please make a proposal on the linux-media mailing list. | ||||
|       - YUV 4:2:0 format used by the IVTV driver. | ||||
| 
 | ||||
| 	The format is documented in the kernel sources in the file | ||||
| 	``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` | ||||
| 	``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst`` | ||||
|     * .. _V4L2-PIX-FMT-CPIA1: | ||||
| 
 | ||||
|       - ``V4L2_PIX_FMT_CPIA1`` | ||||
|  | ||||
| @ -10249,7 +10249,7 @@ L:	linux-media@vger.kernel.org | ||||
| S:	Maintained | ||||
| T:	git git://linuxtv.org/media_tree.git | ||||
| F:	Documentation/devicetree/bindings/media/i2c/max2175.txt | ||||
| F:	Documentation/media/v4l-drivers/max2175.rst | ||||
| F:	Documentation/userspace-api/media/drivers/max2175.rst | ||||
| F:	drivers/media/i2c/max2175* | ||||
| F:	include/uapi/linux/max2175.h | ||||
| 
 | ||||
| @ -11389,7 +11389,7 @@ F:	drivers/regulator/mpq7920.h | ||||
| MOTION EYE VAIO PICTUREBOOK CAMERA DRIVER | ||||
| S:	Orphan | ||||
| W:	http://popies.net/meye/ | ||||
| F:	Documentation/media/v4l-drivers/meye* | ||||
| F:	Documentation/userspace-api/media/drivers/meye* | ||||
| F:	drivers/media/pci/meye/ | ||||
| F:	include/uapi/linux/meye.h | ||||
| 
 | ||||
|  | ||||
| @ -1194,7 +1194,7 @@ static const struct v4l2_ctrl_ops max2175_ctrl_ops = { | ||||
| 
 | ||||
| /*
 | ||||
|  * I2S output enable/disable configuration. This is a private control. | ||||
|  * Refer to Documentation/media/v4l-drivers/max2175.rst for more details. | ||||
|  * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details. | ||||
|  */ | ||||
| static const struct v4l2_ctrl_config max2175_i2s_en = { | ||||
| 	.ops = &max2175_ctrl_ops, | ||||
| @ -1210,7 +1210,7 @@ static const struct v4l2_ctrl_config max2175_i2s_en = { | ||||
| 
 | ||||
| /*
 | ||||
|  * HSLS value control LO freq adjacent location configuration. | ||||
|  * Refer to Documentation/media/v4l-drivers/max2175.rst for more details. | ||||
|  * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details. | ||||
|  */ | ||||
| static const struct v4l2_ctrl_config max2175_hsls = { | ||||
| 	.ops = &max2175_ctrl_ops, | ||||
| @ -1226,7 +1226,7 @@ static const struct v4l2_ctrl_config max2175_hsls = { | ||||
| /*
 | ||||
|  * Rx modes below are a set of preset configurations that decides the tuner's | ||||
|  * sck and sample rate of transmission. They are separate for EU & NA regions. | ||||
|  * Refer to Documentation/media/v4l-drivers/max2175.rst for more details. | ||||
|  * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details. | ||||
|  */ | ||||
| static const char * const max2175_ctrl_eu_rx_modes[] = { | ||||
| 	[MAX2175_EU_FM_1_2]	= "EU FM 1.2", | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user