pps.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. /*
  2. * PPS API header
  3. *
  4. * Copyright (C) 2005-2009 Rodolfo Giometti <giometti@linux.it>
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19. */
  20. #ifndef _PPS_H_
  21. #define _PPS_H_
  22. #include <linux/types.h>
  23. #define PPS_VERSION "5.3.6"
  24. #define PPS_MAX_SOURCES 16 /* should be enough... */
  25. /* Implementation note: the logical states ``assert'' and ``clear''
  26. * are implemented in terms of the chip register, i.e. ``assert''
  27. * means the bit is set. */
  28. /*
  29. * 3.2 New data structures
  30. */
  31. #define PPS_API_VERS_1 1
  32. #define PPS_API_VERS PPS_API_VERS_1 /* we use API version 1 */
  33. #define PPS_MAX_NAME_LEN 32
  34. /* 32-bit vs. 64-bit compatibility.
  35. *
  36. * 0n i386, the alignment of a uint64_t is only 4 bytes, while on most other
  37. * architectures it's 8 bytes. On i386, there will be no padding between the
  38. * two consecutive 'struct pps_ktime' members of struct pps_kinfo and struct
  39. * pps_kparams. But on most platforms there will be padding to ensure correct
  40. * alignment.
  41. *
  42. * The simple fix is probably to add an explicit padding.
  43. * [David Woodhouse]
  44. */
  45. struct pps_ktime {
  46. __s64 sec;
  47. __s32 nsec;
  48. __u32 flags;
  49. };
  50. #define PPS_TIME_INVALID (1<<0) /* used to specify timeout==NULL */
  51. struct pps_kinfo {
  52. __u32 assert_sequence; /* seq. num. of assert event */
  53. __u32 clear_sequence; /* seq. num. of clear event */
  54. struct pps_ktime assert_tu; /* time of assert event */
  55. struct pps_ktime clear_tu; /* time of clear event */
  56. int current_mode; /* current mode bits */
  57. };
  58. struct pps_kparams {
  59. int api_version; /* API version # */
  60. int mode; /* mode bits */
  61. struct pps_ktime assert_off_tu; /* offset compensation for assert */
  62. struct pps_ktime clear_off_tu; /* offset compensation for clear */
  63. };
  64. /*
  65. * 3.3 Mode bit definitions
  66. */
  67. /* Device/implementation parameters */
  68. #define PPS_CAPTUREASSERT 0x01 /* capture assert events */
  69. #define PPS_CAPTURECLEAR 0x02 /* capture clear events */
  70. #define PPS_CAPTUREBOTH 0x03 /* capture assert and clear events */
  71. #define PPS_OFFSETASSERT 0x10 /* apply compensation for assert ev. */
  72. #define PPS_OFFSETCLEAR 0x20 /* apply compensation for clear ev. */
  73. #define PPS_CANWAIT 0x100 /* can we wait for an event? */
  74. #define PPS_CANPOLL 0x200 /* bit reserved for future use */
  75. /* Kernel actions */
  76. #define PPS_ECHOASSERT 0x40 /* feed back assert event to output */
  77. #define PPS_ECHOCLEAR 0x80 /* feed back clear event to output */
  78. /* Timestamp formats */
  79. #define PPS_TSFMT_TSPEC 0x1000 /* select timespec format */
  80. #define PPS_TSFMT_NTPFP 0x2000 /* select NTP format */
  81. /*
  82. * 3.4.4 New functions: disciplining the kernel timebase
  83. */
  84. /* Kernel consumers */
  85. #define PPS_KC_HARDPPS 0 /* hardpps() (or equivalent) */
  86. #define PPS_KC_HARDPPS_PLL 1 /* hardpps() constrained to
  87. use a phase-locked loop */
  88. #define PPS_KC_HARDPPS_FLL 2 /* hardpps() constrained to
  89. use a frequency-locked loop */
  90. /*
  91. * Here begins the implementation-specific part!
  92. */
  93. struct pps_fdata {
  94. struct pps_kinfo info;
  95. struct pps_ktime timeout;
  96. };
  97. struct pps_bind_args {
  98. int tsformat; /* format of time stamps */
  99. int edge; /* selected event type */
  100. int consumer; /* selected kernel consumer */
  101. };
  102. #include <linux/ioctl.h>
  103. #define PPS_GETPARAMS _IOR('p', 0xa1, struct pps_kparams *)
  104. #define PPS_SETPARAMS _IOW('p', 0xa2, struct pps_kparams *)
  105. #define PPS_GETCAP _IOR('p', 0xa3, int *)
  106. #define PPS_FETCH _IOWR('p', 0xa4, struct pps_fdata *)
  107. #define PPS_KC_BIND _IOW('p', 0xa5, struct pps_bind_args *)
  108. #endif /* _PPS_H_ */