Add libhal-arm-mcu main API documentation

libhal-arm-mcu/1.21.1/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d0441b90465c041e58427318eb5b7d01
+tags: 645f666f9bcd5a90fca523b33c5a78b7

libhal-arm-mcu/1.21.1/_sources/cortex_m/dwt_counter.md.txt

@@ -0,0 +1,10 @@
+# DWT (Debug-Watchdog-Trace) Counter
+
+## DWT Counter
+
+Defined in namespace `hal::cortex_m`
+
+*#include <libhal-arm-mcu/dwt_counter.hpp>*
+
+```{doxygenclass} hal::cortex_m::dwt_counter
+```

libhal-arm-mcu/1.21.1/_sources/cortex_m/index.rst.txt

@@ -0,0 +1,15 @@
+libhal-arm-mcu API Documentation
+=========================================
+
+Here are the collection of drivers for microcontrollers ARM Cortex M processor.
+
+
+.. toctree::
+    :caption: ARM MCU drivers
+    :maxdepth: 4
+
+    dwt_counter
+    interrupt
+    startup
+    system_control
+    systick_timer

libhal-arm-mcu/1.21.1/_sources/cortex_m/interrupt.md.txt

@@ -0,0 +1,55 @@
+# Interrupt Controller
+
+## NVIC (Nested Vector Interrupt Controller)
+
+Defined in namespace `hal::cortex_m`
+
+*#include <libhal-arm-mcu/interrupt.hpp>*
+
+```{doxygenenum} hal::cortex_m::irq
+```
+
+```{doxygenfunction} hal::cortex_m::default_interrupt_handler
+```
+
+```{doxygenfunction} hal::cortex_m::hard_fault_handler
+```
+
+```{doxygenfunction} hal::cortex_m::memory_management_fault_handler
+```
+
+```{doxygenfunction} hal::cortex_m::bus_fault_handler
+```
+
+```{doxygenfunction} hal::cortex_m::usage_fault_handler
+```
+
+```{doxygenfunction} hal::cortex_m::revert_interrupt_vector_table
+```
+
+```{doxygenfunction} hal::cortex_m::initialize_interrupts(std::span<interrupt_pointer>)
+```
+
+```{doxygenfunction} hal::cortex_m::interrupt_vector_table_initialized
+```
+
+```{doxygenfunction} hal::cortex_m::disable_all_interrupts
+```
+
+```{doxygenfunction} hal::cortex_m::enable_all_interrupts
+```
+
+```{doxygenfunction} hal::cortex_m::get_vector_table
+```
+
+```{doxygenfunction} hal::cortex_m::enable_interrupt(irq_t, interrupt_pointer)
+```
+
+```{doxygenfunction} hal::cortex_m::disable_interrupt(irq_t)
+```
+
+```{doxygenfunction} hal::cortex_m::is_interrupt_enabled(irq_t)
+```
+
+```{doxygenfunction} hal::cortex_m::verify_vector_enabled(irq_t, interrupt_pointer)
+```

libhal-arm-mcu/1.21.1/_sources/cortex_m/startup.md.txt

@@ -0,0 +1,13 @@
+# Startup Functions
+
+## ARM Cortex-M Startup Utilities
+
+Defined in namespace `hal::cortex_m`
+
+*#include <libhal-arm-mcu/startup.hpp>*
+
+```{doxygenfunction} hal::cortex_m::initialize_data_section
+```
+
+```{doxygenfunction} hal::cortex_m::initialize_bss_section
+```

libhal-arm-mcu/1.21.1/_sources/cortex_m/system_control.md.txt

@@ -0,0 +1,28 @@
+# System Control
+
+## ARM Cortex-M System Control Functions
+
+Defined in namespace `hal::cortex_m`
+
+*#include <libhal-arm-mcu/system_control.hpp>*
+
+```{doxygenfunction} hal::cortex_m::initialize_floating_point_unit
+```
+
+```{doxygenfunction} hal::cortex_m::get_interrupt_vector_table_address
+```
+
+```{doxygenfunction} hal::cortex_m::set_interrupt_vector_table_address
+```
+
+```{doxygenfunction} hal::cortex_m::reset
+```
+
+```{doxygenfunction} hal::cortex_m::wait_for_interrupt
+```
+
+```{doxygenfunction} hal::cortex_m::wait_for_event
+```
+
+```{doxygenfunction} hal::cortex_m::debugger_connected
+```

libhal-arm-mcu/1.21.1/_sources/cortex_m/systick_timer.md.txt

@@ -0,0 +1,10 @@
+# SysTick Timer
+
+## ARM Cortex-M SysTick Timer
+
+Defined in namespace `hal::cortex_m`
+
+*#include <libhal-arm-mcu/systick_timer.hpp>*
+
+```{doxygenclass} hal::cortex_m::systick_timer
+```

libhal-arm-mcu/1.21.1/_sources/index.rst.txt

@@ -0,0 +1,23 @@
+libhal-arm-mcu API documentation
+=================================
+
+.. image:: _static/logo.png
+  :width: 200
+  :align: center
+  :alt: libhal logo
+
+**Welcome to libhal ARM MCU API documentation**
+
+Here you will find an organized list of the peripheral drivers for MCUs with
+ARM Cortex M processors embedded within them.
+
+.. toctree::
+  :caption: libhal-arm-mcu Docs
+  :maxdepth: 5
+
+  Libhal Cortex M <cortex_m/index>
+  Libhal LPC40xx <lpc40/index>
+  Libhal STM32F1 <stm32f1/index>
+  Libhal STM32F40 <stm32f40/index>
+  Libhal STM32F411 <stm32f411/index>
+  Libhal STM32 Generic <stm32_generic/index>

