PN_API_IOD_restoreRemaMemCbf

typedef uint32_t(* PN_API_IOD_restoreRemaMemCbf) (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_RemaDataType_t type, const uint32_t instance, uint8_t **const destMem, uint32_t *const memSize)

Callback function prototype to request stored NV data.

This function is called by Profinet stack to request PDev record data block from to the user application. This function is called after startup and insertion of PDev modules.

Warning

The actual address of the rema data should be given back through "mem" parameter. Rema data must be static and remain valid after the call of this function is completed.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	type	type of content to be stored
[in]	instance	instance of type
[out]	destMem	Pointer to the buffer holding PDev data.
[in]	memSize	Size of the PDev buffer that needs to be restored from NV memory.

Returns

result of the operation as uint32_t.

Return values

PN_API_OK	Success.
PN_API_NOT_OK	Something went wrong.

Example

#include "pn_api_iod_bsp.h"
#include "pn_api_iod_callbacks.h"
#include "pn_api_iod_startup.h"
 
//Implement the callback function in the user application
uint32_t PN_APP_IOD_cbRestoreRemaMem(
   PN_API_IOD_Handle_t *const pnHandle,
   PN_API_IOD_RemaDataType_t type, const uint32_t instance,
   uint8_t *const *destMem, uint32_t *const memSize)
{...}
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
//Store callback functions implemented by the user application
PN_API_IOD_Callbacks_t callbacks = {
    .restoreRemaMem = PN_APP_IOD_cbRestoreRemaMem,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);