blob: f99f68e1e85bd3748c5965a0bd27c47d0f6d538e [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;
Rajendra Nayak72680322013-07-28 23:01:51 -0600132 bool device_active = false;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200133
134 oh_cnt = of_property_count_strings(node, "ti,hwmods");
Russell Kingc48cd652013-03-13 20:44:21 +0000135 if (oh_cnt <= 0) {
Benoit Cousson5dc06b72012-01-20 18:14:00 +0100136 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200137 return -ENODEV;
138 }
139
140 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
141 if (!hwmods) {
142 ret = -ENOMEM;
143 goto odbfd_exit;
144 }
145
146 for (i = 0; i < oh_cnt; i++) {
147 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
148 oh = omap_hwmod_lookup(oh_name);
149 if (!oh) {
150 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
151 oh_name);
152 ret = -EINVAL;
153 goto odbfd_exit1;
154 }
155 hwmods[i] = oh;
Rajendra Nayak72680322013-07-28 23:01:51 -0600156 if (oh->flags & HWMOD_INIT_NO_IDLE)
157 device_active = true;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200158 }
159
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700160 od = omap_device_alloc(pdev, hwmods, oh_cnt);
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200161 if (!od) {
162 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
163 oh_name);
164 ret = PTR_ERR(od);
165 goto odbfd_exit1;
166 }
167
Peter Ujfalusi3956a1a2012-08-23 16:54:09 +0300168 /* Fix up missing resource names */
169 for (i = 0; i < pdev->num_resources; i++) {
170 struct resource *r = &pdev->resource[i];
171
172 if (r->name == NULL)
173 r->name = dev_name(&pdev->dev);
174 }
175
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200176 pdev->dev.pm_domain = &omap_device_pm_domain;
177
Rajendra Nayak72680322013-07-28 23:01:51 -0600178 if (device_active) {
179 omap_device_enable(pdev);
180 pm_runtime_set_active(&pdev->dev);
181 }
182
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200183odbfd_exit1:
184 kfree(hwmods);
185odbfd_exit:
186 return ret;
187}
188
189static int _omap_device_notifier_call(struct notifier_block *nb,
190 unsigned long event, void *dev)
191{
192 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilmane7533452012-07-10 11:13:16 -0700193 struct omap_device *od;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200194
195 switch (event) {
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200196 case BUS_NOTIFY_DEL_DEVICE:
197 if (pdev->archdata.od)
198 omap_device_delete(pdev->archdata.od);
199 break;
Kevin Hilmane7533452012-07-10 11:13:16 -0700200 case BUS_NOTIFY_ADD_DEVICE:
201 if (pdev->dev.of_node)
202 omap_device_build_from_dt(pdev);
203 /* fall through */
204 default:
205 od = to_omap_device(pdev);
206 if (od)
207 od->_driver_status = event;
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200208 }
209
210 return NOTIFY_DONE;
211}
212
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700213/**
214 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
215 * @od: struct omap_device *od
216 *
217 * Enable all underlying hwmods. Returns 0.
218 */
219static int _omap_device_enable_hwmods(struct omap_device *od)
220{
221 int i;
222
223 for (i = 0; i < od->hwmods_cnt; i++)
224 omap_hwmod_enable(od->hwmods[i]);
225
226 /* XXX pass along return value here? */
227 return 0;
228}
229
230/**
231 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
232 * @od: struct omap_device *od
233 *
234 * Idle all underlying hwmods. Returns 0.
235 */
236static int _omap_device_idle_hwmods(struct omap_device *od)
237{
238 int i;
239
240 for (i = 0; i < od->hwmods_cnt; i++)
241 omap_hwmod_idle(od->hwmods[i]);
242
243 /* XXX pass along return value here? */
244 return 0;
245}
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200246
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300247/* Public functions for use by core code */
248
249/**
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700250 * omap_device_get_context_loss_count - get lost context count
251 * @od: struct omap_device *
252 *
253 * Using the primary hwmod, query the context loss count for this
254 * device.
255 *
256 * Callers should consider context for this device lost any time this
257 * function returns a value different than the value the caller got
258 * the last time it called this function.
259 *
260 * If any hwmods exist for the omap_device assoiated with @pdev,
261 * return the context loss counter for that hwmod, otherwise return
262 * zero.
263 */
Tomi Valkeinenfc013872011-06-09 16:56:23 +0300264int omap_device_get_context_loss_count(struct platform_device *pdev)
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700265{
266 struct omap_device *od;
267 u32 ret = 0;
268
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600269 od = to_omap_device(pdev);
Kevin Hilmanc80705a2010-12-21 21:31:55 -0700270
271 if (od->hwmods_cnt)
272 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
273
274 return ret;
275}
276
277/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300278 * omap_device_count_resources - count number of struct resource entries needed
279 * @od: struct omap_device *
Peter Ujfalusidad41912012-11-21 16:15:17 -0700280 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300281 *
282 * Count the number of struct resource entries needed for this
283 * omap_device @od. Used by omap_device_build_ss() to determine how
284 * much memory to allocate before calling
285 * omap_device_fill_resources(). Returns the count.
286 */
Peter Ujfalusidad41912012-11-21 16:15:17 -0700287static int omap_device_count_resources(struct omap_device *od,
288 unsigned long flags)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300289{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300290 int c = 0;
291 int i;
292
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600293 for (i = 0; i < od->hwmods_cnt; i++)
Peter Ujfalusidad41912012-11-21 16:15:17 -0700294 c += omap_hwmod_count_resources(od->hwmods[i], flags);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300295
Paul Walmsley7852ec02012-07-26 00:54:26 -0600296 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
297 od->pdev->name, c, od->hwmods_cnt);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300298
299 return c;
300}
301
302/**
303 * omap_device_fill_resources - fill in array of struct resource
304 * @od: struct omap_device *
305 * @res: pointer to an array of struct resource to be filled in
306 *
307 * Populate one or more empty struct resource pointed to by @res with
308 * the resource data for this omap_device @od. Used by
309 * omap_device_build_ss() after calling omap_device_count_resources().
310 * Ideally this function would not be needed at all. If omap_device
311 * replaces platform_device, then we can specify our own
312 * get_resource()/ get_irq()/etc functions that use the underlying
313 * omap_hwmod information. Or if platform_device is extended to use
314 * subarchitecture-specific function pointers, the various
315 * platform_device functions can simply call omap_device internal
316 * functions to get device resources. Hacking around the existing
317 * platform_device code wastes memory. Returns 0.
318 */
Kevin Hilmana2a28ad2011-07-21 14:14:35 -0700319static int omap_device_fill_resources(struct omap_device *od,
320 struct resource *res)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300321{
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300322 int i, r;
323
Kishon Vijay Abraham If39f4892010-09-24 10:23:18 -0600324 for (i = 0; i < od->hwmods_cnt; i++) {
325 r = omap_hwmod_fill_resources(od->hwmods[i], res);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300326 res += r;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300327 }
328
329 return 0;
330}
331
332/**
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530333 * _od_fill_dma_resources - fill in array of struct resource with dma resources
334 * @od: struct omap_device *
335 * @res: pointer to an array of struct resource to be filled in
336 *
337 * Populate one or more empty struct resource pointed to by @res with
338 * the dma resource data for this omap_device @od. Used by
339 * omap_device_alloc() after calling omap_device_count_resources().
340 *
341 * Ideally this function would not be needed at all. If we have
342 * mechanism to get dma resources from DT.
343 *
344 * Returns 0.
345 */
346static int _od_fill_dma_resources(struct omap_device *od,
347 struct resource *res)
348{
349 int i, r;
350
351 for (i = 0; i < od->hwmods_cnt; i++) {
352 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
353 res += r;
354 }
355
356 return 0;
357}
358
359/**
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200360 * omap_device_alloc - allocate an omap_device
361 * @pdev: platform_device that will be included in this omap_device
362 * @oh: ptr to the single omap_hwmod that backs this omap_device
363 * @pdata: platform_data ptr to associate with the platform_device
364 * @pdata_len: amount of memory pointed to by @pdata
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200365 *
366 * Convenience function for allocating an omap_device structure and filling
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700367 * hwmods, and resources.
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200368 *
369 * Returns an struct omap_device pointer or ERR_PTR() on error;
370 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800371struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700372 struct omap_hwmod **ohs, int oh_cnt)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200373{
374 int ret = -ENOMEM;
375 struct omap_device *od;
376 struct resource *res = NULL;
377 int i, res_count;
378 struct omap_hwmod **hwmods;
379
380 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
381 if (!od) {
382 ret = -ENOMEM;
383 goto oda_exit1;
384 }
385 od->hwmods_cnt = oh_cnt;
386
387 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
388 if (!hwmods)
389 goto oda_exit2;
390
391 od->hwmods = hwmods;
392 od->pdev = pdev;
393
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530394 /*
Peter Ujfalusic567b052012-11-21 16:15:18 -0700395 * Non-DT Boot:
396 * Here, pdev->num_resources = 0, and we should get all the
397 * resources from hwmod.
398 *
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530399 * DT Boot:
400 * OF framework will construct the resource structure (currently
401 * does for MEM & IRQ resource) and we should respect/use these
402 * resources, killing hwmod dependency.
403 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
404 * have been allocated by OF layer already (through DTB).
Peter Ujfalusic567b052012-11-21 16:15:18 -0700405 * As preparation for the future we examine the OF provided resources
406 * to see if we have DMA resources provided already. In this case
407 * there is no need to update the resources for the device, we use the
408 * OF provided ones.
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530409 *
410 * TODO: Once DMA resource is available from OF layer, we should
411 * kill filling any resources from hwmod.
412 */
Peter Ujfalusic567b052012-11-21 16:15:18 -0700413 if (!pdev->num_resources) {
414 /* Count all resources for the device */
415 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
416 IORESOURCE_DMA |
417 IORESOURCE_MEM);
418 } else {
419 /* Take a look if we already have DMA resource via DT */
420 for (i = 0; i < pdev->num_resources; i++) {
421 struct resource *r = &pdev->resource[i];
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200422
Peter Ujfalusic567b052012-11-21 16:15:18 -0700423 /* We have it, no need to touch the resources */
424 if (r->flags == IORESOURCE_DMA)
425 goto have_everything;
Vaibhav Hiremathb82b04e2012-08-29 15:18:11 +0530426 }
Peter Ujfalusic567b052012-11-21 16:15:18 -0700427 /* Count only DMA resources for the device */
428 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
429 /* The device has no DMA resource, no need for update */
430 if (!res_count)
431 goto have_everything;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200432
Peter Ujfalusic567b052012-11-21 16:15:18 -0700433 res_count += pdev->num_resources;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200434 }
435
Peter Ujfalusic567b052012-11-21 16:15:18 -0700436 /* Allocate resources memory to account for new resources */
437 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
438 if (!res)
439 goto oda_exit3;
440
441 if (!pdev->num_resources) {
442 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
443 __func__, res_count);
444 omap_device_fill_resources(od, res);
445 } else {
446 dev_dbg(&pdev->dev,
447 "%s: appending %d DMA resources from hwmod\n",
448 __func__, res_count - pdev->num_resources);
449 memcpy(res, pdev->resource,
450 sizeof(struct resource) * pdev->num_resources);
451 _od_fill_dma_resources(od, &res[pdev->num_resources]);
452 }
453
454 ret = platform_device_add_resources(pdev, res, res_count);
455 kfree(res);
456
457 if (ret)
458 goto oda_exit3;
459
460have_everything:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200461 pdev->archdata.od = od;
462
463 for (i = 0; i < oh_cnt; i++) {
464 hwmods[i]->od = od;
465 _add_hwmod_clocks_clkdev(od, hwmods[i]);
466 }
467
468 return od;
469
470oda_exit3:
471 kfree(hwmods);
472oda_exit2:
473 kfree(od);
474oda_exit1:
475 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
476
477 return ERR_PTR(ret);
478}
479
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800480void omap_device_delete(struct omap_device *od)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200481{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200482 if (!od)
483 return;
484
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200485 od->pdev->archdata.od = NULL;
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200486 kfree(od->hwmods);
487 kfree(od);
488}
489
490/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300491 * omap_device_build - build and register an omap_device with one omap_hwmod
492 * @pdev_name: name of the platform_device driver to use
493 * @pdev_id: this platform_device's connection ID
494 * @oh: ptr to the single omap_hwmod that backs this omap_device
495 * @pdata: platform_data ptr to associate with the platform_device
496 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300497 *
498 * Convenience function for building and registering a single
499 * omap_device record, which in turn builds and registers a
500 * platform_device record. See omap_device_build_ss() for more
501 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
502 * passes along the return value of omap_device_build_ss().
503 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700504struct platform_device __init *omap_device_build(const char *pdev_name,
505 int pdev_id,
506 struct omap_hwmod *oh,
507 void *pdata, int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300508{
509 struct omap_hwmod *ohs[] = { oh };
510
511 if (!oh)
512 return ERR_PTR(-EINVAL);
513
514 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700515 pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300516}
517
518/**
519 * omap_device_build_ss - build and register an omap_device with multiple hwmods
520 * @pdev_name: name of the platform_device driver to use
521 * @pdev_id: this platform_device's connection ID
522 * @oh: ptr to the single omap_hwmod that backs this omap_device
523 * @pdata: platform_data ptr to associate with the platform_device
524 * @pdata_len: amount of memory pointed to by @pdata
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300525 *
526 * Convenience function for building and registering an omap_device
527 * subsystem record. Subsystem records consist of multiple
528 * omap_hwmods. This function in turn builds and registers a
529 * platform_device record. Returns an ERR_PTR() on error, or passes
530 * along the return value of omap_device_register().
531 */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700532struct platform_device __init *omap_device_build_ss(const char *pdev_name,
533 int pdev_id,
534 struct omap_hwmod **ohs,
535 int oh_cnt, void *pdata,
536 int pdata_len)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300537{
538 int ret = -ENOMEM;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700539 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300540 struct omap_device *od;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300541
542 if (!ohs || oh_cnt == 0 || !pdev_name)
543 return ERR_PTR(-EINVAL);
544
545 if (!pdata && pdata_len > 0)
546 return ERR_PTR(-EINVAL);
547
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700548 pdev = platform_device_alloc(pdev_name, pdev_id);
549 if (!pdev) {
550 ret = -ENOMEM;
551 goto odbs_exit;
552 }
553
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200554 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
555 if (pdev->id != -1)
556 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
557 else
558 dev_set_name(&pdev->dev, "%s", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300559
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700560 od = omap_device_alloc(pdev, ohs, oh_cnt);
Wei Yongjuna87e6622012-09-21 14:32:04 +0800561 if (IS_ERR(od))
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700562 goto odbs_exit1;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300563
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700564 ret = platform_device_add_data(pdev, pdata, pdata_len);
Artem Bityutskiy49b368a2010-07-12 13:38:07 +0000565 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200566 goto odbs_exit2;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700567
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700568 ret = omap_device_register(pdev);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700569 if (ret)
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200570 goto odbs_exit2;
Kevin Hilman06563582010-07-26 16:34:30 -0600571
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700572 return pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300573
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700574odbs_exit2:
Benoit Coussona4f6cdb2011-08-09 16:47:01 +0200575 omap_device_delete(od);
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700576odbs_exit1:
577 platform_device_put(pdev);
578odbs_exit:
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300579
580 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
581
582 return ERR_PTR(ret);
583}
584
Kevin Hilman256a5432011-07-12 22:48:03 +0200585#ifdef CONFIG_PM_RUNTIME
Kevin Hilman638080c2011-04-29 00:36:42 +0200586static int _od_runtime_suspend(struct device *dev)
587{
588 struct platform_device *pdev = to_platform_device(dev);
Kevin Hilman345f79b2011-05-31 16:08:09 -0700589 int ret;
Kevin Hilman638080c2011-04-29 00:36:42 +0200590
Kevin Hilman345f79b2011-05-31 16:08:09 -0700591 ret = pm_generic_runtime_suspend(dev);
592
593 if (!ret)
594 omap_device_idle(pdev);
595
596 return ret;
597}
598
Kevin Hilman638080c2011-04-29 00:36:42 +0200599static 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) {
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530624 omap_device_idle(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200625 od->flags |= OMAP_DEVICE_SUSPENDED;
626 }
627 }
628
629 return ret;
630}
631
632static int _od_resume_noirq(struct device *dev)
633{
634 struct platform_device *pdev = to_platform_device(dev);
635 struct omap_device *od = to_omap_device(pdev);
636
637 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
638 !pm_runtime_status_suspended(dev)) {
639 od->flags &= ~OMAP_DEVICE_SUSPENDED;
Sourav Poddar4b7ec5a2013-04-27 01:55:34 +0530640 omap_device_enable(pdev);
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200641 pm_generic_runtime_resume(dev);
642 }
643
644 return pm_generic_resume_noirq(dev);
645}
Kevin Hilman126caf12011-09-01 10:59:36 -0700646#else
647#define _od_suspend_noirq NULL
648#define _od_resume_noirq NULL
Kevin Hilmanc03f0072011-07-12 22:48:19 +0200649#endif
650
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800651struct dev_pm_domain omap_device_pm_domain = {
Kevin Hilman638080c2011-04-29 00:36:42 +0200652 .ops = {
Kevin Hilman256a5432011-07-12 22:48:03 +0200653 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200654 NULL)
Kevin Hilman638080c2011-04-29 00:36:42 +0200655 USE_PLATFORM_PM_SLEEP_OPS
Kevin Hilmanff353362011-08-25 15:31:14 +0200656 .suspend_noirq = _od_suspend_noirq,
657 .resume_noirq = _od_resume_noirq,
Kevin Hilman638080c2011-04-29 00:36:42 +0200658 }
659};
660
Thara Gopinathc23a97d2010-02-24 12:05:58 -0700661/**
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300662 * omap_device_register - register an omap_device with one omap_hwmod
663 * @od: struct omap_device * to register
664 *
665 * Register the omap_device structure. This currently just calls
666 * platform_device_register() on the underlying platform_device.
667 * Returns the return value of platform_device_register().
668 */
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -0800669int omap_device_register(struct platform_device *pdev)
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300670{
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700671 pr_debug("omap_device: %s: registering\n", pdev->name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300672
Kevin Hilmanbfae4f82011-07-21 14:47:53 -0700673 pdev->dev.pm_domain = &omap_device_pm_domain;
Kevin Hilmand66b3fe2011-07-21 13:58:51 -0700674 return platform_device_add(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300675}
676
677
678/* Public functions for use by device drivers through struct platform_data */
679
680/**
681 * omap_device_enable - fully activate an omap_device
682 * @od: struct omap_device * to activate
683 *
684 * Do whatever is necessary for the hwmods underlying omap_device @od
685 * to be accessible and ready to operate. This generally involves
686 * enabling clocks, setting SYSCONFIG registers; and in the future may
687 * involve remuxing pins. Device drivers should call this function
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700688 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
689 * the omap_device is already enabled, or passes along the return
690 * value of _omap_device_enable_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300691 */
692int omap_device_enable(struct platform_device *pdev)
693{
694 int ret;
695 struct omap_device *od;
696
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600697 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300698
699 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700700 dev_warn(&pdev->dev,
701 "omap_device: %s() called from invalid state %d\n",
702 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300703 return -EINVAL;
704 }
705
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700706 ret = _omap_device_enable_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300707
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300708 od->_state = OMAP_DEVICE_STATE_ENABLED;
709
710 return ret;
711}
712
713/**
714 * omap_device_idle - idle an omap_device
715 * @od: struct omap_device * to idle
716 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700717 * Idle omap_device @od. Device drivers call this function indirectly
718 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300719 * currently enabled, or passes along the return value of
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700720 * _omap_device_idle_hwmods().
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300721 */
722int omap_device_idle(struct platform_device *pdev)
723{
724 int ret;
725 struct omap_device *od;
726
Kevin Hilman8f0d69d2011-07-09 19:15:20 -0600727 od = to_omap_device(pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300728
729 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
Kevin Hilman49882c92011-07-21 09:58:36 -0700730 dev_warn(&pdev->dev,
731 "omap_device: %s() called from invalid state %d\n",
732 __func__, od->_state);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300733 return -EINVAL;
734 }
735
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -0700736 ret = _omap_device_idle_hwmods(od);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +0300737
738 od->_state = OMAP_DEVICE_STATE_IDLE;
739
740 return ret;
741}
742
743/**
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -0600744 * omap_device_assert_hardreset - set a device's hardreset line
745 * @pdev: struct platform_device * to reset
746 * @name: const char * name of the reset line
747 *
748 * Set the hardreset line identified by @name on the IP blocks
749 * associated with the hwmods backing the platform_device @pdev. All
750 * of the hwmods associated with @pdev must have the same hardreset
751 * line linked to them for this to work. Passes along the return value
752 * of omap_hwmod_assert_hardreset() in the event of any failure, or
753 * returns 0 upon success.
754 */
755int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
756{
757 struct omap_device *od = to_omap_device(pdev);
758 int ret = 0;
759 int i;
760
761 for (i = 0; i < od->hwmods_cnt; i++) {
762 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
763 if (ret)
764 break;
765 }
766
767 return ret;
768}
769
770/**
771 * omap_device_deassert_hardreset - release a device's hardreset line
772 * @pdev: struct platform_device * to reset
773 * @name: const char * name of the reset line
774 *
775 * Release the hardreset line identified by @name on the IP blocks
776 * associated with the hwmods backing the platform_device @pdev. All
777 * of the hwmods associated with @pdev must have the same hardreset
778 * line linked to them for this to work. Passes along the return
779 * value of omap_hwmod_deassert_hardreset() in the event of any
780 * failure, or returns 0 upon success.
781 */
782int omap_device_deassert_hardreset(struct platform_device *pdev,
783 const char *name)
784{
785 struct omap_device *od = to_omap_device(pdev);
786 int ret = 0;
787 int i;
788
789 for (i = 0; i < od->hwmods_cnt; i++) {
790 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
791 if (ret)
792 break;
793 }
794
795 return ret;
796}
797
798/**
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500799 * omap_device_get_by_hwmod_name() - convert a hwmod name to
800 * device pointer.
801 * @oh_name: name of the hwmod device
802 *
803 * Returns back a struct device * pointer associated with a hwmod
804 * device represented by a hwmod_name
805 */
806struct device *omap_device_get_by_hwmod_name(const char *oh_name)
807{
808 struct omap_hwmod *oh;
809
810 if (!oh_name) {
811 WARN(1, "%s: no hwmod name!\n", __func__);
812 return ERR_PTR(-EINVAL);
813 }
814
815 oh = omap_hwmod_lookup(oh_name);
Russell King857835c2013-02-24 10:56:59 +0000816 if (!oh) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500817 WARN(1, "%s: no hwmod for %s\n", __func__,
818 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000819 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500820 }
Russell King857835c2013-02-24 10:56:59 +0000821 if (!oh->od) {
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500822 WARN(1, "%s: no omap_device for %s\n", __func__,
823 oh_name);
Russell King857835c2013-02-24 10:56:59 +0000824 return ERR_PTR(-ENODEV);
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500825 }
826
Nishanth Menon1f8a7d52011-07-27 15:02:32 -0500827 return &oh->od->pdev->dev;
828}
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700829
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200830static struct notifier_block platform_nb = {
831 .notifier_call = _omap_device_notifier_call,
832};
833
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700834static int __init omap_device_init(void)
835{
Benoit Coussondc2d07e2011-08-10 13:32:08 +0200836 bus_register_notifier(&platform_bus_type, &platform_nb);
Kevin Hilman3ec2dec2012-02-15 11:47:45 -0800837 return 0;
Kevin Hilman0d5e8252010-08-23 08:10:55 -0700838}
Tony Lindgrenb76c8b12013-01-11 11:24:18 -0800839omap_core_initcall(omap_device_init);
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700840
841/**
842 * omap_device_late_idle - idle devices without drivers
843 * @dev: struct device * associated with omap_device
844 * @data: unused
845 *
846 * Check the driver bound status of this device, and idle it
847 * if there is no driver attached.
848 */
849static int __init omap_device_late_idle(struct device *dev, void *data)
850{
851 struct platform_device *pdev = to_platform_device(dev);
852 struct omap_device *od = to_omap_device(pdev);
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600853 int i;
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700854
855 if (!od)
856 return 0;
857
858 /*
859 * If omap_device state is enabled, but has no driver bound,
860 * idle it.
861 */
Rajendra Nayakf66e3292013-07-28 23:01:50 -0600862
863 /*
864 * Some devices (like memory controllers) are always kept
865 * enabled, and should not be idled even with no drivers.
866 */
867 for (i = 0; i < od->hwmods_cnt; i++)
868 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
869 return 0;
870
Kevin Hilman9634c8d2012-07-10 15:06:11 -0700871 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
872 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
873 dev_warn(dev, "%s: enabled but no driver. Idling\n",
874 __func__);
875 omap_device_idle(pdev);
876 }
877 }
878
879 return 0;
880}
881
882static int __init omap_device_late_init(void)
883{
884 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
885 return 0;
886}
Kevin Hilmane7e17c52013-05-08 16:48:01 -0700887omap_late_initcall_sync(omap_device_late_init);