/hal_rpi_pico-latest/src/rp2_common/pico_cyw43_arch/include/pico/ |
D | cyw43_arch.h | 56 …* * \em 'poll' - This not multi-core/IRQ safe, and requires the user to call \ref cyw43_arch_poll … 62 …* is handled in the base (\c pico_cyw43_arch) library based on the #define \ref CYW43_LWIP used by… 65 …* the distinct behavioral abstractions. This is now handled by the more general \ref pico_async_co… 73 …* to a more generic library in a future release. The locking methods are now backed by their \ref … 74 …ose methods may be used interchangeably (see \ref cyw43_arch_lwip_begin, \ref cyw43_arch_lwip_end … 79 …* Whilst you can use the \c pico_cyw43_arch library directly and specify \ref CYW43_LWIP (and othe… 84 * The user must call \ref cyw43_arch_poll periodically from their main loop. 95 …an those made from lwIP callbacks, must be bracketed with \ref cyw43_arch_lwip_begin and \ref cyw4… 108 …callbacks, or from any task if you bracket the calls with \ref cyw43_arch_lwip_begin and \ref cyw4… 123 …* must be bracketed with \ref cyw43_arch_lwip_begin and \ref cyw43_arch_lwip_end. It is fine to… [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_pio/include/hardware/ |
D | pio.h | 82 * instance either addresses pins 0-31 or 16-47 based on \ref pio_set_gpio_base). The 195 …* \brief Returns \ref gpio_function_t needed to select the PIO function for the given PIO instance… 207 …* \brief Returns the \ref dreq_num_t used for pacing DMA transfers to or from a given state machin… 225 * \brief Returns the \ref irq_num_t for processor interrupts from the given PIO instance 238 * structures. See \ref pio_sm_set_config 249 * instance either addresses pins 0-31 or 16-47 based on \ref pio_set_gpio_base). The 260 …* \ref pio_sm_set_config (or \ref pio_sm_init which calls it) attempts to apply the configuratio… 262 …* or if the PIO's GPIO base (see \ref pio_set_gpio_base) does not allow access to the required p… 264 …* To be clear, \ref pio_sm_set_config does not change the PIO's GPIO base for you; you must conf… 265 …* GPIO base before calling the method, however you can use \ref pio_claim_free_sm_and_add_progra… [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_uart/include/hardware/ |
D | uart.h | 142 * \brief Returns the \ref dreq_num_t used for pacing DMA transfers to or from this UART instance. 161 * \brief Returns \ref clock_num_t of the clock for the given UART instance 173 …* \brief Returns \ref gpio_function_t needed to select the UART function for the given UART instan… 189 * \brief Returns the \ref irq_num_t for processor interrupts from the given UART instance 203 * \brief Returns the \ref reset_num_t used to reset a given UART instance 276 * \param uart UART instance. \ref uart0 or \ref uart1 288 * \param uart UART instance. \ref uart0 or \ref uart1 308 * \param uart UART instance. \ref uart0 or \ref uart1 317 * \param uart UART instance. \ref uart0 or \ref uart1 343 * \param uart UART instance. \ref uart0 or \ref uart1 [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_runtime/include/pico/ |
D | runtime.h | 18 * * \ref hardware_uart 19 * * \ref pico_bit_ops 20 * * \ref pico_divider 21 * * \ref pico_double 22 * * \ref pico_int64_ops 23 * * \ref pico_float 24 * * \ref pico_malloc 25 * * \ref pico_mem_ops 26 * * \ref pico_atomic 27 * * \ref pico_cxx_options [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_spi/include/hardware/ |
D | spi.h | 37 * Controller can be defined as master or slave using the \ref spi_set_slave function. 126 * \brief Returns the \ref dreq_num_t used for pacing DMA transfers to or from this SPI instance. 174 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 186 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 196 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 207 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 238 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 273 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 296 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 306 * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_i2c/include/hardware/ |
D | i2c.h | 40 …* This API allows the controller to be set up as a master or a slave using the \ref i2c_set_slave_… 110 * \param i2c Either \ref i2c0 or \ref i2c1 119 * \param i2c Either \ref i2c0 or \ref i2c1 133 * \param i2c Either \ref i2c0 or \ref i2c1 142 * \param i2c Either \ref i2c0 or \ref i2c1 186 * \brief Returns the \ref dreq_num_t used for pacing DMA transfers to or from this I2C instance. 216 * \return pointer to \ref i2c_hw_t 237 * \param i2c Either \ref i2c0 or \ref i2c1 254 * \param i2c Either \ref i2c0 or \ref i2c1 268 * \param i2c Either \ref i2c0 or \ref i2c1 [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_aon_timer/include/pico/ |
D | aon_timer.h | 34 * * \ref aon_timer_start_with_timeofday 35 * * \ref aon_timer_start 36 * * \ref aon_timer_set_time 37 * * \ref aon_timer_get_time 38 * * \ref aon_timer_enable_alarm 40 …* This conversion is handled by the \ref pico_localtime_r method. By default, this pulls in the C … 49 * * \ref aon_timer_start_calendar 50 * * \ref aon_timer_set_time_calendar 51 * * \ref aon_timer_get_time_calendar 52 * * \ref aon_timer_enable_alarm_calendar [all …]
|
/hal_rpi_pico-latest/docs/ |
D | examples.md | 5 - [RTC example](@ref rtc_example) 6 - [UART example](@ref uart_example) 7 - [ADC example](@ref adc_example) 8 - [I2C example](@ref i2c_example) 9 - [Clock example](@ref clock_example) 10 - [Timer example](@ref timer_example) 11 - [Flash programming example](@ref flash_example) 12 - [Watchdog example](@ref watchdog_example) 13 - [Divider example](@ref divider_example) 14 - [PWM example](@ref pwm_example) [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_multicore/include/pico/ |
D | multicore.h | 45 * \brief Returns the \ref irq_num_t for the FIFO IRQ on the given core. 69 …reset core 1 into its initial state (ready for launching code against via \ref multicore_launch_co… 80 …* core 1 must previously have been reset either as a result of a system reset or by calling \ref m… 94 …* core 1 must previously have been reset either as a result of a system reset or by calling \ref m… 113 …* core 1 must previously have been reset either as a result of a system reset or by calling \ref m… 132 …* core 1 launch or by the \ref multicore_lockout functions). Additionally they are often required … 135 * well handled by using a \ref queue 141 …* See the note in the \ref multicore_fifo section for considerations regarding use of the inter-co… 152 …* See the note in the \ref multicore_fifo section for considerations regarding use of the inter-co… 164 * Use \ref multicore_fifo_wready() to check if it is possible to write to the [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_flash/include/pico/ |
D | flash.h | 26 …* This library provides a \ref flash_safe_execute method which calls a function back having succes… 30 …* the user can provide their own mechanism by providing a strong definition of \ref get_flash_safe… 33 * otherwise returning an error (or an assert depending on \ref PICO_FLASH_ASSERT_ON_UNSAFE). 37 …h `configNUM_CORES=1` - FreeRTOS still uses pico_multicore in this case, so \ref flash_safe_execute 42 …* 3. pico_multicore without \ref flash_safe_execute_core_init() having been called on the other co… 43 …* \ref flash_safe_execute method does not know if code is executing on the other core, so it has t… 44 …* way, it is not able to intervene if \ref flash_safe_execute_core_init() has not been called on t… 48 * * Set \ref PICO_FLASH_ASSUME_CORE0_SAFE=1 to explicitly say that core 0 is never using flash. 49 * * Set \ref PICO_FLASH_ASSUME_CORE1_SAFE=1 to explicitly say that core 1 is never using flash. 57 * \brief Initialize a core such that the other core can lock it out during \ref flash_safe_execute. [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_stdio/include/pico/ |
D | stdio.h | 64 …* via the variables specified in \ref stdio_usb_init (i.e. \ref PICO_STDIO_USB_CONNECT_WAIT_TIMEOU… 94 /*! \brief Alias for \ref stdio_getchar_timeout_us for backwards compatibility 135 /*! \brief Alias for \ref stdio_putchar_raw for backwards compatibility 147 /*! \brief Alias for \ref stdio_puts_raw for backwards compatibility 189 /*! \brief stdio_getchar Alias for \ref getchar that definitely does not go thru the implementation 190 * in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0 196 /*! \brief stdio_getchar Alias for \ref putchar that definitely does not go thru the implementation 197 * in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0 203 /*! \brief stdio_getchar Alias for \ref puts that definitely does not go thru the implementation 204 * in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0 [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_watchdog/include/hardware/ |
D | watchdog.h | 45 …* \note If \ref watchdog_start_tick value does not give a 1MHz clock to the watchdog system, then … 48 * By default the SDK assumes a 12MHz XOSC and sets the \ref watchdog_start_tick appropriately. 74 …* \note If \ref watchdog_start_tick value does not give a 1MHz clock to the watchdog system, then … 77 * By default the SDK assumes a 12MHz XOSC and sets the \ref watchdog_start_tick appropriately. 79 …* This method sets a marker in the watchdog scratch register 4 that is checked by \ref watchdog_en… 81 …* onto the RPI-RP2), then this value will be cleared, and so \ref watchdog_enable_caused_reboot wi… 108 …* Perform additional checking along with \ref watchdog_caused_reboot to determine if a watchdog ti… 109 * \ref watchdog_enable caused the last reboot. 111 …* This method checks for a special value in watchdog scratch register 4 placed there by \ref watch… 112 …* This would not be present if a watchdog reset is initiated by \ref watchdog_reboot or by the RP-… [all …]
|
/hal_rpi_pico-latest/src/host/hardware_irq/include/hardware/ |
D | irq.h | 137 * \param num Interrupt number \ref interrupt_nums 158 * \param num Interrupt number \ref interrupt_nums 166 * \param num Interrupt number \ref interrupt_nums 174 * \param num Interrupt number \ref interrupt_nums 182 …* \param mask 32-bit mask with one bits set for the interrupts to enable/disable \ref interrupt_nu… 191 …* \param mask 32-bit mask with one bits set for the interrupts to enable/disable \ref interrupt_nu… 206 * \param num Interrupt number \ref interrupt_nums 207 * \param handler The handler to set. See \ref irq_handler_t 218 * \param num Interrupt number \ref interrupt_nums 236 * \param num Interrupt number \ref interrupt_nums [all …]
|
/hal_rpi_pico-latest/src/common/pico_stdlib_headers/include/pico/ |
D | stdlib.h | 30 * - @ref hardware_divider 31 * - @ref hardware_gpio 32 * - @ref hardware_uart 33 * - @ref pico_runtime 34 * - @ref pico_platform 35 * - @ref pico_stdio 36 * - @ref pico_time 37 * - @ref pico_util 77 * @ref pico_stdio_uart library is linked.
|
/hal_rpi_pico-latest/src/rp2_common/hardware_irq/include/hardware/ |
D | irq.h | 204 * \param num Interrupt number \ref interrupt_nums 241 * \param num Interrupt number \ref interrupt_nums 249 * \param num Interrupt number \ref interrupt_nums 257 * \param num Interrupt number \ref interrupt_nums 265 …* \param mask 32-bit mask with one bits set for the interrupts to enable/disable \ref interrupt_nu… 274 …* \param mask 32-bit mask with one bits set for the interrupts to enable/disable \ref interrupt_nu… 289 * \param num Interrupt number \ref interrupt_nums 290 * \param handler The handler to set. See \ref irq_handler_t 301 * \param num Interrupt number \ref interrupt_nums 319 * \param num Interrupt number \ref interrupt_nums [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_sha256/include/hardware/ |
D | sha256.h | 19 …* The hardware should first be configured by calling the \ref sha256_set_dma_size and \ref sha256_… 20 * To generate a new hash the hardware should first be initialised by calling \ref sha256_start. 21 * The hardware is ready to accept data when \ref sha256_is_ready returns true, 22 …* at which point the data to be hashed can be written to the address returned by \ref sha256_get_w… 23 …* The hardware requires 64 bytes to be written in one go or else \ref sha256_err_not_ready will in… 25 …* \ref sha256_is_sum_valid will return true when there is a valid checksum result which can be ret… 115 * \return True if \ref sha256_get_result would return a valid result 161 …* Read the 32 byte result calculated by the hardware. Only valid if \ref sha256_is_sum_valid is Tr…
|
/hal_rpi_pico-latest/src/rp2_common/hardware_gpio/include/hardware/ |
D | gpio.h | 63 …* The function allocated to each GPIO is selected by calling the \ref gpio_set_function function. … 201 * \param event_mask Which events caused this interrupt. See \ref gpio_irq_level for details. 208 GPIO_OVERRIDE_NORMAL = 0, ///< peripheral signal selected via \ref gpio_set_function 209 GPIO_OVERRIDE_INVERT = 1, ///< invert peripheral signal selected via \ref gpio_set_function 252 * \param fn Which GPIO function select to use from list \ref gpio_function_t 261 * \param fn Which GPIO function select to use from list \ref gpio_function_t 270 * \param fn Which GPIO function select to use from list \ref gpio_function_t 278 * \return Which GPIO function is currently selected from list \ref gpio_function_t 347 * \param value See \ref gpio_override 355 * \param value See \ref gpio_override [all …]
|
/hal_rpi_pico-latest/src/rp2_common/pico_i2c_slave/include/pico/ |
D | i2c_slave.h | 46 …* When sending data to master, up to \ref i2c_get_write_available() bytes can be written without … 47 …* When receiving data from master, up to \ref i2c_get_read_available() bytes can be read without b… 49 * \param i2c Either \ref i2c0 or \ref i2c1 67 * \param i2c Either \ref i2c0 or \ref i2c1
|
/hal_rpi_pico-latest/src/rp2_common/pico_async_context/include/pico/ |
D | async_context.h | 10 …* \brief An \ref async_context provides a logically single-threaded context for performing work, a… 26 …* * <em>when_pending</em> workers, which are processed whenever they have work pending. See \ref a… 27 …* \ref async_context_remove_when_pending_worker, and \ref async_context_set_work_pending, the latt… 33 * The async_context provides locking mechanisms, see \ref async_context_acquire_lock_blocking, 34 * \ref async_context_release_lock and \ref async_context_lock_check which can be used by 36 * Locked code runs on the calling core, however \ref async_context_execute_sync is provided to 42 * \ref async_context_poll() periodically, and can use async_context_wait_for_work_until() to sleep 47 …* that uses the async context in another (non-IRQ) context on the same core. Calling \ref async_co… 53 …* \ref async_context_poll() is not required, and is a no-op. This context implements async_context… 174 …* \brief Base structure type of all async_contexts. For details about its use, see \ref pico_async… [all …]
|
/hal_rpi_pico-latest/src/rp2_common/hardware_sync/include/hardware/ |
D | sync.h | 37 …* methods here (e.g. \ref spin_lock_blocking) always disable interrupts while the lock is held as … 51 …* 14,15 | (\ref PICO_SPINLOCK_ID_OS1 and \ref PICO_SPINLOCK_ID_OS2). Currently reserved for … 52 … (\ref PICO_SPINLOCK_ID_STRIPED_FIRST - \ref PICO_SPINLOCK_ID_STRIPED_LAST). Spin locks from this … 53 …ref PICO_SPINLOCK_ID_CLAIM_FREE_FIRST - \ref PICO_SPINLOCK_ID_CLAIM_FREE_LAST). These are reserved… 245 * e.g. when paired with \ref save_and_disable_interrupts() 271 … holding this spin lock briefly (and with IRQs disabled - the default via \ref spin_lock_blocking(…
|
/hal_rpi_pico-latest/src/rp2_common/pico_lwip/include/pico/ |
D | lwip_freertos.h | 22 … that is required to hook up lwIP (with full blocking API support) via an \ref async_context insta… 28 …* If the initialization succeeds, \ref lwip_freertos_deinit() can be called to shutdown lwIP suppo… 31 * this would be an \ref async_context_freertos instance, though it doesn't have to be. 43 * It is however safe to call \ref lwip_freertos_init again later. 45 …* \param context the async_context the lwip_freertos support was added to via \ref lwip_freertos_i…
|
D | lwip_nosys.h | 22 * Simple \c init and \c deinit are all that is required to hook up lwIP via an \ref async_context i… 28 * If the initialization succeeds, \ref lwip_nosys_deinit() can be called to shutdown lwIP support 41 * It is however safe to call \ref lwip_nosys_init again later. 43 * \param context the async_context the lwip_nosys support was added to via \ref lwip_nosys_init
|
/hal_rpi_pico-latest/src/rp2_common/pico_rand/include/pico/ |
D | rand.h | 30 * - The Ring Oscillator (ROSC) (\ref PICO_RAND_ENTROPY_SRC_ROSC == 1): 31 …* \ref PICO_RAND_ROSC_BIT_SAMPLE_COUNT bits are gathered from the ring oscillator "random bit" … 36 …* - Time (\ref PICO_RAND_ENTROPY_SRC_TIME == 1): The 64-bit microsecond timer is mixed in each ti… 37 …* - Bus Performance Counter (\ref PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER == 1): One of the bus fa… 45 * - The Ring Oscillator (ROSC) (\ref PICO_RAND_SEED_ENTROPY_SRC_ROSC == 1): 47 …* - Time (\ref PICO_RAND_SEED_ENTROPY_SRC_TIME == 1): The 64-bit microsecond timer is mixed into … 48 …* - Board Identifier (PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID == 1): The board id via \ref pico_get_u… 50 …* - RAM hash (\ref PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH (\ref PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH)…
|
/hal_rpi_pico-latest/src/rp2_common/pico_stdio_uart/include/pico/ |
D | stdio_uart.h | 43 …* \note this method is automatically called by \ref stdio_init_all() if `pico_stdio_uart` is inclu… 64 * \param uart the uart instance to use, \ref uart0 or \ref uart1 77 …* \note this method is automatically called by \ref stdio_deinit_all() if `pico_stdio_uart` is inc… 98 * \param uart the uart instance to use, \ref uart0 or \ref uart1
|
/hal_rpi_pico-latest/src/rp2_common/pico_cyw43_driver/include/pico/ |
D | cyw43_driver.h | 13 …* \brief A wrapper around the lower level cyw43_driver, that integrates it with \ref pico_async_co… 32 * If the initialization succeeds, \ref lwip_nosys_deinit() can be called to shutdown lwIP support 42 * \param context the async_context the cyw43_driver support was added to via \ref cyw43_driver_init 90 * This function is only available if \ref CYW43_PIO_CLOCK_DIV_DYNAMIC is true 108 * This function is only available if \ref CYW43_PIN_WL_DYNAMIC is true
|