7. Advanced Features

7.1. MACsec

MACsec (802.1AE) is a Layer 2 protocol that can ensure data integrity and authenticity, as well as data encryption. The OPEN Alliance TC17 has drafted the MACsec Automotive Profile to adapt the broad standards of 802.1AE to automotive applications.

The use and operation of MACsec is well beyond the scope of this guide, but many Intrepid products contain Automotive Ethernet PHYs with MACsec support. This guide explains the different way of loading MACsec configurations and keys into the Automotive Ethernet PHY.

7.1.1. Intrepid Devices Supporting MACsec

The MACsec configuration of a PHY is contained in a yaml file that is sent to the PHY Using Vehicle Spy or one of Intrepid’s API. (Examples follow) The following table contains the information needed to address the PHY using the API.

Product	Serial #	Port	netid	config_netid
RAD-Moon2_zl	RNxxxx	100/1000BASE-T1	NETID_OP_ETHERNET1	NETID_MDIO_01
RAD-Moon3	R3xxxx	100/1000BASE-T1	NETID_OP_ETHERNET1	NETID_MDIO_01
RAD-Comet2	RCxxxx	AE01	NETID_OP_ETHERNET1	NETID_MDIO_02
RAD-Gigastar w/ SFP	GSxxxx	SFP1	NETID_ETHERNET	NETID_I2C1
RAD-Gigastar w/ SFP	GSxxxx	SFP2	NETID_ETHERNET2	NETID_I2C2
RAD-Galaxy2		AE01
		AE02
		AE03
		AE04
		AE05
		AE06
		AE07
		AE08
		AE09
		AE10
		AE11
		AE12
		AE13
		AE14
		AE15
		AE16

7.1.2. Configuring MACsec in Vehicle Spy 3 

In Development

7.1.3. Configuring MACsec using Intrepid’s Open Source API 

libicsneo is the Intrepid Control Systems device communication library.

Installation and usage documentation can be found within each of the respective APIs.

MACsec C++ API 

Coming Soon!

MACsec Python API 

Coming Soon!

MACsec C API 

Coming Soon!

7.1.4. Configuring MACsec in using python_ics

python_ics MACsec examples

Python Installation

pip install python_ics pyyaml

Usage

ics_load_macsec.py [-h] [--yaml YAML] --port PORT [--reset] serial_number

serial_number

The serial number of the device to configure.

options

Option	Descrition	Default Value
-h, –help	show this help message and exit
–yaml YAML	filename of yaml configuration to be loaded (Assumes .yml is located in “/yaml/” directory)	test_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml
–port PORT	‘config_netid’ - network ID for the port configuration network.	config_netid = NETID_I2C2
	‘netid’ - network ID for the port network.	netid = NETID_OP_ETHERNET1
–reset	Reset and clear and disable MACsec on the device, then exit; yaml configuration ignored	FALSE

Example Command Lines

RAD-Comet2/3:

python ics_load_macsec.py Rxxxxx --port "{'netid':NETID_OP_ETHERNET1,'config_netid':NETID_MDIO_02}" --yaml "test_sfp_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml"

RAD-Moon2_zl:

python ics_load_macsec.py RNxxxx --port "{'netid':NETID_OP_ETHERNET1,'config_netid':NETID_MDIO_01}" --yaml "test_sfp_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml"

RAD-Moon3:

python ics_load_macsec.py R3xxxx --port "{'netid':NETID_OP_ETHERNET1,'config_netid':NETID_MDIO_01}" --yaml "test_sfp_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml"

RAD-Gigastar Port1 with SFP-MV2221M:

python ics_load_macsec.py GSxxxx --port "{'netid':NETID_ETHERNET,'config_netid':NETID_I2C2}" --yaml "test_sfp_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml"

RAD-Gigastar Port2 with SFP-MV2221M:

python ics_load_macsec.py GSxxxx --port "{'netid':NETID_ETHERNET2,'config_netid':NETID_I2C3}" --yaml "test_sfp_macsec_Rule_wildcard_SecY_128_strip_strict_sci_SA_sak0.yml"

7.2. Device Register Access

Ethernet PHYs and switches contain many status and configuration registers. The method in which these registers are accessed depend on both the device and decisions made during the electrical design of the product. Intrepid products access PHY and Switch registers either using MDIO or SPI interfaces. The table below lists the Ethernet devices contained in your product along with the management interface information needed to access a device’s registers using Vehicle Spy or Intrepid’s Open Source API.