libhal-arm-mcu/1.21.1/_sources/lpc40/adc.md.txt

@@ -0,0 +1,10 @@
+# LPC40 ADC APIs
+
+## `hal::lpc40::adc`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/adc.hpp>*
+
+```{doxygenclass} hal::lpc40::adc
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/can.md.txt

@@ -0,0 +1,10 @@
+# LPC40 CAN APIs
+
+## `hal::lpc40::can`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/can.hpp>*
+
+```{doxygenclass} hal::lpc40::can
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/clock.md.txt

@@ -0,0 +1,34 @@
+# LPC40 Clock APIs
+
+## `hal::lpc40::clock_tree`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/clock.hpp>*
+
+```{doxygenenum} hal::lpc40::usb_clock_source
+```
+
+```{doxygenenum} hal::lpc40::usb_divider
+```
+
+```{doxygenenum} hal::lpc40::spifi_clock_source
+```
+
+```{doxygenenum} hal::lpc40::flash_configuration
+```
+
+```{doxygenstruct} hal::lpc40::clock_tree
+```
+
+```{doxygenfunction} hal::lpc40::maximum
+```
+
+```{doxygenfunction} hal::lpc40::get_frequency
+```
+
+```{doxygenfunction} hal::lpc40::using_external_oscillator
+```
+
+```{doxygenfunction} hal::lpc40::configure_clocks
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/constants.md.txt

@@ -0,0 +1,11 @@
+# LPC40 Constants APIs
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/constants.hpp>*
+
+```{doxygenenum} hal::lpc40::peripheral
+```
+
+```{doxygenenum} hal::lpc40::irq
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/dac.md.txt

@@ -0,0 +1,10 @@
+# LPC40 DAC APIs
+
+## `hal::lpc40::dac`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/dac.hpp>*
+
+```{doxygenclass} hal::lpc40::dac
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/dma.md.txt

@@ -0,0 +1,31 @@
+# LPC40 DMA APIs
+
+## `hal::lpc40::dma`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/dma.hpp>*
+
+```{doxygenstruct} hal::lpc40::dma
+```
+
+```{doxygenenum} hal::lpc40::dma_transfer_type
+```
+
+```{doxygenenum} hal::lpc40::dma_channel_select
+```
+
+```{doxygenenum} hal::lpc40::dma_transfer_width
+```
+
+```{doxygenenum} hal::lpc40::dma_burst_size
+```
+
+```{doxygenenum} hal::lpc40::dma_peripheral
+```
+
+```{doxygenfunction} hal::lpc40::set_dma_lock
+```
+
+```{doxygenfunction} hal::lpc40::setup_dma_transfer
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/dma_spi.md.txt

@@ -0,0 +1,10 @@
+# LPC40 DMA SPI APIs
+
+## `hal::lpc40::dma_spi`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/dma_spi.hpp>*
+
+```{doxygenclass} hal::lpc40::dma_spi
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/i2c.md.txt

@@ -0,0 +1,10 @@
+# LPC40 I2C APIs
+
+## `hal::lpc40::i2c`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/i2c.hpp>*
+
+```{doxygenclass} hal::lpc40::i2c
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/index.rst.txt

@@ -0,0 +1,28 @@
+libhal-arm-mcu LPC40 API Documentation
+=======================================
+
+Here are the collection of drivers for the LPC40 series microcontrollers.
+
+
+.. toctree::
+    :caption: LPC40 drivers
+    :maxdepth: 4
+
+    adc
+    can
+    clock
+    constants
+    dac
+    dma
+    dma_spi
+    i2c
+    input_pin
+    interrupt
+    interrupt_pin
+    output_pin
+    pin
+    power
+    pwm
+    spi
+    stream_dac
+    uart

libhal-arm-mcu/1.21.1/_sources/lpc40/input_pin.md.txt

@@ -0,0 +1,10 @@
+# LPC40 Input Pin APIs
+
+## `hal::lpc40::input_pin`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/input_pin.hpp>*
+
+```{doxygenclass} hal::lpc40::input_pin
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/interrupt.md.txt

@@ -0,0 +1,8 @@
+# LPC40 Interrupt APIs
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/interrupt.hpp>*
+
+```{doxygenfunction} hal::lpc40::initialize_interrupts
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/interrupt_pin.md.txt

@@ -0,0 +1,10 @@
+# LPC40 Interrupt Pin APIs
+
+## `hal::lpc40::interrupt_pin`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/interrupt_pin.hpp>*
+
+```{doxygenclass} hal::lpc40::interrupt_pin
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/output_pin.md.txt

@@ -0,0 +1,10 @@
+# LPC40 Output Pin APIs
+
+## `hal::lpc40::output_pin`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/output_pin.hpp>*
+
+```{doxygenclass} hal::lpc40::output_pin
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/pin.md.txt

@@ -0,0 +1,10 @@
+# LPC40 Pin APIs
+
+## `hal::lpc40::pin`
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/pin.hpp>*
+
+```{doxygenclass} hal::lpc40::pin
+```

libhal-arm-mcu/1.21.1/_sources/lpc40/power.md.txt

@@ -0,0 +1,14 @@
+# LPC40 Power APIs
+
+Defined in namespace `hal::lpc40`
+
+*#include <libhal-arm-mcu/lpc40/power.hpp>*
+
+```{doxygenfunction} hal::lpc40::power_on
+```
+
+```{doxygenfunction} hal::lpc40::is_on
+```
+
+```{doxygenfunction} hal::lpc40::power_off
+```