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 22 #ifndef _PTP_CLOCK_H_ 23 #define _PTP_CLOCK_H_ 24 25 #include <linux/ioctl.h> 26 #include <linux/types.h> 27 28 /* 29 * Bits of the ptp_extts_request.flags field: 30 */ 31 #define PTP_ENABLE_FEATURE (1<<0) 32 #define PTP_RISING_EDGE (1<<1) 33 #define PTP_FALLING_EDGE (1<<2) 34 #define PTP_STRICT_FLAGS (1<<3) 35 #define PTP_EXTTS_EDGES (PTP_RISING_EDGE | PTP_FALLING_EDGE) 36 37 /* 38 * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl. 39 */ 40 #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \ 41 PTP_RISING_EDGE | \ 42 PTP_FALLING_EDGE | \ 43 PTP_STRICT_FLAGS) 44 45 /* 46 * flag fields valid for the original PTP_EXTTS_REQUEST ioctl. 47 * DO NOT ADD NEW FLAGS HERE. 48 */ 49 #define PTP_EXTTS_V1_VALID_FLAGS (PTP_ENABLE_FEATURE | \ 50 PTP_RISING_EDGE | \ 51 PTP_FALLING_EDGE) 52 53 /* 54 * Bits of the ptp_perout_request.flags field: 55 */ 56 #define PTP_PEROUT_ONE_SHOT (1<<0) 57 #define PTP_PEROUT_DUTY_CYCLE (1<<1) 58 59 /* 60 * flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl. 61 */ 62 #define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT | \ 63 PTP_PEROUT_DUTY_CYCLE) 64 65 /* 66 * No flags are valid for the original PTP_PEROUT_REQUEST ioctl 67 */ 68 #define PTP_PEROUT_V1_VALID_FLAGS (0) 69 70 /* 71 * struct ptp_clock_time - represents a time value 72 * 73 * The sign of the seconds field applies to the whole value. The 74 * nanoseconds field is always unsigned. The reserved field is 75 * included for sub-nanosecond resolution, should the demand for 76 * this ever appear. 77 * 78 */ 79 struct ptp_clock_time { 80 __s64 sec; /* seconds */ 81 __u32 nsec; /* nanoseconds */ 82 __u32 reserved; 83 }; 84 85 struct ptp_clock_caps { 86 int max_adj; /* Maximum frequency adjustment in parts per billon. */ 87 int n_alarm; /* Number of programmable alarms. */ 88 int n_ext_ts; /* Number of external time stamp channels. */ 89 int n_per_out; /* Number of programmable periodic signals. */ 90 int pps; /* Whether the clock supports a PPS callback. */ 91 int n_pins; /* Number of input/output pins. */ 92 /* Whether the clock supports precise system-device cross timestamps */ 93 int cross_timestamping; 94 /* Whether the clock supports adjust phase */ 95 int adjust_phase; 96 int rsv[12]; /* Reserved for future use. */ 97 }; 98 99 struct ptp_extts_request { 100 unsigned int index; /* Which channel to configure. */ 101 unsigned int flags; /* Bit field for PTP_xxx flags. */ 102 unsigned int rsv[2]; /* Reserved for future use. */ 103 }; 104 105 struct ptp_perout_request { 106 struct ptp_clock_time start; /* Absolute start time. */ 107 struct ptp_clock_time period; /* Desired period, zero means disable. */ 108 unsigned int index; /* Which channel to configure. */ 109 unsigned int flags; 110 union { 111 /* 112 * The "on" time of the signal. 113 * Must be lower than the period. 114 * Valid only if (flags & PTP_PEROUT_DUTY_CYCLE) is set. 115 */ 116 struct ptp_clock_time on; 117 /* Reserved for future use. */ 118 unsigned int rsv[4]; 119 }; 120 }; 121 122 #define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */ 123 124 struct ptp_sys_offset { 125 unsigned int n_samples; /* Desired number of measurements. */ 126 unsigned int rsv[3]; /* Reserved for future use. */ 127 /* 128 * Array of interleaved system/phc time stamps. The kernel 129 * will provide 2*n_samples + 1 time stamps, with the last 130 * one as a system time stamp. 131 */ 132 struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1]; 133 }; 134 135 struct ptp_sys_offset_extended { 136 unsigned int n_samples; /* Desired number of measurements. */ 137 unsigned int rsv[3]; /* Reserved for future use. */ 138 /* 139 * Array of [system, phc, system] time stamps. The kernel will provide 140 * 3*n_samples time stamps. 141 */ 142 struct ptp_clock_time ts[PTP_MAX_SAMPLES][3]; 143 }; 144 145 struct ptp_sys_offset_precise { 146 struct ptp_clock_time device; 147 struct ptp_clock_time sys_realtime; 148 struct ptp_clock_time sys_monoraw; 149 unsigned int rsv[4]; /* Reserved for future use. */ 150 }; 151 152 enum ptp_pin_function { 153 PTP_PF_NONE, 154 PTP_PF_EXTTS, 155 PTP_PF_PEROUT, 156 PTP_PF_PHYSYNC, 157 }; 158 159 struct ptp_pin_desc { 160 /* 161 * Hardware specific human readable pin name. This field is 162 * set by the kernel during the PTP_PIN_GETFUNC ioctl and is 163 * ignored for the PTP_PIN_SETFUNC ioctl. 164 */ 165 char name[64]; 166 /* 167 * Pin index in the range of zero to ptp_clock_caps.n_pins - 1. 168 */ 169 unsigned int index; 170 /* 171 * Which of the PTP_PF_xxx functions to use on this pin. 172 */ 173 unsigned int func; 174 /* 175 * The specific channel to use for this function. 176 * This corresponds to the 'index' field of the 177 * PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls. 178 */ 179 unsigned int chan; 180 /* 181 * Reserved for future use. 182 */ 183 unsigned int rsv[5]; 184 }; 185 186 #define PTP_CLK_MAGIC '=' 187 188 #define PTP_CLOCK_GETCAPS _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps) 189 #define PTP_EXTTS_REQUEST _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request) 190 #define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request) 191 #define PTP_ENABLE_PPS _IOW(PTP_CLK_MAGIC, 4, int) 192 #define PTP_SYS_OFFSET _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset) 193 #define PTP_PIN_GETFUNC _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc) 194 #define PTP_PIN_SETFUNC _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc) 195 #define PTP_SYS_OFFSET_PRECISE \ 196 _IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise) 197 #define PTP_SYS_OFFSET_EXTENDED \ 198 _IOWR(PTP_CLK_MAGIC, 9, struct ptp_sys_offset_extended) 199 200 #define PTP_CLOCK_GETCAPS2 _IOR(PTP_CLK_MAGIC, 10, struct ptp_clock_caps) 201 #define PTP_EXTTS_REQUEST2 _IOW(PTP_CLK_MAGIC, 11, struct ptp_extts_request) 202 #define PTP_PEROUT_REQUEST2 _IOW(PTP_CLK_MAGIC, 12, struct ptp_perout_request) 203 #define PTP_ENABLE_PPS2 _IOW(PTP_CLK_MAGIC, 13, int) 204 #define PTP_SYS_OFFSET2 _IOW(PTP_CLK_MAGIC, 14, struct ptp_sys_offset) 205 #define PTP_PIN_GETFUNC2 _IOWR(PTP_CLK_MAGIC, 15, struct ptp_pin_desc) 206 #define PTP_PIN_SETFUNC2 _IOW(PTP_CLK_MAGIC, 16, struct ptp_pin_desc) 207 #define PTP_SYS_OFFSET_PRECISE2 \ 208 _IOWR(PTP_CLK_MAGIC, 17, struct ptp_sys_offset_precise) 209 #define PTP_SYS_OFFSET_EXTENDED2 \ 210 _IOWR(PTP_CLK_MAGIC, 18, struct ptp_sys_offset_extended) 211 212 struct ptp_extts_event { 213 struct ptp_clock_time t; /* Time event occured. */ 214 unsigned int index; /* Which channel produced the event. */ 215 unsigned int flags; /* Reserved for future use. */ 216 unsigned int rsv[2]; /* Reserved for future use. */ 217 }; 218 219 #endif 220