2021-09-14 14:38:07

by Mauro Carvalho Chehab

Subject: [PATCH v2 29/29] ABI: sysfs-ptp: use wildcards on What definitions

An "N" upper letter is not a wildcard, nor can easily be identified
by script, specially since the USB sysfs define things like.
bNumInterfaces. Use, instead, <N>, in order to let script/get_abi.pl
to convert it into a Regex.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/ABI/testing/sysfs-ptp | 30 ++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp
index d378f57c1b73..9c317ac7c47a 100644
--- a/Documentation/ABI/testing/sysfs-ptp
+++ b/Documentation/ABI/testing/sysfs-ptp
@@ -6,7 +6,7 @@ Description:
providing a standardized interface to the ancillary
features of PTP hardware clocks.

-What: /sys/class/ptp/ptpN/
+What: /sys/class/ptp/ptp<N>/
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -14,7 +14,7 @@ Description:
hardware clock registered into the PTP class driver
subsystem.

-What: /sys/class/ptp/ptpN/clock_name
+What: /sys/class/ptp/ptp<N>/clock_name
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -25,7 +25,7 @@ Description:
MAC based ones. The string does not necessarily have
to be any kind of unique id.

-What: /sys/class/ptp/ptpN/max_adjustment
+What: /sys/class/ptp/ptp<N>/max_adjustment
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -33,42 +33,42 @@ Description:
frequency adjustment value (a positive integer) in
parts per billion.

-What: /sys/class/ptp/ptpN/max_vclocks
+What: /sys/class/ptp/ptp<N>/max_vclocks
Date: May 2021
Contact: Yangbo Lu <[email protected]>
Description:
This file contains the maximum number of ptp vclocks.
Write integer to re-configure it.

-What: /sys/class/ptp/ptpN/n_alarms
+What: /sys/class/ptp/ptp<N>/n_alarms
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
This file contains the number of periodic or one shot
alarms offer by the PTP hardware clock.

-What: /sys/class/ptp/ptpN/n_external_timestamps
+What: /sys/class/ptp/ptp<N>/n_external_timestamps
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
This file contains the number of external timestamp
channels offered by the PTP hardware clock.

-What: /sys/class/ptp/ptpN/n_periodic_outputs
+What: /sys/class/ptp/ptp<N>/n_periodic_outputs
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
This file contains the number of programmable periodic
output channels offered by the PTP hardware clock.

-What: /sys/class/ptp/ptpN/n_pins
+What: /sys/class/ptp/ptp<N>/n_pins
Date: March 2014
Contact: Richard Cochran <[email protected]>
Description:
This file contains the number of programmable pins
offered by the PTP hardware clock.

-What: /sys/class/ptp/ptpN/n_vclocks
+What: /sys/class/ptp/ptp<N>/n_vclocks
Date: May 2021
Contact: Yangbo Lu <[email protected]>
Description:
@@ -81,7 +81,7 @@ Description:
switches the physical clock back to normal, adjustable
operation.

-What: /sys/class/ptp/ptpN/pins
+What: /sys/class/ptp/ptp<N>/pins
Date: March 2014
Contact: Richard Cochran <[email protected]>
Description:
@@ -94,7 +94,7 @@ Description:
assignment may be changed by two writing numbers into
the file.

-What: /sys/class/ptp/ptpN/pps_available
+What: /sys/class/ptp/ptp<N>/pps_available
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -103,7 +103,7 @@ Description:
"1" means that the PPS is supported, while "0" means
not supported.

-What: /sys/class/ptp/ptpN/extts_enable
+What: /sys/class/ptp/ptp<N>/extts_enable
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -113,7 +113,7 @@ Description:
To disable external timestamps, write the channel
index followed by a "0" into the file.

-What: /sys/class/ptp/ptpN/fifo
+What: /sys/class/ptp/ptp<N>/fifo
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -121,7 +121,7 @@ Description:
the form of three integers: channel index, seconds,
and nanoseconds.

-What: /sys/class/ptp/ptpN/period
+What: /sys/class/ptp/ptp<N>/period
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
@@ -132,7 +132,7 @@ Description:
period nanoseconds. To disable a periodic output, set
all the seconds and nanoseconds values to zero.

-What: /sys/class/ptp/ptpN/pps_enable
+What: /sys/class/ptp/ptp<N>/pps_enable
Date: September 2010
Contact: Richard Cochran <[email protected]>
Description:
--
2.31.1

2021-09-14 14:52:07

by Richard Cochran

Subject: Re: [PATCH v2 29/29] ABI: sysfs-ptp: use wildcards on What definitions

On Tue, Sep 14, 2021 at 04:32:44PM +0200, Mauro Carvalho Chehab wrote:
> An "N" upper letter is not a wildcard, nor can easily be identified
> by script, specially since the USB sysfs define things like.
> bNumInterfaces. Use, instead, <N>, in order to let script/get_abi.pl
> to convert it into a Regex.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Acked-by: Richard Cochran <[email protected]>