ptp_clock.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
  2. /*
  3. * PTP 1588 clock support - user space interface
  4. *
  5. * Copyright (C) 2010 OMICRON electronics GmbH
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, write to the Free Software
  19. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20. */
  21. #ifndef _PTP_CLOCK_H_
  22. #define _PTP_CLOCK_H_
  23. #include <linux/ioctl.h>
  24. #include <linux/types.h>
  25. /*
  26. * Bits of the ptp_extts_request.flags field:
  27. */
  28. #define PTP_ENABLE_FEATURE (1<<0)
  29. #define PTP_RISING_EDGE (1<<1)
  30. #define PTP_FALLING_EDGE (1<<2)
  31. #define PTP_STRICT_FLAGS (1<<3)
  32. #define PTP_EXTTS_EDGES (PTP_RISING_EDGE | PTP_FALLING_EDGE)
  33. /*
  34. * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl.
  35. */
  36. #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \
  37. PTP_RISING_EDGE | \
  38. PTP_FALLING_EDGE | \
  39. PTP_STRICT_FLAGS)
  40. /*
  41. * flag fields valid for the original PTP_EXTTS_REQUEST ioctl.
  42. * DO NOT ADD NEW FLAGS HERE.
  43. */
  44. #define PTP_EXTTS_V1_VALID_FLAGS (PTP_ENABLE_FEATURE | \
  45. PTP_RISING_EDGE | \
  46. PTP_FALLING_EDGE)
  47. /*
  48. * Bits of the ptp_perout_request.flags field:
  49. */
  50. #define PTP_PEROUT_ONE_SHOT (1<<0)
  51. /*
  52. * flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl.
  53. */
  54. #define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT)
  55. /*
  56. * No flags are valid for the original PTP_PEROUT_REQUEST ioctl
  57. */
  58. #define PTP_PEROUT_V1_VALID_FLAGS (0)
  59. /*
  60. * struct ptp_clock_time - represents a time value
  61. *
  62. * The sign of the seconds field applies to the whole value. The
  63. * nanoseconds field is always unsigned. The reserved field is
  64. * included for sub-nanosecond resolution, should the demand for
  65. * this ever appear.
  66. *
  67. */
  68. struct ptp_clock_time {
  69. __s64 sec; /* seconds */
  70. __u32 nsec; /* nanoseconds */
  71. __u32 reserved;
  72. };
  73. struct ptp_clock_caps {
  74. int max_adj; /* Maximum frequency adjustment in parts per billon. */
  75. int n_alarm; /* Number of programmable alarms. */
  76. int n_ext_ts; /* Number of external time stamp channels. */
  77. int n_per_out; /* Number of programmable periodic signals. */
  78. int pps; /* Whether the clock supports a PPS callback. */
  79. int n_pins; /* Number of input/output pins. */
  80. /* Whether the clock supports precise system-device cross timestamps */
  81. int cross_timestamping;
  82. int rsv[13]; /* Reserved for future use. */
  83. };
  84. struct ptp_extts_request {
  85. unsigned int index; /* Which channel to configure. */
  86. unsigned int flags; /* Bit field for PTP_xxx flags. */
  87. unsigned int rsv[2]; /* Reserved for future use. */
  88. };
  89. struct ptp_perout_request {
  90. struct ptp_clock_time start; /* Absolute start time. */
  91. struct ptp_clock_time period; /* Desired period, zero means disable. */
  92. unsigned int index; /* Which channel to configure. */
  93. unsigned int flags;
  94. unsigned int rsv[4]; /* Reserved for future use. */
  95. };
  96. #define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */
  97. struct ptp_sys_offset {
  98. unsigned int n_samples; /* Desired number of measurements. */
  99. unsigned int rsv[3]; /* Reserved for future use. */
  100. /*
  101. * Array of interleaved system/phc time stamps. The kernel
  102. * will provide 2*n_samples + 1 time stamps, with the last
  103. * one as a system time stamp.
  104. */
  105. struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1];
  106. };
  107. struct ptp_sys_offset_extended {
  108. unsigned int n_samples; /* Desired number of measurements. */
  109. unsigned int rsv[3]; /* Reserved for future use. */
  110. /*
  111. * Array of [system, phc, system] time stamps. The kernel will provide
  112. * 3*n_samples time stamps.
  113. */
  114. struct ptp_clock_time ts[PTP_MAX_SAMPLES][3];
  115. };
  116. struct ptp_sys_offset_precise {
  117. struct ptp_clock_time device;
  118. struct ptp_clock_time sys_realtime;
  119. struct ptp_clock_time sys_monoraw;
  120. unsigned int rsv[4]; /* Reserved for future use. */
  121. };
  122. enum ptp_pin_function {
  123. PTP_PF_NONE,
  124. PTP_PF_EXTTS,
  125. PTP_PF_PEROUT,
  126. PTP_PF_PHYSYNC,
  127. };
  128. struct ptp_pin_desc {
  129. /*
  130. * Hardware specific human readable pin name. This field is
  131. * set by the kernel during the PTP_PIN_GETFUNC ioctl and is
  132. * ignored for the PTP_PIN_SETFUNC ioctl.
  133. */
  134. char name[64];
  135. /*
  136. * Pin index in the range of zero to ptp_clock_caps.n_pins - 1.
  137. */
  138. unsigned int index;
  139. /*
  140. * Which of the PTP_PF_xxx functions to use on this pin.
  141. */
  142. unsigned int func;
  143. /*
  144. * The specific channel to use for this function.
  145. * This corresponds to the 'index' field of the
  146. * PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls.
  147. */
  148. unsigned int chan;
  149. /*
  150. * Reserved for future use.
  151. */
  152. unsigned int rsv[5];
  153. };
  154. #define PTP_CLK_MAGIC '='
  155. #define PTP_CLOCK_GETCAPS _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps)
  156. #define PTP_EXTTS_REQUEST _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request)
  157. #define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request)
  158. #define PTP_ENABLE_PPS _IOW(PTP_CLK_MAGIC, 4, int)
  159. #define PTP_SYS_OFFSET _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset)
  160. #define PTP_PIN_GETFUNC _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc)
  161. #define PTP_PIN_SETFUNC _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc)
  162. #define PTP_SYS_OFFSET_PRECISE \
  163. _IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise)
  164. #define PTP_SYS_OFFSET_EXTENDED \
  165. _IOWR(PTP_CLK_MAGIC, 9, struct ptp_sys_offset_extended)
  166. #define PTP_CLOCK_GETCAPS2 _IOR(PTP_CLK_MAGIC, 10, struct ptp_clock_caps)
  167. #define PTP_EXTTS_REQUEST2 _IOW(PTP_CLK_MAGIC, 11, struct ptp_extts_request)
  168. #define PTP_PEROUT_REQUEST2 _IOW(PTP_CLK_MAGIC, 12, struct ptp_perout_request)
  169. #define PTP_ENABLE_PPS2 _IOW(PTP_CLK_MAGIC, 13, int)
  170. #define PTP_SYS_OFFSET2 _IOW(PTP_CLK_MAGIC, 14, struct ptp_sys_offset)
  171. #define PTP_PIN_GETFUNC2 _IOWR(PTP_CLK_MAGIC, 15, struct ptp_pin_desc)
  172. #define PTP_PIN_SETFUNC2 _IOW(PTP_CLK_MAGIC, 16, struct ptp_pin_desc)
  173. #define PTP_SYS_OFFSET_PRECISE2 \
  174. _IOWR(PTP_CLK_MAGIC, 17, struct ptp_sys_offset_precise)
  175. #define PTP_SYS_OFFSET_EXTENDED2 \
  176. _IOWR(PTP_CLK_MAGIC, 18, struct ptp_sys_offset_extended)
  177. struct ptp_extts_event {
  178. struct ptp_clock_time t; /* Time event occured. */
  179. unsigned int index; /* Which channel produced the event. */
  180. unsigned int flags; /* Reserved for future use. */
  181. unsigned int rsv[2]; /* Reserved for future use. */
  182. };
  183. #endif