OCEOS/oceos protection - Revision history

Okhoruzhyy: /* oceos_protect_APB_devices() */

2022-03-29T10:16:50Z

oceos_protect_APB_devices()

← Older revision		Revision as of 10:16, 29 March 2022
Line 685:		Line 685:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Control access to APB devices by main bus masters and DMA units.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_APB_devices(
			const unsigned int APB, // APB (0,1,2,3)
			const unsigned int CPU_bridge, // CPU and Bridge access
			const unsigned int scrubber, // MEMSCRUB access (low 16)
			const unsigned int DMA0_DMA1, // DMA0 and DMA1 access
			const unsigned int DMA2_DMA3 // DMA2 and DMA3 access
			)
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 695:		Line 702:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\|APB \|\| Select APB (0,1,2,3)
			\|-
			\|CPU_bridge \|\| CPU and Bridge access
			\|-
			\|scrubber \|\| MEMSCRUB access (low 16)
			\|-
			\|DMA0_DMA1 \|\| DMA0 and DMA1 access
			\|-
			\|DMA2_DMA3 \|\| DMA2 and DMA3 access
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 703:		Line 718:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL or~~		\| INVALID_NUMBER \|\| Parameter check failed
	~~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~~		\| UNSATISFIED \|\| Register write failed
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| SUCCESSFUL \|\| If All OK		\| SUCCESSFUL \|\| 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;
			status = oceos_protect_APB_devices(0x3, 0x20002000, 0x0, 0x0, 0x1);
			if (SUCCESSFUL != status) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_memprot1_segment_control() */

2022-03-29T10:11:45Z

oceos_protect_memprot1_segment_control()

