aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/ports/STM32/LLD/ADCv2/notes.txt
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/ports/STM32/LLD/ADCv2/notes.txt')
-rw-r--r--os/hal/ports/STM32/LLD/ADCv2/notes.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/os/hal/ports/STM32/LLD/ADCv2/notes.txt b/os/hal/ports/STM32/LLD/ADCv2/notes.txt
new file mode 100644
index 000000000..81312d063
--- /dev/null
+++ b/os/hal/ports/STM32/LLD/ADCv2/notes.txt
@@ -0,0 +1,13 @@
+STM32 ADCv2 driver.
+
+Driver capability:
+
+- Supports the STM32 "advanced" ADC found on F2, F4 and F4 sub-families.
+
+The file registry must export:
+
+STM32_HAS_ADCx - ADCx presence flag (1..3).
+STM32_ADC_HANDLER - IRQ vector name for ADCs (shared).
+STM32_ADC_NUMBER - IRQ vector number for ADCs (shared).
+STM32_ADCx_DMA_MSK - Mask of the compatible DMA channels.
+STM32_ADCx_DMA_CHN - Mask of the channels mapping.