Skip to content

Commit

Permalink
dt-bindings: smiapp: Align documentation with current practices
Browse files Browse the repository at this point in the history
- The clock-lanes property is not needed for the sensors do not support
  lane reordering. (The information possibly present in existing clock-lane
  properties is simply not used.)

- There's no need to refer to the sensor device in the DT example, thus
  remove the label.

- Rename the "camera" device node as "camera-sensor".

- Rename the endpoint label as "smiapp_ep" (was: "smiapp_1_1"). There is
  in practice only one anyway.

- Remove the remote-endpoint documentation (it is covered by
  graph.txt to which video-interfaces.txt refers to).

- Add a note on the port and endpoint nodes.

These changes make the smiapp bindings a better example.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rob Herring <robh@kernel.org>
  • Loading branch information
Sakari Ailus authored and Rob Herring committed Aug 27, 2019
1 parent 3e627fe commit 476646e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Documentation/devicetree/bindings/media/i2c/nokia,smia.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ 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 .

The device node should contain a "port" node which may contain one or more
endpoint nodes, in accordance with video interface bindings defined in
Documentation/devicetree/bindings/media/video-interfaces.txt .

Mandatory properties
--------------------
Expand Down Expand Up @@ -37,9 +40,7 @@ Optional properties
Endpoint node mandatory properties
----------------------------------

- clock-lanes: <0>
- data-lanes: <1..n>
- remote-endpoint: A phandle to the bus receiver's endpoint node.


Example
Expand All @@ -48,7 +49,7 @@ Example
&i2c2 {
clock-frequency = <400000>;

smiapp_1: camera@10 {
camera-sensor@10 {
compatible = "nokia,smia";
reg = <0x10>;
reset-gpios = <&gpio3 20 0>;
Expand All @@ -58,8 +59,7 @@ Example
nokia,nvm-size = <512>; /* 8 * 64 */
link-frequencies = /bits/ 64 <199200000 210000000 499200000>;
port {
smiapp_1_1: endpoint {
clock-lanes = <0>;
smiapp_ep: endpoint {
data-lanes = <1 2>;
remote-endpoint = <&csi2a_ep>;
};
Expand Down

0 comments on commit 476646e

Please sign in to comment.