1b745c079STero Kristo /* 2b745c079STero Kristo * SCI Clock driver for keystone based devices 3b745c079STero Kristo * 45f1d8970SAlexander A. Klimov * Copyright (C) 2015-2016 Texas Instruments Incorporated - https://www.ti.com/ 5b745c079STero Kristo * Tero Kristo <t-kristo@ti.com> 6b745c079STero Kristo * 7b745c079STero Kristo * This program is free software; you can redistribute it and/or modify 8b745c079STero Kristo * it under the terms of the GNU General Public License version 2 as 9b745c079STero Kristo * published by the Free Software Foundation. 10b745c079STero Kristo * 11b745c079STero Kristo * This program is distributed "as is" WITHOUT ANY WARRANTY of any 12b745c079STero Kristo * kind, whether express or implied; without even the implied warranty 13b745c079STero Kristo * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14b745c079STero Kristo * GNU General Public License for more details. 15b745c079STero Kristo */ 16b745c079STero Kristo #include <linux/clk-provider.h> 17b745c079STero Kristo #include <linux/err.h> 18b745c079STero Kristo #include <linux/io.h> 19b745c079STero Kristo #include <linux/module.h> 20b745c079STero Kristo #include <linux/of_address.h> 21b745c079STero Kristo #include <linux/of_device.h> 22b745c079STero Kristo #include <linux/platform_device.h> 23b745c079STero Kristo #include <linux/slab.h> 24b745c079STero Kristo #include <linux/soc/ti/ti_sci_protocol.h> 25f54d2cd3STero Kristo #include <linux/bsearch.h> 268e48b33fSTero Kristo #include <linux/list_sort.h> 27b745c079STero Kristo 28b745c079STero Kristo #define SCI_CLK_SSC_ENABLE BIT(0) 29b745c079STero Kristo #define SCI_CLK_ALLOW_FREQ_CHANGE BIT(1) 30b745c079STero Kristo #define SCI_CLK_INPUT_TERMINATION BIT(2) 31b745c079STero Kristo 32b745c079STero Kristo /** 33b745c079STero Kristo * struct sci_clk_provider - TI SCI clock provider representation 34b745c079STero Kristo * @sci: Handle to the System Control Interface protocol handler 35b745c079STero Kristo * @ops: Pointer to the SCI ops to be used by the clocks 36b745c079STero Kristo * @dev: Device pointer for the clock provider 37b745c079STero Kristo * @clocks: Clocks array for this device 38f54d2cd3STero Kristo * @num_clocks: Total number of clocks for this provider 39b745c079STero Kristo */ 40b745c079STero Kristo struct sci_clk_provider { 41b745c079STero Kristo const struct ti_sci_handle *sci; 42b745c079STero Kristo const struct ti_sci_clk_ops *ops; 43b745c079STero Kristo struct device *dev; 443c13933cSTero Kristo struct sci_clk **clocks; 45f54d2cd3STero Kristo int num_clocks; 46b745c079STero Kristo }; 47b745c079STero Kristo 48b745c079STero Kristo /** 49b745c079STero Kristo * struct sci_clk - TI SCI clock representation 50b745c079STero Kristo * @hw: Hardware clock cookie for common clock framework 51b745c079STero Kristo * @dev_id: Device index 52b745c079STero Kristo * @clk_id: Clock index 533c13933cSTero Kristo * @num_parents: Number of parents for this clock 54b745c079STero Kristo * @provider: Master clock provider 55b745c079STero Kristo * @flags: Flags for the clock 568e48b33fSTero Kristo * @node: Link for handling clocks probed via DT 57b745c079STero Kristo */ 58b745c079STero Kristo struct sci_clk { 59b745c079STero Kristo struct clk_hw hw; 60b745c079STero Kristo u16 dev_id; 613f1f22d8STero Kristo u32 clk_id; 623f1f22d8STero Kristo u32 num_parents; 63b745c079STero Kristo struct sci_clk_provider *provider; 64b745c079STero Kristo u8 flags; 658e48b33fSTero Kristo struct list_head node; 66b745c079STero Kristo }; 67b745c079STero Kristo 68b745c079STero Kristo #define to_sci_clk(_hw) container_of(_hw, struct sci_clk, hw) 69b745c079STero Kristo 70b745c079STero Kristo /** 71b745c079STero Kristo * sci_clk_prepare - Prepare (enable) a TI SCI clock 72b745c079STero Kristo * @hw: clock to prepare 73b745c079STero Kristo * 74b745c079STero Kristo * Prepares a clock to be actively used. Returns the SCI protocol status. 75b745c079STero Kristo */ 76b745c079STero Kristo static int sci_clk_prepare(struct clk_hw *hw) 77b745c079STero Kristo { 78b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 79b745c079STero Kristo bool enable_ssc = clk->flags & SCI_CLK_SSC_ENABLE; 80b745c079STero Kristo bool allow_freq_change = clk->flags & SCI_CLK_ALLOW_FREQ_CHANGE; 81b745c079STero Kristo bool input_termination = clk->flags & SCI_CLK_INPUT_TERMINATION; 82b745c079STero Kristo 83b745c079STero Kristo return clk->provider->ops->get_clock(clk->provider->sci, clk->dev_id, 84b745c079STero Kristo clk->clk_id, enable_ssc, 85b745c079STero Kristo allow_freq_change, 86b745c079STero Kristo input_termination); 87b745c079STero Kristo } 88b745c079STero Kristo 89b745c079STero Kristo /** 90b745c079STero Kristo * sci_clk_unprepare - Un-prepares (disables) a TI SCI clock 91b745c079STero Kristo * @hw: clock to unprepare 92b745c079STero Kristo * 93b745c079STero Kristo * Un-prepares a clock from active state. 94b745c079STero Kristo */ 95b745c079STero Kristo static void sci_clk_unprepare(struct clk_hw *hw) 96b745c079STero Kristo { 97b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 98b745c079STero Kristo int ret; 99b745c079STero Kristo 100b745c079STero Kristo ret = clk->provider->ops->put_clock(clk->provider->sci, clk->dev_id, 101b745c079STero Kristo clk->clk_id); 102b745c079STero Kristo if (ret) 103b745c079STero Kristo dev_err(clk->provider->dev, 104b745c079STero Kristo "unprepare failed for dev=%d, clk=%d, ret=%d\n", 105b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 106b745c079STero Kristo } 107b745c079STero Kristo 108b745c079STero Kristo /** 109b745c079STero Kristo * sci_clk_is_prepared - Check if a TI SCI clock is prepared or not 110b745c079STero Kristo * @hw: clock to check status for 111b745c079STero Kristo * 112b745c079STero Kristo * Checks if a clock is prepared (enabled) in hardware. Returns non-zero 113b745c079STero Kristo * value if clock is enabled, zero otherwise. 114b745c079STero Kristo */ 115b745c079STero Kristo static int sci_clk_is_prepared(struct clk_hw *hw) 116b745c079STero Kristo { 117b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 118b745c079STero Kristo bool req_state, current_state; 119b745c079STero Kristo int ret; 120b745c079STero Kristo 121b745c079STero Kristo ret = clk->provider->ops->is_on(clk->provider->sci, clk->dev_id, 122b745c079STero Kristo clk->clk_id, &req_state, 123b745c079STero Kristo ¤t_state); 124b745c079STero Kristo if (ret) { 125b745c079STero Kristo dev_err(clk->provider->dev, 126b745c079STero Kristo "is_prepared failed for dev=%d, clk=%d, ret=%d\n", 127b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 128b745c079STero Kristo return 0; 129b745c079STero Kristo } 130b745c079STero Kristo 131b745c079STero Kristo return req_state; 132b745c079STero Kristo } 133b745c079STero Kristo 134b745c079STero Kristo /** 135b745c079STero Kristo * sci_clk_recalc_rate - Get clock rate for a TI SCI clock 136b745c079STero Kristo * @hw: clock to get rate for 137b745c079STero Kristo * @parent_rate: parent rate provided by common clock framework, not used 138b745c079STero Kristo * 139b745c079STero Kristo * Gets the current clock rate of a TI SCI clock. Returns the current 140b745c079STero Kristo * clock rate, or zero in failure. 141b745c079STero Kristo */ 142b745c079STero Kristo static unsigned long sci_clk_recalc_rate(struct clk_hw *hw, 143b745c079STero Kristo unsigned long parent_rate) 144b745c079STero Kristo { 145b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 146b745c079STero Kristo u64 freq; 147b745c079STero Kristo int ret; 148b745c079STero Kristo 149b745c079STero Kristo ret = clk->provider->ops->get_freq(clk->provider->sci, clk->dev_id, 150b745c079STero Kristo clk->clk_id, &freq); 151b745c079STero Kristo if (ret) { 152b745c079STero Kristo dev_err(clk->provider->dev, 153b745c079STero Kristo "recalc-rate failed for dev=%d, clk=%d, ret=%d\n", 154b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 155b745c079STero Kristo return 0; 156b745c079STero Kristo } 157b745c079STero Kristo 158b745c079STero Kristo return freq; 159b745c079STero Kristo } 160b745c079STero Kristo 161b745c079STero Kristo /** 162b745c079STero Kristo * sci_clk_determine_rate - Determines a clock rate a clock can be set to 163b745c079STero Kristo * @hw: clock to change rate for 164b745c079STero Kristo * @req: requested rate configuration for the clock 165b745c079STero Kristo * 166b745c079STero Kristo * Determines a suitable clock rate and parent for a TI SCI clock. 167b745c079STero Kristo * The parent handling is un-used, as generally the parent clock rates 168b745c079STero Kristo * are not known by the kernel; instead these are internally handled 169b745c079STero Kristo * by the firmware. Returns 0 on success, negative error value on failure. 170b745c079STero Kristo */ 171b745c079STero Kristo static int sci_clk_determine_rate(struct clk_hw *hw, 172b745c079STero Kristo struct clk_rate_request *req) 173b745c079STero Kristo { 174b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 175b745c079STero Kristo int ret; 176b745c079STero Kristo u64 new_rate; 177b745c079STero Kristo 178b745c079STero Kristo ret = clk->provider->ops->get_best_match_freq(clk->provider->sci, 179b745c079STero Kristo clk->dev_id, 180b745c079STero Kristo clk->clk_id, 181b745c079STero Kristo req->min_rate, 182b745c079STero Kristo req->rate, 183b745c079STero Kristo req->max_rate, 184b745c079STero Kristo &new_rate); 185b745c079STero Kristo if (ret) { 186b745c079STero Kristo dev_err(clk->provider->dev, 187b745c079STero Kristo "determine-rate failed for dev=%d, clk=%d, ret=%d\n", 188b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 189b745c079STero Kristo return ret; 190b745c079STero Kristo } 191b745c079STero Kristo 192b745c079STero Kristo req->rate = new_rate; 193b745c079STero Kristo 194b745c079STero Kristo return 0; 195b745c079STero Kristo } 196b745c079STero Kristo 197b745c079STero Kristo /** 198b745c079STero Kristo * sci_clk_set_rate - Set rate for a TI SCI clock 199b745c079STero Kristo * @hw: clock to change rate for 200b745c079STero Kristo * @rate: target rate for the clock 201b745c079STero Kristo * @parent_rate: rate of the clock parent, not used for TI SCI clocks 202b745c079STero Kristo * 203b745c079STero Kristo * Sets a clock frequency for a TI SCI clock. Returns the TI SCI 204b745c079STero Kristo * protocol status. 205b745c079STero Kristo */ 206b745c079STero Kristo static int sci_clk_set_rate(struct clk_hw *hw, unsigned long rate, 207b745c079STero Kristo unsigned long parent_rate) 208b745c079STero Kristo { 209b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 210b745c079STero Kristo 211b745c079STero Kristo return clk->provider->ops->set_freq(clk->provider->sci, clk->dev_id, 212b745c079STero Kristo clk->clk_id, rate, rate, rate); 213b745c079STero Kristo } 214b745c079STero Kristo 215b745c079STero Kristo /** 216b745c079STero Kristo * sci_clk_get_parent - Get the current parent of a TI SCI clock 217b745c079STero Kristo * @hw: clock to get parent for 218b745c079STero Kristo * 219b745c079STero Kristo * Returns the index of the currently selected parent for a TI SCI clock. 220b745c079STero Kristo */ 221b745c079STero Kristo static u8 sci_clk_get_parent(struct clk_hw *hw) 222b745c079STero Kristo { 223b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 2243f1f22d8STero Kristo u32 parent_id = 0; 225b745c079STero Kristo int ret; 226b745c079STero Kristo 227b745c079STero Kristo ret = clk->provider->ops->get_parent(clk->provider->sci, clk->dev_id, 2283f1f22d8STero Kristo clk->clk_id, (void *)&parent_id); 229b745c079STero Kristo if (ret) { 230b745c079STero Kristo dev_err(clk->provider->dev, 231b745c079STero Kristo "get-parent failed for dev=%d, clk=%d, ret=%d\n", 232b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 233b745c079STero Kristo return 0; 234b745c079STero Kristo } 235b745c079STero Kristo 2363f1f22d8STero Kristo parent_id = parent_id - clk->clk_id - 1; 2373f1f22d8STero Kristo 2383f1f22d8STero Kristo return (u8)parent_id; 239b745c079STero Kristo } 240b745c079STero Kristo 241b745c079STero Kristo /** 242b745c079STero Kristo * sci_clk_set_parent - Set the parent of a TI SCI clock 243b745c079STero Kristo * @hw: clock to set parent for 244b745c079STero Kristo * @index: new parent index for the clock 245b745c079STero Kristo * 246b745c079STero Kristo * Sets the parent of a TI SCI clock. Return TI SCI protocol status. 247b745c079STero Kristo */ 248b745c079STero Kristo static int sci_clk_set_parent(struct clk_hw *hw, u8 index) 249b745c079STero Kristo { 250b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 251b745c079STero Kristo 252b745c079STero Kristo return clk->provider->ops->set_parent(clk->provider->sci, clk->dev_id, 253b745c079STero Kristo clk->clk_id, 254b745c079STero Kristo index + 1 + clk->clk_id); 255b745c079STero Kristo } 256b745c079STero Kristo 257b745c079STero Kristo static const struct clk_ops sci_clk_ops = { 258b745c079STero Kristo .prepare = sci_clk_prepare, 259b745c079STero Kristo .unprepare = sci_clk_unprepare, 260b745c079STero Kristo .is_prepared = sci_clk_is_prepared, 261b745c079STero Kristo .recalc_rate = sci_clk_recalc_rate, 262b745c079STero Kristo .determine_rate = sci_clk_determine_rate, 263b745c079STero Kristo .set_rate = sci_clk_set_rate, 264b745c079STero Kristo .get_parent = sci_clk_get_parent, 265b745c079STero Kristo .set_parent = sci_clk_set_parent, 266b745c079STero Kristo }; 267b745c079STero Kristo 268b745c079STero Kristo /** 269b745c079STero Kristo * _sci_clk_get - Gets a handle for an SCI clock 270b745c079STero Kristo * @provider: Handle to SCI clock provider 2713c13933cSTero Kristo * @sci_clk: Handle to the SCI clock to populate 272b745c079STero Kristo * 273b745c079STero Kristo * Gets a handle to an existing TI SCI hw clock, or builds a new clock 274b745c079STero Kristo * entry and registers it with the common clock framework. Called from 275b745c079STero Kristo * the common clock framework, when a corresponding of_clk_get call is 276b745c079STero Kristo * executed, or recursively from itself when parsing parent clocks. 2773c13933cSTero Kristo * Returns 0 on success, negative error code on failure. 278b745c079STero Kristo */ 2793c13933cSTero Kristo static int _sci_clk_build(struct sci_clk_provider *provider, 2803c13933cSTero Kristo struct sci_clk *sci_clk) 281b745c079STero Kristo { 282b745c079STero Kristo struct clk_init_data init = { NULL }; 283b745c079STero Kristo char *name = NULL; 284b745c079STero Kristo char **parent_names = NULL; 285b745c079STero Kristo int i; 2863c13933cSTero Kristo int ret = 0; 287b745c079STero Kristo 28896488c09STero Kristo name = kasprintf(GFP_KERNEL, "clk:%d:%d", sci_clk->dev_id, 28996488c09STero Kristo sci_clk->clk_id); 290b745c079STero Kristo 291b745c079STero Kristo init.name = name; 292b745c079STero Kristo 293b745c079STero Kristo /* 294b745c079STero Kristo * From kernel point of view, we only care about a clocks parents, 295b745c079STero Kristo * if it has more than 1 possible parent. In this case, it is going 296b745c079STero Kristo * to have mux functionality. Otherwise it is going to act as a root 297b745c079STero Kristo * clock. 298b745c079STero Kristo */ 2993c13933cSTero Kristo if (sci_clk->num_parents < 2) 3003c13933cSTero Kristo sci_clk->num_parents = 0; 301b745c079STero Kristo 3023c13933cSTero Kristo if (sci_clk->num_parents) { 3033c13933cSTero Kristo parent_names = kcalloc(sci_clk->num_parents, sizeof(char *), 304b745c079STero Kristo GFP_KERNEL); 305b745c079STero Kristo 306b745c079STero Kristo if (!parent_names) { 307b745c079STero Kristo ret = -ENOMEM; 308b745c079STero Kristo goto err; 309b745c079STero Kristo } 310b745c079STero Kristo 3113c13933cSTero Kristo for (i = 0; i < sci_clk->num_parents; i++) { 312b745c079STero Kristo char *parent_name; 313b745c079STero Kristo 31496488c09STero Kristo parent_name = kasprintf(GFP_KERNEL, "clk:%d:%d", 315b745c079STero Kristo sci_clk->dev_id, 316b745c079STero Kristo sci_clk->clk_id + 1 + i); 317b745c079STero Kristo if (!parent_name) { 318b745c079STero Kristo ret = -ENOMEM; 319b745c079STero Kristo goto err; 320b745c079STero Kristo } 321b745c079STero Kristo parent_names[i] = parent_name; 322b745c079STero Kristo } 323b745c079STero Kristo init.parent_names = (void *)parent_names; 324b745c079STero Kristo } 325b745c079STero Kristo 326b745c079STero Kristo init.ops = &sci_clk_ops; 3273c13933cSTero Kristo init.num_parents = sci_clk->num_parents; 328b745c079STero Kristo sci_clk->hw.init = &init; 329b745c079STero Kristo 330b745c079STero Kristo ret = devm_clk_hw_register(provider->dev, &sci_clk->hw); 331b745c079STero Kristo if (ret) 332b745c079STero Kristo dev_err(provider->dev, "failed clk register with %d\n", ret); 333b745c079STero Kristo 334b745c079STero Kristo err: 335b745c079STero Kristo if (parent_names) { 3363c13933cSTero Kristo for (i = 0; i < sci_clk->num_parents; i++) 337b745c079STero Kristo kfree(parent_names[i]); 338b745c079STero Kristo 339b745c079STero Kristo kfree(parent_names); 340b745c079STero Kristo } 341b745c079STero Kristo 342b745c079STero Kristo kfree(name); 343b745c079STero Kristo 3443c13933cSTero Kristo return ret; 345b745c079STero Kristo } 346b745c079STero Kristo 347f54d2cd3STero Kristo static int _cmp_sci_clk(const void *a, const void *b) 348f54d2cd3STero Kristo { 349f54d2cd3STero Kristo const struct sci_clk *ca = a; 350f54d2cd3STero Kristo const struct sci_clk *cb = *(struct sci_clk **)b; 351f54d2cd3STero Kristo 352f54d2cd3STero Kristo if (ca->dev_id == cb->dev_id && ca->clk_id == cb->clk_id) 353f54d2cd3STero Kristo return 0; 354f54d2cd3STero Kristo if (ca->dev_id > cb->dev_id || 355f54d2cd3STero Kristo (ca->dev_id == cb->dev_id && ca->clk_id > cb->clk_id)) 356f54d2cd3STero Kristo return 1; 357f54d2cd3STero Kristo return -1; 358f54d2cd3STero Kristo } 359f54d2cd3STero Kristo 360b745c079STero Kristo /** 361b745c079STero Kristo * sci_clk_get - Xlate function for getting clock handles 362b745c079STero Kristo * @clkspec: device tree clock specifier 363b745c079STero Kristo * @data: pointer to the clock provider 364b745c079STero Kristo * 365b745c079STero Kristo * Xlate function for retrieving clock TI SCI hw clock handles based on 366b745c079STero Kristo * device tree clock specifier. Called from the common clock framework, 367b745c079STero Kristo * when a corresponding of_clk_get call is executed. Returns a pointer 368b745c079STero Kristo * to the TI SCI hw clock struct, or ERR_PTR value in failure. 369b745c079STero Kristo */ 370b745c079STero Kristo static struct clk_hw *sci_clk_get(struct of_phandle_args *clkspec, void *data) 371b745c079STero Kristo { 372b745c079STero Kristo struct sci_clk_provider *provider = data; 373f54d2cd3STero Kristo struct sci_clk **clk; 374f54d2cd3STero Kristo struct sci_clk key; 375b745c079STero Kristo 376b745c079STero Kristo if (clkspec->args_count != 2) 377b745c079STero Kristo return ERR_PTR(-EINVAL); 378b745c079STero Kristo 379f54d2cd3STero Kristo key.dev_id = clkspec->args[0]; 380f54d2cd3STero Kristo key.clk_id = clkspec->args[1]; 381b745c079STero Kristo 382f54d2cd3STero Kristo clk = bsearch(&key, provider->clocks, provider->num_clocks, 383f54d2cd3STero Kristo sizeof(clk), _cmp_sci_clk); 384b745c079STero Kristo 385f54d2cd3STero Kristo if (!clk) 386b745c079STero Kristo return ERR_PTR(-ENODEV); 387f54d2cd3STero Kristo 388f54d2cd3STero Kristo return &(*clk)->hw; 389b745c079STero Kristo } 390b745c079STero Kristo 391b745c079STero Kristo static int ti_sci_init_clocks(struct sci_clk_provider *p) 392b745c079STero Kristo { 393b745c079STero Kristo int i; 3943c13933cSTero Kristo int ret; 395b745c079STero Kristo 3963c13933cSTero Kristo for (i = 0; i < p->num_clocks; i++) { 3973c13933cSTero Kristo ret = _sci_clk_build(p, p->clocks[i]); 3983c13933cSTero Kristo if (ret) 3993c13933cSTero Kristo return ret; 400b745c079STero Kristo } 401b745c079STero Kristo 402b745c079STero Kristo return 0; 403b745c079STero Kristo } 404b745c079STero Kristo 405b745c079STero Kristo static const struct of_device_id ti_sci_clk_of_match[] = { 4063c13933cSTero Kristo { .compatible = "ti,k2g-sci-clk" }, 407b745c079STero Kristo { /* Sentinel */ }, 408b745c079STero Kristo }; 409b745c079STero Kristo MODULE_DEVICE_TABLE(of, ti_sci_clk_of_match); 410b745c079STero Kristo 4118e48b33fSTero Kristo #ifdef CONFIG_TI_SCI_CLK_PROBE_FROM_FW 4124bfce5abSTero Kristo static int ti_sci_scan_clocks_from_fw(struct sci_clk_provider *provider) 413b745c079STero Kristo { 414b745c079STero Kristo int ret; 4153c13933cSTero Kristo int num_clks = 0; 4163c13933cSTero Kristo struct sci_clk **clks = NULL; 4173c13933cSTero Kristo struct sci_clk **tmp_clks; 4183c13933cSTero Kristo struct sci_clk *sci_clk; 4193c13933cSTero Kristo int max_clks = 0; 4203c13933cSTero Kristo int clk_id = 0; 4213c13933cSTero Kristo int dev_id = 0; 4223f1f22d8STero Kristo u32 num_parents = 0; 4233c13933cSTero Kristo int gap_size = 0; 4244bfce5abSTero Kristo struct device *dev = provider->dev; 425b745c079STero Kristo 4263c13933cSTero Kristo while (1) { 4273c13933cSTero Kristo ret = provider->ops->get_num_parents(provider->sci, dev_id, 4283f1f22d8STero Kristo clk_id, 4293f1f22d8STero Kristo (void *)&num_parents); 4303c13933cSTero Kristo if (ret) { 4313c13933cSTero Kristo gap_size++; 4323c13933cSTero Kristo if (!clk_id) { 4333c13933cSTero Kristo if (gap_size >= 5) 4343c13933cSTero Kristo break; 4353c13933cSTero Kristo dev_id++; 4363c13933cSTero Kristo } else { 4373c13933cSTero Kristo if (gap_size >= 2) { 4383c13933cSTero Kristo dev_id++; 4393c13933cSTero Kristo clk_id = 0; 4403c13933cSTero Kristo gap_size = 0; 4413c13933cSTero Kristo } else { 4423c13933cSTero Kristo clk_id++; 4433c13933cSTero Kristo } 4443c13933cSTero Kristo } 4453c13933cSTero Kristo continue; 4463c13933cSTero Kristo } 4473c13933cSTero Kristo 4483c13933cSTero Kristo gap_size = 0; 4493c13933cSTero Kristo 4503c13933cSTero Kristo if (num_clks == max_clks) { 4513c13933cSTero Kristo tmp_clks = devm_kmalloc_array(dev, max_clks + 64, 4523c13933cSTero Kristo sizeof(sci_clk), 4533c13933cSTero Kristo GFP_KERNEL); 4543c13933cSTero Kristo memcpy(tmp_clks, clks, max_clks * sizeof(sci_clk)); 4553c13933cSTero Kristo if (max_clks) 4563c13933cSTero Kristo devm_kfree(dev, clks); 4573c13933cSTero Kristo max_clks += 64; 4583c13933cSTero Kristo clks = tmp_clks; 4593c13933cSTero Kristo } 4603c13933cSTero Kristo 4613c13933cSTero Kristo sci_clk = devm_kzalloc(dev, sizeof(*sci_clk), GFP_KERNEL); 4623c13933cSTero Kristo if (!sci_clk) 4633c13933cSTero Kristo return -ENOMEM; 4643c13933cSTero Kristo sci_clk->dev_id = dev_id; 4653c13933cSTero Kristo sci_clk->clk_id = clk_id; 4663c13933cSTero Kristo sci_clk->provider = provider; 4673c13933cSTero Kristo sci_clk->num_parents = num_parents; 4683c13933cSTero Kristo 4693c13933cSTero Kristo clks[num_clks] = sci_clk; 4703c13933cSTero Kristo 4713c13933cSTero Kristo clk_id++; 4723c13933cSTero Kristo num_clks++; 4733c13933cSTero Kristo } 4743c13933cSTero Kristo 4753c13933cSTero Kristo provider->clocks = devm_kmalloc_array(dev, num_clks, sizeof(sci_clk), 4763c13933cSTero Kristo GFP_KERNEL); 4773c13933cSTero Kristo if (!provider->clocks) 4783c13933cSTero Kristo return -ENOMEM; 4793c13933cSTero Kristo 4803c13933cSTero Kristo memcpy(provider->clocks, clks, num_clks * sizeof(sci_clk)); 4813c13933cSTero Kristo 4823c13933cSTero Kristo provider->num_clocks = num_clks; 4833c13933cSTero Kristo 4843c13933cSTero Kristo devm_kfree(dev, clks); 4853c13933cSTero Kristo 4864bfce5abSTero Kristo return 0; 4874bfce5abSTero Kristo } 4884bfce5abSTero Kristo 4898e48b33fSTero Kristo #else 4908e48b33fSTero Kristo 4918e48b33fSTero Kristo static int _cmp_sci_clk_list(void *priv, struct list_head *a, 4928e48b33fSTero Kristo struct list_head *b) 4938e48b33fSTero Kristo { 4948e48b33fSTero Kristo struct sci_clk *ca = container_of(a, struct sci_clk, node); 4958e48b33fSTero Kristo struct sci_clk *cb = container_of(b, struct sci_clk, node); 4968e48b33fSTero Kristo 4978e48b33fSTero Kristo return _cmp_sci_clk(ca, &cb); 4988e48b33fSTero Kristo } 4998e48b33fSTero Kristo 5008e48b33fSTero Kristo static int ti_sci_scan_clocks_from_dt(struct sci_clk_provider *provider) 5018e48b33fSTero Kristo { 5028e48b33fSTero Kristo struct device *dev = provider->dev; 5038e48b33fSTero Kristo struct device_node *np = NULL; 5048e48b33fSTero Kristo int ret; 5058e48b33fSTero Kristo int index; 5068e48b33fSTero Kristo struct of_phandle_args args; 5078e48b33fSTero Kristo struct list_head clks; 5088e48b33fSTero Kristo struct sci_clk *sci_clk, *prev; 5098e48b33fSTero Kristo int num_clks = 0; 5108e48b33fSTero Kristo int num_parents; 5118e48b33fSTero Kristo int clk_id; 5128e48b33fSTero Kristo const char * const clk_names[] = { 5138e48b33fSTero Kristo "clocks", "assigned-clocks", "assigned-clock-parents", NULL 5148e48b33fSTero Kristo }; 5158e48b33fSTero Kristo const char * const *clk_name; 5168e48b33fSTero Kristo 5178e48b33fSTero Kristo INIT_LIST_HEAD(&clks); 5188e48b33fSTero Kristo 5198e48b33fSTero Kristo clk_name = clk_names; 5208e48b33fSTero Kristo 5218e48b33fSTero Kristo while (*clk_name) { 5228e48b33fSTero Kristo np = of_find_node_with_property(np, *clk_name); 5238e48b33fSTero Kristo if (!np) { 5248e48b33fSTero Kristo clk_name++; 5258e48b33fSTero Kristo break; 5268e48b33fSTero Kristo } 5278e48b33fSTero Kristo 5288e48b33fSTero Kristo if (!of_device_is_available(np)) 5298e48b33fSTero Kristo continue; 5308e48b33fSTero Kristo 5318e48b33fSTero Kristo index = 0; 5328e48b33fSTero Kristo 5338e48b33fSTero Kristo do { 5348e48b33fSTero Kristo ret = of_parse_phandle_with_args(np, *clk_name, 5358e48b33fSTero Kristo "#clock-cells", index, 5368e48b33fSTero Kristo &args); 5378e48b33fSTero Kristo if (ret) 5388e48b33fSTero Kristo break; 5398e48b33fSTero Kristo 5408e48b33fSTero Kristo if (args.args_count == 2 && args.np == dev->of_node) { 5418e48b33fSTero Kristo sci_clk = devm_kzalloc(dev, sizeof(*sci_clk), 5428e48b33fSTero Kristo GFP_KERNEL); 5438e48b33fSTero Kristo if (!sci_clk) 5448e48b33fSTero Kristo return -ENOMEM; 5458e48b33fSTero Kristo 5468e48b33fSTero Kristo sci_clk->dev_id = args.args[0]; 5478e48b33fSTero Kristo sci_clk->clk_id = args.args[1]; 5488e48b33fSTero Kristo sci_clk->provider = provider; 5498e48b33fSTero Kristo provider->ops->get_num_parents(provider->sci, 5508e48b33fSTero Kristo sci_clk->dev_id, 5518e48b33fSTero Kristo sci_clk->clk_id, 5523f1f22d8STero Kristo (void *)&sci_clk->num_parents); 5538e48b33fSTero Kristo list_add_tail(&sci_clk->node, &clks); 5548e48b33fSTero Kristo 5558e48b33fSTero Kristo num_clks++; 5568e48b33fSTero Kristo 5578e48b33fSTero Kristo num_parents = sci_clk->num_parents; 5588e48b33fSTero Kristo if (num_parents == 1) 5598e48b33fSTero Kristo num_parents = 0; 5608e48b33fSTero Kristo 5613f1f22d8STero Kristo /* 5623f1f22d8STero Kristo * Linux kernel has inherent limitation 5633f1f22d8STero Kristo * of 255 clock parents at the moment. 5643f1f22d8STero Kristo * Right now, it is not expected that 5653f1f22d8STero Kristo * any mux clock from sci-clk driver 5663f1f22d8STero Kristo * would exceed that limit either, but 5673f1f22d8STero Kristo * the ABI basically provides that 5683f1f22d8STero Kristo * possibility. Print out a warning if 5693f1f22d8STero Kristo * this happens for any clock. 5703f1f22d8STero Kristo */ 5713f1f22d8STero Kristo if (num_parents >= 255) { 5723f1f22d8STero Kristo dev_warn(dev, "too many parents for dev=%d, clk=%d (%d), cropping to 255.\n", 5733f1f22d8STero Kristo sci_clk->dev_id, 5743f1f22d8STero Kristo sci_clk->clk_id, num_parents); 5753f1f22d8STero Kristo num_parents = 255; 5763f1f22d8STero Kristo } 5773f1f22d8STero Kristo 5788e48b33fSTero Kristo clk_id = args.args[1] + 1; 5798e48b33fSTero Kristo 5808e48b33fSTero Kristo while (num_parents--) { 5818e48b33fSTero Kristo sci_clk = devm_kzalloc(dev, 5828e48b33fSTero Kristo sizeof(*sci_clk), 5838e48b33fSTero Kristo GFP_KERNEL); 5848e48b33fSTero Kristo if (!sci_clk) 5858e48b33fSTero Kristo return -ENOMEM; 5868e48b33fSTero Kristo sci_clk->dev_id = args.args[0]; 5878e48b33fSTero Kristo sci_clk->clk_id = clk_id++; 5888e48b33fSTero Kristo sci_clk->provider = provider; 5898e48b33fSTero Kristo list_add_tail(&sci_clk->node, &clks); 5908e48b33fSTero Kristo 5918e48b33fSTero Kristo num_clks++; 5928e48b33fSTero Kristo } 5938e48b33fSTero Kristo } 5948e48b33fSTero Kristo 5958e48b33fSTero Kristo index++; 5968e48b33fSTero Kristo } while (args.np); 5978e48b33fSTero Kristo } 5988e48b33fSTero Kristo 5998e48b33fSTero Kristo list_sort(NULL, &clks, _cmp_sci_clk_list); 6008e48b33fSTero Kristo 6018e48b33fSTero Kristo provider->clocks = devm_kmalloc_array(dev, num_clks, sizeof(sci_clk), 6028e48b33fSTero Kristo GFP_KERNEL); 6038e48b33fSTero Kristo if (!provider->clocks) 6048e48b33fSTero Kristo return -ENOMEM; 6058e48b33fSTero Kristo 6068e48b33fSTero Kristo num_clks = 0; 6078e48b33fSTero Kristo prev = NULL; 6088e48b33fSTero Kristo 6098e48b33fSTero Kristo list_for_each_entry(sci_clk, &clks, node) { 6108e48b33fSTero Kristo if (prev && prev->dev_id == sci_clk->dev_id && 6118e48b33fSTero Kristo prev->clk_id == sci_clk->clk_id) 6128e48b33fSTero Kristo continue; 6138e48b33fSTero Kristo 6148e48b33fSTero Kristo provider->clocks[num_clks++] = sci_clk; 6158e48b33fSTero Kristo prev = sci_clk; 6168e48b33fSTero Kristo } 6178e48b33fSTero Kristo 6188e48b33fSTero Kristo provider->num_clocks = num_clks; 6198e48b33fSTero Kristo 6208e48b33fSTero Kristo return 0; 6218e48b33fSTero Kristo } 6228e48b33fSTero Kristo #endif 6238e48b33fSTero Kristo 6244bfce5abSTero Kristo /** 6254bfce5abSTero Kristo * ti_sci_clk_probe - Probe function for the TI SCI clock driver 6264bfce5abSTero Kristo * @pdev: platform device pointer to be probed 6274bfce5abSTero Kristo * 6284bfce5abSTero Kristo * Probes the TI SCI clock device. Allocates a new clock provider 6294bfce5abSTero Kristo * and registers this to the common clock framework. Also applies 6304bfce5abSTero Kristo * any required flags to the identified clocks via clock lists 6314bfce5abSTero Kristo * supplied from DT. Returns 0 for success, negative error value 6324bfce5abSTero Kristo * for failure. 6334bfce5abSTero Kristo */ 6344bfce5abSTero Kristo static int ti_sci_clk_probe(struct platform_device *pdev) 6354bfce5abSTero Kristo { 6364bfce5abSTero Kristo struct device *dev = &pdev->dev; 6374bfce5abSTero Kristo struct device_node *np = dev->of_node; 6384bfce5abSTero Kristo struct sci_clk_provider *provider; 6394bfce5abSTero Kristo const struct ti_sci_handle *handle; 6404bfce5abSTero Kristo int ret; 6414bfce5abSTero Kristo 6424bfce5abSTero Kristo handle = devm_ti_sci_get_handle(dev); 6434bfce5abSTero Kristo if (IS_ERR(handle)) 6444bfce5abSTero Kristo return PTR_ERR(handle); 6454bfce5abSTero Kristo 6464bfce5abSTero Kristo provider = devm_kzalloc(dev, sizeof(*provider), GFP_KERNEL); 6474bfce5abSTero Kristo if (!provider) 6484bfce5abSTero Kristo return -ENOMEM; 6494bfce5abSTero Kristo 6504bfce5abSTero Kristo provider->sci = handle; 6514bfce5abSTero Kristo provider->ops = &handle->ops.clk_ops; 6524bfce5abSTero Kristo provider->dev = dev; 6534bfce5abSTero Kristo 6548e48b33fSTero Kristo #ifdef CONFIG_TI_SCI_CLK_PROBE_FROM_FW 6554bfce5abSTero Kristo ret = ti_sci_scan_clocks_from_fw(provider); 6564bfce5abSTero Kristo if (ret) { 6574bfce5abSTero Kristo dev_err(dev, "scan clocks from FW failed: %d\n", ret); 6584bfce5abSTero Kristo return ret; 6594bfce5abSTero Kristo } 6608e48b33fSTero Kristo #else 6618e48b33fSTero Kristo ret = ti_sci_scan_clocks_from_dt(provider); 6628e48b33fSTero Kristo if (ret) { 6638e48b33fSTero Kristo dev_err(dev, "scan clocks from DT failed: %d\n", ret); 6648e48b33fSTero Kristo return ret; 6658e48b33fSTero Kristo } 6668e48b33fSTero Kristo #endif 6674bfce5abSTero Kristo 668b745c079STero Kristo ret = ti_sci_init_clocks(provider); 669b745c079STero Kristo if (ret) { 670b745c079STero Kristo pr_err("ti-sci-init-clocks failed.\n"); 671b745c079STero Kristo return ret; 672b745c079STero Kristo } 673b745c079STero Kristo 674b745c079STero Kristo return of_clk_add_hw_provider(np, sci_clk_get, provider); 675b745c079STero Kristo } 676b745c079STero Kristo 677b745c079STero Kristo /** 678b745c079STero Kristo * ti_sci_clk_remove - Remove TI SCI clock device 679b745c079STero Kristo * @pdev: platform device pointer for the device to be removed 680b745c079STero Kristo * 681b745c079STero Kristo * Removes the TI SCI device. Unregisters the clock provider registered 682b745c079STero Kristo * via common clock framework. Any memory allocated for the device will 683b745c079STero Kristo * be free'd silently via the devm framework. Returns 0 always. 684b745c079STero Kristo */ 685b745c079STero Kristo static int ti_sci_clk_remove(struct platform_device *pdev) 686b745c079STero Kristo { 687b745c079STero Kristo of_clk_del_provider(pdev->dev.of_node); 688b745c079STero Kristo 689b745c079STero Kristo return 0; 690b745c079STero Kristo } 691b745c079STero Kristo 692b745c079STero Kristo static struct platform_driver ti_sci_clk_driver = { 693b745c079STero Kristo .probe = ti_sci_clk_probe, 694b745c079STero Kristo .remove = ti_sci_clk_remove, 695b745c079STero Kristo .driver = { 696b745c079STero Kristo .name = "ti-sci-clk", 697b745c079STero Kristo .of_match_table = of_match_ptr(ti_sci_clk_of_match), 698b745c079STero Kristo }, 699b745c079STero Kristo }; 700b745c079STero Kristo module_platform_driver(ti_sci_clk_driver); 701b745c079STero Kristo 702b745c079STero Kristo MODULE_LICENSE("GPL v2"); 703b745c079STero Kristo MODULE_DESCRIPTION("TI System Control Interface(SCI) Clock driver"); 704b745c079STero Kristo MODULE_AUTHOR("Tero Kristo"); 705b745c079STero Kristo MODULE_ALIAS("platform:ti-sci-clk"); 706