blob: 828f538b1c4e7f75f5cd1525e671f5520c8b5403 [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)) {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070059 dev_warn(&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:
187 return ret;
188}
189
190static int _omap_device_notifier_call(struct notifier_block *nb,
191 unsigned long event, void *dev)
192{
193 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700194 struct omap_device *od;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200195
196 switch (event) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200197 case BUS_NOTIFY_DEL_DEVICE:
198 if (pdev->archdata.od)
199 omap_device_delete(pdev->archdata.od);
200 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700201 case BUS_NOTIFY_ADD_DEVICE:
202 if (pdev->dev.of_node)
203 omap_device_build_from_dt(pdev);
Tony Lindgrendad12d12013-12-06 10:52:58 -0800204 omap_auxdata_legacy_init(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700205 /* fall through */
206 default:
207 od = to_omap_device(pdev);
208 if (od)
209 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200210 }
211
212 return NOTIFY_DONE;
213}
214
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700215/**
216 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
217 * @od: struct omap_device *od
218 *
219 * Enable all underlying hwmods. Returns 0.
220 */
221static int _omap_device_enable_hwmods(struct omap_device *od)
222{
223 int i;
224
225 for (i = 0; i < od->hwmods_cnt; i++)
226 omap_hwmod_enable(od->hwmods[i]);
227
228 /* XXX pass along return value here? */
229 return 0;
230}
231
232/**
233 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
234 * @od: struct omap_device *od
235 *
236 * Idle all underlying hwmods. Returns 0.
237 */
238static int _omap_device_idle_hwmods(struct omap_device *od)
239{
240 int i;
241
242 for (i = 0; i < od->hwmods_cnt; i++)
243 omap_hwmod_idle(od->hwmods[i]);
244
245 /* XXX pass along return value here? */
246 return 0;
247}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200248
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300249/* Public functions for use by core code */
250
251/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700252 * omap_device_get_context_loss_count - get lost context count
253 * @od: struct omap_device *
254 *
255 * Using the primary hwmod, query the context loss count for this
256 * device.
257 *
258 * Callers should consider context for this device lost any time this
259 * function returns a value different than the value the caller got
260 * the last time it called this function.
261 *
262 * If any hwmods exist for the omap_device assoiated with @pdev,
263 * return the context loss counter for that hwmod, otherwise return
264 * zero.
265 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300266int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700267{
268 struct omap_device *od;
269 u32 ret = 0;
270
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600271 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700272
273 if (od->hwmods_cnt)
274 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
275
276 return ret;
277}
278
279/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300280 * omap_device_count_resources - count number of struct resource entries needed
281 * @od: struct omap_device *
Peter Ujfalusidad41912012-11-21 16:15:17 -0700282 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300283 *
284 * Count the number of struct resource entries needed for this
285 * omap_device @od. Used by omap_device_build_ss() to determine how
286 * much memory to allocate before calling
287 * omap_device_fill_resources(). Returns the count.
288 */
Peter Ujfalusidad41912012-11-21 16:15:17 -0700289static int omap_device_count_resources(struct omap_device *od,
290 unsigned long flags)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300291{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300292 int c = 0;
293 int i;
294
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600295 for (i = 0; i < od->hwmods_cnt; i++)
Peter Ujfalusidad41912012-11-21 16:15:17 -0700296 c += omap_hwmod_count_resources(od->hwmods[i], flags);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300297
Paul Walmsley7852ec02012-07-26 00:54:26 -0600298 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
299 od->pdev->name, c, od->hwmods_cnt);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300300
301 return c;
302}
303
304/**
305 * omap_device_fill_resources - fill in array of struct resource
306 * @od: struct omap_device *
307 * @res: pointer to an array of struct resource to be filled in
308 *
309 * Populate one or more empty struct resource pointed to by @res with
310 * the resource data for this omap_device @od. Used by
311 * omap_device_build_ss() after calling omap_device_count_resources().
312 * Ideally this function would not be needed at all. If omap_device
313 * replaces platform_device, then we can specify our own
314 * get_resource()/ get_irq()/etc functions that use the underlying
315 * omap_hwmod information. Or if platform_device is extended to use
316 * subarchitecture-specific function pointers, the various
317 * platform_device functions can simply call omap_device internal
318 * functions to get device resources. Hacking around the existing
319 * platform_device code wastes memory. Returns 0.
320 */
Kevin Hilmana2a28ad2011-07-21 14:14:35 -0700321static int omap_device_fill_resources(struct omap_device *od,
322 struct resource *res)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300323{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300324 int i, r;
325
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600326 for (i = 0; i < od->hwmods_cnt; i++) {
327 r = omap_hwmod_fill_resources(od->hwmods[i], res);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300328 res += r;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300329 }
330
331 return 0;
332}
333
334/**
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530335 * _od_fill_dma_resources - fill in array of struct resource with dma resources
336 * @od: struct omap_device *
337 * @res: pointer to an array of struct resource to be filled in
338 *
339 * Populate one or more empty struct resource pointed to by @res with
340 * the dma resource data for this omap_device @od. Used by
341 * omap_device_alloc() after calling omap_device_count_resources().
342 *
343 * Ideally this function would not be needed at all. If we have
344 * mechanism to get dma resources from DT.
345 *
346 * Returns 0.
347 */
348static int _od_fill_dma_resources(struct omap_device *od,
349 struct resource *res)
350{
351 int i, r;
352
353 for (i = 0; i < od->hwmods_cnt; i++) {
354 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
355 res += r;
356 }
357
358 return 0;
359}
360
361/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200362 * omap_device_alloc - allocate an omap_device
363 * @pdev: platform_device that will be included in this omap_device
364 * @oh: ptr to the single omap_hwmod that backs this omap_device
365 * @pdata: platform_data ptr to associate with the platform_device
366 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200367 *
368 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700369 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200370 *
371 * Returns an struct omap_device pointer or ERR_PTR() on error;
372 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800373struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700374 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200375{
376 int ret = -ENOMEM;
377 struct omap_device *od;
378 struct resource *res = NULL;
379 int i, res_count;
380 struct omap_hwmod **hwmods;
381
382 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
383 if (!od) {
384 ret = -ENOMEM;
385 goto oda_exit1;
386 }
387 od->hwmods_cnt = oh_cnt;
388
389 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
390 if (!hwmods)
391 goto oda_exit2;
392
393 od->hwmods = hwmods;
394 od->pdev = pdev;
395
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530396 /*
Peter Ujfalusic567b052012-11-21 16:15:18 -0700397 * Non-DT Boot:
398 * Here, pdev->num_resources = 0, and we should get all the
399 * resources from hwmod.
400 *
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530401 * DT Boot:
402 * OF framework will construct the resource structure (currently
403 * does for MEM & IRQ resource) and we should respect/use these
404 * resources, killing hwmod dependency.
405 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
406 * have been allocated by OF layer already (through DTB).
Peter Ujfalusic567b052012-11-21 16:15:18 -0700407 * As preparation for the future we examine the OF provided resources
408 * to see if we have DMA resources provided already. In this case
409 * there is no need to update the resources for the device, we use the
410 * OF provided ones.
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530411 *
412 * TODO: Once DMA resource is available from OF layer, we should
413 * kill filling any resources from hwmod.
414 */
Peter Ujfalusic567b052012-11-21 16:15:18 -0700415 if (!pdev->num_resources) {
416 /* Count all resources for the device */
417 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
418 IORESOURCE_DMA |
419 IORESOURCE_MEM);
420 } else {
421 /* Take a look if we already have DMA resource via DT */
422 for (i = 0; i < pdev->num_resources; i++) {
423 struct resource *r = &pdev->resource[i];
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200424
Peter Ujfalusic567b052012-11-21 16:15:18 -0700425 /* We have it, no need to touch the resources */
426 if (r->flags == IORESOURCE_DMA)
427 goto have_everything;
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530428 }
Peter Ujfalusic567b052012-11-21 16:15:18 -0700429 /* Count only DMA resources for the device */
430 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
431 /* The device has no DMA resource, no need for update */
432 if (!res_count)
433 goto have_everything;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200434
Peter Ujfalusic567b052012-11-21 16:15:18 -0700435 res_count += pdev->num_resources;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200436 }
437
Peter Ujfalusic567b052012-11-21 16:15:18 -0700438 /* Allocate resources memory to account for new resources */
439 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
440 if (!res)
441 goto oda_exit3;
442
443 if (!pdev->num_resources) {
444 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
445 __func__, res_count);
446 omap_device_fill_resources(od, res);
447 } else {
448 dev_dbg(&pdev->dev,
449 "%s: appending %d DMA resources from hwmod\n",
450 __func__, res_count - pdev->num_resources);
451 memcpy(res, pdev->resource,
452 sizeof(struct resource) * pdev->num_resources);
453 _od_fill_dma_resources(od, &res[pdev->num_resources]);
454 }
455
456 ret = platform_device_add_resources(pdev, res, res_count);
457 kfree(res);
458
459 if (ret)
460 goto oda_exit3;
461
462have_everything:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200463 pdev->archdata.od = od;
464
465 for (i = 0; i < oh_cnt; i++) {
466 hwmods[i]->od = od;
467 _add_hwmod_clocks_clkdev(od, hwmods[i]);
468 }
469
470 return od;
471
472oda_exit3:
473 kfree(hwmods);
474oda_exit2:
475 kfree(od);
476oda_exit1:
477 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
478
479 return ERR_PTR(ret);
480}
481
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800482void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200483{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200484 if (!od)
485 return;
486
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200487 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200488 kfree(od->hwmods);
489 kfree(od);
490}
491
492/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300493 * omap_device_build - build and register an omap_device with one omap_hwmod
494 * @pdev_name: name of the platform_device driver to use
495 * @pdev_id: this platform_device's connection ID
496 * @oh: ptr to the single omap_hwmod that backs this omap_device
497 * @pdata: platform_data ptr to associate with the platform_device
498 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300499 *
500 * Convenience function for building and registering a single
501 * omap_device record, which in turn builds and registers a
502 * platform_device record. See omap_device_build_ss() for more
503 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
504 * passes along the return value of omap_device_build_ss().
505 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700506struct platform_device __init *omap_device_build(const char *pdev_name,
507 int pdev_id,
508 struct omap_hwmod *oh,
509 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300510{
511 struct omap_hwmod *ohs[] = { oh };
512
513 if (!oh)
514 return ERR_PTR(-EINVAL);
515
516 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700517 pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300518}
519
520/**
521 * omap_device_build_ss - build and register an omap_device with multiple hwmods
522 * @pdev_name: name of the platform_device driver to use
523 * @pdev_id: this platform_device's connection ID
524 * @oh: ptr to the single omap_hwmod that backs this omap_device
525 * @pdata: platform_data ptr to associate with the platform_device
526 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300527 *
528 * Convenience function for building and registering an omap_device
529 * subsystem record. Subsystem records consist of multiple
530 * omap_hwmods. This function in turn builds and registers a
531 * platform_device record. Returns an ERR_PTR() on error, or passes
532 * along the return value of omap_device_register().
533 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700534struct platform_device __init *omap_device_build_ss(const char *pdev_name,
535 int pdev_id,
536 struct omap_hwmod **ohs,
537 int oh_cnt, void *pdata,
538 int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300539{
540 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700541 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300542 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300543
544 if (!ohs || oh_cnt == 0 || !pdev_name)
545 return ERR_PTR(-EINVAL);
546
547 if (!pdata && pdata_len > 0)
548 return ERR_PTR(-EINVAL);
549
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700550 pdev = platform_device_alloc(pdev_name, pdev_id);
551 if (!pdev) {
552 ret = -ENOMEM;
553 goto odbs_exit;
554 }
555
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200556 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
557 if (pdev->id != -1)
558 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
559 else
560 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300561
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700562 od = omap_device_alloc(pdev, ohs, oh_cnt);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800563 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700564 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300565
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700566 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000567 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200568 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700569
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700570 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700571 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200572 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600573
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700574 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300575
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700576odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200577 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700578odbs_exit1:
579 platform_device_put(pdev);
580odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300581
582 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
583
584 return ERR_PTR(ret);
585}
586
Kevin Hilman256a5432011-07-12 22:48:03 +0200587#ifdef CONFIG_PM_RUNTIME
Kevin Hilman638080c2011-04-29 00:36:42 +0200588static int _od_runtime_suspend(struct device *dev)
589{
590 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700591 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200592
Kevin Hilman345f79b2011-05-31 16:08:09 -0700593 ret = pm_generic_runtime_suspend(dev);
594
595 if (!ret)
596 omap_device_idle(pdev);
597
598 return ret;
599}
600
Kevin Hilman638080c2011-04-29 00:36:42 +0200601static int _od_runtime_resume(struct device *dev)
602{
603 struct platform_device *pdev = to_platform_device(dev);
604
Kevin Hilman345f79b2011-05-31 16:08:09 -0700605 omap_device_enable(pdev);
606
607 return pm_generic_runtime_resume(dev);
Kevin Hilman638080c2011-04-29 00:36:42 +0200608}
Kevin Hilman256a5432011-07-12 22:48:03 +0200609#endif
Kevin Hilman638080c2011-04-29 00:36:42 +0200610
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200611#ifdef CONFIG_SUSPEND
612static int _od_suspend_noirq(struct device *dev)
613{
614 struct platform_device *pdev = to_platform_device(dev);
615 struct omap_device *od = to_omap_device(pdev);
616 int ret;
617
Kevin Hilman72bb6f92012-07-10 15:29:04 -0700618 /* Don't attempt late suspend on a driver that is not bound */
619 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
620 return 0;
621
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200622 ret = pm_generic_suspend_noirq(dev);
623
624 if (!ret && !pm_runtime_status_suspended(dev)) {
625 if (pm_generic_runtime_suspend(dev) == 0) {
Nishanth Menon3522bf72013-11-14 11:05:16 -0600626 pm_runtime_set_suspended(dev);
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530627 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200628 od->flags |= OMAP_DEVICE_SUSPENDED;
629 }
630 }
631
632 return ret;
633}
634
635static int _od_resume_noirq(struct device *dev)
636{
637 struct platform_device *pdev = to_platform_device(dev);
638 struct omap_device *od = to_omap_device(pdev);
639
Nishanth Menon3522bf72013-11-14 11:05:16 -0600640 if (od->flags & OMAP_DEVICE_SUSPENDED) {
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200641 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530642 omap_device_enable(pdev);
Nishanth Menon3522bf72013-11-14 11:05:16 -0600643 /*
644 * XXX: we run before core runtime pm has resumed itself. At
645 * this point in time, we just restore the runtime pm state and
646 * considering symmetric operations in resume, we donot expect
647 * to fail. If we failed, something changed in core runtime_pm
648 * framework OR some device driver messed things up, hence, WARN
649 */
650 WARN(pm_runtime_set_active(dev),
651 "Could not set %s runtime state active\n", dev_name(dev));
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200652 pm_generic_runtime_resume(dev);
653 }
654
655 return pm_generic_resume_noirq(dev);
656}
Kevin Hilman126caf12011-09-01 10:59:36 -0700657#else
658#define _od_suspend_noirq NULL
659#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200660#endif
661
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800662struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200663 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200664 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200665 NULL)
Kevin Hilman638080c2011-04-29 00:36:42 +0200666 USE_PLATFORM_PM_SLEEP_OPS
Kevin Hilmanff353362011-08-25 15:31:14 +0200667 .suspend_noirq = _od_suspend_noirq,
668 .resume_noirq = _od_resume_noirq,
Kevin Hilman638080c2011-04-29 00:36:42 +0200669 }
670};
671
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700672/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300673 * omap_device_register - register an omap_device with one omap_hwmod
674 * @od: struct omap_device * to register
675 *
676 * Register the omap_device structure. This currently just calls
677 * platform_device_register() on the underlying platform_device.
678 * Returns the return value of platform_device_register().
679 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800680int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300681{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700682 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300683
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700684 pdev->dev.pm_domain = &omap_device_pm_domain;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700685 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300686}
687
688
689/* Public functions for use by device drivers through struct platform_data */
690
691/**
692 * omap_device_enable - fully activate an omap_device
693 * @od: struct omap_device * to activate
694 *
695 * Do whatever is necessary for the hwmods underlying omap_device @od
696 * to be accessible and ready to operate. This generally involves
697 * enabling clocks, setting SYSCONFIG registers; and in the future may
698 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700699 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
700 * the omap_device is already enabled, or passes along the return
701 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300702 */
703int omap_device_enable(struct platform_device *pdev)
704{
705 int ret;
706 struct omap_device *od;
707
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600708 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300709
710 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700711 dev_warn(&pdev->dev,
712 "omap_device: %s() called from invalid state %d\n",
713 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300714 return -EINVAL;
715 }
716
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700717 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300718
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300719 od->_state = OMAP_DEVICE_STATE_ENABLED;
720
721 return ret;
722}
723
724/**
725 * omap_device_idle - idle an omap_device
726 * @od: struct omap_device * to idle
727 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700728 * Idle omap_device @od. Device drivers call this function indirectly
729 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300730 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700731 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300732 */
733int omap_device_idle(struct platform_device *pdev)
734{
735 int ret;
736 struct omap_device *od;
737
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600738 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300739
740 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700741 dev_warn(&pdev->dev,
742 "omap_device: %s() called from invalid state %d\n",
743 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300744 return -EINVAL;
745 }
746
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700747 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300748
749 od->_state = OMAP_DEVICE_STATE_IDLE;
750
751 return ret;
752}
753
754/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600755 * omap_device_assert_hardreset - set a device's hardreset line
756 * @pdev: struct platform_device * to reset
757 * @name: const char * name of the reset line
758 *
759 * Set the hardreset line identified by @name on the IP blocks
760 * associated with the hwmods backing the platform_device @pdev. All
761 * of the hwmods associated with @pdev must have the same hardreset
762 * line linked to them for this to work. Passes along the return value
763 * of omap_hwmod_assert_hardreset() in the event of any failure, or
764 * returns 0 upon success.
765 */
766int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
767{
768 struct omap_device *od = to_omap_device(pdev);
769 int ret = 0;
770 int i;
771
772 for (i = 0; i < od->hwmods_cnt; i++) {
773 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
774 if (ret)
775 break;
776 }
777
778 return ret;
779}
780
781/**
782 * omap_device_deassert_hardreset - release a device's hardreset line
783 * @pdev: struct platform_device * to reset
784 * @name: const char * name of the reset line
785 *
786 * Release the hardreset line identified by @name on the IP blocks
787 * associated with the hwmods backing the platform_device @pdev. All
788 * of the hwmods associated with @pdev must have the same hardreset
789 * line linked to them for this to work. Passes along the return
790 * value of omap_hwmod_deassert_hardreset() in the event of any
791 * failure, or returns 0 upon success.
792 */
793int omap_device_deassert_hardreset(struct platform_device *pdev,
794 const char *name)
795{
796 struct omap_device *od = to_omap_device(pdev);
797 int ret = 0;
798 int i;
799
800 for (i = 0; i < od->hwmods_cnt; i++) {
801 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
802 if (ret)
803 break;
804 }
805
806 return ret;
807}
808
809/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500810 * omap_device_get_by_hwmod_name() - convert a hwmod name to
811 * device pointer.
812 * @oh_name: name of the hwmod device
813 *
814 * Returns back a struct device * pointer associated with a hwmod
815 * device represented by a hwmod_name
816 */
817struct device *omap_device_get_by_hwmod_name(const char *oh_name)
818{
819 struct omap_hwmod *oh;
820
821 if (!oh_name) {
822 WARN(1, "%s: no hwmod name!\n", __func__);
823 return ERR_PTR(-EINVAL);
824 }
825
826 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000827 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500828 WARN(1, "%s: no hwmod for %s\n", __func__,
829 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000830 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500831 }
Russell King857835c2013-02-24 10:56:59 +0000832 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500833 WARN(1, "%s: no omap_device for %s\n", __func__,
834 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000835 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500836 }
837
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500838 return &oh->od->pdev->dev;
839}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700840
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200841static struct notifier_block platform_nb = {
842 .notifier_call = _omap_device_notifier_call,
843};
844
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700845static int __init omap_device_init(void)
846{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200847 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800848 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700849}
Tony Lindgrenb76c8b12013-01-11 11:24:18 -0800850omap_core_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700851
852/**
853 * omap_device_late_idle - idle devices without drivers
854 * @dev: struct device * associated with omap_device
855 * @data: unused
856 *
857 * Check the driver bound status of this device, and idle it
858 * if there is no driver attached.
859 */
860static int __init omap_device_late_idle(struct device *dev, void *data)
861{
862 struct platform_device *pdev = to_platform_device(dev);
863 struct omap_device *od = to_omap_device(pdev);
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600864 int i;
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700865
866 if (!od)
867 return 0;
868
869 /*
870 * If omap_device state is enabled, but has no driver bound,
871 * idle it.
872 */
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600873
874 /*
875 * Some devices (like memory controllers) are always kept
876 * enabled, and should not be idled even with no drivers.
877 */
878 for (i = 0; i < od->hwmods_cnt; i++)
879 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
880 return 0;
881
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700882 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
883 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
884 dev_warn(dev, "%s: enabled but no driver. Idling\n",
885 __func__);
886 omap_device_idle(pdev);
887 }
888 }
889
890 return 0;
891}
892
893static int __init omap_device_late_init(void)
894{
895 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
896 return 0;
897}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700898omap_late_initcall_sync(omap_device_late_init);