OCEOS/oceos fdir - Revision history

Bkavanagh: /* FDIR Configuration */

2024-02-02T09:13:38Z

FDIR Configuration

← Older revision		Revision as of 09:13, 2 February 2024
Line 106:		Line 106:

	For this function to be called it is necessary to set system_status_mask element in the struct application_configuration. This is normally set in config.c.		For this function to be called it is necessary to set system_status_mask element in the struct application_configuration. This is normally set in config.c.
			Mask bit settings can be found in codes.h.

	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">

Bkavanagh: /* FDIR Configuration */

2024-02-02T09:12:06Z

FDIR Configuration

← Older revision		Revision as of 09:12, 2 February 2024
Line 122:		Line 122:
	struct application_configuration app_config = {0};		struct application_configuration app_config = {0};
	app_config.system_error_function = &oceos_on_error; // NULL => ignore		app_config.system_error_function = &oceos_on_error; // NULL => ignore

			/*
			* Set mask to call user defined error handler when task deadline missed or interval between
			* job creations is less than user specified target.
			*/
			app_config.system_status_mask = STATUS_JOB_OVER_TIME \|\| STATUS_JOB_INTERVAL_SHORT;

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

Bkavanagh: /* FDIR Configuration */

2024-02-02T08:31:34Z

FDIR Configuration

← Older revision		Revision as of 08:31, 2 February 2024
Line 103:		Line 103:
	==<span style="color:#0000ff">FDIR Configuration</span>==		==<span style="color:#0000ff">FDIR Configuration</span>==
	<blockquote>		<blockquote>
	User can provide function, that is called in case of system ERROR		User can provide function, that is called in case of system ERROR.

			For this function to be called it is necessary to set system_status_mask element in the struct application_configuration. This is normally set in config.c.

	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	/**		/**

Okhoruzhyy: /* FDIR Configuration */

2022-04-11T11:49:28Z

FDIR Configuration

