diff --git a/docs/index.h b/docs/index.h index b760936c8..a4f88a431 100644 --- a/docs/index.h +++ b/docs/index.h @@ -48,9 +48,9 @@ * \cond hardware_watchdog \defgroup hardware_watchdog hardware_watchdog \endcond * \cond hardware_xip_cache \defgroup hardware_xip_cache hardware_xip_cache \endcond * \cond hardware_xosc \defgroup hardware_xosc hardware_xosc \endcond - * \cond hardware_powman hardware_powman - * \cond hardware_hazard3 hardware_hazard3 - * \cond hardware_riscv hardware_riscv + * \cond hardware_powman \defgroup hardware_powman hardware_powman \endcond + * \cond hardware_hazard3 \defgroup hardware_hazard3 hardware_hazard3 \endcond + * \cond hardware_riscv \defgroup hardware_riscv hardware_riscv \endcond * @} * diff --git a/src/common/pico_base_headers/include/pico/types.h b/src/common/pico_base_headers/include/pico/types.h index 2e9c39642..010181eef 100644 --- a/src/common/pico_base_headers/include/pico/types.h +++ b/src/common/pico_base_headers/include/pico/types.h @@ -23,18 +23,18 @@ typedef unsigned int uint; #endif /*! \typedef absolute_time_t - \brief An opaque 64 bit timestamp in microseconds - - The type is used instead of a raw uint64_t to prevent accidentally passing relative times or times in the wrong - time units where an absolute time is required. - - note: As of SDK 2.0.0 this type defaults to being a uin64_t (i.e. no protection); it is enabled - by setting PICO_OPAQUE_ABSOLUTE_TIME_T to 1 - - \see to_us_since_boot() - \see update_us_since_boot() - \ingroup timestamp -*/ + * \brief An opaque 64 bit timestamp in microseconds + * + * The type is used instead of a raw uint64_t to prevent accidentally passing relative times or times in the wrong + * time units where an absolute time is required. + * + * note: As of SDK 2.0.0 this type defaults to being a uin64_t (i.e. no protection); it is enabled + * by setting PICO_OPAQUE_ABSOLUTE_TIME_T to 1 + * + * \see to_us_since_boot() + * \see update_us_since_boot() + * \ingroup timestamp + */ #if PICO_OPAQUE_ABSOLUTE_TIME_T typedef struct { uint64_t _private_us_since_boot; diff --git a/src/common/pico_time/include/pico/time.h b/src/common/pico_time/include/pico/time.h index 771fe42d6..43d5ed7a9 100644 --- a/src/common/pico_time/include/pico/time.h +++ b/src/common/pico_time/include/pico/time.h @@ -216,7 +216,7 @@ static inline bool is_nil_time(absolute_time_t t) { * \note These functions should not be called from an IRQ handler. * * \note Lower powered sleep requires use of the \link alarm_pool_get_default default alarm pool\endlink which may - * be disabled by the PICO_TIME_DEFAULT_ALARM_POOL_DISABLED #define or currently full in which case these functions + * be disabled by the PICO_TIME_DEFAULT_ALARM_POOL_DISABLED \#define or currently full in which case these functions * become busy waits instead. * * \note Whilst \a sleep_ functions are preferable to \a busy_wait functions from a power perspective, the \a busy_wait equivalent function @@ -420,7 +420,7 @@ alarm_pool_timer_t *alarm_pool_get_default_timer(void); * \param max_timers the maximum number of timers * \note For implementation reasons this is limited to PICO_PHEAP_MAX_ENTRIES which defaults to 255 * \sa alarm_pool_get_default() - * \sa hardware_claiming + * \sa hardware_claim */ static inline alarm_pool_t *alarm_pool_create(uint timer_alarm_num, uint max_timers) { return alarm_pool_create_on_timer(alarm_pool_get_default_timer(), timer_alarm_num, max_timers); @@ -443,7 +443,7 @@ alarm_pool_t *alarm_pool_create_on_timer_with_unused_hardware_alarm(alarm_pool_t * \param max_timers the maximum number of timers * \note For implementation reasons this is limited to PICO_PHEAP_MAX_ENTRIES which defaults to 255 * \sa alarm_pool_get_default() - * \sa hardware_claiming + * \sa hardware_claim */ static inline alarm_pool_t *alarm_pool_create_with_unused_hardware_alarm(uint max_timers) { return alarm_pool_create_on_timer_with_unused_hardware_alarm(alarm_pool_get_default_timer(), max_timers); diff --git a/src/rp2_common/hardware_dma/include/hardware/dma.h b/src/rp2_common/hardware_dma/include/hardware/dma.h index 94b74cb7f..27dd92286 100644 --- a/src/rp2_common/hardware_dma/include/hardware/dma.h +++ b/src/rp2_common/hardware_dma/include/hardware/dma.h @@ -123,7 +123,7 @@ int dma_claim_unused_channel(bool required); * \param channel the dma channel * \return true if the channel is claimed, false otherwise * \see dma_channel_claim - * \see dma_channel_claim_mask + * \see dma_claim_mask */ bool dma_channel_is_claimed(uint channel); diff --git a/src/rp2_common/hardware_gpio/include/hardware/gpio.h b/src/rp2_common/hardware_gpio/include/hardware/gpio.h index f6f089523..f05bc0002 100644 --- a/src/rp2_common/hardware_gpio/include/hardware/gpio.h +++ b/src/rp2_common/hardware_gpio/include/hardware/gpio.h @@ -204,6 +204,11 @@ enum gpio_irq_level { */ typedef void (*gpio_irq_callback_t)(uint gpio, uint32_t event_mask); +/*! \brief GPIO override modes + * \ingroup hardware_gpio + * + * \sa gpio_set_irqover, gpio_set_outover, gpio_set_inover, gpio_set_oeover + */ enum gpio_override { GPIO_OVERRIDE_NORMAL = 0, ///< peripheral signal selected via \ref gpio_set_function GPIO_OVERRIDE_INVERT = 1, ///< invert peripheral signal selected via \ref gpio_set_function diff --git a/src/rp2_common/hardware_i2c/include/hardware/i2c.h b/src/rp2_common/hardware_i2c/include/hardware/i2c.h index 604b89f98..5453752e8 100644 --- a/src/rp2_common/hardware_i2c/include/hardware/i2c.h +++ b/src/rp2_common/hardware_i2c/include/hardware/i2c.h @@ -324,10 +324,10 @@ int i2c_write_blocking(i2c_inst_t *i2c, uint8_t addr, const uint8_t *src, size_t * (for example) without having to send address byte(s) repeatedly * * \param i2c Either \ref i2c0 or \ref i2c1 - * \param addr 7-bit address of device to read from - * \param dst Pointer to buffer to receive data - * \param len Length of data in bytes to receive - * \return Number of bytes read, or PICO_ERROR_GENERIC if address not acknowledged or no device present. + * \param addr 7-bit address of device to write to + * \param src Pointer to data to send + * \param len Length of data in bytes to send + * \return Number of bytes written, or PICO_ERROR_GENERIC if address not acknowledged or no device present. */ int i2c_write_burst_blocking(i2c_inst_t *i2c, uint8_t addr, const uint8_t *src, size_t len); diff --git a/src/rp2_common/hardware_interp/include/hardware/interp.h b/src/rp2_common/hardware_interp/include/hardware/interp.h index 634af0f46..befe1f8ca 100644 --- a/src/rp2_common/hardware_interp/include/hardware/interp.h +++ b/src/rp2_common/hardware_interp/include/hardware/interp.h @@ -107,7 +107,7 @@ void interp_unclaim_lane(interp_hw_t *interp, uint lane); */ bool interp_lane_is_claimed(interp_hw_t *interp, uint lane); -/*! \brief Release previously claimed interpolator lanes \see interp_claim_lane_mask +/*! \brief Release previously claimed interpolator lanes, see \ref interp_claim_lane_mask * \ingroup hardware_interp * * \param interp Interpolator on which to release lanes. interp0 or interp1 diff --git a/src/rp2_common/hardware_pio/include/hardware/pio.h b/src/rp2_common/hardware_pio/include/hardware/pio.h index b11733092..8654d32a7 100644 --- a/src/rp2_common/hardware_pio/include/hardware/pio.h +++ b/src/rp2_common/hardware_pio/include/hardware/pio.h @@ -680,7 +680,7 @@ static inline void sm_config_set_out_shift(pio_sm_config *c, bool shift_right, b * \ingroup sm_config * * \param c Pointer to the configuration structure to modify - * \param join Specifies the join type. \see enum pio_fifo_join + * \param join Specifies the join type. See \ref pio_fifo_join */ static inline void sm_config_set_fifo_join(pio_sm_config *c, enum pio_fifo_join join) { valid_params_if(HARDWARE_PIO, join == PIO_FIFO_JOIN_NONE || join == PIO_FIFO_JOIN_TX || join == PIO_FIFO_JOIN_RX @@ -720,7 +720,7 @@ static inline void sm_config_set_out_special(pio_sm_config *c, bool sticky, bool * \ingroup sm_config * * \param c Pointer to the configuration structure to modify - * \param status_sel the status operation selector. \see enum pio_mov_status_type + * \param status_sel the status operation selector. See \ref pio_mov_status_type * \param status_n parameter for the mov status operation (currently a bit count) */ static inline void sm_config_set_mov_status(pio_sm_config *c, enum pio_mov_status_type status_sel, uint status_n) { @@ -849,7 +849,7 @@ static inline uint pio_get_index(PIO pio) { * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 * \return the PIO instance number (0, 1, ...) - * \see gpio_function + * \see gpio_function_t */ static inline uint pio_get_funcsel(PIO pio) { check_pio_param(pio); @@ -948,7 +948,7 @@ bool pio_can_add_program_at_offset(PIO pio, const pio_program_t *program, uint o /*! \brief Attempt to load the program * \ingroup hardware_pio * - * \see pio_can_add_program() if you need to check whether the program can be loaded + * See pio_can_add_program() if you need to check whether the program can be loaded * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 * \param program the program definition @@ -960,7 +960,7 @@ int pio_add_program(PIO pio, const pio_program_t *program); /*! \brief Attempt to load the program at the specified instruction memory offset * \ingroup hardware_pio * - * \see pio_can_add_program_at_offset() if you need to check whether the program can be loaded + * See pio_can_add_program_at_offset() if you need to check whether the program can be loaded * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 * \param program the program definition @@ -998,7 +998,7 @@ void pio_clear_instruction_memory(PIO pio); * * The state machine is left disabled on return from this call. * -* * \if rp2350_specific + * \if rp2350_specific * See \ref sm_config_pins "sm_config_ pins" for more detail on why this method might fail on RP2350B * \endif * @@ -1006,7 +1006,7 @@ void pio_clear_instruction_memory(PIO pio); * \param sm State machine index (0..3) * \param initial_pc the initial program memory offset to run from * \param config the configuration to apply (or NULL to apply defaults) - * \return PICO_OK, or < 0 for an error (see \enum pico_error_codes) + * \return PICO_OK, or < 0 for an error (see \ref pico_error_codes) */ int pio_sm_init(PIO pio, uint sm, uint initial_pc, const pio_sm_config *config); @@ -1029,7 +1029,7 @@ static inline void pio_sm_set_enabled(PIO pio, uint sm, bool enabled) { * Note that this method just sets the enabled state of the state machine; * if now enabled they continue exactly from where they left off. * - * \see pio_enable_sm_mask_in_sync() if you wish to enable multiple state machines + * See pio_enable_sm_mask_in_sync() if you wish to enable multiple state machines * and ensure their clock dividers are in sync. * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 @@ -1049,7 +1049,7 @@ static inline void pio_set_sm_mask_enabled(PIO pio, uint32_t mask, bool enabled) * Note that this method just sets the enabled state of the state machine; * if now enabled they continue exactly from where they left off. * - * \see pio_enable_sm_mask_in_sync() if you wish to enable multiple state machines + * See pio_enable_sm_mask_in_sync() if you wish to enable multiple state machines * and ensure their clock dividers are in sync. * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 @@ -1419,7 +1419,7 @@ static inline uint8_t pio_sm_get_pc(PIO pio, uint sm) { * * This instruction is executed instead of the next instruction in the normal control flow on the state machine. * Subsequent calls to this method replace the previous executed - * instruction if it is still running. \see pio_sm_is_exec_stalled() to see if an executed instruction + * instruction if it is still running. See pio_sm_is_exec_stalled() to see if an executed instruction * is still running (i.e. it is stalled on some condition) * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 @@ -1450,7 +1450,7 @@ static inline bool pio_sm_is_exec_stalled(PIO pio, uint sm) { * * This instruction is executed instead of the next instruction in the normal control flow on the state machine. * Subsequent calls to this method replace the previous executed - * instruction if it is still running. \see pio_sm_is_exec_stalled() to see if an executed instruction + * instruction if it is still running. See pio_sm_is_exec_stalled() to see if an executed instruction * is still running (i.e. it is stalled on some condition) * * \param pio The PIO instance; e.g. \ref pio0 or \ref pio1 @@ -1982,7 +1982,7 @@ bool pio_sm_is_claimed(PIO pio, uint sm); * \param sm Returns the index of the PIO state machine that was claimed * \param offset Returns the instruction memory offset of the start of the program * \return true on success, false otherwise - * \see pio_remove_program_unclaim_sm + * \see pio_remove_program_and_unclaim_sm */ bool pio_claim_free_sm_and_add_program(const pio_program_t *program, PIO *pio, uint *sm, uint *offset); @@ -1994,7 +1994,7 @@ bool pio_claim_free_sm_and_add_program(const pio_program_t *program, PIO *pio, u * PIO instance can interact with both pins 0->15 or 32->47 at the same time. * * This method takes additional information about the GPIO pins needed (via gpio_base and gpio_count), - * and optionally will set the GPIO base (\see pio_set_gpio_base) of an unused PIO instance if necessary + * and optionally will set the GPIO base (see \ref pio_set_gpio_base) of an unused PIO instance if necessary * * \param program PIO program to add * \param pio Returns the PIO hardware instance or NULL if no PIO is available @@ -2006,7 +2006,7 @@ bool pio_claim_free_sm_and_add_program(const pio_program_t *program, PIO *pio, u * instance, then that PIO will be reconfigured so that this method can succeed * * \return true on success, false otherwise - * \see pio_remove_program_unclaim_sm + * \see pio_remove_program_and_unclaim_sm */ bool pio_claim_free_sm_and_add_program_for_gpio_range(const pio_program_t *program, PIO *pio, uint *sm, uint *offset, uint gpio_base, uint gpio_count, bool set_gpio_base); diff --git a/src/rp2_common/hardware_resets/include/hardware/resets.h b/src/rp2_common/hardware_resets/include/hardware/resets.h index 8baef728b..f75775717 100644 --- a/src/rp2_common/hardware_resets/include/hardware/resets.h +++ b/src/rp2_common/hardware_resets/include/hardware/resets.h @@ -23,6 +23,8 @@ * * Multiple blocks are referred to using a bitmask as follows: * + * \if rp2040_specific + * For RP2040: * Block to reset | Bit * ---------------|---- * USB | 24 @@ -41,15 +43,51 @@ * PIO 1 | 11 * PIO 0 | 10 * Pads - QSPI | 9 - * Pads - bank 0 | 8 + * Pads - Bank 0 | 8 * JTAG | 7 - * IO Bank 1 | 6 + * IO QSPI | 6 * IO Bank 0 | 5 * I2C 1 | 4 * I2C 0 | 3 * DMA | 2 * Bus Control | 1 * ADC 0 | 0 + * \endif + * + * \if rp2350_specific + * For RP2350: + * Block to reset | Bit + * ---------------|---- + * USB | 28 + * UART 1 | 27 + * UART 0 | 26 + * TRNG | 25 + * Timer 1 | 24 + * Timer 0 | 23 + * TB Manager | 22 + * SysInfo | 21 + * System Config | 20 + * SPI 1 | 19 + * SPI 0 | 18 + * SHA256 | 17 + * PWM | 16 + * PLL USB | 15 + * PLL System | 14 + * PIO 2 | 13 + * PIO 1 | 12 + * PIO 0 | 11 + * Pads - QSPI | 10 + * Pads - Bank 0 | 9 + * JTAG | 8 + * IO QSPI | 7 + * IO Bank 0 | 6 + * I2C 1 | 5 + * I2C 0 | 4 + * HSTX | 3 + * DMA | 2 + * Bus Control | 1 + * ADC 0 | 0 + * \endif * * \subsection reset_example Example * \addtogroup hardware_resets diff --git a/src/rp2_common/hardware_sha256/include/hardware/sha256.h b/src/rp2_common/hardware_sha256/include/hardware/sha256.h index db8fca6ff..dcbf1043d 100644 --- a/src/rp2_common/hardware_sha256/include/hardware/sha256.h +++ b/src/rp2_common/hardware_sha256/include/hardware/sha256.h @@ -122,7 +122,7 @@ static inline bool sha256_is_sum_valid(void) { * \ingroup hardware_sha256 * * After writing 64 bytes of data to the hardware, it will be unable to accept more data for a time. - * Call this to check if the hardware is ready for more data to be written. \see sha256_err_not_ready + * Call this to check if the hardware is ready for more data to be written. See \ref sha256_err_not_ready * * \return True if the hardware is ready to receive more data */ diff --git a/src/rp2_common/hardware_spi/include/hardware/spi.h b/src/rp2_common/hardware_spi/include/hardware/spi.h index cf79645da..bd83770c1 100644 --- a/src/rp2_common/hardware_spi/include/hardware/spi.h +++ b/src/rp2_common/hardware_spi/include/hardware/spi.h @@ -202,7 +202,7 @@ uint spi_set_baudrate(spi_inst_t *spi, uint baudrate); /*! \brief Get SPI baudrate * \ingroup hardware_spi * - * Get SPI baudrate which was set by \see spi_set_baudrate + * Get SPI baudrate which was set by \ref spi_set_baudrate * * \param spi SPI instance specifier, either \ref spi0 or \ref spi1 * \return The actual baudrate set diff --git a/src/rp2_common/hardware_timer/include/hardware/timer.h b/src/rp2_common/hardware_timer/include/hardware/timer.h index 289a28a34..b26964083 100644 --- a/src/rp2_common/hardware_timer/include/hardware/timer.h +++ b/src/rp2_common/hardware_timer/include/hardware/timer.h @@ -351,7 +351,7 @@ typedef void (*hardware_alarm_callback_t)(uint alarm_num); * \param timer the timer instance * \param alarm_num the hardware alarm to claim * \sa hardware_alarm_claim - * \sa hardware_claiming + * \sa hardware_claim */ void timer_hardware_alarm_claim(timer_hw_t *timer, uint alarm_num); @@ -362,7 +362,7 @@ void timer_hardware_alarm_claim(timer_hw_t *timer, uint alarm_num); * * \param alarm_num the hardware alarm to claim * \sa timer_hardware_alarm_claim - * \sa hardware_claiming + * \sa hardware_claim */ void hardware_alarm_claim(uint alarm_num); @@ -375,7 +375,7 @@ void hardware_alarm_claim(uint alarm_num); * \param required if true the function will panic if none are available * \return alarm_num the hardware alarm claimed or -1 if required was false, and none are available * \sa hardware_alarm_claim_unused - * \sa hardware_claiming + * \sa hardware_claim */ int timer_hardware_alarm_claim_unused(timer_hw_t *timer, bool required); @@ -387,7 +387,7 @@ int timer_hardware_alarm_claim_unused(timer_hw_t *timer, bool required); * \param required if true the function will panic if none are available * \return alarm_num the hardware alarm claimed or -1 if required was false, and none are available * \sa timer_hardware_alarm_claim_unused - * \sa hardware_claiming + * \sa hardware_claim */ int hardware_alarm_claim_unused(bool required); @@ -397,7 +397,7 @@ int hardware_alarm_claim_unused(bool required); * \param timer the timer instance * \param alarm_num the hardware alarm to unclaim * \sa hardware_alarm_unclaim - * \sa hardware_claiming + * \sa hardware_claim */ void timer_hardware_alarm_unclaim(timer_hw_t *timer, uint alarm_num); @@ -406,7 +406,7 @@ void timer_hardware_alarm_unclaim(timer_hw_t *timer, uint alarm_num); * * \param alarm_num the hardware alarm to unclaim * \sa timer_hardware_alarm_unclaim - * \sa hardware_claiming + * \sa hardware_claim */ void hardware_alarm_unclaim(uint alarm_num); diff --git a/src/rp2_common/pico_async_context/include/pico/async_context.h b/src/rp2_common/pico_async_context/include/pico/async_context.h index 6f7c4f0dc..8a19b9ca3 100644 --- a/src/rp2_common/pico_async_context/include/pico/async_context.h +++ b/src/rp2_common/pico_async_context/include/pico/async_context.h @@ -84,8 +84,8 @@ typedef struct async_context async_context_t; * A "timeout" represents some future action that must be taken at a specific time. * Its methods are called from the async_context under lock at the given time * - * \see async_context_add_worker_at - * \see async_context_add_worker_in_ms + * \see async_context_add_at_time_worker_at + * \see async_context_add_at_time_worker_in_ms */ typedef struct async_work_on_timeout { /*! @@ -119,8 +119,8 @@ typedef struct async_work_on_timeout { * to some external stimulus (usually an IRQ). * Its methods are called from the async_context under lock at the given time * - * \see async_context_add_worker_at - * \see async_context_add_worker_in_ms + * \see async_context_add_at_time_worker_at + * \see async_context_add_at_time_worker_in_ms */ typedef struct async_when_pending_worker { /*! diff --git a/src/rp2_common/pico_bootrom/include/pico/bootrom.h b/src/rp2_common/pico_bootrom/include/pico/bootrom.h index 76ef30300..db2f23d28 100644 --- a/src/rp2_common/pico_bootrom/include/pico/bootrom.h +++ b/src/rp2_common/pico_bootrom/include/pico/bootrom.h @@ -750,7 +750,7 @@ static inline int rom_load_partition_table(uint8_t *workarea_base, uint32_t work * NOTE: This method does not look at owner partitions, only the A partition passed and it's corresponding B partition. * * NOTE: You should not call this method directly when performing a Flash Update Boot before calling `explicit_buy`, as it may prevent - * any version downgrade from occuring - instead \see rom_pick_ab_update_partition() which wraps this function. + * any version downgrade from occuring - instead see \ref rom_pick_ab_update_partition() which wraps this function. * * \param workarea_base base address of work area * \param workarea_size size of work area diff --git a/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h b/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h index 46aa09896..5eb43d1b3 100644 --- a/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h +++ b/src/rp2_common/pico_cyw43_arch/include/pico/cyw43_arch.h @@ -59,7 +59,7 @@ extern "C" { * * As of right now, lwIP is the only supported TCP/IP stack, however the use of \c pico_cyw43_arch is intended to be independent of * the particular TCP/IP stack used (and possibly Bluetooth stack used) in the future. For this reason, the integration of lwIP - * is handled in the base (\c pico_cyw43_arch) library based on the #define \ref CYW43_LWIP used by the \c cyw43_driver. + * is handled in the base (\c pico_cyw43_arch) library based on the \#define \ref CYW43_LWIP used by the \c cyw43_driver. * * \note As of version 1.5.0 of the Raspberry Pi Pico SDK, the \c pico_cyw43_arch library no longer directly implements * the distinct behavioral abstractions. This is now handled by the more general \ref pico_async_context library. The @@ -169,7 +169,7 @@ extern "C" { * \ref cyw43_arch_init_default_async_context, however the user can specify use of their own async_context * by calling \ref cyw43_arch_set_async_context() before calling this method * - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_init(void); @@ -186,7 +186,7 @@ int cyw43_arch_init(void); * by calling \ref cyw43_arch_set_async_context() before calling this method * * \param country the country code to use (see \ref CYW43_COUNTRY_) - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_init_with_country(uint32_t country); @@ -399,7 +399,7 @@ void cyw43_arch_disable_ap_mode(void); * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t auth); @@ -413,7 +413,7 @@ int cyw43_arch_wifi_connect_blocking(const char *ssid, const char *pw, uint32_t * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_bssid_blocking(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth); @@ -427,7 +427,7 @@ int cyw43_arch_wifi_connect_bssid_blocking(const char *ssid, const uint8_t *bssi * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \param timeout how long to wait in milliseconds for a connection to succeed before giving up * - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_t auth, uint32_t timeout); @@ -442,7 +442,7 @@ int cyw43_arch_wifi_connect_timeout_ms(const char *ssid, const char *pw, uint32_ * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * \param timeout how long to wait in milliseconds for a connection to succeed before giving up * - * \return 0 if the initialization is successful, an error code otherwise \see pico_error_codes + * \return 0 if the initialization is successful, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_bssid_timeout_ms(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth, uint32_t timeout); @@ -458,7 +458,7 @@ int cyw43_arch_wifi_connect_bssid_timeout_ms(const char *ssid, const uint8_t *bs * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * - * \return 0 if the scan was started successfully, an error code otherwise \see pico_error_codes + * \return 0 if the scan was started successfully, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_async(const char *ssid, const char *pw, uint32_t auth); @@ -475,7 +475,7 @@ int cyw43_arch_wifi_connect_async(const char *ssid, const char *pw, uint32_t aut * \param auth the authorization type to use when the password is enabled. Values are \ref CYW43_AUTH_WPA_TKIP_PSK, * \ref CYW43_AUTH_WPA2_AES_PSK, or \ref CYW43_AUTH_WPA2_MIXED_PSK (see \ref CYW43_AUTH_) * - * \return 0 if the scan was started successfully, an error code otherwise \see pico_error_codes + * \return 0 if the scan was started successfully, an error code otherwise see \ref pico_error_codes */ int cyw43_arch_wifi_connect_bssid_async(const char *ssid, const uint8_t *bssid, const char *pw, uint32_t auth); diff --git a/src/rp2_common/pico_multicore/include/pico/multicore.h b/src/rp2_common/pico_multicore/include/pico/multicore.h index 5eb49ddce..9b4622a98 100644 --- a/src/rp2_common/pico_multicore/include/pico/multicore.h +++ b/src/rp2_common/pico_multicore/include/pico/multicore.h @@ -151,7 +151,7 @@ static inline bool multicore_fifo_rvalid(void) { * * See the note in the \ref multicore_fifo section for considerations regarding use of the inter-core FIFOs * - * @return true if the FIFO has room for more data, false otherwise + * \return true if the FIFO has room for more data, false otherwise */ static inline bool multicore_fifo_wready(void) { return sio_hw->fifo_st & SIO_FIFO_ST_RDY_BITS; @@ -316,7 +316,7 @@ static inline void check_doorbell_num_param(__unused uint doorbell_num) { * * \param doorbell_num the doorbell number to claim * \param core_mask 0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 - * \sa hardware_claiming + * \sa hardware_claim */ void multicore_doorbell_claim(uint doorbell_num, uint core_mask); @@ -328,7 +328,7 @@ void multicore_doorbell_claim(uint doorbell_num, uint core_mask); * \param core_mask 0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 * \param required if true the function will panic if none are available * \return the doorbell number claimed or -1 if required was false, and none are available - * \sa hardware_claiming + * \sa hardware_claim */ int multicore_doorbell_claim_unused(uint core_mask, bool required); @@ -337,7 +337,7 @@ int multicore_doorbell_claim_unused(uint core_mask, bool required); * * \param doorbell_num the doorbell number to unclaim * \param core_mask 0b01: core 0, 0b10: core 1, 0b11 both core 0 and core 1 - * \sa hardware_claiming + * \sa hardware_claim */ void multicore_doorbell_unclaim(uint doorbell_num, uint core_mask); diff --git a/src/rp2_common/pico_rand/include/pico/rand.h b/src/rp2_common/pico_rand/include/pico/rand.h index b0a337f24..e3bbe2df8 100644 --- a/src/rp2_common/pico_rand/include/pico/rand.h +++ b/src/rp2_common/pico_rand/include/pico/rand.h @@ -25,7 +25,7 @@ extern "C" { * The random numbers (32 to 128 bit) to be supplied are read from the PRNG which is used * to help provide a large number space. * - * The following (multiple) sources of entropy are available (of varying quality), each enabled by a #define: + * The following (multiple) sources of entropy are available (of varying quality), each enabled by a \#define: * * - The Ring Oscillator (ROSC) (\ref PICO_RAND_ENTROPY_SRC_ROSC == 1): * \ref PICO_RAND_ROSC_BIT_SAMPLE_COUNT bits are gathered from the ring oscillator "random bit" and mixed in each @@ -47,7 +47,7 @@ extern "C" { * - Time (\ref PICO_RAND_SEED_ENTROPY_SRC_TIME == 1): The 64-bit microsecond timer is mixed into the seed. * - Board Identifier (PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID == 1): The board id via \ref pico_get_unique_board_id * is mixed into the seed. - * - RAM hash (\ref PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH (\ref PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH): The hashed contents of a + * - RAM hash (\ref PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH): The hashed contents of a * subset of RAM are mixed in. Initial RAM contents are undefined on power up, so provide a reasonable source of entropy. * By default the last 1K of RAM (which usually contains the core 0 stack) is hashed, which may also provide for differences * after each warm reset. diff --git a/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h b/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h index c487f96ab..9e6575a30 100644 --- a/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h +++ b/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h @@ -197,7 +197,7 @@ bool stdio_usb_connected(void); /*! \brief Explicitly calls the registered USB stdio chars_available_callback * \ingroup pico_stdio_usb * - * \ref This method is normally called by the internal USB stdio background thread when there is new USB CDC + * This method is normally called by the internal USB stdio background thread when there is new USB CDC * data available to read. However, if the internal background thread is disabled (e.g. when the user * directly links tinyUSB), the user will need to implement their own background thread and call this * method directly.