1/*
2 * AMD 10Gb Ethernet driver
3 *
4 * This file is available to you under your choice of the following two
5 * licenses:
6 *
7 * License 1: GPLv2
8 *
9 * Copyright (c) 2014 Advanced Micro Devices, Inc.
10 *
11 * This file is free software; you may copy, redistribute and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 2 of the License, or (at
14 * your option) any later version.
15 *
16 * This file is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 *
24 * This file incorporates work covered by the following copyright and
25 * permission notice:
26 *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
27 *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
28 *     Inc. unless otherwise expressly agreed to in writing between Synopsys
29 *     and you.
30 *
31 *     The Software IS NOT an item of Licensed Software or Licensed Product
32 *     under any End User Software License Agreement or Agreement for Licensed
33 *     Product with Synopsys or any supplement thereto.  Permission is hereby
34 *     granted, free of charge, to any person obtaining a copy of this software
35 *     annotated with this license and the Software, to deal in the Software
36 *     without restriction, including without limitation the rights to use,
37 *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
38 *     of the Software, and to permit persons to whom the Software is furnished
39 *     to do so, subject to the following conditions:
40 *
41 *     The above copyright notice and this permission notice shall be included
42 *     in all copies or substantial portions of the Software.
43 *
44 *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
45 *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
46 *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
47 *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
48 *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
49 *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
50 *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51 *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
52 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53 *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
54 *     THE POSSIBILITY OF SUCH DAMAGE.
55 *
56 *
57 * License 2: Modified BSD
58 *
59 * Copyright (c) 2014 Advanced Micro Devices, Inc.
60 * All rights reserved.
61 *
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions are met:
64 *     * Redistributions of source code must retain the above copyright
65 *       notice, this list of conditions and the following disclaimer.
66 *     * Redistributions in binary form must reproduce the above copyright
67 *       notice, this list of conditions and the following disclaimer in the
68 *       documentation and/or other materials provided with the distribution.
69 *     * Neither the name of Advanced Micro Devices, Inc. nor the
70 *       names of its contributors may be used to endorse or promote products
71 *       derived from this software without specific prior written permission.
72 *
73 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
74 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76 * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
77 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
78 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
79 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
80 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
81 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
82 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83 *
84 * This file incorporates work covered by the following copyright and
85 * permission notice:
86 *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
87 *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
88 *     Inc. unless otherwise expressly agreed to in writing between Synopsys
89 *     and you.
90 *
91 *     The Software IS NOT an item of Licensed Software or Licensed Product
92 *     under any End User Software License Agreement or Agreement for Licensed
93 *     Product with Synopsys or any supplement thereto.  Permission is hereby
94 *     granted, free of charge, to any person obtaining a copy of this software
95 *     annotated with this license and the Software, to deal in the Software
96 *     without restriction, including without limitation the rights to use,
97 *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
98 *     of the Software, and to permit persons to whom the Software is furnished
99 *     to do so, subject to the following conditions:
100 *
101 *     The above copyright notice and this permission notice shall be included
102 *     in all copies or substantial portions of the Software.
103 *
104 *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
105 *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
106 *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
107 *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
108 *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
109 *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
110 *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
111 *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
112 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113 *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
114 *     THE POSSIBILITY OF SUCH DAMAGE.
115 */
116#include <sys/cdefs.h>
117#include "xgbe.h"
118
119static u64 xgbe_cc_read(const struct cyclecounter *cc)
120{
121	struct xgbe_prv_data *pdata = container_of(cc,
122						   struct xgbe_prv_data,
123						   tstamp_cc);
124	u64 nsec;
125
126	nsec = pdata->hw_if.get_tstamp_time(pdata);
127
128	return (nsec);
129}
130
131static int xgbe_adjfreq(struct ptp_clock_info *info, s32 delta)
132{
133	struct xgbe_prv_data *pdata = container_of(info,
134						   struct xgbe_prv_data,
135						   ptp_clock_info);
136	unsigned long flags;
137	u64 adjust;
138	u32 addend, diff;
139	unsigned int neg_adjust = 0;
140
141	if (delta < 0) {
142		neg_adjust = 1;
143		delta = -delta;
144	}
145
146	adjust = pdata->tstamp_addend;
147	adjust *= delta;
148	diff = div_u64(adjust, 1000000000UL);
149
150	addend = (neg_adjust) ? pdata->tstamp_addend - diff :
151				pdata->tstamp_addend + diff;
152
153	spin_lock_irqsave(&pdata->tstamp_lock, flags);
154
155	pdata->hw_if.update_tstamp_addend(pdata, addend);
156
157	spin_unlock_irqrestore(&pdata->tstamp_lock, flags);
158
159	return (0);
160}
161
162static int xgbe_adjtime(struct ptp_clock_info *info, s64 delta)
163{
164	struct xgbe_prv_data *pdata = container_of(info,
165						   struct xgbe_prv_data,
166						   ptp_clock_info);
167	unsigned long flags;
168
169	spin_lock_irqsave(&pdata->tstamp_lock, flags);
170	timecounter_adjtime(&pdata->tstamp_tc, delta);
171	spin_unlock_irqrestore(&pdata->tstamp_lock, flags);
172
173	return (0);
174}
175
176static int xgbe_gettime(struct ptp_clock_info *info, struct timespec64 *ts)
177{
178	struct xgbe_prv_data *pdata = container_of(info,
179						   struct xgbe_prv_data,
180						   ptp_clock_info);
181	unsigned long flags;
182	u64 nsec;
183
184	spin_lock_irqsave(&pdata->tstamp_lock, flags);
185
186	nsec = timecounter_read(&pdata->tstamp_tc);
187
188	spin_unlock_irqrestore(&pdata->tstamp_lock, flags);
189
190	*ts = ns_to_timespec64(nsec);
191
192	return (0);
193}
194
195static int xgbe_settime(struct ptp_clock_info *info,
196			const struct timespec64 *ts)
197{
198	struct xgbe_prv_data *pdata = container_of(info,
199						   struct xgbe_prv_data,
200						   ptp_clock_info);
201	unsigned long flags;
202	u64 nsec;
203
204	nsec = timespec64_to_ns(ts);
205
206	spin_lock_irqsave(&pdata->tstamp_lock, flags);
207
208	timecounter_init(&pdata->tstamp_tc, &pdata->tstamp_cc, nsec);
209
210	spin_unlock_irqrestore(&pdata->tstamp_lock, flags);
211
212	return (0);
213}
214
215static int xgbe_enable(struct ptp_clock_info *info,
216    void *request, int on)
217{
218	return (-EOPNOTSUPP);
219}
220
221void xgbe_ptp_register(struct xgbe_prv_data *pdata)
222{
223	struct ptp_clock_info *info = &pdata->ptp_clock_info;
224	//struct ptp_clock *clock;
225	struct cyclecounter *cc = &pdata->tstamp_cc;
226	u64 dividend;
227
228	snprintf(info->name, sizeof(info->name), "axgbe-ptp");
229	//info->owner = THIS_MODULE;
230	info->max_adj = pdata->ptpclk_rate;
231	info->adjfreq = xgbe_adjfreq;
232	info->adjtime = xgbe_adjtime;
233	info->gettime64 = xgbe_gettime;
234	info->settime64 = xgbe_settime;
235	info->enable = xgbe_enable;
236#if 0
237	clock = ptp_clock_register(info, pdata->dev);
238	if (IS_ERR(clock)) {
239		dev_err(pdata->dev, "ptp_clock_register failed\n");
240		return;
241	}
242
243	pdata->ptp_clock = clock;
244#endif
245	/* Calculate the addend:
246	 *   addend = 2^32 / (PTP ref clock / 50Mhz)
247	 *          = (2^32 * 50Mhz) / PTP ref clock
248	 */
249	dividend = 50000000;
250	dividend <<= 32;
251	pdata->tstamp_addend = div_u64(dividend, pdata->ptpclk_rate);
252
253	/* Setup the timecounter */
254	cc->read = xgbe_cc_read;
255	cc->mask = CLOCKSOURCE_MASK(64);
256	cc->mult = 1;
257	cc->shift = 0;
258
259	timecounter_init(&pdata->tstamp_tc, &pdata->tstamp_cc,
260			 ktime_to_ns(ktime_get_real()));
261
262	/* Disable all timestamping to start */
263	XGMAC_IOWRITE(pdata, MAC_TSCR, 0);
264	pdata->tstamp_config.tx_type = HWTSTAMP_TX_OFF;
265	pdata->tstamp_config.rx_filter = HWTSTAMP_FILTER_NONE;
266}
267
268void xgbe_ptp_unregister(struct xgbe_prv_data *pdata)
269{
270#if 0
271	if (pdata->ptp_clock)
272		ptp_clock_unregister(pdata->ptp_clock);
273#endif
274}
275