1 of 26

Sub Setting Structures Overview - neoVI API

Setting Structure

Use

CAN Setting

SW CAN Settings

CAN FD Settings

LIN Settings

ISO9141 Keyword2000 Settings

ISO9141 Keyword200 Waveform Settings

Ethernet Settings

General OP Ethernet Settings

OP Ethernet Settings

Text API Settings

Additional Pluto Settings

UART Settings

CAN_SETTINGS Structure

s structure defines settings for CAN networks on neoVI and ValueCAN devices.

Remarks

Item

Description

SWCAN_SETTINGS Structure

This structure defines settings for SWCAN networks on neoVI Fire devices.

Remarks

Item

Description

CANFD_SETTINGS Structure

This structure defines settings for CANFD networks on supporting neoVI and ValueCAN devices.

Remarks

Item

Description

LIN_SETTINGS Structure

This structure defines settings for LIN networks on supported hardware devices.

typedef struct __declspec (align(2))
 {
  unsigned int Baudrate;
  unsigned short spbrg;
  unsigned char brgh;
  unsigned char NumBitsDelay;
  unsigned char MasterResistor;
  unsigned char Mode;
 }LIN_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure LIN_SETTINGS
    Dim Baudrate As UInt32
    Dim spbrg As UInt16
    Dim brgh As Byte
    Dim NumBitsDelay As Byte
    Dim MasterResistor As Byte
    Dim Mode As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct LIN_SETTINGS
{
    public UInt32 Baudrate;
    public UInt16 spbrg;
    public byte brgh;
    public byte NumBitsDelay;
    public byte MasterResistor;
    public byte Mode;
}

Remarks

Item

Description

Baudrate

Baudrate to be set

spbrg

Only use with neoVI FIRE. 40Mhz/Baudrate/16-1 = spbrg

brgh

Set to 0

NumBitsDelay

Delay to set between Header and Slave data. Default is 0

MasterResistor

Enable for Master Resistor Off=0: On=1:

Mode

Sets the LIN Mode Sleep=0: Slow=1: Normal=2: Fast=2:

ISO9141_KEYWORD2000_SETTINGS Structure

This structure defines settings for ISO9141 and Keyword 2000 networks on neoVI Fire devices.

Remarks

Structure Elements

Item

Description

ISO9141_KEYWORD2000__INIT_STEP Structure

This structure defines settings for the ISO9141 and Keyword 2000 initialization step on neoVI Fire devices.

Remarks

Structure Elements

Item

Description

ETHERNET_SETTINGS Structure

This structure defines various settings for Ethernet networks.

Remarks

Item

Description

ETHERNET_SETTINGS2 Structure

This structure defines various settings for Ethernet networks.

Remarks

Item

Description

OP_ETH_GENERAL_SETTINGS Structure

Structure defining the parameter in OP_ETH_GENERAL_SETTINGS

typedef struct __declspec (align(2))
{
    uint8_t ucInterfaceType;
    uint8_t reserved0;
    uint8_t reserved1;
    uint8_t reserved2;
    uint16_t tapPair0;
    uint16_t tapPair1;
    uint16_t tapPair2;
    uint16_t tapPair3;
    uint16_t tapPair4;
    uint16_t tapPair5;
    uint32_t uFlags;
}OP_ETH_GENERAL_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure OP_ETH_GENERAL_SETTINGS
    Dim ucInterfaceType As Byte
    Dim reserved0 As Byte
    Dim reserved1 As Byte
    Dim reserved2 As Byte
    Dim tapPair0 As UInt16
    Dim tapPair1 As UInt16
    Dim tapPair2 As UInt16
    Dim tapPair3 As UInt16
    Dim tapPair4 As UInt16
    Dim tapPair5 As UInt16
    Dim uFlags As UInt32
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct OP_ETH_GENERAL_SETTINGS
{
    public byte ucInterfaceType;
    public byte reserved0;
    public byte reserved1;
    public byte reserved2;
    public UInt16 tapPair0;
    public UInt16 tapPair1;
    public UInt16 tapPair2;
    public UInt16 tapPair3;
    public UInt16 tapPair4;
    public UInt16 tapPair5;
    public UInt32 uFlags;
}

