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
20  * \defgroup hardware_exception hardware_exception
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_async_context pico_async_context
45  * \defgroup pico_multicore pico_multicore
46  * \defgroup pico_i2c_slave pico_i2c_slave
47  * \defgroup pico_rand pico_rand
48  * \defgroup pico_stdlib pico_stdlib
49  * \defgroup pico_sync pico_sync
50  * \defgroup pico_time pico_time
51  * \defgroup pico_unique_id pico_unique_id
52  * \defgroup pico_util pico_util
53  * @}
54  *
55  * \defgroup third_party Third-party Libraries
56  * Third party libraries for implementing high level functionality.
57  * @{
58  * \defgroup tinyusb_device tinyusb_device
59  * \defgroup tinyusb_host tinyusb_host
60  * @}
61  *
62  * \defgroup networking Networking Libraries
63  * Functions for implementing networking
64  * @{
65  * \defgroup pico_btstack pico_btstack
66  * \defgroup pico_lwip pico_lwip
67  * \defgroup pico_cyw43_driver pico_cyw43_driver
68  * \defgroup pico_cyw43_arch pico_cyw43_arch
69  * @}
70  *
71  * \defgroup runtime Runtime Infrastructure
72  * Libraries that are used to provide efficient implementation of certain
73  * language level and C library functions, as well as CMake INTERFACE libraries
74  * abstracting the compilation and link steps in the SDK
75  * @{
76  * \defgroup boot_stage2 boot_stage2
77  * \defgroup pico_base pico_base
78  * \defgroup pico_binary_info pico_binary_info
79  * \defgroup pico_bit_ops pico_bit_ops
80  * \defgroup pico_bootrom pico_bootrom
81  * \defgroup pico_bootsel_via_double_reset pico_bootsel_via_double_reset
82  * \defgroup pico_cxx_options pico_cxx_options
83  * \defgroup pico_divider pico_divider
84  * \defgroup pico_double pico_double
85  * \defgroup pico_float pico_float
86  * \defgroup pico_int64_ops pico_int64_ops
87  * \defgroup pico_malloc pico_malloc
88  * \defgroup pico_mem_ops pico_mem_ops
89  * \defgroup pico_platform pico_platform
90  * \defgroup pico_printf pico_printf
91  * \defgroup pico_runtime pico_runtime
92  * \defgroup pico_stdio pico_stdio
93  * \defgroup pico_standard_link pico_standard_link
94  * @}
95  *
96  * \defgroup misc External API Headers
97  * Headers for interfaces that are shared with code outside of the SDK
98  * @{
99  * \defgroup boot_picoboot boot_picoboot
100  * \defgroup boot_uf2 boot_uf2
101  * @}
102 */
103