xref: /freebsd/sys/arm64/freescale/imx/clk/imx_clk_gate.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/bus.h>
33 
34 #include <dev/extres/clk/clk.h>
35 
36 #include <arm64/freescale/imx/clk/imx_clk_gate.h>
37 
38 #include "clkdev_if.h"
39 
40 #define	WR4(_clk, off, val)						\
41 	CLKDEV_WRITE_4(clknode_get_device(_clk), off, val)
42 #define	RD4(_clk, off, val)						\
43 	CLKDEV_READ_4(clknode_get_device(_clk), off, val)
44 #define	MD4(_clk, off, clr, set )					\
45 	CLKDEV_MODIFY_4(clknode_get_device(_clk), off, clr, set)
46 #define	DEVICE_LOCK(_clk)						\
47 	CLKDEV_DEVICE_LOCK(clknode_get_device(_clk))
48 #define	DEVICE_UNLOCK(_clk)						\
49 	CLKDEV_DEVICE_UNLOCK(clknode_get_device(_clk))
50 
51 static int imx_clk_gate_init(struct clknode *clk, device_t dev);
52 static int imx_clk_gate_set_gate(struct clknode *clk, bool enable);
53 struct imx_clk_gate_sc {
54 	uint32_t	offset;
55 	uint32_t	shift;
56 	uint32_t	mask;
57 	int		gate_flags;
58 };
59 
60 static clknode_method_t imx_clk_gate_methods[] = {
61 	/* Device interface */
62 	CLKNODEMETHOD(clknode_init,	imx_clk_gate_init),
63 	CLKNODEMETHOD(clknode_set_gate,	imx_clk_gate_set_gate),
64 	CLKNODEMETHOD_END
65 };
66 DEFINE_CLASS_1(imx_clk_gate, imx_clk_gate_class, imx_clk_gate_methods,
67    sizeof(struct imx_clk_gate_sc), clknode_class);
68 
69 static int
70 imx_clk_gate_init(struct clknode *clk, device_t dev)
71 {
72 
73 	clknode_init_parent_idx(clk, 0);
74 	return(0);
75 }
76 
77 static int
78 imx_clk_gate_set_gate(struct clknode *clk, bool enable)
79 {
80 	uint32_t reg;
81 	struct imx_clk_gate_sc *sc;
82 	int rv;
83 
84 	sc = clknode_get_softc(clk);
85 	DEVICE_LOCK(clk);
86 	rv = MD4(clk, sc->offset, sc->mask << sc->shift,
87 	    (enable ? sc->mask : 0) << sc->shift);
88 	if (rv != 0) {
89 		DEVICE_UNLOCK(clk);
90 		return (rv);
91 	}
92 	RD4(clk, sc->offset, &reg);
93 	DEVICE_UNLOCK(clk);
94 	return(0);
95 }
96 
97 int
98 imx_clk_gate_register(struct clkdom *clkdom, struct imx_clk_gate_def *clkdef)
99 {
100 	struct clknode *clk;
101 	struct imx_clk_gate_sc *sc;
102 
103 	clk = clknode_create(clkdom, &imx_clk_gate_class, &clkdef->clkdef);
104 	if (clk == NULL)
105 		return (1);
106 
107 	sc = clknode_get_softc(clk);
108 	sc->offset = clkdef->offset;
109 	sc->shift = clkdef->shift;
110 	sc->mask =  clkdef->mask;
111 	sc->gate_flags = clkdef->gate_flags;
112 
113 	clknode_register(clkdom, clk);
114 	return (0);
115 }
116