1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
#include <machine/rtems-bsd-kernel-space.h>
/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2021 Chris Johns <chrisj@rtems.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Versal ACAP SLCR driver. Provides hook for CGEM clocks.
*
* Reference:
* https://www.xilinx.com/html_docs/registers/am012/mod___crl.html
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <bsp.h>
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <rtems/bsd/sys/resource.h>
#include <sys/sysctl.h>
#include <sys/rman.h>
#include <machine/bus.h>
#include <machine/resource.h>
#include <machine/stdarg.h>
#include <arm64/xilinx/versal_slcr.h>
struct versal_slcr_softc {
device_t dev;
struct mtx sc_mtx;
struct resource *mem_res;
};
static struct versal_slcr_softc *versal_slcr_softc_p;
#define RD4(sc, off) (bus_read_4((sc)->mem_res, (off)))
#define WR4(sc, off, val) (bus_write_4((sc)->mem_res, (off), (val)))
SYSCTL_NODE(_hw, OID_AUTO, versal, CTLFLAG_RD, 0, "Xilinx Versal ACAP SLCR");
#if defined(LIBBSP_AARCH64_XILINX_VERSAL_BSP_H)
/* Override cgem_set_refclk() in gigabit ethernet driver
* (sys/dev/cadence/if_cgem.c). This function is called to
* request a change in the gem's reference clock speed.
*/
int
cgem_set_ref_clk(int unit, int frequency)
{
struct versal_slcr_softc *sc = versal_slcr_softc_p;
int div, last_error = 0;
uint64_t clk_ctrl, pll_ctrl, to_xpd_ctrl;
uint32_t clk_ctrl_val, pll_ctrl_val, pll_freq, pll_reset, pll_bypass;
uint32_t clk_src_sel, to_xpd_ctrl_val, to_xpd_div, to_xpd_freq;
if (!sc)
return (-1);
switch (unit) {
case 0:
clk_ctrl = VERSAL_SLCR_GEM0_CLK_CTRL;
break;
case 1:
clk_ctrl = VERSAL_SLCR_GEM1_CLK_CTRL;
break;
default:
return (-1);
}
clk_ctrl_val = RD4(sc, clk_ctrl);
switch (clk_ctrl_val & VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_MASK) {
case VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_P_PLL:
pll_ctrl = VERSAL_SLCR_P_PLL_CTRL;
break;
case VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_R_PLL:
pll_ctrl = VERSAL_SLCR_R_PLL_CTRL;
break;
case VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_N_PLL:
pll_ctrl = VERSAL_SLCR_N_PLL_CTRL;
break;
default:
return (-1);
}
/* Get PLL frequency */
pll_ctrl_val = RD4(sc, pll_ctrl);
pll_reset = (pll_ctrl_val & VERSAL_SLCR_PLL_CTRL_RESET) != 0;
pll_bypass = (pll_ctrl_val & VERSAL_SLCR_PLL_CTRL_BYPASS) != 0;
if (pll_reset && !pll_bypass) {
return 0;
}
pll_freq = VERSAL_DEFAULT_PS_CLK_FREQUENCY;
if (!pll_bypass) {
pll_freq *= (pll_ctrl_val & VERSAL_SLCR_PLL_CTRL_FBDIV_MASK) >> VERSAL_SLCR_PLL_CTRL_FBDIV_SHIFT;
}
/* Apply divider */
pll_freq >>= (pll_ctrl_val & VERSAL_SLCR_PLL_CTRL_DIV_MASK) >> VERSAL_SLCR_PLL_CTRL_DIV_SHIFT;
/* Check if routed through {X}PLL_TO_XPD_CLK to GEM{unit}_REF_CLK and adjust */
clk_src_sel = (clk_ctrl_val & VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_MASK);
to_xpd_ctrl = 0;
if (clk_src_sel == VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_P_PLL) {
to_xpd_ctrl = VERSAL_SLCR_PPLL_TO_XPD_CTRL;
} else if (clk_src_sel == VERSAL_SLCR_GEM_CLK_CTRL_SRCSEL_N_PLL) {
to_xpd_ctrl = VERSAL_SLCR_NPLL_TO_XPD_CTRL;
}
if (to_xpd_ctrl != 0) {
to_xpd_ctrl_val = RD4(sc, to_xpd_ctrl);
to_xpd_div = (to_xpd_ctrl_val & VERSAL_SLCR_XPD_CLK_CTRL_DIVISOR_MASK);
to_xpd_div = to_xpd_div >> VERSAL_SLCR_XPD_CTRL_DIV_SHIFT;
if (to_xpd_div == 0) {
to_xpd_div = 1;
}
to_xpd_freq = pll_freq / to_xpd_div;
} else {
to_xpd_freq = pll_freq;
}
/* Find suitable divisor. Linear search, not the fastest method but hey.
*/
for (div = 1; div <= VERSAL_SLCR_GEM_CLK_CTRL_DIVISOR_MAX; div++) {
int div_freq = to_xpd_freq / div;
int error = abs(frequency - div_freq);
if (error >= last_error && last_error != 0) {
div--;
break;
}
last_error = error;
}
if (div > VERSAL_SLCR_GEM_CLK_CTRL_DIVISOR_MAX)
return (-1);
/* Modify GEM reference clock. */
clk_ctrl_val &= ~VERSAL_SLCR_GEM_CLK_CTRL_DIVISOR_MASK;
clk_ctrl_val |= div << VERSAL_SLCR_GEM_CLK_CTRL_DIVISOR_SHIFT;
WR4(sc, clk_ctrl, clk_ctrl_val);
return (0);
}
#endif
static int
versal_slcr_probe(device_t dev)
{
device_set_desc(dev, "Versal ACAP SLCR block");
return (0);
}
static int
versal_slcr_attach(device_t dev)
{
struct versal_slcr_softc *sc = device_get_softc(dev);
int rid;
/* Allow only one attach. */
if (versal_slcr_softc_p != NULL)
return (ENXIO);
sc->dev = dev;
/* Get memory resource. */
rid = 0;
sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
RF_ACTIVE);
if (sc->mem_res == NULL) {
device_printf(dev, "could not allocate memory resources.\n");
return (ENOMEM);
}
/* For use with CGEM clock setting */
versal_slcr_softc_p = sc;
return (0);
}
static int
versal_slcr_detach(device_t dev)
{
struct versal_slcr_softc *sc = device_get_softc(dev);
bus_generic_detach(dev);
/* Release memory resource. */
if (sc->mem_res != NULL)
bus_release_resource(dev, SYS_RES_MEMORY,
rman_get_rid(sc->mem_res), sc->mem_res);
versal_slcr_softc_p = NULL;
return (0);
}
static device_method_t versal_slcr_methods[] = {
/* device_if */
DEVMETHOD(device_probe, versal_slcr_probe),
DEVMETHOD(device_attach, versal_slcr_attach),
DEVMETHOD(device_detach, versal_slcr_detach),
DEVMETHOD_END
};
static driver_t versal_slcr_driver = {
"versal_slcr",
versal_slcr_methods,
sizeof(struct versal_slcr_softc),
};
static devclass_t versal_slcr_devclass;
DRIVER_MODULE(versal_slcr, nexus, versal_slcr_driver, versal_slcr_devclass, 0, 0);
MODULE_VERSION(versal_slcr, 1);
|
