media: Documentation: media: Improve camera sensor documentation
authorSakari Ailus <sakari.ailus@linux.intel.com>
Mon, 1 Feb 2021 09:16:03 +0000 (10:16 +0100)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 4 Aug 2021 12:43:50 +0000 (14:43 +0200)
commitb9a543364299e09ba236c69acb021ebbf7cebf1a
treec1bf41a74d88b37c9609ea0bae82442ce5eb2468
parent0368e7d2cd84a90d0518753fac33795e13df553f
media: Documentation: media: Improve camera sensor documentation

Modernise the documentation to make it more precise and update the use of
pixel rate control and various other changes. In particular:

- Use non-proportional font for file names, properties as well as
  controls.

- The unit of the HBLANK control is pixels, not lines.

- The unit of PIXEL_RATE control is pixels per second, not Hz.

- Merge common requirements for CSI-2 and parallel busses.

- Include all DT properties needed for assigned clocks.

- Fix referencing the link rate control.

- SMIA driver's new name is CCS driver.

- The PIXEL_RATE control denotes pixel rate on the pixel array on camera
  sensors. Do not suggest it is used to tell the maximum pixel rate on the
  bus anymore.

- Improve ReST syntax (plain struct and function names).

- Remove the suggestion to use s_power() in receiver drivers.

- Make MIPI website URL use HTTPS, add Wikipedia links to BT.601 and
  BT.656.

Fixes: e4cf8c58af75 ("media: Documentation: media: Document how to write camera sensor drivers")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Andrey Konovalov <andrey.konovalov@linaro.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/driver-api/media/camera-sensor.rst
Documentation/driver-api/media/csi2.rst [deleted file]
Documentation/driver-api/media/index.rst
Documentation/driver-api/media/tx-rx.rst [new file with mode: 0644]
Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst