1 .. SPDX-License-Identifier: GPL-2.0-only OR BSD-3-Clause 2 3 .. include:: <isonum.txt> 4 5 .. _media-ccs-driver: 6 7 MIPI CCS camera sensor driver 8 ============================= 9 10 The MIPI CCS camera sensor driver is a generic driver for `MIPI CCS 11 <https://www.mipi.org/specifications/camera-command-set>`_ compliant 12 camera sensors. 13 14 Also see :ref:`the CCS driver UAPI documentation <media-ccs-uapi>`. 15 16 CCS static data 17 --------------- 18 19 The MIPI CCS driver supports CCS static data for all compliant devices, 20 including not just those compliant with CCS 1.1 but also CCS 1.0 and SMIA(++). 21 For CCS the file names are formed as 22 23 ccs/ccs-sensor-vvvv-mmmm-rrrr.fw (sensor) and 24 ccs/ccs-module-vvvv-mmmm-rrrr.fw (module). 25 26 For SMIA++ compliant devices the corresponding file names are 27 28 ccs/smiapp-sensor-vv-mmmm-rr.fw (sensor) and 29 ccs/smiapp-module-vv-mmmm-rrrr.fw (module). 30 31 For SMIA (non-++) compliant devices the static data file name is 32 33 ccs/smia-sensor-vv-mmmm-rr.fw (sensor). 34 35 vvvv or vv denotes MIPI and SMIA manufacturer IDs respectively, mmmm model ID 36 and rrrr or rr revision number. 37 38 CCS tools 39 ~~~~~~~~~ 40 41 `CCS tools <https://github.com/MIPI-Alliance/ccs-tools/>`_ is a set of 42 tools for working with CCS static data files. CCS tools includes a 43 definition of the human-readable CCS static data YAML format and includes a 44 program to convert it to a binary. 45 46 Register definition generator 47 ----------------------------- 48 49 The ccs-regs.asc file contains MIPI CCS register definitions that are used 50 to produce C source code files for definitions that can be better used by 51 programs written in C language. As there are many dependencies between the 52 produced files, please do not modify them manually as it's error-prone and 53 in vain, but instead change the script producing them. 54 55 Usage 56 ~~~~~ 57 58 Conventionally the script is called this way to update the CCS driver 59 definitions: 60 61 .. code-block:: none 62 63 $ Documentation/driver-api/media/drivers/ccs/mk-ccs-regs -k \ 64 -e drivers/media/i2c/ccs/ccs-regs.h \ 65 -L drivers/media/i2c/ccs/ccs-limits.h \ 66 -l drivers/media/i2c/ccs/ccs-limits.c \ 67 -c Documentation/driver-api/media/drivers/ccs/ccs-regs.asc 68 69 CCS PLL calculator 70 ================== 71 72 The CCS PLL calculator is used to compute the PLL configuration, given sensor's 73 capabilities as well as board configuration and user specified configuration. As 74 the configuration space that encompasses all these configurations is vast, the 75 PLL calculator isn't entirely trivial. Yet it is relatively simple to use for a 76 driver. 77 78 The PLL model implemented by the PLL calculator corresponds to MIPI CCS 1.1. 79 80 .. kernel-doc:: drivers/media/i2c/ccs-pll.h 81 82 **Copyright** |copy| 2020 Intel Corporation
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.