7.2.1. Ethernet Device Register Interfaces

The register interfaces for Ethernet ports of RAD-Comet3 are as follows.

Device	Port	Management Interface	PHY Address	Protocol
RAD-Comet3	Ethernet (100/1000BASE-T)	MDIO_01	0x01	Clause 22
	AE 01 (100/1000BASE-T1)	MDIO_02	0x01	Clause 45
	AE 02	SPI1	–	SPI
	AE 03	SPI2
	AE 04	SPI3
	AE 05	SPI4
	AE 06	SPI5
	AE 07	SPI6

7.2.2. MDIO Protocol

This section provides an introduction and overview of the MDIO protocol.

Already familiar with MDIO?

If this information is not needed, skip to the following sections for instruction on how to use this protocol with Vehicle Spy or Intrepid’s Open Source API.

Each MDIO frame is 32 bits:

2 start bits
2 bit operation code
5 bit phy address
5 bit register address
2 bit turn around delay
16 bits of data.

As Ethernet devices has evolved over the years, so has the protocol used to communicate with them. Devices in Intrepid products use either Clause 22 or Clause 45, which will be explained in the following sections.

Clause 22

The initial protocol, IEEE 802.3 Clause 22, was designed to read or write 32 registers within 32 devices. Each read/write is done in one operation.

Phy Address 5 bits (0 – 31 decimal)
Register address 5 bits (0 – 31 decimal) or (0 – 1F hex)
Data 16 bits

Page Register

Some Ethernet Phy manufacturers added a page register to allow for more registers in Clause 22. The page can be 0 – 255 decimal. If the Phy does not support pages, then page will be ignored. When using pages, reads and writes can no longer be performed in one operation. Instead you must write to the page register and then before any other process changes the page, you can read or write the destination register. If another process were to change the page register before you finish, the result will be an read the wrong register or an write to wrong register which may cause the Phy to stop working.

Common Clause 22 Registers

Clasuse 22 Registers	Bits	Function/Status
Control Register (Register 0)	15	reset
	14	loopback
	12	auto negotiate
	11	power down
	10	isolate
	9	renegotiate
	8	duplex
	7	collision test
	6/13	speed	10=1000mbps
			01=100mbps
			00=10mbps
Status Register (Register 1)	5	Auto Negotiation Complete
	4	Remote Fault
	3	Auto Negotiation Capability
	2	Link Status
	1	Jabber Detect
	0	Extended Capability
Phy ID Reg 1 (Register 2)	15:0	OUI MSB
PHY ID Reg 2 (Register 1)	15:10	OUI LSB
	9:4	Model Number
	3:0	Revision Number

Clause 45

As Ethernet Phys became more complicated and supported different speeds and connections, IEEE 802.3 Clause 45 was added. Because the Register Address is now 16 bits, each read/write takes at 2 operations. The first operation is always writing the Register Address that you want to use in the next operation. The second is the actual read or write. There is also a special read that increments the address after each read which allows you to write a starting address and then read a whole block of registers.

Port 5 bits (this is equivalent to the Phy Address)
Device 5 bits (this is similar to the page)
Register address 16 bits (this allows 65536 registers in each device)
Data 16 bits

Common Clause 45 Registers

PMA/PMD Registers

	Device	Register	Bits	Function/Status
Control Register	1	0	15	reset
			11	power down
			6/13	speed (10-1000mbps)	11=Speed set by bits 5:2
					10=1000mbps
					01=100mbps
					00=10mbps
			5:2	speed (2.5-10 Gbps)	0111=5 Gbps
					0110=2.5 Gbps
					0000=10 Gbps
Device ID Reg 1	1	2	15:0	Auto Negotiation Complete
Device ID Reg 2	1	3	15:10	OUI LSB
			9:4	Model Number
			3:0	Revision Number

PCS Registers

	Device	Register	Bits	Function/Status
Control Register	3	0	15	reset
			14	loopback
			11	power down
			6/13	speed	10=1000mbps
					01=100mbps
					00=10mbps
Device ID Reg 1	3	2	15:0	Auto Negotiation Complete
Device ID Reg 2	3	3	15:10	OUI LSB
			9:4	Model Number
			3:0	Revision Number

