blob: b8b73066d1379087f1ecd5bd40dbf719ad2af4ad [file] [log] [blame]
Richard Cochrand94ba802011-04-22 12:03:08 +02001/*
2 * PTP 1588 clock support
3 *
4 * Copyright (C) 2010 OMICRON electronics GmbH
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
21#ifndef _PTP_CLOCK_KERNEL_H_
22#define _PTP_CLOCK_KERNEL_H_
23
Richard Cochran1ef76152012-09-22 07:02:03 +000024#include <linux/device.h>
Ben Hutchings220a60a2012-09-03 11:34:58 +010025#include <linux/pps_kernel.h>
Richard Cochrand94ba802011-04-22 12:03:08 +020026#include <linux/ptp_clock.h>
27
28
29struct ptp_clock_request {
30 enum {
31 PTP_CLK_REQ_EXTTS,
32 PTP_CLK_REQ_PEROUT,
33 PTP_CLK_REQ_PPS,
34 } type;
35 union {
36 struct ptp_extts_request extts;
37 struct ptp_perout_request perout;
38 };
39};
40
41/**
42 * struct ptp_clock_info - decribes a PTP hardware clock
43 *
44 * @owner: The clock driver should set to THIS_MODULE.
Richard Cochrande465842012-09-22 07:02:04 +000045 * @name: A short "friendly name" to identify the clock and to
46 * help distinguish PHY based devices from MAC based ones.
47 * The string is not meant to be a unique id.
Richard Cochrand94ba802011-04-22 12:03:08 +020048 * @max_adj: The maximum possible frequency adjustment, in parts per billon.
49 * @n_alarm: The number of programmable alarms.
50 * @n_ext_ts: The number of external time stamp channels.
51 * @n_per_out: The number of programmable periodic signals.
Richard Cochran60923152014-03-20 22:21:52 +010052 * @n_pins: The number of programmable pins.
Richard Cochrand94ba802011-04-22 12:03:08 +020053 * @pps: Indicates whether the clock supports a PPS callback.
Richard Cochran60923152014-03-20 22:21:52 +010054 * @pin_config: Array of length 'n_pins'. If the number of
55 * programmable pins is nonzero, then drivers must
56 * allocate and initialize this array.
Richard Cochrand94ba802011-04-22 12:03:08 +020057 *
58 * clock operations
59 *
60 * @adjfreq: Adjusts the frequency of the hardware clock.
Jacob Keller87f4d7c2012-11-01 12:30:16 +000061 * parameter delta: Desired frequency offset from nominal frequency
62 * in parts per billion
Richard Cochrand94ba802011-04-22 12:03:08 +020063 *
64 * @adjtime: Shifts the time of the hardware clock.
65 * parameter delta: Desired change in nanoseconds.
66 *
Richard Cochran92f17192015-03-29 23:11:51 +020067 * @gettime64: Reads the current time from the hardware clock.
68 * parameter ts: Holds the result.
69 *
70 * @settime64: Set the current time on the hardware clock.
71 * parameter ts: Time value to set.
72 *
Richard Cochrand94ba802011-04-22 12:03:08 +020073 * @enable: Request driver to enable or disable an ancillary feature.
74 * parameter request: Desired resource to enable or disable.
75 * parameter on: Caller passes one to enable or zero to disable.
76 *
Richard Cochran60923152014-03-20 22:21:52 +010077 * @verify: Confirm that a pin can perform a given function. The PTP
78 * Hardware Clock subsystem maintains the 'pin_config'
79 * array on behalf of the drivers, but the PHC subsystem
80 * assumes that every pin can perform every function. This
81 * hook gives drivers a way of telling the core about
82 * limitations on specific pins. This function must return
83 * zero if the function can be assigned to this pin, and
84 * nonzero otherwise.
85 * parameter pin: index of the pin in question.
86 * parameter func: the desired function to use.
87 * parameter chan: the function channel index to use.
88 *
Richard Cochrand94ba802011-04-22 12:03:08 +020089 * Drivers should embed their ptp_clock_info within a private
90 * structure, obtaining a reference to it using container_of().
91 *
92 * The callbacks must all return zero on success, non-zero otherwise.
93 */
94
95struct ptp_clock_info {
96 struct module *owner;
97 char name[16];
98 s32 max_adj;
99 int n_alarm;
100 int n_ext_ts;
101 int n_per_out;
Richard Cochran60923152014-03-20 22:21:52 +0100102 int n_pins;
Richard Cochrand94ba802011-04-22 12:03:08 +0200103 int pps;
Richard Cochran60923152014-03-20 22:21:52 +0100104 struct ptp_pin_desc *pin_config;
Richard Cochrand94ba802011-04-22 12:03:08 +0200105 int (*adjfreq)(struct ptp_clock_info *ptp, s32 delta);
106 int (*adjtime)(struct ptp_clock_info *ptp, s64 delta);
Richard Cochran92f17192015-03-29 23:11:51 +0200107 int (*gettime64)(struct ptp_clock_info *ptp, struct timespec64 *ts);
108 int (*settime64)(struct ptp_clock_info *p, const struct timespec64 *ts);
Richard Cochrand94ba802011-04-22 12:03:08 +0200109 int (*enable)(struct ptp_clock_info *ptp,
110 struct ptp_clock_request *request, int on);
Richard Cochran60923152014-03-20 22:21:52 +0100111 int (*verify)(struct ptp_clock_info *ptp, unsigned int pin,
112 enum ptp_pin_function func, unsigned int chan);
Richard Cochrand94ba802011-04-22 12:03:08 +0200113};
114
115struct ptp_clock;
116
117/**
118 * ptp_clock_register() - register a PTP hardware clock driver
119 *
Richard Cochran1ef76152012-09-22 07:02:03 +0000120 * @info: Structure describing the new clock.
121 * @parent: Pointer to the parent device of the new clock.
Richard Cochrand94ba802011-04-22 12:03:08 +0200122 */
123
Richard Cochran1ef76152012-09-22 07:02:03 +0000124extern struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
125 struct device *parent);
Richard Cochrand94ba802011-04-22 12:03:08 +0200126
127/**
128 * ptp_clock_unregister() - unregister a PTP hardware clock driver
129 *
130 * @ptp: The clock to remove from service.
131 */
132
133extern int ptp_clock_unregister(struct ptp_clock *ptp);
134
135
136enum ptp_clock_events {
137 PTP_CLOCK_ALARM,
138 PTP_CLOCK_EXTTS,
139 PTP_CLOCK_PPS,
Ben Hutchings220a60a2012-09-03 11:34:58 +0100140 PTP_CLOCK_PPSUSR,
Richard Cochrand94ba802011-04-22 12:03:08 +0200141};
142
143/**
144 * struct ptp_clock_event - decribes a PTP hardware clock event
145 *
146 * @type: One of the ptp_clock_events enumeration values.
147 * @index: Identifies the source of the event.
Ben Hutchings220a60a2012-09-03 11:34:58 +0100148 * @timestamp: When the event occurred (%PTP_CLOCK_EXTTS only).
149 * @pps_times: When the event occurred (%PTP_CLOCK_PPSUSR only).
Richard Cochrand94ba802011-04-22 12:03:08 +0200150 */
151
152struct ptp_clock_event {
153 int type;
154 int index;
Ben Hutchings220a60a2012-09-03 11:34:58 +0100155 union {
156 u64 timestamp;
157 struct pps_event_time pps_times;
158 };
Richard Cochrand94ba802011-04-22 12:03:08 +0200159};
160
161/**
162 * ptp_clock_event() - notify the PTP layer about an event
163 *
164 * @ptp: The clock obtained from ptp_clock_register().
165 * @event: Message structure describing the event.
166 */
167
168extern void ptp_clock_event(struct ptp_clock *ptp,
169 struct ptp_clock_event *event);
170
Richard Cochran995a9092012-04-03 22:59:16 +0000171/**
172 * ptp_clock_index() - obtain the device index of a PTP clock
173 *
174 * @ptp: The clock obtained from ptp_clock_register().
175 */
176
177extern int ptp_clock_index(struct ptp_clock *ptp);
178
Richard Cochran60923152014-03-20 22:21:52 +0100179/**
180 * ptp_find_pin() - obtain the pin index of a given auxiliary function
181 *
182 * @ptp: The clock obtained from ptp_clock_register().
183 * @func: One of the ptp_pin_function enumerated values.
184 * @chan: The particular functional channel to find.
185 * Return: Pin index in the range of zero to ptp_clock_caps.n_pins - 1,
186 * or -1 if the auxiliary function cannot be found.
187 */
188
189int ptp_find_pin(struct ptp_clock *ptp,
190 enum ptp_pin_function func, unsigned int chan);
191
Richard Cochrand94ba802011-04-22 12:03:08 +0200192#endif