[media] of: smiapp: Add documentation

Document the smiapp device tree properties.

Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/Documentation/devicetree/bindings/media/i2c/nokia,smia.txt b/Documentation/devicetree/bindings/media/i2c/nokia,smia.txt
new file mode 100644 (file)
index 0000000..855e1fa
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/i2c/nokia,smia.txt
@@ -0,0 +1,63 @@
+SMIA/SMIA++ sensor
+
+SMIA (Standard Mobile Imaging Architecture) is an image sensor standard
+defined jointly by Nokia and ST. SMIA++, defined by Nokia, is an extension
+of that. These definitions are valid for both types of sensors.
+
+More detailed documentation can be found in
+Documentation/devicetree/bindings/media/video-interfaces.txt .
+
+
+Mandatory properties
+--------------------
+
+- compatible: "nokia,smia"
+- reg: I2C address (0x10, or an alternative address)
+- vana-supply: Analogue voltage supply (VANA), typically 2,8 volts (sensor
+  dependent).
+- clocks: External clock to the sensor
+- clock-frequency: Frequency of the external clock to the sensor
+- link-frequencies: List of allowed data link frequencies. An array of
+  64-bit elements.
+
+
+Optional properties
+-------------------
+
+- nokia,nvm-size: The size of the NVM, in bytes. If the size is not given,
+  the NVM contents will not be read.
+- reset-gpios: XSHUTDOWN GPIO
+
+
+Endpoint node mandatory properties
+----------------------------------
+
+- clock-lanes: <0>
+- data-lanes: <1..n>
+- remote-endpoint: A phandle to the bus receiver's endpoint node.
+
+
+Example
+-------
+
+&i2c2 {
+       clock-frequency = <400000>;
+
+       smiapp_1: camera@10 {
+               compatible = "nokia,smia";
+               reg = <0x10>;
+               reset-gpios = <&gpio3 20 0>;
+               vana-supply = <&vaux3>;
+               clocks = <&omap3_isp 0>;
+               clock-frequency = <9600000>;
+               nokia,nvm-size = <512>; /* 8 * 64 */
+               link-frequencies = /bits/ 64 <199200000 210000000 499200000>;
+               port {
+                       smiapp_1_1: endpoint {
+                               clock-lanes = <0>;
+                               data-lanes = <1 2>;
+                               remote-endpoint = <&csi2a_ep>;
+                       };
+               };
+       };
+};

diff --git a/MAINTAINERS b/MAINTAINERS
index f7d04bac206bb7d1be92eb0d27f8ada95ed83112..dc2d91252d8b4ef2f0e85c3b0fe75ab533fafc9e 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8827,6 +8827,7 @@ F:        include/media/smiapp.h
 F:     drivers/media/i2c/smiapp-pll.c
 F:     drivers/media/i2c/smiapp-pll.h
 F:     include/uapi/linux/smiapp.h
+F:     Documentation/devicetree/bindings/media/i2c/nokia,smia.txt
 
 SMM665 HARDWARE MONITOR DRIVER
 M:     Guenter Roeck <linux@roeck-us.net>