File tree Expand file tree Collapse file tree 1 file changed +4
-0
lines changed
src/rp2_common/pico_flash/include/pico Expand file tree Collapse file tree 1 file changed +4
-0
lines changed Original file line number Diff line number Diff line change @@ -58,6 +58,7 @@ extern "C" {
5858
5959/**
6060 * Initialize a core such that the other core can lock it out during \ref flash_safe_execute.
61+ * \ingroup pico_flash
6162 *
6263 * \note This is not necessary for FreeRTOS SMP, but should be used when launching via \ref multicore_launch_core1
6364 * \return true on success; there is no need to call \ref flash_safe_execute_core_deinit() on failure.
@@ -66,12 +67,14 @@ bool flash_safe_execute_core_init(void);
6667
6768/**
6869 * De-initialize work done by \ref flash_safe_execute_core_init
70+ * \ingroup pico_flash
6971 * \return true on success
7072 */
7173bool flash_safe_execute_core_deinit (void );
7274
7375/**
7476 * Execute a function with IRQs disabled and with the other core also not executing/reading flash
77+ * \ingroup pico_flash
7578 *
7679 * \param func the function to call
7780 * \param param the parameter to pass to the function
@@ -116,6 +119,7 @@ typedef struct {
116119
117120/**
118121 * Internal method to return the flash safety helper implementation.
122+ * \ingroup pico_flash
119123 *
120124 * Advanced users can provide their own implementation of this function to perform
121125 * different inter-core coordination before disabling XIP mode.
You can’t perform that action at this time.
0 commit comments