1 /*******************************************************************************
2 PTP 1588 clock using the STMMAC.
4 Copyright (C) 2013 Vayavya Labs Pvt Ltd
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
22 Author: Rayagond Kokatanur <rayagond@vayavyalabs.com>
23 *******************************************************************************/
25 #include "stmmac_ptp.h"
30 * @ptp: pointer to ptp_clock_info structure
31 * @ppb: desired period change in parts ber billion
33 * Description: this function will adjust the frequency of hardware clock.
35 static int stmmac_adjust_freq(struct ptp_clock_info *ptp, s32 ppb)
37 struct stmmac_priv *priv =
38 container_of(ptp, struct stmmac_priv, ptp_clock_ops);
49 addend = priv->default_addend;
52 diff = div_u64(adj, 1000000000ULL);
53 addend = neg_adj ? (addend - diff) : (addend + diff);
55 spin_lock_irqsave(&priv->ptp_lock, flags);
57 priv->hw->ptp->config_addend(priv->ioaddr, addend);
59 spin_unlock_irqrestore(&priv->ptp_lock, flags);
67 * @ptp: pointer to ptp_clock_info structure
68 * @delta: desired change in nanoseconds
70 * Description: this function will shift/adjust the hardware clock time.
72 static int stmmac_adjust_time(struct ptp_clock_info *ptp, s64 delta)
74 struct stmmac_priv *priv =
75 container_of(ptp, struct stmmac_priv, ptp_clock_ops);
78 u32 quotient, reminder;
86 quotient = div_u64_rem(delta, 1000000000ULL, &reminder);
90 spin_lock_irqsave(&priv->ptp_lock, flags);
92 priv->hw->ptp->adjust_systime(priv->ioaddr, sec, nsec, neg_adj);
94 spin_unlock_irqrestore(&priv->ptp_lock, flags);
102 * @ptp: pointer to ptp_clock_info structure
103 * @ts: pointer to hold time/result
105 * Description: this function will read the current time from the
106 * hardware clock and store it in @ts.
108 static int stmmac_get_time(struct ptp_clock_info *ptp, struct timespec64 *ts)
110 struct stmmac_priv *priv =
111 container_of(ptp, struct stmmac_priv, ptp_clock_ops);
115 spin_lock_irqsave(&priv->ptp_lock, flags);
117 ns = priv->hw->ptp->get_systime(priv->ioaddr);
119 spin_unlock_irqrestore(&priv->ptp_lock, flags);
121 *ts = ns_to_timespec64(ns);
129 * @ptp: pointer to ptp_clock_info structure
130 * @ts: time value to set
132 * Description: this function will set the current time on the
135 static int stmmac_set_time(struct ptp_clock_info *ptp,
136 const struct timespec64 *ts)
138 struct stmmac_priv *priv =
139 container_of(ptp, struct stmmac_priv, ptp_clock_ops);
142 spin_lock_irqsave(&priv->ptp_lock, flags);
144 priv->hw->ptp->init_systime(priv->ioaddr, ts->tv_sec, ts->tv_nsec);
146 spin_unlock_irqrestore(&priv->ptp_lock, flags);
151 static int stmmac_enable(struct ptp_clock_info *ptp,
152 struct ptp_clock_request *rq, int on)
157 /* structure describing a PTP hardware clock */
158 static struct ptp_clock_info stmmac_ptp_clock_ops = {
159 .owner = THIS_MODULE,
160 .name = "stmmac_ptp_clock",
167 .adjfreq = stmmac_adjust_freq,
168 .adjtime = stmmac_adjust_time,
169 .gettime64 = stmmac_get_time,
170 .settime64 = stmmac_set_time,
171 .enable = stmmac_enable,
175 * stmmac_ptp_register
176 * @priv: driver private structure
177 * Description: this function will register the ptp clock driver
178 * to kernel. It also does some house keeping work.
180 int stmmac_ptp_register(struct stmmac_priv *priv)
182 spin_lock_init(&priv->ptp_lock);
183 priv->ptp_clock_ops = stmmac_ptp_clock_ops;
185 priv->ptp_clock = ptp_clock_register(&priv->ptp_clock_ops,
187 if (IS_ERR(priv->ptp_clock)) {
188 priv->ptp_clock = NULL;
189 pr_err("ptp_clock_register() failed on %s\n", priv->dev->name);
190 } else if (priv->ptp_clock)
191 pr_debug("Added PTP HW clock successfully on %s\n",
198 * stmmac_ptp_unregister
199 * @priv: driver private structure
200 * Description: this function will remove/unregister the ptp clock driver
203 void stmmac_ptp_unregister(struct stmmac_priv *priv)
205 if (priv->ptp_clock) {
206 ptp_clock_unregister(priv->ptp_clock);
207 priv->ptp_clock = NULL;
208 pr_debug("Removed PTP HW clock successfully on %s\n",