blob: 3b829a50d1dbb6258f7e8a18bc6a042c0c2c6ea3 [file] [log] [blame]
Paul Walmsleyb04b65a2009-09-03 20:14:05 +03001/*
2 * omap_device implementation
3 *
Paul Walmsley887adea2010-07-26 16:34:33 -06004 * Copyright (C) 2009-2010 Nokia Corporation
Paul Walmsley4788da22010-05-18 20:24:05 -06005 * Paul Walmsley, Kevin Hilman
Paul Walmsleyb04b65a2009-09-03 20:14:05 +03006 *
7 * Developed in collaboration with (alphabetical order): Benoit
Paul Walmsley4788da22010-05-18 20:24:05 -06008 * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
Paul Walmsleyb04b65a2009-09-03 20:14:05 +03009 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
10 * Woodruff
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
15 *
16 * This code provides a consistent interface for OMAP device drivers
17 * to control power management and interconnect properties of their
18 * devices.
19 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -070020 * In the medium- to long-term, this code should be implemented as a
21 * proper omap_bus/omap_device in Linux, no more platform_data func
22 * pointers
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030023 *
24 *
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030025 */
26#undef DEBUG
27
28#include <linux/kernel.h>
29#include <linux/platform_device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090030#include <linux/slab.h>
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030031#include <linux/err.h>
32#include <linux/io.h>
Partha Basak4ef7aca2010-09-21 19:23:04 +020033#include <linux/clk.h>
Rajendra Nayakda0653f2011-02-25 15:40:21 -070034#include <linux/clkdev.h>
Tomeu Vizoso989561d2016-01-07 16:46:13 +010035#include <linux/pm_domain.h>
Kevin Hilman345f79b2011-05-31 16:08:09 -070036#include <linux/pm_runtime.h>
Benoit Coussondc2d07e2011-08-10 13:32:08 +020037#include <linux/of.h>
Tony Lindgrend85a2d62017-10-10 14:23:35 -070038#include <linux/of_address.h>
39#include <linux/of_irq.h>
Benoit Coussondc2d07e2011-08-10 13:32:08 +020040#include <linux/notifier.h>
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030041
Tony Lindgrendad12d12013-12-06 10:52:58 -080042#include "common.h"
Tony Lindgrenb76c8b192013-01-11 11:24:18 -080043#include "soc.h"
Tony Lindgren25c7d492012-10-02 17:25:48 -070044#include "omap_device.h"
Tony Lindgren2a296c82012-10-02 17:41:35 -070045#include "omap_hwmod.h"
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030046
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030047/* Private functions */
48
Benoit Coussonbf1e0772011-07-10 05:54:12 -060049static void _add_clkdev(struct omap_device *od, const char *clk_alias,
50 const char *clk_name)
51{
52 struct clk *r;
Russell King1ca90bd2015-03-02 15:46:03 +000053 int rc;
Benoit Coussonbf1e0772011-07-10 05:54:12 -060054
55 if (!clk_alias || !clk_name)
56 return;
57
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070058 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060059
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070060 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060061 if (!IS_ERR(r)) {
Markus Pargmann9a02ae42014-08-25 16:15:34 -070062 dev_dbg(&od->pdev->dev,
Kevin Hilman49882c92011-07-21 09:58:36 -070063 "alias %s already exists\n", clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060064 clk_put(r);
65 return;
66 }
67
Tero Kristo59dcfc42016-06-30 16:14:59 +030068 r = clk_get_sys(NULL, clk_name);
69
Tony Lindgren1aa8f0c2017-05-31 15:51:37 -070070 if (IS_ERR(r)) {
Tero Kristo59dcfc42016-06-30 16:14:59 +030071 struct of_phandle_args clkspec;
72
73 clkspec.np = of_find_node_by_name(NULL, clk_name);
74
75 r = of_clk_get_from_provider(&clkspec);
76
77 rc = clk_register_clkdev(r, clk_alias,
78 dev_name(&od->pdev->dev));
79 } else {
80 rc = clk_add_alias(clk_alias, dev_name(&od->pdev->dev),
81 clk_name, NULL);
82 }
83
Russell King1ca90bd2015-03-02 15:46:03 +000084 if (rc) {
85 if (rc == -ENODEV || rc == -ENOMEM)
86 dev_err(&od->pdev->dev,
87 "clkdev_alloc for %s failed\n", clk_alias);
88 else
89 dev_err(&od->pdev->dev,
90 "clk_get for %s failed\n", clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060091 }
Benoit Coussonbf1e0772011-07-10 05:54:12 -060092}
93
Partha Basak4ef7aca2010-09-21 19:23:04 +020094/**
Benoit Coussonbf1e0772011-07-10 05:54:12 -060095 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
96 * and main clock
Partha Basak4ef7aca2010-09-21 19:23:04 +020097 * @od: struct omap_device *od
Benoit Coussonbf1e0772011-07-10 05:54:12 -060098 * @oh: struct omap_hwmod *oh
Partha Basak4ef7aca2010-09-21 19:23:04 +020099 *
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600100 * For the main clock and every optional clock present per hwmod per
101 * omap_device, this function adds an entry in the clkdev table of the
102 * form <dev-id=dev_name, con-id=role> if it does not exist already.
Partha Basak4ef7aca2010-09-21 19:23:04 +0200103 *
104 * The function is called from inside omap_device_build_ss(), after
105 * omap_device_register.
106 *
107 * This allows drivers to get a pointer to its optional clocks based on its role
108 * by calling clk_get(<dev*>, <role>).
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600109 * In the case of the main clock, a "fck" alias is used.
Partha Basak4ef7aca2010-09-21 19:23:04 +0200110 *
111 * No return value.
112 */
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600113static void _add_hwmod_clocks_clkdev(struct omap_device *od,
114 struct omap_hwmod *oh)
Partha Basak4ef7aca2010-09-21 19:23:04 +0200115{
116 int i;
117
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600118 _add_clkdev(od, "fck", oh->main_clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200119
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600120 for (i = 0; i < oh->opt_clks_cnt; i++)
121 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200122}
123
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300124
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200125/**
126 * omap_device_build_from_dt - build an omap_device with multiple hwmods
127 * @pdev_name: name of the platform_device driver to use
128 * @pdev_id: this platform_device's connection ID
129 * @oh: ptr to the single omap_hwmod that backs this omap_device
130 * @pdata: platform_data ptr to associate with the platform_device
131 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200132 *
133 * Function for building an omap_device already registered from device-tree
134 *
135 * Returns 0 or PTR_ERR() on error.
136 */
137static int omap_device_build_from_dt(struct platform_device *pdev)
138{
139 struct omap_hwmod **hwmods;
140 struct omap_device *od;
141 struct omap_hwmod *oh;
142 struct device_node *node = pdev->dev.of_node;
Tony Lindgren695eea32018-02-22 14:05:31 -0800143 struct resource res;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200144 const char *oh_name;
145 int oh_cnt, i, ret = 0;
Rajendra Nayak72680322013-07-28 23:01:51 -0600146 bool device_active = false;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200147
148 oh_cnt = of_property_count_strings(node, "ti,hwmods");
Russell Kingc48cd652013-03-13 20:44:21 +0000149 if (oh_cnt <= 0) {
Benoit Cousson5dc06b72012-01-20 18:14:00 +0100150 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200151 return -ENODEV;
152 }
153
Tony Lindgren695eea32018-02-22 14:05:31 -0800154 /* Use ti-sysc driver instead of omap_device? */
155 if (!omap_hwmod_parse_module_range(NULL, node, &res))
156 return -ENODEV;
157
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200158 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
159 if (!hwmods) {
160 ret = -ENOMEM;
161 goto odbfd_exit;
162 }
163
164 for (i = 0; i < oh_cnt; i++) {
165 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
166 oh = omap_hwmod_lookup(oh_name);
167 if (!oh) {
168 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
169 oh_name);
170 ret = -EINVAL;
171 goto odbfd_exit1;
172 }
173 hwmods[i] = oh;
Rajendra Nayak72680322013-07-28 23:01:51 -0600174 if (oh->flags & HWMOD_INIT_NO_IDLE)
175 device_active = true;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200176 }
177
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700178 od = omap_device_alloc(pdev, hwmods, oh_cnt);
Wei Yongjun4cf9cf82013-09-18 12:01:58 -0700179 if (IS_ERR(od)) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200180 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
181 oh_name);
182 ret = PTR_ERR(od);
183 goto odbfd_exit1;
184 }
185
Peter Ujfalusi3956a1a2012-08-23 16:54:09 +0300186 /* Fix up missing resource names */
187 for (i = 0; i < pdev->num_resources; i++) {
188 struct resource *r = &pdev->resource[i];
189
190 if (r->name == NULL)
191 r->name = dev_name(&pdev->dev);
192 }
193
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100194 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200195
Rajendra Nayak72680322013-07-28 23:01:51 -0600196 if (device_active) {
197 omap_device_enable(pdev);
198 pm_runtime_set_active(&pdev->dev);
199 }
200
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200201odbfd_exit1:
202 kfree(hwmods);
203odbfd_exit:
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600204 /* if data/we are at fault.. load up a fail handler */
205 if (ret)
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100206 dev_pm_domain_set(&pdev->dev, &omap_device_fail_pm_domain);
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600207
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200208 return ret;
209}
210
211static int _omap_device_notifier_call(struct notifier_block *nb,
212 unsigned long event, void *dev)
213{
214 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700215 struct omap_device *od;
Tony Lindgrencf26f112016-02-12 08:56:52 -0800216 int err;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200217
218 switch (event) {
Grygorii Strashko213fa102016-07-28 20:50:37 +0300219 case BUS_NOTIFY_REMOVED_DEVICE:
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200220 if (pdev->archdata.od)
221 omap_device_delete(pdev->archdata.od);
222 break;
Tony Lindgrencf26f112016-02-12 08:56:52 -0800223 case BUS_NOTIFY_UNBOUND_DRIVER:
224 od = to_omap_device(pdev);
225 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED)) {
226 dev_info(dev, "enabled after unload, idling\n");
227 err = omap_device_idle(pdev);
228 if (err)
229 dev_err(dev, "failed to idle\n");
230 }
231 break;
Dave Gerlach04abaf02017-03-30 14:58:18 -0500232 case BUS_NOTIFY_BIND_DRIVER:
233 od = to_omap_device(pdev);
234 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED) &&
235 pm_runtime_status_suspended(dev)) {
236 od->_driver_status = BUS_NOTIFY_BIND_DRIVER;
237 pm_runtime_set_active(dev);
238 }
239 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700240 case BUS_NOTIFY_ADD_DEVICE:
241 if (pdev->dev.of_node)
242 omap_device_build_from_dt(pdev);
Tony Lindgrendad12d12013-12-06 10:52:58 -0800243 omap_auxdata_legacy_init(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700244 /* fall through */
245 default:
246 od = to_omap_device(pdev);
247 if (od)
248 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200249 }
250
251 return NOTIFY_DONE;
252}
253
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700254/**
255 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
256 * @od: struct omap_device *od
257 *
258 * Enable all underlying hwmods. Returns 0.
259 */
260static int _omap_device_enable_hwmods(struct omap_device *od)
261{
Pali Rohár6da23352015-02-26 14:49:51 +0100262 int ret = 0;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700263 int i;
264
265 for (i = 0; i < od->hwmods_cnt; i++)
Pali Rohár6da23352015-02-26 14:49:51 +0100266 ret |= omap_hwmod_enable(od->hwmods[i]);
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700267
Pali Rohár6da23352015-02-26 14:49:51 +0100268 return ret;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700269}
270
271/**
272 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
273 * @od: struct omap_device *od
274 *
275 * Idle all underlying hwmods. Returns 0.
276 */
277static int _omap_device_idle_hwmods(struct omap_device *od)
278{
Pali Rohár6da23352015-02-26 14:49:51 +0100279 int ret = 0;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700280 int i;
281
282 for (i = 0; i < od->hwmods_cnt; i++)
Pali Rohár6da23352015-02-26 14:49:51 +0100283 ret |= omap_hwmod_idle(od->hwmods[i]);
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700284
Pali Rohár6da23352015-02-26 14:49:51 +0100285 return ret;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700286}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200287
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300288/* Public functions for use by core code */
289
290/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700291 * omap_device_get_context_loss_count - get lost context count
292 * @od: struct omap_device *
293 *
294 * Using the primary hwmod, query the context loss count for this
295 * device.
296 *
297 * Callers should consider context for this device lost any time this
298 * function returns a value different than the value the caller got
299 * the last time it called this function.
300 *
Andrea Gelminif733e7c2016-05-21 13:50:25 +0200301 * If any hwmods exist for the omap_device associated with @pdev,
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700302 * return the context loss counter for that hwmod, otherwise return
303 * zero.
304 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300305int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700306{
307 struct omap_device *od;
308 u32 ret = 0;
309
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600310 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700311
312 if (od->hwmods_cnt)
313 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
314
315 return ret;
316}
317
318/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200319 * omap_device_alloc - allocate an omap_device
320 * @pdev: platform_device that will be included in this omap_device
321 * @oh: ptr to the single omap_hwmod that backs this omap_device
322 * @pdata: platform_data ptr to associate with the platform_device
323 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200324 *
325 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700326 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200327 *
328 * Returns an struct omap_device pointer or ERR_PTR() on error;
329 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800330struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700331 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200332{
333 int ret = -ENOMEM;
334 struct omap_device *od;
Tony Lindgrenc2b84a92017-10-10 14:27:26 -0700335 int i;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200336 struct omap_hwmod **hwmods;
337
338 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
339 if (!od) {
340 ret = -ENOMEM;
341 goto oda_exit1;
342 }
343 od->hwmods_cnt = oh_cnt;
344
345 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
346 if (!hwmods)
347 goto oda_exit2;
348
349 od->hwmods = hwmods;
350 od->pdev = pdev;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200351 pdev->archdata.od = od;
352
353 for (i = 0; i < oh_cnt; i++) {
354 hwmods[i]->od = od;
355 _add_hwmod_clocks_clkdev(od, hwmods[i]);
356 }
357
358 return od;
359
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200360oda_exit2:
361 kfree(od);
362oda_exit1:
363 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
364
365 return ERR_PTR(ret);
366}
367
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800368void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200369{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200370 if (!od)
371 return;
372
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200373 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200374 kfree(od->hwmods);
375 kfree(od);
376}
377
378/**
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700379 * omap_device_copy_resources - Add legacy IO and IRQ resources
380 * @oh: interconnect target module
381 * @pdev: platform device to copy resources to
382 *
383 * We still have legacy DMA and smartreflex needing resources.
384 * Let's populate what they need until we can eventually just
385 * remove this function. Note that there should be no need to
386 * call this from omap_device_build_from_dt(), nor should there
387 * be any need to call it for other devices.
388 */
389static int
390omap_device_copy_resources(struct omap_hwmod *oh,
391 struct platform_device *pdev)
392{
393 struct device_node *np, *child;
394 struct property *prop;
395 struct resource *res;
396 const char *name;
397 int error, irq = 0;
398
Tony Lindgrenf0c96c62017-10-30 10:01:39 -0700399 if (!oh || !oh->od || !oh->od->pdev)
400 return -EINVAL;
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700401
402 np = oh->od->pdev->dev.of_node;
403 if (!np) {
404 error = -ENODEV;
405 goto error;
406 }
407
408 res = kzalloc(sizeof(*res) * 2, GFP_KERNEL);
409 if (!res)
410 return -ENOMEM;
411
412 /* Do we have a dts range for the interconnect target module? */
413 error = omap_hwmod_parse_module_range(oh, np, res);
414
415 /* No ranges, rely on device reg entry */
416 if (error)
417 error = of_address_to_resource(np, 0, res);
418 if (error)
419 goto free;
420
421 /* SmartReflex needs first IO resource name to be "mpu" */
422 res[0].name = "mpu";
423
424 /*
425 * We may have a configured "ti,sysc" interconnect target with a
426 * dts child with the interrupt. If so use the first child's
427 * first interrupt for "ti-hwmods" legacy support.
428 */
429 of_property_for_each_string(np, "compatible", prop, name)
430 if (!strncmp("ti,sysc-", name, 8))
431 break;
432
433 child = of_get_next_available_child(np, NULL);
434
435 if (name)
436 irq = irq_of_parse_and_map(child, 0);
437 if (!irq)
438 irq = irq_of_parse_and_map(np, 0);
Wei Yongjun552ee302017-10-13 09:29:25 +0000439 if (!irq) {
440 error = -EINVAL;
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700441 goto free;
Wei Yongjun552ee302017-10-13 09:29:25 +0000442 }
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700443
444 /* Legacy DMA code needs interrupt name to be "0" */
445 res[1].start = irq;
446 res[1].end = irq;
447 res[1].flags = IORESOURCE_IRQ;
448 res[1].name = "0";
449
450 error = platform_device_add_resources(pdev, res, 2);
451
452free:
453 kfree(res);
454
455error:
456 WARN(error, "%s: %s device %s failed: %i\n",
457 __func__, oh->name, dev_name(&pdev->dev),
458 error);
459
460 return error;
461}
462
463/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300464 * omap_device_build - build and register an omap_device with one omap_hwmod
465 * @pdev_name: name of the platform_device driver to use
466 * @pdev_id: this platform_device's connection ID
467 * @oh: ptr to the single omap_hwmod that backs this omap_device
468 * @pdata: platform_data ptr to associate with the platform_device
469 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300470 *
471 * Convenience function for building and registering a single
472 * omap_device record, which in turn builds and registers a
473 * platform_device record. See omap_device_build_ss() for more
474 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
475 * passes along the return value of omap_device_build_ss().
476 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700477struct platform_device __init *omap_device_build(const char *pdev_name,
478 int pdev_id,
479 struct omap_hwmod *oh,
480 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300481{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300482 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700483 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300484 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300485
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700486 if (!oh || !pdev_name)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300487 return ERR_PTR(-EINVAL);
488
489 if (!pdata && pdata_len > 0)
490 return ERR_PTR(-EINVAL);
491
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700492 if (strncmp(oh->name, "smartreflex", 11) &&
493 strncmp(oh->name, "dma", 3)) {
494 pr_warn("%s need to update %s to probe with dt\na",
495 __func__, pdev_name);
496 ret = -ENODEV;
497 goto odbs_exit;
498 }
499
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700500 pdev = platform_device_alloc(pdev_name, pdev_id);
501 if (!pdev) {
502 ret = -ENOMEM;
503 goto odbs_exit;
504 }
505
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200506 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
507 if (pdev->id != -1)
508 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
509 else
510 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300511
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700512 /*
513 * Must be called before omap_device_alloc() as oh->od
514 * only contains the currently registered omap_device
515 * and will get overwritten by omap_device_alloc().
516 */
517 ret = omap_device_copy_resources(oh, pdev);
518 if (ret)
519 goto odbs_exit1;
520
521 od = omap_device_alloc(pdev, &oh, 1);
Dan Carpentere9a9bb42017-11-14 09:06:48 +0300522 if (IS_ERR(od)) {
523 ret = PTR_ERR(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700524 goto odbs_exit1;
Dan Carpentere9a9bb42017-11-14 09:06:48 +0300525 }
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300526
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700527 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000528 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200529 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700530
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700531 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700532 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200533 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600534
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700535 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300536
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700537odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200538 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700539odbs_exit1:
540 platform_device_put(pdev);
541odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300542
543 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
544
545 return ERR_PTR(ret);
546}
547
Rafael J. Wysockibf7c5442014-12-13 00:42:49 +0100548#ifdef CONFIG_PM
Kevin Hilman638080c2011-04-29 00:36:42 +0200549static int _od_runtime_suspend(struct device *dev)
550{
551 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700552 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200553
Kevin Hilman345f79b2011-05-31 16:08:09 -0700554 ret = pm_generic_runtime_suspend(dev);
Pali Rohár6da23352015-02-26 14:49:51 +0100555 if (ret)
556 return ret;
Kevin Hilman345f79b2011-05-31 16:08:09 -0700557
Pali Rohár6da23352015-02-26 14:49:51 +0100558 return omap_device_idle(pdev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700559}
560
Kevin Hilman638080c2011-04-29 00:36:42 +0200561static int _od_runtime_resume(struct device *dev)
562{
563 struct platform_device *pdev = to_platform_device(dev);
Pali Rohár6da23352015-02-26 14:49:51 +0100564 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200565
Pali Rohár6da23352015-02-26 14:49:51 +0100566 ret = omap_device_enable(pdev);
Tony Lindgren08c78e92016-02-12 08:56:52 -0800567 if (ret) {
568 dev_err(dev, "use pm_runtime_put_sync_suspend() in driver?\n");
Pali Rohár6da23352015-02-26 14:49:51 +0100569 return ret;
Tony Lindgren08c78e92016-02-12 08:56:52 -0800570 }
Kevin Hilman345f79b2011-05-31 16:08:09 -0700571
572 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200573}
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600574
575static int _od_fail_runtime_suspend(struct device *dev)
576{
577 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
578 return -ENODEV;
579}
580
581static int _od_fail_runtime_resume(struct device *dev)
582{
583 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
584 return -ENODEV;
585}
586
Kevin Hilman256a5432011-07-12 22:48:03 +0200587#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200588
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200589#ifdef CONFIG_SUSPEND
590static int _od_suspend_noirq(struct device *dev)
591{
592 struct platform_device *pdev = to_platform_device(dev);
593 struct omap_device *od = to_omap_device(pdev);
594 int ret;
595
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700596 /* Don't attempt late suspend on a driver that is not bound */
597 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
598 return 0;
599
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200600 ret = pm_generic_suspend_noirq(dev);
601
602 if (!ret && !pm_runtime_status_suspended(dev)) {
603 if (pm_generic_runtime_suspend(dev) == 0) {
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530604 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200605 od->flags |= OMAP_DEVICE_SUSPENDED;
606 }
607 }
608
609 return ret;
610}
611
612static int _od_resume_noirq(struct device *dev)
613{
614 struct platform_device *pdev = to_platform_device(dev);
615 struct omap_device *od = to_omap_device(pdev);
616
Nishanth Menon3522bf72013-11-14 11:05:16 -0600617 if (od->flags & OMAP_DEVICE_SUSPENDED) {
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200618 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530619 omap_device_enable(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200620 pm_generic_runtime_resume(dev);
621 }
622
623 return pm_generic_resume_noirq(dev);
624}
Kevin Hilman126caf12011-09-01 10:59:36 -0700625#else
626#define _od_suspend_noirq NULL
627#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200628#endif
629
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600630struct dev_pm_domain omap_device_fail_pm_domain = {
631 .ops = {
632 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
633 _od_fail_runtime_resume, NULL)
634 }
635};
636
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800637struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200638 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200639 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200640 NULL)
Kevin Hilman638080c2011-04-29 00:36:42 +0200641 USE_PLATFORM_PM_SLEEP_OPS
Grygorii Strashkoc381f222015-04-27 21:24:32 +0300642 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
643 _od_resume_noirq)
Kevin Hilman638080c2011-04-29 00:36:42 +0200644 }
645};
646
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700647/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300648 * omap_device_register - register an omap_device with one omap_hwmod
649 * @od: struct omap_device * to register
650 *
651 * Register the omap_device structure. This currently just calls
652 * platform_device_register() on the underlying platform_device.
653 * Returns the return value of platform_device_register().
654 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800655int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300656{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700657 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300658
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100659 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700660 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300661}
662
663
664/* Public functions for use by device drivers through struct platform_data */
665
666/**
667 * omap_device_enable - fully activate an omap_device
668 * @od: struct omap_device * to activate
669 *
670 * Do whatever is necessary for the hwmods underlying omap_device @od
671 * to be accessible and ready to operate. This generally involves
672 * enabling clocks, setting SYSCONFIG registers; and in the future may
673 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700674 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
675 * the omap_device is already enabled, or passes along the return
676 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300677 */
678int omap_device_enable(struct platform_device *pdev)
679{
680 int ret;
681 struct omap_device *od;
682
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600683 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300684
685 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700686 dev_warn(&pdev->dev,
687 "omap_device: %s() called from invalid state %d\n",
688 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300689 return -EINVAL;
690 }
691
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700692 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300693
Pali Rohár6da23352015-02-26 14:49:51 +0100694 if (ret == 0)
695 od->_state = OMAP_DEVICE_STATE_ENABLED;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300696
697 return ret;
698}
699
700/**
701 * omap_device_idle - idle an omap_device
702 * @od: struct omap_device * to idle
703 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700704 * Idle omap_device @od. Device drivers call this function indirectly
705 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300706 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700707 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300708 */
709int omap_device_idle(struct platform_device *pdev)
710{
711 int ret;
712 struct omap_device *od;
713
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600714 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300715
716 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700717 dev_warn(&pdev->dev,
718 "omap_device: %s() called from invalid state %d\n",
719 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300720 return -EINVAL;
721 }
722
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700723 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300724
Pali Rohár6da23352015-02-26 14:49:51 +0100725 if (ret == 0)
726 od->_state = OMAP_DEVICE_STATE_IDLE;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300727
728 return ret;
729}
730
731/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600732 * omap_device_assert_hardreset - set a device's hardreset line
733 * @pdev: struct platform_device * to reset
734 * @name: const char * name of the reset line
735 *
736 * Set the hardreset line identified by @name on the IP blocks
737 * associated with the hwmods backing the platform_device @pdev. All
738 * of the hwmods associated with @pdev must have the same hardreset
739 * line linked to them for this to work. Passes along the return value
740 * of omap_hwmod_assert_hardreset() in the event of any failure, or
741 * returns 0 upon success.
742 */
743int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
744{
745 struct omap_device *od = to_omap_device(pdev);
746 int ret = 0;
747 int i;
748
749 for (i = 0; i < od->hwmods_cnt; i++) {
750 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
751 if (ret)
752 break;
753 }
754
755 return ret;
756}
757
758/**
759 * omap_device_deassert_hardreset - release a device's hardreset line
760 * @pdev: struct platform_device * to reset
761 * @name: const char * name of the reset line
762 *
763 * Release the hardreset line identified by @name on the IP blocks
764 * associated with the hwmods backing the platform_device @pdev. All
765 * of the hwmods associated with @pdev must have the same hardreset
766 * line linked to them for this to work. Passes along the return
767 * value of omap_hwmod_deassert_hardreset() in the event of any
768 * failure, or returns 0 upon success.
769 */
770int omap_device_deassert_hardreset(struct platform_device *pdev,
771 const char *name)
772{
773 struct omap_device *od = to_omap_device(pdev);
774 int ret = 0;
775 int i;
776
777 for (i = 0; i < od->hwmods_cnt; i++) {
778 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
779 if (ret)
780 break;
781 }
782
783 return ret;
784}
785
786/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500787 * omap_device_get_by_hwmod_name() - convert a hwmod name to
788 * device pointer.
789 * @oh_name: name of the hwmod device
790 *
791 * Returns back a struct device * pointer associated with a hwmod
792 * device represented by a hwmod_name
793 */
794struct device *omap_device_get_by_hwmod_name(const char *oh_name)
795{
796 struct omap_hwmod *oh;
797
798 if (!oh_name) {
799 WARN(1, "%s: no hwmod name!\n", __func__);
800 return ERR_PTR(-EINVAL);
801 }
802
803 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000804 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500805 WARN(1, "%s: no hwmod for %s\n", __func__,
806 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000807 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500808 }
Russell King857835c2013-02-24 10:56:59 +0000809 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500810 WARN(1, "%s: no omap_device for %s\n", __func__,
811 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000812 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500813 }
814
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500815 return &oh->od->pdev->dev;
816}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700817
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200818static struct notifier_block platform_nb = {
819 .notifier_call = _omap_device_notifier_call,
820};
821
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700822static int __init omap_device_init(void)
823{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200824 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800825 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700826}
Tony Lindgren8dd5ea72015-12-03 11:38:09 -0800827omap_postcore_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700828
829/**
830 * omap_device_late_idle - idle devices without drivers
831 * @dev: struct device * associated with omap_device
832 * @data: unused
833 *
834 * Check the driver bound status of this device, and idle it
835 * if there is no driver attached.
836 */
837static int __init omap_device_late_idle(struct device *dev, void *data)
838{
839 struct platform_device *pdev = to_platform_device(dev);
840 struct omap_device *od = to_omap_device(pdev);
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600841 int i;
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700842
843 if (!od)
844 return 0;
845
846 /*
847 * If omap_device state is enabled, but has no driver bound,
848 * idle it.
849 */
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600850
851 /*
852 * Some devices (like memory controllers) are always kept
853 * enabled, and should not be idled even with no drivers.
854 */
855 for (i = 0; i < od->hwmods_cnt; i++)
856 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
857 return 0;
858
Grygorii Strashkofe8291e2015-09-01 13:59:24 -0700859 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
860 od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700861 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
862 dev_warn(dev, "%s: enabled but no driver. Idling\n",
863 __func__);
864 omap_device_idle(pdev);
865 }
866 }
867
868 return 0;
869}
870
871static int __init omap_device_late_init(void)
872{
873 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
Tony Lindgren4b91f7f2014-10-27 13:05:54 -0700874
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700875 return 0;
876}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700877omap_late_initcall_sync(omap_device_late_init);