7.2.3. Using MDIO with Intrepid Devices

MDIO access to Registers in Intrepid devices can be accomplishes using:

Vehicle Spy 3 Software
libicsneo , the Intrepid Control Systems cross-platform device communication library. Installation and usage documentation for libicsneo can be found within each of the respective APIs.

The following sections provide examples for each method of MDIO register access.

Vehicle Spy 3 Software MDIO Example

Coming Soon!

C++ MDIO Example:

The following code block is an example of writing and reading to a register using the C++ API.

// We can transmit messages to write to arbitrary register
std::cout << "\tTransmitting a MDIO request to write register on 88Q2112...\n";
mdio_r = std::make_shared<icsneo::MDIOMessage>();
mdio_r->network = icsneo::Network::NetID::MDIO1;
mdio_r->phyAddress = 0x06u;
mdio_r->devAddress = 0x01u;
mdio_r->regAddress = 0x0902u;
mdio_r->data = {0xA3, 0x02};
mdio_r->direction = icsneo::MDIOMessage::Direction::Write;
mdio_r->clause = icsneo::MDIOMessage::Clause::Clause45;
ret = device->transmit(mdio_r); // This will return false if the device does not support MDIO
std::cout << (ret ? "OK" : "FAIL") << std::endl;

// We can transmit messages to read back to arbitrary register
std::cout << "\tTransmitting a MDIO request to read register on 88Q2112...\n";
mdio_r = std::make_shared<icsneo::MDIOMessage>();
mdio_r->network = icsneo::Network::NetID::MDIO1;
mdio_r->phyAddress = 0x06u;
mdio_r->devAddress = 0x01u;
mdio_r->regAddress = 0x0902u;
mdio_r->direction = icsneo::MDIOMessage::Direction::Read;
mdio_r->clause = icsneo::MDIOMessage::Clause::Clause45;
ret = device->transmit(mdio_r); // This will return false if the device does not support MDIO
std::cout << (ret ? "OK" : "FAIL") << std::endl;

An complete example of how to use MDIO through the C++ API can be found here: MDIO C++ Example

Python MDIO Example:

The following code block is an example of writing and reading to a register using the Python API.

import icsneopy

a = icsneopy.MDIOMessage()
a.network = icsneopy.Network(icsneopy.Network.NetID.MDIO1)
a.phyAddress = 0x00
a.regAddress = 0x02
a.direction = icsneopy.MDIOMessage.Direction.Read
a.clause = icsneopy.MDIOMessage.Clause.Clause22
dev.transmit(a)

b = icsneopy.MDIOMessage()
b.network = icsneopy.Network(icsneopy.Network.NetID.MDIO1)
b.phyAddress = 0x00
b.regAddress = 0x18
b.direction = icsneopy.MDIOMessage.Direction.Write
b.clause = icsneopy.MDIOMessage.Clause.Clause22
dev.transmit(b)

C MDIO Example

Coming Soon!

7.2.4. Using SPI with Intrepid Products

SPI access to Registers in Intrepid devices can be accomplishes using:

Vehicle Spy 3 Software
libicsneo , the Intrepid Control Systems cross-platform device communication library. Installation and usage documentation for libicsneo can be found within each of the respective APIs.

The following sections provide examples for each method of SPI register access.

Vehicle Spy 3 Software SPI Example

Coming Soon!

C++ SPI Example:

The following code block is an example of writing and reading to a register using the C++ API.

// Coming Soon!!

An complete example of how to use MDIO through the C++ API can be found here: MDIO C++ Example

Python SPI Example:

The following code block is an example of writing and reading to a register using the Python API.

# Coming Soon!!

C SPI Example

// Coming Soon!!

7.2.5. Vehicle Spy’s PHY Dashboard

PHY Dashboard is a feature of Vehicle Spy 3 allowing simple device register reads and writes using MDIO.

Opening the PHY Dashboard

The PHY Dashboard can be opened from the Embedded Tools menu in Vehicle Spy (shown below)

PHY Dashboard Interface

Add – use this button to add MDIO operations. Ctrl-S saves screen contents to VS3 file.
Delete – deletes the currently selected item or item.
Delete All – deletes all operations
Read One Time – performs all reads from the list once. No writes are performed.
Write One Time – performs all writes from the list once. No reads are performed.
All One Time – performs every item in the list once.
Send Selected – performs only the selected item or items once.
Start Monitor – performs all reads once per second.
Stops Monitor – stops the monitor operation.

