OCEOS/oceos introduction - Revision history

Okhoruzhyy: /* OCEOS Memory Requirements */

2022-03-31T16:33:48Z

OCEOS Memory Requirements

← Older revision		Revision as of 16:33, 31 March 2022
Line 70:		Line 70:
	*Developed in cooperation with European Space Agency (ESA)		*Developed in cooperation with European Space Agency (ESA)

	== <span style="color:#0000ff">OCEOS Memory Requirements</span> ==		<!-- == <span style="color:#0000ff">OCEOS Memory Requirements</span> ==

	Memory usage depends on microcontroller, OCEOS modules and features, compilers and optimization level.		Memory usage depends on microcontroller, OCEOS modules and features, compilers and optimization level.
Line 190:		Line 190:
	\| \|\| '''Total''' \|\| 21811 \|\| \|\|		\| \|\| '''Total''' \|\| 21811 \|\| \|\|
	\|}		\|}
			-->

	== <span style="color:#0000ff">OCEOS Data Area Layouts</span> ==		== <span style="color:#0000ff">OCEOS Data Area Layouts</span> ==

Okhoruzhyy: /* OCEOS Configuration */

2022-03-31T09:53:44Z

OCEOS Configuration

← Older revision		Revision as of 09:53, 31 March 2022
Line 69:		Line 69:
	*Developed to ECSS Category B and ISO 26262 standards		*Developed to ECSS Category B and ISO 26262 standards
	*Developed in cooperation with European Space Agency (ESA)		*Developed in cooperation with European Space Agency (ESA)

	~~== <span style="color:#0000ff">OCEOS Configuration</span> ==~~

	~~<span style="color:red">TODO : describe oceos configuration with links to appropriate section in manual for more detailed information for each parameter</span>~~
	~~<syntaxhighlight lang="C">~~
	~~// 1: Includes OCEOS main header file~~
	~~#include "oceos.h"~~
	~~//----------------------------------------------------------------------------~~
	~~// 2: Number of Log entries.~~
	~~#define NUMBER_OF_LOG_ENTRIES 16 // 16 to 1024, default 64~~
	~~//----------------------------------------------------------------------------~~
	~~// 3: Number of tasks~~
	~~#define NUMBER_OF_TASKS 3 // 1 to 255~~
	~~//----------------------------------------------------------------------------~~
	~~// 4: Number of ready queue entries, 0 to 254, see manual( MUST BE UPDATED BY USER);~~
	~~// Defaults to number of tasks, as each task should have aa least one job;~~
	~~// If Number of ready Q entries larger that number of total jobs => defaults to number of total jobs~~
	~~#define NUMBER_OF_READYQ_ENTRIES 10~~
	~~//----------------------------------------------------------------------------~~
	~~// 5: Number of Mutexes~~
	~~#define NUMBER_OF_MUTEXES 2 // 0 to 63~~
	~~//----------------------------------------------------------------------------~~
	~~// 6: Number of Semaphores~~
	~~#define NUMBER_OF_SEMAPHORES 0 // 0 to 63~~
	~~//----------------------------------------------------------------------------~~
	~~// 7: Number of Data Qs~~
	~~#define NUMBER_OF_DATAQS 0 // 0 to 63~~
	~~//----------------------------------------------------------------------------~~
	~~// 8: LOG data array size~~
	~~#define LOG_DATA_ARRAY_SIZE_U32S 0x100// Calculated value. Read manual~~
	~~//----------------------------------------------------------------------------~~
	~~// 9: FIXED data array size~~
	~~#define FIXED_DATA_ARRAY_SIZE_U32S 0x100// Calculated value. Read manual~~
	~~//----------------------------------------------------------------------------~~
	~~// 10: DYNAMIC data array size~~
	~~#define DYN_DATA_ARRAY_SIZE_U32S 0x100// Calculated value. Read manual~~
	~~//----------------------------------------------------------------------------~~
	~~// 11: Timed Actions~~
	~~#define NUMBER_OF_ACTION_ENTRIES 0 // User-modify field~~
	~~//----------------------------------------------------------------------------~~
	~~// 12: Log entries base 2~~
	~~#define CS_LOG_DEF_ENTRIES_BASE2 0~~
	~~//----------------------------------------------------------------------------~~
	~~// 13: OCEOS stack start Address~~
	~~#define OCEOS_STACK_START_ADDRESS 0~~
	~~//----------------------------------------------------------------------------~~
	~~// 14: OCEOS stack end address~~
	~~#define OCEOS_STACK_LOW_BOUND_ADDRESS 0~~
	~~</syntaxhighlight>~~
	~~<syntaxhighlight lang="C">~~
	/*
	* Set up the application configuration structure and pass it to oceos_init
	* (done this way the memory used for the structure is returned automatically)
	*/

	~~int application_init(){~~

	/*
	* Create the application configuration structure
	*/
	~~struct application_configuration app_config = {0};~~

	/*
	* Fill in the application parameters
	*/
	~~app_config.log_address = (adrs_t)log_data; // required~~
	~~app_config.fixed_data_address = (adrs_t)fixed_data; // required~~
	~~app_config.dynamic_data_address = (adrs_t)dynamic_data; // required~~

	~~app_config.stack_start_address = OCEOS_STACK_START_ADDRESS; // 0 => no check~~
	~~app_config.stack_lower_bound_address = OCEOS_STACK_LOW_BOUND_ADDRESS; // 0 => no check~~

	~~app_config.system_error_function = &oceos_on_error; // NULL => ignore~~
	~~app_config.log_full_function = &oceos_on_full_log; // NULL => ignore~~
	~~#ifdef __sparc__~~
	/**
	* FOR SPARC TARGET ONLY.
	* Not Used for ARM. Always Nested
	*/
	~~app_config.interrupt_nesting_enabled = TRUE; // Nesting Enabled~~
	~~#endif~~
	~~// used in setting up system log and fixed data array~~
	~~app_config.log_number_of_entries = NUMBER_OF_LOG_ENTRIES; // 0 => use default~~

	~~app_config.number_of_tasks = NUMBER_OF_TASKS; // >= 1~~
	~~app_config.number_of_readyQ_entries = NUMBER_OF_READYQ_ENTRIES; // 0 => calculate size~~

	~~app_config.number_of_mutexes = NUMBER_OF_MUTEXES;~~
	~~app_config.number_of_counting_semaphores = NUMBER_OF_SEMAPHORES;~~
	~~app_config.number_of_data_queues = NUMBER_OF_DATAQS;~~

	~~#ifdef __sparc__~~
	/**
	* FOR SPARC TARGET ONLY.
	* ARM SysTick is used for System Time
	*/
	~~app_config.sys_time_timer_index = SYS_TIME_TIMER_INDEX; // 0 => invalid index~~
	~~#endif~~

	~~app_config.timed_actions_queue_size = NUMBER_OF_ACTION_ENTRIES;~~
	~~app_config.CS_log_entries_base2 = CS_LOG_DEF_ENTRIES_BASE2;~~
	~~// System time is used by timed actions, semaphores with timeout, dataqs with timeout, logging and profiling.~~
	~~// If all of above are not required then system time can be disabled. The system will not be interrupted by SysTick while CPU in sleep mode,~~
	~~//but it is not the case for SPARC targets,~~
	~~// as system time implemented by chaining two timers without interrupting.~~
	~~app_config.use_oceos_system_time = TRUE;~~

	~~// initialise OCEOS~~
	~~enum DIRECTIVE_STATUS status;~~
	~~status = oceos_init(app_config);~~
	~~assert(SUCCESSFUL == status);~~

	~~if (SUCCESSFUL == status) {~~
	~~return 1;~~
	~~} else {~~
	~~printf("\n oceos_init failure\n");~~
	~~return -1;~~
	~~} // else~~
	~~} // application_init()~~
	~~</syntaxhighlight>~~

	== <span style="color:#0000ff">OCEOS Memory Requirements</span> ==		== <span style="color:#0000ff">OCEOS Memory Requirements</span> ==

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-28T14:02:24Z

