[linux-2.6-block.git] / drivers / ptp / Kconfig

# SPDX-License-Identifier: GPL-2.0-only
#
# PTP clock support configuration
#

menu "PTP clock support"

config PTP_1588_CLOCK
	tristate "PTP clock support"
	depends on NET && POSIX_TIMERS
	default ETHERNET
	select PPS
	select NET_PTP_CLASSIFY
	help
	  The IEEE 1588 standard defines a method to precisely
	  synchronize distributed clocks over Ethernet networks. The
	  standard defines a Precision Time Protocol (PTP), which can
	  be used to achieve synchronization within a few dozen
	  microseconds. In addition, with the help of special hardware
	  time stamping units, it can be possible to achieve
	  synchronization to within a few hundred nanoseconds.

	  This driver adds support for PTP clocks as character
	  devices. If you want to use a PTP clock, then you should
	  also enable at least one clock driver as well.

	  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
	depends on NET && HAS_IOMEM
	depends on ARCH_BCM_MOBILE || (ARCH_BCM_IPROC && !(ARCH_BCM_NSP || ARCH_BCM_5301X)) || COMPILE_TEST
	default y
	help
	  This driver adds support for using the Digital timing engine
	  (DTE) in the Broadcom SoC's as a PTP clock.

	  The clock can be used in both wired and wireless networks
	  for PTP purposes.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_dte.

config PTP_1588_CLOCK_QORIQ
	tristate "Freescale QorIQ 1588 timer as PTP clock"
	depends on GIANFAR || FSL_DPAA_ETH || FSL_DPAA2_ETH || FSL_ENETC || FSL_ENETC_VF || COMPILE_TEST
	depends on PTP_1588_CLOCK
	default y
	help
	  This driver adds support for using the Freescale QorIQ 1588
	  timer as a PTP clock. This clock is only useful if your PTP
	  programs are getting hardware time stamps on the PTP Ethernet
	  packets using the SO_TIMESTAMPING API.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp-qoriq.

comment "Enable PHYLIB and NETWORK_PHY_TIMESTAMPING to see the additional clocks."
	depends on PHYLIB=n || NETWORK_PHY_TIMESTAMPING=n

config DP83640_PHY
	tristate "Driver for the National Semiconductor DP83640 PHYTER"
	depends on NETWORK_PHY_TIMESTAMPING
	depends on PHYLIB
	depends on PTP_1588_CLOCK
	select CRC32
	help
	  Supports the DP83640 PHYTER with IEEE 1588 features.

	  This driver adds support for using the DP83640 as a PTP
	  clock. This clock is only useful if your PTP programs are
	  getting hardware time stamps on the PTP Ethernet packets
	  using the SO_TIMESTAMPING API.

	  In order for this to work, your MAC driver must also
	  implement the skb_tx_timestamp() function.

config PTP_1588_CLOCK_INES
	tristate "ZHAW InES PTP time stamping IP core"
	depends on NETWORK_PHY_TIMESTAMPING
	depends on HAS_IOMEM
	depends on PHYLIB
	depends on PTP_1588_CLOCK
	help
	  This driver adds support for using the ZHAW InES 1588 IP
	  core.  This clock is only useful if the MII bus of your MAC
	  is wired up to the core.

config PTP_1588_CLOCK_PCH
	tristate "Intel PCH EG20T as PTP clock"
	depends on X86_32 || COMPILE_TEST
	depends on HAS_IOMEM && NET
	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
	  when using the end-to-end delay (E2E) mechanism. The peer
	  delay mechanism (P2P) is not supported.

	  This clock is only useful if your PTP programs are getting
	  hardware time stamps on the PTP Ethernet packets using the
	  SO_TIMESTAMPING API.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_pch.

config PTP_1588_CLOCK_KVM
	tristate "KVM virtual PTP clock"
	depends on PTP_1588_CLOCK
	depends on (KVM_GUEST && X86) || (HAVE_ARM_SMCCC_DISCOVERY && ARM_ARCH_TIMER)
	default y
	help
	  This driver adds support for using kvm infrastructure as a PTP
	  clock. This clock is only useful if you are using KVM guests.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_kvm.

