OCEOSmp/directive reference - Revision history

Bkavanagh: /* oceos_timed_output_number() */

2024-06-24T16:16:12Z

oceos_timed_output_number()

← Older revision		Revision as of 16:16, 24 June 2024
Line 4,301:		Line 4,301:
	S32_t status, no_of_outputs;		S32_t status, no_of_outputs;
	...		...
	// Get the number of ~~jobs~~ on the timed actions queue		// Get the number of output actions on the timed actions queue
	status = oceos_timed_output_number(&no_of_outputs);		status = oceos_timed_output_number(&no_of_outputs);

Bkavanagh: /* oceos_timed_output_number() */

2024-06-24T16:14:03Z

oceos_timed_output_number()

← Older revision		Revision as of 16:14, 24 June 2024
Line 4,255:		Line 4,255:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
	This function returns the number ~~of jobs~~ on the timed actions queue.		This function returns the number timed output actions waiting on the timed actions queue.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	/**		/**
	* Get number of ~~Jobs (request to start the task)~~ waiting on timed action queue.		* Get number of timed output actions waiting on timed action queue.
	* These ~~jobs~~ are ~~added~~ by ~~oceos_task_timed_start() or~~		* These timed output actions are created by oceos_timed_output_add
	* oceos_dataq_read_restart_timeout when data is not available (NULL) or
	* oceos_sem_wait_restart_timeout when counting semaphore is 0
	*		*
	* @param ~~total_jobs~~ Pointer to store total ~~jobs~~ number waiting on timed action Q		* @param total_outputs Pointer to store total outputs number waiting on timed action Q
	* @return OCEOS_SUCCESS		* @return OCEOS_SUCCESS
	* ERR_SYS_FIXED_CORRUPT System Fixed area corrupt		* ERR_SYS_FIXED_CORRUPT System Fixed area corrupt
Line 4,273:		Line 4,271:
	* ERR_TA_PTR_BAD Timed action pointer is null		* ERR_TA_PTR_BAD Timed action pointer is null
	*/		*/
	S32_t ~~oceos_timed_jobs_number~~(U32_t *~~total_jobs~~);		S32_t oceos_timed_output_number(U32_t *total_outputs);
	</syntaxhighlight>		</syntaxhighlight>

Line 4,280:		Line 4,278:
	! Parameter \|\| Description		! Parameter \|\| Description
	\|-		\|-
	\| ~~total_jobs~~ \|\| s32_t pointer to store total ~~jobs number~~ waiting on timed action Q		\| total_outputs \|\| s32_t pointer to store total output actions waiting on timed action queue
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 4,301:		Line 4,299:
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	S32_t status, ~~no_of_jobs~~;		S32_t status, no_of_outputs;
	...		...
	// Get the number of jobs on the timed actions queue		// Get the number of jobs on the timed actions queue
	status = ~~oceos_timed_jobs_number~~(&~~no_of_jobs~~);		status = oceos_timed_output_number(&no_of_outputs);

	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>


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

Bkavanagh: /* Timed Actions */

2024-06-24T16:08:50Z

Timed Actions

← Older revision		Revision as of 16:08, 24 June 2024
Line 4,247:		Line 4,247:
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

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

			<span style="color:#1b7ac2">'''Description'''</span><br>
			This function returns the number of jobs on the timed actions queue.

			<span style="color:#1b7ac2">'''Prototype'''</span><br>
			<syntaxhighlight lang="C">
			/**
			* Get number of Jobs (request to start the task) waiting on timed action queue.
			* These jobs are added by oceos_task_timed_start() or
			* oceos_dataq_read_restart_timeout when data is not available (NULL) or
			* oceos_sem_wait_restart_timeout when counting semaphore is 0
			*
			* @param total_jobs Pointer to store total jobs number waiting on timed action Q
			* @return OCEOS_SUCCESS
			* ERR_SYS_FIXED_CORRUPT System Fixed area corrupt
			* ERR_SYS_DYN_CORRUPT System Dynamic area corrupt
			* ERR_WRONG_PHASE Directive was called before OCEOS initialisation is finished
			* ERR_TA_NOT_INIT Timed action inialisation is not done and tried to be used
			* ERR_TA_PTR_BAD Timed action pointer is null
			*/
			S32_t oceos_timed_jobs_number(U32_t *total_jobs);
			</syntaxhighlight>

			<span style="color:#1b7ac2">'''Parameters'''</span><br>
			{\| class="wikitable"
			! Parameter \|\| Description
			\|-
			\| total_jobs \|\| s32_t pointer to store total jobs number waiting on timed action Q
			\|}
			<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
			\|-
			\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
			\|-
			\| ERR_SYS_DYN_CORRUPT \|\| System Dynamic area corrupt
			\|-
			\| ERR_WRONG_PHASE \|\| Directive was called before OCEOS initialisation is finished
			\|-
			\| ERR_TA_NOT_INIT \|\| Timed action inialisation is not done and tried to be used
			\|-
			\| ERR_TA_PTR_BAD \|\| Timed action pointer is null
			\|}

			<span style="color:#1b7ac2">'''Example Usage'''</span><br>
			<syntaxhighlight lang="C">
			S32_t status, no_of_jobs;
			...
			// Get the number of jobs on the timed actions queue
			status = oceos_timed_jobs_number(&no_of_jobs);

			</syntaxhighlight>
			</blockquote>


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