Remarks

Item

Description

ucInterfaceType

Sets the mode of the device

0=Tap 1= Media Converter 2=Low Latency Tab

reserved0

Reserved

reserved1

Reserved

reserved2

Reserved

tapPair0

For future use

tapPair1

For future use

tapPair2

For future use

tapPair3

For future use

tapPair4

For future use

tapPair5

For future use

uFlags

Reserved

OP_ETH_SETTINGS Structure

This structure defines various settings for OP BR Ethernet networks.

typedef struct __declspec (align(2))
{
    unsigned char ucConfigMode;
    unsigned char preemption_en;
    unsigned char mac_addr1_0;
    unsigned char mac_addr1_1;
    unsigned char mac_addr1_2;
    unsigned char mac_addr1_3;
    unsigned char mac_addr1_4;
    unsigned char mac_addr1_5;
    unsigned char mac_addr2_0;
    unsigned char mac_addr2_1;
    unsigned char mac_addr2_2;
    unsigned char mac_addr2_3;
    unsigned char mac_addr2_4;
    unsigned char mac_addr2_5;
    unsigned char OpEthFlags;
    unsigned char Reserved;
}OP_ETH_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure OP_ETH_SETTINGS
    Dim ucConfigMode As Byte
    Dim preemption_en As Byte
    Dim mac_addr1_0 As Byte
    Dim mac_addr1_1 As Byte
    Dim mac_addr1_2 As Byte
    Dim mac_addr1_3 As Byte
    Dim mac_addr1_4 As Byte
    Dim mac_addr1_5 As Byte
    Dim mac_addr2_0 As Byte
    Dim mac_addr2_1 As Byte
    Dim mac_addr2_2 As Byte
    Dim mac_addr2_3 As Byte
    Dim mac_addr2_4 As Byte
    Dim mac_addr2_5 As Byte
    Dim OpEthFlags As Byte
    Dim Reserved As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct OP_ETH_SETTINGS
{
    public byte ucConfigMode;
    public byte preemption_en;
    public byte mac_addr1_0;
    public byte mac_addr1_1;
    public byte mac_addr1_2;
    public byte mac_addr1_3;
    public byte mac_addr1_4;
    public byte mac_addr1_5;
    public byte mac_addr2_0;
    public byte mac_addr2_1;
    public byte mac_addr2_2;
    public byte mac_addr2_3;
    public byte mac_addr2_4;
    public byte mac_addr2_5;
    public byte OpEthFlags;
    public byte Reserved;
}

Remarks

Item

Description

ucConfigMode

Sets the Link Mode. 0=Auto: 1=Master: 2=Slave

preemption_en

Enables Preemption Support (IEEE802.3Br). 0=Disabled: 1=Enabled

mac_addr1_0

First byte of Original MAC address XX:11:22:33:44:55

mac_addr1_1

Second byte of Original MAC address 00:XX:22:33:44:55

mac_addr1_2

Third byte of Original MAC address 00:11:XX:33:44:55

mac_addr1_3

Fourth byte of Original MAC address 00:11:22:XX:44:55

mac_addr1_4

Fifth byte of Original MAC address 00:11:22:33:XX:55

mac_addr1_5

Sixth First byte of Original MAC address 00:11:22:33:44:XX

mac_addr2_0

First byte of Spoof MAC address XX:11:22:33:44:55

mac_addr2_1

Second byte of Spoof MAC address 00:XX:22:33:44:55

mac_addr2_2

Third byte of Spoof MAC address 00:11:XX:33:44:55

mac_addr2_3

fourth byte of Spoof MAC address 00:11:22:XX:44:55

mac_addr2_4

Fifth byte of Spoof MAC address 00:11:22:33:XX:55

mac_addr2_5

Sixth byte of Spoof MAC address 00:11:22:33:44:XX

