[PATCH 28/57] docs: ptp.txt: convert to ReST and move to driver-api

Mauro Carvalho Chehab
2019-04-16T03:00:10Z

The conversion is trivial: just adjust title markups.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/ptp/ptp.txt | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)

diff --git a/Documentation/ptp/ptp.txt b/Documentation/ptp/ptp.txt
index 11e904ee073f..65c84a72e9fc 100644
--- a/Documentation/ptp/ptp.txt
+++ b/Documentation/ptp/ptp.txt
@@ -1,5 +1,6 @@
-
-* PTP hardware clock infrastructure for Linux
+===========================================
+PTP hardware clock infrastructure for Linux
+===========================================

This patch set introduces support for IEEE 1588 PTP clocks in
Linux. Together with the SO_TIMESTAMPING socket options, this
@@ -22,7 +23,8 @@
- Period output signals configurable from user space
- Synchronization of the Linux system time via the PPS subsystem

-** PTP hardware clock kernel API
+PTP hardware clock kernel API
+=============================

A PTP clock driver registers itself with the class driver. The
class driver handles all of the dealings with user space. The
@@ -36,7 +38,8 @@
development, it can be useful to have more than one clock in a
single system, in order to allow performance comparisons.

-** PTP hardware clock user space API
+PTP hardware clock user space API
+=================================

The class driver also creates a character device for each
registered clock. User space can use an open file descriptor from
@@ -49,7 +52,8 @@
ancillary clock features. User space can receive time stamped
events via blocking read() and poll().

-** Writing clock drivers
+Writing clock drivers
+=====================

Clock drivers include include/linux/ptp_clock_kernel.h and register
themselves by presenting a 'struct ptp_clock_info' to the
@@ -66,14 +70,17 @@
class driver, since the lock may also be needed by the clock
driver's interrupt service routine.

-** Supported hardware
+Supported hardware
+==================
+
+ * Freescale eTSEC gianfar

- + Freescale eTSEC gianfar
- 2 Time stamp external triggers, programmable polarity (opt. interrupt)
- 2 Alarm registers (optional interrupt)
- 3 Periodic signals (optional interrupt)

- + National DP83640
+ * National DP83640
+
- 6 GPIOs programmable as inputs or outputs
- 6 GPIOs with dedicated functions (LED/JTAG/clock) can also be
used as general inputs or outputs
@@ -81,6 +88,7 @@
- GPIO outputs can produce periodic signals
- 1 interrupt pin

- + Intel IXP465
+ * Intel IXP465
+
- Auxiliary Slave/Master Mode Snapshot (optional interrupt)
- Target Time (optional interrupt)
--
2.20.1