com_secure_config.h File Reference

Detailed Description

..

The symbol COM_SECURE_CONFIG_SUPPORT must be configured (file com_conf.h) to enable this add-on.

#include "com_sdo_cln.h"

Include dependency graph for com_secure_config.h:

Data Structures
struct	ComSecureDeviceChecksum_s

Macros
#define	COM_SECURE_CONFIG_VERSION_MAJOR   1
#define	COM_SECURE_CONFIG_VERSION_MINOR   0

Functions
ComStatus_tv	ComSecureConfigGetChecksum (uint8_t ubNetV, uint8_t ubNodeIdV)
ComStatus_tv	ComSecureConfigGetSeed (uint8_t ubNetV, uint8_t ubNodeIdV)
ComStatus_tv	ComSecureConfigGetStatus (uint8_t ubNetV, uint8_t ubNodeIdV)
ComStatus_tv	ComSecureConfigSetDcf (uint8_t ubNetV, uint8_t ubNodeIdV, uint32_t ulVendorIdV, uint32_t ulProductCodeV, uint8_t ubFlagsV, uint8_t *pubConciseDcfV, uint32_t ulConciseDcfSizeV)
ComStatus_tv	ComSecureConfigSetDict (uint8_t ubNetV, uint8_t ubNodeIdV, uint32_t ulVendorIdV, uint32_t ulProductCodeV, uint8_t ubAccessV)

Typedef Documentation

ComSecureDeviceChecksum_ts

typedef struct ComSecureDeviceChecksum_s ComSecureDeviceChecksum_ts

Enumeration Type Documentation

ComSecureConfigDict_e

enum ComSecureConfigDict_e

Enumerator
eCOM_SECURE_CONFIG_DICT_ALLOW_WRITE
eCOM_SECURE_CONFIG_DICT_BLOCK_WRITE

Function Documentation

ComSecureConfigDeviceBuildNonce()

uint64_t ComSecureConfigDeviceBuildNonce	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV,
		uint64_t	uqSeedV )

ComSecureConfigDeviceChecksum()

ComStatus_tv ComSecureConfigDeviceChecksum	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV,
		ComSecureDeviceChecksum_ts *	ptsChecksumV )

ComSecureConfigDeviceSeed()

ComStatus_tv ComSecureConfigDeviceSeed	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV )

ComSecureConfigDeviceStatus()

ComStatus_tv ComSecureConfigDeviceStatus	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV,
		uint8_t *	pubStatusV )

ComSecureConfigEventNonceExpired()

void ComSecureConfigEventNonceExpired	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV )

ComSecureConfigGetChecksum()

ComStatus_tv ComSecureConfigGetChecksum	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubNodeIdV	Node-ID value

Returns

Value of enumeration ComErr_e

See also

ComSecureConfigChecksum()

This function is used to read the Secure Configuration Checksum value (Index 2D12_h) from device with a node-ID of ubNodeIdV.

The function returns immediately after the SDO / USDO request has been triggered, the status of the SDO / USDO transfer can be evaluated by the handler ComObjectEventReady().

ComSecureConfigGetSeed()

ComStatus_tv ComSecureConfigGetSeed	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubNodeIdV	Node-ID value

Returns

Value of enumeration ComErr_e

See also

ComSecureConfigBuildNonce()

This function is used to read the Secure Authentication Seed value (Index 2D18_h) from device with a node-ID of ubNodeIdV.

The function returns immediately after the SDO / USDO request has been triggered, the status of the SDO / USDO transfer can be evaluated by the handler ComObjectEventReady().

ComSecureConfigGetStatus()

ComStatus_tv ComSecureConfigGetStatus	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubNodeIdV	Node-ID value

Returns

Value of enumeration ComErr_e

See also

ComSecureConfigStatus()

This function is used to read the Secure Configuration Status value (Index 2D14_h) from device with a node-ID of ubNodeIdV.

The function returns immediately after the SDO / USDO request has been triggered, the status of the SDO / USDO transfer can be evaluated by the handler ComObjectEventReady().

ComSecureConfigInit()

ComStatus_tv ComSecureConfigInit

(

uint8_t

ubNetV

)

ComSecureConfigSetDcf()

ComStatus_tv ComSecureConfigSetDcf	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV,
		uint32_t	ulVendorIdV,
		uint32_t	ulProductCodeV,
		uint8_t	ubFlagsV,
		uint8_t *	pubConciseDcfV,
		uint32_t	ulConciseDcfSizeV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubNodeIdV	Node-ID value
[in]	ulVendorIdV	Vendor-ID of device (1018:01h)
[in]	ulProductCodeV	Product Code of device (1018:01h)
[in]	ubFlagsV	Full or partial configuration
[in]	pubConciseDcfV	Pointer to Concise DCF structure
[in]	ulConciseDcfSizeV	Size of Concise DCF structure

Returns

Value of enumeration ComErr_e

This function is used to write secure DCF to the device defined by ubNodeIdV and apply this DCF to the object dictionary. The parameters ulVendorIdV and ulProductCodeV must match the values of the Identity object stored in the device.

The function returns immediately after the SDO / USDO request has been triggered, the status of the SDO / USDO transfer can be evaluated by the handler ComObjectEventReady().

ComSecureConfigSetDict()

ComStatus_tv ComSecureConfigSetDict	(	uint8_t	ubNetV,
		uint8_t	ubNodeIdV,
		uint32_t	ulVendorIdV,
		uint32_t	ulProductCodeV,
		uint8_t	ubAccessV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubNodeIdV	Node-ID value
[in]	ulVendorIdV	Vendor-ID of device (1018:01h)
[in]	ulProductCodeV	Product Code of device (1018:01h)
[in]	ubAccessV	Allow or block write access

Returns

Value of enumeration ComErr_e

This function is used to used to allow or block write access to data elements of the object dictionary for device defined by ubNodeIdV. The parameters ulVendorIdV and ulProductCodeV must match the values of the Identity object stored in the device.

The function returns immediately after the SDO / USDO request has been triggered, the status of the SDO / USDO transfer can be evaluated by the handler ComObjectEventReady().

ComSecureConfigTmrEvent()

void ComSecureConfigTmrEvent

(

uint8_t

ubNetV

)