OpEthFlags

Bitfield of options

Reserved

Not Available

SPluto_CustomParams Structure

This structure defines a sub structure for SRADPlutoSettings

typedef struct __declspec (align(2))
{
   unsigned char mode0;
   unsigned char mode1;
   unsigned char mode2;
   unsigned char mode3;
   unsigned char mode4;
   unsigned char speed0;
   unsigned char speed1;
   unsigned char speed2;
   unsigned char speed3;
   unsigned char speed4;
   unsigned char PhyEnable0;
   unsigned char PhyEnable1;
   unsigned char PhyEnable2;
   unsigned char PhyEnable3;
   unsigned char PhyEnable4;
   unsigned char ae1Select;
   unsigned char usbSelect;
   unsigned char pad;
}SPluto_CustomParams;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure SPluto_CustomParams
   Dim mode0 As Byte
   Dim mode1 As Byte
   Dim mode2 As Byte
   Dim mode3 As Byte
   Dim mode4 As Byte
   Dim speed0 As Byte
   Dim speed1 As Byte
   Dim speed2 As Byte
   Dim speed3 As Byte
   Dim speed4 As Byte
   Dim PhyEnable0 As Byte
   Dim PhyEnable1 As Byte
   Dim PhyEnable2 As Byte
   Dim PhyEnable3 As Byte
   Dim PhyEnable4 As Byte
   Dim ae1Select As Byte
   Dim usbSelect As Byte
   Dim pad As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct SPluto_CustomParams
{
   public byte mode0;
   public byte mode1;
   public byte mode2;
   public byte mode3;
   public byte mode4;
   public byte speed0;
   public byte speed1;
   public byte speed2;
   public byte speed3;
   public byte speed4;
   public byte PhyEnable0;
   public byte PhyEnable1;
   public byte PhyEnable2;
   public byte PhyEnable3;
   public byte PhyEnable4;
   public byte ae1Select;
   public byte usbSelect;
   public byte pad;
}

Remarks

Item

Description

mode0

First inputs connect Mode

Auto = 0: Master = 1: Slave :1

mode1

Second inputs connect Mode

Auto = 0: Master = 1: Slave :1

mode2

Third inputs connect Mode

Auto = 0: Master = 1: Slave :1

mode3

Fourth inputs connect Mode

Auto = 0: Master = 1: Slave :1

mode4

Not used Set to 0

speed0

Sets the Speed of the Channel

speed1

Not used set to 0

speed2

Not used set to 0

speed3

Not used set to 0

speed4

Not used set to 0

PhyEnable0

Enables the first phy

PhyEnable1

Enables the second phy

PhyEnable2

Enables the Third phy

PhyEnable3

Enables the Fourth phy

PhyEnable4

Enables the Fifth phy

ae1Select

Sets if the First phy is AE or RJ45

AE=1: RJ45=0

usbSelect

Sets USB Mode

USB=0: USB to Ethernet: VSpy and Core Mini are not connected to Ethernet.

CoreMini=1: CM: VSpy and Core Mini can access Ethernet. USB to Ethernet disconnected

pad

Not Available

UART_SETTINGS Structure

This structure defines settings for UART access on neoVI Fire devices.

typedef struct _UART_SETTINGS{
   unsigned short Baudrate;
   unsigned short spbrg;
   unsigned short brgh;
   unsigned short parity;
   unsigned short stop_bits;
   unsigned char flow_control; // 0- off, 1 - Simple CTS RTS,
   unsigned char reserved_1;
   unsigned int bOptions; //AND to combind these values invert_tx = 1 invert_rx = 2 half_duplex = 4
} UART_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure UART_SETTINGS
   Dim Baudrate As UInt16
   Dim spbrg As UInt16
   Dim brgh As UInt16
   Dim parity As UInt16
   Dim stop_bits As UInt16
   Dim flow_control As Byte '// 0- off, 1 - Simple CTS RTS,
   Dim reserved_1 As Byte
   Dim bOptions As UInt32 '//AND to combind these values invert_tx = 1 invert_rx = 2 half_duplex = 4
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct UART_SETTINGS
{
   public UInt16 Baudrate; If
   public UInt16 spbrg;
   public UInt16 brgh;
   public UInt16 parity;
   public UInt16 stop_bits;
   public byte flow_control; // 0- off, 1 - Simple CTS RTS,
   public byte reserved_1;
   public UInt32 bOptions; //AND to combind these values invert_tx = 1 invert_rx = 2 half_duplex = 4
}

