[linux-block.git] / include / uapi / linux / ptp_clock.h

/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
/*
 * PTP 1588 clock support - user space interface
 *
 * Copyright (C) 2010 OMICRON electronics GmbH
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _PTP_CLOCK_H_
#define _PTP_CLOCK_H_

#include <linux/ioctl.h>
#include <linux/types.h>

/*
 * Bits of the ptp_extts_request.flags field:
 */
#define PTP_ENABLE_FEATURE (1<<0)
#define PTP_RISING_EDGE    (1<<1)
#define PTP_FALLING_EDGE   (1<<2)
#define PTP_STRICT_FLAGS   (1<<3)
#define PTP_EXTTS_EDGES    (PTP_RISING_EDGE | PTP_FALLING_EDGE)

/*
 * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl.
 */
#define PTP_EXTTS_VALID_FLAGS	(PTP_ENABLE_FEATURE |	\
				 PTP_RISING_EDGE |	\
				 PTP_FALLING_EDGE |	\
				 PTP_STRICT_FLAGS)

/*
 * flag fields valid for the original PTP_EXTTS_REQUEST ioctl.
 * DO NOT ADD NEW FLAGS HERE.
 */
#define PTP_EXTTS_V1_VALID_FLAGS	(PTP_ENABLE_FEATURE |	\
					 PTP_RISING_EDGE |	\
					 PTP_FALLING_EDGE)

/*
 * Bits of the ptp_perout_request.flags field:
 */
#define PTP_PEROUT_ONE_SHOT (1<<0)

/*
 * flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl.
 */
#define PTP_PEROUT_VALID_FLAGS	(PTP_PEROUT_ONE_SHOT)

/*
 * No flags are valid for the original PTP_PEROUT_REQUEST ioctl
 */
#define PTP_PEROUT_V1_VALID_FLAGS	(0)

/*
 * struct ptp_clock_time - represents a time value
 *
 * The sign of the seconds field applies to the whole value. The
 * nanoseconds field is always unsigned. The reserved field is
 * included for sub-nanosecond resolution, should the demand for
 * this ever appear.
 *
 */
struct ptp_clock_time {
	__s64 sec;  /* seconds */
	__u32 nsec; /* nanoseconds */
	__u32 reserved;
};

struct ptp_clock_caps {
	int max_adj;   /* Maximum frequency adjustment in parts per billon. */
	int n_alarm;   /* Number of programmable alarms. */
	int n_ext_ts;  /* Number of external time stamp channels. */
	int n_per_out; /* Number of programmable periodic signals. */
	int pps;       /* Whether the clock supports a PPS callback. */
	int n_pins;    /* Number of input/output pins. */
	/* Whether the clock supports precise system-device cross timestamps */
	int cross_timestamping;
	int rsv[13];   /* Reserved for future use. */
};

struct ptp_extts_request {
	unsigned int index;  /* Which channel to configure. */
	unsigned int flags;  /* Bit field for PTP_xxx flags. */
	unsigned int rsv[2]; /* Reserved for future use. */
};

struct ptp_perout_request {
	struct ptp_clock_time start;  /* Absolute start time. */
	struct ptp_clock_time period; /* Desired period, zero means disable. */
	unsigned int index;           /* Which channel to configure. */
	unsigned int flags;
	unsigned int rsv[4];          /* Reserved for future use. */
};

#define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */

struct ptp_sys_offset {
	unsigned int n_samples; /* Desired number of measurements. */
	unsigned int rsv[3];    /* Reserved for future use. */
	/*
	 * Array of interleaved system/phc time stamps. The kernel
	 * will provide 2*n_samples + 1 time stamps, with the last
	 * one as a system time stamp.
	 */
	struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1];
};

struct ptp_sys_offset_extended {
	unsigned int n_samples; /* Desired number of measurements. */
	unsigned int rsv[3];    /* Reserved for future use. */
	/*
	 * Array of [system, phc, system] time stamps. The kernel will provide
	 * 3*n_samples time stamps.
	 */
	struct ptp_clock_time ts[PTP_MAX_SAMPLES][3];
};

struct ptp_sys_offset_precise {
	struct ptp_clock_time device;
	struct ptp_clock_time sys_realtime;
	struct ptp_clock_time sys_monoraw;
	unsigned int rsv[4];    /* Reserved for future use. */
};

enum ptp_pin_function {
	PTP_PF_NONE,
	PTP_PF_EXTTS,
	PTP_PF_PEROUT,
	PTP_PF_PHYSYNC,
};

struct ptp_pin_desc {
	/*
	 * Hardware specific human readable pin name. This field is
	 * set by the kernel during the PTP_PIN_GETFUNC ioctl and is
	 * ignored for the PTP_PIN_SETFUNC ioctl.
	 */
	char name[64];
	/*
	 * Pin index in the range of zero to ptp_clock_caps.n_pins - 1.
	 */
	unsigned int index;
	/*
	 * Which of the PTP_PF_xxx functions to use on this pin.
	 */
	unsigned int func;
	/*
	 * The specific channel to use for this function.
	 * This corresponds to the 'index' field of the
	 * PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls.
	 */
	unsigned int chan;
	/*
	 * Reserved for future use.
	 */
	unsigned int rsv[5];
};