Note: all values in Hex except Phy Address/Port

PHY Dashboard Examples

Clause 22 Example:

Line 1 writes soft reset to phy address 16, using Clause 22
Line 2 reads Phy ID Reg1 from phy address 16 using Clause 22
Line 3 reads Phy ID Reg2 from phy address 16 using Clause 22

Clause 45 Example:

Line 1 writes soft reset of PCS to Port 16, Device 3 using Clause 45
Line 2 reads PCS ID Reg1 from Port 16, Device 3 using Clause 45
Line 3 reads PCS ID Reg2 from Port 16, Device 3 using Clause 45

MDIO Addresses for your hardware

Reference this MDIO address table for the addresses specific to your hardware.

7.3. TC10 - Automotive Ethernet Sleep/Wake-up

A requirement of every modern vehicle is for its subsystems to enter a power saving mode to minimize power when not in use, as well as the ability to quickly resume operation on demand.

TC10 optimizes vehicle architectures using Automotive Ethernet by eliminating the need for dedicated wake-up signals or power mode management using CAN (or possibly other networks). It is a realized by features built into the PHY and requires no involvement of higher layers (MAC and software stacks).

TC10 should not be confused with Energy Efficient Ethernet

EEE is a mode of lower current consumption when link is idle, or communication is asymmetric.
EEE has no concept of sleep/wake, only mode changes based on link activity.
EEE is not only incapable of a system level power mode strategy, but aspects of it can also be problematic to automotive use cases.

The following table lists the Intrepid products having ports with TC10 functionality.

Device	Ports Supporting TC10
SFP-MV88Q2221M	xBASE-T1
SFP-MV3244	xBASE-T1
RAD-Moon2	100/1000BASE-T1 (Serial Numbers RN6127 and higher)
RAD-Moon3	MultiGBASE-T1
RAD-Moon T1S	AE01 (10BASE-T1S)
RAD-Comet2	AE01 (100/1000BASE-T1)
RAD-Comet3	AE01 (100/1000BASE-T1)
RAD-Comet3	AE02-AE07 (10BASE-T1S)
RAD-Galaxy2	AE01 - AE16 (100/1000BASE-T1)

TC10 only applies to Automotive Ethernet

TC10 does not apply to any non-automotive Ethernet physical layers. (such as 100/1000BASE-T)

The commands for sleep and wake-up exchanged between PHYs are buried in previously unused bits of the OAM frame (Operations Administration and Maintenance). These OAM “symbols” are not directly accessible by upper layers. The power moding application of a device must use low-level PHY register reads and writes to invoke commands or determine the power mode state of the PHY.

The TC10 features of Intrepid products can be accessed by any of the following methods.

7.3.1. TC10 in Vehicle Spy 3 

Older versions of VSPY do not support the TC10 interface

This TC10 interface in Vehicle Spy 3 was introduced in the stable release of 3.9.19.x (not a beta release) and will not be seen in earlier versions. If you have recently updated, please ensure your firmware has been updated to match the version of Vehicle Spy used.

TC10 properties of a network

In Vehicle Spy, TC10 status and commands are accessed using “properties” of an Automotive Ethernet port of an Intrepid device.

TC10 Status

The following properties of an Automotive Ethernet port that can be read for TC10 status

Ethernet TC10 Available: True if a PHY supports TC10
Ethernet TC10 Wake Status: True if TC10 Wakeup request was received
Ethernet TC10 Sleep Status: True if TC10 Sleep completed

TC10 Commands

TC10 commands are sent by writing 0x01 to the following properties

Ethernet TC10 Send Wake: Sends a TC10 Wake Request
Ethernet TC10 Send Sleep: Sends a TC10 Sleep Request

Now that the concept of TC10 properties of a network are understood, the following sections will explain how to use them in Function Block scripting and Graphical Panels.

Displaying TC10 Status in a Graphical Panel 

Graphical Panels are constructed using controls that can either display data or trigger events, such as the transmission of a TC10 command. Reference the Graphical Panels documentation of Vehicle Spy for a full tutorial on building Graphical Panels.

