subsys: net: lib: Implement Precision Time Protocol (PTP) Support

MAINTAINERS.yml

@@ -2587,9 +2587,11 @@ Networking:
   files-exclude:
     - doc/connectivity/networking/api/gptp.rst
     - doc/connectivity/networking/api/ieee802154.rst
+    - doc/connectivity/networking/api/ptp.rst
     - doc/connectivity/networking/api/wifi.rst
     - include/zephyr/net/gptp.h
     - include/zephyr/net/ieee802154*.h
+    - include/zephyr/net/ptp.h
     - include/zephyr/net/wifi*.h
     - include/zephyr/net/buf.h
     - include/zephyr/net/dhcpv4*.h
@@ -2605,6 +2607,7 @@ Networking:
     - subsys/net/lib/coap/
     - subsys/net/lib/config/ieee802154*
     - subsys/net/lib/lwm2m/
+    - subsys/net/lib/ptp/
     - subsys/net/lib/tls_credentials/
     - subsys/net/lib/dhcpv4/
     - tests/net/dhcpv4/
@@ -2760,6 +2763,20 @@ Networking:
   tests:
     - net.mqtt_sn
 
+"Networking: PTP":
+  status: maintained
+  maintainers:
+    - awojasinski
+  files:
+    - doc/connectivity/networking/api/ptp.rst
+    - include/zephyr/net/ptp.h
+    - subsys/net/lib/ptp/
+    - samples/net/ptp/
+  labels:
+    - "area: Networking"
+  tests:
+    - sample.net.ptp
+
 "Networking: Native IEEE 802.15.4":
   status: maintained
   maintainers:

boards/st/nucleo_h563zi/nucleo_h563zi.yaml

@@ -17,6 +17,7 @@ supported:
   - adc
   - dac
   - pwm
+  - netif:eth
   - counter
   - spi
   - usb_device

doc/connectivity/networking/api/protocols.rst

@@ -15,4 +15,5 @@ Protocols
    lwm2m
    mqtt
    mqtt_sn
+   ptp
    tftp

doc/connectivity/networking/api/ptp.rst