← Older revision		Revision as of 10:11, 29 March 2022
Line 636:		Line 636:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Control access to MEMPROT1 protected segments from masters on DMA bus.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_memprot1_segment_control(
			const unsigned int segment, // 0 to 3
			const unsigned int access, // DMA bus masters (low 16 bits)
			const unsigned int enable // 1 => enable protection, 0 => disable
			)
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 646:		Line 651:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| segment\|\| Select segment from 0 to 3
			\|-
			\| access \|\| DMA bus masters (low 16 bits)
			\|-
			\| enable \|\| 1 => enable protection, 0 => disable
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 654:		Line 663:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL or~~		\| INVALID_NUMBER \|\| Parameter check failed
	~~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~~		\| UNSATISFIED \|\| Register write failed
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~		\| SUCCESSFUL \|\| All OK
	~~(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;
			status = oceos_protect_memprot1_segment_control(0x0, 0x1, 0x1);
			if (SUCCESSFUL != status) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_memprot0_segment_control() */

2022-03-29T10:11:15Z

oceos_protect_memprot0_segment_control()

← Older revision		Revision as of 10:11, 29 March 2022
Line 623:		Line 623:
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	enum DIRECTIVE_STATUS status;		enum DIRECTIVE_STATUS status;
	status = ~~oceos_protect_internal_scrubber_set~~(0x0, 0x1, 0x0, 0x0, 0x1);		status = oceos_protect_memprot0_segment_control(0x0, 0x1, 0x0, 0x0, 0x1);
	if (SUCCESSFUL != status) {		if (SUCCESSFUL != status) {
	// Handle ERROR		// Handle ERROR

Okhoruzhyy: /* oceos_protect_memprot0_segment_control() */

2022-03-29T09:58:58Z

oceos_protect_memprot0_segment_control()

← Older revision		Revision as of 09:58, 29 March 2022
Line 581:		Line 581:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Control access to MEMPROT0 segments from masters on main bus.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_memprot0_segment_control(
			const unsigned int segment, // 0 to 3
			const unsigned int leon, // LEON access to segment
			const unsigned int scrubber, // MEMSCRUB access to segment
			const unsigned int bridge, // DMA bus access to segment
			const unsigned int enable // 1 => enable protection, 0 => disable
			)
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 591:		Line 598:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\|segment \|\| Select segment from 0 to 3
			\|-
			\|leon \|\| LEON access to segment
			\|-
			\|scrubber \|\| MEMSCRUB access to segment
			\|-
			\|bridge \|\| DMA bus access to segment
			\|-
			\|enable \|\| 1 => enable protection, 0 => disable
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 599:		Line 614:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL or~~		\| INVALID_NUMBER \|\| Parameter check failed
	~~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~~		\| UNSATISFIED \|\| Register write failed
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~		\| SUCCESSFUL \|\| All OK
	~~(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;
			status = oceos_protect_internal_scrubber_set(0x0, 0x1, 0x0, 0x0, 0x1);
			if (SUCCESSFUL != status) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_segment_define() */

2022-03-29T09:44:02Z

oceos_protect_segment_define()

← Older revision		Revision as of 09:44, 29 March 2022
Line 529:		Line 529:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Define the range of addresses for a segment of a MEMPROT unit.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_segment_define(
			const unsigned int unit, // MEMPROT select, 0 => main bus, 1 => DMA bus
			const unsigned int segment,// segment number, 0 to 3 inclusive
			const unsigned int start, // start address
			const unsigned int end // end address
			)
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 539:		Line 545:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| unit \|\| MEMPROT select, 0 => main bus, 1 => DMA bus
			\|-
			\| segment\|\| Segment number, 0 to 3 inclusive
			\|-
			\| start \|\| Segment start address
			\|-
			\| end \|\| Segment end address
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 547:		Line 559:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL or~~		\| INVALID_NUMBER \|\| Parameter check failed
	~~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~~		\| UNSATISFIED \|\| Register write failed
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~		\| SUCCESSFUL \|\| All OK
	~~(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;
			status = oceos_protect_segment_define(0x1, 0x2, 0x40000000, 0x40001000);
			if (SUCCESSFUL != status) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_unit_control() */

2022-03-29T09:38:57Z

oceos_protect_unit_control()

← Older revision		Revision as of 09:38, 29 March 2022
Line 477:		Line 477:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			The two memory protection units in the GR716 can be used to restrict write access to memory segments by selected system bus masters (MEMPROT0) and by selected DMA bus masters (MEMPROT1).Each unit allows four memory segments be defined for write protection.

			In addition MEMPROT0 can restrict access via the system bus AHB to APB bridges by selected system bus masters and the four DMA units to selected APB bus devices.

			MEMPROT0 can protect four segments in the range 0x40000000 to 0x4FFFFFFF or the range 0x80000000 to 0x8041FFFF, as well as specific APB units.

			MEMPROT1 can protect four segments in the range 0x30000000 tp 0x31000000 and restrict the access of any master on the DMA bus. An attempt to write to a protected area causes an AMBA ERROR response which can cause an interrupt from MEMSCRUB or from one of the AHBSTAT units.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_unit_control(
			const unsigned int unit, // 0 => main bus, 1 => DMA bus
			const unsigned int enable_all // 0=> disable protection, 1 => enable
			)
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 487:		Line 497:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| unit \|\| 0 => main bus, 1 => DMA bus
			\|-
			\| enable_all \|\| 0 => disable protection, 1 => enable
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 495:		Line 507:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL or~~		\| INVALID_NUMBER \|\| Parameter check failed
	~~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~~		\| UNSATISFIED \|\| Register write failed
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~		\| SUCCESSFUL \|\| All OK
	~~(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;
			status = oceos_protect_unit_control(0x1, 0x0);
			if (SUCCESSFUL != status) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_external_scrubber_position_get() */

2022-03-29T09:14:31Z

oceos_protect_external_scrubber_position_get()

← Older revision		Revision as of 09:14, 29 March 2022
Line 443:		Line 443:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Return the current value of the position register MEMSCRUB.POS

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			unsigned int oceos_protect_external_scrubber_position_get();
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 456:		Line 457:
	\|}		\|}
	<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~~		\| >= 0 \|\| MEMSCRUB.POS value
	~~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">
			unsigned int position;
			position = oceos_protect_external_scrubber_position_get();
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* oceos_protect_external_scrubbers_done_clear() */

2022-03-29T09:10:45Z

oceos_protect_external_scrubbers_done_clear()

← Older revision		Revision as of 09:10, 29 March 2022
Line 409:		Line 409:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Clears the DONE bit in MEMSCRUB.STAT as required to re-enable interrupts on task completion.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_protect_external_scrubbers_done_clear();
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 419:		Line 420:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| SUCCESSFUL \|\| All OK
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 426:		Line 427:
	\|-		\|-
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! 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~~
	~~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		\| SUCCESSFUL \|\| If All OK
Line 442:		Line 432:
	<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;
			status = oceos_protect_external_scrubbers_done_clear();
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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

Okhoruzhyy: /* API Functions */

2022-03-29T09:08:43Z

API Functions

← Older revision		Revision as of 09:08, 29 March 2022
Line 64:		Line 64:
	\|-		\|-
	\| [[OCEOS/oceos_protection#oceos_protect_external_scrubber_status_get()\|oceos_protect_external_scrubber_status_get()]] \|\| Get the status of the external scrubber MEMSCRUB \|\| * \|\| * \|\| *		\| [[OCEOS/oceos_protection#oceos_protect_external_scrubber_status_get()\|oceos_protect_external_scrubber_status_get()]] \|\| Get the status of the external scrubber MEMSCRUB \|\| * \|\| * \|\| *
			\|-
			\| [[OCEOS/oceos_protection#oceos_protect_external_scrubbers_done_clear()\|oceos_protect_external_scrubbers_done_clear()]] \|\| Clear the DONE bit in MEMSCRUB.STAT \|\| * \|\| * \|\| *
	\|-		\|-
	\| [[OCEOS/oceos_protection#oceos_protect_external_scrubber_position_get()\|oceos_protect_external_scrubber_position_get()]] \|\| Get the current value of the MEMSCRUB position register \|\| * \|\| * \|\| *		\| [[OCEOS/oceos_protection#oceos_protect_external_scrubber_position_get()\|oceos_protect_external_scrubber_position_get()]] \|\| Get the current value of the MEMSCRUB position register \|\| * \|\| * \|\| *
Line 368:		Line 370:
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

	===<span style="color:#0000ff">oceos_protect_external_scrubber_status_get()</span>===		===<span style="color:#0000ff">oceos_protect_external_scrubber_status_get()</span>===
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">
Line 402:		Line 403:
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>
			===<span style="color:#0000ff">oceos_protect_external_scrubbers_done_clear()</span>===
			<blockquote style="border-left-style: none;">
			<span style="color:#1b7ac2">'''Header File'''</span><br>
			'''''protection.h'''''<br>

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

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

			</syntaxhighlight>
			<span style="color:#1b7ac2">'''Parameters'''</span><br>
			{\| class="wikitable"
			\|-
			! Parameter !! Description
			\|-
			\| \|\|
			\|}
			<span style="color:#1b7ac2">'''Returns'''</span><br>
			This function returns enum DIRECTIVE_STATUS.<br>
			{\| class="wikitable"
			\|-
			! enum DIRECTIVE_STATUS !! 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
			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>
			<syntaxhighlight lang="C">

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

Okhoruzhyy: /* oceos_protect_external_scrubber_status_get() */

2022-03-29T09:03:27Z

oceos_protect_external_scrubber_status_get()

← Older revision		Revision as of 09:03, 29 March 2022
Line 375:		Line 375:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Returns the external memory scrubber status register MEMSCRUB.STAT as required to re-enable interrupts on task completion.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			unsigned int oceos_protect_external_scrubber_status_get();
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 388:		Line 389:
	\|}		\|}
	<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~~		\| >= 0 \|\| MEMSCRUB.STAT value
	~~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">
			unsigned int reg_value;
			reg_value = oceos_protect_external_scrubber_status_get();
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

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