drivers/clk/clk-ti-sci.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Texas Instruments System Control Interface (TI SCI) clock driver
   4  *
   5  * Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com/
   6  *      Andreas Dannenberg <dannenberg@ti.com>
   7  *
   8  * Loosely based on Linux kernel sci-clk.c...
   9  */
  10
  11 #include <common.h>
  12 #include <dm.h>
  13 #include <errno.h>
  14 #include <clk-uclass.h>
  15 #include <log.h>
  16 #include <malloc.h>
  17 #include <dm/device_compat.h>
  18 #include <linux/err.h>
  19 #include <linux/soc/ti/ti_sci_protocol.h>
  20 #include <k3-avs.h>
  21
  22 /**
  23  * struct ti_sci_clk_data - clock controller information structure
  24  * @sci: TI SCI handle used for communication with system controller
  25  */
  26 struct ti_sci_clk_data {
  27         const struct ti_sci_handle *sci;
  28 };
  29
  30 static int ti_sci_clk_probe(struct udevice *dev)
  31 {
  32         struct ti_sci_clk_data *data = dev_get_priv(dev);
  33
  34         debug("%s(dev=%p)\n", __func__, dev);
  35
  36         if (!data)
  37                 return -ENOMEM;
  38
  39         /* Store handle for communication with the system controller */
  40         data->sci = ti_sci_get_handle(dev);
  41         if (IS_ERR(data->sci))
  42                 return PTR_ERR(data->sci);
  43
  44         return 0;
  45 }
  46
  47 static int ti_sci_clk_of_xlate(struct clk *clk,
  48                                struct ofnode_phandle_args *args)
  49 {
  50         debug("%s(clk=%p, args_count=%d)\n", __func__, clk, args->args_count);
  51
  52         if (args->args_count != 2) {
  53                 debug("Invalid args_count: %d\n", args->args_count);
  54                 return -EINVAL;
  55         }
  56
  57         /*
  58          * On TI SCI-based devices, the clock provider id field is used as a
  59          * device ID, and the data field is used as the associated sub-ID.
  60          */
  61         clk->id = args->args[0];
  62         clk->data = args->args[1];
  63
  64         return 0;
  65 }
  66
  67 static int ti_sci_clk_request(struct clk *clk)
  68 {
  69         debug("%s(clk=%p)\n", __func__, clk);
  70         return 0;
  71 }
  72
  73 static int ti_sci_clk_free(struct clk *clk)
  74 {
  75         debug("%s(clk=%p)\n", __func__, clk);
  76         return 0;
  77 }
  78
  79 static ulong ti_sci_clk_get_rate(struct clk *clk)
  80 {
  81         struct ti_sci_clk_data *data = dev_get_priv(clk->dev);
  82         const struct ti_sci_handle *sci = data->sci;
  83         const struct ti_sci_clk_ops *cops = &sci->ops.clk_ops;
  84         u64 current_freq;
  85         int ret;
  86
  87         debug("%s(clk=%p)\n", __func__, clk);
  88
  89         ret = cops->get_freq(sci, clk->id, clk->data, &current_freq);
  90         if (ret) {
  91                 dev_err(clk->dev, "%s: get_freq failed (%d)\n", __func__, ret);
  92                 return ret;
  93         }
  94
  95         debug("%s(current_freq=%llu)\n", __func__, current_freq);
  96
  97         return current_freq;
  98 }
  99
 100 static ulong ti_sci_clk_set_rate(struct clk *clk, ulong rate)
 101 {
 102         struct ti_sci_clk_data *data = dev_get_priv(clk->dev);
 103         const struct ti_sci_handle *sci = data->sci;
 104         const struct ti_sci_clk_ops *cops = &sci->ops.clk_ops;
 105         int ret;
 106
 107         debug("%s(clk=%p, rate=%lu)\n", __func__, clk, rate);
 108
 109 #ifdef CONFIG_K3_AVS0
 110         k3_avs_notify_freq(clk->id, clk->data, rate);
 111 #endif
 112
 113         ret = cops->set_freq(sci, clk->id, clk->data, 0, rate, ULONG_MAX);
 114         if (ret)
 115                 dev_err(clk->dev, "%s: set_freq failed (%d)\n", __func__, ret);
 116
 117         return ret;
 118 }
 119
 120 static int ti_sci_clk_set_parent(struct clk *clk, struct clk *parent)
 121 {
 122         struct ti_sci_clk_data *data = dev_get_priv(clk->dev);
 123         const struct ti_sci_handle *sci = data->sci;
 124         const struct ti_sci_clk_ops *cops = &sci->ops.clk_ops;
 125         u8 num_parents;
 126         u8 parent_cid;
 127         int ret;
 128
 129         debug("%s(clk=%p, parent=%p)\n", __func__, clk, parent);
 130
 131         /* Make sure the clock parent is valid for a given device ID */
 132         if (clk->id != parent->id)
 133                 return -EINVAL;
 134
 135         /* Make sure clock has parents that can be set */
 136         ret = cops->get_num_parents(sci, clk->id, clk->data, &num_parents);
 137         if (ret) {
 138                 dev_err(clk->dev, "%s: get_num_parents failed (%d)\n",
 139                         __func__, ret);
 140                 return ret;
 141         }
 142         if (num_parents < 2) {
 143                 dev_err(clk->dev, "%s: clock has no settable parents!\n",
 144                         __func__);
 145                 return -EINVAL;
 146         }
 147
 148         /* Make sure parent clock ID is valid */
 149         parent_cid = parent->data - clk->data - 1;
 150         if (parent_cid >= num_parents) {
 151                 dev_err(clk->dev, "%s: invalid parent clock!\n", __func__);
 152                 return -EINVAL;
 153         }
 154
 155         /* Ready to proceed to configure the new clock parent */
 156         ret = cops->set_parent(sci, clk->id, clk->data, parent->data);
 157         if (ret)
 158                 dev_err(clk->dev, "%s: set_parent failed (%d)\n", __func__,
 159                         ret);
 160
 161         return ret;
 162 }
 163
 164 static int ti_sci_clk_enable(struct clk *clk)
 165 {
 166         struct ti_sci_clk_data *data = dev_get_priv(clk->dev);
 167         const struct ti_sci_handle *sci = data->sci;
 168         const struct ti_sci_clk_ops *cops = &sci->ops.clk_ops;
 169         int ret;
 170
 171         debug("%s(clk=%p)\n", __func__, clk);
 172
 173         /*
 174          * Allow the System Controller to automatically manage the state of
 175          * this clock. If the device is enabled, then the clock is enabled.
 176          */
 177         ret = cops->put_clock(sci, clk->id, clk->data);
 178         if (ret)
 179                 dev_err(clk->dev, "%s: put_clock failed (%d)\n", __func__, ret);
 180
 181         return ret;
 182 }
 183
 184 static int ti_sci_clk_disable(struct clk *clk)
 185 {
 186         struct ti_sci_clk_data *data = dev_get_priv(clk->dev);
 187         const struct ti_sci_handle *sci = data->sci;
 188         const struct ti_sci_clk_ops *cops = &sci->ops.clk_ops;
 189         int ret;
 190
 191         debug("%s(clk=%p)\n", __func__, clk);
 192
 193         /* Unconditionally disable clock, regardless of state of the device */
 194         ret = cops->idle_clock(sci, clk->id, clk->data);
 195         if (ret)
 196                 dev_err(clk->dev, "%s: idle_clock failed (%d)\n", __func__,
 197                         ret);
 198
 199         return ret;
 200 }
 201
 202 static const struct udevice_id ti_sci_clk_of_match[] = {
 203         { .compatible = "ti,k2g-sci-clk" },
 204         { /* sentinel */ },
 205 };
 206
 207 static struct clk_ops ti_sci_clk_ops = {
 208         .of_xlate = ti_sci_clk_of_xlate,
 209         .request = ti_sci_clk_request,
 210         .rfree = ti_sci_clk_free,
 211         .get_rate = ti_sci_clk_get_rate,
 212         .set_rate = ti_sci_clk_set_rate,
 213         .set_parent = ti_sci_clk_set_parent,
 214         .enable = ti_sci_clk_enable,
 215         .disable = ti_sci_clk_disable,
 216 };
 217
 218 U_BOOT_DRIVER(ti_sci_clk) = {
 219         .name = "ti-sci-clk",
 220         .id = UCLASS_CLK,
 221         .of_match = ti_sci_clk_of_match,
 222         .probe = ti_sci_clk_probe,
 223         .priv_auto_alloc_size = sizeof(struct ti_sci_clk_data),
 224         .ops = &ti_sci_clk_ops,
 225 };