RestoreBlockDefaults

Restore Block Defaults

Restore Block Defaults

Description

Request to copy the ROM block default data to its corresponding RAM block. The selected block needs either ROM defaults or an initialization callback. This function queues the restore request and returns the acceptance results synchronously.

Request Type

Asynchronous

Port Description

The following table describes the ports for this block.

Port

Type

Description

NvM_DstPtr

Output

Pointer where the data of a non-permanent RAM block shall be written to.
Only available if Set Output to NULL_PTR = False

CallFunction

Input

Non-functional port to allow designers to show when the function should be called in their model.
Only available if Cast Function Return to Void = True

Return

Output

Standard return E_OK or E_NOT_OK for the function call.
Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter

Description

NvM Block Name

The block name defined in the m-file with the NVM class.

Cast Function Return to Void

True: Function will be cast as a 'void' function and the return value is ignored.
False: Value is returned and used by the calling function.

Data Store for NvM_DstPtr

Data store name for use in model testing for the output argument in the function call.

Data Store for Return

Data store name for use in model testing for the result of the function call.
Only available if Cast Function Return to Void = False

Set Output to NULL_PTR

True: NvM_DstPtr is ignored and NvM will used the configured PIM (permanent address)
False: NvM_DstPtr shall point to the variable where NvM data shall be written to in RAM.

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type

Compatible

Native

Yes

Redundant

Yes

Data Set

Yes

See Also

Last modified October 12, 2025: Initial commit (1fadfc4)