summaryrefslogtreecommitdiff
path: root/sys/dev/clk/clk.c
blob: e12c9e8ab4d88e929ef752b0452b4f0a8c00e11a (plain)
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/* $NetBSD: clk.c,v 1.7 2019/07/23 17:44:03 jmcneill Exp $ */

/*-
 * Copyright (c) 2015 Jared D. McNeill <jmcneill@invisible.ca>
 * 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 ``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 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: clk.c,v 1.7 2019/07/23 17:44:03 jmcneill Exp $");

#include <sys/param.h>
#include <sys/sysctl.h>
#include <sys/kmem.h>

#include <dev/clk/clk.h>
#include <dev/clk/clk_backend.h>

static struct sysctllog *clk_log;
static const struct sysctlnode *clk_node;

static int
create_clk_node(void)
{
	const struct sysctlnode *hw_node;
	int error;

	if (clk_node)
		return 0;

	error = sysctl_createv(&clk_log, 0, NULL, &hw_node,
	    CTLFLAG_PERMANENT, CTLTYPE_NODE, "hw", NULL,
	    NULL, 0, NULL, 0, CTL_HW, CTL_EOL);
	if (error)
		return error;

	error = sysctl_createv(&clk_log, 0, &hw_node, &clk_node,
	    CTLFLAG_PERMANENT, CTLTYPE_NODE, "clk", NULL,
	    NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
	if (error)
		return error;

	return 0;
}

static int
create_domain_node(struct clk_domain *domain)
{
	int error;

	if (domain->node)
		return 0;

	error = create_clk_node();
	if (error)
		return error;

	error = sysctl_createv(&clk_log, 0, &clk_node, &domain->node,
	    0, CTLTYPE_NODE, domain->name, NULL,
	    NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
	if (error)
		return error;

	return 0;
}

static int
clk_sysctl_rate_helper(SYSCTLFN_ARGS)
{
	struct sysctlnode node;
	struct clk *clk;
	uint64_t rate;

	node = *rnode;
	clk = node.sysctl_data;
	node.sysctl_data = &rate;

	rate = clk_get_rate(clk);

	return sysctl_lookup(SYSCTLFN_CALL(&node));
}

static int
clk_sysctl_parent_helper(SYSCTLFN_ARGS)
{
	struct sysctlnode node;
	struct clk *clk, *clk_parent;

	node = *rnode;
	clk = node.sysctl_data;

	clk_parent = clk_get_parent(clk);
	if (clk_parent && clk_parent->name)
		node.sysctl_data = __UNCONST(clk_parent->name);
	else
		node.sysctl_data = __UNCONST("?");

	return sysctl_lookup(SYSCTLFN_CALL(&node));
}

static int
clk_sysctl_parent_domain_helper(SYSCTLFN_ARGS)
{
	struct sysctlnode node;
	struct clk *clk, *clk_parent;

	node = *rnode;
	clk = node.sysctl_data;

	clk_parent = clk_get_parent(clk);
	if (clk_parent && clk_parent->domain && clk_parent->domain->name)
		node.sysctl_data = __UNCONST(clk_parent->domain->name);
	else
		node.sysctl_data = __UNCONST("?");

	return sysctl_lookup(SYSCTLFN_CALL(&node));
}

static void
clk_normalize_name(char *name)
{
	unsigned char *p;

	for (p = (unsigned char *)name; *p; p++)
		if (!isalpha(*p) && !isdigit(*p) && *p != '-' && *p != '_')
			*p = '_';
}

int
clk_attach(struct clk *clk)
{
	const struct sysctlnode *node;
	struct clk_domain *domain = clk->domain;
	char *name;
	size_t namelen;
	int error;

	KASSERT(domain != NULL);

	if (!domain->name || !clk->name) {
		/* Names are required to create sysctl nodes */
		return 0;
	}

	namelen = strlen(clk->name) + 1;
	name = kmem_zalloc(namelen, KM_SLEEP);
	memcpy(name, clk->name, namelen);
	clk_normalize_name(name);

	error = create_domain_node(domain);
	if (error != 0)
		goto sysctl_failed;

	error = sysctl_createv(&clk_log, 0, &domain->node, &node,
	    CTLFLAG_PRIVATE, CTLTYPE_NODE, name, NULL,
	    NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
	if (error)
		goto sysctl_failed;

	error = sysctl_createv(&clk_log, 0, &node, NULL,
	    CTLFLAG_PRIVATE, CTLTYPE_QUAD, "rate", NULL,
	    clk_sysctl_rate_helper, 0, (void *)clk, 0,
	    CTL_CREATE, CTL_EOL);
	if (error)
		goto sysctl_failed;

	error = sysctl_createv(&clk_log, 0, &node, NULL,
	    CTLFLAG_PRIVATE, CTLTYPE_STRING, "parent", NULL,
	    clk_sysctl_parent_helper, 0, (void *)clk, 0,
	    CTL_CREATE, CTL_EOL);
	if (error)
		goto sysctl_failed;

	error = sysctl_createv(&clk_log, 0, &node, NULL,
	    CTLFLAG_PRIVATE, CTLTYPE_STRING, "parent_domain", NULL,
	    clk_sysctl_parent_domain_helper, 0, (void *)clk, 0,
	    CTL_CREATE, CTL_EOL);
	if (error)
		goto sysctl_failed;

sysctl_failed:
	if (error)
		aprint_error("%s: failed to create sysctl node for %s (%s): %d\n",
		    domain->name, clk->name, name, error);

	kmem_free(name, namelen);
	return error;
}

struct clk *
clk_get(struct clk_domain *domain, const char *name)
{
	return domain->funcs->get(domain->priv, name);
}

void
clk_put(struct clk *clk)
{
	if (clk->domain->funcs->put)
		clk->domain->funcs->put(clk->domain->priv, clk);
}

u_int
clk_get_rate(struct clk *clk)
{
	return clk->domain->funcs->get_rate(clk->domain->priv, clk);
}

int
clk_set_rate(struct clk *clk, u_int rate)
{
	if (clk->flags & CLK_SET_RATE_PARENT)
		return clk_set_rate(clk_get_parent(clk), rate);

	if (clk->domain->funcs->set_rate)
		return clk->domain->funcs->set_rate(clk->domain->priv,
		    clk, rate);

	if (clk_get_rate(clk) == rate)
		return 0;

	return EINVAL;
}

u_int
clk_round_rate(struct clk *clk, u_int rate)
{
	if (clk->domain->funcs->round_rate) {
		return clk->domain->funcs->round_rate(clk->domain->priv,
		    clk, rate);
	}
	return 0;
}

int
clk_enable(struct clk *clk)
{
	if (clk->domain->funcs->enable)
		return clk->domain->funcs->enable(clk->domain->priv, clk);
	else
		return 0;
}

int
clk_disable(struct clk *clk)
{
	if (clk->domain->funcs->disable)
		return clk->domain->funcs->disable(clk->domain->priv, clk);
	else
		return EINVAL;
}

int
clk_set_parent(struct clk *clk, struct clk *parent_clk)
{
	if (clk->domain->funcs->set_parent)
		return clk->domain->funcs->set_parent(clk->domain->priv,
		    clk, parent_clk);
	else
		return EINVAL;
}

struct clk *
clk_get_parent(struct clk *clk)
{
	if (clk->domain->funcs->get_parent)
		return clk->domain->funcs->get_parent(clk->domain->priv, clk);
	else
		return NULL;
}