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