Remarks

Structure Elements

Item

Description

Holds the baud rate for the UART Connection. An example value could be 10417 or 9600

Sets the Parity type. Valid values are below

Sets the number of stop bits to use. Valid values are below.

Set to 0 for no flow control and 1 for simple CTS RTS

Bitfield containing UART Options

RAD_GPTP_SETTINGS Structure

This structure defines various settings for the gPTP

typedef struct __declspec (align(2))
{
   uint32_t neighborPropDelayThresh;
   uint32_t sys_phc_sync_interval;
   int8_t logPDelayReqInterval;
   int8_t logSyncInterval;
   int8_t logAnnounceInterval;
   uint8_t profile;
   uint8_t priority1;
   uint8_t clockclass;
   uint8_t clockaccuracy;
   uint8_t priority2;
   uint16_t offset_scaled_log_variance;
   uint8_t gPTPportRole;
   uint8_t gptpEnabledPort;
   uint32_t rsvd0;
   uint32_t rsvd1;
   uint32_t rsvd2;
   uint32_t rsvd3;
}RAD_GPTP_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure RAD_GPTP_SETTINGS
   Dim neighborPropDelayThresh As UInt32
   Dim sys_phc_sync_interval As UInt32
   Dim logPDelayReqInterval As Byte
   Dim logSyncInterval As Byte
   Dim logAnnounceInterval As Byte
   Dim profile As Byte
   Dim priority1 As Byte
   Dim clockclass As Byte
   Dim clockaccuracy As Byte
   Dim priority2 As Byte
   Dim offset_scaled_log_variance As UInt16
   Dim gPTPportRole As Byte
   Dim gptpEnabledPort As Byte
   Dim rsvd0 As UInt32
   Dim rsvd1 As UInt32
   Dim rsvd2 As UInt32
   Dim rsvd3 As UInt32
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct RAD_GPTP_SETTINGS
{
   public UInt32 neighborPropDelayThresh;
   public UInt32 sys_phc_sync_interval;
   public byte logPDelayReqInterval;
   public byte logSyncInterval;
   public byte logAnnounceInterval;
   public byte profile;
   public byte priority1;
   public byte clockclass;
   public byte clockaccuracy;
   public byte priority2;
   public UInt16 offset_scaled_log_variance;
   public byte gPTPportRole;
   public byte gptpEnabledPort;
   public UInt32 rsvd0;
   public UInt32 rsvd1;
   public UInt32 rsvd2;
   public UInt32 rsvd3;
   }

Remarks

Item

Description

neighborPropDelayThresh

Threshold value for neighbor propagation delay. A Device will be identified as non-AS Capable if pDelay exceeds this value

sys_phc_sync_interval

Not Defined

logPDelayReqInterval

Delay Request Interval Value = log2(Interval in Seconds)

logSyncInterval

Sync Interval Value = log2(Interval in Seconds)

logAnnounceInterval

Announce Interval Value = log2(Interval in Seconds)

profile

Set the gPTP Profile 0 = Standard, 1=Automotive

priority1

Priority1 sets the ordering priority. Lower values set a better ClockMaster. See gPTP spec, 8021AS for more details and restrictions.

clockclass

clockClass gives the traceability of the synchronized time sent by the Master in Grandmaster mode. See gPTP spec, 8021AS for more details.

clockaccuracy

clockAccuracy sets the time Accuracy of the ClockMaster. Lower values indicate better clocks. See gPTP spec, 8021AS for more details.

