Skip to contentSkip to conversation

DT: Add binding documentation for CM36651 proximity/light sensor

PATCH Superseded Beomho Seo 2 participants 3 messages Sep 9, 2013 – Sep 26, 2013 2 messages not in the archive

Subsystems (2)

v1 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Beomho Seo

author
#0 lore raw

PATCH 2/2 DT: Add binding documentation for CM36651 proximity/light sensor

This patch add device tree binding documentation for CM36651 proximity/light sensor.

---
 .../devicetree/bindings/iio/light/cm36651.txt      |   24
++++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.txt        |    1 +
 2 files changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/light/cm36651.txt
(quoted diff) +0 -0

b/Documentation/devicetree/bindings/iio/light/cm36651.txt new file mode 100644
index 0000000..3a6ba38

Documentation/devicetree/bindings/iio/light/cm36651.txt new file +24 -0
@@ -0,0 +1,24 @@
+* Capella CM36651 I2C Proximity and Color Light sensor
+
+Required properties:
+- compatible: must be "capella,cm36651"
+- reg: the I2C address of the device
+- interrupts: interrupt to which the chip is connected
+- vled-supply: regulator for the sensor device, as covered
+	       in ../../regulator/regulator.txt
+
+Example:
+
+	i2c_cm36651: i2c-gpio {
+		/* ... */
+
+		cm36651@18 {
+			compatible = "capella,cm36651";
+			reg = <0x18>;
+			interrupt-parent = <&gpx0>;
+			interrupts = <2 0>;
+			vled-supply = <&ps_als_reg>;
+		};
+
+		/* ... */
+	};
(quoted diff) +0 -0

b/Documentation/devicetree/bindings/vendor-prefixes.txt index ec4d713..044796d 100644

Documentation/devicetree/bindings/vendor-prefixes.txt +1 -0
@@ -17,6 +17,7 @@ brcm	Broadcom Corporation
 cavium	Cavium, Inc.
 chrp	Common Hardware Reference Platform
 cirrus	Cirrus Logic, Inc.
+capella	Capella Microsystems, Inc
 cortina	Cortina Systems, Inc.
 dallas	Maxim Integrated Products (formerly Dallas Semiconductor)
 davicom	DAVICOM Semiconductor, Inc.
Signature · 6 lines
1.7.9.5

-- 
Beomho Seo, Assistant Engineer
System S/W Lab., S/W Platform Team, Software Center
Samsung Electronics
#2 lore raw
In reply to a message not in the archive
Quoted 18 lines · Beomho Seo

This patch add device tree binding documentation for CM36651 proximity/light sensor.

---
 .../devicetree/bindings/iio/light/cm36651.txt      |   24
++++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.txt        |    1 +
 2 files changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/light/cm36651.txt
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +0 -0
new file mode 100644
index 0000000..3a6ba38

Documentation/devicetree/bindings/iio/light/cm36651.txt line 6

Quoted 6 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +6 -0
@@ -0,0 +1,24 @@
+* Capella CM36651 I2C Proximity and Color Light sensor
+
+Required properties:
+- compatible: must be "capella,cm36651"
+- reg: the I2C address of the device
+- interrupts: interrupt to which the chip is connected

Nit: I'd prefer something like the below:

- interrupts: interrupt-specifier for the sole interrupt generated by the device.

Documentation/devicetree/bindings/iio/light/cm36651.txt line 8

Quoted 2 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +2 -0
+- vled-supply: regulator for the sensor device, as covered
+	       in ../../regulator/regulator.txt

I assume by the name that this is the regulator for the LED that's used alongside the sensor, rather than for the sensor itself?

Is the LED part of the CM36651 unit, or is it external? I couldn't find any documentation for the unit.

Quoted 22 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +16 -0
+
+Example:
+
+	i2c_cm36651: i2c-gpio {
+		/* ... */
+
+		cm36651@18 {
+			compatible = "capella,cm36651";
+			reg = <0x18>;
+			interrupt-parent = <&gpx0>;
+			interrupts = <2 0>;
+			vled-supply = <&ps_als_reg>;
+		};
+
+		/* ... */
+	};
Documentation/devicetree/bindings/vendor-prefixes.txt +0 -0
index ec4d713..044796d 100644

Documentation/devicetree/bindings/vendor-prefixes.txt brcm Broadcom Corporation · line 20