OCEOS data area layouts

← Older revision		Revision as of 14:02, 28 March 2022
Line 311:		Line 311:
	\|}		\|}

	== <span style="color:#0000ff">OCEOS ~~data area layouts~~</span> ==		== <span style="color:#0000ff">OCEOS Data Area Layouts</span> ==
	The design of OCEOS makes the contents of its data areas readily visible to an application. It is straightforward to determine the details of state of the system should it be necessary to do so.<br>		The design of OCEOS makes the contents of its data areas readily visible to an application. It is straightforward to determine the details of state of the system should it be necessary to do so.<br>
	Each data area is made up of a number of fields whose sizes depend on the particular application but whose general layout is invariant.<br>		Each data area is made up of a number of fields whose sizes depend on the particular application but whose general layout is invariant.<br>

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:48:28Z

OCEOS data area layouts

← Older revision		Revision as of 16:48, 25 March 2022
Line 322:		Line 322:
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	#define LOG_DATA_ARRAY_SIZE_U32S 0x100 // Number of words		#define LOG_DATA_ARRAY_SIZE_U32S 0x100 // Number of words; Application dependent, must be modified by user
	...		...

Line 331:		Line 331:
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	#define FIXED_DATA_ARRAY_SIZE_U32S 0x200 // Number of words		#define FIXED_DATA_ARRAY_SIZE_U32S 0x200 // Number of words; Application dependent, must be modified by user
	...		...

