xref: /freebsd/sys/arm64/freescale/imx/clk/imx_clk_gate.c (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
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 AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, 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 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bus.h>
35 
36 #include <dev/extres/clk/clk.h>
37 
38 #include <arm64/freescale/imx/clk/imx_clk_gate.h>
39 
40 #include "clkdev_if.h"
41 
42 #define	WR4(_clk, off, val)						\
43 	CLKDEV_WRITE_4(clknode_get_device(_clk), off, val)
44 #define	RD4(_clk, off, val)						\
45 	CLKDEV_READ_4(clknode_get_device(_clk), off, val)
46 #define	MD4(_clk, off, clr, set )					\
47 	CLKDEV_MODIFY_4(clknode_get_device(_clk), off, clr, set)
48 #define	DEVICE_LOCK(_clk)						\
49 	CLKDEV_DEVICE_LOCK(clknode_get_device(_clk))
50 #define	DEVICE_UNLOCK(_clk)						\
51 	CLKDEV_DEVICE_UNLOCK(clknode_get_device(_clk))
52 
53 static int imx_clk_gate_init(struct clknode *clk, device_t dev);
54 static int imx_clk_gate_set_gate(struct clknode *clk, bool enable);
55 struct imx_clk_gate_sc {
56 	uint32_t	offset;
57 	uint32_t	shift;
58 	uint32_t	mask;
59 	int		gate_flags;
60 };
61 
62 static clknode_method_t imx_clk_gate_methods[] = {
63 	/* Device interface */
64 	CLKNODEMETHOD(clknode_init,	imx_clk_gate_init),
65 	CLKNODEMETHOD(clknode_set_gate,	imx_clk_gate_set_gate),
66 	CLKNODEMETHOD_END
67 };
68 DEFINE_CLASS_1(imx_clk_gate, imx_clk_gate_class, imx_clk_gate_methods,
69    sizeof(struct imx_clk_gate_sc), clknode_class);
70 
71 static int
72 imx_clk_gate_init(struct clknode *clk, device_t dev)
73 {
74 
75 	clknode_init_parent_idx(clk, 0);
76 	return(0);
77 }
78 
79 static int
80 imx_clk_gate_set_gate(struct clknode *clk, bool enable)
81 {
82 	uint32_t reg;
83 	struct imx_clk_gate_sc *sc;
84 	int rv;
85 
86 	sc = clknode_get_softc(clk);
87 	DEVICE_LOCK(clk);
88 	rv = MD4(clk, sc->offset, sc->mask << sc->shift,
89 	    (enable ? sc->mask : 0) << sc->shift);
90 	if (rv != 0) {
91 		DEVICE_UNLOCK(clk);
92 		return (rv);
93 	}
94 	RD4(clk, sc->offset, &reg);
95 	DEVICE_UNLOCK(clk);
96 	return(0);
97 }
98 
99 int
100 imx_clk_gate_register(struct clkdom *clkdom, struct imx_clk_gate_def *clkdef)
101 {
102 	struct clknode *clk;
103 	struct imx_clk_gate_sc *sc;
104 
105 	clk = clknode_create(clkdom, &imx_clk_gate_class, &clkdef->clkdef);
106 	if (clk == NULL)
107 		return (1);
108 
109 	sc = clknode_get_softc(clk);
110 	sc->offset = clkdef->offset;
111 	sc->shift = clkdef->shift;
112 	sc->mask =  clkdef->mask;
113 	sc->gate_flags = clkdef->gate_flags;
114 
115 	clknode_register(clkdom, clk);
116 	return (0);
117 }
118