> -----Original Message-----
> From: Mateusz Polchlopek <[email protected]>
> Sent: Tuesday, March 26, 2024 5:21 PM
> To: [email protected]
> Cc: [email protected]; Jacob Keller <[email protected]>;
> Wojciech Drewek <[email protected]>; Ahmed Zaki
> <[email protected]>; Mateusz Polchlopek
> <[email protected]>
> Subject: [Intel-wired-lan] [PATCH iwl-next v1 06/12] iavf: add
> initial framework for registering PTP clock
>
> From: Jacob Keller <[email protected]>
>
> Add the iavf_ptp.c file and fill it in with a skeleton framework to allow
> registering the PTP clock device.
> Add implementation of helper functions to check if a PTP capability is
> supported and handle change in PTP capabilities.
> Enabling virtual clock would be possible, though it would probably perform
> poorly due to the lack of direct time access.
>
> Reviewed-by: Wojciech Drewek <[email protected]>
> Signed-off-by: Jacob Keller <[email protected]>
> Co-developed-by: Ahmed Zaki <[email protected]>
> Signed-off-by: Ahmed Zaki <[email protected]>
> Co-developed-by: Mateusz Polchlopek <[email protected]>
> Signed-off-by: Mateusz Polchlopek <[email protected]>
> ---
> drivers/net/ethernet/intel/iavf/Makefile | 3 +-
> drivers/net/ethernet/intel/iavf/iavf_main.c | 6 +
> drivers/net/ethernet/intel/iavf/iavf_ptp.c | 123 ++++++++++++++++++
> drivers/net/ethernet/intel/iavf/iavf_ptp.h | 10 ++
> .../net/ethernet/intel/iavf/iavf_virtchnl.c | 2 +
> 5 files changed, 143 insertions(+), 1 deletion(-) create mode 100644
> drivers/net/ethernet/intel/iavf/iavf_ptp.c
>
> diff --git a/drivers/net/ethernet/intel/iavf/Makefile
> b/drivers/net/ethernet/intel/iavf/Makefile
> index 2d154a4e2fd7..06a5d2752246 100644
> --- a/drivers/net/ethernet/intel/iavf/Makefile
> +++ b/drivers/net/ethernet/intel/iavf/Makefile
> @@ -13,4 +13,5 @@ obj-$(CONFIG_IAVF) += iavf.o
>
> iavf-objs := iavf_main.o iavf_ethtool.o iavf_virtchnl.o iavf_fdir.o \
> iavf_adv_rss.o \
> - iavf_txrx.o iavf_common.o iavf_adminq.o
> + iavf_txrx.o iavf_common.o iavf_adminq.o \
> + iavf_ptp.o
> diff --git a/drivers/net/ethernet/intel/iavf/iavf_main.c
> b/drivers/net/ethernet/intel/iavf/iavf_main.c
> index ea2034d7914a..6feabb1c62d1 100644
> --- a/drivers/net/ethernet/intel/iavf/iavf_main.c
> +++ b/drivers/net/ethernet/intel/iavf/iavf_main.c
> @@ -2875,6 +2875,9 @@ static void iavf_init_config_adapter(struct
> iavf_adapter *adapter)
> /* request initial VLAN offload settings */
> iavf_set_vlan_offload_features(adapter, 0, netdev->features);
>
> + /* Setup initial PTP configuration */
> + iavf_ptp_init(adapter);
> +
> iavf_schedule_finish_config(adapter);
> return;
>
> @@ -5331,6 +5334,9 @@ static void iavf_remove(struct pci_dev *pdev)
> }
>
> iavf_misc_irq_disable(adapter);
> +
> + iavf_ptp_release(adapter);
> +
> /* Shut down all the garbage mashers on the detention level */
> cancel_work_sync(&adapter->reset_task);
> cancel_delayed_work_sync(&adapter->watchdog_task);
> diff --git a/drivers/net/ethernet/intel/iavf/iavf_ptp.c
> b/drivers/net/ethernet/intel/iavf/iavf_ptp.c
> new file mode 100644
> index 000000000000..0f09d918d269
> --- /dev/null
> +++ b/drivers/net/ethernet/intel/iavf/iavf_ptp.c
> @@ -0,0 +1,123 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/* Copyright(c) 2024 Intel Corporation. */
> +
> +#include "iavf.h"
> +
> +/**
> + * iavf_ptp_cap_supported - Check if a PTP capability is supported
> + * @adapter: private adapter structure
> + * @cap: the capability bitmask to check
> + *
> + * Return true if every capability set in cap is also set in the
> +enabled
> + * capabilities reported by the PF.
> + */
> +bool iavf_ptp_cap_supported(struct iavf_adapter *adapter, u32 cap) {
> + if (!PTP_ALLOWED(adapter))
> + return false;
> +
> + /* Only return true if every bit in cap is set in hw_caps.caps */
> + return (adapter->ptp.hw_caps.caps & cap) == cap; }
> +
> +/**
> + * iavf_ptp_register_clock - Register a new PTP for userspace
> + * @adapter: private adapter structure
> + *
> + * Allocate and register a new PTP clock device if necessary.
> + */
> +static int iavf_ptp_register_clock(struct iavf_adapter *adapter) {
> + struct ptp_clock_info *ptp_info = &adapter->ptp.info;
> + struct device *dev = &adapter->pdev->dev;
> +
> + memset(ptp_info, 0, sizeof(*ptp_info));
> +
> + snprintf(ptp_info->name, sizeof(ptp_info->name) - 1, "%s-%s-clk",
> + dev_driver_string(dev),
> + dev_name(dev));
> + ptp_info->owner = THIS_MODULE;
> +
> + adapter->ptp.clock = ptp_clock_register(ptp_info, dev);
> + if (IS_ERR(adapter->ptp.clock))
> + return PTR_ERR(adapter->ptp.clock);
> +
> + dev_info(&adapter->pdev->dev, "PTP clock %s registered\n",
> + adapter->ptp.info.name);
> + return 0;
> +}
> +
> +/**
> + * iavf_ptp_init - Initialize PTP support if capability was negotiated
> + * @adapter: private adapter structure
> + *
> + * Initialize PTP functionality, based on the capabilities that the PF
> +has
> + * enabled for this VF.
> + */
> +void iavf_ptp_init(struct iavf_adapter *adapter) {
> + struct device *dev = &adapter->pdev->dev;
> + int err;
> +
> + if (WARN_ON(adapter->ptp.initialized)) {
> + dev_err(dev, "PTP functionality was already initialized!\n");
> + return;
> + }
> +
> + if (!iavf_ptp_cap_supported(adapter,
> VIRTCHNL_1588_PTP_CAP_READ_PHC)) {
> + dev_dbg(dev, "Device does not have PTP clock support\n");
> + return;
> + }
> +
> + err = iavf_ptp_register_clock(adapter);
> + if (err) {
> + dev_warn(dev, "Failed to register PTP clock device (%d)\n",
> + err);
> + return;
> + }
> +
> + adapter->ptp.initialized = true;
> +}
> +
> +/**
> + * iavf_ptp_release - Disable PTP support
> + * @adapter: private adapter structure
> + *
> + * Release all PTP resources that were previously initialized.
> + */
> +void iavf_ptp_release(struct iavf_adapter *adapter) {
> + if (!IS_ERR_OR_NULL(adapter->ptp.clock)) {
> + dev_info(&adapter->pdev->dev, "removing PTP clock %s\n",
> + adapter->ptp.info.name);
> + ptp_clock_unregister(adapter->ptp.clock);
> + adapter->ptp.clock = NULL;
> + }
> +
> + adapter->ptp.initialized = false;
> +}
> +
> +/**
> + * iavf_ptp_process_caps - Handle change in PTP capabilities
> + * @adapter: private adapter structure
> + *
> + * Handle any state changes necessary due to change in PTP
> +capabilities, such
> + * as after a device reset or change in configuration from the PF.
> + */
> +void iavf_ptp_process_caps(struct iavf_adapter *adapter) {
> + struct device *dev = &adapter->pdev->dev;
> +
> + dev_dbg(dev, "PTP capabilities changed at runtime\n");
> +
> + /* Check if the device gained or lost necessary access to support the
> + * PTP hardware clock. If so, driver must respond appropriately by
> + * creating or destroying the PTP clock device.
> + */
> + if (adapter->ptp.initialized &&
> + !iavf_ptp_cap_supported(adapter,
> VIRTCHNL_1588_PTP_CAP_READ_PHC))
> + iavf_ptp_release(adapter);
> + else if (!adapter->ptp.initialized &&
> + iavf_ptp_cap_supported(adapter,
> VIRTCHNL_1588_PTP_CAP_READ_PHC))
> + iavf_ptp_init(adapter);
> +}
> diff --git a/drivers/net/ethernet/intel/iavf/iavf_ptp.h
> b/drivers/net/ethernet/intel/iavf/iavf_ptp.h
> index aee4e2da0b9a..4939c219bd18 100644
> --- a/drivers/net/ethernet/intel/iavf/iavf_ptp.h
> +++ b/drivers/net/ethernet/intel/iavf/iavf_ptp.h
> @@ -4,9 +4,19 @@
> #ifndef _IAVF_PTP_H_
> #define _IAVF_PTP_H_
>
> +#include <linux/ptp_clock_kernel.h>
> +
> /* fields used for PTP support */
> struct iavf_ptp {
> struct virtchnl_ptp_caps hw_caps;
> + bool initialized;
> + struct ptp_clock_info info;
> + struct ptp_clock *clock;
> };
>
> +void iavf_ptp_init(struct iavf_adapter *adapter); void
> +iavf_ptp_release(struct iavf_adapter *adapter); void
> +iavf_ptp_process_caps(struct iavf_adapter *adapter); bool
> +iavf_ptp_cap_supported(struct iavf_adapter *adapter, u32 cap);
> +
> #endif /* _IAVF_PTP_H_ */
> diff --git a/drivers/net/ethernet/intel/iavf/iavf_virtchnl.c
> b/drivers/net/ethernet/intel/iavf/iavf_virtchnl.c
> index f922e177146d..12ce169699cf 100644
> --- a/drivers/net/ethernet/intel/iavf/iavf_virtchnl.c
> +++ b/drivers/net/ethernet/intel/iavf/iavf_virtchnl.c
> @@ -2511,6 +2511,8 @@ void iavf_virtchnl_completion(struct iavf_adapter
> *adapter,
> case VIRTCHNL_OP_1588_PTP_GET_CAPS:
> memcpy(&adapter->ptp.hw_caps, msg,
> min_t(u16, msglen, sizeof(adapter->ptp.hw_caps)));
> + /* process any state change needed due to new capabilities */
> + iavf_ptp_process_caps(adapter);
> break;
> case VIRTCHNL_OP_ENABLE_QUEUES:
> /* enable transmits */
> --
> 2.38.1
>
Reviewed-by: Sai Krishna <[email protected]