Line 340:		Line 340:
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	#define DYN_DATA_ARRAY_SIZE_U32S 0x200 // Number of words		#define DYN_DATA_ARRAY_SIZE_U32S 0x200 // Number of words; Application dependent, must be modified by user
	...		...

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:43:38Z

OCEOS data area layouts

← Older revision		Revision as of 16:43, 25 March 2022
Line 361:		Line 361:
	* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].		* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<~~code~~>		<syntaxhighlight lang="C">
	extern U32_t log_data[];		extern U32_t log_data[];
	extern U32_t fixed_data[];		extern U32_t fixed_data[];
Line 374:		Line 374:
	return;		return;
	}		}
			</syntaxhighlight>
	</code>		</code>
	</blockquote>		</blockquote>

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:43:05Z

OCEOS data area layouts

← Older revision		Revision as of 16:43, 25 March 2022
Line 361:		Line 361:
	* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].		* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<~~syntaxhighlight lang="C"~~>		<code>
	extern U32_t log_data[];		extern U32_t log_data[];
	extern U32_t fixed_data[];		extern U32_t fixed_data[];
Line 374:		Line 374:
	return;		return;
	}		}
	</~~syntaxhighlight~~>		</code>
	</blockquote>		</blockquote>
	'''OCEOS data areas layout'''		'''OCEOS data areas layout'''

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:41:53Z

OCEOS data area layouts

← Older revision		Revision as of 16:41, 25 March 2022
Line 352:		Line 352:
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<pre>		<pre>
	DMON > oceos info~~<br>~~		DMON > oceos info
	Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: size 0x109 :: sentinel OK~~<br>~~		Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: size 0x109 :: sentinel OK
	Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: size 0x59 :: sentinel OK~~<br>~~		Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: size 0x59 :: sentinel OK
	Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: size 0x258 :: sentinel OK~~<br>~~		Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: size 0x258 :: sentinel OK
	...		...
	</pre>		</pre>

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:41:15Z

OCEOS data area layouts

← Older revision		Revision as of 16:41, 25 March 2022
Line 353:		Line 353:
	<pre>		<pre>
	DMON > oceos info<br>		DMON > oceos info<br>
	Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: ~~<span style="color:red">~~size 0x109~~</span>~~ :: sentinel OK<br>		Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: size 0x109 :: sentinel OK<br>
	Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: ~~<span style="color:red">~~size 0x59 ~~</span>~~ :: sentinel OK<br>		Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: size 0x59 :: sentinel OK<br>
	Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: ~~<span style="color:red">~~size 0x258~~</span>~~ :: sentinel OK<br>		Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: size 0x258 :: sentinel OK<br>
	...		...
	</pre>		</pre>

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:40:27Z