@@ -0,0 +1,140 @@
+.. _ptp_interface:
+
+Precision Time Protocol (PTP)
+#############################
+
+.. contents::
+    :local:
+    :depth: 2
+
+Overview
+********
+
+PTP is a network protocol implemented in the application layer, used to synchronize
+clocks in a computer network. It's accurate up to less than a microsecond.
+The stack supports the protocol and procedures as defined in the `IEEE 1588-2019 standard`_
+(IEEE Standard for a Precision Clock Synchronization Protocol
+for Networked Measurement and Control Systems). It has multiple profiles,
+and can be implemented on top of L2 (Ethernet) or L3 (UDP/IPv4 or UDP/IPv6).
+Its accuracy is achieved by using hardware timestamping of the protocol packets.
+
+Zephyr's implementation of PTP stack consist following items:
+
+* PTP stack thread that handles incoming messages and events
+* Integration with ptp_clock driver
+* PTP stack initialization executed during system init
+
+The implementation automatically creates PTP Ports (each PTP Port coresponds to unique interface).
+
+Supported features
+******************
+
+Implementation of the stack doesn't support all features specified in the standard.
+In the table below all supported features are listed.
+
+.. csv-table:: Supported features
+   :header: Feature, Supported
+   :widths: 50,10
+
+    Ordinary Clock, yes
+    Boundary Clock, yes
+    Transparent Clock,
+    Management Node,
+    End to end delay mechanism, yes
+    Peer to peer delay mechanism,
+    Multicast operation mode,
+    Hybrid operation mode,
+    Unicast operation mode,
+    Non-volatile storage,
+    UDP IPv4 transport protocol, yes
+    UDP IPv6 transport protocol, yes
+    IEEE 802.3 (Ethernet) transport protocol,
+    Hardware timestamping, yes
+    Software timestamping,
+    TIME_RECEIVER_ONLY PTP Instance, yes
+    TIME_TRANSMITTER_ONLY PTP Instance,
+
+Supported Management messages
+*****************************
+
+Based on Table 59 from section 15.5.2.3 of the IEEE 1588-2019 following management TLVs
+are supported:
+
+.. csv-table:: Supported management message's IDs
+   :header: Management_ID, Management_ID name, Allowed acctions
+   :widths: 10,40,25
+
+    0x0000, NULL_PTP_MANAGEMENT, GET SET COMMAND
+    0x0001, CLOCK_DESCRIPTION, GET
+    0x0002, USER_DESCRIPTION, GET
+    0x0003, SAVE_IN_NON_VOLATILE_STORAGE, -
+    0x0004, RESET_NON_VOLATILE_STORAGE, -
+    0x0005, INITIALIZE, -
+    0x0006, FAULT_LOG, -
+    0x0007, FAULT_LOG_RESET, -
+    0x2000, DEFAULT_DATA_SET, GET
+    0x2001, CURRENT_DATA_SET, GET
+    0x2002, PARENT_DATA_SET, GET
+    0x2003, TIME_PROPERTIES_DATA_SET, GET
+    0x2004, PORT_DATA_SET, GET
+    0x2005, PRIORITY1, GET SET
+    0x2006, PRIORITY2, GET SET
+    0x2007, DOMAIN, GET SET
+    0x2008, TIME_RECEIVER_ONLY, GET SET
+    0x2009, LOG_ANNOUNCE_INTERVAL, GET SET
+    0x200A, ANNOUNCE_RECEIPT_TIMEOUT, GET SET
+    0x200B, LOG_SYNC_INTERVAL, GET SET
+    0x200C, VERSION_NUMBER, GET SET
+    0x200D, ENABLE_PORT, COMMAND
+    0x200E, DISABLE_PORT, COMMAND
+    0x200F, TIME, GET SET
+    0x2010, CLOCK_ACCURACY, GET SET
+    0x2011, UTC_PROPERTIES, GET SET
+    0x2012, TRACEBILITY_PROPERTIES, GET SET
+    0x2013, TIMESCALE_PROPERTIES, GET SET
+    0x2014, UNICAST_NEGOTIATION_ENABLE, -
+    0x2015, PATH_TRACE_LIST, -
+    0x2016, PATH_TRACE_ENABLE, -
+    0x2017, GRANDMASTER_CLUSTER_TABLE, -
+    0x2018, UNICAST_TIME_TRANSMITTER_TABLE, -
+    0x2019, UNICAST_TIME_TRANSMITTER_MAX_TABLE_SIZE, -
+    0x201A, ACCEPTABLE_TIME_TRANSMITTER_TABLE, -
+    0x201B, ACCEPTABLE_TIME_TRANSMITTER_TABLE_ENABLED, -
+    0x201C, ACCEPTABLE_TIME_TRANSMITTER_MAX_TABLE_SIZE, -
+    0x201D, ALTERNATE_TIME_TRANSMITTER, -
+    0x201E, ALTERNATE_TIME_OFFSET_ENABLE, -
+    0x201F, ALTERNATE_TIME_OFFSET_NAME, -
+    0x2020, ALTERNATE_TIME_OFFSET_MAX_KEY, -
+    0x2021, ALTERNATE_TIME_OFFSET_PROPERTIES, -
+    0x3000, EXTERNAL_PORT_CONFIGURATION_ENABLED,
+    0x3001, TIME_TRANSMITTER_ONLY, -
+    0x3002, HOLDOVER_UPGRADE_ENABLE, -
+    0x3003, EXT_PORT_CONFIG_PORT_DATA_SET, -
+    0x4000, TRANSPARENT_CLOCK_DEFAULT_DATA_SET, -
+    0x4001, TRANSPARENT_CLOCK_PORT_DATA_SET, -
+    0x4002, PRIMARY_DOMAIN, -
+    0x6000, DELAY_MECHANISM, GET
+    0x6001, LOG_MIN_PDELAY_REQ_INTERVAL, GET SET
+
+Enabling the stack
+******************
+
+The following configuration option must me enabled in :file:`prj.conf` file.
+
+- :kconfig:option:`CONFIG_PTP`
+
+Testing
+*******
+
+The stack has been informally tested using the
+`Linux ptp4l <http://linuxptp.sourceforge.net/>`_ daemons.
+The :zephyr:code-sample:`PTP sample application <ptp>` from the Zephyr
+source distribution can be used for testing.
+
+.. _IEEE 1588-2019 standard:
+   https://standards.ieee.org/ieee/1588/6825/
+
+API Reference
+*************
+
+.. doxygengroup:: ptp

