1 /* Intel PRO/1000 Linux driver
2 * Copyright(c) 1999 - 2014 Intel Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
16 * Contact Information:
17 * Linux NICS <linux.nics@intel.com>
18 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
19 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
22 /* PTP 1588 Hardware Clock (PHC)
23 * Derived from PTP Hardware Clock driver for Intel 82576 and 82580 (igb)
24 * Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
30 * e1000e_phc_adjfreq - adjust the frequency of the hardware clock
31 * @ptp: ptp clock structure
32 * @delta: Desired frequency change in parts per billion
34 * Adjust the frequency of the PHC cycle counter by the indicated delta from
37 static int e1000e_phc_adjfreq(struct ptp_clock_info *ptp, s32 delta)
39 struct e1000_adapter *adapter = container_of(ptp, struct e1000_adapter,
41 struct e1000_hw *hw = &adapter->hw;
45 u32 timinca, incvalue;
48 if ((delta > ptp->max_adj) || (delta <= -1000000000))
56 /* Get the System Time Register SYSTIM base frequency */
57 ret_val = e1000e_get_base_timinca(adapter, &timinca);
61 spin_lock_irqsave(&adapter->systim_lock, flags);
63 incvalue = timinca & E1000_TIMINCA_INCVALUE_MASK;
65 adjustment = incvalue;
67 adjustment = div_u64(adjustment, 1000000000);
69 incvalue = neg_adj ? (incvalue - adjustment) : (incvalue + adjustment);
71 timinca &= ~E1000_TIMINCA_INCVALUE_MASK;
74 ew32(TIMINCA, timinca);
76 spin_unlock_irqrestore(&adapter->systim_lock, flags);
82 * e1000e_phc_adjtime - Shift the time of the hardware clock
83 * @ptp: ptp clock structure
84 * @delta: Desired change in nanoseconds
86 * Adjust the timer by resetting the timecounter structure.
88 static int e1000e_phc_adjtime(struct ptp_clock_info *ptp, s64 delta)
90 struct e1000_adapter *adapter = container_of(ptp, struct e1000_adapter,
95 spin_lock_irqsave(&adapter->systim_lock, flags);
96 now = timecounter_read(&adapter->tc);
98 timecounter_init(&adapter->tc, &adapter->cc, now);
99 spin_unlock_irqrestore(&adapter->systim_lock, flags);
105 * e1000e_phc_gettime - Reads the current time from the hardware clock
106 * @ptp: ptp clock structure
107 * @ts: timespec structure to hold the current time value
109 * Read the timecounter and return the correct value in ns after converting
110 * it into a struct timespec.
112 static int e1000e_phc_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
114 struct e1000_adapter *adapter = container_of(ptp, struct e1000_adapter,
120 spin_lock_irqsave(&adapter->systim_lock, flags);
121 ns = timecounter_read(&adapter->tc);
122 spin_unlock_irqrestore(&adapter->systim_lock, flags);
124 ts->tv_sec = div_u64_rem(ns, NSEC_PER_SEC, &remainder);
125 ts->tv_nsec = remainder;
131 * e1000e_phc_settime - Set the current time on the hardware clock
132 * @ptp: ptp clock structure
133 * @ts: timespec containing the new time for the cycle counter
135 * Reset the timecounter to use a new base value instead of the kernel
138 static int e1000e_phc_settime(struct ptp_clock_info *ptp,
139 const struct timespec *ts)
141 struct e1000_adapter *adapter = container_of(ptp, struct e1000_adapter,
146 ns = timespec_to_ns(ts);
148 /* reset the timecounter */
149 spin_lock_irqsave(&adapter->systim_lock, flags);
150 timecounter_init(&adapter->tc, &adapter->cc, ns);
151 spin_unlock_irqrestore(&adapter->systim_lock, flags);
157 * e1000e_phc_enable - enable or disable an ancillary feature
158 * @ptp: ptp clock structure
159 * @request: Desired resource to enable or disable
160 * @on: Caller passes one to enable or zero to disable
162 * Enable (or disable) ancillary features of the PHC subsystem.
163 * Currently, no ancillary features are supported.
165 static int e1000e_phc_enable(struct ptp_clock_info __always_unused *ptp,
166 struct ptp_clock_request __always_unused *request,
167 int __always_unused on)
172 static void e1000e_systim_overflow_work(struct work_struct *work)
174 struct e1000_adapter *adapter = container_of(work, struct e1000_adapter,
175 systim_overflow_work.work);
176 struct e1000_hw *hw = &adapter->hw;
179 adapter->ptp_clock_info.gettime(&adapter->ptp_clock_info, &ts);
181 e_dbg("SYSTIM overflow check at %ld.%09lu\n", ts.tv_sec, ts.tv_nsec);
183 schedule_delayed_work(&adapter->systim_overflow_work,
184 E1000_SYSTIM_OVERFLOW_PERIOD);
187 static const struct ptp_clock_info e1000e_ptp_clock_info = {
188 .owner = THIS_MODULE,
194 .adjfreq = e1000e_phc_adjfreq,
195 .adjtime = e1000e_phc_adjtime,
196 .gettime = e1000e_phc_gettime,
197 .settime = e1000e_phc_settime,
198 .enable = e1000e_phc_enable,
202 * e1000e_ptp_init - initialize PTP for devices which support it
203 * @adapter: board private structure
205 * This function performs the required steps for enabling PTP support.
206 * If PTP support has already been loaded it simply calls the cyclecounter
207 * init routine and exits.
209 void e1000e_ptp_init(struct e1000_adapter *adapter)
211 struct e1000_hw *hw = &adapter->hw;
213 adapter->ptp_clock = NULL;
215 if (!(adapter->flags & FLAG_HAS_HW_TIMESTAMP))
218 adapter->ptp_clock_info = e1000e_ptp_clock_info;
220 snprintf(adapter->ptp_clock_info.name,
221 sizeof(adapter->ptp_clock_info.name), "%pm",
222 adapter->netdev->perm_addr);
224 switch (hw->mac.type) {
227 if ((hw->mac.type != e1000_pch_lpt) ||
228 (er32(TSYNCRXCTL) & E1000_TSYNCRXCTL_SYSCFI)) {
229 adapter->ptp_clock_info.max_adj = 24000000 - 1;
235 adapter->ptp_clock_info.max_adj = 600000000 - 1;
241 INIT_DELAYED_WORK(&adapter->systim_overflow_work,
242 e1000e_systim_overflow_work);
244 schedule_delayed_work(&adapter->systim_overflow_work,
245 E1000_SYSTIM_OVERFLOW_PERIOD);
247 adapter->ptp_clock = ptp_clock_register(&adapter->ptp_clock_info,
248 &adapter->pdev->dev);
249 if (IS_ERR(adapter->ptp_clock)) {
250 adapter->ptp_clock = NULL;
251 e_err("ptp_clock_register failed\n");
253 e_info("registered PHC clock\n");
258 * e1000e_ptp_remove - disable PTP device and stop the overflow check
259 * @adapter: board private structure
261 * Stop the PTP support, and cancel the delayed work.
263 void e1000e_ptp_remove(struct e1000_adapter *adapter)
265 if (!(adapter->flags & FLAG_HAS_HW_TIMESTAMP))
268 cancel_delayed_work_sync(&adapter->systim_overflow_work);
270 if (adapter->ptp_clock) {
271 ptp_clock_unregister(adapter->ptp_clock);
272 adapter->ptp_clock = NULL;
273 e_info("removed PHC\n");