#define PTP_CLK_MAGIC '='

#define PTP_CLOCK_GETCAPS  _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps)
#define PTP_EXTTS_REQUEST  _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request)
#define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request)
#define PTP_ENABLE_PPS     _IOW(PTP_CLK_MAGIC, 4, int)
#define PTP_SYS_OFFSET     _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset)
#define PTP_PIN_GETFUNC    _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc)
#define PTP_PIN_SETFUNC    _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc)
#define PTP_SYS_OFFSET_PRECISE \
	_IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise)
#define PTP_SYS_OFFSET_EXTENDED \
	_IOWR(PTP_CLK_MAGIC, 9, struct ptp_sys_offset_extended)

#define PTP_CLOCK_GETCAPS2  _IOR(PTP_CLK_MAGIC, 10, struct ptp_clock_caps)
#define PTP_EXTTS_REQUEST2  _IOW(PTP_CLK_MAGIC, 11, struct ptp_extts_request)
#define PTP_PEROUT_REQUEST2 _IOW(PTP_CLK_MAGIC, 12, struct ptp_perout_request)
#define PTP_ENABLE_PPS2     _IOW(PTP_CLK_MAGIC, 13, int)
#define PTP_SYS_OFFSET2     _IOW(PTP_CLK_MAGIC, 14, struct ptp_sys_offset)
#define PTP_PIN_GETFUNC2    _IOWR(PTP_CLK_MAGIC, 15, struct ptp_pin_desc)
#define PTP_PIN_SETFUNC2    _IOW(PTP_CLK_MAGIC, 16, struct ptp_pin_desc)
#define PTP_SYS_OFFSET_PRECISE2 \
	_IOWR(PTP_CLK_MAGIC, 17, struct ptp_sys_offset_precise)
#define PTP_SYS_OFFSET_EXTENDED2 \
	_IOWR(PTP_CLK_MAGIC, 18, struct ptp_sys_offset_extended)

struct ptp_extts_event {
	struct ptp_clock_time t; /* Time event occured. */
	unsigned int index;      /* Which channel produced the event. */
	unsigned int flags;      /* Reserved for future use. */
	unsigned int rsv[2];     /* Reserved for future use. */
};

#endif
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
d94ba80e RC	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
41560658 FB	28	/*
	29	* Bits of the ptp_extts_request.flags field:
	30	*/
d94ba80e RC	31	#define PTP_ENABLE_FEATURE (1<<0)
	32	#define PTP_RISING_EDGE (1<<1)
	33	#define PTP_FALLING_EDGE (1<<2)
6138e687	34	#define PTP_STRICT_FLAGS (1<<3)
cd734d54	35	#define PTP_EXTTS_EDGES (PTP_RISING_EDGE \| PTP_FALLING_EDGE)
2df4de16 JK	36
	37	/*
	38	* flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl.
	39	*/
41560658 FB	40	#define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE \| \
41560658 FB	41	PTP_RISING_EDGE \| \
6138e687 RC	42	PTP_FALLING_EDGE \| \
6138e687 RC	43	PTP_STRICT_FLAGS)
41560658	44
2df4de16 JK	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
41560658 FB	53	/*
	54	* Bits of the ptp_perout_request.flags field:
	55	*/
823eb2a3	56	#define PTP_PEROUT_ONE_SHOT (1<<0)
2df4de16 JK	57
	58	/*
	59	* flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl.
	60	*/
823eb2a3	61	#define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT)
2df4de16 JK	62
	63	/*
	64	* No flags are valid for the original PTP_PEROUT_REQUEST ioctl
	65	*/
	66	#define PTP_PEROUT_V1_VALID_FLAGS (0)
	67
d94ba80e RC	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	*/
	77	struct ptp_clock_time {
	78	__s64 sec; /* seconds */
	79	__u32 nsec; /* nanoseconds */
	80	__u32 reserved;
	81	};
	82
	83	struct 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. */
6092315d	89	int n_pins; /* Number of input/output pins. */
719f1aa4 CH	90	/* Whether the clock supports precise system-device cross timestamps */
	91	int cross_timestamping;
	92	int rsv[13]; /* Reserved for future use. */
d94ba80e RC	93	};
	94
	95	struct ptp_extts_request {
	96	unsigned int index; /* Which channel to configure. */
	97	unsigned int flags; /* Bit field for PTP_xxx flags. */
	98	unsigned int rsv[2]; /* Reserved for future use. */
	99	};
	100
	101	struct ptp_perout_request {
	102	struct ptp_clock_time start; /* Absolute start time. */
	103	struct ptp_clock_time period; /* Desired period, zero means disable. */
	104	unsigned int index; /* Which channel to configure. */
823eb2a3	105	unsigned int flags;
d94ba80e RC	106	unsigned int rsv[4]; /* Reserved for future use. */
	107	};
	108
