blob: d45cbfdb4be6838b7f698886a84f4ceb48fe35f8 [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;
143 const char *oh_name;
144 int oh_cnt, i, ret = 0;
Rajendra Nayak72680322013-07-28 23:01:51 -0600145 bool device_active = false;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200146
147 oh_cnt = of_property_count_strings(node, "ti,hwmods");
Russell Kingc48cd652013-03-13 20:44:21 +0000148 if (oh_cnt <= 0) {
Benoit Cousson5dc06b72012-01-20 18:14:00 +0100149 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200150 return -ENODEV;
151 }
152
153 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
154 if (!hwmods) {
155 ret = -ENOMEM;
156 goto odbfd_exit;
157 }
158
159 for (i = 0; i < oh_cnt; i++) {
160 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
161 oh = omap_hwmod_lookup(oh_name);
162 if (!oh) {
163 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
164 oh_name);
165 ret = -EINVAL;
166 goto odbfd_exit1;
167 }
168 hwmods[i] = oh;
Rajendra Nayak72680322013-07-28 23:01:51 -0600169 if (oh->flags & HWMOD_INIT_NO_IDLE)
170 device_active = true;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200171 }
172
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700173 od = omap_device_alloc(pdev, hwmods, oh_cnt);
Wei Yongjun4cf9cf82013-09-18 12:01:58 -0700174 if (IS_ERR(od)) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200175 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
176 oh_name);
177 ret = PTR_ERR(od);
178 goto odbfd_exit1;
179 }
180
Peter Ujfalusi3956a1a2012-08-23 16:54:09 +0300181 /* Fix up missing resource names */
182 for (i = 0; i < pdev->num_resources; i++) {
183 struct resource *r = &pdev->resource[i];
184
185 if (r->name == NULL)
186 r->name = dev_name(&pdev->dev);
187 }
188
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100189 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200190
Rajendra Nayak72680322013-07-28 23:01:51 -0600191 if (device_active) {
192 omap_device_enable(pdev);
193 pm_runtime_set_active(&pdev->dev);
194 }
195
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200196odbfd_exit1:
197 kfree(hwmods);
198odbfd_exit:
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600199 /* if data/we are at fault.. load up a fail handler */
200 if (ret)
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100201 dev_pm_domain_set(&pdev->dev, &omap_device_fail_pm_domain);
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600202
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200203 return ret;
204}
205
206static int _omap_device_notifier_call(struct notifier_block *nb,
207 unsigned long event, void *dev)
208{
209 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700210 struct omap_device *od;
Tony Lindgrencf26f112016-02-12 08:56:52 -0800211 int err;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200212
213 switch (event) {
Grygorii Strashko213fa102016-07-28 20:50:37 +0300214 case BUS_NOTIFY_REMOVED_DEVICE:
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200215 if (pdev->archdata.od)
216 omap_device_delete(pdev->archdata.od);
217 break;
Tony Lindgrencf26f112016-02-12 08:56:52 -0800218 case BUS_NOTIFY_UNBOUND_DRIVER:
219 od = to_omap_device(pdev);
220 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED)) {
221 dev_info(dev, "enabled after unload, idling\n");
222 err = omap_device_idle(pdev);
223 if (err)
224 dev_err(dev, "failed to idle\n");
225 }
226 break;
Dave Gerlach04abaf02017-03-30 14:58:18 -0500227 case BUS_NOTIFY_BIND_DRIVER:
228 od = to_omap_device(pdev);
229 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED) &&
230 pm_runtime_status_suspended(dev)) {
231 od->_driver_status = BUS_NOTIFY_BIND_DRIVER;
232 pm_runtime_set_active(dev);
233 }
234 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700235 case BUS_NOTIFY_ADD_DEVICE:
236 if (pdev->dev.of_node)
237 omap_device_build_from_dt(pdev);
Tony Lindgrendad12d12013-12-06 10:52:58 -0800238 omap_auxdata_legacy_init(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700239 /* fall through */
240 default:
241 od = to_omap_device(pdev);
242 if (od)
243 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200244 }
245
246 return NOTIFY_DONE;
247}
248
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700249/**
250 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
251 * @od: struct omap_device *od
252 *
253 * Enable all underlying hwmods. Returns 0.
254 */
255static int _omap_device_enable_hwmods(struct omap_device *od)
256{
Pali Rohár6da23352015-02-26 14:49:51 +0100257 int ret = 0;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700258 int i;
259
260 for (i = 0; i < od->hwmods_cnt; i++)
Pali Rohár6da23352015-02-26 14:49:51 +0100261 ret |= omap_hwmod_enable(od->hwmods[i]);
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700262
Pali Rohár6da23352015-02-26 14:49:51 +0100263 return ret;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700264}
265
266/**
267 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
268 * @od: struct omap_device *od
269 *
270 * Idle all underlying hwmods. Returns 0.
271 */
272static int _omap_device_idle_hwmods(struct omap_device *od)
273{
Pali Rohár6da23352015-02-26 14:49:51 +0100274 int ret = 0;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700275 int i;
276
277 for (i = 0; i < od->hwmods_cnt; i++)
Pali Rohár6da23352015-02-26 14:49:51 +0100278 ret |= omap_hwmod_idle(od->hwmods[i]);
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700279
Pali Rohár6da23352015-02-26 14:49:51 +0100280 return ret;
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700281}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200282
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300283/* Public functions for use by core code */
284
285/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700286 * omap_device_get_context_loss_count - get lost context count
287 * @od: struct omap_device *
288 *
289 * Using the primary hwmod, query the context loss count for this
290 * device.
291 *
292 * Callers should consider context for this device lost any time this
293 * function returns a value different than the value the caller got
294 * the last time it called this function.
295 *
Andrea Gelminif733e7c2016-05-21 13:50:25 +0200296 * If any hwmods exist for the omap_device associated with @pdev,
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700297 * return the context loss counter for that hwmod, otherwise return
298 * zero.
299 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300300int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700301{
302 struct omap_device *od;
303 u32 ret = 0;
304
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600305 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700306
307 if (od->hwmods_cnt)
308 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
309
310 return ret;
311}
312
313/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200314 * omap_device_alloc - allocate an omap_device
315 * @pdev: platform_device that will be included in this omap_device
316 * @oh: ptr to the single omap_hwmod that backs this omap_device
317 * @pdata: platform_data ptr to associate with the platform_device
318 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200319 *
320 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700321 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200322 *
323 * Returns an struct omap_device pointer or ERR_PTR() on error;
324 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800325struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700326 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200327{
328 int ret = -ENOMEM;
329 struct omap_device *od;
Tony Lindgrenc2b84a92017-10-10 14:27:26 -0700330 int i;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200331 struct omap_hwmod **hwmods;
332
333 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
334 if (!od) {
335 ret = -ENOMEM;
336 goto oda_exit1;
337 }
338 od->hwmods_cnt = oh_cnt;
339
340 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
341 if (!hwmods)
342 goto oda_exit2;
343
344 od->hwmods = hwmods;
345 od->pdev = pdev;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200346 pdev->archdata.od = od;
347
348 for (i = 0; i < oh_cnt; i++) {
349 hwmods[i]->od = od;
350 _add_hwmod_clocks_clkdev(od, hwmods[i]);
351 }
352
353 return od;
354
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200355oda_exit2:
356 kfree(od);
357oda_exit1:
358 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
359
360 return ERR_PTR(ret);
361}
362
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800363void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200364{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200365 if (!od)
366 return;
367
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200368 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200369 kfree(od->hwmods);
370 kfree(od);
371}
372
373/**
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700374 * omap_device_copy_resources - Add legacy IO and IRQ resources
375 * @oh: interconnect target module
376 * @pdev: platform device to copy resources to
377 *
378 * We still have legacy DMA and smartreflex needing resources.
379 * Let's populate what they need until we can eventually just
380 * remove this function. Note that there should be no need to
381 * call this from omap_device_build_from_dt(), nor should there
382 * be any need to call it for other devices.
383 */
384static int
385omap_device_copy_resources(struct omap_hwmod *oh,
386 struct platform_device *pdev)
387{
388 struct device_node *np, *child;
389 struct property *prop;
390 struct resource *res;
391 const char *name;
392 int error, irq = 0;
393
394 if (!oh || !oh->od || !oh->od->pdev) {
395 error = -EINVAL;
396 goto error;
397 }
398
399 np = oh->od->pdev->dev.of_node;
400 if (!np) {
401 error = -ENODEV;
402 goto error;
403 }
404
405 res = kzalloc(sizeof(*res) * 2, GFP_KERNEL);
406 if (!res)
407 return -ENOMEM;
408
409 /* Do we have a dts range for the interconnect target module? */
410 error = omap_hwmod_parse_module_range(oh, np, res);
411
412 /* No ranges, rely on device reg entry */
413 if (error)
414 error = of_address_to_resource(np, 0, res);
415 if (error)
416 goto free;
417
418 /* SmartReflex needs first IO resource name to be "mpu" */
419 res[0].name = "mpu";
420
421 /*
422 * We may have a configured "ti,sysc" interconnect target with a
423 * dts child with the interrupt. If so use the first child's
424 * first interrupt for "ti-hwmods" legacy support.
425 */
426 of_property_for_each_string(np, "compatible", prop, name)
427 if (!strncmp("ti,sysc-", name, 8))
428 break;
429
430 child = of_get_next_available_child(np, NULL);
431
432 if (name)
433 irq = irq_of_parse_and_map(child, 0);
434 if (!irq)
435 irq = irq_of_parse_and_map(np, 0);
Wei Yongjun552ee302017-10-13 09:29:25 +0000436 if (!irq) {
437 error = -EINVAL;
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700438 goto free;
Wei Yongjun552ee302017-10-13 09:29:25 +0000439 }
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700440
441 /* Legacy DMA code needs interrupt name to be "0" */
442 res[1].start = irq;
443 res[1].end = irq;
444 res[1].flags = IORESOURCE_IRQ;
445 res[1].name = "0";
446
447 error = platform_device_add_resources(pdev, res, 2);
448
449free:
450 kfree(res);
451
452error:
453 WARN(error, "%s: %s device %s failed: %i\n",
454 __func__, oh->name, dev_name(&pdev->dev),
455 error);
456
457 return error;
458}
459
460/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300461 * omap_device_build - build and register an omap_device with one omap_hwmod
462 * @pdev_name: name of the platform_device driver to use
463 * @pdev_id: this platform_device's connection ID
464 * @oh: ptr to the single omap_hwmod that backs this omap_device
465 * @pdata: platform_data ptr to associate with the platform_device
466 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300467 *
468 * Convenience function for building and registering a single
469 * omap_device record, which in turn builds and registers a
470 * platform_device record. See omap_device_build_ss() for more
471 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
472 * passes along the return value of omap_device_build_ss().
473 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700474struct platform_device __init *omap_device_build(const char *pdev_name,
475 int pdev_id,
476 struct omap_hwmod *oh,
477 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300478{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300479 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700480 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300481 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300482
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700483 if (!oh || !pdev_name)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300484 return ERR_PTR(-EINVAL);
485
486 if (!pdata && pdata_len > 0)
487 return ERR_PTR(-EINVAL);
488
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700489 if (strncmp(oh->name, "smartreflex", 11) &&
490 strncmp(oh->name, "dma", 3)) {
491 pr_warn("%s need to update %s to probe with dt\na",
492 __func__, pdev_name);
493 ret = -ENODEV;
494 goto odbs_exit;
495 }
496
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700497 pdev = platform_device_alloc(pdev_name, pdev_id);
498 if (!pdev) {
499 ret = -ENOMEM;
500 goto odbs_exit;
501 }
502
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200503 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
504 if (pdev->id != -1)
505 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
506 else
507 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300508
Tony Lindgrend85a2d62017-10-10 14:23:35 -0700509 /*
510 * Must be called before omap_device_alloc() as oh->od
511 * only contains the currently registered omap_device
512 * and will get overwritten by omap_device_alloc().
513 */
514 ret = omap_device_copy_resources(oh, pdev);
515 if (ret)
516 goto odbs_exit1;
517
518 od = omap_device_alloc(pdev, &oh, 1);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800519 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700520 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300521
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700522 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000523 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200524 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700525
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700526 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700527 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200528 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600529
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700530 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300531
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700532odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200533 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700534odbs_exit1:
535 platform_device_put(pdev);
536odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300537
538 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
539
540 return ERR_PTR(ret);
541}
542
Rafael J. Wysockibf7c5442014-12-13 00:42:49 +0100543#ifdef CONFIG_PM
Kevin Hilman638080c2011-04-29 00:36:42 +0200544static int _od_runtime_suspend(struct device *dev)
545{
546 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700547 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200548
Kevin Hilman345f79b2011-05-31 16:08:09 -0700549 ret = pm_generic_runtime_suspend(dev);
Pali Rohár6da23352015-02-26 14:49:51 +0100550 if (ret)
551 return ret;
Kevin Hilman345f79b2011-05-31 16:08:09 -0700552
Pali Rohár6da23352015-02-26 14:49:51 +0100553 return omap_device_idle(pdev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700554}
555
Kevin Hilman638080c2011-04-29 00:36:42 +0200556static int _od_runtime_resume(struct device *dev)
557{
558 struct platform_device *pdev = to_platform_device(dev);
Pali Rohár6da23352015-02-26 14:49:51 +0100559 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200560
Pali Rohár6da23352015-02-26 14:49:51 +0100561 ret = omap_device_enable(pdev);
Tony Lindgren08c78e92016-02-12 08:56:52 -0800562 if (ret) {
563 dev_err(dev, "use pm_runtime_put_sync_suspend() in driver?\n");
Pali Rohár6da23352015-02-26 14:49:51 +0100564 return ret;
Tony Lindgren08c78e92016-02-12 08:56:52 -0800565 }
Kevin Hilman345f79b2011-05-31 16:08:09 -0700566
567 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200568}
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600569
570static int _od_fail_runtime_suspend(struct device *dev)
571{
572 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
573 return -ENODEV;
574}
575
576static int _od_fail_runtime_resume(struct device *dev)
577{
578 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
579 return -ENODEV;
580}
581
Kevin Hilman256a5432011-07-12 22:48:03 +0200582#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200583
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200584#ifdef CONFIG_SUSPEND
585static int _od_suspend_noirq(struct device *dev)
586{
587 struct platform_device *pdev = to_platform_device(dev);
588 struct omap_device *od = to_omap_device(pdev);
589 int ret;
590
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700591 /* Don't attempt late suspend on a driver that is not bound */
592 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
593 return 0;
594
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200595 ret = pm_generic_suspend_noirq(dev);
596
597 if (!ret && !pm_runtime_status_suspended(dev)) {
598 if (pm_generic_runtime_suspend(dev) == 0) {
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530599 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200600 od->flags |= OMAP_DEVICE_SUSPENDED;
601 }
602 }
603
604 return ret;
605}
606
607static int _od_resume_noirq(struct device *dev)
608{
609 struct platform_device *pdev = to_platform_device(dev);
610 struct omap_device *od = to_omap_device(pdev);
611
Nishanth Menon3522bf72013-11-14 11:05:16 -0600612 if (od->flags & OMAP_DEVICE_SUSPENDED) {
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200613 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530614 omap_device_enable(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200615 pm_generic_runtime_resume(dev);
616 }
617
618 return pm_generic_resume_noirq(dev);
619}
Kevin Hilman126caf12011-09-01 10:59:36 -0700620#else
621#define _od_suspend_noirq NULL
622#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200623#endif
624
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600625struct dev_pm_domain omap_device_fail_pm_domain = {
626 .ops = {
627 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
628 _od_fail_runtime_resume, NULL)
629 }
630};
631
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800632struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200633 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200634 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200635 NULL)
Kevin Hilman638080c2011-04-29 00:36:42 +0200636 USE_PLATFORM_PM_SLEEP_OPS
Grygorii Strashkoc381f222015-04-27 21:24:32 +0300637 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
638 _od_resume_noirq)
Kevin Hilman638080c2011-04-29 00:36:42 +0200639 }
640};
641
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700642/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300643 * omap_device_register - register an omap_device with one omap_hwmod
644 * @od: struct omap_device * to register
645 *
646 * Register the omap_device structure. This currently just calls
647 * platform_device_register() on the underlying platform_device.
648 * Returns the return value of platform_device_register().
649 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800650int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300651{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700652 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300653
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100654 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700655 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300656}
657
658
659/* Public functions for use by device drivers through struct platform_data */
660
661/**
662 * omap_device_enable - fully activate an omap_device
663 * @od: struct omap_device * to activate
664 *
665 * Do whatever is necessary for the hwmods underlying omap_device @od
666 * to be accessible and ready to operate. This generally involves
667 * enabling clocks, setting SYSCONFIG registers; and in the future may
668 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700669 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
670 * the omap_device is already enabled, or passes along the return
671 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300672 */
673int omap_device_enable(struct platform_device *pdev)
674{
675 int ret;
676 struct omap_device *od;
677
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600678 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300679
680 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700681 dev_warn(&pdev->dev,
682 "omap_device: %s() called from invalid state %d\n",
683 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300684 return -EINVAL;
685 }
686
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700687 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300688
Pali Rohár6da23352015-02-26 14:49:51 +0100689 if (ret == 0)
690 od->_state = OMAP_DEVICE_STATE_ENABLED;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300691
692 return ret;
693}
694
695/**
696 * omap_device_idle - idle an omap_device
697 * @od: struct omap_device * to idle
698 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700699 * Idle omap_device @od. Device drivers call this function indirectly
700 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300701 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700702 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300703 */
704int omap_device_idle(struct platform_device *pdev)
705{
706 int ret;
707 struct omap_device *od;
708
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600709 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300710
711 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700712 dev_warn(&pdev->dev,
713 "omap_device: %s() called from invalid state %d\n",
714 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300715 return -EINVAL;
716 }
717
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700718 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300719
Pali Rohár6da23352015-02-26 14:49:51 +0100720 if (ret == 0)
721 od->_state = OMAP_DEVICE_STATE_IDLE;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300722
723 return ret;
724}
725
726/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600727 * omap_device_assert_hardreset - set a device's hardreset line
728 * @pdev: struct platform_device * to reset
729 * @name: const char * name of the reset line
730 *
731 * Set the hardreset line identified by @name on the IP blocks
732 * associated with the hwmods backing the platform_device @pdev. All
733 * of the hwmods associated with @pdev must have the same hardreset
734 * line linked to them for this to work. Passes along the return value
735 * of omap_hwmod_assert_hardreset() in the event of any failure, or
736 * returns 0 upon success.
737 */
738int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
739{
740 struct omap_device *od = to_omap_device(pdev);
741 int ret = 0;
742 int i;
743
744 for (i = 0; i < od->hwmods_cnt; i++) {
745 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
746 if (ret)
747 break;
748 }
749
750 return ret;
751}
752
753/**
754 * omap_device_deassert_hardreset - release a device's hardreset line
755 * @pdev: struct platform_device * to reset
756 * @name: const char * name of the reset line
757 *
758 * Release the hardreset line identified by @name on the IP blocks
759 * associated with the hwmods backing the platform_device @pdev. All
760 * of the hwmods associated with @pdev must have the same hardreset
761 * line linked to them for this to work. Passes along the return
762 * value of omap_hwmod_deassert_hardreset() in the event of any
763 * failure, or returns 0 upon success.
764 */
765int omap_device_deassert_hardreset(struct platform_device *pdev,
766 const char *name)
767{
768 struct omap_device *od = to_omap_device(pdev);
769 int ret = 0;
770 int i;
771
772 for (i = 0; i < od->hwmods_cnt; i++) {
773 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
774 if (ret)
775 break;
776 }
777
778 return ret;
779}
780
781/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500782 * omap_device_get_by_hwmod_name() - convert a hwmod name to
783 * device pointer.
784 * @oh_name: name of the hwmod device
785 *
786 * Returns back a struct device * pointer associated with a hwmod
787 * device represented by a hwmod_name
788 */
789struct device *omap_device_get_by_hwmod_name(const char *oh_name)
790{
791 struct omap_hwmod *oh;
792
793 if (!oh_name) {
794 WARN(1, "%s: no hwmod name!\n", __func__);
795 return ERR_PTR(-EINVAL);
796 }
797
798 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000799 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500800 WARN(1, "%s: no hwmod for %s\n", __func__,
801 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000802 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500803 }
Russell King857835c2013-02-24 10:56:59 +0000804 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500805 WARN(1, "%s: no omap_device 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 }
809
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500810 return &oh->od->pdev->dev;
811}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700812
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200813static struct notifier_block platform_nb = {
814 .notifier_call = _omap_device_notifier_call,
815};
816
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700817static int __init omap_device_init(void)
818{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200819 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800820 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700821}
Tony Lindgren8dd5ea72015-12-03 11:38:09 -0800822omap_postcore_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700823
824/**
825 * omap_device_late_idle - idle devices without drivers
826 * @dev: struct device * associated with omap_device
827 * @data: unused
828 *
829 * Check the driver bound status of this device, and idle it
830 * if there is no driver attached.
831 */
832static int __init omap_device_late_idle(struct device *dev, void *data)
833{
834 struct platform_device *pdev = to_platform_device(dev);
835 struct omap_device *od = to_omap_device(pdev);
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600836 int i;
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700837
838 if (!od)
839 return 0;
840
841 /*
842 * If omap_device state is enabled, but has no driver bound,
843 * idle it.
844 */
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600845
846 /*
847 * Some devices (like memory controllers) are always kept
848 * enabled, and should not be idled even with no drivers.
849 */
850 for (i = 0; i < od->hwmods_cnt; i++)
851 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
852 return 0;
853
Grygorii Strashkofe8291e2015-09-01 13:59:24 -0700854 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
855 od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700856 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
857 dev_warn(dev, "%s: enabled but no driver. Idling\n",
858 __func__);
859 omap_device_idle(pdev);
860 }
861 }
862
863 return 0;
864}
865
866static int __init omap_device_late_init(void)
867{
868 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
Tony Lindgren4b91f7f2014-10-27 13:05:54 -0700869
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700870 return 0;
871}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700872omap_late_initcall_sync(omap_device_late_init);