The 'imply' keyword does not do what most people think it does, it only
politely asks Kconfig to turn on another symbol, but does not prevent
it from being disabled manually or built as a loadable module when the
user is built-in. In the ICE driver, the latter now causes a link failure:
aarch64-linux-ld: drivers/net/ethernet/intel/ice/ice_main.o: in function `ice_eth_ioctl':
ice_main.c:(.text+0x13b0): undefined reference to `ice_ptp_get_ts_config'
ice_main.c:(.text+0x13b0): relocation truncated to fit: R_AARCH64_CALL26 against undefined symbol `ice_ptp_get_ts_config'
aarch64-linux-ld: ice_main.c:(.text+0x13bc): undefined reference to `ice_ptp_set_ts_config'
ice_main.c:(.text+0x13bc): relocation truncated to fit: R_AARCH64_CALL26 against undefined symbol `ice_ptp_set_ts_config'
aarch64-linux-ld: drivers/net/ethernet/intel/ice/ice_main.o: in function `ice_prepare_for_reset':
ice_main.c:(.text+0x31fc): undefined reference to `ice_ptp_release'
ice_main.c:(.text+0x31fc): relocation truncated to fit: R_AARCH64_CALL26 against undefined symbol `ice_ptp_release'
aarch64-linux-ld: drivers/net/ethernet/intel/ice/ice_main.o: in function `ice_rebuild':
This is a recurring problem in many drivers, and we have discussed
it several times befores, without reaching a consensus. I'm providing
a link to the previous email thread for reference, which discusses
some related problems.
To solve the dependency issue better than the 'imply' keyword, introduce a
separate Kconfig symbol "CONFIG_PTP_1588_CLOCK_OPTIONAL" that any driver
can depend on if it is able to use PTP support when available, but works
fine without it. Whenever CONFIG_PTP_1588_CLOCK=m, those drivers are
then prevented from being built-in, the same way as with a 'depends on
PTP_1588_CLOCK || !PTP_1588_CLOCK' dependency that does the same trick,
but that can be rather confusing when you first see it.
Since this should cover the dependencies correctly, the IS_REACHABLE()
hack in the header is no longer needed now, and can be turned back
into a normal IS_ENABLED() check. Any driver that gets the dependency
wrong will now cause a link time failure rather than being unable to use
PTP support when that is in a loadable module.
However, the two recently added ptp_get_vclocks_index() and
ptp_convert_timestamp() interfaces are only called from builtin code with
ethtool and socket timestamps, so keep the current behavior by stubbing
those out completely when PTP is in a loadable module. This should be
addressed properly in a follow-up.
As Richard suggested, we may want to actually turn PTP support into a
'bool' option later on, preventing it from being a loadable module
altogether, which would be one way to solve the problem with the ethtool
interface.
Fixes: 06c16d89d2cb ("ice: register 1588 PTP clock device object for E810 devices")
Link: https://lore.kernel.org/netdev/20210804121318.337276-1-arnd@kernel.org/
Link: https://lore.kernel.org/netdev/CAK8P3a06enZOf=XyZ+zcAwBczv41UuCTz+=0FMf2gBz1_cOnZQ@mail.gmail.com/
Link: https://lore.kernel.org/netdev/CAK8P3a3=eOxE-K25754+fB_-i_0BZzf9a9RfPTX3ppSwu9WZXw@mail.gmail.com/
Link: https://lore.kernel.org/netdev/20210726084540.3282344-1-arnd@kernel.org/
Acked-by: Shannon Nelson <snelson@pensando.io>
Acked-by: Jacob Keller <jacob.e.keller@intel.com>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Link: https://lore.kernel.org/r/20210812183509.1362782-1-arnd@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
 config NET_DSA_MV88E6XXX
        tristate "Marvell 88E6xxx Ethernet switch fabric support"
        depends on NET_DSA
+       depends on PTP_1588_CLOCK_OPTIONAL
        select IRQ_DOMAIN
        select NET_DSA_TAG_EDSA
        select NET_DSA_TAG_DSA
 
        depends on NET_VENDOR_MICROSEMI
        depends on NET_VENDOR_FREESCALE
        depends on HAS_IOMEM
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MSCC_OCELOT_SWITCH_LIB
        select NET_DSA_TAG_OCELOT_8021Q
        select NET_DSA_TAG_OCELOT
        depends on NET_DSA
        depends on NET_VENDOR_MICROSEMI
        depends on HAS_IOMEM
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MSCC_OCELOT_SWITCH_LIB
        select NET_DSA_TAG_OCELOT_8021Q
        select NET_DSA_TAG_OCELOT
 
 config NET_DSA_SJA1105
 tristate "NXP SJA1105 Ethernet switch family support"
        depends on NET_DSA && SPI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select NET_DSA_TAG_SJA1105
        select PCS_XPCS
        select PACKING
 
        tristate "AMD 10GbE Ethernet driver"
        depends on ((OF_NET && OF_ADDRESS) || ACPI || PCI) && HAS_IOMEM
        depends on X86 || ARM64 || COMPILE_TEST
+       depends on PTP_1588_CLOCK_OPTIONAL
        select BITREVERSE
        select CRC32
        select PHYLIB
        select AMD_XGBE_HAVE_ECC if X86
-       imply PTP_1588_CLOCK
        help
          This driver supports the AMD 10GbE Ethernet device found on an
          AMD SoC.
 
 config TIGON3
        tristate "Broadcom Tigon3 support"
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select PHYLIB
-       imply PTP_1588_CLOCK
        help
          This driver supports Broadcom Tigon3 based gigabit Ethernet cards.
 
 config BNX2X
        tristate "Broadcom NetXtremeII 10Gb support"
        depends on PCI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select FW_LOADER
        select ZLIB_INFLATE
        select LIBCRC32C
 config BNXT
        tristate "Broadcom NetXtreme-C/E support"
        depends on PCI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select FW_LOADER
        select LIBCRC32C
        select NET_DEVLINK
 
 config MACB
        tristate "Cadence MACB/GEM support"
        depends on HAS_DMA && COMMON_CLK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select PHYLINK
        select CRC32
        help
 
        tristate "Cavium LiquidIO support"
        depends on 64BIT && PCI
        depends on PCI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select FW_LOADER
        select LIBCRC32C
        select NET_DEVLINK
 config LIQUIDIO_VF
        tristate "Cavium LiquidIO VF support"
        depends on 64BIT && PCI_MSI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This driver supports Cavium LiquidIO Intelligent Server Adapter
          based on CN23XX chips.
 
 config CHELSIO_T4
        tristate "Chelsio Communications T4/T5/T6 Ethernet support"
        depends on PCI && (IPV6 || IPV6=n) && (TLS || TLS=n)
+       depends on PTP_1588_CLOCK_OPTIONAL
        select FW_LOADER
        select MDIO
        select ZLIB_DEFLATE
 
        depends on (M523x || M527x || M5272 || M528x || M520x || M532x || \
                   ARCH_MXC || SOC_IMX28 || COMPILE_TEST)
        default ARCH_MXC || SOC_IMX28 if ARM
+       depends on PTP_1588_CLOCK_OPTIONAL
        select CRC32
        select PHYLIB
        imply NET_SELFTESTS
-       imply PTP_1588_CLOCK
        help
          Say Y here if you want to use the built-in 10/100 Fast ethernet
          controller on some Motorola ColdFire and Freescale i.MX processors.
 
        tristate "Hisilicon HNS3 HCLGE Acceleration Engine & Compatibility Layer Support"
        default m
        depends on PCI_MSI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This selects the HNS3_HCLGE network acceleration engine & its hardware
          compatibility layer. The engine would be used in Hisilicon hip08 family of
 
 config E1000E
        tristate "Intel(R) PRO/1000 PCI-Express Gigabit Ethernet support"
        depends on PCI && (!SPARC32 || BROKEN)
+       depends on PTP_1588_CLOCK_OPTIONAL
        select CRC32
-       imply PTP_1588_CLOCK
        help
          This driver supports the PCI-Express Intel(R) PRO/1000 gigabit
          ethernet family of adapters. For PCI or PCI-X e1000 adapters,
 config IGB
        tristate "Intel(R) 82575/82576 PCI-Express Gigabit Ethernet support"
        depends on PCI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select I2C
        select I2C_ALGOBIT
        help
 config IXGBE
        tristate "Intel(R) 10GbE PCI Express adapters support"
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MDIO
        select PHYLIB
-       imply PTP_1588_CLOCK
        help
          This driver supports Intel(R) 10GbE PCI Express family of
          adapters.  For more information on how to identify your adapter, go
 
 config I40E
        tristate "Intel(R) Ethernet Controller XL710 Family support"
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        depends on PCI
        select AUXILIARY_BUS
        help
        tristate "Intel(R) Ethernet Connection E800 Series Support"
        default n
        depends on PCI_MSI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select AUXILIARY_BUS
        select DIMLIB
        select NET_DEVLINK
        select PLDMFW
-       imply PTP_1588_CLOCK
        help
          This driver supports Intel(R) Ethernet Connection E800 Series of
          devices.  For more information on how to identify your adapter, go
        tristate "Intel(R) FM10000 Ethernet Switch Host Interface Support"
        default n
        depends on PCI_MSI
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This driver supports Intel(R) FM10000 Ethernet Switch Host
          Interface.  For more information on how to identify your adapter,
 
        select NET_DEVLINK
        depends on (64BIT && COMPILE_TEST) || ARM64
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This driver supports Marvell's OcteonTX2 Resource Virtualization
          Unit's admin function manager which manages all RVU HW resources
        select OCTEONTX2_MBOX
        depends on (64BIT && COMPILE_TEST) || ARM64
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This driver supports Marvell's OcteonTX2 NIC physical function.
 
 
 config MLX4_EN
        tristate "Mellanox Technologies 1/10/40Gbit Ethernet support"
        depends on PCI && NETDEVICES && ETHERNET && INET
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MLX4_CORE
-       imply PTP_1588_CLOCK
        help
          This driver supports Mellanox Technologies ConnectX Ethernet
          devices.
 
        select NET_DEVLINK
        depends on VXLAN || !VXLAN
        depends on MLXFW || !MLXFW
-       depends on PTP_1588_CLOCK || !PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        depends on PCI_HYPERV_INTERFACE || !PCI_HYPERV_INTERFACE
        help
          Core driver for low level functionality of the ConnectX-4 and
 
        depends on NET_IPGRE || NET_IPGRE=n
        depends on IPV6_GRE || IPV6_GRE=n
        depends on VXLAN || VXLAN=n
+       depends on PTP_1588_CLOCK_OPTIONAL
        select GENERIC_ALLOCATOR
        select PARMAN
        select OBJAGG
-       imply PTP_1588_CLOCK
        select NET_PTP_CLASSIFY if PTP_1588_CLOCK
        default m
        help
 
 config LAN743X
        tristate "LAN743x support"
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select PHYLIB
        select CRC16
        select CRC32
 
 
 config MSCC_OCELOT_SWITCH
        tristate "Ocelot switch driver"
+       depends on PTP_1588_CLOCK_OPTIONAL
        depends on BRIDGE || BRIDGE=n
        depends on NET_SWITCHDEV
        depends on HAS_IOMEM
 
 config PCH_GBE
        tristate "OKI SEMICONDUCTOR IOH(ML7223/ML7831) GbE"
        depends on PCI && (X86_32 || COMPILE_TEST)
+       depends on PTP_1588_CLOCK
        select MII
        select PTP_1588_CLOCK_PCH
        select NET_PTP_CLASSIFY
 
 config IONIC
        tristate "Pensando Ethernet IONIC Support"
        depends on 64BIT && PCI
-       depends on PTP_1588_CLOCK || !PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        select NET_DEVLINK
        select DIMLIB
        help
 
 config QEDE
        tristate "QLogic QED 25/40/100Gb Ethernet NIC"
        depends on QED
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          This enables the support for Marvell FastLinQ adapters family,
          ethernet driver.
 
 config RAVB
        tristate "Renesas Ethernet AVB support"
        depends on ARCH_RENESAS || COMPILE_TEST
+       depends on PTP_1588_CLOCK_OPTIONAL
        select CRC32
        select MII
        select MDIO_BITBANG
        select PHYLIB
-       imply PTP_1588_CLOCK
        help
          Renesas Ethernet AVB device driver.
          This driver supports the following SoCs:
 
 config SXGBE_ETH
        tristate "Samsung 10G/2.5G/1G SXGBE Ethernet driver"
        depends on HAS_IOMEM && HAS_DMA
+       depends on PTP_1588_CLOCK_OPTIONAL
        select PHYLIB
        select CRC32
-       imply PTP_1588_CLOCK
        help
          This is the driver for the SXGBE 10G Ethernet IP block found on
          Samsung platforms.
 
 config SFC
        tristate "Solarflare SFC9000/SFC9100/EF100-family support"
        depends on PCI
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MDIO
        select CRC32
-       imply PTP_1588_CLOCK
        help
          This driver supports 10/40-gigabit Ethernet cards based on
          the Solarflare SFC9000-family and SFC9100-family controllers.
 
 config STMMAC_ETH
        tristate "STMicroelectronics Multi-Gigabit Ethernet driver"
        depends on HAS_IOMEM && HAS_DMA
+       depends on PTP_1588_CLOCK_OPTIONAL
        select MII
        select PCS_XPCS
        select PAGE_POOL
        select PHYLINK
        select CRC32
-       imply PTP_1588_CLOCK
        select RESET_CONTROLLER
        help
          This is the driver for the Ethernet IPs built around a
 
 config MICROSEMI_PHY
        tristate "Microsemi PHYs"
        depends on MACSEC || MACSEC=n
+       depends on PTP_1588_CLOCK_OPTIONAL || !NETWORK_PHY_TIMESTAMPING
        select CRYPTO_LIB_AES if MACSEC
        help
          Currently supports VSC8514, VSC8530, VSC8531, VSC8540 and VSC8541 PHYs
 
 config NXP_C45_TJA11XX_PHY
        tristate "NXP C45 TJA11XX PHYs"
+       depends on PTP_1588_CLOCK_OPTIONAL
        help
          Enable support for NXP C45 TJA11XX PHYs.
          Currently supports only the TJA1103 PHY.
 
 config PTP_1588_CLOCK
        tristate "PTP clock support"
        depends on NET && POSIX_TIMERS
+       default ETHERNET
        select PPS
        select NET_PTP_CLASSIFY
        help
          To compile this driver as a module, choose M here: the module
          will be called ptp.
 
+config PTP_1588_CLOCK_OPTIONAL
+       tristate
+       default y if PTP_1588_CLOCK=n
+       default PTP_1588_CLOCK
+       help
+         Drivers that can optionally use the PTP_1588_CLOCK framework
+         should depend on this symbol to prevent them from being built
+         into vmlinux while the PTP support itself is in a loadable
+         module.
+         If PTP support is disabled, this dependency will still be
+         met, and drivers refer to dummy helpers.
+
 config PTP_1588_CLOCK_DTE
        tristate "Broadcom DTE as PTP clock"
        depends on PTP_1588_CLOCK
        tristate "Intel PCH EG20T as PTP clock"
        depends on X86_32 || COMPILE_TEST
        depends on HAS_IOMEM && NET
-       imply PTP_1588_CLOCK
+       depends on PTP_1588_CLOCK
        help
          This driver adds support for using the PCH EG20T as a PTP
          clock. The hardware supports time stamping of PTP packets
 
        kfree(vclock);
 }
 
+#if IS_BUILTIN(CONFIG_PTP_1588_CLOCK)
 int ptp_get_vclocks_index(int pclock_index, int **vclock_index)
 {
        char name[PTP_CLOCK_NAME_LEN] = "";
        hwtstamps->hwtstamp = ns_to_ktime(ns);
 }
 EXPORT_SYMBOL(ptp_convert_timestamp);
+#endif
 
 config SCSI_CXGB4_ISCSI
        tristate "Chelsio T4 iSCSI support"
        depends on PCI && INET && (IPV6 || IPV6=n)
+       depends on PTP_1588_CLOCK_OPTIONAL
        depends on THERMAL || !THERMAL
        depends on ETHERNET
        depends on TLS || TLS=n
 
        return (long)ppb;
 }
 
-#if IS_REACHABLE(CONFIG_PTP_1588_CLOCK)
+#if IS_ENABLED(CONFIG_PTP_1588_CLOCK)
 
 /**
  * ptp_clock_register() - register a PTP hardware clock driver
  */
 void ptp_cancel_worker_sync(struct ptp_clock *ptp);
 
+#else
+static inline struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
+                                                  struct device *parent)
+{ return NULL; }
+static inline int ptp_clock_unregister(struct ptp_clock *ptp)
+{ return 0; }
+static inline void ptp_clock_event(struct ptp_clock *ptp,
+                                  struct ptp_clock_event *event)
+{ }
+static inline int ptp_clock_index(struct ptp_clock *ptp)
+{ return -1; }
+static inline int ptp_find_pin(struct ptp_clock *ptp,
+                              enum ptp_pin_function func, unsigned int chan)
+{ return -1; }
+static inline int ptp_schedule_worker(struct ptp_clock *ptp,
+                                     unsigned long delay)
+{ return -EOPNOTSUPP; }
+static inline void ptp_cancel_worker_sync(struct ptp_clock *ptp)
+{ }
+#endif
+
+#if IS_BUILTIN(CONFIG_PTP_1588_CLOCK)
+/*
+ * These are called by the network core, and don't work if PTP is in
+ * a loadable module.
+ */
+
 /**
  * ptp_get_vclocks_index() - get all vclocks index on pclock, and
  *                           caller is responsible to free memory
  */
 void ptp_convert_timestamp(struct skb_shared_hwtstamps *hwtstamps,
                           int vclock_index);
-
 #else
-static inline struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
-                                                  struct device *parent)
-{ return NULL; }
-static inline int ptp_clock_unregister(struct ptp_clock *ptp)
-{ return 0; }
-static inline void ptp_clock_event(struct ptp_clock *ptp,
-                                  struct ptp_clock_event *event)
-{ }
-static inline int ptp_clock_index(struct ptp_clock *ptp)
-{ return -1; }
-static inline int ptp_find_pin(struct ptp_clock *ptp,
-                              enum ptp_pin_function func, unsigned int chan)
-{ return -1; }
-static inline int ptp_schedule_worker(struct ptp_clock *ptp,
-                                     unsigned long delay)
-{ return -EOPNOTSUPP; }
-static inline void ptp_cancel_worker_sync(struct ptp_clock *ptp)
-{ }
 static inline int ptp_get_vclocks_index(int pclock_index, int **vclock_index)
 { return 0; }
 static inline void ptp_convert_timestamp(struct skb_shared_hwtstamps *hwtstamps,