aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-07-03 22:52:42 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-07-04 09:48:45 -0400
commitd1bdde56cced15cdc76625e4e1075abdcda3c9b5 (patch)
treed9bfabce6e428d6b57311c5bfa7e93672628f09f /docs
parentdf43c9e9bff1f638ad41c27e4f6bb6e757d26ea5 (diff)
downloadkutter-d1bdde56cced15cdc76625e4e1075abdcda3c9b5.tar.gz
kutter-d1bdde56cced15cdc76625e4e1075abdcda3c9b5.tar.xz
kutter-d1bdde56cced15cdc76625e4e1075abdcda3c9b5.zip
samd_sercom: Specify the sercom explicitly in a config option
Do not infer the sercom from the config section name, as that prevents one from using SPI buses on multiple samd mcus. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Changes.md3
-rw-r--r--docs/Config_Reference.md14
2 files changed, 12 insertions, 5 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 65a4890a..8e761a95 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -6,6 +6,9 @@ All dates in this document are approximate.
# Changes
+20210703: A `samd_sercom` config section must now specify the sercom
+bus it is configuring via the `sercom` option.
+
20210612: The `pid_integral_max` config option in heater and
temperature_fan sections is deprecated. The option will be removed in
the near future.
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 94b8d88f..f271d8d5 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3793,13 +3793,17 @@ i2c_address:
## [samd_sercom]
SAMD SERCOM configuration to specify which pins to use on a given
-SERCOM. One may define one section with the "samd_sercom" prefix per
-SERCOM available. Each SERCOM must be configured prior to using it as
-SPI or I2C peripheral. Place this config section above any other
-section that makes use of SPI or I2C buses.
+SERCOM. One may define any number of sections with a "samd_sercom"
+prefix. Each SERCOM must be configured prior to using it as SPI or I2C
+peripheral. Place this config section above any other section that
+makes use of SPI or I2C buses.
```
-[samd_sercom sercom0]
+[samd_sercom my_sercom]
+sercom:
+# The name of the sercom bus to configure in the micro-controller.
+# Available names are "sercom0", "sercom1", etc.. This parameter
+# must be provided.
tx_pin:
# MOSI pin for SPI communication, or SDA (data) pin for I2C
# communication. The pin must have a valid pinmux configuration