priority2

priority2 uses a similar scheme as priority1. See gPTP spec, 8021AS for more details.

offset_scaled_log_variance

This parameter is an estimate of the Variance in PTP. See gPTP spec, 8021AS for more details.

gPTPportRole

Sets the gPTP port Role. 0 = Master, 1=Slave

gptpEnabledPort

Sets the Channel to use for gPTP 0 = Disabled, 1 = OpEth1, 2 = OpEth2, 3 = OpEth3 4 = OpEth4, 5 = OpEth5, 6 = OpEth6, 7 = OpEth7 8 = OpEth8, 9 = OpEth9, 10 = OpEth10, 11 = OpEth11 12 = OpEth12, 13 = StdEth1, 14 = StdEth2

rsvd0

Reserved

rsvd1

Reserved

rsvd2

Reserved

rsvd3

Reserved

LOGGER_SETTINGS Structure

Structure for logging settings

typedef struct __declspec (align(2))
{
   uint8_t extraction_timeout;
   uint8_t rsvd0;
   uint8_t rsvd1;
   uint8_t rsvd2;
}LOGGER_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure LOGGER_SETTINGS
   Dim extraction_timeout As Byte
   Dim rsvd0 As Byte
   Dim rsvd1 As Byte
   Dim rsvd2 As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct LOGGER_SETTINGS
{
   public byte extraction_timeout;
   public byte rsvd0;
   public byte rsvd1;
   public byte rsvd2;
}

Remarks

Item

Description

extraction_timeout

Not Defined

Bit 7

Bit 6-0

rsvd0

Not Defined

rsvd1

Not Defined

rsvd2

Not Defined

DISK_SETTINGS Structure

Structure for storage media on the hardware

typedef struct __declspec (align(2))
{
   uint8_t disk_layout;
   uint8_t disk_format;
   uint32_t disk_enables;
   uint32_t rsvd0;
   uint32_t rsvd1;
}DISK_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure DISK_SETTINGS
   Dim disk_layout As Byte
   Dim disk_format As Byte
   Dim disk_enables As UInt32
   Dim rsvd0 As UInt32
   Dim rsvd1 As UInt32
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct DISK_SETTINGS
{
   public byte disk_layout;
   public byte disk_format;
   public UInt32 disk_enables;
   public UInt32 rsvd0;
   public UInt32 rsvd1;
}

Remarks

Item

Description

disk_layout

Reads the layout of the memory media 0=Spanned, 1=RAID0, 2=RAID1, 3=RAID5, 4=Individual

disk_format

Reads the format of the configured disk 0=Unknown, 1=FAT32, 2=exFAT

disk_enables

Not Defined

rsvd0

Reserved

rsvd1

Reserved

TIMESYNC_ICSHARDWARE_SETTINGS Structure

Structure defining the parameters for Time Sync

typedef struct __declspec (align(2))
{
   uint8_t MasterEnable;
   uint8_t SlaveEnable;
   uint8_t MasterNetwork;
   uint8_t SlaveNetwork;
}TIMESYNC_ICSHARDWARE_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure TIMESYNC_ICSHARDWARE_SETTINGS
   Dim MasterEnable As Byte
   Dim SlaveEnable As Byte
   Dim MasterNetwork As Byte
   Dim SlaveNetwork As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct TIMESYNC_ICSHARDWARE_SETTINGS
{
   public byte MasterEnable;
   public byte SlaveEnable;
   public byte MasterNetwork;
   public byte SlaveNetwork;
}

Remarks

Item

Description

MasterEnable

Not Defined

SlaveEnable

Not Defined

MasterNetwork

Not Defined

SlaveNetwork

Not Defined

RAD_REPORTING_SETTINGS Structure

Setting structure for reporting options for the Rad Galaxy