OCEOS data area layouts

← Older revision		Revision as of 16:40, 25 March 2022
Line 350:		Line 350:
	* Use ''oceos_areas.h'' header file		* Use ''oceos_areas.h'' header file
	* Set values as big as possible, run application and use DMON command '''''oceos info''''' to display sizes of each data area in words. Update variables with these sizes.		* Set values as big as possible, run application and use DMON command '''''oceos info''''' to display sizes of each data area in words. Update variables with these sizes.
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
	<~~nowiki~~>DMON > oceos info<br>		<pre>
			DMON > oceos info<br>
	Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: <span style="color:red">size 0x109</span> :: sentinel OK<br>		Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: <span style="color:red">size 0x109</span> :: sentinel OK<br>
	Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: <span style="color:red">size 0x59 </span> :: sentinel OK<br>		Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: <span style="color:red">size 0x59 </span> :: sentinel OK<br>
	Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: <span style="color:red">size 0x258</span> :: sentinel OK<br~~></nowiki~~>		Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: <span style="color:red">size 0x258</span> :: sentinel OK<br>
	...		...
			</pre>
	</blockquote>		</blockquote>
	* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].		* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].

Okhoruzhyy: /* OCEOS data area layouts */

2022-03-25T16:36:53Z

OCEOS data area layouts

← Older revision		Revision as of 16:36, 25 March 2022
Line 329:		Line 329:
	</blockquote>		</blockquote>
	* Fixed data area		* Fixed data area
	<blockquote>		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	#define FIXED_DATA_ARRAY_SIZE_U32S 0x200 // Number of words		#define FIXED_DATA_ARRAY_SIZE_U32S 0x200 // Number of words
Line 338:		Line 338:
	</blockquote>		</blockquote>
	* Dynamic data area		* Dynamic data area
	<blockquote>		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	#define DYN_DATA_ARRAY_SIZE_U32S 0x200 // Number of words		#define DYN_DATA_ARRAY_SIZE_U32S 0x200 // Number of words
Line 350:		Line 350:
	* Use ''oceos_areas.h'' header file		* Use ''oceos_areas.h'' header file
	* Set values as big as possible, run application and use DMON command '''''oceos info''''' to display sizes of each data area in words. Update variables with these sizes.		* Set values as big as possible, run application and use DMON command '''''oceos info''''' to display sizes of each data area in words. Update variables with these sizes.
	<blockquote>		<blockquote style="border-left-style: none;">
	DMON > oceos info<br>		<nowiki>DMON > oceos info<br>
	Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: <span style="color:red">size 0x109</span> :: sentinel OK<br>		Struct Field Name : *system_log_ptr :: location 0x40016444 :: pointer 0x4001A0E0 :: <span style="color:red">size 0x109</span> :: sentinel OK<br>
	Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: <span style="color:red">size 0x59 </span> :: sentinel OK<br>		Struct Field Name : *data_fixed_ptr :: location 0x40016448 :: pointer 0x4001643C :: <span style="color:red">size 0x59 </span> :: sentinel OK<br>
	Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: <span style="color:red">size 0x258</span> :: sentinel OK<br>		Struct Field Name : *data_dynamic_ptr :: location 0x4001644C :: pointer 0x400180E0 :: <span style="color:red">size 0x258</span> :: sentinel OK<br></nowiki>
	...		...
	</blockquote>		</blockquote>
	* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].		* Add function described below to application to display sizes of data areas. This function should be called after [[OCEOS/oceos kernel/initialisation#oceos_start()\|oceos_start()]].
	<blockquote>		<blockquote style="border-left-style: none;">
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	extern U32_t log_data[];		extern U32_t log_data[];