dt-bindings: i2c: cadence: Document `fifo-depth` property
authorLars-Peter Clausen <lars@metafoo.de>
Fri, 17 Mar 2023 14:54:39 +0000 (07:54 -0700)
committerWolfram Sang <wsa@kernel.org>
Wed, 29 Mar 2023 19:16:50 +0000 (21:16 +0200)
commit6ff0ddb3051e33372a22b1fac11ee74315f9d12e
treec7cc2f8d330df359decdc89b6cc531d44056df63
parent0cc98416709210e93e0ae154b336f954df298b6c
dt-bindings: i2c: cadence: Document `fifo-depth` property

The depth of the FIFO of the Cadence I2C controller IP is a synthesis
configuration parameter. Different instances of the IP can have different
values. For correct operation software needs to be aware of the size of the
FIFO.

Add the documentation for the devicetree property that describes the FIFO
depth of the IP core.

The default value of 16 is for backwards compatibility reasons with
existing hardware descriptions where this property is not specified and
software has assumed that the FIFO depth is 16.

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Acked-by: Michal Simek <michal.simek@amd.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml