drivers/timer/timer-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2015 Thomas Chou <[email protected]>
   4  */
   5
   6 #include <common.h>
   7 #include <clk.h>
   8 #include <cpu.h>
   9 #include <dm.h>
  10 #include <dm/lists.h>
  11 #include <dm/device_compat.h>
  12 #include <dm/device-internal.h>
  13 #include <dm/root.h>
  14 #include <errno.h>
  15 #include <init.h>
  16 #include <timer.h>
  17 #include <linux/err.h>
  18
  19 DECLARE_GLOBAL_DATA_PTR;
  20
  21 /*
  22  * Implement a timer uclass to work with lib/time.c. The timer is usually
  23  * a 32/64 bits free-running up counter. The get_rate() method is used to get
  24  * the input clock frequency of the timer. The get_count() method is used
  25  * to get the current 64 bits count value. If the hardware is counting down,
  26  * the value should be inversed inside the method. There may be no real
  27  * tick, and no timer interrupt.
  28  */
  29
  30 int notrace timer_get_count(struct udevice *dev, u64 *count)
  31 {
  32         const struct timer_ops *ops = device_get_ops(dev);
  33
  34         if (!ops->get_count)
  35                 return -ENOSYS;
  36
  37         return ops->get_count(dev, count);
  38 }
  39
  40 unsigned long notrace timer_get_rate(struct udevice *dev)
  41 {
  42         struct timer_dev_priv *uc_priv = dev->uclass_priv;
  43
  44         return uc_priv->clock_rate;
  45 }
  46
  47 static int timer_pre_probe(struct udevice *dev)
  48 {
  49 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  50         struct timer_dev_priv *uc_priv = dev_get_uclass_priv(dev);
  51         struct clk timer_clk;
  52         int err;
  53         ulong ret;
  54
  55         /* It is possible that a timer device has a null ofnode */
  56         if (!dev_of_valid(dev))
  57                 return 0;
  58
  59         err = clk_get_by_index(dev, 0, &timer_clk);
  60         if (!err) {
  61                 ret = clk_get_rate(&timer_clk);
  62                 if (IS_ERR_VALUE(ret))
  63                         return ret;
  64                 uc_priv->clock_rate = ret;
  65         } else {
  66                 uc_priv->clock_rate =
  67                         dev_read_u32_default(dev, "clock-frequency", 0);
  68         }
  69 #endif
  70
  71         return 0;
  72 }
  73
  74 static int timer_post_probe(struct udevice *dev)
  75 {
  76         struct timer_dev_priv *uc_priv = dev_get_uclass_priv(dev);
  77
  78         if (!uc_priv->clock_rate)
  79                 return -EINVAL;
  80
  81         return 0;
  82 }
  83
  84 /*
  85  * TODO: should be CONFIG_IS_ENABLED(CPU), but the SPL config has _SUPPORT on
  86  * the end...
  87  */
  88 #if defined(CONFIG_CPU) || defined(CONFIG_SPL_CPU_SUPPORT)
  89 int timer_timebase_fallback(struct udevice *dev)
  90 {
  91         struct udevice *cpu;
  92         struct cpu_platdata *cpu_plat;
  93         struct timer_dev_priv *uc_priv = dev_get_uclass_priv(dev);
  94
  95         /* Did we get our clock rate from the device tree? */
  96         if (uc_priv->clock_rate)
  97                 return 0;
  98
  99         /* Fall back to timebase-frequency */
 100         dev_dbg(dev, "missing clocks or clock-frequency property; falling back on timebase-frequency\n");
 101         cpu = cpu_get_current_dev();
 102         if (!cpu)
 103                 return -ENODEV;
 104
 105         cpu_plat = dev_get_parent_platdata(cpu);
 106         if (!cpu_plat)
 107                 return -ENODEV;
 108
 109         uc_priv->clock_rate = cpu_plat->timebase_freq;
 110         return 0;
 111 }
 112 #endif
 113
 114 u64 timer_conv_64(u32 count)
 115 {
 116         /* increment tbh if tbl has rolled over */
 117         if (count < gd->timebase_l)
 118                 gd->timebase_h++;
 119         gd->timebase_l = count;
 120         return ((u64)gd->timebase_h << 32) | gd->timebase_l;
 121 }
 122
 123 int notrace dm_timer_init(void)
 124 {
 125         struct udevice *dev = NULL;
 126         __maybe_unused ofnode node;
 127         int ret;
 128
 129         if (gd->timer)
 130                 return 0;
 131
 132         /*
 133          * Directly access gd->dm_root to suppress error messages, if the
 134          * virtual root driver does not yet exist.
 135          */
 136         if (gd->dm_root == NULL)
 137                 return -EAGAIN;
 138
 139 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 140         /* Check for a chosen timer to be used for tick */
 141         node = ofnode_get_chosen_node("tick-timer");
 142
 143         if (ofnode_valid(node) &&
 144             uclass_get_device_by_ofnode(UCLASS_TIMER, node, &dev)) {
 145                 /*
 146                  * If the timer is not marked to be bound before
 147                  * relocation, bind it anyway.
 148                  */
 149                 if (!lists_bind_fdt(dm_root(), node, &dev, false)) {
 150                         ret = device_probe(dev);
 151                         if (ret)
 152                                 return ret;
 153                 }
 154         }
 155 #endif
 156
 157         if (!dev) {
 158                 /* Fall back to the first available timer */
 159                 ret = uclass_first_device_err(UCLASS_TIMER, &dev);
 160                 if (ret)
 161                         return ret;
 162         }
 163
 164         if (dev) {
 165                 gd->timer = dev;
 166                 return 0;
 167         }
 168
 169         return -ENODEV;
 170 }
 171
 172 UCLASS_DRIVER(timer) = {
 173         .id             = UCLASS_TIMER,
 174         .name           = "timer",
 175         .pre_probe      = timer_pre_probe,
 176         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 177         .post_probe     = timer_post_probe,
 178         .per_device_auto_alloc_size = sizeof(struct timer_dev_priv),
 179 };