From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1FE4B45B00; Thu, 10 Oct 2024 11:55:35 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1481D4042C; Thu, 10 Oct 2024 11:55:33 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.7]) by mails.dpdk.org (Postfix) with ESMTP id 699414060B for ; Thu, 10 Oct 2024 11:55:31 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1728554131; x=1760090131; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=HUPiS/n9+Zs9Pr0S+nlpcq9nqYOQK4jZspkJ3mlIs2M=; b=n6bH8V64PbblQvZWp15vMH09IGLRLtnnkvpwcwLwghYfzyS5K9mD+vIQ PnMXQSbiyoJuzBjmTrAQuSk4X/cEnOBpAQmuyryoPdbxFa+GD44BIp4QR AqLdMty/YufEHbQS0l8YN5jCSlnJw+J+dLqc5gPtXIVZg0XHLr919sDm8 tQAV4PE74tMJLGoARBg5f99D1/LWmv76BT++ZN0GaJ2cd6Gt+o08NBzne S8LjMTHcRPtRhGjP99iJo+VcP3VQOsV8jtmVF3MV5o+H/7Ay2xp4LPE7+ HEwy+MUTHYnSY3kfthZKb2rtkxiguZWAkcncYj/2oDyFgvaZf7ggufc12 w==; X-CSE-ConnectionGUID: aooFYS38QyWb1d63w2pehA== X-CSE-MsgGUID: bzzwaI9SSNOjij8wtddWiw== X-IronPort-AV: E=McAfee;i="6700,10204,11220"; a="53304886" X-IronPort-AV: E=Sophos;i="6.11,192,1725346800"; d="scan'208";a="53304886" Received: from fmviesa004.fm.intel.com ([10.60.135.144]) by fmvoesa101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Oct 2024 02:55:31 -0700 X-CSE-ConnectionGUID: J8Owga/3R7a9Ph8OLmsKPA== X-CSE-MsgGUID: xY7tn3CXTAOd13a4qktHEg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.11,192,1725346800"; d="scan'208";a="81111612" Received: from unknown (HELO localhost.localdomain) ([10.239.252.253]) by fmviesa004-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Oct 2024 02:55:29 -0700 From: Mingjin Ye To: dev@dpdk.org Cc: Mingjin Ye , Simei Su , Thomas Monjalon , Ferruh Yigit , Andrew Rybchenko Subject: [PATCH v4 1/3] ethdev: add frequency adjustment API Date: Thu, 10 Oct 2024 09:32:19 +0000 Message-Id: <20241010093221.1359778-2-mingjinx.ye@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20241010093221.1359778-1-mingjinx.ye@intel.com> References: <20240930084216.1174034-1-mingjinx.ye@intel.com> <20241010093221.1359778-1-mingjinx.ye@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org This patch adds freq adjustment API for PTP high accuracy. Signed-off-by: Simei Su Signed-off-by: Mingjin Ye --- v2: rte_eth_timesync_adjust_freq marked as experimental --- v3: Add more description for API. --- doc/guides/nics/features.rst | 4 ++- doc/guides/rel_notes/release_24_11.rst | 4 +++ lib/ethdev/ethdev_driver.h | 5 +++ lib/ethdev/ethdev_trace.h | 9 ++++++ lib/ethdev/ethdev_trace_points.c | 3 ++ lib/ethdev/rte_ethdev.c | 18 +++++++++++ lib/ethdev/rte_ethdev.h | 43 ++++++++++++++++++++++++++ lib/ethdev/version.map | 3 ++ 8 files changed, 88 insertions(+), 1 deletion(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index cd0115ffb3..0508f118fe 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -677,10 +677,12 @@ Supports IEEE1588/802.1AS timestamping. * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable`` ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``, - ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``. + ``timesync_adjust_time``, ``timesync_adjust_freq``, + ``timesync_read_time``, ``timesync_write_time``. * **[related] API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``, ``rte_eth_timesync_read_rx_timestamp()``, ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``, + ``rte_eth_timesync_adjust_freq()``, ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``. diff --git a/doc/guides/rel_notes/release_24_11.rst b/doc/guides/rel_notes/release_24_11.rst index 2f78f2d125..1569f2df23 100644 --- a/doc/guides/rel_notes/release_24_11.rst +++ b/doc/guides/rel_notes/release_24_11.rst @@ -82,6 +82,10 @@ New Features The new statistics are useful for debugging and profiling. +* **Added Ethernet device clock frequency adjustment.** + + Added new function ``rte_eth_timesync_adjust_freq`` to adjust the clock + frequency for Ethernet devices. Removed Items ------------- diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index ae00ead865..ec1a9d1cc7 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -664,6 +664,9 @@ typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev, /** @internal Function used to adjust the device clock. */ typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t); +/** @internal Function used to adjust the clock frequency. */ +typedef int (*eth_timesync_adjust_freq)(struct rte_eth_dev *dev, int64_t); + /** @internal Function used to get time from the device clock. */ typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev, struct timespec *timestamp); @@ -1378,6 +1381,8 @@ struct eth_dev_ops { eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp; /** Adjust the device clock */ eth_timesync_adjust_time timesync_adjust_time; + /** Adjust the clock frequency */ + eth_timesync_adjust_freq timesync_adjust_freq; /** Get the device clock time */ eth_timesync_read_time timesync_read_time; /** Set the device clock time */ diff --git a/lib/ethdev/ethdev_trace.h b/lib/ethdev/ethdev_trace.h index 36a38f718a..598e9f4d35 100644 --- a/lib/ethdev/ethdev_trace.h +++ b/lib/ethdev/ethdev_trace.h @@ -2183,6 +2183,15 @@ RTE_TRACE_POINT_FP( rte_trace_point_emit_int(ret); ) +/* Called in loop in examples/ptpclient */ +RTE_TRACE_POINT_FP( + rte_eth_trace_timesync_adjust_freq, + RTE_TRACE_POINT_ARGS(uint16_t port_id, int64_t ppm, int ret), + rte_trace_point_emit_u16(port_id); + rte_trace_point_emit_i64(ppm); + rte_trace_point_emit_int(ret); +) + /* Called in loop in app/test-flow-perf */ RTE_TRACE_POINT_FP( rte_flow_trace_create, diff --git a/lib/ethdev/ethdev_trace_points.c b/lib/ethdev/ethdev_trace_points.c index 99e04f5893..a99fec0c1e 100644 --- a/lib/ethdev/ethdev_trace_points.c +++ b/lib/ethdev/ethdev_trace_points.c @@ -409,6 +409,9 @@ RTE_TRACE_POINT_REGISTER(rte_eth_trace_timesync_read_tx_timestamp, RTE_TRACE_POINT_REGISTER(rte_eth_trace_timesync_adjust_time, lib.ethdev.timesync_adjust_time) +RTE_TRACE_POINT_REGISTER(rte_eth_trace_timesync_adjust_freq, + lib.ethdev.timesync_adjust_freq) + RTE_TRACE_POINT_REGISTER(rte_eth_trace_timesync_read_time, lib.ethdev.timesync_read_time) diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c index f1c658f49e..660eab2f1e 100644 --- a/lib/ethdev/rte_ethdev.c +++ b/lib/ethdev/rte_ethdev.c @@ -6310,6 +6310,24 @@ rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta) return ret; } +int +rte_eth_timesync_adjust_freq(uint16_t port_id, int64_t ppm) +{ + struct rte_eth_dev *dev; + int ret; + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + dev = &rte_eth_devices[port_id]; + + if (*dev->dev_ops->timesync_adjust_freq == NULL) + return -ENOTSUP; + ret = eth_err(port_id, (*dev->dev_ops->timesync_adjust_freq)(dev, ppm)); + + rte_eth_trace_timesync_adjust_freq(port_id, ppm, ret); + + return ret; +} + int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *timestamp) { diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index a75e26bf07..c8a9993ad6 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -5293,6 +5293,49 @@ int rte_eth_timesync_read_tx_timestamp(uint16_t port_id, */ int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta); +/** + * Adjust the clock frequency on an Ethernet device. + * + * Adjusts the base frequency by a specified percentage of ppm (parts per + * million). This is usually used in conjunction with other Ethdev timesync + * functions to synchronize the device time using the IEEE1588/802.1AS + * protocol. + * + * The clock is subject to frequency deviation and rate of change drift due to + * the environment. The upper layer APP calculates the frequency compensation + * value of the slave clock relative to the master clock via a servo algorithm + * and adjusts the device clock frequency via "rte_eth_timesync_adjust_freq()". + * Commonly used servo algorithms are pi/linreg/ntpshm, for implementation + * see: https://github.com/nxp-archive/openil_linuxptp.git. + * + * The adjustment value obtained by the servo algorithm is usually in + * ppb (parts per billion). For consistency with the kernel driver .adjfine, + * the tuning values are in ppm. Note that 1 ppb is approximately 65.536 scaled + * ppm, see Linux kernel upstream commit 1060707e3809 (‘ptp: introduce helpers + * to adjust by scaled parts per million’). + * + * In addition, the device reference frequency is usually also the stepping + * threshold for the servo algorithm, and the frequency up and down adjustment + * range is limited by the device. The device clock frequency should be + * adjusted with "rte_eth_timesync_adjust_freq()" every time the clock is + * synchronised. Also use ‘rte_eth_timesync_adjust_time()’ to update the device + * clock only if the absolute value of the master/slave clock offset is greater than + * or equal to the step threshold. + * + * @param port_id + * The port identifier of the Ethernet device. + * @param ppm + * Parts per million with 16-bit fractional field + * + * @return + * - 0: Success. + * - -ENODEV: The port ID is invalid. + * - -EIO: if device is removed. + * - -ENOTSUP: The function is not supported by the Ethernet driver. + */ +__rte_experimental +int rte_eth_timesync_adjust_freq(uint16_t port_id, int64_t ppm); + /** * Read the time from the timesync clock on an Ethernet device. * diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map index 1669055ca5..199480ef07 100644 --- a/lib/ethdev/version.map +++ b/lib/ethdev/version.map @@ -325,6 +325,9 @@ EXPERIMENTAL { rte_flow_template_table_resizable; rte_flow_template_table_resize; rte_flow_template_table_resize_complete; + + # added in 24.11 + rte_eth_timesync_adjust_freq; }; INTERNAL { -- 2.25.1