Bkavanagh: /* Timed Actions */

2024-06-24T13:21:00Z

Timed Actions

← Older revision		Revision as of 13:21, 24 June 2024
Line 4,295:		Line 4,295:
	\|-		\|-
	! Error bit \|\| Description		! Error bit \|\| Description
	\|		\|-
	\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt		\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
	\|-		\|-
Line 4,366:		Line 4,366:
	\|-		\|-
	! Error bit \|\| Description		! Error bit \|\| Description
	\|		\|-
	\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt		\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
	\|-		\|-
Line 4,441:		Line 4,441:
	\|-		\|-
	\| Error bit \|\| Description		\| Error bit \|\| Description
	\|		\|-
	\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt		\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
	\|-		\|-
Line 4,510:		Line 4,510:
	\|-		\|-
	\| Error bit \|\| Description		\| Error bit \|\| Description
	\|		\|-
	\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt		\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
	\|-		\|-

Bkavanagh: /* oceos_timed_jobs_number() */

2024-06-24T13:13:17Z

oceos_timed_jobs_number()

← Older revision		Revision as of 13:13, 24 June 2024
Line 4,226:		Line 4,226:
	\|-		\|-
	! Error bit \|\| Description		! Error bit \|\| Description
	\|		\|-
	\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt		\| ERR_SYS_FIXED_CORRUPT \|\| System Fixed area corrupt
	\|-		\|-

Bkavanagh: /* Task data structures */

2024-05-03T17:04:26Z

Task data structures

← Older revision		Revision as of 17:04, 3 May 2024
Line 824:		Line 824:

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

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

Bkavanagh at 17:03, 3 May 2024

2024-05-03T17:03:02Z

← Older revision		Revision as of 17:03, 3 May 2024
Line 824:		Line 824:

	===<span style="color:#0000ff">Task data structures</span>===		===<span style="color:#0000ff">Task data structures</span>===
	~~<blockquote style="border-left-style: none;">~~
	<span style="color:#1b7ac2">'''Header File'''</span><br>		<span style="color:#1b7ac2">'''Header File'''</span><br>
	'''''tasks.h'''''<br>		'''''tasks.h'''''<br>
Line 887:		Line 887:

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

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

Bkavanagh at 16:59, 3 May 2024

2024-05-03T16:59:36Z

← Older revision		Revision as of 16:59, 3 May 2024
Line 887:		Line 887:

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

Bkavanagh: /* Introduction */

2024-05-03T16:08:53Z

Introduction

← Older revision		Revision as of 16:08, 3 May 2024
Line 5,318:		Line 5,318:
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">

	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 5,328:		Line 5,328:
	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.		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:		'''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 5,337:		Line 5,337:
	OCEOS has 64 bit counter which is increased by 0xFFFFFF value every time timer reloads.		OCEOS has 64 bit counter which is increased by 0xFFFFFF value every time timer reloads.

	RISC-V:		'''RISC-V'''

	~~TBD~~		In OCEOS for RISC-V systems time is based internally on clock cycles.
			The RISC-V processor typically has a 64 bit counter (typically mtime) that updates automatically on each clock cycle. Each hart typically has its own comparison register (typically mtimecmp) that can be used to interrupt that hart when a certain cycle count has been exceeded.
			If a particular RISC-V implementation provides a more restricted clock cycle count this will be used with appropriate modifications as clock cycles give the best timing precision available.

			Note: The application configuration provides the constant needed to allow microseconds (as used in OCEOS directives) be converted to clock cycles. Time is reported by OCEOSmp as the number of microseconds since OCEOS was initialized.

			A potential difficulty arises if the main system clock rate can change for power saving or other reasons, each system is probably different with regard to this. OCEOSmp can handle this, if needed.

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

Bkavanagh: /* This section is under construction */

2024-05-03T15:41:25Z

This section is under construction

← Older revision		Revision as of 15:41, 3 May 2024
Line 1:		Line 1:
	~~= <span style="color:#ff0000">'''This section is under construction'''</span> =~~

	= Introduction =		= Introduction =