Skip to content

Commit bac6dae

Browse files
Document new restartCore1 call
1 parent 5c186d8 commit bac6dae

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/multicore.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ void rp2040.resumeOtherCore()
4141

4242
Resumes processing in the other core, where it left off.
4343

44+
45+
void rp2040.restartCore1()
46+
~~~~~~~~~~~~~~~~~~~~~~~~~~
47+
48+
Hard resets Core1 from Core 0 and restarts its operation from ``setup1()``.
49+
4450
Communicating Between Cores
4551
---------------------------
4652

@@ -50,23 +56,23 @@ use the following functions to access a software-managed, multicore safe
5056
FIFO.
5157

5258
void rp2040.fifo.push(uint32_t)
53-
~~~~~~~~~~~~~~~~~~~~~~~~~~
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5460

5561
Pushes a value to the other core. Will block if the FIFO is full.
5662

5763
bool rp2040.fifo.push_nb(uint32_t)
58-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5965

6066
Pushes a value to the other core. If the FIFO is full, returns ``false``
6167
immediately and doesn't block. If the push is successful, returns ``true``.
6268

6369
uint32_t rp2040.fifo.pop()
64-
~~~~~~~~~~~~~~~~~~~~~
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~
6571

6672
Reads a value from this core's FIFO. Blocks until one is available.
6773

6874
bool rp2040.fifo.pop_nb(uint32_t *dest)
69-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7076
7177
Reads a value from this core's FIFO and places it in dest. Will return
7278
``true`` if successful, or ``false`` if the pop would block.

0 commit comments

Comments
 (0)