← Older revision		Revision as of 11:49, 11 April 2022
Line 109:		Line 109:
	* Comment it out if not used and set field system_error_function in app_config to NULL		* Comment it out if not used and set field system_error_function in app_config to NULL
	*/		*/
	void oceos_on_error(~~void* ptr~~) {		void oceos_on_error() {
	// Application ERROR Handling code		// Application ERROR Handling code
	return;		return;

Okhoruzhyy: /* FDIR Introduction */

2022-04-08T10:06:14Z

FDIR Introduction

Okhoruzhyy: /* FDIR Introduction */

2022-04-08T10:05:40Z

FDIR Introduction

← Older revision		Revision as of 10:05, 8 April 2022
Line 55:		Line 55:
	*/		*/

	#define STATUS_NORMAL 0U // no flag set		#define STATUS_NORMAL 0U // no flag set
	#define STATUS_MASK_NORMAL 0x0U // no error function can be called		#define STATUS_MASK_NORMAL 0x0U // no error function can be called
	#define STATUS_INVALID 0xffffffffU // system status invalid		#define STATUS_INVALID 0xffffffffU // system status invalid

	/* Task related problems */		/* Task related problems */
Line 96:		Line 96:

	/* Will have to exit */		/* Will have to exit */
	#define STATUS_BAD_SENTINEL 0x40000000U // Area sentinel corrupt		#define STATUS_BAD_SENTINEL 0x40000000U // Area sentinel corrupt
	#define STATUS_BAD_META_PTR 0x80000000U // Null meta pointer		#define STATUS_BAD_META_PTR 0x80000000U // Null meta pointer

	</syntaxhighlight>		</syntaxhighlight>

Okhoruzhyy: /* FDIR Introduction */

2022-04-08T10:03:16Z

FDIR Introduction

← Older revision		Revision as of 10:03, 8 April 2022
Line 55:		Line 55:
	*/		*/

	#define STATUS_MASK_NORMAL 0xffffffffU // ~~not used at present~~		#define STATUS_NORMAL 0U // no flag set
			#define STATUS_MASK_NORMAL 0x0U // no error function can be called
			#define STATUS_INVALID 0xffffffffU // system status invalid

	~~#define STATUS_NORMAL 0U~~ // ~~No flag set~~		/* Task related problems */
	~~#define STATUS_EDAC_INTERNAL 1U // Uncorrectable error in internal memory~~		#define STATUS_DISABLED_TASK_START 0x1U // An attempt to start a disabled task
	~~#define STATUS_EDAC_EXTERNAL 2U // Uncorrectable error in external memory~~		#define STATUS_TASK_JOB_LIMIT_OVER 0x2U // An attempt to execute a task when its jobs limit is already reached.
	~~#define STATUS_MEM_PROT_1 4U // Invalid access memory protection unit 1~~		#define STATUS_JOB_OVER_TIME 0x4U // Job time from creation to completion exceeds allowed maximum for task. YES
	~~#define STATUS_MEM_PROT_2 8U // Invalid access memory protection unit 2~~		#define STATUS_JOB_INTERVAL_SHORT 0x8U // Minimum time between job creations is less than the allowed minimum for task
	#define STATUS_DISABLED_TASK_START ~~0x10U~~ // An attempt to start a disabled task		#define STATUS_READYQ_FULL 0x10U // Ready queue unable to accept job as result of being full
	#define STATUS_TASK_JOB_LIMIT_OVER ~~0x20U~~ // An attempt to execute a task when its jobs limit is already reached.		#define STATUS_READYQ_NO_REMOVE 0x20U // Remove job from ready queue failed
	#define STATUS_JOB_OVER_TIME ~~0x40U~~ // Job time from creation to completion exceeds allowed maximum for a task.
	#define STATUS_JOB_INTERVAL_SHORT ~~0x80U~~ // Minimum time between job creations is less than the allowed minimum for task		/* Mutex related problems */
	#define STATUS_READYQ_FULL ~~0x100U~~ // Ready queue unable to accept job as result of being full		#define STATUS_MUTEX_ALREADY_HELD 0x40U // Mutex wait() when mutex already held
	#define STATUS_MUTEX_ALREADY_HELD ~~0x200U~~ // Mutex wait() when mutex already held		#define STATUS_MUTEX_NOT_HELD 0x80U // Mutex signal() when not already held
	#define STATUS_MUTEX_NOT_HELD ~~0x400U~~ // Mutex signal() when not already held		#define STATUS_MUTEX_NOT_RETURNED 0x100U // Mutex not returned before job terminates
	#define STATUS_MUTEX_NOT_RETURNED ~~0x800U~~ // Mutex not returned before job terminates		#define STATUS_MUTEX_NOT_NESTED 0x200U // Use of multiple mutexes not nested
	#define STATUS_SEMAPHORE_JOBS_FULL ~~0x1000U~~ // Attempt to add job to semaphore pending list when list ~~full~~
	~~#define STATUS_DATAQ_FULL 0x2000U // Data queue write when queue already~~ full		/* Counting semaphore and data queue related problems */
	#define STATUS_DATAQ_JOBS_FULL ~~0x4000U~~ // Attempt to add job to queue pending list when list full		#define STATUS_SEMAPHORE_JOBS_FULL 0x400U // Attempt to add job to semaphore pending list when list full
	#define ~~STATUS_TIMED_JOBS_FULL 0x8000U~~ // ~~Timed jobs~~ queue write when queue already full		#define STATUS_DATAQ_JOBS_FULL 0x800U // Attempt to add job to data queue pending list when list full
	~~#define STATUS_TIMED_JOB_LATE 0x10000U~~ // ~~Timed jobs queue late job transfer to scheduler~~		#define STATUS_DATAQ_FULL 0x1000U // Data queue write when queue already full
	#define ~~STATUS_TIMED_OUTPUT_FULL 0x20000U~~ // Timed ~~output queue write when~~ queue already full
	#define ~~STATUS_TIMED_OUTPUT_LATE~~ ~~0x40000U~~ // Timed output ~~late~~		/* Timed actions related problems */
	#define STATUS_TIMED_ACTION_LATE ~~0x80000U~~ // Timed action late		#define STATUS_TIMED_JOBS_FULL 0x2000U // Timed actions queue already full for timed task start
	~~#define STATUS_READYQ_NO_REMOVE 0x100000U~~ /~~/ Remove job from ready queue failed~~		#define STATUS_TIMED_OUTPUT_FULL 0x4000U // Timed actions queue already full for timed output
	~~#define~~ ~~STATUS_OLDJOB_NOT_EXEC 0x200000U /~~/ ~~Job being pre-empted was not executing~~		#define STATUS_TIMED_ACTION_LATE 0x8000U // Timed action late YES
	#define STATUS_SYSTEM_ERROR ~~0x400000U~~ // ERROR was handled by default trap handler
	#define STATUS_BAD_LOG ~~0x80000000U~~ // System log problem		/* Default trap handler should have been replaced
	#define ~~STATUS_INVALID 0xffffffffU~~ // ~~System status invalid~~		* NOT USED AT THE MOMENT*/
			#define STATUS_SYSTEM_ERROR 0x10000U // ERROR was handled by default trap handler YES

			/* Flag to indicate problem with Stack Pointe
			* NOT USED AT THE MOMENT*/
			#define STATUS_SP_WARNING 0x20000U // SP not in expected range
			/* Log system error */
			#define STATUS_BAD_LOG 0x40000U // System log problem

			/* Not using next few bits */

			/* Will have to exit */
			#define STATUS_BAD_SENTINEL 0x40000000U // Area sentinel corrupt
			#define STATUS_BAD_META_PTR 0x80000000U // Null meta pointer

	</syntaxhighlight>		</syntaxhighlight>

Okhoruzhyy: /* oceos_system_watchdog_reset() */

2022-03-28T15:13:59Z

oceos_system_watchdog_reset()

← Older revision		Revision as of 15:13, 28 March 2022
Line 368:		Line 368:
	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
	<span style="color:red">'''FOR GR716 ONLY'''</span><br>		<span style="color:red">'''FOR GR716 ONLY'''</span><br>
			This directive resets the watchdog timer for GR716 at 0x80003070, allowing it to be enabled or disabled after reset.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_system_watchdog_reset(
			BOOLE_t enable // whether to enable or disable after reset
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 377:		Line 381:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| enable \|\| Whether to enable or disable after reset
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 385:		Line 389:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~		\| SUCCESSFUL \|\| All OK
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-
	~~\| INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~
	~~Start Sentinel for dynamic area is corrupt~~
	\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-
	\| SUCCESSFUL \|\| If All OK
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS status;
	</syntaxhighlight>		status = oceos_system_watchdog_reset(TRUE);
			</syntaxhighlight>
	</blockquote>		</blockquote>


	[[Category:backup]]		[[Category:backup]]

Okhoruzhyy: /* oceos_system_watchdog_ticks_remaining() */

2022-03-28T15:11:14Z

oceos_system_watchdog_ticks_remaining()

← Older revision		Revision as of 15:11, 28 March 2022
Line 333:		Line 333:
	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
	<span style="color:red">'''FOR GR716 ONLY'''</span><br>		<span style="color:red">'''FOR GR716 ONLY'''</span><br>
	This directive returns number of ticks remaining ~~from~~ watchdog timer for GR716 at 0x80003070.		This directive returns number of ticks remaining in watchdog timer for GR716 at 0x80003070.

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

Okhoruzhyy: /* oceos_system_watchdog_ticks_remaining() */

2022-03-28T15:10:06Z

oceos_system_watchdog_ticks_remaining()

← Older revision		Revision as of 15:10, 28 March 2022
Line 333:		Line 333:
	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
	<span style="color:red">'''FOR GR716 ONLY'''</span><br>		<span style="color:red">'''FOR GR716 ONLY'''</span><br>
			This directive returns number of ticks remaining from watchdog timer for GR716 at 0x80003070.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			unsigned int oceos_system_watchdog_ticks_remaining();
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 345:		Line 347:
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns unsigned int.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! unsigned int !! Description
	\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-		\|-
	\| ~~INVALID_NAME~~ \|\| ~~If Start Sentinel for fixed area is corrupt or~~		\| >= 0 \|\| Number of watchdog ticks
	~~Start Sentinel for dynamic area is corrupt~~
	\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-
	~~\| SUCCESSFUL \|\| If All OK~~
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			unsigned int num_ticks;
	</syntaxhighlight>		num_ticks = oceos_system_watchdog_ticks_remaining();
			</syntaxhighlight>
	</blockquote>		</blockquote>

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

← Older revision		Revision as of 10:06, 8 April 2022
Line 62:		Line 62:
	#define STATUS_DISABLED_TASK_START 0x1U // An attempt to start a disabled task		#define STATUS_DISABLED_TASK_START 0x1U // An attempt to start a disabled task
	#define STATUS_TASK_JOB_LIMIT_OVER 0x2U // An attempt to execute a task when its jobs limit is already reached.		#define STATUS_TASK_JOB_LIMIT_OVER 0x2U // An attempt to execute a task when its jobs limit is already reached.
	#define STATUS_JOB_OVER_TIME 0x4U // Job time from creation to completion exceeds allowed maximum for task~~. YES~~		#define STATUS_JOB_OVER_TIME 0x4U // Job time from creation to completion exceeds allowed maximum for task
	#define STATUS_JOB_INTERVAL_SHORT 0x8U // Minimum time between job creations is less than the allowed minimum for task		#define STATUS_JOB_INTERVAL_SHORT 0x8U // Minimum time between job creations is less than the allowed minimum for task
	#define STATUS_READYQ_FULL 0x10U // Ready queue unable to accept job as result of being full		#define STATUS_READYQ_FULL 0x10U // Ready queue unable to accept job as result of being full
Line 81:		Line 81:
	#define STATUS_TIMED_JOBS_FULL 0x2000U // Timed actions queue already full for timed task start		#define STATUS_TIMED_JOBS_FULL 0x2000U // Timed actions queue already full for timed task start
	#define STATUS_TIMED_OUTPUT_FULL 0x4000U // Timed actions queue already full for timed output		#define STATUS_TIMED_OUTPUT_FULL 0x4000U // Timed actions queue already full for timed output
	#define STATUS_TIMED_ACTION_LATE 0x8000U // Timed action late ~~YES~~		#define STATUS_TIMED_ACTION_LATE 0x8000U // Timed action late

	/* Default trap handler should have been replaced		/* Default trap handler should have been replaced
	* NOT USED AT THE MOMENT*/		* NOT USED AT THE MOMENT*/
	#define STATUS_SYSTEM_ERROR 0x10000U // ERROR was handled by default trap handler ~~YES~~		#define STATUS_SYSTEM_ERROR 0x10000U // ERROR was handled by default trap handler

	/* Flag to indicate problem with Stack Pointe		/* Flag to indicate problem with Stack Pointe