blob: 68be532f8688c30e857cc4463c414ab4ffc18c9c [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 pdev->dev.pm_domain = &omap_device_pm_domain;
174
175odbfd_exit1:
176 kfree(hwmods);
177odbfd_exit:
178 return ret;
179}
180
181static int _omap_device_notifier_call(struct notifier_block *nb,
182 unsigned long event, void *dev)
183{
184 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700185 struct omap_device *od;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200186
187 switch (event) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200188 case BUS_NOTIFY_DEL_DEVICE:
189 if (pdev->archdata.od)
190 omap_device_delete(pdev->archdata.od);
191 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700192 case BUS_NOTIFY_ADD_DEVICE:
193 if (pdev->dev.of_node)
194 omap_device_build_from_dt(pdev);
195 /* fall through */
196 default:
197 od = to_omap_device(pdev);
198 if (od)
199 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200200 }
201
202 return NOTIFY_DONE;
203}
204
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700205/**
206 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
207 * @od: struct omap_device *od
208 *
209 * Enable all underlying hwmods. Returns 0.
210 */
211static int _omap_device_enable_hwmods(struct omap_device *od)
212{
213 int i;
214
215 for (i = 0; i < od->hwmods_cnt; i++)
216 omap_hwmod_enable(od->hwmods[i]);
217
218 /* XXX pass along return value here? */
219 return 0;
220}
221
222/**
223 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
224 * @od: struct omap_device *od
225 *
226 * Idle all underlying hwmods. Returns 0.
227 */
228static int _omap_device_idle_hwmods(struct omap_device *od)
229{
230 int i;
231
232 for (i = 0; i < od->hwmods_cnt; i++)
233 omap_hwmod_idle(od->hwmods[i]);
234
235 /* XXX pass along return value here? */
236 return 0;
237}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200238
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300239/* Public functions for use by core code */
240
241/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700242 * omap_device_get_context_loss_count - get lost context count
243 * @od: struct omap_device *
244 *
245 * Using the primary hwmod, query the context loss count for this
246 * device.
247 *
248 * Callers should consider context for this device lost any time this
249 * function returns a value different than the value the caller got
250 * the last time it called this function.
251 *
252 * If any hwmods exist for the omap_device assoiated with @pdev,
253 * return the context loss counter for that hwmod, otherwise return
254 * zero.
255 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300256int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700257{
258 struct omap_device *od;
259 u32 ret = 0;
260
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600261 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700262
263 if (od->hwmods_cnt)
264 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
265
266 return ret;
267}
268
269/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300270 * omap_device_count_resources - count number of struct resource entries needed
271 * @od: struct omap_device *
Peter Ujfalusidad41912012-11-21 16:15:17 -0700272 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300273 *
274 * Count the number of struct resource entries needed for this
275 * omap_device @od. Used by omap_device_build_ss() to determine how
276 * much memory to allocate before calling
277 * omap_device_fill_resources(). Returns the count.
278 */
Peter Ujfalusidad41912012-11-21 16:15:17 -0700279static int omap_device_count_resources(struct omap_device *od,
280 unsigned long flags)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300281{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300282 int c = 0;
283 int i;
284
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600285 for (i = 0; i < od->hwmods_cnt; i++)
Peter Ujfalusidad41912012-11-21 16:15:17 -0700286 c += omap_hwmod_count_resources(od->hwmods[i], flags);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300287
Paul Walmsley7852ec02012-07-26 00:54:26 -0600288 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
289 od->pdev->name, c, od->hwmods_cnt);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300290
291 return c;
292}
293
294/**
295 * omap_device_fill_resources - fill in array of struct resource
296 * @od: struct omap_device *
297 * @res: pointer to an array of struct resource to be filled in
298 *
299 * Populate one or more empty struct resource pointed to by @res with
300 * the resource data for this omap_device @od. Used by
301 * omap_device_build_ss() after calling omap_device_count_resources().
302 * Ideally this function would not be needed at all. If omap_device
303 * replaces platform_device, then we can specify our own
304 * get_resource()/ get_irq()/etc functions that use the underlying
305 * omap_hwmod information. Or if platform_device is extended to use
306 * subarchitecture-specific function pointers, the various
307 * platform_device functions can simply call omap_device internal
308 * functions to get device resources. Hacking around the existing
309 * platform_device code wastes memory. Returns 0.
310 */
Kevin Hilmana2a28ad2011-07-21 14:14:35 -0700311static int omap_device_fill_resources(struct omap_device *od,
312 struct resource *res)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300313{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300314 int i, r;
315
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600316 for (i = 0; i < od->hwmods_cnt; i++) {
317 r = omap_hwmod_fill_resources(od->hwmods[i], res);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300318 res += r;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300319 }
320
321 return 0;
322}
323
324/**
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530325 * _od_fill_dma_resources - fill in array of struct resource with dma resources
326 * @od: struct omap_device *
327 * @res: pointer to an array of struct resource to be filled in
328 *
329 * Populate one or more empty struct resource pointed to by @res with
330 * the dma resource data for this omap_device @od. Used by
331 * omap_device_alloc() after calling omap_device_count_resources().
332 *
333 * Ideally this function would not be needed at all. If we have
334 * mechanism to get dma resources from DT.
335 *
336 * Returns 0.
337 */
338static int _od_fill_dma_resources(struct omap_device *od,
339 struct resource *res)
340{
341 int i, r;
342
343 for (i = 0; i < od->hwmods_cnt; i++) {
344 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
345 res += r;
346 }
347
348 return 0;
349}
350
351/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200352 * omap_device_alloc - allocate an omap_device
353 * @pdev: platform_device that will be included in this omap_device
354 * @oh: ptr to the single omap_hwmod that backs this omap_device
355 * @pdata: platform_data ptr to associate with the platform_device
356 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200357 *
358 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700359 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200360 *
361 * Returns an struct omap_device pointer or ERR_PTR() on error;
362 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800363struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700364 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200365{
366 int ret = -ENOMEM;
367 struct omap_device *od;
368 struct resource *res = NULL;
369 int i, res_count;
370 struct omap_hwmod **hwmods;
371
372 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
373 if (!od) {
374 ret = -ENOMEM;
375 goto oda_exit1;
376 }
377 od->hwmods_cnt = oh_cnt;
378
379 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
380 if (!hwmods)
381 goto oda_exit2;
382
383 od->hwmods = hwmods;
384 od->pdev = pdev;
385
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530386 /*
Peter Ujfalusic567b052012-11-21 16:15:18 -0700387 * Non-DT Boot:
388 * Here, pdev->num_resources = 0, and we should get all the
389 * resources from hwmod.
390 *
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530391 * DT Boot:
392 * OF framework will construct the resource structure (currently
393 * does for MEM & IRQ resource) and we should respect/use these
394 * resources, killing hwmod dependency.
395 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
396 * have been allocated by OF layer already (through DTB).
Peter Ujfalusic567b052012-11-21 16:15:18 -0700397 * As preparation for the future we examine the OF provided resources
398 * to see if we have DMA resources provided already. In this case
399 * there is no need to update the resources for the device, we use the
400 * OF provided ones.
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530401 *
402 * TODO: Once DMA resource is available from OF layer, we should
403 * kill filling any resources from hwmod.
404 */
Peter Ujfalusic567b052012-11-21 16:15:18 -0700405 if (!pdev->num_resources) {
406 /* Count all resources for the device */
407 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
408 IORESOURCE_DMA |
409 IORESOURCE_MEM);
410 } else {
411 /* Take a look if we already have DMA resource via DT */
412 for (i = 0; i < pdev->num_resources; i++) {
413 struct resource *r = &pdev->resource[i];
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200414
Peter Ujfalusic567b052012-11-21 16:15:18 -0700415 /* We have it, no need to touch the resources */
416 if (r->flags == IORESOURCE_DMA)
417 goto have_everything;
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530418 }
Peter Ujfalusic567b052012-11-21 16:15:18 -0700419 /* Count only DMA resources for the device */
420 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
421 /* The device has no DMA resource, no need for update */
422 if (!res_count)
423 goto have_everything;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200424
Peter Ujfalusic567b052012-11-21 16:15:18 -0700425 res_count += pdev->num_resources;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200426 }
427
Peter Ujfalusic567b052012-11-21 16:15:18 -0700428 /* Allocate resources memory to account for new resources */
429 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
430 if (!res)
431 goto oda_exit3;
432
433 if (!pdev->num_resources) {
434 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
435 __func__, res_count);
436 omap_device_fill_resources(od, res);
437 } else {
438 dev_dbg(&pdev->dev,
439 "%s: appending %d DMA resources from hwmod\n",
440 __func__, res_count - pdev->num_resources);
441 memcpy(res, pdev->resource,
442 sizeof(struct resource) * pdev->num_resources);
443 _od_fill_dma_resources(od, &res[pdev->num_resources]);
444 }
445
446 ret = platform_device_add_resources(pdev, res, res_count);
447 kfree(res);
448
449 if (ret)
450 goto oda_exit3;
451
452have_everything:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200453 pdev->archdata.od = od;
454
455 for (i = 0; i < oh_cnt; i++) {
456 hwmods[i]->od = od;
457 _add_hwmod_clocks_clkdev(od, hwmods[i]);
458 }
459
460 return od;
461
462oda_exit3:
463 kfree(hwmods);
464oda_exit2:
465 kfree(od);
466oda_exit1:
467 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
468
469 return ERR_PTR(ret);
470}
471
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800472void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200473{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200474 if (!od)
475 return;
476
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200477 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200478 kfree(od->hwmods);
479 kfree(od);
480}
481
482/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300483 * omap_device_build - build and register an omap_device with one omap_hwmod
484 * @pdev_name: name of the platform_device driver to use
485 * @pdev_id: this platform_device's connection ID
486 * @oh: ptr to the single omap_hwmod that backs this omap_device
487 * @pdata: platform_data ptr to associate with the platform_device
488 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300489 *
490 * Convenience function for building and registering a single
491 * omap_device record, which in turn builds and registers a
492 * platform_device record. See omap_device_build_ss() for more
493 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
494 * passes along the return value of omap_device_build_ss().
495 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700496struct platform_device __init *omap_device_build(const char *pdev_name,
497 int pdev_id,
498 struct omap_hwmod *oh,
499 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300500{
501 struct omap_hwmod *ohs[] = { oh };
502
503 if (!oh)
504 return ERR_PTR(-EINVAL);
505
506 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700507 pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300508}
509
510/**
511 * omap_device_build_ss - build and register an omap_device with multiple hwmods
512 * @pdev_name: name of the platform_device driver to use
513 * @pdev_id: this platform_device's connection ID
514 * @oh: ptr to the single omap_hwmod that backs this omap_device
515 * @pdata: platform_data ptr to associate with the platform_device
516 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300517 *
518 * Convenience function for building and registering an omap_device
519 * subsystem record. Subsystem records consist of multiple
520 * omap_hwmods. This function in turn builds and registers a
521 * platform_device record. Returns an ERR_PTR() on error, or passes
522 * along the return value of omap_device_register().
523 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700524struct platform_device __init *omap_device_build_ss(const char *pdev_name,
525 int pdev_id,
526 struct omap_hwmod **ohs,
527 int oh_cnt, void *pdata,
528 int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300529{
530 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700531 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300532 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300533
534 if (!ohs || oh_cnt == 0 || !pdev_name)
535 return ERR_PTR(-EINVAL);
536
537 if (!pdata && pdata_len > 0)
538 return ERR_PTR(-EINVAL);
539
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700540 pdev = platform_device_alloc(pdev_name, pdev_id);
541 if (!pdev) {
542 ret = -ENOMEM;
543 goto odbs_exit;
544 }
545
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200546 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
547 if (pdev->id != -1)
548 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
549 else
550 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300551
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700552 od = omap_device_alloc(pdev, ohs, oh_cnt);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800553 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700554 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300555
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700556 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000557 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200558 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700559
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700560 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700561 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200562 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600563
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700564 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300565
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700566odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200567 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700568odbs_exit1:
569 platform_device_put(pdev);
570odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300571
572 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
573
574 return ERR_PTR(ret);
575}
576
Kevin Hilman256a5432011-07-12 22:48:03 +0200577#ifdef CONFIG_PM_RUNTIME
Kevin Hilman638080c2011-04-29 00:36:42 +0200578static int _od_runtime_suspend(struct device *dev)
579{
580 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700581 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200582
Kevin Hilman345f79b2011-05-31 16:08:09 -0700583 ret = pm_generic_runtime_suspend(dev);
584
585 if (!ret)
586 omap_device_idle(pdev);
587
588 return ret;
589}
590
591static int _od_runtime_idle(struct device *dev)
592{
593 return pm_generic_runtime_idle(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200594}
595
596static int _od_runtime_resume(struct device *dev)
597{
598 struct platform_device *pdev = to_platform_device(dev);
599
Kevin Hilman345f79b2011-05-31 16:08:09 -0700600 omap_device_enable(pdev);
601
602 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200603}
Kevin Hilman256a5432011-07-12 22:48:03 +0200604#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200605
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200606#ifdef CONFIG_SUSPEND
607static int _od_suspend_noirq(struct device *dev)
608{
609 struct platform_device *pdev = to_platform_device(dev);
610 struct omap_device *od = to_omap_device(pdev);
611 int ret;
612
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700613 /* Don't attempt late suspend on a driver that is not bound */
614 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
615 return 0;
616
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200617 ret = pm_generic_suspend_noirq(dev);
618
619 if (!ret && !pm_runtime_status_suspended(dev)) {
620 if (pm_generic_runtime_suspend(dev) == 0) {
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530621 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200622 od->flags |= OMAP_DEVICE_SUSPENDED;
623 }
624 }
625
626 return ret;
627}
628
629static int _od_resume_noirq(struct device *dev)
630{
631 struct platform_device *pdev = to_platform_device(dev);
632 struct omap_device *od = to_omap_device(pdev);
633
634 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
635 !pm_runtime_status_suspended(dev)) {
636 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530637 omap_device_enable(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200638 pm_generic_runtime_resume(dev);
639 }
640
641 return pm_generic_resume_noirq(dev);
642}
Kevin Hilman126caf12011-09-01 10:59:36 -0700643#else
644#define _od_suspend_noirq NULL
645#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200646#endif
647
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800648struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200649 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200650 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
651 _od_runtime_idle)
Kevin Hilman638080c2011-04-29 00:36:42 +0200652 USE_PLATFORM_PM_SLEEP_OPS
Kevin Hilmanff353362011-08-25 15:31:14 +0200653 .suspend_noirq = _od_suspend_noirq,
654 .resume_noirq = _od_resume_noirq,
Kevin Hilman638080c2011-04-29 00:36:42 +0200655 }
656};
657
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700658/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300659 * omap_device_register - register an omap_device with one omap_hwmod
660 * @od: struct omap_device * to register
661 *
662 * Register the omap_device structure. This currently just calls
663 * platform_device_register() on the underlying platform_device.
664 * Returns the return value of platform_device_register().
665 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800666int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300667{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700668 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300669
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700670 pdev->dev.pm_domain = &omap_device_pm_domain;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700671 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300672}
673
674
675/* Public functions for use by device drivers through struct platform_data */
676
677/**
678 * omap_device_enable - fully activate an omap_device
679 * @od: struct omap_device * to activate
680 *
681 * Do whatever is necessary for the hwmods underlying omap_device @od
682 * to be accessible and ready to operate. This generally involves
683 * enabling clocks, setting SYSCONFIG registers; and in the future may
684 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700685 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
686 * the omap_device is already enabled, or passes along the return
687 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300688 */
689int omap_device_enable(struct platform_device *pdev)
690{
691 int ret;
692 struct omap_device *od;
693
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600694 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300695
696 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700697 dev_warn(&pdev->dev,
698 "omap_device: %s() called from invalid state %d\n",
699 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300700 return -EINVAL;
701 }
702
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700703 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300704
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300705 od->_state = OMAP_DEVICE_STATE_ENABLED;
706
707 return ret;
708}
709
710/**
711 * omap_device_idle - idle an omap_device
712 * @od: struct omap_device * to idle
713 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700714 * Idle omap_device @od. Device drivers call this function indirectly
715 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300716 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700717 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300718 */
719int omap_device_idle(struct platform_device *pdev)
720{
721 int ret;
722 struct omap_device *od;
723
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600724 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300725
726 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700727 dev_warn(&pdev->dev,
728 "omap_device: %s() called from invalid state %d\n",
729 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300730 return -EINVAL;
731 }
732
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700733 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300734
735 od->_state = OMAP_DEVICE_STATE_IDLE;
736
737 return ret;
738}
739
740/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600741 * omap_device_assert_hardreset - set a device's hardreset line
742 * @pdev: struct platform_device * to reset
743 * @name: const char * name of the reset line
744 *
745 * Set the hardreset line identified by @name on the IP blocks
746 * associated with the hwmods backing the platform_device @pdev. All
747 * of the hwmods associated with @pdev must have the same hardreset
748 * line linked to them for this to work. Passes along the return value
749 * of omap_hwmod_assert_hardreset() in the event of any failure, or
750 * returns 0 upon success.
751 */
752int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
753{
754 struct omap_device *od = to_omap_device(pdev);
755 int ret = 0;
756 int i;
757
758 for (i = 0; i < od->hwmods_cnt; i++) {
759 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
760 if (ret)
761 break;
762 }
763
764 return ret;
765}
766
767/**
768 * omap_device_deassert_hardreset - release a device's hardreset line
769 * @pdev: struct platform_device * to reset
770 * @name: const char * name of the reset line
771 *
772 * Release the hardreset line identified by @name on the IP blocks
773 * associated with the hwmods backing the platform_device @pdev. All
774 * of the hwmods associated with @pdev must have the same hardreset
775 * line linked to them for this to work. Passes along the return
776 * value of omap_hwmod_deassert_hardreset() in the event of any
777 * failure, or returns 0 upon success.
778 */
779int omap_device_deassert_hardreset(struct platform_device *pdev,
780 const char *name)
781{
782 struct omap_device *od = to_omap_device(pdev);
783 int ret = 0;
784 int i;
785
786 for (i = 0; i < od->hwmods_cnt; i++) {
787 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
788 if (ret)
789 break;
790 }
791
792 return ret;
793}
794
795/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500796 * omap_device_get_by_hwmod_name() - convert a hwmod name to
797 * device pointer.
798 * @oh_name: name of the hwmod device
799 *
800 * Returns back a struct device * pointer associated with a hwmod
801 * device represented by a hwmod_name
802 */
803struct device *omap_device_get_by_hwmod_name(const char *oh_name)
804{
805 struct omap_hwmod *oh;
806
807 if (!oh_name) {
808 WARN(1, "%s: no hwmod name!\n", __func__);
809 return ERR_PTR(-EINVAL);
810 }
811
812 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000813 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500814 WARN(1, "%s: no hwmod for %s\n", __func__,
815 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000816 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500817 }
Russell King857835c2013-02-24 10:56:59 +0000818 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500819 WARN(1, "%s: no omap_device 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 }
823
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500824 return &oh->od->pdev->dev;
825}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700826
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200827static struct notifier_block platform_nb = {
828 .notifier_call = _omap_device_notifier_call,
829};
830
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700831static int __init omap_device_init(void)
832{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200833 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800834 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700835}
Tony Lindgrenb76c8b12013-01-11 11:24:18 -0800836omap_core_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700837
838/**
839 * omap_device_late_idle - idle devices without drivers
840 * @dev: struct device * associated with omap_device
841 * @data: unused
842 *
843 * Check the driver bound status of this device, and idle it
844 * if there is no driver attached.
845 */
846static int __init omap_device_late_idle(struct device *dev, void *data)
847{
848 struct platform_device *pdev = to_platform_device(dev);
849 struct omap_device *od = to_omap_device(pdev);
850
851 if (!od)
852 return 0;
853
854 /*
855 * If omap_device state is enabled, but has no driver bound,
856 * idle it.
857 */
858 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
859 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
860 dev_warn(dev, "%s: enabled but no driver. Idling\n",
861 __func__);
862 omap_device_idle(pdev);
863 }
864 }
865
866 return 0;
867}
868
869static int __init omap_device_late_init(void)
870{
871 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
872 return 0;
873}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700874omap_late_initcall_sync(omap_device_late_init);