Difference between revisions of "OCEOSmp/blank"
| Line 1: | Line 1: | ||
== Next Section == | == Next Section == | ||
==<span style="color:#0000ff">Task directives</span>== | |||
<span style="color:#1b7ac2">'''Data structures'''</span><br> | |||
===<span style="color:#0000ff">oceos_task_create()</span>=== | |||
<blockquote style="border-left-style: none;"> | |||
<span style="color:#1b7ac2">'''Header File'''</span><br> | |||
'''''tasks.h'''''<br> | |||
<span style="color:#1b7ac2">'''Description'''</span><br> | |||
Create a task. | |||
Can only be use before OCEOS starts. Stores the task information in the OCEOS fixed data area. | |||
This directive populates the data structures for a task. It should be called after [[OCEOSmp/directive_reference#oceos_init()|oceos_init()]] and before [[OCEOSmp/directive_reference#oceos_init_finish()|oceos_init_finish()]].<br> | |||
It must be called for each task otherwise [[OCEOSmp/directive_reference#oceos_start()|oceos_start()]] will return an error. | |||
===<span style="color:#0000ff">blank_function()</span>=== | |||
<blockquote style="border-left-style: none;"> | |||
<span style="color:#1b7ac2">'''Header File'''</span><br> | |||
'''''header.h'''''<br> | |||
<span style="color:#1b7ac2">'''Description'''</span><br> | |||
This function does xyz... | |||
<span style="color:#1b7ac2">'''Prototype'''</span><br> | |||
<syntaxhighlight lang="C"> | |||
S32_t oceosmp_blank( | |||
U32_t param | |||
); | |||
</syntaxhighlight> | |||
<span style="color:#1b7ac2">'''Parameters'''</span><br> | |||
{| class="wikitable" | |||
|- | |||
! Parameter || Description | |||
|- | |||
| param || parameter to function | |||
|} | |||
<span style="color:#1b7ac2">'''Returns'''</span><br> | |||
This function returns an S32_t with a value of OCEOS_SUCCESS (zero) or return code bits set as defined in the table below. | |||
{| class="wikitable" | |||
|- | |||
! Error bit !! Description | |||
|- | |||
| Error_name|| description | |||
|- | |||
|} | |||
<span style="color:#1b7ac2">'''Example Usage'''</span><br> | |||
<syntaxhighlight lang="C"> | |||
S32_t status, param; | |||
... | |||
// Do xyz | |||
status = oceosmp_blank(param)); | |||
</syntaxhighlight> | |||
</blockquote> | |||
[[Category:backup]] | |||
==<span style="color:#0000ff">Task directives</span>== | ==<span style="color:#0000ff">Task directives</span>== | ||
Revision as of 16:43, 3 May 2024
Next Section
Task directives
Data structures
oceos_task_create()
Header File
tasks.h
Description
Create a task. Can only be use before OCEOS starts. Stores the task information in the OCEOS fixed data area. This directive populates the data structures for a task. It should be called after oceos_init() and before oceos_init_finish().
It must be called for each task otherwise oceos_start() will return an error.
blank_function()
Header File
header.h
Description
This function does xyz...Prototype
S32_t oceosmp_blank( U32_t param );Parameters
Parameter Description param parameter to function Returns
This function returns an S32_t with a value of OCEOS_SUCCESS (zero) or return code bits set as defined in the table below.
Error bit Description Error_name description Example Usage
S32_t status, param; ... // Do xyz status = oceosmp_blank(param));Task directives
Task data structures
oceos_task_create()
Header File
tasks.h
Description
Create a task. Can only be use before OCEOS starts. Stores the task information in the OCEOS fixed data area. This directive populates the data structures for a task. It should be called after oceos_init() and before oceos_init_finish().
It must be called for each task otherwise oceos_start() will return an error.
blank_function()
Header File
header.h
Description
This function does xyz...Prototype
S32_t oceosmp_blank( U32_t param );Parameters
Parameter Description param parameter to function Returns
This function returns an S32_t with a value of OCEOS_SUCCESS (zero) or return code bits set as defined in the table below.
Error bit Description Error_name description Example Usage
S32_t status, param; ... // Do xyz status = oceosmp_blank(param));