config PTP_1588_CLOCK_IDT82P33
	tristate "IDT 82P33xxx PTP clock"
	depends on PTP_1588_CLOCK && I2C
	default n
	help
	  This driver adds support for using the IDT 82P33xxx as a PTP
	  clock. This clock is only useful if your time stamping MAC
	  is connected to the IDT chip.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_idt82p33.

config PTP_1588_CLOCK_IDTCM
	tristate "IDT CLOCKMATRIX as PTP clock"
	depends on PTP_1588_CLOCK && I2C
	default n
	help
	  This driver adds support for using IDT CLOCKMATRIX(TM) as a PTP
	  clock. This clock is only useful if your time stamping MAC
	  is connected to the IDT chip.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_clockmatrix.

config PTP_1588_CLOCK_VMW
	tristate "VMware virtual PTP clock"
	depends on ACPI && HYPERVISOR_GUEST && X86
	depends on PTP_1588_CLOCK
	help
	  This driver adds support for using VMware virtual precision
	  clock device as a PTP clock. This is only useful in virtual
	  machines running on VMware virtual infrastructure.

	  To compile this driver as a module, choose M here: the module
	  will be called ptp_vmw.

config PTP_1588_CLOCK_OCP
	tristate "OpenCompute TimeCard as PTP clock"
	depends on PTP_1588_CLOCK
	depends on HAS_IOMEM && PCI
	depends on SPI && I2C && MTD
	depends on !S390
	imply SPI_MEM
	imply SPI_XILINX
	imply MTD_SPI_NOR
	imply I2C_XILINX
	select SERIAL_8250

	default n
	help
	  This driver adds support for an OpenCompute time card.

	  The OpenCompute time card is an atomic clock along with
	  a GPS receiver that provides a Grandmaster clock source
	  for a PTP enabled network.

	  More information is available at http://www.timingcard.com/

endmenu
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
d94ba80e RC	2	#
	3	# PTP clock support configuration
	4	#
	5
	6	menu "PTP clock support"
	7
d94ba80e RC	8	config PTP_1588_CLOCK
d94ba80e RC	9	tristate "PTP clock support"
baa73d9e	10	depends on NET && POSIX_TIMERS
e5f31552	11	default ETHERNET
42a7ccef	12	select PPS
408eccce	13	select NET_PTP_CLASSIFY
d94ba80e RC	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
e5f31552 AB	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
8a56aa10 AP	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
ceefc71d YL	58	config PTP_1588_CLOCK_QORIQ
ceefc71d YL	59	tristate "Freescale QorIQ 1588 timer as PTP clock"
8099d7ca	60	depends on GIANFAR \|\| FSL_DPAA_ETH \|\| FSL_DPAA2_ETH \|\| FSL_ENETC \|\| FSL_ENETC_VF \|\| COMPILE_TEST
d1cbfd77	61	depends on PTP_1588_CLOCK
a24006ed	62	default y
c78275f3	63	help
ceefc71d YL	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.
c78275f3 RC	68
c78275f3 RC	69	To compile this driver as a module, choose M here: the module
19df7510	70	will be called ptp-qoriq.
c78275f3	71
cb646e2b	72	comment "Enable PHYLIB and NETWORK_PHY_TIMESTAMPING to see the additional clocks."
a24006ed	73	depends on PHYLIB=n \|\| NETWORK_PHY_TIMESTAMPING=n
cb646e2b RC	74
	75	config DP83640_PHY
	76	tristate "Driver for the National Semiconductor DP83640 PHYTER"
cb646e2b RC	77	depends on NETWORK_PHY_TIMESTAMPING
cb646e2b RC	78	depends on PHYLIB
d1cbfd77	79	depends on PTP_1588_CLOCK
f9d6f941	80	select CRC32
a7f7f624	81	help
cb646e2b RC	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
6b2aac42	90	implement the skb_tx_timestamp() function.
cb646e2b	91
bad1eaa6 RC	92	config PTP_1588_CLOCK_INES
	93	tristate "ZHAW InES PTP time stamping IP core"
	94	depends on NETWORK_PHY_TIMESTAMPING
