drivers/ptp/Kconfig

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # PTP clock support configuration
   4 #
   5
   6 menu "PTP clock support"
   7
   8 config PTP_1588_CLOCK
   9         tristate "PTP clock support"
  10         depends on NET && POSIX_TIMERS
  11         default ETHERNET
  12         select PPS
  13         select NET_PTP_CLASSIFY
  14         help
  15           The IEEE 1588 standard defines a method to precisely
  16           synchronize distributed clocks over Ethernet networks. The
  17           standard defines a Precision Time Protocol (PTP), which can
  18           be used to achieve synchronization within a few dozen
  19           microseconds. In addition, with the help of special hardware
  20           time stamping units, it can be possible to achieve
  21           synchronization to within a few hundred nanoseconds.
  22
  23           This driver adds support for PTP clocks as character
  24           devices. If you want to use a PTP clock, then you should
  25           also enable at least one clock driver as well.
  26
  27           To compile this driver as a module, choose M here: the module
  28           will be called ptp.
  29
  30 config PTP_1588_CLOCK_OPTIONAL
  31         tristate
  32         default y if PTP_1588_CLOCK=n
  33         default PTP_1588_CLOCK
  34         help
  35           Drivers that can optionally use the PTP_1588_CLOCK framework
  36           should depend on this symbol to prevent them from being built
  37           into vmlinux while the PTP support itself is in a loadable
  38           module.
  39           If PTP support is disabled, this dependency will still be
  40           met, and drivers refer to dummy helpers.
  41
  42 config PTP_1588_CLOCK_DTE
  43         tristate "Broadcom DTE as PTP clock"
  44         depends on PTP_1588_CLOCK
  45         depends on NET && HAS_IOMEM
  46         depends on ARCH_BCM_MOBILE || (ARCH_BCM_IPROC && !(ARCH_BCM_NSP || ARCH_BCM_5301X)) || COMPILE_TEST
  47         default y
  48         help
  49           This driver adds support for using the Digital timing engine
  50           (DTE) in the Broadcom SoC's as a PTP clock.
  51
  52           The clock can be used in both wired and wireless networks
  53           for PTP purposes.
  54
  55           To compile this driver as a module, choose M here: the module
  56           will be called ptp_dte.
  57
  58 config PTP_1588_CLOCK_QORIQ
  59         tristate "Freescale QorIQ 1588 timer as PTP clock"
  60         depends on GIANFAR || FSL_DPAA_ETH || FSL_DPAA2_ETH || FSL_ENETC || FSL_ENETC_VF || COMPILE_TEST
  61         depends on PTP_1588_CLOCK
  62         default y
  63         help
  64           This driver adds support for using the Freescale QorIQ 1588
  65           timer as a PTP clock. This clock is only useful if your PTP
  66           programs are getting hardware time stamps on the PTP Ethernet
  67           packets using the SO_TIMESTAMPING API.
  68
  69           To compile this driver as a module, choose M here: the module
  70           will be called ptp-qoriq.
  71
  72 comment "Enable PHYLIB and NETWORK_PHY_TIMESTAMPING to see the additional clocks."
  73         depends on PHYLIB=n || NETWORK_PHY_TIMESTAMPING=n
  74
  75 config DP83640_PHY
  76         tristate "Driver for the National Semiconductor DP83640 PHYTER"
  77         depends on NETWORK_PHY_TIMESTAMPING
  78         depends on PHYLIB
  79         depends on PTP_1588_CLOCK
  80         select CRC32
  81         help
  82           Supports the DP83640 PHYTER with IEEE 1588 features.
  83
  84           This driver adds support for using the DP83640 as a PTP
  85           clock. This clock is only useful if your PTP programs are
  86           getting hardware time stamps on the PTP Ethernet packets
  87           using the SO_TIMESTAMPING API.
  88
  89           In order for this to work, your MAC driver must also
  90           implement the skb_tx_timestamp() function.
  91
  92 config PTP_1588_CLOCK_INES
  93         tristate "ZHAW InES PTP time stamping IP core"
  94         depends on NETWORK_PHY_TIMESTAMPING
  95         depends on HAS_IOMEM
  96         depends on PHYLIB
  97         depends on PTP_1588_CLOCK
  98         help
  99           This driver adds support for using the ZHAW InES 1588 IP
 100           core.  This clock is only useful if the MII bus of your MAC
 101           is wired up to the core.
 102
 103 config PTP_1588_CLOCK_PCH
 104         tristate "Intel PCH EG20T as PTP clock"
 105         depends on MIPS_GENERIC || X86_32 || COMPILE_TEST
 106         depends on HAS_IOMEM && PCI
 107         depends on NET
 108         depends on PTP_1588_CLOCK
 109         help
 110           This driver adds support for using the PCH EG20T as a PTP
 111           clock. The hardware supports time stamping of PTP packets
 112           when using the end-to-end delay (E2E) mechanism. The peer
 113           delay mechanism (P2P) is not supported.
 114
 115           This clock is only useful if your PTP programs are getting
 116           hardware time stamps on the PTP Ethernet packets using the
 117           SO_TIMESTAMPING API.
 118
 119           To compile this driver as a module, choose M here: the module
 120           will be called ptp_pch.
 121
 122 config PTP_1588_CLOCK_KVM
 123         tristate "KVM virtual PTP clock"
 124         depends on PTP_1588_CLOCK
 125         depends on (KVM_GUEST && X86) || (HAVE_ARM_SMCCC_DISCOVERY && ARM_ARCH_TIMER)
 126         default y
 127         help
 128           This driver adds support for using kvm infrastructure as a PTP
 129           clock. This clock is only useful if you are using KVM guests.
 130
 131           To compile this driver as a module, choose M here: the module
 132           will be called ptp_kvm.
 133
 134 config PTP_1588_CLOCK_VMCLOCK
 135         tristate "Virtual machine PTP clock"
 136         depends on X86_TSC || ARM_ARCH_TIMER
 137         depends on PTP_1588_CLOCK && ACPI && ARCH_SUPPORTS_INT128
 138         default PTP_1588_CLOCK_KVM
 139         help
 140           This driver adds support for using a virtual precision clock
 141           advertised by the hypervisor. This clock is only useful in virtual
 142           machines where such a device is present.
 143
 144           Unlike the KVM virtual PTP clock, the VMCLOCK device offers support
 145           for reliable timekeeping even across live migration. So this driver
 146           is enabled by default whenever the KVM PTP clock is.
 147
 148           To compile this driver as a module, choose M here: the module
 149           will be called ptp_vmclock.
 150
 151 config PTP_1588_CLOCK_IDT82P33
 152         tristate "IDT 82P33xxx PTP clock"
 153         depends on PTP_1588_CLOCK && I2C
 154         default n
 155         help
 156           This driver adds support for using the IDT 82P33xxx as a PTP
 157           clock. This clock is only useful if your time stamping MAC
 158           is connected to the IDT chip.
 159
 160           To compile this driver as a module, choose M here: the module
 161           will be called ptp_idt82p33.
 162
 163 config PTP_1588_CLOCK_IDTCM
 164         tristate "IDT CLOCKMATRIX as PTP clock"
 165         depends on PTP_1588_CLOCK && I2C
 166         default n
 167         help
 168           This driver adds support for using IDT CLOCKMATRIX(TM) as a PTP
 169           clock. This clock is only useful if your time stamping MAC
 170           is connected to the IDT chip.
 171
 172           To compile this driver as a module, choose M here: the module
 173           will be called ptp_clockmatrix.
 174
 175 config PTP_1588_CLOCK_FC3W
 176         tristate "RENESAS FemtoClock3 Wireless as PTP clock"
 177         depends on PTP_1588_CLOCK && I2C
 178         default n
 179         help
 180           This driver adds support for using Renesas FemtoClock3 Wireless
 181           as a PTP clock. This clock is only useful if your time stamping
 182           MAC is connected to the RENESAS chip.
 183
 184           To compile this driver as a module, choose M here: the module
 185           will be called ptp_fc3.
 186
 187 config PTP_1588_CLOCK_MOCK
 188         tristate "Mock-up PTP clock"
 189         depends on PTP_1588_CLOCK
 190         help
 191           This driver offers a set of PTP clock manipulation operations over
 192           the system monotonic time. It can be used by virtual network device
 193           drivers to emulate PTP capabilities.
 194
 195           To compile this driver as a module, choose M here: the module
 196           will be called ptp_mock.
 197
 198 config PTP_1588_CLOCK_VMW
 199         tristate "VMware virtual PTP clock"
 200         depends on ACPI && HYPERVISOR_GUEST && X86
 201         depends on PTP_1588_CLOCK
 202         help
 203           This driver adds support for using VMware virtual precision
 204           clock device as a PTP clock. This is only useful in virtual
 205           machines running on VMware virtual infrastructure.
 206
 207           To compile this driver as a module, choose M here: the module
 208           will be called ptp_vmw.
 209
 210 config PTP_1588_CLOCK_OCP
 211         tristate "OpenCompute TimeCard as PTP clock"
 212         depends on PTP_1588_CLOCK
 213         depends on HAS_IOMEM && PCI
 214         depends on I2C && MTD
 215         depends on SERIAL_8250
 216         depends on !S390
 217         depends on COMMON_CLK
 218         select NET_DEVLINK
 219         select CRC16
 220         select DPLL
 221         help
 222           This driver adds support for an OpenCompute time card.
 223
 224           The OpenCompute time card is an atomic clock along with
 225           a GPS receiver that provides a Grandmaster clock source
 226           for a PTP enabled network.
 227
 228           More information is available at http://www.timingcard.com/
 229
 230 config PTP_DFL_TOD
 231         tristate "FPGA DFL ToD Driver"
 232         depends on FPGA_DFL
 233         depends on PTP_1588_CLOCK
 234         help
 235           The DFL (Device Feature List) device driver for the Intel ToD
 236           (Time-of-Day) device in FPGA card. The ToD IP within the FPGA
 237           is exposed as PTP Hardware Clock (PHC) device to the Linux PTP
 238           stack to synchronize the system clock to its ToD information
 239           using phc2sys utility of the Linux PTP stack.
 240
 241           To compile this driver as a module, choose M here: the module
 242           will be called ptp_dfl_tod.
 243
 244 config PTP_S390
 245         tristate "S390 PTP driver"
 246         depends on PTP_1588_CLOCK
 247         depends on S390
 248         help
 249           This driver adds support for S390 time steering via the PtP
 250           interface. This works by adding a in-kernel clock delta value,
 251           which is always added to time values used in the kernel. The PtP
 252           driver provides the raw clock value without the delta to
 253           userspace. That way userspace programs like chrony could steer
 254           the kernel clock.
 255 endmenu