doc/connectivity/networking/api/tsn.rst

@@ -9,3 +9,4 @@ Time Sensitive Networking
    gptp.rst
    net_time.rst
    ptp_time.rst
+   ptp.rst

drivers/ethernet/Kconfig.native_posix

@@ -15,12 +15,13 @@ if ETH_NATIVE_POSIX
 config ETH_NATIVE_POSIX_INTERFACE_COUNT
 	int "Number of network interfaces created"
 	default NET_GPTP_NUM_PORTS if NET_GPTP
+	default PTP_NUM_PORTS if PTP
 	default 1
 	range 1 32
 	help
 	  By default only one network interface is created. It is possible
 	  to create multiple interfaces in certain use cases. For example if
-	  multiple ports are defined in gPTP, then multiple network interfaces
+	  multiple ports are defined in gPTP or PTP, then multiple network interfaces
 	  must be created here.
 
 config ETH_NATIVE_POSIX_DRV_NAME
@@ -40,9 +41,9 @@ config ETH_NATIVE_POSIX_DEV_NAME
 
 config ETH_NATIVE_POSIX_PTP_CLOCK
 	bool "PTP clock driver support"
-	default y if NET_GPTP
+	default y if NET_GPTP || PTP
 	select PTP_CLOCK
-	depends on NET_GPTP
+	depends on NET_GPTP || PTP
 	help
 	  Enable PTP clock support.
 

drivers/ethernet/eth_stm32_hal.c

@@ -352,7 +352,8 @@ static int eth_tx(const struct device *dev, struct net_pkt *pkt)
 #endif /* CONFIG_ETH_STM32_HAL_API_V2 */
 
 #if defined(CONFIG_PTP_CLOCK_STM32_HAL)
-	timestamped_frame = eth_is_ptp_pkt(net_pkt_iface(pkt), pkt);
+	timestamped_frame = eth_is_ptp_pkt(net_pkt_iface(pkt), pkt) ||
+			    net_pkt_is_tx_timestamping(pkt);
 	if (timestamped_frame) {
 		/* Enable transmit timestamp */
 #if defined(CONFIG_ETH_STM32_HAL_API_V2)
@@ -789,13 +790,10 @@ static struct net_pkt *eth_rx(const struct device *dev)
 	}
 
 #if defined(CONFIG_PTP_CLOCK_STM32_HAL)
-	if (eth_is_ptp_pkt(get_iface(dev_data), pkt)) {
-		pkt->timestamp.second = timestamp.second;
-		pkt->timestamp.nanosecond = timestamp.nanosecond;
-	} else {
-		/* Invalid value */
-		pkt->timestamp.second = UINT64_MAX;
-		pkt->timestamp.nanosecond = UINT32_MAX;
+	pkt->timestamp.second = timestamp.second;
+	pkt->timestamp.nanosecond = timestamp.nanosecond;
+	if (timestamp.second != UINT64_MAX) {
+		net_pkt_set_rx_timestamping(pkt, true);
 	}
 #endif /* CONFIG_PTP_CLOCK_STM32_HAL */
 

include/zephyr/net/net_context.h

@@ -359,6 +359,10 @@ __net_socket struct net_context {
 		 * see RFC 5014 for details.
 		 */
 		uint16_t addr_preferences;
+#endif
+#if defined(CONFIG_NET_CONTEXT_TIMESTAMPING)
+		/** Enable RX, TX or both timestamps of packets send through sockets. */
+		uint8_t timestamping;
 #endif
 	} options;
 
@@ -1285,6 +1289,7 @@ enum net_context_option {
 	NET_OPT_UNICAST_HOP_LIMIT = 15, /**< IPv6 unicast hop limit */
 	NET_OPT_TTL               = 16, /**< IPv4 unicast TTL */
 	NET_OPT_ADDR_PREFERENCES  = 17, /**< IPv6 address preference */
+	NET_OPT_TIMESTAMPING      = 18, /**< Packet timestamping */
 };
 
 /**

include/zephyr/net/net_pkt.h

@@ -197,6 +197,10 @@ struct net_pkt {
 				  */
 #if defined(CONFIG_NET_IP_FRAGMENT)
 	uint8_t ip_reassembled : 1; /* Packet is a reassembled IP packet. */
+#endif
+#if defined(CONFIG_NET_PKT_TIMESTAMP)
+	uint8_t tx_timestamping : 1; /** Timestamp transmitted packet */
+	uint8_t rx_timestamping : 1; /** Timestamp received packet */
 #endif
 	/* bitfield byte alignment boundary */
 
@@ -389,6 +393,38 @@ static inline void net_pkt_set_ptp(struct net_pkt *pkt, bool is_ptp)
 	pkt->ptp_pkt = is_ptp;
 }
 
