Deprecated MMOSAL API

Detailed Description

This API should not be used by applications, since it may not be supported by all MMOSAL implementations.

Macros
#define	MMOSAL_DEPRECATED_API_ENABLED   (1)
	Default to enabling deprecated API for backwards compatibility. More...

Functions
void	mmosal_task_join (struct mmosal_task *task)
	Block until the given task has terminated. More...
bool	mmosal_task_wait_for_notification (uint32_t timeout_ms)
	Blocks the current task until a notification is received. More...
void	mmosal_task_notify (struct mmosal_task *task)
	Notifies a waiting task (mmosal_task_wait_for_notification()) that it can continue. More...
void	mmosal_task_notify_from_isr (struct mmosal_task *task)
	Notifies a waiting task (mmosal_task_wait_for_notification()) that it can continue. More...

Macro Definition Documentation

MMOSAL_DEPRECATED_API_ENABLED

#define MMOSAL_DEPRECATED_API_ENABLED   (1)

Default to enabling deprecated API for backwards compatibility.

Set this to 0 to remove deprecated API declarations.

Definition at line 1060 of file mmosal.h.

Function Documentation

mmosal_task_join()

void mmosal_task_join

(

struct mmosal_task *

task

)

Block until the given task has terminated.

Parameters

task	Handle of the task to wait for.

Note

With FreeRTOS deleted tasks will not be cleaned up until the idle task runs.

mmosal_task_notify()

void mmosal_task_notify

(

struct mmosal_task *

task

)

Notifies a waiting task (mmosal_task_wait_for_notification()) that it can continue.

Warning

Must not be called from ISR context.

Parameters

task	Handle of the task to notify.

See also

mmosal_task_wait_for_notification()

Deprecated:

Do not invoke this function because it is deprecated and will be removed from the mmosal API in a future release.

mmosal_task_notify_from_isr()

void mmosal_task_notify_from_isr

(

struct mmosal_task *

task

)

Notifies a waiting task (mmosal_task_wait_for_notification()) that it can continue.

Warning

Must only be called from ISR context.

Parameters

task	Handle of the task to notify.

See also

mmosal_task_wait_for_notification()

Deprecated:

Do not invoke this function because it is deprecated and will be removed from the mmosal API in a future release.

mmosal_task_wait_for_notification()

bool mmosal_task_wait_for_notification

(

uint32_t

timeout_ms

)

Blocks the current task until a notification is received.

Notifications can be sent using mmosal_task_notify() or mmosal_task_notify_from_isr().

Parameters

timeout_ms

The time to wait before giving up (or UINT32_MAX to wait forever).

Returns

true of a notification was received or false if it timed out.

See also

mmosal_task_notify()

mmosal_task_notify_from_isr()

Deprecated:

Do not invoke this function because it is deprecated and will be removed from the mmosal API in a future release.