spi: atmel: update DT bindings documentation
authorCyrille Pitchen <cyrille.pitchen@atmel.com>
Tue, 16 Jun 2015 10:09:30 +0000 (12:09 +0200)
committerMark Brown <broonie@kernel.org>
Tue, 16 Jun 2015 12:08:18 +0000 (13:08 +0100)
commit2c01a3d6b3cf0aaf39b55318fd986b1bd0b98168
tree7fb196386a67fbfd2b7e56957b7c1cae6d550296
parent4820303480a18773f30e2c5ad1178d5960facdbf
spi: atmel: update DT bindings documentation

- add new property "atmel,fifo-size"
- change "cs-gpios" to optional for SPI controller version >= 2.

Please be aware that the VERSION register can not be used to guess the
size of FIFOs. Indeed, for a given hardware version, the SPI controller
can be integrated on Atmel SoCs with different FIFO sizes. Also the
"atmel,fifo-size" property is optional as older SPI controllers don't
embed FIFO at all.

Besides, the FIFO size can not be read or guessed from other registers:
When designing the FIFO feature, no dedicated registers were added to
store this size. Unused spaces in the I/O register range are limited and
better reserved for future usages. Instead, the FIFO size of each
peripheral is documented in the programmer datasheet.

Finally, on a given SoC, there can be several instances of the SPI
controller with different FIFO sizes. This explain why we'd rather use a
dedicated DT property than use the "compatible" property.

For instance, sama5d2x SoCs come with some SPI controllers, the ones
inside Flexcoms, integrating 32 data FIFOs whereas other SPI controllers
use 16 data FIFOs. All these SPI controllers share the same IP version.

Signed-off-by: Cyrille Pitchen <cyrille.pitchen@atmel.com>
Acked-by: Nicolas Ferre <nicolas.ferre@atmel.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/spi/spi_atmel.txt