+static inline bool net_pkt_is_tx_timestamping(struct net_pkt *pkt)
+{
+#if defined(CONFIG_NET_PKT_TIMESTAMP)
+	return !!(pkt->tx_timestamping);
+#else
+	return false;
+#endif
+}
+
+static inline void net_pkt_set_tx_timestamping(struct net_pkt *pkt, bool is_timestamping)
+{
+#if defined(CONFIG_NET_PKT_TIMESTAMP)
+	pkt->tx_timestamping = is_timestamping;
+#endif
+}
+
+static inline bool net_pkt_is_rx_timestamping(struct net_pkt *pkt)
+{
+#if defined(CONFIG_NET_PKT_TIMESTAMP)
+	return !!(pkt->rx_timestamping);
+#else
+	return false;
+#endif
+}
+
+static inline void net_pkt_set_rx_timestamping(struct net_pkt *pkt, bool is_timestamping)
+{
+#if defined(CONFIG_NET_PKT_TIMESTAMP)
+	pkt->rx_timestamping = is_timestamping;
+#endif
+}
+
 static inline bool net_pkt_is_captured(struct net_pkt *pkt)
 {
 	return !!(pkt->captured);

include/zephyr/net/ptp.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024 BayLibre SAS
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file
+ * @brief Public functions for the Precision Time Protocol.
+ *
+ * References are to version 2019 of IEEE 1588, ("PTP")
+ */
+
+#ifndef ZEPHYR_INCLUDE_NET_PTP_H_
+#define ZEPHYR_INCLUDE_NET_PTP_H_
+
+/**
+ * @brief Precision Time Protocol (PTP) support
+ * @defgroup ptp PTP support
+ * @ingroup networking
+ * @{
+ */
+
+#include <zephyr/net/ptp_time.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define PTP_MAJOR_VERSION 2 /**< Major PTP Version */
+#define PTP_MINOR_VERSION 1 /**< Minor PTP Version */
+
+#define PTP_VERSION (PTP_MINOR_VERSION << 4 | PTP_MAJOR_VERSION) /**< PTP version IEEE-1588:2019 */
+
+#ifdef __cplusplus
+}
+#endif
+
+/**
+ * @}
+ */
+
+#endif /* ZEPHYR_INCLUDE_NET_PTP_H_ */

include/zephyr/net/socket.h

@@ -1163,8 +1163,9 @@ struct ifreq {
 /** Socket accepts incoming connections (ignored, for compatibility) */
 #define SO_ACCEPTCONN 30
 
-/** Timestamp TX packets */
+/** Timestamp TX RX or both packets. Supports multiple timestamp sources. */
 #define SO_TIMESTAMPING 37
+
 /** Protocol used with the socket */
 #define SO_PROTOCOL 38
 
@@ -1179,6 +1180,18 @@ struct ifreq {
 /** Socket TX time (same as SO_TXTIME) */
 #define SCM_TXTIME SO_TXTIME
 
+/** Timestamp generation flags */
+
+/** Request RX timestamps generated by network adapter. */
+#define SOF_TIMESTAMPING_RX_HARDWARE BIT(0)
+/**
+ * Request TX timestamps generated by network adapter.
+ * This can be enabled via socket option or control messages.
+ */
+#define SOF_TIMESTAMPING_TX_HARDWARE BIT(1)
+
+/** */
+
 /** @} */
 
 /**