Quoted 4 lines
Documentation/devicetree/bindings/vendor-prefixes.txt +1 -0
@@ -17,6 +17,7 @@ brcm	Broadcom Corporation
 cavium	Cavium, Inc.
 chrp	Common Hardware Reference Platform
 cirrus	Cirrus Logic, Inc.
+capella	Capella Microsystems, Inc

The vendor prefix looks OK to me. However, it should apper before cavium to maintain the ordering of the file.

Thanks,
Mark.

Quoted 11 lines
Documentation/devicetree/bindings/vendor-prefixes.txt +0 -0
 cortina	Cortina Systems, Inc.
 dallas	Maxim Integrated Products (formerly Dallas Semiconductor)
 davicom	DAVICOM Semiconductor, Inc.
Signature · 6 lines
1.7.9.5

-- 
Beomho Seo, Assistant Engineer
System S/W Lab., S/W Platform Team, Software Center
Samsung Electronics

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

author
#4 lore raw
In reply to a message not in the archive

Thank you for review.
I revised on your advice.
I will send v3 patch in the course of today.

reply about your question inline

Quoted 31 lines · Beomho Seo
Quoted 18 lines

This patch add device tree binding documentation for CM36651 proximity/light sensor.

---
 .../devicetree/bindings/iio/light/cm36651.txt      |   24
++++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.txt        |    1 +
 2 files changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/light/cm36651.txt
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +0 -0
new file mode 100644
index 0000000..3a6ba38

Documentation/devicetree/bindings/iio/light/cm36651.txt line 6

Quoted 6 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +6 -0
@@ -0,0 +1,24 @@
+* Capella CM36651 I2C Proximity and Color Light sensor
+
+Required properties:
+- compatible: must be "capella,cm36651"
+- reg: the I2C address of the device
+- interrupts: interrupt to which the chip is connected

Nit: I'd prefer something like the below:

- interrupts: interrupt-specifier for the sole interrupt generated by the device.

Quoted 9 lines

Documentation/devicetree/bindings/iio/light/cm36651.txt line 8

Quoted 2 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +2 -0
+- vled-supply: regulator for the sensor device, as covered
+	       in ../../regulator/regulator.txt

I assume by the name that this is the regulator for the LED that's used alongside the sensor, rather than for the sensor itself?

Is the LED part of the CM36651 unit, or is it external? I couldn't find any documentation for the unit.

vled_suppy is the regulator for the IR LED. In order to cm36651 manual, IR_LED part of the cm36651 unit.

Quoted 45 lines
Quoted 22 lines
Documentation/devicetree/bindings/iio/light/cm36651.txt new file +16 -0
+
+Example:
+
+	i2c_cm36651: i2c-gpio {
+		/* ... */
+
+		cm36651@18 {
+			compatible = "capella,cm36651";
+			reg = <0x18>;
+			interrupt-parent = <&gpx0>;
+			interrupts = <2 0>;
+			vled-supply = <&ps_als_reg>;
+		};
+
+		/* ... */
+	};
Documentation/devicetree/bindings/vendor-prefixes.txt +0 -0
index ec4d713..044796d 100644

Documentation/devicetree/bindings/vendor-prefixes.txt brcm Broadcom Corporation · line 20

Quoted 4 lines
Documentation/devicetree/bindings/vendor-prefixes.txt +1 -0
@@ -17,6 +17,7 @@ brcm	Broadcom Corporation
 cavium	Cavium, Inc.
 chrp	Common Hardware Reference Platform
 cirrus	Cirrus Logic, Inc.
+capella	Capella Microsystems, Inc

The vendor prefix looks OK to me. However, it should apper before cavium to maintain the ordering of the file.

Thanks,
Mark.

Quoted 11 lines
Documentation/devicetree/bindings/vendor-prefixes.txt +0 -0
 cortina	Cortina Systems, Inc.
 dallas	Maxim Integrated Products (formerly Dallas Semiconductor)
 davicom	DAVICOM Semiconductor, Inc.
Signature · 6 lines
1.7.9.5

-- 
Beomho Seo, Assistant Engineer
System S/W Lab., S/W Platform Team, Software Center
Samsung Electronics
Signature · 5 lines
Best Regards,

Beomho Seo, Assistant Engineer
System S/W Lab., S/W Platform Team, Software Center
Samsung Electronics