MX Foundation 4

Functions

uint32 mxfEmbeddedCodeDownload (HMXF_DEVICE device, const char *name)
 
uint32 mxfEmbeddedDataDownload (HMXF_DEVICE device, uint64 size, uint32 *data)
 

Detailed Description

Function Documentation

uint32 mxfEmbeddedCodeDownload ( HMXF_DEVICE  device,
const char *  name 
)
C#
public static extern UInt32 mxfEmbeddedCodeDownload(UInt64 device, string name);

Downloads an embedded code application on the specified device.

The code will be copied to the filesystem on the device. The code size must be smaller than VMXF_DEVICE_EMBEDDED_CODEANDDATA_SIZE_MAX. The KMXF_DEVICE_EMBEDDED_CODEANDDATA_SIZE attribute is not used.

Parameters
[in]devicedevice handle
[in]namecomplete path to file to download
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfEmbeddedHandlerEnableSet()
mxfEmbeddedDataDownload()
Examples:
ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, and ar429_embedded_timer.cs.
uint32 mxfEmbeddedDataDownload ( HMXF_DEVICE  device,
uint64  size,
uint32 *  data 
)
C#
public static extern UInt32 mxfEmbeddedDataDownload(UInt64 device, UInt64 size, UInt32[] data);

Downloads a data section on the specified device.
mxfEmbeddedCodeDownload() must previously be called.
This function will trigger the mxfEmbeddedDataDownloadHandler() function of the embedded code.

A specific region of memory must be reserved on the device before the initialization by using the mxfSystemInitAttributeUint64CallbackHandler() and KMXF_DEVICE_EMBEDDED_CODEANDDATA_SIZE attribute.

The data in the buffer is copied using 32-bit access. To avoid any endianness mapping issues, it is recommended to use only 32-bit data format for this buffer.

Parameters
[in]devicedevice handle
[in]sizenumber of 32-bit word to send.
[in]datadata buffer pointer
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfSystemDeviceGet()
mxfSystemDeviceAllGet()
mxfSystemInitAttributeUint64CallbackHandler()
Updated 10/23/2023