summaryrefslogtreecommitdiff
path: root/include/linux/ptp_clock_kernel.h
diff options
context:
space:
mode:
authorRichard Cochran <richardcochran@gmail.com>2012-09-22 11:02:04 +0400
committerDavid S. Miller <davem@davemloft.net>2012-09-22 23:42:46 +0400
commitde46584675fad02b7f8255f31be0ea1be5cd185b (patch)
tree45fe54d42a38c2f1293fc6137f2f1ebae62ef88e /include/linux/ptp_clock_kernel.h
parent1ef761582c074448bae5be97abde5934667e7710 (diff)
downloadlinux-de46584675fad02b7f8255f31be0ea1be5cd185b.tar.xz
ptp: clarify the clock_name sysfs attribute
There has been some confusion among PHC driver authors about the intended purpose of the clock_name attribute. This patch expands the documation in order to clarify how the clock_name field should be understood. Signed-off-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'include/linux/ptp_clock_kernel.h')
-rw-r--r--include/linux/ptp_clock_kernel.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/linux/ptp_clock_kernel.h b/include/linux/ptp_clock_kernel.h
index 56c71b27112e..f2dc6d8fc680 100644
--- a/include/linux/ptp_clock_kernel.h
+++ b/include/linux/ptp_clock_kernel.h
@@ -42,7 +42,9 @@ struct ptp_clock_request {
* struct ptp_clock_info - decribes a PTP hardware clock
*
* @owner: The clock driver should set to THIS_MODULE.
- * @name: A short name to identify the clock.
+ * @name: A short "friendly name" to identify the clock and to
+ * help distinguish PHY based devices from MAC based ones.
+ * The string is not meant to be a unique id.
* @max_adj: The maximum possible frequency adjustment, in parts per billon.
* @n_alarm: The number of programmable alarms.
* @n_ext_ts: The number of external time stamp channels.