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 57d3f3f499STero Kristo * @cached_req: Cached requested freq for determine rate calls 58d3f3f499STero Kristo * @cached_res: Cached result freq for determine rate calls 59b745c079STero Kristo */ 60b745c079STero Kristo struct sci_clk { 61b745c079STero Kristo struct clk_hw hw; 62b745c079STero Kristo u16 dev_id; 633f1f22d8STero Kristo u32 clk_id; 643f1f22d8STero Kristo u32 num_parents; 65b745c079STero Kristo struct sci_clk_provider *provider; 66b745c079STero Kristo u8 flags; 678e48b33fSTero Kristo struct list_head node; 68d3f3f499STero Kristo unsigned long cached_req; 69d3f3f499STero Kristo unsigned long cached_res; 70b745c079STero Kristo }; 71b745c079STero Kristo 72b745c079STero Kristo #define to_sci_clk(_hw) container_of(_hw, struct sci_clk, hw) 73b745c079STero Kristo 74b745c079STero Kristo /** 75b745c079STero Kristo * sci_clk_prepare - Prepare (enable) a TI SCI clock 76b745c079STero Kristo * @hw: clock to prepare 77b745c079STero Kristo * 78b745c079STero Kristo * Prepares a clock to be actively used. Returns the SCI protocol status. 79b745c079STero Kristo */ 80b745c079STero Kristo static int sci_clk_prepare(struct clk_hw *hw) 81b745c079STero Kristo { 82b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 83b745c079STero Kristo bool enable_ssc = clk->flags & SCI_CLK_SSC_ENABLE; 84b745c079STero Kristo bool allow_freq_change = clk->flags & SCI_CLK_ALLOW_FREQ_CHANGE; 85b745c079STero Kristo bool input_termination = clk->flags & SCI_CLK_INPUT_TERMINATION; 86b745c079STero Kristo 87b745c079STero Kristo return clk->provider->ops->get_clock(clk->provider->sci, clk->dev_id, 88b745c079STero Kristo clk->clk_id, enable_ssc, 89b745c079STero Kristo allow_freq_change, 90b745c079STero Kristo input_termination); 91b745c079STero Kristo } 92b745c079STero Kristo 93b745c079STero Kristo /** 94b745c079STero Kristo * sci_clk_unprepare - Un-prepares (disables) a TI SCI clock 95b745c079STero Kristo * @hw: clock to unprepare 96b745c079STero Kristo * 97b745c079STero Kristo * Un-prepares a clock from active state. 98b745c079STero Kristo */ 99b745c079STero Kristo static void sci_clk_unprepare(struct clk_hw *hw) 100b745c079STero Kristo { 101b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 102b745c079STero Kristo int ret; 103b745c079STero Kristo 104b745c079STero Kristo ret = clk->provider->ops->put_clock(clk->provider->sci, clk->dev_id, 105b745c079STero Kristo clk->clk_id); 106b745c079STero Kristo if (ret) 107b745c079STero Kristo dev_err(clk->provider->dev, 108b745c079STero Kristo "unprepare failed for dev=%d, clk=%d, ret=%d\n", 109b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 110b745c079STero Kristo } 111b745c079STero Kristo 112b745c079STero Kristo /** 113b745c079STero Kristo * sci_clk_is_prepared - Check if a TI SCI clock is prepared or not 114b745c079STero Kristo * @hw: clock to check status for 115b745c079STero Kristo * 116b745c079STero Kristo * Checks if a clock is prepared (enabled) in hardware. Returns non-zero 117b745c079STero Kristo * value if clock is enabled, zero otherwise. 118b745c079STero Kristo */ 119b745c079STero Kristo static int sci_clk_is_prepared(struct clk_hw *hw) 120b745c079STero Kristo { 121b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 122b745c079STero Kristo bool req_state, current_state; 123b745c079STero Kristo int ret; 124b745c079STero Kristo 125b745c079STero Kristo ret = clk->provider->ops->is_on(clk->provider->sci, clk->dev_id, 126b745c079STero Kristo clk->clk_id, &req_state, 127b745c079STero Kristo ¤t_state); 128b745c079STero Kristo if (ret) { 129b745c079STero Kristo dev_err(clk->provider->dev, 130b745c079STero Kristo "is_prepared failed for dev=%d, clk=%d, ret=%d\n", 131b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 132b745c079STero Kristo return 0; 133b745c079STero Kristo } 134b745c079STero Kristo 135b745c079STero Kristo return req_state; 136b745c079STero Kristo } 137b745c079STero Kristo 138b745c079STero Kristo /** 139b745c079STero Kristo * sci_clk_recalc_rate - Get clock rate for a TI SCI clock 140b745c079STero Kristo * @hw: clock to get rate for 141b745c079STero Kristo * @parent_rate: parent rate provided by common clock framework, not used 142b745c079STero Kristo * 143b745c079STero Kristo * Gets the current clock rate of a TI SCI clock. Returns the current 144b745c079STero Kristo * clock rate, or zero in failure. 145b745c079STero Kristo */ 146b745c079STero Kristo static unsigned long sci_clk_recalc_rate(struct clk_hw *hw, 147b745c079STero Kristo unsigned long parent_rate) 148b745c079STero Kristo { 149b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 150b745c079STero Kristo u64 freq; 151b745c079STero Kristo int ret; 152b745c079STero Kristo 153b745c079STero Kristo ret = clk->provider->ops->get_freq(clk->provider->sci, clk->dev_id, 154b745c079STero Kristo clk->clk_id, &freq); 155b745c079STero Kristo if (ret) { 156b745c079STero Kristo dev_err(clk->provider->dev, 157b745c079STero Kristo "recalc-rate failed for dev=%d, clk=%d, ret=%d\n", 158b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 159b745c079STero Kristo return 0; 160b745c079STero Kristo } 161b745c079STero Kristo 162b745c079STero Kristo return freq; 163b745c079STero Kristo } 164b745c079STero Kristo 165b745c079STero Kristo /** 166b745c079STero Kristo * sci_clk_determine_rate - Determines a clock rate a clock can be set to 167b745c079STero Kristo * @hw: clock to change rate for 168b745c079STero Kristo * @req: requested rate configuration for the clock 169b745c079STero Kristo * 170b745c079STero Kristo * Determines a suitable clock rate and parent for a TI SCI clock. 171b745c079STero Kristo * The parent handling is un-used, as generally the parent clock rates 172b745c079STero Kristo * are not known by the kernel; instead these are internally handled 173b745c079STero Kristo * by the firmware. Returns 0 on success, negative error value on failure. 174b745c079STero Kristo */ 175b745c079STero Kristo static int sci_clk_determine_rate(struct clk_hw *hw, 176b745c079STero Kristo struct clk_rate_request *req) 177b745c079STero Kristo { 178b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 179b745c079STero Kristo int ret; 180b745c079STero Kristo u64 new_rate; 181b745c079STero Kristo 182d3f3f499STero Kristo if (clk->cached_req && clk->cached_req == req->rate) { 183d3f3f499STero Kristo req->rate = clk->cached_res; 184d3f3f499STero Kristo return 0; 185d3f3f499STero Kristo } 186d3f3f499STero Kristo 187b745c079STero Kristo ret = clk->provider->ops->get_best_match_freq(clk->provider->sci, 188b745c079STero Kristo clk->dev_id, 189b745c079STero Kristo clk->clk_id, 190b745c079STero Kristo req->min_rate, 191b745c079STero Kristo req->rate, 192b745c079STero Kristo req->max_rate, 193b745c079STero Kristo &new_rate); 194b745c079STero Kristo if (ret) { 195b745c079STero Kristo dev_err(clk->provider->dev, 196b745c079STero Kristo "determine-rate failed for dev=%d, clk=%d, ret=%d\n", 197b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 198b745c079STero Kristo return ret; 199b745c079STero Kristo } 200b745c079STero Kristo 201d3f3f499STero Kristo clk->cached_req = req->rate; 202d3f3f499STero Kristo clk->cached_res = new_rate; 203d3f3f499STero Kristo 204b745c079STero Kristo req->rate = new_rate; 205b745c079STero Kristo 206b745c079STero Kristo return 0; 207b745c079STero Kristo } 208b745c079STero Kristo 209b745c079STero Kristo /** 210b745c079STero Kristo * sci_clk_set_rate - Set rate for a TI SCI clock 211b745c079STero Kristo * @hw: clock to change rate for 212b745c079STero Kristo * @rate: target rate for the clock 213b745c079STero Kristo * @parent_rate: rate of the clock parent, not used for TI SCI clocks 214b745c079STero Kristo * 215b745c079STero Kristo * Sets a clock frequency for a TI SCI clock. Returns the TI SCI 216b745c079STero Kristo * protocol status. 217b745c079STero Kristo */ 218b745c079STero Kristo static int sci_clk_set_rate(struct clk_hw *hw, unsigned long rate, 219b745c079STero Kristo unsigned long parent_rate) 220b745c079STero Kristo { 221b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 222b745c079STero Kristo 223b745c079STero Kristo return clk->provider->ops->set_freq(clk->provider->sci, clk->dev_id, 2244630ef13STero Kristo clk->clk_id, rate / 10 * 9, rate, 2254630ef13STero Kristo rate / 10 * 11); 226b745c079STero Kristo } 227b745c079STero Kristo 228b745c079STero Kristo /** 229b745c079STero Kristo * sci_clk_get_parent - Get the current parent of a TI SCI clock 230b745c079STero Kristo * @hw: clock to get parent for 231b745c079STero Kristo * 232b745c079STero Kristo * Returns the index of the currently selected parent for a TI SCI clock. 233b745c079STero Kristo */ 234b745c079STero Kristo static u8 sci_clk_get_parent(struct clk_hw *hw) 235b745c079STero Kristo { 236b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 2373f1f22d8STero Kristo u32 parent_id = 0; 238b745c079STero Kristo int ret; 239b745c079STero Kristo 240b745c079STero Kristo ret = clk->provider->ops->get_parent(clk->provider->sci, clk->dev_id, 2413f1f22d8STero Kristo clk->clk_id, (void *)&parent_id); 242b745c079STero Kristo if (ret) { 243b745c079STero Kristo dev_err(clk->provider->dev, 244b745c079STero Kristo "get-parent failed for dev=%d, clk=%d, ret=%d\n", 245b745c079STero Kristo clk->dev_id, clk->clk_id, ret); 246b745c079STero Kristo return 0; 247b745c079STero Kristo } 248b745c079STero Kristo 2493f1f22d8STero Kristo parent_id = parent_id - clk->clk_id - 1; 2503f1f22d8STero Kristo 2513f1f22d8STero Kristo return (u8)parent_id; 252b745c079STero Kristo } 253b745c079STero Kristo 254b745c079STero Kristo /** 255b745c079STero Kristo * sci_clk_set_parent - Set the parent of a TI SCI clock 256b745c079STero Kristo * @hw: clock to set parent for 257b745c079STero Kristo * @index: new parent index for the clock 258b745c079STero Kristo * 259b745c079STero Kristo * Sets the parent of a TI SCI clock. Return TI SCI protocol status. 260b745c079STero Kristo */ 261b745c079STero Kristo static int sci_clk_set_parent(struct clk_hw *hw, u8 index) 262b745c079STero Kristo { 263b745c079STero Kristo struct sci_clk *clk = to_sci_clk(hw); 264b745c079STero Kristo 265d3f3f499STero Kristo clk->cached_req = 0; 266d3f3f499STero Kristo 267b745c079STero Kristo return clk->provider->ops->set_parent(clk->provider->sci, clk->dev_id, 268b745c079STero Kristo clk->clk_id, 269b745c079STero Kristo index + 1 + clk->clk_id); 270b745c079STero Kristo } 271b745c079STero Kristo 272b745c079STero Kristo static const struct clk_ops sci_clk_ops = { 273b745c079STero Kristo .prepare = sci_clk_prepare, 274b745c079STero Kristo .unprepare = sci_clk_unprepare, 275b745c079STero Kristo .is_prepared = sci_clk_is_prepared, 276b745c079STero Kristo .recalc_rate = sci_clk_recalc_rate, 277b745c079STero Kristo .determine_rate = sci_clk_determine_rate, 278b745c079STero Kristo .set_rate = sci_clk_set_rate, 279b745c079STero Kristo .get_parent = sci_clk_get_parent, 280b745c079STero Kristo .set_parent = sci_clk_set_parent, 281b745c079STero Kristo }; 282b745c079STero Kristo 283b745c079STero Kristo /** 284b745c079STero Kristo * _sci_clk_get - Gets a handle for an SCI clock 285b745c079STero Kristo * @provider: Handle to SCI clock provider 2863c13933cSTero Kristo * @sci_clk: Handle to the SCI clock to populate 287b745c079STero Kristo * 288b745c079STero Kristo * Gets a handle to an existing TI SCI hw clock, or builds a new clock 289b745c079STero Kristo * entry and registers it with the common clock framework. Called from 290b745c079STero Kristo * the common clock framework, when a corresponding of_clk_get call is 291b745c079STero Kristo * executed, or recursively from itself when parsing parent clocks. 2923c13933cSTero Kristo * Returns 0 on success, negative error code on failure. 293b745c079STero Kristo */ 2943c13933cSTero Kristo static int _sci_clk_build(struct sci_clk_provider *provider, 2953c13933cSTero Kristo struct sci_clk *sci_clk) 296b745c079STero Kristo { 297b745c079STero Kristo struct clk_init_data init = { NULL }; 298b745c079STero Kristo char *name = NULL; 299b745c079STero Kristo char **parent_names = NULL; 300b745c079STero Kristo int i; 3013c13933cSTero Kristo int ret = 0; 302b745c079STero Kristo 30396488c09STero Kristo name = kasprintf(GFP_KERNEL, "clk:%d:%d", sci_clk->dev_id, 30496488c09STero Kristo sci_clk->clk_id); 305b745c079STero Kristo 306b745c079STero Kristo init.name = name; 307b745c079STero Kristo 308b745c079STero Kristo /* 309b745c079STero Kristo * From kernel point of view, we only care about a clocks parents, 310b745c079STero Kristo * if it has more than 1 possible parent. In this case, it is going 311b745c079STero Kristo * to have mux functionality. Otherwise it is going to act as a root 312b745c079STero Kristo * clock. 313b745c079STero Kristo */ 3143c13933cSTero Kristo if (sci_clk->num_parents < 2) 3153c13933cSTero Kristo sci_clk->num_parents = 0; 316b745c079STero Kristo 3173c13933cSTero Kristo if (sci_clk->num_parents) { 3183c13933cSTero Kristo parent_names = kcalloc(sci_clk->num_parents, sizeof(char *), 319b745c079STero Kristo GFP_KERNEL); 320b745c079STero Kristo 321b745c079STero Kristo if (!parent_names) { 322b745c079STero Kristo ret = -ENOMEM; 323b745c079STero Kristo goto err; 324b745c079STero Kristo } 325b745c079STero Kristo 3263c13933cSTero Kristo for (i = 0; i < sci_clk->num_parents; i++) { 327b745c079STero Kristo char *parent_name; 328b745c079STero Kristo 32996488c09STero Kristo parent_name = kasprintf(GFP_KERNEL, "clk:%d:%d", 330b745c079STero Kristo sci_clk->dev_id, 331b745c079STero Kristo sci_clk->clk_id + 1 + i); 332b745c079STero Kristo if (!parent_name) { 333b745c079STero Kristo ret = -ENOMEM; 334b745c079STero Kristo goto err; 335b745c079STero Kristo } 336b745c079STero Kristo parent_names[i] = parent_name; 337b745c079STero Kristo } 338b745c079STero Kristo init.parent_names = (void *)parent_names; 339b745c079STero Kristo } 340b745c079STero Kristo 341b745c079STero Kristo init.ops = &sci_clk_ops; 3423c13933cSTero Kristo init.num_parents = sci_clk->num_parents; 343b745c079STero Kristo sci_clk->hw.init = &init; 344b745c079STero Kristo 345b745c079STero Kristo ret = devm_clk_hw_register(provider->dev, &sci_clk->hw); 346b745c079STero Kristo if (ret) 347b745c079STero Kristo dev_err(provider->dev, "failed clk register with %d\n", ret); 348b745c079STero Kristo 349b745c079STero Kristo err: 350b745c079STero Kristo if (parent_names) { 3513c13933cSTero Kristo for (i = 0; i < sci_clk->num_parents; i++) 352b745c079STero Kristo kfree(parent_names[i]); 353b745c079STero Kristo 354b745c079STero Kristo kfree(parent_names); 355b745c079STero Kristo } 356b745c079STero Kristo 357b745c079STero Kristo kfree(name); 358b745c079STero Kristo 3593c13933cSTero Kristo return ret; 360b745c079STero Kristo } 361b745c079STero Kristo 362f54d2cd3STero Kristo static int _cmp_sci_clk(const void *a, const void *b) 363f54d2cd3STero Kristo { 364f54d2cd3STero Kristo const struct sci_clk *ca = a; 365f54d2cd3STero Kristo const struct sci_clk *cb = *(struct sci_clk **)b; 366f54d2cd3STero Kristo 367f54d2cd3STero Kristo if (ca->dev_id == cb->dev_id && ca->clk_id == cb->clk_id) 368f54d2cd3STero Kristo return 0; 369f54d2cd3STero Kristo if (ca->dev_id > cb->dev_id || 370f54d2cd3STero Kristo (ca->dev_id == cb->dev_id && ca->clk_id > cb->clk_id)) 371f54d2cd3STero Kristo return 1; 372f54d2cd3STero Kristo return -1; 373f54d2cd3STero Kristo } 374f54d2cd3STero Kristo 375b745c079STero Kristo /** 376b745c079STero Kristo * sci_clk_get - Xlate function for getting clock handles 377b745c079STero Kristo * @clkspec: device tree clock specifier 378b745c079STero Kristo * @data: pointer to the clock provider 379b745c079STero Kristo * 380b745c079STero Kristo * Xlate function for retrieving clock TI SCI hw clock handles based on 381b745c079STero Kristo * device tree clock specifier. Called from the common clock framework, 382b745c079STero Kristo * when a corresponding of_clk_get call is executed. Returns a pointer 383b745c079STero Kristo * to the TI SCI hw clock struct, or ERR_PTR value in failure. 384b745c079STero Kristo */ 385b745c079STero Kristo static struct clk_hw *sci_clk_get(struct of_phandle_args *clkspec, void *data) 386b745c079STero Kristo { 387b745c079STero Kristo struct sci_clk_provider *provider = data; 388f54d2cd3STero Kristo struct sci_clk **clk; 389f54d2cd3STero Kristo struct sci_clk key; 390b745c079STero Kristo 391b745c079STero Kristo if (clkspec->args_count != 2) 392b745c079STero Kristo return ERR_PTR(-EINVAL); 393b745c079STero Kristo 394f54d2cd3STero Kristo key.dev_id = clkspec->args[0]; 395f54d2cd3STero Kristo key.clk_id = clkspec->args[1]; 396b745c079STero Kristo 397f54d2cd3STero Kristo clk = bsearch(&key, provider->clocks, provider->num_clocks, 398f54d2cd3STero Kristo sizeof(clk), _cmp_sci_clk); 399b745c079STero Kristo 400f54d2cd3STero Kristo if (!clk) 401b745c079STero Kristo return ERR_PTR(-ENODEV); 402f54d2cd3STero Kristo 403f54d2cd3STero Kristo return &(*clk)->hw; 404b745c079STero Kristo } 405b745c079STero Kristo 406b745c079STero Kristo static int ti_sci_init_clocks(struct sci_clk_provider *p) 407b745c079STero Kristo { 408b745c079STero Kristo int i; 4093c13933cSTero Kristo int ret; 410b745c079STero Kristo 4113c13933cSTero Kristo for (i = 0; i < p->num_clocks; i++) { 4123c13933cSTero Kristo ret = _sci_clk_build(p, p->clocks[i]); 4133c13933cSTero Kristo if (ret) 4143c13933cSTero Kristo return ret; 415b745c079STero Kristo } 416b745c079STero Kristo 417b745c079STero Kristo return 0; 418b745c079STero Kristo } 419b745c079STero Kristo 420b745c079STero Kristo static const struct of_device_id ti_sci_clk_of_match[] = { 4213c13933cSTero Kristo { .compatible = "ti,k2g-sci-clk" }, 422b745c079STero Kristo { /* Sentinel */ }, 423b745c079STero Kristo }; 424b745c079STero Kristo MODULE_DEVICE_TABLE(of, ti_sci_clk_of_match); 425b745c079STero Kristo 4268e48b33fSTero Kristo #ifdef CONFIG_TI_SCI_CLK_PROBE_FROM_FW 4274bfce5abSTero Kristo static int ti_sci_scan_clocks_from_fw(struct sci_clk_provider *provider) 428b745c079STero Kristo { 429b745c079STero Kristo int ret; 4303c13933cSTero Kristo int num_clks = 0; 4313c13933cSTero Kristo struct sci_clk **clks = NULL; 4323c13933cSTero Kristo struct sci_clk **tmp_clks; 4333c13933cSTero Kristo struct sci_clk *sci_clk; 4343c13933cSTero Kristo int max_clks = 0; 4353c13933cSTero Kristo int clk_id = 0; 4363c13933cSTero Kristo int dev_id = 0; 4373f1f22d8STero Kristo u32 num_parents = 0; 4383c13933cSTero Kristo int gap_size = 0; 4394bfce5abSTero Kristo struct device *dev = provider->dev; 440b745c079STero Kristo 4413c13933cSTero Kristo while (1) { 4423c13933cSTero Kristo ret = provider->ops->get_num_parents(provider->sci, dev_id, 4433f1f22d8STero Kristo clk_id, 4443f1f22d8STero Kristo (void *)&num_parents); 4453c13933cSTero Kristo if (ret) { 4463c13933cSTero Kristo gap_size++; 4473c13933cSTero Kristo if (!clk_id) { 4483c13933cSTero Kristo if (gap_size >= 5) 4493c13933cSTero Kristo break; 4503c13933cSTero Kristo dev_id++; 4513c13933cSTero Kristo } else { 4523c13933cSTero Kristo if (gap_size >= 2) { 4533c13933cSTero Kristo dev_id++; 4543c13933cSTero Kristo clk_id = 0; 4553c13933cSTero Kristo gap_size = 0; 4563c13933cSTero Kristo } else { 4573c13933cSTero Kristo clk_id++; 4583c13933cSTero Kristo } 4593c13933cSTero Kristo } 4603c13933cSTero Kristo continue; 4613c13933cSTero Kristo } 4623c13933cSTero Kristo 4633c13933cSTero Kristo gap_size = 0; 4643c13933cSTero Kristo 4653c13933cSTero Kristo if (num_clks == max_clks) { 4663c13933cSTero Kristo tmp_clks = devm_kmalloc_array(dev, max_clks + 64, 4673c13933cSTero Kristo sizeof(sci_clk), 4683c13933cSTero Kristo GFP_KERNEL); 4693c13933cSTero Kristo memcpy(tmp_clks, clks, max_clks * sizeof(sci_clk)); 4703c13933cSTero Kristo if (max_clks) 4713c13933cSTero Kristo devm_kfree(dev, clks); 4723c13933cSTero Kristo max_clks += 64; 4733c13933cSTero Kristo clks = tmp_clks; 4743c13933cSTero Kristo } 4753c13933cSTero Kristo 4763c13933cSTero Kristo sci_clk = devm_kzalloc(dev, sizeof(*sci_clk), GFP_KERNEL); 4773c13933cSTero Kristo if (!sci_clk) 4783c13933cSTero Kristo return -ENOMEM; 4793c13933cSTero Kristo sci_clk->dev_id = dev_id; 4803c13933cSTero Kristo sci_clk->clk_id = clk_id; 4813c13933cSTero Kristo sci_clk->provider = provider; 4823c13933cSTero Kristo sci_clk->num_parents = num_parents; 4833c13933cSTero Kristo 4843c13933cSTero Kristo clks[num_clks] = sci_clk; 4853c13933cSTero Kristo 4863c13933cSTero Kristo clk_id++; 4873c13933cSTero Kristo num_clks++; 4883c13933cSTero Kristo } 4893c13933cSTero Kristo 4903c13933cSTero Kristo provider->clocks = devm_kmalloc_array(dev, num_clks, sizeof(sci_clk), 4913c13933cSTero Kristo GFP_KERNEL); 4923c13933cSTero Kristo if (!provider->clocks) 4933c13933cSTero Kristo return -ENOMEM; 4943c13933cSTero Kristo 4953c13933cSTero Kristo memcpy(provider->clocks, clks, num_clks * sizeof(sci_clk)); 4963c13933cSTero Kristo 4973c13933cSTero Kristo provider->num_clocks = num_clks; 4983c13933cSTero Kristo 4993c13933cSTero Kristo devm_kfree(dev, clks); 5003c13933cSTero Kristo 5014bfce5abSTero Kristo return 0; 5024bfce5abSTero Kristo } 5034bfce5abSTero Kristo 5048e48b33fSTero Kristo #else 5058e48b33fSTero Kristo 5068e48b33fSTero Kristo static int _cmp_sci_clk_list(void *priv, struct list_head *a, 5078e48b33fSTero Kristo struct list_head *b) 5088e48b33fSTero Kristo { 5098e48b33fSTero Kristo struct sci_clk *ca = container_of(a, struct sci_clk, node); 5108e48b33fSTero Kristo struct sci_clk *cb = container_of(b, struct sci_clk, node); 5118e48b33fSTero Kristo 5128e48b33fSTero Kristo return _cmp_sci_clk(ca, &cb); 5138e48b33fSTero Kristo } 5148e48b33fSTero Kristo 5158e48b33fSTero Kristo static int ti_sci_scan_clocks_from_dt(struct sci_clk_provider *provider) 5168e48b33fSTero Kristo { 5178e48b33fSTero Kristo struct device *dev = provider->dev; 5188e48b33fSTero Kristo struct device_node *np = NULL; 5198e48b33fSTero Kristo int ret; 5208e48b33fSTero Kristo int index; 5218e48b33fSTero Kristo struct of_phandle_args args; 5228e48b33fSTero Kristo struct list_head clks; 5238e48b33fSTero Kristo struct sci_clk *sci_clk, *prev; 5248e48b33fSTero Kristo int num_clks = 0; 5258e48b33fSTero Kristo int num_parents; 5268e48b33fSTero Kristo int clk_id; 5278e48b33fSTero Kristo const char * const clk_names[] = { 5288e48b33fSTero Kristo "clocks", "assigned-clocks", "assigned-clock-parents", NULL 5298e48b33fSTero Kristo }; 5308e48b33fSTero Kristo const char * const *clk_name; 5318e48b33fSTero Kristo 5328e48b33fSTero Kristo INIT_LIST_HEAD(&clks); 5338e48b33fSTero Kristo 5348e48b33fSTero Kristo clk_name = clk_names; 5358e48b33fSTero Kristo 5368e48b33fSTero Kristo while (*clk_name) { 5378e48b33fSTero Kristo np = of_find_node_with_property(np, *clk_name); 5388e48b33fSTero Kristo if (!np) { 5398e48b33fSTero Kristo clk_name++; 5402f05ccedSTero Kristo continue; 5418e48b33fSTero Kristo } 5428e48b33fSTero Kristo 5438e48b33fSTero Kristo if (!of_device_is_available(np)) 5448e48b33fSTero Kristo continue; 5458e48b33fSTero Kristo 5468e48b33fSTero Kristo index = 0; 5478e48b33fSTero Kristo 5488e48b33fSTero Kristo do { 5498e48b33fSTero Kristo ret = of_parse_phandle_with_args(np, *clk_name, 5508e48b33fSTero Kristo "#clock-cells", index, 5518e48b33fSTero Kristo &args); 5528e48b33fSTero Kristo if (ret) 5538e48b33fSTero Kristo break; 5548e48b33fSTero Kristo 5558e48b33fSTero Kristo if (args.args_count == 2 && args.np == dev->of_node) { 5568e48b33fSTero Kristo sci_clk = devm_kzalloc(dev, sizeof(*sci_clk), 5578e48b33fSTero Kristo GFP_KERNEL); 5588e48b33fSTero Kristo if (!sci_clk) 5598e48b33fSTero Kristo return -ENOMEM; 5608e48b33fSTero Kristo 5618e48b33fSTero Kristo sci_clk->dev_id = args.args[0]; 5628e48b33fSTero Kristo sci_clk->clk_id = args.args[1]; 5638e48b33fSTero Kristo sci_clk->provider = provider; 5648e48b33fSTero Kristo provider->ops->get_num_parents(provider->sci, 5658e48b33fSTero Kristo sci_clk->dev_id, 5668e48b33fSTero Kristo sci_clk->clk_id, 5673f1f22d8STero Kristo (void *)&sci_clk->num_parents); 5688e48b33fSTero Kristo list_add_tail(&sci_clk->node, &clks); 5698e48b33fSTero Kristo 5708e48b33fSTero Kristo num_clks++; 5718e48b33fSTero Kristo 5728e48b33fSTero Kristo num_parents = sci_clk->num_parents; 5738e48b33fSTero Kristo if (num_parents == 1) 5748e48b33fSTero Kristo num_parents = 0; 5758e48b33fSTero Kristo 5763f1f22d8STero Kristo /* 5773f1f22d8STero Kristo * Linux kernel has inherent limitation 5783f1f22d8STero Kristo * of 255 clock parents at the moment. 5793f1f22d8STero Kristo * Right now, it is not expected that 5803f1f22d8STero Kristo * any mux clock from sci-clk driver 5813f1f22d8STero Kristo * would exceed that limit either, but 5823f1f22d8STero Kristo * the ABI basically provides that 5833f1f22d8STero Kristo * possibility. Print out a warning if 5843f1f22d8STero Kristo * this happens for any clock. 5853f1f22d8STero Kristo */ 5863f1f22d8STero Kristo if (num_parents >= 255) { 5873f1f22d8STero Kristo dev_warn(dev, "too many parents for dev=%d, clk=%d (%d), cropping to 255.\n", 5883f1f22d8STero Kristo sci_clk->dev_id, 5893f1f22d8STero Kristo sci_clk->clk_id, num_parents); 5903f1f22d8STero Kristo num_parents = 255; 5913f1f22d8STero Kristo } 5923f1f22d8STero Kristo 5938e48b33fSTero Kristo clk_id = args.args[1] + 1; 5948e48b33fSTero Kristo 5958e48b33fSTero Kristo while (num_parents--) { 5968e48b33fSTero Kristo sci_clk = devm_kzalloc(dev, 5978e48b33fSTero Kristo sizeof(*sci_clk), 5988e48b33fSTero Kristo GFP_KERNEL); 5998e48b33fSTero Kristo if (!sci_clk) 6008e48b33fSTero Kristo return -ENOMEM; 6018e48b33fSTero Kristo sci_clk->dev_id = args.args[0]; 6028e48b33fSTero Kristo sci_clk->clk_id = clk_id++; 6038e48b33fSTero Kristo sci_clk->provider = provider; 6048e48b33fSTero Kristo list_add_tail(&sci_clk->node, &clks); 6058e48b33fSTero Kristo 6068e48b33fSTero Kristo num_clks++; 6078e48b33fSTero Kristo } 6088e48b33fSTero Kristo } 6098e48b33fSTero Kristo 6108e48b33fSTero Kristo index++; 6118e48b33fSTero Kristo } while (args.np); 6128e48b33fSTero Kristo } 6138e48b33fSTero Kristo 6148e48b33fSTero Kristo list_sort(NULL, &clks, _cmp_sci_clk_list); 6158e48b33fSTero Kristo 6168e48b33fSTero Kristo provider->clocks = devm_kmalloc_array(dev, num_clks, sizeof(sci_clk), 6178e48b33fSTero Kristo GFP_KERNEL); 6188e48b33fSTero Kristo if (!provider->clocks) 6198e48b33fSTero Kristo return -ENOMEM; 6208e48b33fSTero Kristo 6218e48b33fSTero Kristo num_clks = 0; 6228e48b33fSTero Kristo prev = NULL; 6238e48b33fSTero Kristo 6248e48b33fSTero Kristo list_for_each_entry(sci_clk, &clks, node) { 6258e48b33fSTero Kristo if (prev && prev->dev_id == sci_clk->dev_id && 6268e48b33fSTero Kristo prev->clk_id == sci_clk->clk_id) 6278e48b33fSTero Kristo continue; 6288e48b33fSTero Kristo 6298e48b33fSTero Kristo provider->clocks[num_clks++] = sci_clk; 6308e48b33fSTero Kristo prev = sci_clk; 6318e48b33fSTero Kristo } 6328e48b33fSTero Kristo 6338e48b33fSTero Kristo provider->num_clocks = num_clks; 6348e48b33fSTero Kristo 6358e48b33fSTero Kristo return 0; 6368e48b33fSTero Kristo } 6378e48b33fSTero Kristo #endif 6388e48b33fSTero Kristo 6394bfce5abSTero Kristo /** 6404bfce5abSTero Kristo * ti_sci_clk_probe - Probe function for the TI SCI clock driver 6414bfce5abSTero Kristo * @pdev: platform device pointer to be probed 6424bfce5abSTero Kristo * 6434bfce5abSTero Kristo * Probes the TI SCI clock device. Allocates a new clock provider 6444bfce5abSTero Kristo * and registers this to the common clock framework. Also applies 6454bfce5abSTero Kristo * any required flags to the identified clocks via clock lists 6464bfce5abSTero Kristo * supplied from DT. Returns 0 for success, negative error value 6474bfce5abSTero Kristo * for failure. 6484bfce5abSTero Kristo */ 6494bfce5abSTero Kristo static int ti_sci_clk_probe(struct platform_device *pdev) 6504bfce5abSTero Kristo { 6514bfce5abSTero Kristo struct device *dev = &pdev->dev; 6524bfce5abSTero Kristo struct device_node *np = dev->of_node; 6534bfce5abSTero Kristo struct sci_clk_provider *provider; 6544bfce5abSTero Kristo const struct ti_sci_handle *handle; 6554bfce5abSTero Kristo int ret; 6564bfce5abSTero Kristo 6574bfce5abSTero Kristo handle = devm_ti_sci_get_handle(dev); 6584bfce5abSTero Kristo if (IS_ERR(handle)) 6594bfce5abSTero Kristo return PTR_ERR(handle); 6604bfce5abSTero Kristo 6614bfce5abSTero Kristo provider = devm_kzalloc(dev, sizeof(*provider), GFP_KERNEL); 6624bfce5abSTero Kristo if (!provider) 6634bfce5abSTero Kristo return -ENOMEM; 6644bfce5abSTero Kristo 6654bfce5abSTero Kristo provider->sci = handle; 6664bfce5abSTero Kristo provider->ops = &handle->ops.clk_ops; 6674bfce5abSTero Kristo provider->dev = dev; 6684bfce5abSTero Kristo 6698e48b33fSTero Kristo #ifdef CONFIG_TI_SCI_CLK_PROBE_FROM_FW 6704bfce5abSTero Kristo ret = ti_sci_scan_clocks_from_fw(provider); 6714bfce5abSTero Kristo if (ret) { 6724bfce5abSTero Kristo dev_err(dev, "scan clocks from FW failed: %d\n", ret); 6734bfce5abSTero Kristo return ret; 6744bfce5abSTero Kristo } 6758e48b33fSTero Kristo #else 6768e48b33fSTero Kristo ret = ti_sci_scan_clocks_from_dt(provider); 6778e48b33fSTero Kristo if (ret) { 6788e48b33fSTero Kristo dev_err(dev, "scan clocks from DT failed: %d\n", ret); 6798e48b33fSTero Kristo return ret; 6808e48b33fSTero Kristo } 6818e48b33fSTero Kristo #endif 6824bfce5abSTero Kristo 683b745c079STero Kristo ret = ti_sci_init_clocks(provider); 684b745c079STero Kristo if (ret) { 685b745c079STero Kristo pr_err("ti-sci-init-clocks failed.\n"); 686b745c079STero Kristo return ret; 687b745c079STero Kristo } 688b745c079STero Kristo 689b745c079STero Kristo return of_clk_add_hw_provider(np, sci_clk_get, provider); 690b745c079STero Kristo } 691b745c079STero Kristo 692b745c079STero Kristo /** 693b745c079STero Kristo * ti_sci_clk_remove - Remove TI SCI clock device 694b745c079STero Kristo * @pdev: platform device pointer for the device to be removed 695b745c079STero Kristo * 696b745c079STero Kristo * Removes the TI SCI device. Unregisters the clock provider registered 697b745c079STero Kristo * via common clock framework. Any memory allocated for the device will 698b745c079STero Kristo * be free'd silently via the devm framework. Returns 0 always. 699b745c079STero Kristo */ 700b745c079STero Kristo static int ti_sci_clk_remove(struct platform_device *pdev) 701b745c079STero Kristo { 702b745c079STero Kristo of_clk_del_provider(pdev->dev.of_node); 703b745c079STero Kristo 704b745c079STero Kristo return 0; 705b745c079STero Kristo } 706b745c079STero Kristo 707b745c079STero Kristo static struct platform_driver ti_sci_clk_driver = { 708b745c079STero Kristo .probe = ti_sci_clk_probe, 709b745c079STero Kristo .remove = ti_sci_clk_remove, 710b745c079STero Kristo .driver = { 711b745c079STero Kristo .name = "ti-sci-clk", 712b745c079STero Kristo .of_match_table = of_match_ptr(ti_sci_clk_of_match), 713b745c079STero Kristo }, 714b745c079STero Kristo }; 715b745c079STero Kristo module_platform_driver(ti_sci_clk_driver); 716b745c079STero Kristo 717b745c079STero Kristo MODULE_LICENSE("GPL v2"); 718b745c079STero Kristo MODULE_DESCRIPTION("TI System Control Interface(SCI) Clock driver"); 719b745c079STero Kristo MODULE_AUTHOR("Tero Kristo"); 720b745c079STero Kristo MODULE_ALIAS("platform:ti-sci-clk"); 721