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 // for some reason cond/endcond work better here than if/endif 10 11 /** 12 * \defgroup hardware Hardware APIs 13 * This group of libraries provides a thin and efficient C API / abstractions to access the RP-series microcontroller hardware without having to read and write 14 * hardware registers directly. 15 * @{ 16 * \cond hardware_adc \defgroup hardware_adc hardware_adc \endcond 17 * \cond hardware_base \defgroup hardware_base hardware_base \endcond 18 * \cond hardware_bootlock \defgroup hardware_bootlock hardware_bootlock \endcond 19 * \cond hardware_claim \defgroup hardware_claim hardware_claim \endcond 20 * \cond hardware_clocks \defgroup hardware_clocks hardware_clocks \endcond 21 * \cond hardware_divider \defgroup hardware_divider hardware_divider \endcond 22 * \cond hardware_dcp \defgroup hardware_dcp hardware_dcp \endcond 23 * \cond hardware_dma \defgroup hardware_dma hardware_dma \endcond 24 * \cond hardware_exception \defgroup hardware_exception hardware_exception \endcond 25 * \cond hardware_flash \defgroup hardware_flash hardware_flash \endcond 26 * \cond hardware_gpio \defgroup hardware_gpio hardware_gpio \endcond 27 * \cond hardware_hazard3 \defgroup hardware_hazard3 hardware_hazard3 \endcond 28 * \cond hardware_i2c \defgroup hardware_i2c hardware_i2c \endcond 29 * \cond hardware_interp \defgroup hardware_interp hardware_interp \endcond 30 * \cond hardware_irq \defgroup hardware_irq hardware_irq \endcond 31 * \cond hardware_pio \defgroup hardware_pio hardware_pio \endcond 32 * \cond hardware_pll \defgroup hardware_pll hardware_pll \endcond 33 * \cond hardware_powman \defgroup hardware_powman hardware_powman \endcond 34 * \cond hardware_pwm \defgroup hardware_pwm hardware_pwm \endcond 35 * \cond hardware_pwm \defgroup hardware_pwm hardware_pwm \endcond 36 * \cond hardware_resets \defgroup hardware_resets hardware_resets \endcond 37 * \cond hardware_riscv \defgroup hardware_riscv hardware_riscv \endcond 38 * \cond hardware_riscv_platform_timer \defgroup hardware_riscv_platform_timer hardware_riscv_platform_timer \endcond 39 * \cond hardware_rtc \defgroup hardware_rtc hardware_rtc \endcond 40 * \cond hardware_rcp \defgroup hardware_rcp hardware_rcp \endcond 41 * \cond hardware_spi \defgroup hardware_spi hardware_spi \endcond 42 * \cond hardware_sha256 \defgroup hardware_sha256 hardware_sha256 \endcond 43 * \cond hardware_sync \defgroup hardware_sync hardware_sync \endcond 44 * \cond hardware_ticks \defgroup hardware_ticks hardware_ticks \endcond 45 * \cond hardware_timer \defgroup hardware_timer hardware_timer \endcond 46 * \cond hardware_uart \defgroup hardware_uart hardware_uart \endcond 47 * \cond hardware_vreg \defgroup hardware_vreg hardware_vreg \endcond 48 * \cond hardware_watchdog \defgroup hardware_watchdog hardware_watchdog \endcond 49 * \cond hardware_xosc \defgroup hardware_xosc hardware_xosc \endcond 50 * \cond hardware_powman hardware_powman 51 * \cond hardware_hazard3 hardware_hazard3 52 * \cond hardware_riscv hardware_riscv 53 54 * @} 55 * 56 * \defgroup high_level High Level APIs 57 * This group of libraries provide higher level functionality that isn't hardware related or provides a richer 58 * set of functionality above the basic hardware interfaces 59 * @{ 60 * \cond pico_aon_timer \defgroup pico_aon_timer pico_aon_timer \endcond 61 * \cond pico_async_context \defgroup pico_async_context pico_async_context \endcond 62 * \cond pico_bootsel_via_double_reset \defgroup pico_bootsel_via_double_reset pico_bootsel_via_double_reset \endcond 63 * \cond pico_flash \defgroup pico_flash pico_flash \endcond 64 * \cond pico_i2c_slave \defgroup pico_i2c_slave pico_i2c_slave \endcond 65 * \cond pico_multicore \defgroup pico_multicore pico_multicore \endcond 66 * \cond pico_rand \defgroup pico_rand pico_rand \endcond 67 * \cond pico_sha256 \defgroup pico_sha256 pico_sha256 \endcond 68 * \cond pico_stdlib \defgroup pico_stdlib pico_stdlib \endcond 69 * \cond pico_sync \defgroup pico_sync pico_sync \endcond 70 * \cond pico_time \defgroup pico_time pico_time \endcond 71 * \cond pico_unique_id \defgroup pico_unique_id pico_unique_id \endcond 72 * \cond pico_util \defgroup pico_util pico_util \endcond 73 * @} 74 * 75 * \defgroup third_party Third-party Libraries 76 * Third party libraries for implementing high level functionality. 77 * @{ 78 * \cond tinyusb 79 * \defgroup tinyusb_device tinyusb_device 80 * \defgroup tinyusb_host tinyusb_host 81 * \endcond 82 * @} 83 * 84 * \defgroup networking Networking Libraries 85 * Functions for implementing networking 86 * @{ 87 * \cond pico_btstack \defgroup pico_btstack pico_btstack \endcond 88 * \cond pico_lwip \defgroup pico_lwip pico_lwip \endcond 89 * \cond pico_cyw43_driver \defgroup pico_cyw43_driver pico_cyw43_driver \endcond 90 * \cond pico_cyw43_arch \defgroup pico_cyw43_arch pico_cyw43_arch \endcond 91 * @} 92 * 93 * \defgroup runtime Runtime Infrastructure 94 * Libraries that are used to provide efficient implementation of certain 95 * language level and C library functions, as well as CMake INTERFACE libraries 96 * abstracting the compilation and link steps in the SDK 97 * @{ 98 * \cond boot_stage2 \defgroup boot_stage2 boot_stage2 \endcond 99 * \cond pico_atomic \defgroup pico_atomic pico_atomic \endcond 100 * \cond pico_base_headers \defgroup pico_base pico_base \endcond 101 * \cond pico_binary_info \defgroup pico_binary_info pico_binary_info \endcond 102 * \cond pico_bootrom \defgroup pico_bootrom pico_bootrom \endcond 103 * \cond pico_bit_ops \defgroup pico_bit_ops pico_bit_ops \endcond 104 * \cond pico_cxx_options \defgroup pico_cxx_options pico_cxx_options \endcond 105 * \cond pico_clib_interface \defgroup pico_clib_interface pico_clib_interface \endcond 106 * \cond pico_crt0 \defgroup pico_crt0 pico_crt0 \endcond 107 * \cond pico_divider \defgroup pico_divider pico_divider \endcond 108 * \cond pico_double \defgroup pico_double pico_double \endcond 109 * \cond pico_float \defgroup pico_float pico_float \endcond 110 * \cond pico_int64_ops \defgroup pico_int64_ops pico_int64_ops \endcond 111 * \cond pico_malloc \defgroup pico_malloc pico_malloc \endcond 112 * \cond pico_mem_ops \defgroup pico_mem_ops pico_mem_ops \endcond 113 * \cond pico_platform \defgroup pico_platform pico_platform \endcond 114 * \cond pico_printf \defgroup pico_printf pico_printf \endcond 115 * \cond pico_runtime \defgroup pico_runtime pico_runtime \endcond 116 * \cond pico_runtime_init \defgroup pico_runtime_init pico_runtime_init \endcond 117 * \cond pico_stdio \defgroup pico_stdio pico_stdio \endcond 118 * \cond pico_standard_binary_info \defgroup pico_standard_binary_info pico_standard_binary_info \endcond 119 * \cond pico_standard_link \defgroup pico_standard_link pico_standard_link \endcond 120 * @} 121 * 122 * \defgroup misc External API Headers 123 * Headers for interfaces that are shared with code outside of the SDK 124 * @{ 125 * \cond boot_picobin_headers \defgroup boot_picobin_headers boot_picobin_headers \endcond 126 * \cond boot_picoboot_headers \defgroup boot_picoboot_headers boot_picoboot_headers \endcond 127 * \cond boot_uf2_headers \defgroup boot_uf2_headers boot_uf2_headers \endcond 128 * \cond pico_usb_reset_interface_headers \defgroup pico_usb_reset_interface_headers pico_usb_reset_interface_headers \endcond 129 * @} 130 */ 131
