spi: sam0: use Device Tree for configuration.

[nzmichaelh]

Define a Device Tree binding for the SAM0 SPI and use it instead of
Kconfig for enabling / disabling instances

Signed-off-by: Michael Hope [email protected]

[codecov-io]

Codecov Report

Merging #5865 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #5865   +/-   ##
=======================================
  Coverage   53.08%   53.08%           
=======================================
  Files         430      430           
  Lines       41040    41040           
  Branches     7908     7908           
=======================================
  Hits        21785    21785           
  Misses      16032    16032           
  Partials     3223     3223

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf07caa...edd22b9. Read the comment docs.

[galak]

You could merge this with #5731

[nzmichaelh]

@galak @tbursztyka this is now ready for review.

[galak]

We need to rework how we deal w/SPI & UART since they are all just modes of SERCOM.

I think we should have a node per SERCOM, have multiple compatibles in the node. One for “atmel,sercom”, and one for “atmel,sercom-spi”, “atmel,sercom-i2c” or “atmel,sercom-uart”. Not sure if we should expand the compats to match the all the modes (CTRLA.MODE) can be set to.

[galak]

@nzmichaelh any updates here?

[nzmichaelh]

Hey @galak I'm happy to rework this but I'll need some pointers on Device Tree :) The peripheral reset and clock configuration code is basically the same for all SERCOMs. The peripheral is pretty simple so the actual serial, SPI, etc drivers are dominated by how different the Zephyr API is.

[nzmichaelh]

@galak let me know what the changes would look like and I'll start working on them

[nzmichaelh]

I've also rebased onto master.

[nzmichaelh]

Hi @galak I've rebased this and updated it for the Trinket M0.

re: the many modes of SERCOM, I had a look around the code and couldn't find an example of how to do support multiple modes of one peripheral. Could you tell me how, else could we land this patch and merge the SERCOM modes in a follow up?

[galak]

Hi @galak I've rebased this and updated it for the Trinket M0.

re: the many modes of SERCOM, I had a look around the code and couldn't find an example of how to do support multiple modes of one peripheral. Could you tell me how, else could we land this patch and merge the SERCOM modes in a follow up?

I need to play around with this, the straight forward method is to modify the compatible in the board .dts file to set it to uart or spi. I need to chat with a few people to see if there are examples of how this should be handled.

[galak]

Ok, after a little discussion I think the compatible solution is the way to go. So I think we should have sercom nodes in dts/arm/atmel/samd21.dtsi - w/o any compatible. In the board.dts we than add the compatible in addition to status = "ok";

So something like:

&sercom0 {
compatible = "atmel,sam0-uart";
status = "ok";
current-speed = <115200>;
};

&sercom4 {
compatible = "atmel,sam0-spi";
status = "ok";
};

Make sense?

[nzmichaelh]

@galak done. It turned out pretty clean - the Device Tree generator uses the compatible string as part of the #define, so I didn't need to make any other changes.

[ydamigos]

DT node inheritance is not clear to me. For example, the interrupt property exists in atmel,sam0-uart.yaml but I cannot find it in atmel,sam0-spi.yaml. Does SAM0 spi driver support interrupt?

[ydamigos]

I couldn't find this constrain in any yaml file.

[nzmichaelh]

Fixed.

[nzmichaelh]

re: sercom, uart, and spi: the SPI driver doesn't use interrupts as the SAM0 has no FIFO so it's faster and cheaper to use polling.

re: inheritance, it seems the Device Tree generator doesn't support multiple inheritance so, for example, the sam0-uart binding can't inherit from both uart.yaml and atmel,sam0-sercom.yaml.

[ydamigos]

re: sercom, uart, and spi: the SPI driver doesn't use interrupts as the SAM0 has no FIFO so it's faster and cheaper to use polling.
re: inheritance, it seems the Device Tree generator doesn't support multiple inheritance so, for example, the sam0-uart binding can't inherit from both uart.yaml and atmel,sam0-sercom.yaml.

I propose to remove atmel,sam0-sercom.yaml, compatible = "atmel,sam0-sercom"; and declare sercomX node in samd21.dtsi:

sercomX: sercom@address {
			reg = <address 0x40>;
			status = "disabled";
			label = "SERCOM0";
};

In board's dtsi we add uart as:

sercomΧ {
 	compatible = "atmel,sam0-uart";
 	current-speed = <115200>;
 	interrupts = <IRQn 0>;
	status = "ok";
};

and SPI as you already did.

In board level, you could use aliases and override label property (e.g. SPI_1, UART_1) to make things more clear.

WDYT?

If SPI HW uses interrupts we could leave interrupts property in sercomX nodes in samd21.dtsi file. The SPI driver won't use them.

[nzmichaelh]

The SPI HW does support interrupts so leaving them in samd21.dtsi SGTM. They're just not used as the driver is master only.

[henrikbrixandersen]

@ydamigos SGTM. Looking forward to seeing this land in the tree.

[henrikbrixandersen]

The SPI loopback config for the Arduino Zero (tests/drivers/spi/spi_loopback/boards/arduino_zero.conf) will need to be updated as well (replacing SPI4 with SERCOM4).