drivers/ccs/ccs.rst

1 .. SPDX-License-Identifier: GPL-2.0-only OR BSD-3-Clause
5 MIPI CCS camera sensor driver
8 The MIPI CCS camera sensor driver is a generic driver for `MIPI CCS
9 <https://www.mipi.org/specifications/camera-command-set>`_ compliant
10 camera sensors. It exposes three sub-devices representing the pixel array,
16 Pixel Array sub-device
17 ----------------------
19 The pixel array sub-device represents the camera sensor's pixel matrix, as well
26 ------
28 The binner sub-device represents the binning functionality on the sensor. For
37 ------
39 The scaler sub-device represents the digital crop and scaling functionality of
40 the sensor. The V4L2 selection target ``V4L2_SEL_TGT_CROP`` is used to
45 Additionally, if the scaler sub-device exists, its source pad (1) exposes
50 -------------------------
54 the cropped information is never retrieved. In case of camera sensors, the
60 ---------------
66 	ccs/ccs-sensor-vvvv-mmmm-rrrr.fw (sensor) and
67 	ccs/ccs-module-vvvv-mmmm-rrrr.fw (module).
71 	ccs/smiapp-sensor-vv-mmmm-rr.fw (sensor) and
72 	ccs/smiapp-module-vv-mmmm-rrrr.fw (module).
74 For SMIA (non-++) compliant devices the static data file name is
76 	ccs/smia-sensor-vv-mmmm-rr.fw (sensor).
84 `CCS tools <https://github.com/MIPI-Alliance/ccs-tools/>`_ is a set of
86 definition of the human-readable CCS static data YAML format and includes a
90 -----------------------------
92 The ccs-regs.asc file contains MIPI CCS register definitions that are used
95 produced files, please do not modify them manually as it's error-prone and
104 .. code-block:: none
106 	$ Documentation/driver-api/media/drivers/ccs/mk-ccs-regs -k \
107 		-e drivers/media/i2c/ccs/ccs-regs.h \
108 		-L drivers/media/i2c/ccs/ccs-limits.h \
109 		-l drivers/media/i2c/ccs/ccs-limits.c \
110 		-c Documentation/driver-api/media/drivers/ccs/ccs-regs.asc
115 The CCS PLL calculator is used to compute the PLL configuration, given sensor's
123 .. kernel-doc:: drivers/media/i2c/ccs-pll.h