xref: /netbsd-src/sys/dev/clk/clk_backend.h (revision ed41487b0c334eb1ee99e83b5fae0834624baa7a)
1 /* $NetBSD: clk_backend.h,v 1.4 2018/04/28 15:20:33 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2015 Jared D. McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _DEV_CLK_CLK_BACKEND_H
30 #define _DEV_CLK_CLK_BACKEND_H
31 
32 #include <sys/sysctl.h>
33 
34 #include <dev/clk/clk.h>
35 
36 struct clk_domain {
37 	const char *name;
38 	const struct sysctlnode *node;
39 	const struct clk_funcs *funcs;
40 	void *priv;
41 };
42 
43 struct clk {
44 	struct clk_domain *domain;
45         const char *name;
46         u_int flags;
47 #define CLK_SET_RATE_PARENT     0x01
48 };
49 
50 struct clk_funcs {
51 	struct clk *(*get)(void *, const char *);
52 	void (*put)(void *, struct clk *);
53 
54 	u_int (*get_rate)(void *, struct clk *);
55 	int (*set_rate)(void *, struct clk *, u_int);
56 	u_int (*round_rate)(void *, struct clk *, u_int);
57 	int (*enable)(void *, struct clk *);
58 	int (*disable)(void *, struct clk *);
59 	int (*set_parent)(void *, struct clk *, struct clk *);
60 	struct clk *(*get_parent)(void *, struct clk *);
61 };
62 
63 int	clk_attach(struct clk *);
64 
65 #endif /* _DEV_CLK_CLK_BACKEND_H */
66