Document the i2c-slave-mqueue binding by adding descriptor, required properties, and example.
Cc: Rob Herring <[email protected]> Cc: Mark Rutland <[email protected]> Cc: Wolfram Sang <[email protected]> Cc: [email protected] Cc: [email protected] Cc: [email protected] Signed-off-by: Eduardo Valentin <[email protected]> --- Changes from V6 to V7: - none .../bindings/i2c/i2c-slave-mqueue.txt | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 Documentation/devicetree/bindings/i2c/i2c-slave-mqueue.txt diff --git a/Documentation/devicetree/bindings/i2c/i2c-slave-mqueue.txt b/Documentation/devicetree/bindings/i2c/i2c-slave-mqueue.txt new file mode 100644 index 000000000000..eb1881a4fc0e --- /dev/null +++ b/Documentation/devicetree/bindings/i2c/i2c-slave-mqueue.txt @@ -0,0 +1,34 @@ +=============================================== +Device Tree for I2C slave message queue backend +=============================================== + +Some protocols over I2C/SMBus are designed for bi-directional transferring +messages by using I2C Master Write protocol. This requires that both sides +of the communication have slave addresses. + +This I2C slave mqueue (message queue) is used to receive and queue +messages from the remote i2c intelligent device; and it will add the target +slave address (with R/W# bit is always 0) into the message at the first byte. + +Links +---- +`Intelligent Platform Management Bus +Communications Protocol Specification +<https://www.intel.com/content/dam/www/public/us/en/documents/product-briefs/ipmp-spec-v1.0.pdf>`_ + +`Management Component Transport Protocol (MCTP) +SMBus/I2C Transport Binding Specification +<https://www.dmtf.org/sites/default/files/standards/documents/DSP0237_1.1.0.pdf>`_ + +Required Properties: +- compatible : should be "i2c-slave-mqueue" +- reg : slave address + +Example: + +i2c { + slave_mqueue: i2c-slave-mqueue { + compatible = "i2c-slave-mqueue"; + reg = <0x10>; + }; +}; -- 2.21.0
