| graham sanderson | 26653ea | 2021-01-20 10:44:27 -0600 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. |
| 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
| 7 | // Here to organize documentation order |
| 8 | |
| 9 | /** |
| 10 | * \defgroup hardware Hardware APIs |
| 11 | * This group of libraries provides a thin and efficient C API / abstractions to access the RP2040 hardware without having to read and write |
| 12 | * hardware registers directly. |
| 13 | * @{ |
| 14 | * \defgroup hardware_adc hardware_adc |
| 15 | * \defgroup hardware_base hardware_base |
| 16 | * \defgroup hardware_claim hardware_claim |
| 17 | * \defgroup hardware_clocks hardware_clocks |
| 18 | * \defgroup hardware_divider hardware_divider |
| 19 | * \defgroup hardware_dma hardware_dma |
| Graham Sanderson | 53f1915 | 2021-05-05 11:45:39 -0500 | [diff] [blame] | 20 | * \defgroup hardware_exception hardware_exception |
| graham sanderson | 26653ea | 2021-01-20 10:44:27 -0600 | [diff] [blame] | 21 | * \defgroup hardware_flash hardware_flash |
| 22 | * \defgroup hardware_gpio hardware_gpio |
| 23 | * \defgroup hardware_i2c hardware_i2c |
| 24 | * \defgroup hardware_interp hardware_interp |
| 25 | * \defgroup hardware_irq hardware_irq |
| 26 | * \defgroup hardware_pio hardware_pio |
| 27 | * \defgroup hardware_pll hardware_pll |
| 28 | * \defgroup hardware_pwm hardware_pwm |
| 29 | * \defgroup hardware_resets hardware_resets |
| 30 | * \defgroup hardware_rtc hardware_rtc |
| 31 | * \defgroup hardware_spi hardware_spi |
| 32 | * \defgroup hardware_sync hardware_sync |
| 33 | * \defgroup hardware_timer hardware_timer |
| 34 | * \defgroup hardware_uart hardware_uart |
| 35 | * \defgroup hardware_vreg hardware_vreg |
| 36 | * \defgroup hardware_watchdog hardware_watchdog |
| 37 | * \defgroup hardware_xosc hardware_xosc |
| 38 | * @} |
| 39 | * |
| 40 | * \defgroup high_level High Level APIs |
| 41 | * This group of libraries provide higher level functionality that isn't hardware related or provides a richer |
| 42 | * set of functionality above the basic hardware interfaces |
| 43 | * @{ |
| 44 | * \defgroup pico_multicore pico_multicore |
| 45 | * \defgroup pico_stdlib pico_stdlib |
| 46 | * \defgroup pico_sync pico_sync |
| 47 | * \defgroup pico_time pico_time |
| Luke Wren | 12925bc | 2021-01-28 14:16:05 +0000 | [diff] [blame] | 48 | * \defgroup pico_unique_id pico_unique_id |
| graham sanderson | 26653ea | 2021-01-20 10:44:27 -0600 | [diff] [blame] | 49 | * \defgroup pico_util pico_util |
| 50 | * @} |
| 51 | * |
| 52 | * \defgroup third_party Third-party Libraries |
| 53 | * Third party libraries for implementing high level functionality. |
| 54 | * @{ |
| 55 | * \defgroup tinyusb_device tinyusb_device |
| 56 | * \defgroup tinyusb_host tinyusb_host |
| 57 | * @} |
| 58 | * |
| 59 | * \defgroup runtime Runtime Infrastructure |
| 60 | * Libraries that are used to provide efficient implementation of certain |
| 61 | * language level and C library functions, as well as CMake INTERFACE libraries |
| 62 | * abstracting the compilation and link steps in the SDK |
| 63 | * @{ |
| 64 | * \defgroup boot_stage2 boot_stage2 |
| 65 | * \defgroup pico_base pico_base |
| Andrew Scheller | fc17f88 | 2021-03-02 21:37:27 +0000 | [diff] [blame] | 66 | * \defgroup pico_binary_info pico_binary_info |
| graham sanderson | 26653ea | 2021-01-20 10:44:27 -0600 | [diff] [blame] | 67 | * \defgroup pico_bit_ops pico_bit_ops |
| 68 | * \defgroup pico_bootrom pico_bootrom |
| Andrew Scheller | fc17f88 | 2021-03-02 21:37:27 +0000 | [diff] [blame] | 69 | * \defgroup pico_bootsel_via_double_reset pico_bootsel_via_double_reset |
| graham sanderson | 26653ea | 2021-01-20 10:44:27 -0600 | [diff] [blame] | 70 | * \defgroup pico_cxx_options pico_cxx_options |
| 71 | * \defgroup pico_divider pico_divider |
| 72 | * \defgroup pico_double pico_double |
| 73 | * \defgroup pico_float pico_float |
| 74 | * \defgroup pico_int64_ops pico_int64_ops |
| 75 | * \defgroup pico_malloc pico_malloc |
| 76 | * \defgroup pico_mem_ops pico_mem_ops |
| 77 | * \defgroup pico_platform pico_platform |
| 78 | * \defgroup pico_printf pico_printf |
| 79 | * \defgroup pico_runtime pico_runtime |
| 80 | * \defgroup pico_stdio pico_stdio |
| 81 | * \defgroup pico_standard_link pico_standard_link |
| 82 | * @} |
| 83 | * |
| 84 | * \defgroup misc External API Headers |
| 85 | * Headers for interfaces that are shared with code outside of the SDK |
| 86 | * @{ |
| 87 | * \defgroup boot_picoboot boot_picoboot |
| 88 | * \defgroup boot_uf2 boot_uf2 |
| 89 | * @} |
| Andrew Scheller | fc17f88 | 2021-03-02 21:37:27 +0000 | [diff] [blame] | 90 | */ |
