drivers/timer/timer-uclass.c

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