blob: e6d230700b2bdf3d0702de3b4e9cfeef67d6801e [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 Lindgrenb76c8b12013-01-11 11:24:18 -080039#include "soc.h"
Tony Lindgren25c7d492012-10-02 17:25:48 -070040#include "omap_device.h"
Tony Lindgren2a296c82012-10-02 17:41:35 -070041#include "omap_hwmod.h"
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030042
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030043/* Private functions */
44
Benoit Coussonbf1e0772011-07-10 05:54:12 -060045static void _add_clkdev(struct omap_device *od, const char *clk_alias,
46 const char *clk_name)
47{
48 struct clk *r;
49 struct clk_lookup *l;
50
51 if (!clk_alias || !clk_name)
52 return;
53
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070054 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060055
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070056 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060057 if (!IS_ERR(r)) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070058 dev_warn(&od->pdev->dev,
Kevin Hilman49882c92011-07-21 09:58:36 -070059 "alias %s already exists\n", clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060060 clk_put(r);
61 return;
62 }
63
Rajendra Nayak6ea74cb2012-09-22 02:24:16 -060064 r = clk_get(NULL, clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060065 if (IS_ERR(r)) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070066 dev_err(&od->pdev->dev,
Rajendra Nayak6ea74cb2012-09-22 02:24:16 -060067 "clk_get for %s failed\n", clk_name);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060068 return;
69 }
70
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070071 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
Benoit Coussonbf1e0772011-07-10 05:54:12 -060072 if (!l) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070073 dev_err(&od->pdev->dev,
Kevin Hilman49882c92011-07-21 09:58:36 -070074 "clkdev_alloc for %s failed\n", clk_alias);
Benoit Coussonbf1e0772011-07-10 05:54:12 -060075 return;
76 }
77
78 clkdev_add(l);
79}
80
Partha Basak4ef7aca2010-09-21 19:23:04 +020081/**
Benoit Coussonbf1e0772011-07-10 05:54:12 -060082 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
83 * and main clock
Partha Basak4ef7aca2010-09-21 19:23:04 +020084 * @od: struct omap_device *od
Benoit Coussonbf1e0772011-07-10 05:54:12 -060085 * @oh: struct omap_hwmod *oh
Partha Basak4ef7aca2010-09-21 19:23:04 +020086 *
Benoit Coussonbf1e0772011-07-10 05:54:12 -060087 * For the main clock and every optional clock present per hwmod per
88 * omap_device, this function adds an entry in the clkdev table of the
89 * form <dev-id=dev_name, con-id=role> if it does not exist already.
Partha Basak4ef7aca2010-09-21 19:23:04 +020090 *
91 * The function is called from inside omap_device_build_ss(), after
92 * omap_device_register.
93 *
94 * This allows drivers to get a pointer to its optional clocks based on its role
95 * by calling clk_get(<dev*>, <role>).
Benoit Coussonbf1e0772011-07-10 05:54:12 -060096 * In the case of the main clock, a "fck" alias is used.
Partha Basak4ef7aca2010-09-21 19:23:04 +020097 *
98 * No return value.
99 */
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600100static void _add_hwmod_clocks_clkdev(struct omap_device *od,
101 struct omap_hwmod *oh)
Partha Basak4ef7aca2010-09-21 19:23:04 +0200102{
103 int i;
104
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600105 _add_clkdev(od, "fck", oh->main_clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200106
Benoit Coussonbf1e0772011-07-10 05:54:12 -0600107 for (i = 0; i < oh->opt_clks_cnt; i++)
108 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
Partha Basak4ef7aca2010-09-21 19:23:04 +0200109}
110
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300111
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200112/**
113 * omap_device_build_from_dt - build an omap_device with multiple hwmods
114 * @pdev_name: name of the platform_device driver to use
115 * @pdev_id: this platform_device's connection ID
116 * @oh: ptr to the single omap_hwmod that backs this omap_device
117 * @pdata: platform_data ptr to associate with the platform_device
118 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200119 *
120 * Function for building an omap_device already registered from device-tree
121 *
122 * Returns 0 or PTR_ERR() on error.
123 */
124static int omap_device_build_from_dt(struct platform_device *pdev)
125{
126 struct omap_hwmod **hwmods;
127 struct omap_device *od;
128 struct omap_hwmod *oh;
129 struct device_node *node = pdev->dev.of_node;
130 const char *oh_name;
131 int oh_cnt, i, ret = 0;
132
133 oh_cnt = of_property_count_strings(node, "ti,hwmods");
Russell Kingc48cd652013-03-13 20:44:21 +0000134 if (oh_cnt <= 0) {
Benoit Cousson5dc06b72012-01-20 18:14:00 +0100135 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200136 return -ENODEV;
137 }
138
139 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
140 if (!hwmods) {
141 ret = -ENOMEM;
142 goto odbfd_exit;
143 }
144
145 for (i = 0; i < oh_cnt; i++) {
146 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
147 oh = omap_hwmod_lookup(oh_name);
148 if (!oh) {
149 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
150 oh_name);
151 ret = -EINVAL;
152 goto odbfd_exit1;
153 }
154 hwmods[i] = oh;
155 }
156
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700157 od = omap_device_alloc(pdev, hwmods, oh_cnt);
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200158 if (!od) {
159 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
160 oh_name);
161 ret = PTR_ERR(od);
162 goto odbfd_exit1;
163 }
164
Peter Ujfalusi3956a1a2012-08-23 16:54:09 +0300165 /* Fix up missing resource names */
166 for (i = 0; i < pdev->num_resources; i++) {
167 struct resource *r = &pdev->resource[i];
168
169 if (r->name == NULL)
170 r->name = dev_name(&pdev->dev);
171 }
172
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200173 if (of_get_property(node, "ti,no_idle_on_suspend", NULL))
174 omap_device_disable_idle_on_suspend(pdev);
175
176 pdev->dev.pm_domain = &omap_device_pm_domain;
177
178odbfd_exit1:
179 kfree(hwmods);
180odbfd_exit:
181 return ret;
182}
183
184static int _omap_device_notifier_call(struct notifier_block *nb,
185 unsigned long event, void *dev)
186{
187 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700188 struct omap_device *od;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200189
190 switch (event) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200191 case BUS_NOTIFY_DEL_DEVICE:
192 if (pdev->archdata.od)
193 omap_device_delete(pdev->archdata.od);
194 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700195 case BUS_NOTIFY_ADD_DEVICE:
196 if (pdev->dev.of_node)
197 omap_device_build_from_dt(pdev);
198 /* fall through */
199 default:
200 od = to_omap_device(pdev);
201 if (od)
202 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200203 }
204
205 return NOTIFY_DONE;
206}
207
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700208/**
209 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
210 * @od: struct omap_device *od
211 *
212 * Enable all underlying hwmods. Returns 0.
213 */
214static int _omap_device_enable_hwmods(struct omap_device *od)
215{
216 int i;
217
218 for (i = 0; i < od->hwmods_cnt; i++)
219 omap_hwmod_enable(od->hwmods[i]);
220
221 /* XXX pass along return value here? */
222 return 0;
223}
224
225/**
226 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
227 * @od: struct omap_device *od
228 *
229 * Idle all underlying hwmods. Returns 0.
230 */
231static int _omap_device_idle_hwmods(struct omap_device *od)
232{
233 int i;
234
235 for (i = 0; i < od->hwmods_cnt; i++)
236 omap_hwmod_idle(od->hwmods[i]);
237
238 /* XXX pass along return value here? */
239 return 0;
240}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200241
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300242/* Public functions for use by core code */
243
244/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700245 * omap_device_get_context_loss_count - get lost context count
246 * @od: struct omap_device *
247 *
248 * Using the primary hwmod, query the context loss count for this
249 * device.
250 *
251 * Callers should consider context for this device lost any time this
252 * function returns a value different than the value the caller got
253 * the last time it called this function.
254 *
255 * If any hwmods exist for the omap_device assoiated with @pdev,
256 * return the context loss counter for that hwmod, otherwise return
257 * zero.
258 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300259int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700260{
261 struct omap_device *od;
262 u32 ret = 0;
263
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600264 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700265
266 if (od->hwmods_cnt)
267 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
268
269 return ret;
270}
271
272/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300273 * omap_device_count_resources - count number of struct resource entries needed
274 * @od: struct omap_device *
Peter Ujfalusidad41912012-11-21 16:15:17 -0700275 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300276 *
277 * Count the number of struct resource entries needed for this
278 * omap_device @od. Used by omap_device_build_ss() to determine how
279 * much memory to allocate before calling
280 * omap_device_fill_resources(). Returns the count.
281 */
Peter Ujfalusidad41912012-11-21 16:15:17 -0700282static int omap_device_count_resources(struct omap_device *od,
283 unsigned long flags)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300284{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300285 int c = 0;
286 int i;
287
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600288 for (i = 0; i < od->hwmods_cnt; i++)
Peter Ujfalusidad41912012-11-21 16:15:17 -0700289 c += omap_hwmod_count_resources(od->hwmods[i], flags);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300290
Paul Walmsley7852ec02012-07-26 00:54:26 -0600291 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
292 od->pdev->name, c, od->hwmods_cnt);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300293
294 return c;
295}
296
297/**
298 * omap_device_fill_resources - fill in array of struct resource
299 * @od: struct omap_device *
300 * @res: pointer to an array of struct resource to be filled in
301 *
302 * Populate one or more empty struct resource pointed to by @res with
303 * the resource data for this omap_device @od. Used by
304 * omap_device_build_ss() after calling omap_device_count_resources().
305 * Ideally this function would not be needed at all. If omap_device
306 * replaces platform_device, then we can specify our own
307 * get_resource()/ get_irq()/etc functions that use the underlying
308 * omap_hwmod information. Or if platform_device is extended to use
309 * subarchitecture-specific function pointers, the various
310 * platform_device functions can simply call omap_device internal
311 * functions to get device resources. Hacking around the existing
312 * platform_device code wastes memory. Returns 0.
313 */
Kevin Hilmana2a28ad2011-07-21 14:14:35 -0700314static int omap_device_fill_resources(struct omap_device *od,
315 struct resource *res)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300316{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300317 int i, r;
318
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600319 for (i = 0; i < od->hwmods_cnt; i++) {
320 r = omap_hwmod_fill_resources(od->hwmods[i], res);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300321 res += r;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300322 }
323
324 return 0;
325}
326
327/**
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530328 * _od_fill_dma_resources - fill in array of struct resource with dma resources
329 * @od: struct omap_device *
330 * @res: pointer to an array of struct resource to be filled in
331 *
332 * Populate one or more empty struct resource pointed to by @res with
333 * the dma resource data for this omap_device @od. Used by
334 * omap_device_alloc() after calling omap_device_count_resources().
335 *
336 * Ideally this function would not be needed at all. If we have
337 * mechanism to get dma resources from DT.
338 *
339 * Returns 0.
340 */
341static int _od_fill_dma_resources(struct omap_device *od,
342 struct resource *res)
343{
344 int i, r;
345
346 for (i = 0; i < od->hwmods_cnt; i++) {
347 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
348 res += r;
349 }
350
351 return 0;
352}
353
354/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200355 * omap_device_alloc - allocate an omap_device
356 * @pdev: platform_device that will be included in this omap_device
357 * @oh: ptr to the single omap_hwmod that backs this omap_device
358 * @pdata: platform_data ptr to associate with the platform_device
359 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200360 *
361 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700362 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200363 *
364 * Returns an struct omap_device pointer or ERR_PTR() on error;
365 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800366struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700367 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200368{
369 int ret = -ENOMEM;
370 struct omap_device *od;
371 struct resource *res = NULL;
372 int i, res_count;
373 struct omap_hwmod **hwmods;
374
375 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
376 if (!od) {
377 ret = -ENOMEM;
378 goto oda_exit1;
379 }
380 od->hwmods_cnt = oh_cnt;
381
382 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
383 if (!hwmods)
384 goto oda_exit2;
385
386 od->hwmods = hwmods;
387 od->pdev = pdev;
388
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530389 /*
Peter Ujfalusic567b052012-11-21 16:15:18 -0700390 * Non-DT Boot:
391 * Here, pdev->num_resources = 0, and we should get all the
392 * resources from hwmod.
393 *
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530394 * DT Boot:
395 * OF framework will construct the resource structure (currently
396 * does for MEM & IRQ resource) and we should respect/use these
397 * resources, killing hwmod dependency.
398 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
399 * have been allocated by OF layer already (through DTB).
Peter Ujfalusic567b052012-11-21 16:15:18 -0700400 * As preparation for the future we examine the OF provided resources
401 * to see if we have DMA resources provided already. In this case
402 * there is no need to update the resources for the device, we use the
403 * OF provided ones.
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530404 *
405 * TODO: Once DMA resource is available from OF layer, we should
406 * kill filling any resources from hwmod.
407 */
Peter Ujfalusic567b052012-11-21 16:15:18 -0700408 if (!pdev->num_resources) {
409 /* Count all resources for the device */
410 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
411 IORESOURCE_DMA |
412 IORESOURCE_MEM);
413 } else {
414 /* Take a look if we already have DMA resource via DT */
415 for (i = 0; i < pdev->num_resources; i++) {
416 struct resource *r = &pdev->resource[i];
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200417
Peter Ujfalusic567b052012-11-21 16:15:18 -0700418 /* We have it, no need to touch the resources */
419 if (r->flags == IORESOURCE_DMA)
420 goto have_everything;
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530421 }
Peter Ujfalusic567b052012-11-21 16:15:18 -0700422 /* Count only DMA resources for the device */
423 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
424 /* The device has no DMA resource, no need for update */
425 if (!res_count)
426 goto have_everything;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200427
Peter Ujfalusic567b052012-11-21 16:15:18 -0700428 res_count += pdev->num_resources;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200429 }
430
Peter Ujfalusic567b052012-11-21 16:15:18 -0700431 /* Allocate resources memory to account for new resources */
432 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
433 if (!res)
434 goto oda_exit3;
435
436 if (!pdev->num_resources) {
437 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
438 __func__, res_count);
439 omap_device_fill_resources(od, res);
440 } else {
441 dev_dbg(&pdev->dev,
442 "%s: appending %d DMA resources from hwmod\n",
443 __func__, res_count - pdev->num_resources);
444 memcpy(res, pdev->resource,
445 sizeof(struct resource) * pdev->num_resources);
446 _od_fill_dma_resources(od, &res[pdev->num_resources]);
447 }
448
449 ret = platform_device_add_resources(pdev, res, res_count);
450 kfree(res);
451
452 if (ret)
453 goto oda_exit3;
454
455have_everything:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200456 pdev->archdata.od = od;
457
458 for (i = 0; i < oh_cnt; i++) {
459 hwmods[i]->od = od;
460 _add_hwmod_clocks_clkdev(od, hwmods[i]);
461 }
462
463 return od;
464
465oda_exit3:
466 kfree(hwmods);
467oda_exit2:
468 kfree(od);
469oda_exit1:
470 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
471
472 return ERR_PTR(ret);
473}
474
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800475void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200476{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200477 if (!od)
478 return;
479
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200480 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200481 kfree(od->hwmods);
482 kfree(od);
483}
484
485/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300486 * omap_device_build - build and register an omap_device with one omap_hwmod
487 * @pdev_name: name of the platform_device driver to use
488 * @pdev_id: this platform_device's connection ID
489 * @oh: ptr to the single omap_hwmod that backs this omap_device
490 * @pdata: platform_data ptr to associate with the platform_device
491 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300492 *
493 * Convenience function for building and registering a single
494 * omap_device record, which in turn builds and registers a
495 * platform_device record. See omap_device_build_ss() for more
496 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
497 * passes along the return value of omap_device_build_ss().
498 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700499struct platform_device __init *omap_device_build(const char *pdev_name,
500 int pdev_id,
501 struct omap_hwmod *oh,
502 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300503{
504 struct omap_hwmod *ohs[] = { oh };
505
506 if (!oh)
507 return ERR_PTR(-EINVAL);
508
509 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700510 pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300511}
512
513/**
514 * omap_device_build_ss - build and register an omap_device with multiple hwmods
515 * @pdev_name: name of the platform_device driver to use
516 * @pdev_id: this platform_device's connection ID
517 * @oh: ptr to the single omap_hwmod that backs this omap_device
518 * @pdata: platform_data ptr to associate with the platform_device
519 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300520 *
521 * Convenience function for building and registering an omap_device
522 * subsystem record. Subsystem records consist of multiple
523 * omap_hwmods. This function in turn builds and registers a
524 * platform_device record. Returns an ERR_PTR() on error, or passes
525 * along the return value of omap_device_register().
526 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700527struct platform_device __init *omap_device_build_ss(const char *pdev_name,
528 int pdev_id,
529 struct omap_hwmod **ohs,
530 int oh_cnt, void *pdata,
531 int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300532{
533 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700534 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300535 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300536
537 if (!ohs || oh_cnt == 0 || !pdev_name)
538 return ERR_PTR(-EINVAL);
539
540 if (!pdata && pdata_len > 0)
541 return ERR_PTR(-EINVAL);
542
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700543 pdev = platform_device_alloc(pdev_name, pdev_id);
544 if (!pdev) {
545 ret = -ENOMEM;
546 goto odbs_exit;
547 }
548
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200549 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
550 if (pdev->id != -1)
551 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
552 else
553 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300554
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700555 od = omap_device_alloc(pdev, ohs, oh_cnt);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800556 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700557 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300558
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700559 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000560 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200561 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700562
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700563 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700564 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200565 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600566
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700567 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300568
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700569odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200570 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700571odbs_exit1:
572 platform_device_put(pdev);
573odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300574
575 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
576
577 return ERR_PTR(ret);
578}
579
Kevin Hilman256a5432011-07-12 22:48:03 +0200580#ifdef CONFIG_PM_RUNTIME
Kevin Hilman638080c2011-04-29 00:36:42 +0200581static int _od_runtime_suspend(struct device *dev)
582{
583 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700584 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200585
Kevin Hilman345f79b2011-05-31 16:08:09 -0700586 ret = pm_generic_runtime_suspend(dev);
587
588 if (!ret)
589 omap_device_idle(pdev);
590
591 return ret;
592}
593
594static int _od_runtime_idle(struct device *dev)
595{
596 return pm_generic_runtime_idle(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200597}
598
599static int _od_runtime_resume(struct device *dev)
600{
601 struct platform_device *pdev = to_platform_device(dev);
602
Kevin Hilman345f79b2011-05-31 16:08:09 -0700603 omap_device_enable(pdev);
604
605 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200606}
Kevin Hilman256a5432011-07-12 22:48:03 +0200607#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200608
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200609#ifdef CONFIG_SUSPEND
610static int _od_suspend_noirq(struct device *dev)
611{
612 struct platform_device *pdev = to_platform_device(dev);
613 struct omap_device *od = to_omap_device(pdev);
614 int ret;
615
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700616 /* Don't attempt late suspend on a driver that is not bound */
617 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
618 return 0;
619
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200620 ret = pm_generic_suspend_noirq(dev);
621
622 if (!ret && !pm_runtime_status_suspended(dev)) {
623 if (pm_generic_runtime_suspend(dev) == 0) {
Paul Walmsleyb7c39a32012-03-03 13:15:33 -0700624 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
625 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200626 od->flags |= OMAP_DEVICE_SUSPENDED;
627 }
628 }
629
630 return ret;
631}
632
633static int _od_resume_noirq(struct device *dev)
634{
635 struct platform_device *pdev = to_platform_device(dev);
636 struct omap_device *od = to_omap_device(pdev);
637
638 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
639 !pm_runtime_status_suspended(dev)) {
640 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Paul Walmsleyb7c39a32012-03-03 13:15:33 -0700641 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
642 omap_device_enable(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200643 pm_generic_runtime_resume(dev);
644 }
645
646 return pm_generic_resume_noirq(dev);
647}
Kevin Hilman126caf12011-09-01 10:59:36 -0700648#else
649#define _od_suspend_noirq NULL
650#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200651#endif
652
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800653struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200654 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200655 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
656 _od_runtime_idle)
Kevin Hilman638080c2011-04-29 00:36:42 +0200657 USE_PLATFORM_PM_SLEEP_OPS
Kevin Hilmanff353362011-08-25 15:31:14 +0200658 .suspend_noirq = _od_suspend_noirq,
659 .resume_noirq = _od_resume_noirq,
Kevin Hilman638080c2011-04-29 00:36:42 +0200660 }
661};
662
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700663/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300664 * omap_device_register - register an omap_device with one omap_hwmod
665 * @od: struct omap_device * to register
666 *
667 * Register the omap_device structure. This currently just calls
668 * platform_device_register() on the underlying platform_device.
669 * Returns the return value of platform_device_register().
670 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800671int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300672{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700673 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300674
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700675 pdev->dev.pm_domain = &omap_device_pm_domain;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700676 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300677}
678
679
680/* Public functions for use by device drivers through struct platform_data */
681
682/**
683 * omap_device_enable - fully activate an omap_device
684 * @od: struct omap_device * to activate
685 *
686 * Do whatever is necessary for the hwmods underlying omap_device @od
687 * to be accessible and ready to operate. This generally involves
688 * enabling clocks, setting SYSCONFIG registers; and in the future may
689 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700690 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
691 * the omap_device is already enabled, or passes along the return
692 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300693 */
694int omap_device_enable(struct platform_device *pdev)
695{
696 int ret;
697 struct omap_device *od;
698
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600699 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300700
701 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700702 dev_warn(&pdev->dev,
703 "omap_device: %s() called from invalid state %d\n",
704 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300705 return -EINVAL;
706 }
707
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700708 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300709
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300710 od->_state = OMAP_DEVICE_STATE_ENABLED;
711
712 return ret;
713}
714
715/**
716 * omap_device_idle - idle an omap_device
717 * @od: struct omap_device * to idle
718 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700719 * Idle omap_device @od. Device drivers call this function indirectly
720 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300721 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700722 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300723 */
724int omap_device_idle(struct platform_device *pdev)
725{
726 int ret;
727 struct omap_device *od;
728
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600729 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300730
731 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700732 dev_warn(&pdev->dev,
733 "omap_device: %s() called from invalid state %d\n",
734 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300735 return -EINVAL;
736 }
737
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700738 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300739
740 od->_state = OMAP_DEVICE_STATE_IDLE;
741
742 return ret;
743}
744
745/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600746 * omap_device_assert_hardreset - set a device's hardreset line
747 * @pdev: struct platform_device * to reset
748 * @name: const char * name of the reset line
749 *
750 * Set the hardreset line identified by @name on the IP blocks
751 * associated with the hwmods backing the platform_device @pdev. All
752 * of the hwmods associated with @pdev must have the same hardreset
753 * line linked to them for this to work. Passes along the return value
754 * of omap_hwmod_assert_hardreset() in the event of any failure, or
755 * returns 0 upon success.
756 */
757int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
758{
759 struct omap_device *od = to_omap_device(pdev);
760 int ret = 0;
761 int i;
762
763 for (i = 0; i < od->hwmods_cnt; i++) {
764 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
765 if (ret)
766 break;
767 }
768
769 return ret;
770}
771
772/**
773 * omap_device_deassert_hardreset - release a device's hardreset line
774 * @pdev: struct platform_device * to reset
775 * @name: const char * name of the reset line
776 *
777 * Release the hardreset line identified by @name on the IP blocks
778 * associated with the hwmods backing the platform_device @pdev. All
779 * of the hwmods associated with @pdev must have the same hardreset
780 * line linked to them for this to work. Passes along the return
781 * value of omap_hwmod_deassert_hardreset() in the event of any
782 * failure, or returns 0 upon success.
783 */
784int omap_device_deassert_hardreset(struct platform_device *pdev,
785 const char *name)
786{
787 struct omap_device *od = to_omap_device(pdev);
788 int ret = 0;
789 int i;
790
791 for (i = 0; i < od->hwmods_cnt; i++) {
792 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
793 if (ret)
794 break;
795 }
796
797 return ret;
798}
799
800/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500801 * omap_device_get_by_hwmod_name() - convert a hwmod name to
802 * device pointer.
803 * @oh_name: name of the hwmod device
804 *
805 * Returns back a struct device * pointer associated with a hwmod
806 * device represented by a hwmod_name
807 */
808struct device *omap_device_get_by_hwmod_name(const char *oh_name)
809{
810 struct omap_hwmod *oh;
811
812 if (!oh_name) {
813 WARN(1, "%s: no hwmod name!\n", __func__);
814 return ERR_PTR(-EINVAL);
815 }
816
817 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000818 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500819 WARN(1, "%s: no hwmod for %s\n", __func__,
820 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000821 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500822 }
Russell King857835c2013-02-24 10:56:59 +0000823 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500824 WARN(1, "%s: no omap_device for %s\n", __func__,
825 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000826 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500827 }
828
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500829 return &oh->od->pdev->dev;
830}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700831
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200832static struct notifier_block platform_nb = {
833 .notifier_call = _omap_device_notifier_call,
834};
835
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700836static int __init omap_device_init(void)
837{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200838 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800839 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700840}
Tony Lindgrenb76c8b12013-01-11 11:24:18 -0800841omap_core_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700842
843/**
844 * omap_device_late_idle - idle devices without drivers
845 * @dev: struct device * associated with omap_device
846 * @data: unused
847 *
848 * Check the driver bound status of this device, and idle it
849 * if there is no driver attached.
850 */
851static int __init omap_device_late_idle(struct device *dev, void *data)
852{
853 struct platform_device *pdev = to_platform_device(dev);
854 struct omap_device *od = to_omap_device(pdev);
855
856 if (!od)
857 return 0;
858
859 /*
860 * If omap_device state is enabled, but has no driver bound,
861 * idle it.
862 */
863 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
864 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
865 dev_warn(dev, "%s: enabled but no driver. Idling\n",
866 __func__);
867 omap_device_idle(pdev);
868 }
869 }
870
871 return 0;
872}
873
874static int __init omap_device_late_init(void)
875{
876 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
877 return 0;
878}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700879omap_late_initcall_sync(omap_device_late_init);