OCEOSmp/blank - Revision history

Bkavanagh at 16:56, 3 May 2024

2024-05-03T16:56:12Z

← Older revision		Revision as of 16:56, 3 May 2024
Line 1:		Line 1:
	== Next Section ==		== Next Section ==

	~~==<span style="color:#0000ff">Task directives</span>==~~

	~~<span style="color:#1b7ac2">'''Header File'''</span><br>~~
	~~'''''tasks.h'''''<br>~~

	~~<span style="color:#1b7ac2">'''Description'''</span><br>~~
	~~The following data structures are used by some of the task directives.~~



	~~===<span style="color:#0000ff">oceos_task_create()</span>===~~



	===<span style="color:#0000ff">blank_function()</span>===		===<span style="color:#0000ff">blank_function()</span>===

Bkavanagh at 16:55, 3 May 2024

2024-05-03T16:55:10Z

← Older revision		Revision as of 16:55, 3 May 2024
Line 12:		Line 12:

	===<span style="color:#0000ff">oceos_task_create()</span>===		===<span style="color:#0000ff">oceos_task_create()</span>===
	~~<blockquote style="border-left-style: none;">~~

Bkavanagh: /* Task directives */

2024-05-03T16:51:50Z

Task directives

← Older revision		Revision as of 16:51, 3 May 2024
Line 9:		Line 9:
	The following data structures are used by some of the task directives.		The following data structures are used by some of the task directives.

	~~<span style="color:#1b7ac2">'''Data structures'''</span><br>~~


	===<span style="color:#0000ff">oceos_task_create()</span>===		===<span style="color:#0000ff">oceos_task_create()</span>===
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	~~<span style="color:#1b7ac2">'''Header File'''</span><br>~~
	~~'''''tasks.h'''''<br>~~

Bkavanagh at 16:48, 3 May 2024

2024-05-03T16:48:35Z

Show changes

Bkavanagh: /* Next Section */

2024-05-03T16:47:14Z

Next Section

← Older revision		Revision as of 16:47, 3 May 2024
Line 1:		Line 1:
	== Next Section ==		== Next Section ==

			==<span style="color:#0000ff">Task directives</span>==

			<span style="color:#1b7ac2">'''Header File'''</span><br>
			'''''tasks.h'''''<br>

			<span style="color:#1b7ac2">'''Description'''</span><br>
			The following data structures are used by some of the task directives.

			<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:#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>==

Bkavanagh: /* Next Section */

2024-05-03T16:44:39Z

Next Section

← Older revision		Revision as of 16:44, 3 May 2024
Line 1:		Line 1:
	== Next Section ==		== Next Section ==

			==<span style="color:#0000ff">Task directives</span>==

			<span style="color:#1b7ac2">'''Header File'''</span><br>
			'''''tasks.h'''''<br>

			<span style="color:#1b7ac2">'''Description'''</span><br>
			The following data structures are used by some of the task directives.

			<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>==

Bkavanagh: /* Next Section */

2024-05-03T16:43:31Z

Next Section

← Older revision		Revision as of 16:43, 3 May 2024
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>==

Bkavanagh: /* Next Section */

2024-05-03T16:41:47Z

Next Section

← Older revision		Revision as of 16:41, 3 May 2024
Line 1:		Line 1:
	== Next Section ==		== Next Section ==

			==<span style="color:#0000ff">Task directives</span>==

			===<span style="color:#0000ff">Task data structures</span>===
			<blockquote style="border-left-style: none;">


			===<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.

Bkavanagh at 14:11, 3 May 2024

2024-05-03T14:11:23Z