1f685e6a	95	depends on HAS_IOMEM
bad1eaa6 RC	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
863d08ec TS	103	config PTP_1588_CLOCK_PCH
863d08ec TS	104	tristate "Intel PCH EG20T as PTP clock"
bc56151d	105	depends on X86_32 \|\| COMPILE_TEST
1a466ae9	106	depends on HAS_IOMEM && NET
e5f31552	107	depends on PTP_1588_CLOCK
863d08ec TS	108	help
863d08ec TS	109	This driver adds support for using the PCH EG20T as a PTP
358dfb6d	110	clock. The hardware supports time stamping of PTP packets
503c9add AB	111	when using the end-to-end delay (E2E) mechanism. The peer
503c9add AB	112	delay mechanism (P2P) is not supported.
358dfb6d TS	113
	114	This clock is only useful if your PTP programs are getting
	115	hardware time stamps on the PTP Ethernet packets using the
	116	SO_TIMESTAMPING API.
863d08ec TS	117
	118	To compile this driver as a module, choose M here: the module
	119	will be called ptp_pch.
	120
a0e136d4 MT	121	config PTP_1588_CLOCK_KVM
	122	tristate "KVM virtual PTP clock"
	123	depends on PTP_1588_CLOCK
300bb1fe	124	depends on (KVM_GUEST && X86) \|\| (HAVE_ARM_SMCCC_DISCOVERY && ARM_ARCH_TIMER)
a0e136d4 MT	125	default y
	126	help
	127	This driver adds support for using kvm infrastructure as a PTP
	128	clock. This clock is only useful if you are using KVM guests.
	129
	130	To compile this driver as a module, choose M here: the module
	131	will be called ptp_kvm.
	132
57a10d8c ML	133	config PTP_1588_CLOCK_IDT82P33
	134	tristate "IDT 82P33xxx PTP clock"
	135	depends on PTP_1588_CLOCK && I2C
	136	default n
	137	help
	138	This driver adds support for using the IDT 82P33xxx as a PTP
	139	clock. This clock is only useful if your time stamping MAC
	140	is connected to the IDT chip.
	141
	142	To compile this driver as a module, choose M here: the module
	143	will be called ptp_idt82p33.
	144
3a6ba7dc VC	145	config PTP_1588_CLOCK_IDTCM
3a6ba7dc VC	146	tristate "IDT CLOCKMATRIX as PTP clock"
03b06e3f	147	depends on PTP_1588_CLOCK && I2C
3a6ba7dc VC	148	default n
	149	help
	150	This driver adds support for using IDT CLOCKMATRIX(TM) as a PTP
	151	clock. This clock is only useful if your time stamping MAC
	152	is connected to the IDT chip.
	153
	154	To compile this driver as a module, choose M here: the module
	155	will be called ptp_clockmatrix.
	156
7d10001e VT	157	config PTP_1588_CLOCK_VMW
	158	tristate "VMware virtual PTP clock"
	159	depends on ACPI && HYPERVISOR_GUEST && X86
	160	depends on PTP_1588_CLOCK
	161	help
	162	This driver adds support for using VMware virtual precision
	163	clock device as a PTP clock. This is only useful in virtual
	164	machines running on VMware virtual infrastructure.
	165
	166	To compile this driver as a module, choose M here: the module
	167	will be called ptp_vmw.
	168
a7e1abad JL	169	config PTP_1588_CLOCK_OCP
	170	tristate "OpenCompute TimeCard as PTP clock"
	171	depends on PTP_1588_CLOCK
	172	depends on HAS_IOMEM && PCI
773bda96	173	depends on SPI && I2C && MTD
944f5101	174	depends on !S390
773bda96 JL	175	imply SPI_MEM
	176	imply SPI_XILINX
	177	imply MTD_SPI_NOR
	178	imply I2C_XILINX
	179	select SERIAL_8250
	180
a7e1abad JL	181	default n
	182	help
	183	This driver adds support for an OpenCompute time card.
	184
	185	The OpenCompute time card is an atomic clock along with
	186	a GPS receiver that provides a Grandmaster clock source
	187	for a PTP enabled network.
	188
	189	More information is available at http://www.timingcard.com/
	190
d94ba80e	191	endmenu