Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: ptp.txt: convert to ReST and move to driver-api

The conversion is trivial: just adjust title markups.

In order to avoid conflicts, let's add an :orphan: tag
to it, to be removed when this file gets added to the
driver-api book.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
329f0041 28aedd7e

+20 -10
+1 -1
Documentation/networking/timestamping.txt
··· 368 368 Instead, expose the hardware clock device on the NIC directly as 369 369 a HW PTP clock source, to allow time conversion in userspace and 370 370 optionally synchronize system time with a userspace PTP stack such 371 - as linuxptp. For the PTP clock API, see Documentation/ptp/ptp.txt. 371 + as linuxptp. For the PTP clock API, see Documentation/driver-api/ptp.rst. 372 372 373 373 Note that if the SO_TIMESTAMP or SO_TIMESTAMPNS option is enabled 374 374 together with SO_TIMESTAMPING using SOF_TIMESTAMPING_SOFTWARE, a false
+18 -8
Documentation/ptp/ptp.txt Documentation/driver-api/ptp.rst
··· 1 + :orphan: 1 2 2 - * PTP hardware clock infrastructure for Linux 3 + =========================================== 4 + PTP hardware clock infrastructure for Linux 5 + =========================================== 3 6 4 7 This patch set introduces support for IEEE 1588 PTP clocks in 5 8 Linux. Together with the SO_TIMESTAMPING socket options, this ··· 25 22 - Period output signals configurable from user space 26 23 - Synchronization of the Linux system time via the PPS subsystem 27 24 28 - ** PTP hardware clock kernel API 25 + PTP hardware clock kernel API 26 + ============================= 29 27 30 28 A PTP clock driver registers itself with the class driver. The 31 29 class driver handles all of the dealings with user space. The ··· 40 36 development, it can be useful to have more than one clock in a 41 37 single system, in order to allow performance comparisons. 42 38 43 - ** PTP hardware clock user space API 39 + PTP hardware clock user space API 40 + ================================= 44 41 45 42 The class driver also creates a character device for each 46 43 registered clock. User space can use an open file descriptor from ··· 54 49 ancillary clock features. User space can receive time stamped 55 50 events via blocking read() and poll(). 56 51 57 - ** Writing clock drivers 52 + Writing clock drivers 53 + ===================== 58 54 59 55 Clock drivers include include/linux/ptp_clock_kernel.h and register 60 56 themselves by presenting a 'struct ptp_clock_info' to the ··· 72 66 class driver, since the lock may also be needed by the clock 73 67 driver's interrupt service routine. 74 68 75 - ** Supported hardware 69 + Supported hardware 70 + ================== 76 71 77 - + Freescale eTSEC gianfar 72 + * Freescale eTSEC gianfar 73 + 78 74 - 2 Time stamp external triggers, programmable polarity (opt. interrupt) 79 75 - 2 Alarm registers (optional interrupt) 80 76 - 3 Periodic signals (optional interrupt) 81 77 82 - + National DP83640 78 + * National DP83640 79 + 83 80 - 6 GPIOs programmable as inputs or outputs 84 81 - 6 GPIOs with dedicated functions (LED/JTAG/clock) can also be 85 82 used as general inputs or outputs ··· 90 81 - GPIO outputs can produce periodic signals 91 82 - 1 interrupt pin 92 83 93 - + Intel IXP465 84 + * Intel IXP465 85 + 94 86 - Auxiliary Slave/Master Mode Snapshot (optional interrupt) 95 87 - Target Time (optional interrupt)
+1 -1
MAINTAINERS
··· 12765 12765 S: Maintained 12766 12766 W: http://linuxptp.sourceforge.net/ 12767 12767 F: Documentation/ABI/testing/sysfs-ptp 12768 - F: Documentation/ptp/* 12768 + F: Documentation/driver-api/ptp.rst 12769 12769 F: drivers/net/phy/dp83640* 12770 12770 F: drivers/ptp/* 12771 12771 F: include/linux/ptp_cl*