typedef struct __declspec (align(2))
{
   uint32_t flags;
   uint16_t temp_interval_ms;
   uint16_t gps_interval_ms;
   uint16_t serdes_interval_ms;
   uint16_t io_interval_ms;
   uint32_t rsvd;
}RAD_REPORTING_SETTINGS;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure RAD_REPORTING_SETTINGS
   Dim flags As UInt32
   Dim temp_interval_ms As UInt16
   Dim gps_interval_ms As UInt16
   Dim serdes_interval_ms As UInt16
   Dim io_interval_ms As UInt16
   Dim rsvd As UInt32
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct RAD_REPORTING_SETTINGS
{
   public UInt32 flags;
   public UInt16 temp_interval_ms;
   public UInt16 gps_interval_ms;
   public UInt16 serdes_interval_ms;
   public UInt16 io_interval_ms;
   public UInt32 rsvd;
}

Remarks

Item

Description

flags

Bitfield for enabling different IO features.

I/O Feature

Bit to set

temp_interval_ms

Sets the interval in ms for reporting the temperature.

gps_interval_ms

Sets the interval in ms for reporting the GPS.

serdes_interval_ms

Sets the interval in ms for reporting the Serdes.

io_interval_ms

Sets the interval in ms for reporting the IO.

rsvd

Reserved

STextAPISettings Structure

This structure defines settings for Text API communication for neoVI Fire devices.

typedef struct _STextAPISettings
{
    unsigned int can1_tx_id;
    unsigned int can1_rx_id;
    unsigned int can1_options;// Set to 1 for Extended, 0 for standard
    unsigned int can2_tx_id;
    unsigned int can2_rx_id;
    unsigned int can2_options; // Set to 1 for Extended, 0 for standard
    unsigned int network_enables;
    unsigned int can3_tx_id3;
    unsigned int can3_rx_id3;
    unsigned int can3_options; // Set to 1 for Extended, 0 for standard
    unsigned int can4_tx_id4;
    unsigned int can4_rx_id4;
    unsigned int can4_options; // Set to 1 for Extended, 0 for standard
    int Reserved0;
    int Reserved1;
    int Reserved2;
    int Reserved3;
    int Reserved4;
}STextAPISettings;

<StructLayout(LayoutKind.Sequential, Pack:=2)> Public Structure STextAPISettings
    Dim can1_tx_id As UInt32
    Dim can1_rx_id As UInt32
    Dim can1_options As UInt32 '// Set to 1 for Extended, 0 for standard
    Dim can2_tx_id As UInt32
    Dim can2_rx_id As UInt32
    Dim can2_options As UInt32 '// Set to 1 for Extended, 0 for standard
    Dim network_enables As UInt32
    Dim can3_tx_id3 As UInt32
    Dim can3_rx_id3 As UInt32
    Dim can3_options As UInt32 '// Set to 1 for Extended, 0 for standard
    Dim can4_tx_id4 As UInt32
    Dim can4_rx_id4 As UInt32
    Dim can4_options As UInt32 '// Set to 1 for Extended, 0 for standard
    Dim Reserved0 As Int32
    Dim Reserved1 As Int32
    Dim Reserved2 As Int32
    Dim Reserved3 As Int32
    Dim Reserved4 As Int32
End Structure

[StructLayout(LayoutKind.Sequential,Pack=2)]
public struct STextAPISettings
{
    public UInt32 can1_tx_id;
    public UInt32 can1_rx_id;
    public UInt32 can1_options; // Set to 1 for Extended, 0 for standard
    public UInt32 can2_tx_id;
    public UInt32 can2_rx_id;
    public UInt32 can2_options; // Set to 1 for Extended, 0 for standard
    public UInt32 network_enables;
    public UInt32 can3_tx_id3;
    public UInt32 can3_rx_id3;
    public UInt32 can3_options; // Set to 1 for Extended, 0 for standard
    public UInt32 can4_tx_id4;
    public UInt32 can4_rx_id4;
    public UInt32 can4_options; // Set to 1 for Extended, 0 for standard
    public Int32 Reserved0;
    public Int32 Reserved1;
    public Int32 Reserved2;
    public Int32 Reserved3;
    public Int32 Reserved4;
}

