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