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
45 Additionally, if the scaler sub-device exists, its source pad (1) exposes
50 -------------------------
59 CCS static data
60 ---------------
62 The MIPI CCS driver supports CCS static data for all compliant devices,
63 including not just those compliant with CCS 1.1 but also CCS 1.0 and SMIA(++).
64 For CCS the file names are formed as
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).
78 vvvv or vv denotes MIPI and SMIA manufacturer IDs respectively, mmmm model ID
81 CCS tools
84 `CCS tools <https://github.com/MIPI-Alliance/ccs-tools/>`_ is a set of
85 tools for working with CCS static data files. CCS tools includes a
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
101 Conventionally the script is called this way to update the CCS driver
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
112 CCS PLL calculator
115 The CCS PLL calculator is used to compute the PLL configuration, given sensor's
121 The PLL model implemented by the PLL calculator corresponds to MIPI CCS 1.1.
123 .. kernel-doc:: drivers/media/i2c/ccs-pll.h