215b13dd RC	109	#define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */
	110
	111	struct ptp_sys_offset {
	112	unsigned int n_samples; /* Desired number of measurements. */
	113	unsigned int rsv[3]; /* Reserved for future use. */
	114	/*
	115	* Array of interleaved system/phc time stamps. The kernel
	116	* will provide 2*n_samples + 1 time stamps, with the last
	117	* one as a system time stamp.
	118	*/
	119	struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1];
	120	};
	121
36180087 ML	122	struct ptp_sys_offset_extended {
	123	unsigned int n_samples; /* Desired number of measurements. */
	124	unsigned int rsv[3]; /* Reserved for future use. */
	125	/*
	126	* Array of [system, phc, system] time stamps. The kernel will provide
	127	* 3*n_samples time stamps.
	128	*/
	129	struct ptp_clock_time ts[PTP_MAX_SAMPLES][3];
	130	};
	131
719f1aa4 CH	132	struct ptp_sys_offset_precise {
	133	struct ptp_clock_time device;
	134	struct ptp_clock_time sys_realtime;
	135	struct ptp_clock_time sys_monoraw;
	136	unsigned int rsv[4]; /* Reserved for future use. */
	137	};
	138
6092315d RC	139	enum ptp_pin_function {
	140	PTP_PF_NONE,
	141	PTP_PF_EXTTS,
	142	PTP_PF_PEROUT,
	143	PTP_PF_PHYSYNC,
	144	};
	145
	146	struct ptp_pin_desc {
	147	/*
	148	* Hardware specific human readable pin name. This field is
	149	* set by the kernel during the PTP_PIN_GETFUNC ioctl and is
	150	* ignored for the PTP_PIN_SETFUNC ioctl.
	151	*/
	152	char name[64];
	153	/*
	154	* Pin index in the range of zero to ptp_clock_caps.n_pins - 1.
	155	*/
	156	unsigned int index;
	157	/*
	158	* Which of the PTP_PF_xxx functions to use on this pin.
	159	*/
	160	unsigned int func;
	161	/*
	162	* The specific channel to use for this function.
	163	* This corresponds to the 'index' field of the
	164	* PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls.
	165	*/
	166	unsigned int chan;
	167	/*
	168	* Reserved for future use.
	169	*/
	170	unsigned int rsv[5];
	171	};
	172
d94ba80e RC	173	#define PTP_CLK_MAGIC '='
	174
	175	#define PTP_CLOCK_GETCAPS _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps)
	176	#define PTP_EXTTS_REQUEST _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request)
	177	#define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request)
	178	#define PTP_ENABLE_PPS _IOW(PTP_CLK_MAGIC, 4, int)
215b13dd	179	#define PTP_SYS_OFFSET _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset)
6092315d RC	180	#define PTP_PIN_GETFUNC _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc)
6092315d RC	181	#define PTP_PIN_SETFUNC _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc)
719f1aa4 CH	182	#define PTP_SYS_OFFSET_PRECISE \
719f1aa4 CH	183	_IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise)
36180087	184	#define PTP_SYS_OFFSET_EXTENDED \
b7ea4894	185	_IOWR(PTP_CLK_MAGIC, 9, struct ptp_sys_offset_extended)
d94ba80e	186
41560658 FB	187	#define PTP_CLOCK_GETCAPS2 _IOR(PTP_CLK_MAGIC, 10, struct ptp_clock_caps)
	188	#define PTP_EXTTS_REQUEST2 _IOW(PTP_CLK_MAGIC, 11, struct ptp_extts_request)
	189	#define PTP_PEROUT_REQUEST2 _IOW(PTP_CLK_MAGIC, 12, struct ptp_perout_request)
	190	#define PTP_ENABLE_PPS2 _IOW(PTP_CLK_MAGIC, 13, int)
	191	#define PTP_SYS_OFFSET2 _IOW(PTP_CLK_MAGIC, 14, struct ptp_sys_offset)
	192	#define PTP_PIN_GETFUNC2 _IOWR(PTP_CLK_MAGIC, 15, struct ptp_pin_desc)
	193	#define PTP_PIN_SETFUNC2 _IOW(PTP_CLK_MAGIC, 16, struct ptp_pin_desc)
	194	#define PTP_SYS_OFFSET_PRECISE2 \
	195	_IOWR(PTP_CLK_MAGIC, 17, struct ptp_sys_offset_precise)
	196	#define PTP_SYS_OFFSET_EXTENDED2 \
	197	_IOWR(PTP_CLK_MAGIC, 18, struct ptp_sys_offset_extended)
	198
d94ba80e RC	199	struct ptp_extts_event {
	200	struct ptp_clock_time t; /* Time event occured. */
	201	unsigned int index; /* Which channel produced the event. */
	202	unsigned int flags; /* Reserved for future use. */
	203	unsigned int rsv[2]; /* Reserved for future use. */
	204	};
	205
	206	#endif