Remarks

Structure Elements

Item

Description

Sets or Reads the Arbitration ID for Sending Text API commands

Sets or Reads the Arbitration ID for Sending Receiving API commands

Sets the length of the Arbitration ID’s. Set to 1 for Extended and 0 for Standard

Bitfield telling which netowrk to support Text API. One one can be enabled at a time.

Not used

gPTP Structures

GPTPStatus Structure

This structure defines settings for the GPTPStatus structure.

typedef struct __declspec (align(1))
{
   timestamp current_time;
   priority_vector gm_priority;
   int64_t ms_offset_ns;
   uint8_t is_sync;
   uint8_t link_status;
   int64_t link_delay_ns;
   uint8_t selected_role;
   uint8_t as_capable;
   uint8_t is_syntonized;
   uint8_t Reserved0;
   uint8_t Reserved1;
   uint8_t Reserved2;
   uint8_t Reserved3;
   uint8_t Reserved4;
   uint8_t Reserved5;
   uint8_t Reserved6;
   uint8_t Reserved7;
}GPTPStatus;

<StructLayout(LayoutKind.Sequential, Pack:=1)> Public Structure GPTPStatus
   Dim current_time As timestamp
   Dim gm_priority As priority_vector
   Dim ms_offset_ns As Int64
   Dim is_sync As Byte
   Dim link_status As Byte
   Dim link_delay_ns As Int64
   Dim selected_role As Byte
   Dim as_capable As Byte
   Dim is_syntonized As Byte
   Dim Reserved0 As Byte
   Dim Reserved1 As Byte
   Dim Reserved2 As Byte
   Dim Reserved3 As Byte
   Dim Reserved4 As Byte
   Dim Reserved5 As Byte
   Dim Reserved6 As Byte
   Dim Reserved7 As Byte
End Structure

[StructLayout(LayoutKind.Sequential,Pack=1)]
public struct GPTPStatus
{
   public timestamp current_time;
   public priority_vector gm_priority;
   public Int64 ms_offset_ns;
   public byte is_sync;
   public byte link_status;
   public Int64 link_delay_ns;
   public byte selected_role;
   public byte as_capable;
   public byte is_syntonized;
   public byte Reserved0;
   public byte Reserved1;
   public byte Reserved2;
   public byte Reserved3;
   public byte Reserved4;
   public byte Reserved5;
   public byte Reserved6;
   public byte Reserved7;
}

Remarks

Item

Description

current_time

See timestamp structure

gm_priority

See priority_vector structure

ms_offset_ns

Master slave offset in nano seconds Valid when the port role is in slave mode.

is_sync

Returns the gptp is synchronization status. un-synced = 0 synced = 1 - valid when the port role is in slave mode.

link_status

Gives the link status of the gptp enabled port. link down = 0 link up = 1

link_delay_ns

Gives the link delay between the device and the link partner in nano second. Value is valid when the device is - in standard profile - in automotive profile - port role is slave mode

selected_role

Indicates current port role, disabled, master, slave or passive. DISABLED = 0 PASSIVE = 1 (Passive is only available for gptp switch mode) MASTER = 2 SLAVE = 3

as_capable

indicates 802.1AS capability 0 = Not 802.1AS capability 1 = 802.1AS capability

is_syntonized

Indicates if gPTP is syntonized or not. Valid when the port role is in slave mode. 1 = if device is syntonized with grand master 0 = if not

Reserved0

Reserved

Reserved1

Reserved

Reserved2

Reserved

Reserved3

Reserved

Reserved4

Reserved

Reserved5

Reserved

Reserved6

Reserved

Reserved7

Reserved

timestamp Structure

This structure defines Timestamp from gPTP

Remarks

Item

Description

priority_vector Structure

This structure defines settings for the priority_Vector structure for gPTP.

typedef struct __declspec (align(1))
{
   system_identity sysid;
   uint16_t steps_removed;
   port_identity portid;
   uint16_t port_number;
}priority_vector;