After selecting a control to represent the TC10 status on a Graphical Panel, such as an LED , the value of a TC10 property can be bound to it using the Expression Builder

After selecting the control, and opening the Expression Builder , the following steps will bind the value of one of the TC10 properties to that control.

Select the Networks in the left pane.

Select one of the Automotive Ethernet networks as the source of the status. (In this case AE 01 is chosen)

In the properties pane, scroll down to the TC10 commands shown in the diagram above.

Adding this property to the expression will bind its value to the control.

Sending TC10 Commands from a Function Blocks 

Function Blocks are scripts created in Vehicle Spy. The TC10 status of an Ethernet port can be referenced using the same interface as used for Graphical Panels and it can be used in the logical statements of a script. The TC10 sleep and wake requests can also be sent by using Function Blocks using the Set Value Command as shown below.

More info on the Function Blocks and their editor can be found in this section of the Vehicle Spy documentation.

The Set Value Command uses the same Expression Builder interface to write a value to a property.

From this screen follow steps similar to the last example.

Select the Networks in the left pane.

Select an Automotive Ethernet networks to send the TC10 command. (In this case AE 01 is chosen)

In the properties pane, scroll down to the TC10 commands shown in the diagram above.

Select this Send Wake or Send Sleep property as the value to set, and set the expression to 1.

7.3.2. Using TC10 with Intrepid’s Open Source APIs 

libicsneo is the Intrepid Control Systems device communication library.

Installation and usage documentation can be found within each of the respective APIs.

TC10 C++ API 

Download this C++ TC10 Example to see the use of the following C++ functions.

TC10 Python API 

Following are the equivalent TC10 functions for Python.

TC10 C API 

Coming Soon!

TC10 is not supported in Intrepid legacy APIs

There is no support for TC10 in the neoVI API (icsneo40) or python_ics. Please consider using libicsneo or Vehicle Spy 3.

If you are having trouble working with TC10 using any of the interfaces above, please contact our Customer Support

7. Advanced Features

7.1. MACsec

7.1.1. Intrepid Devices Supporting MACsec

7.1.2. Configuring MACsec in Vehicle Spy 3

7.1.3. Configuring MACsec using Intrepid’s Open Source API

MACsec C++ API

MACsec Python API

MACsec C API

7.1.4. Configuring MACsec in using python_ics

Python Installation

Usage

serial_number

options

Example Command Lines

RAD-Comet2/3:

RAD-Moon2_zl:

RAD-Moon3:

RAD-Gigastar Port1 with SFP-MV2221M:

RAD-Gigastar Port2 with SFP-MV2221M:

7.2. Device Register Access

7.2.1. Ethernet Device Register Interfaces

7.2.2. MDIO Protocol

Clause 22

Common Clause 22 Registers

Clause 45

Common Clause 45 Registers

PMA/PMD Registers

PCS Registers

7.2.3. Using MDIO with Intrepid Devices

Vehicle Spy 3 Software MDIO Example

C++ MDIO Example:

Python MDIO Example:

C MDIO Example

7.2.4. Using SPI with Intrepid Products

Vehicle Spy 3 Software SPI Example

C++ SPI Example:

Python SPI Example:

C SPI Example

7.2.5. Vehicle Spy’s PHY Dashboard

Opening the PHY Dashboard

PHY Dashboard Interface

PHY Dashboard Examples

Clause 22 Example:

Clause 45 Example:

7.3. TC10 - Automotive Ethernet Sleep/Wake-up

7.3.1. TC10 in Vehicle Spy 3

TC10 properties of a network

TC10 Status

TC10 Commands

Displaying TC10 Status in a Graphical Panel

Sending TC10 Commands from a Function Blocks

7.3.2. Using TC10 with Intrepid’s Open Source APIs

TC10 C++ API

TC10 Python API

TC10 C API

7.1.2. Configuring MACsec in Vehicle Spy 3 

7.1.3. Configuring MACsec using Intrepid’s Open Source API 

MACsec C++ API 

MACsec Python API 

MACsec C API 

7.3.1. TC10 in Vehicle Spy 3 

Displaying TC10 Status in a Graphical Panel 

Sending TC10 Commands from a Function Blocks 

7.3.2. Using TC10 with Intrepid’s Open Source APIs 

TC10 C++ API 

TC10 Python API 

TC10 C API 