Add device tree bindings documentation for Mellanox BlueField
I2C SMBus controller.
Signed-off-by: Khalil Blaiech <kblaiech@xxxxxxxxxxxx>
---
v5->v6:
- Adding description of an extra resource to be
consistent with new BlueField-2 SoCs.
- Adding an additional example of device instance.
v3->v4:
- Re-ordering of the property descriptions.
- Removing useless register addresses from the
resource description.
- Definition of default clock-frequency value.
- Fixing format issues; removing spaces.
- Removing "aliases" from Example section.
- Renaming device instance node in Example section.
v2->v3:
- Removing shared resources from the controller
instance.
- Updating the 'compatible' property and support the
second generation of the Mellanox BlueField SoC.
- Fixing file format; replacing spaces with tabs.
v1->v2:
- Enumeration of the device resources.
- Updating the 'compatible' property to make it less
generic.
- Removing the 'bus' index property and replace it with
standard approach to read the bus identifier.
- Getting rid of the 'profile' property.
- Using 'clock-frequency' property instead of 'bus-freq'.
- Convertion of the clock frequency from KHz to Hz.
- Removing useless examples.
---
.../devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt | 42 ++++++++++++++++++++++
1 file changed, 42 insertions(+)
create mode 100644 Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt
diff --git a/Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt b/Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt
new file mode 100644
index 0000000..566ea86
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt
@@ -0,0 +1,42 @@
+Device tree configuration for the Mellanox I2C SMBus on BlueField SoCs
+
+Required Properties:
+
+- compatible : should be "mellanox,i2c-mlxbf1" or "mellanox,i2c-mlxbf2".
+
+- reg : address offset and length of the device registers. The
+ registers consist of the following set of resources:
+ 1) Smbus block registers.
+ 2) Cause master registers.
+ 3) Cause slave registers.
+ 4) Cause coalesce registers (if compatible isn't set
+ to "mellanox,i2c-mlxbf1").
+
+- interrupts : interrupt number.
+
+Optional Properties:
+
+- clock-frequency : bus frequency used to configure timing registers;
+ allowed values are 100000, 400000 and 1000000;
+ those are expressed in Hz. Default is 100000.
+
+Example:
+
+i2c@2804000 {
+ compatible = "mellanox,i2c-mlxbf1";
+ reg = <0x02804000 0x800>,
+ <0x02801200 0x020>,
+ <0x02801260 0x020>;
+ interrupts = <57>;
+ clock-frequency = <100000>;
+};
+
+i2c@2808800 {
+ compatible = "mellanox,i2c-mlxbf2";
+ reg = <0x02808800 0x600>,
+ <0x02808e00 0x020>,
+ <0x02808e20 0x020>,
+ <0x02808e40 0x010>;
+ interrupts = <57>;
+ clock-frequency = <400000>;
+};
--
2.1.2
