drivers/clk/at91/pmc.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Copyright (C) 2013 Boris BREZILLON <b.brezillon@overkiz.com>
   4  */
   5
   6 #include <linux/clk-provider.h>
   7 #include <linux/clkdev.h>
   8 #include <linux/clk/at91_pmc.h>
   9 #include <linux/of.h>
  10 #include <linux/mfd/syscon.h>
  11 #include <linux/platform_device.h>
  12 #include <linux/regmap.h>
  13 #include <linux/syscore_ops.h>
  14
  15 #include <asm/proc-fns.h>
  16
  17 #include <dt-bindings/clock/at91.h>
  18
  19 #include "pmc.h"
  20
  21 #define PMC_MAX_IDS 128
  22 #define PMC_MAX_PCKS 8
  23
  24 int of_at91_get_clk_range(struct device_node *np, const char *propname,
  25                           struct clk_range *range)
  26 {
  27         u32 min, max;
  28         int ret;
  29
  30         ret = of_property_read_u32_index(np, propname, 0, &min);
  31         if (ret)
  32                 return ret;
  33
  34         ret = of_property_read_u32_index(np, propname, 1, &max);
  35         if (ret)
  36                 return ret;
  37
  38         if (range) {
  39                 range->min = min;
  40                 range->max = max;
  41         }
  42
  43         return 0;
  44 }
  45 EXPORT_SYMBOL_GPL(of_at91_get_clk_range);
  46
  47 struct clk_hw *of_clk_hw_pmc_get(struct of_phandle_args *clkspec, void *data)
  48 {
  49         unsigned int type = clkspec->args[0];
  50         unsigned int idx = clkspec->args[1];
  51         struct pmc_data *pmc_data = data;
  52
  53         switch (type) {
  54         case PMC_TYPE_CORE:
  55                 if (idx < pmc_data->ncore)
  56                         return pmc_data->chws[idx];
  57                 break;
  58         case PMC_TYPE_SYSTEM:
  59                 if (idx < pmc_data->nsystem)
  60                         return pmc_data->shws[idx];
  61                 break;
  62         case PMC_TYPE_PERIPHERAL:
  63                 if (idx < pmc_data->nperiph)
  64                         return pmc_data->phws[idx];
  65                 break;
  66         case PMC_TYPE_GCK:
  67                 if (idx < pmc_data->ngck)
  68                         return pmc_data->ghws[idx];
  69                 break;
  70         default:
  71                 break;
  72         }
  73
  74         pr_err("%s: invalid type (%u) or index (%u)\n", __func__, type, idx);
  75
  76         return ERR_PTR(-EINVAL);
  77 }
  78
  79 struct pmc_data *pmc_data_allocate(unsigned int ncore, unsigned int nsystem,
  80                                    unsigned int nperiph, unsigned int ngck)
  81 {
  82         unsigned int num_clks = ncore + nsystem + nperiph + ngck;
  83         struct pmc_data *pmc_data;
  84
  85         pmc_data = kzalloc(struct_size(pmc_data, hwtable, num_clks),
  86                            GFP_KERNEL);
  87         if (!pmc_data)
  88                 return NULL;
  89
  90         pmc_data->ncore = ncore;
  91         pmc_data->chws = pmc_data->hwtable;
  92
  93         pmc_data->nsystem = nsystem;
  94         pmc_data->shws = pmc_data->chws + ncore;
  95
  96         pmc_data->nperiph = nperiph;
  97         pmc_data->phws = pmc_data->shws + nsystem;
  98
  99         pmc_data->ngck = ngck;
 100         pmc_data->ghws = pmc_data->phws + nperiph;
 101
 102         return pmc_data;
 103 }
 104
 105 #ifdef CONFIG_PM
 106 static struct regmap *pmcreg;
 107
 108 static u8 registered_ids[PMC_MAX_IDS];
 109 static u8 registered_pcks[PMC_MAX_PCKS];
 110
 111 static struct
 112 {
 113         u32 scsr;
 114         u32 pcsr0;
 115         u32 uckr;
 116         u32 mor;
 117         u32 mcfr;
 118         u32 pllar;
 119         u32 mckr;
 120         u32 usb;
 121         u32 imr;
 122         u32 pcsr1;
 123         u32 pcr[PMC_MAX_IDS];
 124         u32 audio_pll0;
 125         u32 audio_pll1;
 126         u32 pckr[PMC_MAX_PCKS];
 127 } pmc_cache;
 128
 129 /*
 130  * As Peripheral ID 0 is invalid on AT91 chips, the identifier is stored
 131  * without alteration in the table, and 0 is for unused clocks.
 132  */
 133 void pmc_register_id(u8 id)
 134 {
 135         int i;
 136
 137         for (i = 0; i < PMC_MAX_IDS; i++) {
 138                 if (registered_ids[i] == 0) {
 139                         registered_ids[i] = id;
 140                         break;
 141                 }
 142                 if (registered_ids[i] == id)
 143                         break;
 144         }
 145 }
 146
 147 /*
 148  * As Programmable Clock 0 is valid on AT91 chips, there is an offset
 149  * of 1 between the stored value and the real clock ID.
 150  */
 151 void pmc_register_pck(u8 pck)
 152 {
 153         int i;
 154
 155         for (i = 0; i < PMC_MAX_PCKS; i++) {
 156                 if (registered_pcks[i] == 0) {
 157                         registered_pcks[i] = pck + 1;
 158                         break;
 159                 }
 160                 if (registered_pcks[i] == (pck + 1))
 161                         break;
 162         }
 163 }
 164
 165 static int pmc_suspend(void)
 166 {
 167         int i;
 168         u8 num;
 169
 170         regmap_read(pmcreg, AT91_PMC_SCSR, &pmc_cache.scsr);
 171         regmap_read(pmcreg, AT91_PMC_PCSR, &pmc_cache.pcsr0);
 172         regmap_read(pmcreg, AT91_CKGR_UCKR, &pmc_cache.uckr);
 173         regmap_read(pmcreg, AT91_CKGR_MOR, &pmc_cache.mor);
 174         regmap_read(pmcreg, AT91_CKGR_MCFR, &pmc_cache.mcfr);
 175         regmap_read(pmcreg, AT91_CKGR_PLLAR, &pmc_cache.pllar);
 176         regmap_read(pmcreg, AT91_PMC_MCKR, &pmc_cache.mckr);
 177         regmap_read(pmcreg, AT91_PMC_USB, &pmc_cache.usb);
 178         regmap_read(pmcreg, AT91_PMC_IMR, &pmc_cache.imr);
 179         regmap_read(pmcreg, AT91_PMC_PCSR1, &pmc_cache.pcsr1);
 180
 181         for (i = 0; registered_ids[i]; i++) {
 182                 regmap_write(pmcreg, AT91_PMC_PCR,
 183                              (registered_ids[i] & AT91_PMC_PCR_PID_MASK));
 184                 regmap_read(pmcreg, AT91_PMC_PCR,
 185                             &pmc_cache.pcr[registered_ids[i]]);
 186         }
 187         for (i = 0; registered_pcks[i]; i++) {
 188                 num = registered_pcks[i] - 1;
 189                 regmap_read(pmcreg, AT91_PMC_PCKR(num), &pmc_cache.pckr[num]);
 190         }
 191
 192         return 0;
 193 }
 194
 195 static bool pmc_ready(unsigned int mask)
 196 {
 197         unsigned int status;
 198
 199         regmap_read(pmcreg, AT91_PMC_SR, &status);
 200
 201         return ((status & mask) == mask) ? 1 : 0;
 202 }
 203
 204 static void pmc_resume(void)
 205 {
 206         int i;
 207         u8 num;
 208         u32 tmp;
 209         u32 mask = AT91_PMC_MCKRDY | AT91_PMC_LOCKA;
 210
 211         regmap_read(pmcreg, AT91_PMC_MCKR, &tmp);
 212         if (pmc_cache.mckr != tmp)
 213                 pr_warn("MCKR was not configured properly by the firmware\n");
 214         regmap_read(pmcreg, AT91_CKGR_PLLAR, &tmp);
 215         if (pmc_cache.pllar != tmp)
 216                 pr_warn("PLLAR was not configured properly by the firmware\n");
 217
 218         regmap_write(pmcreg, AT91_PMC_SCER, pmc_cache.scsr);
 219         regmap_write(pmcreg, AT91_PMC_PCER, pmc_cache.pcsr0);
 220         regmap_write(pmcreg, AT91_CKGR_UCKR, pmc_cache.uckr);
 221         regmap_write(pmcreg, AT91_CKGR_MOR, pmc_cache.mor);
 222         regmap_write(pmcreg, AT91_CKGR_MCFR, pmc_cache.mcfr);
 223         regmap_write(pmcreg, AT91_PMC_USB, pmc_cache.usb);
 224         regmap_write(pmcreg, AT91_PMC_IMR, pmc_cache.imr);
 225         regmap_write(pmcreg, AT91_PMC_PCER1, pmc_cache.pcsr1);
 226
 227         for (i = 0; registered_ids[i]; i++) {
 228                 regmap_write(pmcreg, AT91_PMC_PCR,
 229                              pmc_cache.pcr[registered_ids[i]] |
 230                              AT91_PMC_PCR_CMD);
 231         }
 232         for (i = 0; registered_pcks[i]; i++) {
 233                 num = registered_pcks[i] - 1;
 234                 regmap_write(pmcreg, AT91_PMC_PCKR(num), pmc_cache.pckr[num]);
 235         }
 236
 237         if (pmc_cache.uckr & AT91_PMC_UPLLEN)
 238                 mask |= AT91_PMC_LOCKU;
 239
 240         while (!pmc_ready(mask))
 241                 cpu_relax();
 242 }
 243
 244 static struct syscore_ops pmc_syscore_ops = {
 245         .suspend = pmc_suspend,
 246         .resume = pmc_resume,
 247 };
 248
 249 static const struct of_device_id sama5d2_pmc_dt_ids[] = {
 250         { .compatible = "atmel,sama5d2-pmc" },
 251         { /* sentinel */ }
 252 };
 253
 254 static int __init pmc_register_ops(void)
 255 {
 256         struct device_node *np;
 257
 258         np = of_find_matching_node(NULL, sama5d2_pmc_dt_ids);
 259         if (!np)
 260                 return -ENODEV;
 261
 262         pmcreg = device_node_to_regmap(np);
 263         of_node_put(np);
 264         if (IS_ERR(pmcreg))
 265                 return PTR_ERR(pmcreg);
 266
 267         register_syscore_ops(&pmc_syscore_ops);
 268
 269         return 0;
 270 }
 271 /* This has to happen before arch_initcall because of the tcb_clksrc driver */
 272 postcore_initcall(pmc_register_ops);
 273 #endif