blob: d22c30d3ccfa0809d2662cbd5390c20f40b24a55 [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>
Kevin Hilman345f79b2011-05-31 16:08:09 -070035#include <linux/pm_runtime.h>
Benoit Coussondc2d07e2011-08-10 13:32:08 +020036#include <linux/of.h>
37#include <linux/notifier.h>
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030038
Tony Lindgrendad12d12013-12-06 10:52:58 -080039#include "common.h"
Tony Lindgrenb76c8b12013-01-11 11:24:18 -080040#include "soc.h"
Tony Lindgren25c7d492012-10-02 17:25:48 -070041#include "omap_device.h"
Tony Lindgren2a296c82012-10-02 17:41:35 -070042#include "omap_hwmod.h"
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030043
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030044/* Private functions */
45
Benoit Coussonbf1e0772011-07-10 05:54:12 -060046static void _add_clkdev(struct omap_device *od, const char *clk_alias,
47 const char *clk_name)
48{
49 struct clk *r;
50 struct clk_lookup *l;
51
52 if (!clk_alias || !clk_name)
53 return;
54
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070055 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060056
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070057 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060058 if (!IS_ERR(r)) {
Markus Pargmann9a02ae42014-08-25 16:15:34 -070059 dev_dbg(&od->pdev->dev,
Kevin Hilman49882c92011-07-21 09:58:36 -070060 "alias %s already exists\n", clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060061 clk_put(r);
62 return;
63 }
64
Rajendra Nayak6ea74cb2012-09-22 02:24:16 -060065 r = clk_get(NULL, clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060066 if (IS_ERR(r)) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070067 dev_err(&od->pdev->dev,
Rajendra Nayak6ea74cb2012-09-22 02:24:16 -060068 "clk_get for %s failed\n", clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060069 return;
70 }
71
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070072 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
Benoit Coussonbf1e0772011-07-10 05:54:12 -060073 if (!l) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070074 dev_err(&od->pdev->dev,
Kevin Hilman49882c92011-07-21 09:58:36 -070075 "clkdev_alloc for %s failed\n", clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060076 return;
77 }
78
79 clkdev_add(l);
80}
81
Partha Basak4ef7aca2010-09-21 19:23:04 +020082/**
Benoit Coussonbf1e0772011-07-10 05:54:12 -060083 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
84 * and main clock
Partha Basak4ef7aca2010-09-21 19:23:04 +020085 * @od: struct omap_device *od
Benoit Coussonbf1e0772011-07-10 05:54:12 -060086 * @oh: struct omap_hwmod *oh
Partha Basak4ef7aca2010-09-21 19:23:04 +020087 *
Benoit Coussonbf1e0772011-07-10 05:54:12 -060088 * For the main clock and every optional clock present per hwmod per
89 * omap_device, this function adds an entry in the clkdev table of the
90 * form <dev-id=dev_name, con-id=role> if it does not exist already.
Partha Basak4ef7aca2010-09-21 19:23:04 +020091 *
92 * The function is called from inside omap_device_build_ss(), after
93 * omap_device_register.
94 *
95 * This allows drivers to get a pointer to its optional clocks based on its role
96 * by calling clk_get(<dev*>, <role>).
Benoit Coussonbf1e0772011-07-10 05:54:12 -060097 * In the case of the main clock, a "fck" alias is used.
Partha Basak4ef7aca2010-09-21 19:23:04 +020098 *
99 * No return value.
100 */
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600101static void _add_hwmod_clocks_clkdev(struct omap_device *od,
102 struct omap_hwmod *oh)
Partha Basak4ef7aca2010-09-21 19:23:04 +0200103{
104 int i;
105
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600106 _add_clkdev(od, "fck", oh->main_clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200107
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600108 for (i = 0; i < oh->opt_clks_cnt; i++)
109 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200110}
111
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300112
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200113/**
114 * omap_device_build_from_dt - build an omap_device with multiple hwmods
115 * @pdev_name: name of the platform_device driver to use
116 * @pdev_id: this platform_device's connection ID
117 * @oh: ptr to the single omap_hwmod that backs this omap_device
118 * @pdata: platform_data ptr to associate with the platform_device
119 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200120 *
121 * Function for building an omap_device already registered from device-tree
122 *
123 * Returns 0 or PTR_ERR() on error.
124 */
125static int omap_device_build_from_dt(struct platform_device *pdev)
126{
127 struct omap_hwmod **hwmods;
128 struct omap_device *od;
129 struct omap_hwmod *oh;
130 struct device_node *node = pdev->dev.of_node;
131 const char *oh_name;
132 int oh_cnt, i, ret = 0;
Rajendra Nayak72680322013-07-28 23:01:51 -0600133 bool device_active = false;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200134
135 oh_cnt = of_property_count_strings(node, "ti,hwmods");
Russell Kingc48cd652013-03-13 20:44:21 +0000136 if (oh_cnt <= 0) {
Benoit Cousson5dc06b72012-01-20 18:14:00 +0100137 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200138 return -ENODEV;
139 }
140
141 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
142 if (!hwmods) {
143 ret = -ENOMEM;
144 goto odbfd_exit;
145 }
146
147 for (i = 0; i < oh_cnt; i++) {
148 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
149 oh = omap_hwmod_lookup(oh_name);
150 if (!oh) {
151 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
152 oh_name);
153 ret = -EINVAL;
154 goto odbfd_exit1;
155 }
156 hwmods[i] = oh;
Rajendra Nayak72680322013-07-28 23:01:51 -0600157 if (oh->flags & HWMOD_INIT_NO_IDLE)
158 device_active = true;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200159 }
160
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700161 od = omap_device_alloc(pdev, hwmods, oh_cnt);
Wei Yongjun4cf9cf82013-09-18 12:01:58 -0700162 if (IS_ERR(od)) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200163 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
164 oh_name);
165 ret = PTR_ERR(od);
166 goto odbfd_exit1;
167 }
168
Peter Ujfalusi3956a1a2012-08-23 16:54:09 +0300169 /* Fix up missing resource names */
170 for (i = 0; i < pdev->num_resources; i++) {
171 struct resource *r = &pdev->resource[i];
172
173 if (r->name == NULL)
174 r->name = dev_name(&pdev->dev);
175 }
176
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200177 pdev->dev.pm_domain = &omap_device_pm_domain;
178
Rajendra Nayak72680322013-07-28 23:01:51 -0600179 if (device_active) {
180 omap_device_enable(pdev);
181 pm_runtime_set_active(&pdev->dev);
182 }
183
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200184odbfd_exit1:
185 kfree(hwmods);
186odbfd_exit:
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600187 /* if data/we are at fault.. load up a fail handler */
188 if (ret)
189 pdev->dev.pm_domain = &omap_device_fail_pm_domain;
190
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200191 return ret;
192}
193
194static int _omap_device_notifier_call(struct notifier_block *nb,
195 unsigned long event, void *dev)
196{
197 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700198 struct omap_device *od;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200199
200 switch (event) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200201 case BUS_NOTIFY_DEL_DEVICE:
202 if (pdev->archdata.od)
203 omap_device_delete(pdev->archdata.od);
204 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700205 case BUS_NOTIFY_ADD_DEVICE:
206 if (pdev->dev.of_node)
207 omap_device_build_from_dt(pdev);
Tony Lindgrendad12d12013-12-06 10:52:58 -0800208 omap_auxdata_legacy_init(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700209 /* fall through */
210 default:
211 od = to_omap_device(pdev);
212 if (od)
213 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200214 }
215
216 return NOTIFY_DONE;
217}
218
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700219/**
220 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
221 * @od: struct omap_device *od
222 *
223 * Enable all underlying hwmods. Returns 0.
224 */
225static int _omap_device_enable_hwmods(struct omap_device *od)
226{
227 int i;
228
229 for (i = 0; i < od->hwmods_cnt; i++)
230 omap_hwmod_enable(od->hwmods[i]);
231
232 /* XXX pass along return value here? */
233 return 0;
234}
235
236/**
237 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
238 * @od: struct omap_device *od
239 *
240 * Idle all underlying hwmods. Returns 0.
241 */
242static int _omap_device_idle_hwmods(struct omap_device *od)
243{
244 int i;
245
246 for (i = 0; i < od->hwmods_cnt; i++)
247 omap_hwmod_idle(od->hwmods[i]);
248
249 /* XXX pass along return value here? */
250 return 0;
251}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200252
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300253/* Public functions for use by core code */
254
255/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700256 * omap_device_get_context_loss_count - get lost context count
257 * @od: struct omap_device *
258 *
259 * Using the primary hwmod, query the context loss count for this
260 * device.
261 *
262 * Callers should consider context for this device lost any time this
263 * function returns a value different than the value the caller got
264 * the last time it called this function.
265 *
266 * If any hwmods exist for the omap_device assoiated with @pdev,
267 * return the context loss counter for that hwmod, otherwise return
268 * zero.
269 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300270int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700271{
272 struct omap_device *od;
273 u32 ret = 0;
274
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600275 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700276
277 if (od->hwmods_cnt)
278 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
279
280 return ret;
281}
282
283/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300284 * omap_device_count_resources - count number of struct resource entries needed
285 * @od: struct omap_device *
Peter Ujfalusidad41912012-11-21 16:15:17 -0700286 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300287 *
288 * Count the number of struct resource entries needed for this
289 * omap_device @od. Used by omap_device_build_ss() to determine how
290 * much memory to allocate before calling
291 * omap_device_fill_resources(). Returns the count.
292 */
Peter Ujfalusidad41912012-11-21 16:15:17 -0700293static int omap_device_count_resources(struct omap_device *od,
294 unsigned long flags)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300295{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300296 int c = 0;
297 int i;
298
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600299 for (i = 0; i < od->hwmods_cnt; i++)
Peter Ujfalusidad41912012-11-21 16:15:17 -0700300 c += omap_hwmod_count_resources(od->hwmods[i], flags);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300301
Paul Walmsley7852ec02012-07-26 00:54:26 -0600302 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
303 od->pdev->name, c, od->hwmods_cnt);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300304
305 return c;
306}
307
308/**
309 * omap_device_fill_resources - fill in array of struct resource
310 * @od: struct omap_device *
311 * @res: pointer to an array of struct resource to be filled in
312 *
313 * Populate one or more empty struct resource pointed to by @res with
314 * the resource data for this omap_device @od. Used by
315 * omap_device_build_ss() after calling omap_device_count_resources().
316 * Ideally this function would not be needed at all. If omap_device
317 * replaces platform_device, then we can specify our own
318 * get_resource()/ get_irq()/etc functions that use the underlying
319 * omap_hwmod information. Or if platform_device is extended to use
320 * subarchitecture-specific function pointers, the various
321 * platform_device functions can simply call omap_device internal
322 * functions to get device resources. Hacking around the existing
323 * platform_device code wastes memory. Returns 0.
324 */
Kevin Hilmana2a28ad2011-07-21 14:14:35 -0700325static int omap_device_fill_resources(struct omap_device *od,
326 struct resource *res)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300327{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300328 int i, r;
329
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600330 for (i = 0; i < od->hwmods_cnt; i++) {
331 r = omap_hwmod_fill_resources(od->hwmods[i], res);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300332 res += r;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300333 }
334
335 return 0;
336}
337
338/**
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530339 * _od_fill_dma_resources - fill in array of struct resource with dma resources
340 * @od: struct omap_device *
341 * @res: pointer to an array of struct resource to be filled in
342 *
343 * Populate one or more empty struct resource pointed to by @res with
344 * the dma resource data for this omap_device @od. Used by
345 * omap_device_alloc() after calling omap_device_count_resources().
346 *
347 * Ideally this function would not be needed at all. If we have
348 * mechanism to get dma resources from DT.
349 *
350 * Returns 0.
351 */
352static int _od_fill_dma_resources(struct omap_device *od,
353 struct resource *res)
354{
355 int i, r;
356
357 for (i = 0; i < od->hwmods_cnt; i++) {
358 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
359 res += r;
360 }
361
362 return 0;
363}
364
365/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200366 * omap_device_alloc - allocate an omap_device
367 * @pdev: platform_device that will be included in this omap_device
368 * @oh: ptr to the single omap_hwmod that backs this omap_device
369 * @pdata: platform_data ptr to associate with the platform_device
370 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200371 *
372 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700373 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200374 *
375 * Returns an struct omap_device pointer or ERR_PTR() on error;
376 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800377struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700378 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200379{
380 int ret = -ENOMEM;
381 struct omap_device *od;
382 struct resource *res = NULL;
383 int i, res_count;
384 struct omap_hwmod **hwmods;
385
386 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
387 if (!od) {
388 ret = -ENOMEM;
389 goto oda_exit1;
390 }
391 od->hwmods_cnt = oh_cnt;
392
393 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
394 if (!hwmods)
395 goto oda_exit2;
396
397 od->hwmods = hwmods;
398 od->pdev = pdev;
399
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530400 /*
Peter Ujfalusic567b052012-11-21 16:15:18 -0700401 * Non-DT Boot:
402 * Here, pdev->num_resources = 0, and we should get all the
403 * resources from hwmod.
404 *
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530405 * DT Boot:
406 * OF framework will construct the resource structure (currently
407 * does for MEM & IRQ resource) and we should respect/use these
408 * resources, killing hwmod dependency.
409 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
410 * have been allocated by OF layer already (through DTB).
Peter Ujfalusic567b052012-11-21 16:15:18 -0700411 * As preparation for the future we examine the OF provided resources
412 * to see if we have DMA resources provided already. In this case
413 * there is no need to update the resources for the device, we use the
414 * OF provided ones.
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530415 *
416 * TODO: Once DMA resource is available from OF layer, we should
417 * kill filling any resources from hwmod.
418 */
Peter Ujfalusic567b052012-11-21 16:15:18 -0700419 if (!pdev->num_resources) {
420 /* Count all resources for the device */
421 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
422 IORESOURCE_DMA |
423 IORESOURCE_MEM);
424 } else {
425 /* Take a look if we already have DMA resource via DT */
426 for (i = 0; i < pdev->num_resources; i++) {
427 struct resource *r = &pdev->resource[i];
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200428
Peter Ujfalusic567b052012-11-21 16:15:18 -0700429 /* We have it, no need to touch the resources */
430 if (r->flags == IORESOURCE_DMA)
431 goto have_everything;
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530432 }
Peter Ujfalusic567b052012-11-21 16:15:18 -0700433 /* Count only DMA resources for the device */
434 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
435 /* The device has no DMA resource, no need for update */
436 if (!res_count)
437 goto have_everything;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200438
Peter Ujfalusic567b052012-11-21 16:15:18 -0700439 res_count += pdev->num_resources;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200440 }
441
Peter Ujfalusic567b052012-11-21 16:15:18 -0700442 /* Allocate resources memory to account for new resources */
443 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
444 if (!res)
445 goto oda_exit3;
446
447 if (!pdev->num_resources) {
448 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
449 __func__, res_count);
450 omap_device_fill_resources(od, res);
451 } else {
452 dev_dbg(&pdev->dev,
453 "%s: appending %d DMA resources from hwmod\n",
454 __func__, res_count - pdev->num_resources);
455 memcpy(res, pdev->resource,
456 sizeof(struct resource) * pdev->num_resources);
457 _od_fill_dma_resources(od, &res[pdev->num_resources]);
458 }
459
460 ret = platform_device_add_resources(pdev, res, res_count);
461 kfree(res);
462
463 if (ret)
464 goto oda_exit3;
465
466have_everything:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200467 pdev->archdata.od = od;
468
469 for (i = 0; i < oh_cnt; i++) {
470 hwmods[i]->od = od;
471 _add_hwmod_clocks_clkdev(od, hwmods[i]);
472 }
473
474 return od;
475
476oda_exit3:
477 kfree(hwmods);
478oda_exit2:
479 kfree(od);
480oda_exit1:
481 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
482
483 return ERR_PTR(ret);
484}
485
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800486void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200487{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200488 if (!od)
489 return;
490
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200491 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200492 kfree(od->hwmods);
493 kfree(od);
494}
495
496/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300497 * omap_device_build - build and register an omap_device with one omap_hwmod
498 * @pdev_name: name of the platform_device driver to use
499 * @pdev_id: this platform_device's connection ID
500 * @oh: ptr to the single omap_hwmod that backs this omap_device
501 * @pdata: platform_data ptr to associate with the platform_device
502 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300503 *
504 * Convenience function for building and registering a single
505 * omap_device record, which in turn builds and registers a
506 * platform_device record. See omap_device_build_ss() for more
507 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
508 * passes along the return value of omap_device_build_ss().
509 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700510struct platform_device __init *omap_device_build(const char *pdev_name,
511 int pdev_id,
512 struct omap_hwmod *oh,
513 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300514{
515 struct omap_hwmod *ohs[] = { oh };
516
517 if (!oh)
518 return ERR_PTR(-EINVAL);
519
520 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700521 pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300522}
523
524/**
525 * omap_device_build_ss - build and register an omap_device with multiple hwmods
526 * @pdev_name: name of the platform_device driver to use
527 * @pdev_id: this platform_device's connection ID
528 * @oh: ptr to the single omap_hwmod that backs this omap_device
529 * @pdata: platform_data ptr to associate with the platform_device
530 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300531 *
532 * Convenience function for building and registering an omap_device
533 * subsystem record. Subsystem records consist of multiple
534 * omap_hwmods. This function in turn builds and registers a
535 * platform_device record. Returns an ERR_PTR() on error, or passes
536 * along the return value of omap_device_register().
537 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700538struct platform_device __init *omap_device_build_ss(const char *pdev_name,
539 int pdev_id,
540 struct omap_hwmod **ohs,
541 int oh_cnt, void *pdata,
542 int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300543{
544 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700545 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300546 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300547
548 if (!ohs || oh_cnt == 0 || !pdev_name)
549 return ERR_PTR(-EINVAL);
550
551 if (!pdata && pdata_len > 0)
552 return ERR_PTR(-EINVAL);
553
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700554 pdev = platform_device_alloc(pdev_name, pdev_id);
555 if (!pdev) {
556 ret = -ENOMEM;
557 goto odbs_exit;
558 }
559
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200560 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
561 if (pdev->id != -1)
562 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
563 else
564 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300565
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700566 od = omap_device_alloc(pdev, ohs, oh_cnt);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800567 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700568 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300569
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700570 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000571 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200572 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700573
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700574 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700575 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200576 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600577
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700578 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300579
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700580odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200581 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700582odbs_exit1:
583 platform_device_put(pdev);
584odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300585
586 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
587
588 return ERR_PTR(ret);
589}
590
Kevin Hilman256a5432011-07-12 22:48:03 +0200591#ifdef CONFIG_PM_RUNTIME
Kevin Hilman638080c2011-04-29 00:36:42 +0200592static int _od_runtime_suspend(struct device *dev)
593{
594 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700595 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200596
Kevin Hilman345f79b2011-05-31 16:08:09 -0700597 ret = pm_generic_runtime_suspend(dev);
598
599 if (!ret)
600 omap_device_idle(pdev);
601
602 return ret;
603}
604
Kevin Hilman638080c2011-04-29 00:36:42 +0200605static int _od_runtime_resume(struct device *dev)
606{
607 struct platform_device *pdev = to_platform_device(dev);
608
Kevin Hilman345f79b2011-05-31 16:08:09 -0700609 omap_device_enable(pdev);
610
611 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200612}
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600613
614static int _od_fail_runtime_suspend(struct device *dev)
615{
616 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
617 return -ENODEV;
618}
619
620static int _od_fail_runtime_resume(struct device *dev)
621{
622 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
623 return -ENODEV;
624}
625
Kevin Hilman256a5432011-07-12 22:48:03 +0200626#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200627
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200628#ifdef CONFIG_SUSPEND
629static int _od_suspend_noirq(struct device *dev)
630{
631 struct platform_device *pdev = to_platform_device(dev);
632 struct omap_device *od = to_omap_device(pdev);
633 int ret;
634
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700635 /* Don't attempt late suspend on a driver that is not bound */
636 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
637 return 0;
638
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200639 ret = pm_generic_suspend_noirq(dev);
640
641 if (!ret && !pm_runtime_status_suspended(dev)) {
642 if (pm_generic_runtime_suspend(dev) == 0) {
Nishanth Menon3522bf72013-11-14 11:05:16 -0600643 pm_runtime_set_suspended(dev);
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530644 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200645 od->flags |= OMAP_DEVICE_SUSPENDED;
646 }
647 }
648
649 return ret;
650}
651
652static int _od_resume_noirq(struct device *dev)
653{
654 struct platform_device *pdev = to_platform_device(dev);
655 struct omap_device *od = to_omap_device(pdev);
656
Nishanth Menon3522bf72013-11-14 11:05:16 -0600657 if (od->flags & OMAP_DEVICE_SUSPENDED) {
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200658 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530659 omap_device_enable(pdev);
Nishanth Menon3522bf72013-11-14 11:05:16 -0600660 /*
661 * XXX: we run before core runtime pm has resumed itself. At
662 * this point in time, we just restore the runtime pm state and
663 * considering symmetric operations in resume, we donot expect
664 * to fail. If we failed, something changed in core runtime_pm
665 * framework OR some device driver messed things up, hence, WARN
666 */
667 WARN(pm_runtime_set_active(dev),
668 "Could not set %s runtime state active\n", dev_name(dev));
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200669 pm_generic_runtime_resume(dev);
670 }
671
672 return pm_generic_resume_noirq(dev);
673}
Kevin Hilman126caf12011-09-01 10:59:36 -0700674#else
675#define _od_suspend_noirq NULL
676#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200677#endif
678
Nishanth Menonf5c33b02013-12-03 19:39:13 -0600679struct dev_pm_domain omap_device_fail_pm_domain = {
680 .ops = {
681 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
682 _od_fail_runtime_resume, NULL)
683 }
684};
685
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800686struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200687 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200688 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200689 NULL)
Kevin Hilman638080c2011-04-29 00:36:42 +0200690 USE_PLATFORM_PM_SLEEP_OPS
Kevin Hilmanff353362011-08-25 15:31:14 +0200691 .suspend_noirq = _od_suspend_noirq,
692 .resume_noirq = _od_resume_noirq,
Kevin Hilman638080c2011-04-29 00:36:42 +0200693 }
694};
695
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700696/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300697 * omap_device_register - register an omap_device with one omap_hwmod
698 * @od: struct omap_device * to register
699 *
700 * Register the omap_device structure. This currently just calls
701 * platform_device_register() on the underlying platform_device.
702 * Returns the return value of platform_device_register().
703 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800704int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300705{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700706 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300707
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700708 pdev->dev.pm_domain = &omap_device_pm_domain;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700709 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300710}
711
712
713/* Public functions for use by device drivers through struct platform_data */
714
715/**
716 * omap_device_enable - fully activate an omap_device
717 * @od: struct omap_device * to activate
718 *
719 * Do whatever is necessary for the hwmods underlying omap_device @od
720 * to be accessible and ready to operate. This generally involves
721 * enabling clocks, setting SYSCONFIG registers; and in the future may
722 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700723 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
724 * the omap_device is already enabled, or passes along the return
725 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300726 */
727int omap_device_enable(struct platform_device *pdev)
728{
729 int ret;
730 struct omap_device *od;
731
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600732 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300733
734 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700735 dev_warn(&pdev->dev,
736 "omap_device: %s() called from invalid state %d\n",
737 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300738 return -EINVAL;
739 }
740
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700741 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300742
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300743 od->_state = OMAP_DEVICE_STATE_ENABLED;
744
745 return ret;
746}
747
748/**
749 * omap_device_idle - idle an omap_device
750 * @od: struct omap_device * to idle
751 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700752 * Idle omap_device @od. Device drivers call this function indirectly
753 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300754 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700755 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300756 */
757int omap_device_idle(struct platform_device *pdev)
758{
759 int ret;
760 struct omap_device *od;
761
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600762 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300763
764 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700765 dev_warn(&pdev->dev,
766 "omap_device: %s() called from invalid state %d\n",
767 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300768 return -EINVAL;
769 }
770
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700771 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300772
773 od->_state = OMAP_DEVICE_STATE_IDLE;
774
775 return ret;
776}
777
778/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600779 * omap_device_assert_hardreset - set a device's hardreset line
780 * @pdev: struct platform_device * to reset
781 * @name: const char * name of the reset line
782 *
783 * Set the hardreset line identified by @name on the IP blocks
784 * associated with the hwmods backing the platform_device @pdev. All
785 * of the hwmods associated with @pdev must have the same hardreset
786 * line linked to them for this to work. Passes along the return value
787 * of omap_hwmod_assert_hardreset() in the event of any failure, or
788 * returns 0 upon success.
789 */
790int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
791{
792 struct omap_device *od = to_omap_device(pdev);
793 int ret = 0;
794 int i;
795
796 for (i = 0; i < od->hwmods_cnt; i++) {
797 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
798 if (ret)
799 break;
800 }
801
802 return ret;
803}
804
805/**
806 * omap_device_deassert_hardreset - release a device's hardreset line
807 * @pdev: struct platform_device * to reset
808 * @name: const char * name of the reset line
809 *
810 * Release the hardreset line identified by @name on the IP blocks
811 * associated with the hwmods backing the platform_device @pdev. All
812 * of the hwmods associated with @pdev must have the same hardreset
813 * line linked to them for this to work. Passes along the return
814 * value of omap_hwmod_deassert_hardreset() in the event of any
815 * failure, or returns 0 upon success.
816 */
817int omap_device_deassert_hardreset(struct platform_device *pdev,
818 const char *name)
819{
820 struct omap_device *od = to_omap_device(pdev);
821 int ret = 0;
822 int i;
823
824 for (i = 0; i < od->hwmods_cnt; i++) {
825 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
826 if (ret)
827 break;
828 }
829
830 return ret;
831}
832
833/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500834 * omap_device_get_by_hwmod_name() - convert a hwmod name to
835 * device pointer.
836 * @oh_name: name of the hwmod device
837 *
838 * Returns back a struct device * pointer associated with a hwmod
839 * device represented by a hwmod_name
840 */
841struct device *omap_device_get_by_hwmod_name(const char *oh_name)
842{
843 struct omap_hwmod *oh;
844
845 if (!oh_name) {
846 WARN(1, "%s: no hwmod name!\n", __func__);
847 return ERR_PTR(-EINVAL);
848 }
849
850 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000851 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500852 WARN(1, "%s: no hwmod for %s\n", __func__,
853 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000854 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500855 }
Russell King857835c2013-02-24 10:56:59 +0000856 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500857 WARN(1, "%s: no omap_device for %s\n", __func__,
858 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000859 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500860 }
861
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500862 return &oh->od->pdev->dev;
863}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700864
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200865static struct notifier_block platform_nb = {
866 .notifier_call = _omap_device_notifier_call,
867};
868
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700869static int __init omap_device_init(void)
870{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200871 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800872 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700873}
Tony Lindgrenb76c8b12013-01-11 11:24:18 -0800874omap_core_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700875
876/**
877 * omap_device_late_idle - idle devices without drivers
878 * @dev: struct device * associated with omap_device
879 * @data: unused
880 *
881 * Check the driver bound status of this device, and idle it
882 * if there is no driver attached.
883 */
884static int __init omap_device_late_idle(struct device *dev, void *data)
885{
886 struct platform_device *pdev = to_platform_device(dev);
887 struct omap_device *od = to_omap_device(pdev);
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600888 int i;
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700889
890 if (!od)
891 return 0;
892
893 /*
894 * If omap_device state is enabled, but has no driver bound,
895 * idle it.
896 */
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600897
898 /*
899 * Some devices (like memory controllers) are always kept
900 * enabled, and should not be idled even with no drivers.
901 */
902 for (i = 0; i < od->hwmods_cnt; i++)
903 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
904 return 0;
905
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700906 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
907 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
908 dev_warn(dev, "%s: enabled but no driver. Idling\n",
909 __func__);
910 omap_device_idle(pdev);
911 }
912 }
913
914 return 0;
915}
916
917static int __init omap_device_late_init(void)
918{
919 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
920 return 0;
921}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700922omap_late_initcall_sync(omap_device_late_init);