GNU Linux-libre 6.9.1-gnu
[releases.git] / 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_IDT82P33
135         tristate "IDT 82P33xxx PTP clock"
136         depends on PTP_1588_CLOCK && I2C
137         default n
138         help
139           This driver adds support for using the IDT 82P33xxx as a PTP
140           clock. This clock is only useful if your time stamping MAC
141           is connected to the IDT chip.
142
143           To compile this driver as a module, choose M here: the module
144           will be called ptp_idt82p33.
145
146 config PTP_1588_CLOCK_IDTCM
147         tristate "IDT CLOCKMATRIX as PTP clock"
148         depends on PTP_1588_CLOCK && I2C
149         default n
150         help
151           This driver adds support for using IDT CLOCKMATRIX(TM) as a PTP
152           clock. This clock is only useful if your time stamping MAC
153           is connected to the IDT chip.
154
155           To compile this driver as a module, choose M here: the module
156           will be called ptp_clockmatrix.
157
158 config PTP_1588_CLOCK_FC3W
159         tristate "RENESAS FemtoClock3 Wireless as PTP clock"
160         depends on PTP_1588_CLOCK && I2C
161         default n
162         help
163           This driver adds support for using Renesas FemtoClock3 Wireless
164           as a PTP clock. This clock is only useful if your time stamping
165           MAC is connected to the RENESAS chip.
166
167           To compile this driver as a module, choose M here: the module
168           will be called ptp_fc3.
169
170 config PTP_1588_CLOCK_MOCK
171         tristate "Mock-up PTP clock"
172         depends on PTP_1588_CLOCK
173         help
174           This driver offers a set of PTP clock manipulation operations over
175           the system monotonic time. It can be used by virtual network device
176           drivers to emulate PTP capabilities.
177
178           To compile this driver as a module, choose M here: the module
179           will be called ptp_mock.
180
181 config PTP_1588_CLOCK_VMW
182         tristate "VMware virtual PTP clock"
183         depends on ACPI && HYPERVISOR_GUEST && X86
184         depends on PTP_1588_CLOCK
185         help
186           This driver adds support for using VMware virtual precision
187           clock device as a PTP clock. This is only useful in virtual
188           machines running on VMware virtual infrastructure.
189
190           To compile this driver as a module, choose M here: the module
191           will be called ptp_vmw.
192
193 config PTP_1588_CLOCK_OCP
194         tristate "OpenCompute TimeCard as PTP clock"
195         depends on PTP_1588_CLOCK
196         depends on HAS_IOMEM && PCI
197         depends on I2C && MTD
198         depends on SERIAL_8250
199         depends on !S390
200         depends on COMMON_CLK
201         select NET_DEVLINK
202         select CRC16
203         select DPLL
204         help
205           This driver adds support for an OpenCompute time card.
206
207           The OpenCompute time card is an atomic clock along with
208           a GPS receiver that provides a Grandmaster clock source
209           for a PTP enabled network.
210
211           More information is available at http://www.timingcard.com/
212
213 config PTP_DFL_TOD
214         tristate "FPGA DFL ToD Driver"
215         depends on FPGA_DFL
216         depends on PTP_1588_CLOCK
217         help
218           The DFL (Device Feature List) device driver for the Intel ToD
219           (Time-of-Day) device in FPGA card. The ToD IP within the FPGA
220           is exposed as PTP Hardware Clock (PHC) device to the Linux PTP
221           stack to synchronize the system clock to its ToD information
222           using phc2sys utility of the Linux PTP stack.
223
224           To compile this driver as a module, choose M here: the module
225           will be called ptp_dfl_tod.
226
227 endmenu