drivers/clk/imx/clk-pfdv2.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2016 Freescale Semiconductor, Inc.
   4  * Copyright 2017~2018 NXP
   5  *
   6  * Author: Dong Aisheng <aisheng.dong@nxp.com>
   7  *
   8  */
   9
  10 #include <linux/clk-provider.h>
  11 #include <linux/err.h>
  12 #include <linux/io.h>
  13 #include <linux/iopoll.h>
  14 #include <linux/slab.h>
  15
  16 #include "clk.h"
  17
  18 /**
  19  * struct clk_pfdv2 - IMX PFD clock
  20  * @clk_hw:     clock source
  21  * @reg:        PFD register address
  22  * @gate_bit:   Gate bit offset
  23  * @vld_bit:    Valid bit offset
  24  * @frac_off:   PLL Fractional Divider offset
  25  */
  26
  27 struct clk_pfdv2 {
  28         struct clk_hw   hw;
  29         void __iomem    *reg;
  30         u8              gate_bit;
  31         u8              vld_bit;
  32         u8              frac_off;
  33 };
  34
  35 #define to_clk_pfdv2(_hw) container_of(_hw, struct clk_pfdv2, hw)
  36
  37 #define CLK_PFDV2_FRAC_MASK 0x3f
  38
  39 #define LOCK_TIMEOUT_US         USEC_PER_MSEC
  40
  41 static DEFINE_SPINLOCK(pfd_lock);
  42
  43 static int clk_pfdv2_wait(struct clk_pfdv2 *pfd)
  44 {
  45         u32 val;
  46
  47         return readl_poll_timeout(pfd->reg, val, val & (1 << pfd->vld_bit),
  48                                   0, LOCK_TIMEOUT_US);
  49 }
  50
  51 static int clk_pfdv2_enable(struct clk_hw *hw)
  52 {
  53         struct clk_pfdv2 *pfd = to_clk_pfdv2(hw);
  54         unsigned long flags;
  55         u32 val;
  56
  57         spin_lock_irqsave(&pfd_lock, flags);
  58         val = readl_relaxed(pfd->reg);
  59         val &= ~(1 << pfd->gate_bit);
  60         writel_relaxed(val, pfd->reg);
  61         spin_unlock_irqrestore(&pfd_lock, flags);
  62
  63         return clk_pfdv2_wait(pfd);
  64 }
  65
  66 static void clk_pfdv2_disable(struct clk_hw *hw)
  67 {
  68         struct clk_pfdv2 *pfd = to_clk_pfdv2(hw);
  69         unsigned long flags;
  70         u32 val;
  71
  72         spin_lock_irqsave(&pfd_lock, flags);
  73         val = readl_relaxed(pfd->reg);
  74         val |= (1 << pfd->gate_bit);
  75         writel_relaxed(val, pfd->reg);
  76         spin_unlock_irqrestore(&pfd_lock, flags);
  77 }
  78
  79 static unsigned long clk_pfdv2_recalc_rate(struct clk_hw *hw,
  80                                            unsigned long parent_rate)
  81 {
  82         struct clk_pfdv2 *pfd = to_clk_pfdv2(hw);
  83         u64 tmp = parent_rate;
  84         u8 frac;
  85
  86         frac = (readl_relaxed(pfd->reg) >> pfd->frac_off)
  87                 & CLK_PFDV2_FRAC_MASK;
  88
  89         if (!frac) {
  90                 pr_debug("clk_pfdv2: %s invalid pfd frac value 0\n",
  91                          clk_hw_get_name(hw));
  92                 return 0;
  93         }
  94
  95         tmp *= 18;
  96         do_div(tmp, frac);
  97
  98         return tmp;
  99 }
 100
 101 static int clk_pfdv2_determine_rate(struct clk_hw *hw,
 102                                     struct clk_rate_request *req)
 103 {
 104         u64 tmp = req->best_parent_rate;
 105         u64 rate = req->rate;
 106         u8 frac;
 107
 108         tmp = tmp * 18 + rate / 2;
 109         do_div(tmp, rate);
 110         frac = tmp;
 111
 112         if (frac < 12)
 113                 frac = 12;
 114         else if (frac > 35)
 115                 frac = 35;
 116
 117         tmp = req->best_parent_rate;
 118         tmp *= 18;
 119         do_div(tmp, frac);
 120
 121         req->rate = tmp;
 122
 123         return 0;
 124 }
 125
 126 static int clk_pfdv2_is_enabled(struct clk_hw *hw)
 127 {
 128         struct clk_pfdv2 *pfd = to_clk_pfdv2(hw);
 129
 130         if (readl_relaxed(pfd->reg) & (1 << pfd->gate_bit))
 131                 return 0;
 132
 133         return 1;
 134 }
 135
 136 static int clk_pfdv2_set_rate(struct clk_hw *hw, unsigned long rate,
 137                               unsigned long parent_rate)
 138 {
 139         struct clk_pfdv2 *pfd = to_clk_pfdv2(hw);
 140         unsigned long flags;
 141         u64 tmp = parent_rate;
 142         u32 val;
 143         u8 frac;
 144
 145         if (!rate)
 146                 return -EINVAL;
 147
 148         /* PFD can NOT change rate without gating */
 149         WARN_ON(clk_pfdv2_is_enabled(hw));
 150
 151         tmp = tmp * 18 + rate / 2;
 152         do_div(tmp, rate);
 153         frac = tmp;
 154         if (frac < 12)
 155                 frac = 12;
 156         else if (frac > 35)
 157                 frac = 35;
 158
 159         spin_lock_irqsave(&pfd_lock, flags);
 160         val = readl_relaxed(pfd->reg);
 161         val &= ~(CLK_PFDV2_FRAC_MASK << pfd->frac_off);
 162         val |= frac << pfd->frac_off;
 163         writel_relaxed(val, pfd->reg);
 164         spin_unlock_irqrestore(&pfd_lock, flags);
 165
 166         return 0;
 167 }
 168
 169 static const struct clk_ops clk_pfdv2_ops = {
 170         .enable         = clk_pfdv2_enable,
 171         .disable        = clk_pfdv2_disable,
 172         .recalc_rate    = clk_pfdv2_recalc_rate,
 173         .determine_rate = clk_pfdv2_determine_rate,
 174         .set_rate       = clk_pfdv2_set_rate,
 175         .is_enabled     = clk_pfdv2_is_enabled,
 176 };
 177
 178 struct clk_hw *imx_clk_hw_pfdv2(const char *name, const char *parent_name,
 179                              void __iomem *reg, u8 idx)
 180 {
 181         struct clk_init_data init;
 182         struct clk_pfdv2 *pfd;
 183         struct clk_hw *hw;
 184         int ret;
 185
 186         WARN_ON(idx > 3);
 187
 188         pfd = kzalloc(sizeof(*pfd), GFP_KERNEL);
 189         if (!pfd)
 190                 return ERR_PTR(-ENOMEM);
 191
 192         pfd->reg = reg;
 193         pfd->gate_bit = (idx + 1) * 8 - 1;
 194         pfd->vld_bit = pfd->gate_bit - 1;
 195         pfd->frac_off = idx * 8;
 196
 197         init.name = name;
 198         init.ops = &clk_pfdv2_ops;
 199         init.parent_names = &parent_name;
 200         init.num_parents = 1;
 201         init.flags = CLK_SET_RATE_GATE;
 202
 203         pfd->hw.init = &init;
 204
 205         hw = &pfd->hw;
 206         ret = clk_hw_register(NULL, hw);
 207         if (ret) {
 208                 kfree(pfd);
 209                 hw = ERR_PTR(ret);
 210         }
 211
 212         return hw;
 213 }