<StructLayout(LayoutKind.Sequential, Pack:=1)> Public Structure priority_vector
   Dim sysid As system_identity
   Dim steps_removed As UInt16
   Dim portid As port_identity
   Dim port_number As UInt16
End Structure

[StructLayout(LayoutKind.Sequential,Pack=1)]
public struct priority_vector
{
   public system_identity sysid;
   public UInt16 steps_removed;
   public port_identity portid;
   public UInt16 port_number;
}

Remarks

Item

Description

sysid

See system_identity structure

steps_removed

Indicates the number of Network paths from the root the source is

portid

See port_identity structure

port_number

portNumber represents the PTP ports on the network.

clock_quality Structure

This structure defines various settings for the clock_quality in gPTP

Remarks

Item

Description

system_identity Structure

This structure defines settings for system_identity for gPTP

typedef struct __declspec (align(1))
{
   uint8_t priority_1;
   clock_quality clock_quality;
   uint8_t priority_2;
   uint64_t clock_identity;
}system_identity;

<StructLayout(LayoutKind.Sequential, Pack:=1)> Public Structure system_identity
   Dim priority_1 As Byte
   Dim clock_quality As clock_quality
   Dim priority_2 As Byte
   Dim clock_identity As UInt64
End Structure

[StructLayout(LayoutKind.Sequential,Pack=1)]
public struct system_identity
{
   public byte priority_1;
   public clock_quality clock_quality;
   public byte priority_2;
   public UInt64 clock_identity;
}

Remarks

Item

Description

priority_1

Priority1 sets the ordering priority. Lower values set a better ClockMaster. See gPTP spec, 8021AS for more details and restrictions.

clock_quality

See clock_quality structure

priority_2

priority2 uses a similar scheme as priority1. See gPTP spec, 8021AS for more details.

clock_identity

clockIdentity attribute is defined in 7.5.2.2 of IEEE Std 1588-2019

Sub Setting Structures Overview - neoVI API

CAN_SETTINGS Structure

SWCAN_SETTINGS Structure

CANFD_SETTINGS Structure

LIN_SETTINGS Structure

ISO9141_KEYWORD2000_SETTINGS Structure

ISO9141_KEYWORD2000__INIT_STEP Structure

ETHERNET_SETTINGS Structure

ETHERNET_SETTINGS2 Structure

Remarks

OP_ETH_GENERAL_SETTINGS Structure

OP_ETH_SETTINGS Structure

SPluto_CustomParams Structure

UART_SETTINGS Structure

RAD_GPTP_SETTINGS Structure

LOGGER_SETTINGS Structure

Remarks

DISK_SETTINGS Structure

Remarks

TIMESYNC_ICSHARDWARE_SETTINGS Structure

Remarks

RAD_REPORTING_SETTINGS Structure

Remarks

STextAPISettings Structure

gPTP Structures

GPTPStatus Structure

timestamp Structure

priority_vector Structure

clock_quality Structure

system_identity Structure

LIN_SETTINGS Structure

Sub Setting Structures Overview - neoVI API

CANFD_SETTINGS Structure

ETHERNET_SETTINGS Structure

ETHERNET_SETTINGS2 Structure

Remarks

ISO9141_KEYWORD2000_SETTINGS Structure

SWCAN_SETTINGS Structure

ISO9141_KEYWORD2000__INIT_STEP Structure

CAN_SETTINGS Structure

RAD_GPTP_SETTINGS Structure

OP_ETH_GENERAL_SETTINGS Structure

SPluto_CustomParams Structure

DISK_SETTINGS Structure

Remarks

TIMESYNC_ICSHARDWARE_SETTINGS Structure

Remarks

OP_ETH_SETTINGS Structure

UART_SETTINGS Structure

STextAPISettings Structure

LOGGER_SETTINGS Structure

Remarks

timestamp Structure

clock_quality Structure

GPTPStatus Structure

system_identity Structure

priority_vector Structure

gPTP Structures

RAD_REPORTING_SETTINGS Structure

Remarks

port_identity Structure