← Older revision		Revision as of 14:11, 3 May 2024
Line 1:		Line 1:
	== Next Section ==		== Next Section ==

	~~= Timing directives =~~

	~~===<span style="color:#0000ff">Introduction</span>===~~
	~~<blockquote style="border-left-style: none;">~~

	~~SPARC:~~

	~~In OCEOS system time is based on two chained 32-bit timers.~~

	~~No interrupts are involved, the current system time is obtained by reading the two timer counter registers (in an atomic way) and then inverting the~~
	~~values since the timers count down.~~

	~~The scaler associated with the timers is configured based on the system clock frequency to decrement the low order timer every microsecond. This~~
	~~decrements the high order timer when it rolls over, every 71.6 minutes approximately. The 64-bit time range is very long, over 584,000 years.~~

	~~ARM Cortex-M:~~

	In OCEOS for ARM Cortex-M, system time is based on SysTick. The processor has a 24-bit system timer, SysTick, that counts down from the reload value to zero, reloads (wraps to) the value in the LOAD register on the next clock edge, then counts down on subsequent clocks.

	~~Note: When the processor is halted for debugging the counter does not decrement.~~

	~~OCEOS initializes the timer to be driven from MCK and counting down to zero asserts SysTick exception request.~~
	~~OCEOS has 64 bit counter which is increased by 0xFFFFFF value every time timer reloads.~~

	~~RISC-V:~~

	~~TBD~~

	~~The units of OCEOS system time are microseconds on SPARC and ARM and on RISC-V the period of the clock cycle.~~

	~~The system time is reset to 0 by oceos_init()~~

	~~===<span style="color:#0000ff">oceos_time_sys_get64()</span>===~~
	~~<blockquote style="border-left-style: none;">~~

	~~<span style="color:#1b7ac2">'''Header File'''</span><br>~~
	~~'''''oceos_timer.h'''''<br>~~

	~~<span style="color:#1b7ac2">'''Description'''</span><br>~~
	~~This function returns the current system time as a 64-bit number.~~

	~~<span style="color:#1b7ac2">'''Prototype'''</span><br>~~
	~~<syntaxhighlight lang="C">~~
	**
	* Get the current system time (64-bit)
	*
	* @return U64_t
	*/
	~~U64_t oceos_time_sys_get64(void);~~
	~~</syntaxhighlight>~~

	~~<span style="color:#1b7ac2">'''Parameters'''</span><br>~~

	~~There are no parameters to this function.~~

	~~<span style="color:#1b7ac2">'''Returns'''</span><br>~~
	~~This function returns an S64_t with the current system time.~~

	~~<span style="color:#1b7ac2">'''Example Usage'''</span><br>~~
	~~<syntaxhighlight lang="C">~~
	~~S64_t now;~~
	~~...~~
	~~// Get the time~~
	~~now = oceos_time_sys_get64();~~
	~~</syntaxhighlight>~~
	~~</blockquote>~~

	~~===<span style="color:#0000ff">oceos_time_sys_get32()</span>===~~
	~~<blockquote style="border-left-style: none;">~~

	~~<span style="color:#1b7ac2">'''Header File'''</span><br>~~
	~~'''''oceos_timer.h'''''<br>~~

	~~<span style="color:#1b7ac2">'''Description'''</span><br>~~
	~~This function returns the low 32 bits of the system time.~~

	~~<span style="color:#1b7ac2">'''Prototype'''</span><br>~~
	~~<syntaxhighlight lang="C">~~
	/**
	* Get the current system time (low 32 bits of 64 bit value)
	*
	* @return U32_t
	*/
	~~U32_t oceos_time_sys_get32(void);~~
	~~</syntaxhighlight>~~

	~~<span style="color:#1b7ac2">'''Parameters'''</span><br>~~
	~~There are no parameters to this function.~~

	~~<span style="color:#1b7ac2">'''Returns'''</span><br>~~
	~~This function returns an S32_t with the current system time.~~

	~~<span style="color:#1b7ac2">'''Example Usage'''</span><br>~~
	~~<syntaxhighlight lang="C">~~
	~~S32_t now;~~
	~~...~~
	~~// Get the time~~
	~~now = oceos_time_sys_get32();~~
	~~</syntaxhighlight>~~
	~~</blockquote>~~

Bkavanagh: /* Introduction */

2024-05-03T14:06:40Z

Introduction

← Older revision		Revision as of 14:06, 3 May 2024
Line 7:		Line 7:

	SPARC:		SPARC:

	In OCEOS system time is based on two chained 32-bit timers.		In OCEOS system time is based on two chained 32-bit timers.

Line 16:		Line 17:

	ARM Cortex-M:		ARM Cortex-M:

	In OCEOS for ARM Cortex-M, system time is based on SysTick. The processor has a 24-bit system timer, SysTick, that counts down from the reload value to zero, reloads (wraps to) the value in the LOAD register on the next clock edge, then counts down on subsequent clocks.		In OCEOS for ARM Cortex-M, system time is based on SysTick. The processor has a 24-bit system timer, SysTick, that counts down from the reload value to zero, reloads (wraps to) the value in the LOAD register on the next clock edge, then counts down on subsequent clocks.

Line 24:		Line 26:

	RISC-V:		RISC-V:

	TBD		TBD