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

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.

Acked-by: Richard Cochran <richardcochran@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/03dcf9985244f8f9d8202af1ba203abb1f405e7d.1631782432.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Mauro Carvalho Chehab and committed by
Greg Kroah-Hartman
64b609fd 3f6b07ad

+15 -15
+15 -15
Documentation/ABI/testing/sysfs-ptp
··· 6 6 providing a standardized interface to the ancillary 7 7 features of PTP hardware clocks. 8 8 9 - What: /sys/class/ptp/ptpN/ 9 + What: /sys/class/ptp/ptp<N>/ 10 10 Date: September 2010 11 11 Contact: Richard Cochran <richardcochran@gmail.com> 12 12 Description: ··· 14 14 hardware clock registered into the PTP class driver 15 15 subsystem. 16 16 17 - What: /sys/class/ptp/ptpN/clock_name 17 + What: /sys/class/ptp/ptp<N>/clock_name 18 18 Date: September 2010 19 19 Contact: Richard Cochran <richardcochran@gmail.com> 20 20 Description: ··· 25 25 MAC based ones. The string does not necessarily have 26 26 to be any kind of unique id. 27 27 28 - What: /sys/class/ptp/ptpN/max_adjustment 28 + What: /sys/class/ptp/ptp<N>/max_adjustment 29 29 Date: September 2010 30 30 Contact: Richard Cochran <richardcochran@gmail.com> 31 31 Description: ··· 33 33 frequency adjustment value (a positive integer) in 34 34 parts per billion. 35 35 36 - What: /sys/class/ptp/ptpN/max_vclocks 36 + What: /sys/class/ptp/ptp<N>/max_vclocks 37 37 Date: May 2021 38 38 Contact: Yangbo Lu <yangbo.lu@nxp.com> 39 39 Description: 40 40 This file contains the maximum number of ptp vclocks. 41 41 Write integer to re-configure it. 42 42 43 - What: /sys/class/ptp/ptpN/n_alarms 43 + What: /sys/class/ptp/ptp<N>/n_alarms 44 44 Date: September 2010 45 45 Contact: Richard Cochran <richardcochran@gmail.com> 46 46 Description: 47 47 This file contains the number of periodic or one shot 48 48 alarms offer by the PTP hardware clock. 49 49 50 - What: /sys/class/ptp/ptpN/n_external_timestamps 50 + What: /sys/class/ptp/ptp<N>/n_external_timestamps 51 51 Date: September 2010 52 52 Contact: Richard Cochran <richardcochran@gmail.com> 53 53 Description: 54 54 This file contains the number of external timestamp 55 55 channels offered by the PTP hardware clock. 56 56 57 - What: /sys/class/ptp/ptpN/n_periodic_outputs 57 + What: /sys/class/ptp/ptp<N>/n_periodic_outputs 58 58 Date: September 2010 59 59 Contact: Richard Cochran <richardcochran@gmail.com> 60 60 Description: 61 61 This file contains the number of programmable periodic 62 62 output channels offered by the PTP hardware clock. 63 63 64 - What: /sys/class/ptp/ptpN/n_pins 64 + What: /sys/class/ptp/ptp<N>/n_pins 65 65 Date: March 2014 66 66 Contact: Richard Cochran <richardcochran@gmail.com> 67 67 Description: 68 68 This file contains the number of programmable pins 69 69 offered by the PTP hardware clock. 70 70 71 - What: /sys/class/ptp/ptpN/n_vclocks 71 + What: /sys/class/ptp/ptp<N>/n_vclocks 72 72 Date: May 2021 73 73 Contact: Yangbo Lu <yangbo.lu@nxp.com> 74 74 Description: ··· 81 81 switches the physical clock back to normal, adjustable 82 82 operation. 83 83 84 - What: /sys/class/ptp/ptpN/pins 84 + What: /sys/class/ptp/ptp<N>/pins 85 85 Date: March 2014 86 86 Contact: Richard Cochran <richardcochran@gmail.com> 87 87 Description: ··· 94 94 assignment may be changed by two writing numbers into 95 95 the file. 96 96 97 - What: /sys/class/ptp/ptpN/pps_available 97 + What: /sys/class/ptp/ptp<N>/pps_available 98 98 Date: September 2010 99 99 Contact: Richard Cochran <richardcochran@gmail.com> 100 100 Description: ··· 103 103 "1" means that the PPS is supported, while "0" means 104 104 not supported. 105 105 106 - What: /sys/class/ptp/ptpN/extts_enable 106 + What: /sys/class/ptp/ptp<N>/extts_enable 107 107 Date: September 2010 108 108 Contact: Richard Cochran <richardcochran@gmail.com> 109 109 Description: ··· 113 113 To disable external timestamps, write the channel 114 114 index followed by a "0" into the file. 115 115 116 - What: /sys/class/ptp/ptpN/fifo 116 + What: /sys/class/ptp/ptp<N>/fifo 117 117 Date: September 2010 118 118 Contact: Richard Cochran <richardcochran@gmail.com> 119 119 Description: ··· 121 121 the form of three integers: channel index, seconds, 122 122 and nanoseconds. 123 123 124 - What: /sys/class/ptp/ptpN/period 124 + What: /sys/class/ptp/ptp<N>/period 125 125 Date: September 2010 126 126 Contact: Richard Cochran <richardcochran@gmail.com> 127 127 Description: ··· 132 132 period nanoseconds. To disable a periodic output, set 133 133 all the seconds and nanoseconds values to zero. 134 134 135 - What: /sys/class/ptp/ptpN/pps_enable 135 + What: /sys/class/ptp/ptp<N>/pps_enable 136 136 Date: September 2010 137 137 Contact: Richard Cochran <richardcochran@gmail.com> 138 138 Description: