diff mbox

[v6,01/10] Documentation: dt: Add binding documentation for S5K6A3 image sensor

Message ID 1394122819-9582-2-git-send-email-s.nawrocki@samsung.com (mailing list archive)
State New, archived
Headers show

Commit Message

This patch adds binding documentation for the Samsung S5K6A3(YX)
raw image sensor.

Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
Acked-by: Kyungmin Park <kyungmin.park@samsung.com>
Acked-by: Mark Rutland <mark.rutland@arm.com>
---
Changes since v5:
  - none.

Changes since v2:
 - rephrased 'clocks' and 'clock-names' properties' description;
---
 .../devicetree/bindings/media/samsung-s5k6a3.txt   |   33 ++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/samsung-s5k6a3.txt

Comments

Philipp Zabel March 6, 2014, 6:08 p.m. UTC | #1
Hi Sylwester,

On Thu, Mar 6, 2014 at 5:20 PM, Sylwester Nawrocki
<s.nawrocki@samsung.com> wrote:
> This patch adds binding documentation for the Samsung S5K6A3(YX)
> raw image sensor.
>
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> Acked-by: Kyungmin Park <kyungmin.park@samsung.com>
> Acked-by: Mark Rutland <mark.rutland@arm.com>
> ---
> Changes since v5:
>   - none.
>
> Changes since v2:
>  - rephrased 'clocks' and 'clock-names' properties' description;
> ---
>  .../devicetree/bindings/media/samsung-s5k6a3.txt   |   33 ++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
>
> diff --git a/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt b/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
> new file mode 100644
> index 0000000..cce01e8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
> @@ -0,0 +1,33 @@
> +Samsung S5K6A3(YX) raw image sensor
> +---------------------------------
> +
> +S5K6A3(YX) is a raw image sensor with MIPI CSI-2 and CCP2 image data interfaces
> +and CCI (I2C compatible) control bus.
> +
> +Required properties:
> +
> +- compatible   : "samsung,s5k6a3";
> +- reg          : I2C slave address of the sensor;
> +- svdda-supply : core voltage supply;
> +- svddio-supply        : I/O voltage supply;
> +- afvdd-supply : AF (actuator) voltage supply;
> +- gpios                : specifier of a GPIO connected to the RESET pin;

Please use 'reset-gpios' for GPIOs connected to reset pins.

regards
Philipp
Sylwester Nawrocki March 6, 2014, 8:15 p.m. UTC | #2
Hi Phillip,

On 03/06/2014 07:08 PM, Philipp Zabel wrote:
>> +++ b/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
>> >  @@ -0,0 +1,33 @@
>> >  +Samsung S5K6A3(YX) raw image sensor
>> >  +---------------------------------
>> >  +
>> >  +S5K6A3(YX) is a raw image sensor with MIPI CSI-2 and CCP2 image data interfaces
>> >  +and CCI (I2C compatible) control bus.
>> >  +
>> >  +Required properties:
>> >  +
>> >  +- compatible   : "samsung,s5k6a3";
>> >  +- reg          : I2C slave address of the sensor;
>> >  +- svdda-supply : core voltage supply;
>> >  +- svddio-supply        : I/O voltage supply;
>> >  +- afvdd-supply : AF (actuator) voltage supply;
>> >  +- gpios                : specifier of a GPIO connected to the RESET pin;
>
> Please use 'reset-gpios' for GPIOs connected to reset pins.

I would prefer to keep it as is, I'm not adding a new driver in this
series, just the binding documentation and doing some refactoring.
So if I changed this now, the driver would need to be messed up with
an additional code to support both 'gpios' and 'reset-gpios'. Are
there any serious reasons to use this specific name ? It's not
related to the reset signal DT bindings, is it ?

--
Regards,
Sylwester
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt b/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
new file mode 100644
index 0000000..cce01e8
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/samsung-s5k6a3.txt
@@ -0,0 +1,33 @@ 
+Samsung S5K6A3(YX) raw image sensor
+---------------------------------
+
+S5K6A3(YX) is a raw image sensor with MIPI CSI-2 and CCP2 image data interfaces
+and CCI (I2C compatible) control bus.
+
+Required properties:
+
+- compatible	: "samsung,s5k6a3";
+- reg		: I2C slave address of the sensor;
+- svdda-supply	: core voltage supply;
+- svddio-supply	: I/O voltage supply;
+- afvdd-supply	: AF (actuator) voltage supply;
+- gpios		: specifier of a GPIO connected to the RESET pin;
+- clocks	: should contain list of phandle and clock specifier pairs
+		  according to common clock bindings for the clocks described
+		  in the clock-names property;
+- clock-names	: should contain "extclk" entry for the sensor's EXTCLK clock;
+
+Optional properties:
+
+- clock-frequency : the frequency at which the "extclk" clock should be
+		    configured to operate, in Hz; if this property is not
+		    specified default 24 MHz value will be used.
+
+The common video interfaces bindings (see video-interfaces.txt) should be
+used to specify link to the image data receiver. The S5K6A3(YX) device
+node should contain one 'port' child node with an 'endpoint' subnode.
+
+Following properties are valid for the endpoint node:
+
+- data-lanes : (optional) specifies MIPI CSI-2 data lanes as covered in
+  video-interfaces.txt.  The sensor supports only one data lane.