Mule is an MCU that emulates a set of I2C devices which are reachable
through an I2C-mux.
The emulated devices share a single I2C address with the mux itself
where the requested register is what determines which logic is executed
(mux logic or device logic).
Add support for the Mule I2C multiplexer bindings.
Signed-off-by: Farouk Bouabid <[email protected]>
---
.../devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml | 80 ++++++++++++++++++++++
1 file changed, 80 insertions(+)
diff --git a/Documentation/devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml b/Documentation/devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml
new file mode 100644
index 000000000000..b7bb13549027
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml
@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/tsd,mule-i2c-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mule I2C multiplexer
+
+maintainers:
+ - Farouk Bouabid <[email protected]>
+ - Quentin Schulz <[email protected]>
+
+description: |
+ Mule is an MCU that emulates a set of I2C devices which are reachable
+ through an I2C-mux.
+
+ The emulated devices share a single I2C address with the mux itself
+ where the requested register is what determines which logic is executed
+ (mux logic or device logic)
+
+ +--------------------------------------------------+
+ | Mule |
+ | +---------------+ |
+ ------+->|Config register|----+ |
+ | | +---------------+ | |
+ | | V_ |
+ | | | \ +--------+ |
+ | | | \-------->| dev #0 | |
+ | | | | +--------+ |
+ | | | M |-------->| dev #1 | |
+ | +--------------------->| U | +--------+ |
+ | | X |-------->| dev #2 | |
+ | | | +--------+ |
+ | | /-------->| dev #3 | |
+ | |__/ +--------+ |
+ +--------------------------------------------------+
+
+
+allOf:
+ - $ref: /schemas/i2c/i2c-mux.yaml#
+
+properties:
+ compatible:
+ const: tsd,mule-i2c-mux
+
+ reg:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ i2c-mux@18 {
+ compatible = "tsd,mule-i2c-mux";
+ reg = <0x18>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ i2c@0 {
+ reg = <0x0>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ fan: fan@18 {
+ compatible = "ti,amc6821";
+ reg = <0x18>;
+ #cooling-cells = <2>;
+ };
+ };
+ };
+ };
+...
--
2.34.1
On Tue, 11 Jun 2024 13:43:53 +0200, Farouk Bouabid wrote:
> Mule is an MCU that emulates a set of I2C devices which are reachable
> through an I2C-mux.
>
> The emulated devices share a single I2C address with the mux itself
> where the requested register is what determines which logic is executed
> (mux logic or device logic).
>
> Add support for the Mule I2C multiplexer bindings.
>
> Signed-off-by: Farouk Bouabid <[email protected]>
> ---
> .../devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml | 80 ++++++++++++++++++++++
> 1 file changed, 80 insertions(+)
>
My bot found errors running 'make dt_binding_check' on your patch:
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/i2c/tsd,mule-i2c-mux.example.dtb: fan@18: '#cooling-cells' does not match any of the regexes: 'pinctrl-[0-9]+'
from schema $id: http://devicetree.org/schemas/trivial-devices.yaml#
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]
The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
On Tue, Jun 11, 2024 at 7:32 AM Rob Herring (Arm) <[email protected]> wrote:
>
>
> On Tue, 11 Jun 2024 13:43:53 +0200, Farouk Bouabid wrote:
> > Mule is an MCU that emulates a set of I2C devices which are reachable
> > through an I2C-mux.
> >
> > The emulated devices share a single I2C address with the mux itself
> > where the requested register is what determines which logic is executed
> > (mux logic or device logic).
> >
> > Add support for the Mule I2C multiplexer bindings.
> >
> > Signed-off-by: Farouk Bouabid <[email protected]>
> > ---
> > .../devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml | 80 ++++++++++++++++++++++
> > 1 file changed, 80 insertions(+)
> >
>
> My bot found errors running 'make dt_binding_check' on your patch:
>
> yamllint warnings/errors:
>
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/i2c/tsd,mule-i2c-mux.example.dtb: fan@18: '#cooling-cells' does not match any of the regexes: 'pinctrl-[0-9]+'
> from schema $id: http://devicetree.org/schemas/trivial-devices.yaml#
You cannot add warnings. Please fix this or this patch will never be
accepted. Either drop the property from the example or add it to the
binding (by moving out of trivial-devices.yaml).
Rob
On 11/06/2024 13:43, Farouk Bouabid wrote:
> Mule is an MCU that emulates a set of I2C devices which are reachable
> through an I2C-mux.
>
A nit, subject: drop second/last, redundant "dt-bindings for". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18
...
> +
> + i2c@0 {
> + reg = <0x0>;
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + fan: fan@18 {
> + compatible = "ti,amc6821";
> + reg = <0x18>;
> + #cooling-cells = <2>;
Please keep consistent indentation.
Best regards,
Krzysztof