aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDario Nieuwenhuis <[email protected]>2024-05-28 10:58:20 +0200
committerGitHub <[email protected]>2024-05-28 10:58:20 +0200
commit34bc439f174ed95cf2e733c7276e314361fb50da (patch)
tree2c0bd2e30d002c50e9b3e5396edf55721979ed04
parent8d7c3f7de137d0669f829af3df17e0f6ef87c30a (diff)
parent4d431b308011db6c196cc052c03ca94d6222e97e (diff)
Merge pull request #3011 from plaes/docs-faq-fix-bdma-link
docs: faq: Fix link to bdma example and improve wording.
-rw-r--r--docs/pages/faq.adoc10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/pages/faq.adoc b/docs/pages/faq.adoc
index 827164bae..bb088dfb6 100644
--- a/docs/pages/faq.adoc
+++ b/docs/pages/faq.adoc
@@ -267,10 +267,10 @@ Additionally, some PWR settings require a full device reboot (and enough time to
267 267
268There is not a fix for this yet, as it is board/hardware dependant. See link:https://github.com/embassy-rs/embassy/issues/2806[this tracking issue] for more details 268There is not a fix for this yet, as it is board/hardware dependant. See link:https://github.com/embassy-rs/embassy/issues/2806[this tracking issue] for more details
269 269
270=== STM32 BDMA only work out of some RAM regions 270=== STM32 BDMA only working out of some RAM regions
271 271
272The STM32 BDMA controller included in some chips (TODO: list which ones) has a limitation in that it only works out of certain regions of RAM (TODO: list which ones), otherwise the transfer 272The STM32 BDMA controller included in some STM32H7 chips has to be configured to use only certain regions of RAM,
273will fail. 273otherwise the transfer will fail.
274 274
275If you see errors that look like this: 275If you see errors that look like this:
276 276
@@ -279,7 +279,7 @@ If you see errors that look like this:
279DMA: error on BDMA@1234ABCD channel 4 279DMA: error on BDMA@1234ABCD channel 4
280---- 280----
281 281
282You need to set up your linker script to define a special region for this area, and copy data to that region before using with BDMA. 282You need to set up your linker script to define a special region for this area and copy data to that region before using with BDMA.
283 283
284General steps: 284General steps:
285 285
@@ -289,7 +289,7 @@ General steps:
2894. In your code, access the defined memory region using `#[link_section = ".xxx"]` 2894. In your code, access the defined memory region using `#[link_section = ".xxx"]`
2905. Copy data to that region before using BDMA. 2905. Copy data to that region before using BDMA.
291 291
292See link:/examples/stm32h7/src/bin/spi_bdma.rs[this example] for more details. 292See link:https://github.com/embassy-rs/embassy/blob/main/examples/stm32h7/src/bin/spi_bdma.rs[SMT32H7 SPI BDMA example] for more details.
293 293
294== How do I switch to the `main` branch? 294== How do I switch to the `main` branch?
295 295