sys/arm/allwinner/clkng/aw_clk_prediv_mux.c

   1 /*-
   2  * Copyright (c) 2017 Emmanuel Vadot <manu@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  19  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  21  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  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 <arm/allwinner/clkng/aw_clk.h>
  39 #include <arm/allwinner/clkng/aw_clk_prediv_mux.h>
  40
  41 #include "clkdev_if.h"
  42
  43 /*
  44  * clknode for clocks matching the formula :
  45  *
  46  * clk = clkin / prediv / div
  47  *
  48  * and where prediv is conditional
  49  *
  50  */
  51
  52 struct aw_clk_prediv_mux_sc {
  53         uint32_t        offset;
  54
  55         uint32_t                mux_shift;
  56         uint32_t                mux_mask;
  57
  58         struct aw_clk_factor    div;
  59         struct aw_clk_factor    prediv;
  60
  61         uint32_t        flags;
  62 };
  63
  64 #define WRITE4(_clk, off, val)                                          \
  65         CLKDEV_WRITE_4(clknode_get_device(_clk), off, val)
  66 #define READ4(_clk, off, val)                                           \
  67         CLKDEV_READ_4(clknode_get_device(_clk), off, val)
  68 #define MODIFY4(_clk, off, clr, set )                                   \
  69         CLKDEV_MODIFY_4(clknode_get_device(_clk), off, clr, set)
  70 #define DEVICE_LOCK(_clk)                                                       \
  71         CLKDEV_DEVICE_LOCK(clknode_get_device(_clk))
  72 #define DEVICE_UNLOCK(_clk)                                             \
  73         CLKDEV_DEVICE_UNLOCK(clknode_get_device(_clk))
  74
  75 static int
  76 aw_clk_prediv_mux_init(struct clknode *clk, device_t dev)
  77 {
  78         struct aw_clk_prediv_mux_sc *sc;
  79         uint32_t val;
  80
  81         sc = clknode_get_softc(clk);
  82
  83         DEVICE_LOCK(clk);
  84         READ4(clk, sc->offset, &val);
  85         DEVICE_UNLOCK(clk);
  86
  87         /* Init the current parent */
  88         val = (val & sc->mux_mask) >> sc->mux_shift;
  89         clknode_init_parent_idx(clk, val);
  90
  91         return (0);
  92 }
  93
  94 static int
  95 aw_clk_prediv_mux_set_mux(struct clknode *clk, int index)
  96 {
  97         struct aw_clk_prediv_mux_sc *sc;
  98         uint32_t val;
  99
 100         sc = clknode_get_softc(clk);
 101
 102         DEVICE_LOCK(clk);
 103         READ4(clk, sc->offset, &val);
 104         val &= ~sc->mux_mask;
 105         val |= index << sc->mux_shift;
 106         WRITE4(clk, sc->offset, val);
 107         DEVICE_UNLOCK(clk);
 108
 109         return (0);
 110 }
 111
 112 static int
 113 aw_clk_prediv_mux_recalc(struct clknode *clk, uint64_t *freq)
 114 {
 115         struct aw_clk_prediv_mux_sc *sc;
 116         uint32_t val, div, prediv;
 117
 118         sc = clknode_get_softc(clk);
 119
 120         DEVICE_LOCK(clk);
 121         READ4(clk, sc->offset, &val);
 122         DEVICE_UNLOCK(clk);
 123
 124         div = aw_clk_get_factor(val, &sc->div);
 125         prediv = aw_clk_get_factor(val, &sc->prediv);
 126
 127         *freq = *freq / prediv / div;
 128         return (0);
 129 }
 130
 131 static clknode_method_t aw_prediv_mux_clknode_methods[] = {
 132         /* Device interface */
 133         CLKNODEMETHOD(clknode_init,             aw_clk_prediv_mux_init),
 134         CLKNODEMETHOD(clknode_set_mux,          aw_clk_prediv_mux_set_mux),
 135         CLKNODEMETHOD(clknode_recalc_freq,      aw_clk_prediv_mux_recalc),
 136         CLKNODEMETHOD_END
 137 };
 138
 139 DEFINE_CLASS_1(aw_prediv_mux_clknode, aw_prediv_mux_clknode_class,
 140     aw_prediv_mux_clknode_methods, sizeof(struct aw_clk_prediv_mux_sc),
 141     clknode_class);
 142
 143 int
 144 aw_clk_prediv_mux_register(struct clkdom *clkdom, struct aw_clk_prediv_mux_def *clkdef)
 145 {
 146         struct clknode *clk;
 147         struct aw_clk_prediv_mux_sc *sc;
 148
 149         clk = clknode_create(clkdom, &aw_prediv_mux_clknode_class, &clkdef->clkdef);
 150         if (clk == NULL)
 151                 return (1);
 152
 153         sc = clknode_get_softc(clk);
 154
 155         sc->offset = clkdef->offset;
 156
 157         sc->mux_shift = clkdef->mux_shift;
 158         sc->mux_mask = ((1 << clkdef->mux_width) - 1) << sc->mux_shift;
 159
 160         sc->div.shift = clkdef->div.shift;
 161         sc->div.mask = ((1 << clkdef->div.width) - 1) << sc->div.shift;
 162         sc->div.value = clkdef->div.value;
 163         sc->div.cond_shift = clkdef->div.cond_shift;
 164         sc->div.cond_mask = ((1 << clkdef->div.cond_width) - 1) << sc->div.shift;
 165         sc->div.cond_value = clkdef->div.cond_value;
 166         sc->div.flags = clkdef->div.flags;
 167
 168         sc->prediv.shift = clkdef->prediv.shift;
 169         sc->prediv.mask = ((1 << clkdef->prediv.width) - 1) << sc->prediv.shift;
 170         sc->prediv.value = clkdef->prediv.value;
 171         sc->prediv.cond_shift = clkdef->prediv.cond_shift;
 172         if (clkdef->prediv.cond_width != 0)
 173                 sc->prediv.cond_mask = ((1 << clkdef->prediv.cond_width) - 1) << sc->prediv.shift;
 174         else
 175                 sc->prediv.cond_mask = clkdef->prediv.cond_mask;
 176         sc->prediv.cond_value = clkdef->prediv.cond_value;
 177         sc->prediv.flags = clkdef->prediv.flags;
 178
 179         sc->flags = clkdef->flags;
 180
 181         clknode_register(clkdom, clk);
 182
 183         return (0);
 184 }