MultiCore Class Reference

Pico Multi Core Class. More...

#include <multicore.hpp>

Public Types
enum	CoreStatus { csStopped , csRunning , csStarting , csStopping }
	Defines possible values for CPU core status. More...
typedef void(*	MultiCoreEntry) (MultiCore &)
	Entry point to second core routine. More...

Public Member Functions
	MultiCore (MultiCoreEntry entry)
	Constructor. More...
	~MultiCore ()
	Destructor. More...
void	launch ()
	Runs the entry point routine into second CPU core. More...
void	stop ()
	Stops the execution of second CPU core. More...
bool	isRunning () const
	Return if second CPU core is running. More...
bool	isStopRequested () const
	Returns if the second CPU core has been requested to stop. More...
CoreStatus	getStatus () const
	Gets the status of second CPU core. More...
void	putParam (uintptr_t src)
	Sends a 32-bit parameter to second core routine. More...
uintptr_t	getParam ()
	Receives a 32-bit parameter sent from first core routine. More...
void	lock ()
	Locks execution line (using mutex). More...
void	unlock ()
	Unlocks execution line (using mutex). More...

Static Public Member Functions
static void	usleep (uint64_t us)
	Sleeps the execution of current CPU core for a number of microseconds. More...
static void	msleep (uint32_t ms)
	Sleeps the execution of current CPU core for a number of milliseconds. More...

Detailed Description

Pico Multi Core Class.

The purpose of this class is to allow processing on the second CPU core on the board.

Member Typedef Documentation

MultiCoreEntry

typedef void(* MultiCoreEntry) (MultiCore &)

Entry point to second core routine.

A valid routine to be used as an entry point for the second CPU core must be of this type.

For example:
void second_core_my_entry(MultiCore& core) { ... }

Member Enumeration Documentation

CoreStatus

enum CoreStatus

Defines possible values for CPU core status.

Enumerator
csStopped	Core is stopped.
csRunning	Core is running.
csStarting	Core is starting (initialization).
csStopping	Core is stopping (finalization).

Constructor & Destructor Documentation

MultiCore()

MultiCore ( MultiCoreEntry  entry )

explicit

Constructor.

Parameters

entry

Entry point (function) for second CPU core.

~MultiCore()

~MultiCore

(

)

Destructor.

Member Function Documentation

launch()

void launch

(

)

Runs the entry point routine into second CPU core.

stop()

void stop

(

)

Stops the execution of second CPU core.

isRunning()

bool isRunning

(

)

const

Return if second CPU core is running.

Returns

True if second CPU core is running, false otherwise.

isStopRequested()

bool isStopRequested

(

)

const

Returns if the second CPU core has been requested to stop.

Returns

True if second CPU core is stopping, false otherwise.

getStatus()

MultiCore::CoreStatus getStatus

(

)

const

Gets the status of second CPU core.

Returns

Status value. One of CoreStatus values.

putParam()

void putParam

(

uintptr_t

src

)

Sends a 32-bit parameter to second core routine.

Sends a parameter to second CPU core routine.
Blocks the caller (on first core) until the second core processes this parameter through getParam().

Parameters

src	Value to send.

getParam()

uintptr_t getParam

(

)

Receives a 32-bit parameter sent from first core routine.

Receives a parameter sent from first CPU core routine.
Blocks the caller (on second core) until the first core sends one parameter through putParam(uint32_t).

Returns

Value received.

lock()

void lock

(

)

Locks execution line (using mutex).

Protects code of the simultaneous write access (and race conditions).

unlock()

void unlock

(

)

Unlocks execution line (using mutex).

Protects code of the simultaneous write access (and race conditions).

usleep()

void usleep ( uint64_t  us )

static

Sleeps the execution of current CPU core for a number of microseconds.

Parameters

us	Number of microseconds to sleep.

msleep()

void msleep ( uint32_t  ms )

static

Sleeps the execution of current CPU core for a number of milliseconds.

Parameters

ms	Number of milliseconds to sleep.

---

The documentation for this class was generated from the following files:

• multicore.hpp
• multicore.cpp