aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2015-06-13 19:14:53 -0700
committerbnewbold <bnewbold@robocracy.org>2015-06-13 20:28:01 -0700
commit58199489e79ca90b86c18e5c825f1c9bf84fb282 (patch)
tree8c5edaefa7b2a35b4cfb951740bb3bcba4ba77b8 /docs
parenteaabec0a91967b40b9fbcabfd3399f1e33fb7c4c (diff)
downloadlibrambutan-58199489e79ca90b86c18e5c825f1c9bf84fb282.tar.gz
librambutan-58199489e79ca90b86c18e5c825f1c9bf84fb282.zip
stm32f2-f4: refactor docs to use stm32f2_f4 namespace
Diffstat (limited to 'docs')
-rw-r--r--docs/source/libmaple/api/adc.rst22
-rw-r--r--docs/source/libmaple/api/dac.rst2
-rw-r--r--docs/source/libmaple/api/dma.rst2
-rw-r--r--docs/source/libmaple/api/flash.rst10
-rw-r--r--docs/source/libmaple/api/gpio.rst2
-rw-r--r--docs/source/libmaple/api/nvic.rst6
-rw-r--r--docs/source/libmaple/api/rcc.rst50
-rw-r--r--docs/source/libmaple/api/timer.rst2
8 files changed, 48 insertions, 48 deletions
diff --git a/docs/source/libmaple/api/adc.rst b/docs/source/libmaple/api/adc.rst
index 2f06926..f490a42 100644
--- a/docs/source/libmaple/api/adc.rst
+++ b/docs/source/libmaple/api/adc.rst
@@ -100,10 +100,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::adc_extsel_event
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::adc_extsel_event
+.. doxygenenum:: stm32f2_f4::adc_extsel_event
ADC Clock Prescaler
~~~~~~~~~~~~~~~~~~~
@@ -130,10 +130,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::adc_prescaler
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::adc_prescaler
+.. doxygenenum:: stm32f2_f4::adc_prescaler
.. _adc-adc_set_sample_rate:
@@ -170,10 +170,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::adc_smp_rate
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::adc_smp_rate
+.. doxygenenum:: stm32f2_f4::adc_smp_rate
Miscellaneous
~~~~~~~~~~~~~
@@ -211,12 +211,12 @@ pointers are ``ADC1_BASE``, ``ADC2_BASE``, and ``ADC3_BASE``.
.. _adc-adc_reg_map:
.. doxygenstruct:: adc_reg_map
-On **STM32F2 targets**, there is an additional common set of registers
+On **STM32F2-F4 targets**, there is an additional common set of registers
shared by all ADC peripherals. Its base pointer is
``ADC_COMMON_BASE``.
.. _adc-adc_common_reg_map:
-.. doxygenstruct:: stm32f2::adc_common_reg_map
+.. doxygenstruct:: stm32f2_f4::adc_common_reg_map
Register Bit Definitions
------------------------
diff --git a/docs/source/libmaple/api/dac.rst b/docs/source/libmaple/api/dac.rst
index 47955ef..aa879ea 100644
--- a/docs/source/libmaple/api/dac.rst
+++ b/docs/source/libmaple/api/dac.rst
@@ -16,7 +16,7 @@ Types
.. doxygenstruct:: dac_dev
.. doxygenstruct:: stm32f1::dac_reg_map
-.. doxygenstruct:: stm32f2::dac_reg_map
+.. doxygenstruct:: stm32f2_f4::dac_reg_map
Devices
-------
diff --git a/docs/source/libmaple/api/dma.rst b/docs/source/libmaple/api/dma.rst
index 4ce298d..080ac61 100644
--- a/docs/source/libmaple/api/dma.rst
+++ b/docs/source/libmaple/api/dma.rst
@@ -15,7 +15,7 @@ Types
.. TODO: seperate stm32f1/stm32f2 families correctly
.. doxygenstruct:: stm32f1::dma_reg_map
-.. doxygenstruct:: stm32f2::dma_reg_map
+.. doxygenstruct:: stm32f2_f4::dma_reg_map
.. doxygenstruct:: dma_dev
.. doxygenstruct:: dma_handler_config
.. doxygenenum:: dma_mode_flags
diff --git a/docs/source/libmaple/api/flash.rst b/docs/source/libmaple/api/flash.rst
index 52ff4d2..66cbbac 100644
--- a/docs/source/libmaple/api/flash.rst
+++ b/docs/source/libmaple/api/flash.rst
@@ -44,10 +44,10 @@ STM32F1 targets
.. doxygenstruct:: stm32f1::flash_reg_map
-STM32F2 targets
-~~~~~~~~~~~~~~~
+STM32F2-F4 targets
+~~~~~~~~~~~~~~~~~~
-.. doxygenstruct:: stm32f2::flash_reg_map
+.. doxygenstruct:: stm32f2_f4::flash_reg_map
Register Bit Definitions
------------------------
@@ -124,8 +124,8 @@ STM32F1 Targets
#define FLASH_OBR_RDPRT (1U << FLASH_OBR_RDPRT_BIT)
#define FLASH_OBR_OPTERR (1U << FLASH_OBR_OPTERR_BIT)
-STM32F2 Targets
-~~~~~~~~~~~~~~~
+STM32F2-F4 Targets
+~~~~~~~~~~~~~~~~~~
::
diff --git a/docs/source/libmaple/api/gpio.rst b/docs/source/libmaple/api/gpio.rst
index 5f631d5..5fd7435 100644
--- a/docs/source/libmaple/api/gpio.rst
+++ b/docs/source/libmaple/api/gpio.rst
@@ -16,7 +16,7 @@ Types
.. TODO: seperate stm32f1/stm32f2 families correctly
.. doxygenstruct:: stm32f1::gpio_reg_map
-.. doxygenstruct:: stm32f2::gpio_reg_map
+.. doxygenstruct:: stm32f2_f4::gpio_reg_map
.. doxygenstruct:: gpio_dev
.. doxygenenum:: gpio_pin_mode
diff --git a/docs/source/libmaple/api/nvic.rst b/docs/source/libmaple/api/nvic.rst
index 815da2b..9499a5a 100644
--- a/docs/source/libmaple/api/nvic.rst
+++ b/docs/source/libmaple/api/nvic.rst
@@ -34,10 +34,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::nvic_irq_num
-STM32F2 Targets
-~~~~~~~~~~~~~~~
+STM32F2-F4 Targets
+~~~~~~~~~~~~~~~~~~
-.. doxygenenum:: stm32f2::nvic_irq_num
+.. doxygenenum:: stm32f2_f4::nvic_irq_num
Functions
---------
diff --git a/docs/source/libmaple/api/rcc.rst b/docs/source/libmaple/api/rcc.rst
index ce58ec8..3506956 100644
--- a/docs/source/libmaple/api/rcc.rst
+++ b/docs/source/libmaple/api/rcc.rst
@@ -57,10 +57,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::rcc_clk_id
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::rcc_clk_id
+.. doxygenenum:: stm32f2_f4::rcc_clk_id
.. _libmaple-rcc-rcc_sysclk_src:
@@ -102,10 +102,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::rcc_clk
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::rcc_clk
+.. doxygenenum:: stm32f2_f4::rcc_clk
.. _libmaple-rcc-rcc_clk_domain:
@@ -133,10 +133,10 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::rcc_clk_domain
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::rcc_clk_domain
+.. doxygenenum:: stm32f2_f4::rcc_clk_domain
.. _libmaple-rcc-rcc_prescaler:
@@ -194,16 +194,16 @@ This just contains an ``rcc_pll_multiplier``.
.. doxygenstruct:: stm32f1::stm32f1_rcc_pll_data
-rcc_pll_cfg on STM32F2 Targets
-++++++++++++++++++++++++++++++
+rcc_pll_cfg on STM32F2-F4 Targets
++++++++++++++++++++++++++++++++++
The ``pllsrc`` field is chosen from the following.
-.. doxygenenum:: stm32f2::rcc_pllsrc
+.. doxygenenum:: stm32f2_f4::rcc_pllsrc
The ``data`` field must point to a ``struct stm32f2_rcc_pll_data``.
-.. doxygenstruct:: stm32f2::stm32f2_rcc_pll_data
+.. doxygenstruct:: stm32f2_f4::stm32f2_rcc_pll_data
.. _libmaple-rcc-clk-funcs:
@@ -274,16 +274,16 @@ STM32F1 Targets
.. doxygenenum:: stm32f1::rcc_apb2_divider
.. doxygenenum:: stm32f1::rcc_ahb_divider
-STM32F2 Targets
-+++++++++++++++
+STM32F2-F4 Targets
+++++++++++++++++++
-.. doxygenenum:: stm32f2::rcc_prescaler
-.. doxygenenum:: stm32f2::rcc_mco2_divider
-.. doxygenenum:: stm32f2::rcc_mco1_divider
-.. doxygenenum:: stm32f2::rcc_rtc_divider
-.. doxygenenum:: stm32f2::rcc_apb2_divider
-.. doxygenenum:: stm32f2::rcc_apb1_divider
-.. doxygenenum:: stm32f2::rcc_ahb_divider
+.. doxygenenum:: stm32f2_f4::rcc_prescaler
+.. doxygenenum:: stm32f2_f4::rcc_mco2_divider
+.. doxygenenum:: stm32f2_f4::rcc_mco1_divider
+.. doxygenenum:: stm32f2_f4::rcc_rtc_divider
+.. doxygenenum:: stm32f2_f4::rcc_apb2_divider
+.. doxygenenum:: stm32f2_f4::rcc_apb1_divider
+.. doxygenenum:: stm32f2_f4::rcc_ahb_divider
Register Maps
-------------
@@ -297,10 +297,10 @@ STM32F1 Targets
.. doxygenstruct:: stm32f1::rcc_reg_map
-STM32F2 Targets
-~~~~~~~~~~~~~~~
+STM32F2-F4 Targets
+~~~~~~~~~~~~~~~~~~
-.. doxygenstruct:: stm32f2::rcc_reg_map
+.. doxygenstruct:: stm32f2_f4::rcc_reg_map
Register Bit Definitions
------------------------
diff --git a/docs/source/libmaple/api/timer.rst b/docs/source/libmaple/api/timer.rst
index 0b261fc..bc3e10b 100644
--- a/docs/source/libmaple/api/timer.rst
+++ b/docs/source/libmaple/api/timer.rst
@@ -22,7 +22,7 @@ timer_reg_map`` ties it all together.
.. doxygenstruct:: timer_adv_reg_map
.. doxygenstruct:: stm32f1::timer_gen_reg_map
-.. doxygenstruct:: stm32f2::timer_gen_reg_map
+.. doxygenstruct:: stm32f2_f4::timer_gen_reg_map
.. doxygenstruct:: timer_bas_reg_map
.. doxygenunion:: timer_reg_map
.. doxygenenum:: timer_type