omap_device.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813
  1. /*
  2. * omap_device implementation
  3. *
  4. * Copyright (C) 2009-2010 Nokia Corporation
  5. * Paul Walmsley, Kevin Hilman
  6. *
  7. * Developed in collaboration with (alphabetical order): Benoit
  8. * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
  9. * 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. *
  20. * In the medium- to long-term, this code should either be
  21. * a) implemented via arch-specific pointers in platform_data
  22. * or
  23. * b) implemented as a proper omap_bus/omap_device in Linux, no more
  24. * platform_data func pointers
  25. *
  26. *
  27. * Guidelines for usage by driver authors:
  28. *
  29. * 1. These functions are intended to be used by device drivers via
  30. * function pointers in struct platform_data. As an example,
  31. * omap_device_enable() should be passed to the driver as
  32. *
  33. * struct foo_driver_platform_data {
  34. * ...
  35. * int (*device_enable)(struct platform_device *pdev);
  36. * ...
  37. * }
  38. *
  39. * Note that the generic "device_enable" name is used, rather than
  40. * "omap_device_enable". This is so other architectures can pass in their
  41. * own enable/disable functions here.
  42. *
  43. * This should be populated during device setup:
  44. *
  45. * ...
  46. * pdata->device_enable = omap_device_enable;
  47. * ...
  48. *
  49. * 2. Drivers should first check to ensure the function pointer is not null
  50. * before calling it, as in:
  51. *
  52. * if (pdata->device_enable)
  53. * pdata->device_enable(pdev);
  54. *
  55. * This allows other architectures that don't use similar device_enable()/
  56. * device_shutdown() functions to execute normally.
  57. *
  58. * ...
  59. *
  60. * Suggested usage by device drivers:
  61. *
  62. * During device initialization:
  63. * device_enable()
  64. *
  65. * During device idle:
  66. * (save remaining device context if necessary)
  67. * device_idle();
  68. *
  69. * During device resume:
  70. * device_enable();
  71. * (restore context if necessary)
  72. *
  73. * During device shutdown:
  74. * device_shutdown()
  75. * (device must be reinitialized at this point to use it again)
  76. *
  77. */
  78. #undef DEBUG
  79. #include <linux/kernel.h>
  80. #include <linux/platform_device.h>
  81. #include <linux/slab.h>
  82. #include <linux/err.h>
  83. #include <linux/io.h>
  84. #include <linux/clk.h>
  85. #include <plat/omap_device.h>
  86. #include <plat/omap_hwmod.h>
  87. /* These parameters are passed to _omap_device_{de,}activate() */
  88. #define USE_WAKEUP_LAT 0
  89. #define IGNORE_WAKEUP_LAT 1
  90. /* Private functions */
  91. /**
  92. * _omap_device_activate - increase device readiness
  93. * @od: struct omap_device *
  94. * @ignore_lat: increase to latency target (0) or full readiness (1)?
  95. *
  96. * Increase readiness of omap_device @od (thus decreasing device
  97. * wakeup latency, but consuming more power). If @ignore_lat is
  98. * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise,
  99. * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
  100. * latency is greater than the requested maximum wakeup latency, step
  101. * backwards in the omap_device_pm_latency table to ensure the
  102. * device's maximum wakeup latency is less than or equal to the
  103. * requested maximum wakeup latency. Returns 0.
  104. */
  105. static int _omap_device_activate(struct omap_device *od, u8 ignore_lat)
  106. {
  107. struct timespec a, b, c;
  108. pr_debug("omap_device: %s: activating\n", od->pdev.name);
  109. while (od->pm_lat_level > 0) {
  110. struct omap_device_pm_latency *odpl;
  111. unsigned long long act_lat = 0;
  112. od->pm_lat_level--;
  113. odpl = od->pm_lats + od->pm_lat_level;
  114. if (!ignore_lat &&
  115. (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit))
  116. break;
  117. read_persistent_clock(&a);
  118. /* XXX check return code */
  119. odpl->activate_func(od);
  120. read_persistent_clock(&b);
  121. c = timespec_sub(b, a);
  122. act_lat = timespec_to_ns(&c);
  123. pr_debug("omap_device: %s: pm_lat %d: activate: elapsed time "
  124. "%llu nsec\n", od->pdev.name, od->pm_lat_level,
  125. act_lat);
  126. if (act_lat > odpl->activate_lat) {
  127. odpl->activate_lat_worst = act_lat;
  128. if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
  129. odpl->activate_lat = act_lat;
  130. pr_warning("omap_device: %s.%d: new worst case "
  131. "activate latency %d: %llu\n",
  132. od->pdev.name, od->pdev.id,
  133. od->pm_lat_level, act_lat);
  134. } else
  135. pr_warning("omap_device: %s.%d: activate "
  136. "latency %d higher than exptected. "
  137. "(%llu > %d)\n",
  138. od->pdev.name, od->pdev.id,
  139. od->pm_lat_level, act_lat,
  140. odpl->activate_lat);
  141. }
  142. od->dev_wakeup_lat -= odpl->activate_lat;
  143. }
  144. return 0;
  145. }
  146. /**
  147. * _omap_device_deactivate - decrease device readiness
  148. * @od: struct omap_device *
  149. * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
  150. *
  151. * Decrease readiness of omap_device @od (thus increasing device
  152. * wakeup latency, but conserving power). If @ignore_lat is
  153. * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise,
  154. * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
  155. * latency is less than the requested maximum wakeup latency, step
  156. * forwards in the omap_device_pm_latency table to ensure the device's
  157. * maximum wakeup latency is less than or equal to the requested
  158. * maximum wakeup latency. Returns 0.
  159. */
  160. static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat)
  161. {
  162. struct timespec a, b, c;
  163. pr_debug("omap_device: %s: deactivating\n", od->pdev.name);
  164. while (od->pm_lat_level < od->pm_lats_cnt) {
  165. struct omap_device_pm_latency *odpl;
  166. unsigned long long deact_lat = 0;
  167. odpl = od->pm_lats + od->pm_lat_level;
  168. if (!ignore_lat &&
  169. ((od->dev_wakeup_lat + odpl->activate_lat) >
  170. od->_dev_wakeup_lat_limit))
  171. break;
  172. read_persistent_clock(&a);
  173. /* XXX check return code */
  174. odpl->deactivate_func(od);
  175. read_persistent_clock(&b);
  176. c = timespec_sub(b, a);
  177. deact_lat = timespec_to_ns(&c);
  178. pr_debug("omap_device: %s: pm_lat %d: deactivate: elapsed time "
  179. "%llu nsec\n", od->pdev.name, od->pm_lat_level,
  180. deact_lat);
  181. if (deact_lat > odpl->deactivate_lat) {
  182. odpl->deactivate_lat_worst = deact_lat;
  183. if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
  184. odpl->deactivate_lat = deact_lat;
  185. pr_warning("omap_device: %s.%d: new worst case "
  186. "deactivate latency %d: %llu\n",
  187. od->pdev.name, od->pdev.id,
  188. od->pm_lat_level, deact_lat);
  189. } else
  190. pr_warning("omap_device: %s.%d: deactivate "
  191. "latency %d higher than exptected. "
  192. "(%llu > %d)\n",
  193. od->pdev.name, od->pdev.id,
  194. od->pm_lat_level, deact_lat,
  195. odpl->deactivate_lat);
  196. }
  197. od->dev_wakeup_lat += odpl->activate_lat;
  198. od->pm_lat_level++;
  199. }
  200. return 0;
  201. }
  202. static inline struct omap_device *_find_by_pdev(struct platform_device *pdev)
  203. {
  204. return container_of(pdev, struct omap_device, pdev);
  205. }
  206. /**
  207. * _add_optional_clock_alias - Add clock alias for hwmod optional clocks
  208. * @od: struct omap_device *od
  209. *
  210. * For every optional clock present per hwmod per omap_device, this function
  211. * adds an entry in the clocks list of the form <dev-id=dev_name, con-id=role>
  212. * if an entry is already present in it with the form <dev-id=NULL, con-id=role>
  213. *
  214. * The function is called from inside omap_device_build_ss(), after
  215. * omap_device_register.
  216. *
  217. * This allows drivers to get a pointer to its optional clocks based on its role
  218. * by calling clk_get(<dev*>, <role>).
  219. *
  220. * No return value.
  221. */
  222. static void _add_optional_clock_alias(struct omap_device *od,
  223. struct omap_hwmod *oh)
  224. {
  225. int i;
  226. for (i = 0; i < oh->opt_clks_cnt; i++) {
  227. struct omap_hwmod_opt_clk *oc;
  228. int r;
  229. oc = &oh->opt_clks[i];
  230. if (!oc->_clk)
  231. continue;
  232. r = clk_add_alias(oc->role, dev_name(&od->pdev.dev),
  233. (char *)oc->clk, &od->pdev.dev);
  234. if (r)
  235. pr_err("omap_device: %s: clk_add_alias for %s failed\n",
  236. dev_name(&od->pdev.dev), oc->role);
  237. }
  238. }
  239. /* Public functions for use by core code */
  240. /**
  241. * omap_device_get_context_loss_count - get lost context count
  242. * @od: struct omap_device *
  243. *
  244. * Using the primary hwmod, query the context loss count for this
  245. * device.
  246. *
  247. * Callers should consider context for this device lost any time this
  248. * function returns a value different than the value the caller got
  249. * the last time it called this function.
  250. *
  251. * If any hwmods exist for the omap_device assoiated with @pdev,
  252. * return the context loss counter for that hwmod, otherwise return
  253. * zero.
  254. */
  255. u32 omap_device_get_context_loss_count(struct platform_device *pdev)
  256. {
  257. struct omap_device *od;
  258. u32 ret = 0;
  259. od = _find_by_pdev(pdev);
  260. if (od->hwmods_cnt)
  261. ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
  262. return ret;
  263. }
  264. /**
  265. * omap_device_count_resources - count number of struct resource entries needed
  266. * @od: struct omap_device *
  267. *
  268. * Count the number of struct resource entries needed for this
  269. * omap_device @od. Used by omap_device_build_ss() to determine how
  270. * much memory to allocate before calling
  271. * omap_device_fill_resources(). Returns the count.
  272. */
  273. int omap_device_count_resources(struct omap_device *od)
  274. {
  275. int c = 0;
  276. int i;
  277. for (i = 0; i < od->hwmods_cnt; i++)
  278. c += omap_hwmod_count_resources(od->hwmods[i]);
  279. pr_debug("omap_device: %s: counted %d total resources across %d "
  280. "hwmods\n", od->pdev.name, c, od->hwmods_cnt);
  281. return c;
  282. }
  283. /**
  284. * omap_device_fill_resources - fill in array of struct resource
  285. * @od: struct omap_device *
  286. * @res: pointer to an array of struct resource to be filled in
  287. *
  288. * Populate one or more empty struct resource pointed to by @res with
  289. * the resource data for this omap_device @od. Used by
  290. * omap_device_build_ss() after calling omap_device_count_resources().
  291. * Ideally this function would not be needed at all. If omap_device
  292. * replaces platform_device, then we can specify our own
  293. * get_resource()/ get_irq()/etc functions that use the underlying
  294. * omap_hwmod information. Or if platform_device is extended to use
  295. * subarchitecture-specific function pointers, the various
  296. * platform_device functions can simply call omap_device internal
  297. * functions to get device resources. Hacking around the existing
  298. * platform_device code wastes memory. Returns 0.
  299. */
  300. int omap_device_fill_resources(struct omap_device *od, struct resource *res)
  301. {
  302. int c = 0;
  303. int i, r;
  304. for (i = 0; i < od->hwmods_cnt; i++) {
  305. r = omap_hwmod_fill_resources(od->hwmods[i], res);
  306. res += r;
  307. c += r;
  308. }
  309. return 0;
  310. }
  311. /**
  312. * omap_device_build - build and register an omap_device with one omap_hwmod
  313. * @pdev_name: name of the platform_device driver to use
  314. * @pdev_id: this platform_device's connection ID
  315. * @oh: ptr to the single omap_hwmod that backs this omap_device
  316. * @pdata: platform_data ptr to associate with the platform_device
  317. * @pdata_len: amount of memory pointed to by @pdata
  318. * @pm_lats: pointer to a omap_device_pm_latency array for this device
  319. * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
  320. * @is_early_device: should the device be registered as an early device or not
  321. *
  322. * Convenience function for building and registering a single
  323. * omap_device record, which in turn builds and registers a
  324. * platform_device record. See omap_device_build_ss() for more
  325. * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
  326. * passes along the return value of omap_device_build_ss().
  327. */
  328. struct omap_device *omap_device_build(const char *pdev_name, int pdev_id,
  329. struct omap_hwmod *oh, void *pdata,
  330. int pdata_len,
  331. struct omap_device_pm_latency *pm_lats,
  332. int pm_lats_cnt, int is_early_device)
  333. {
  334. struct omap_hwmod *ohs[] = { oh };
  335. if (!oh)
  336. return ERR_PTR(-EINVAL);
  337. return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
  338. pdata_len, pm_lats, pm_lats_cnt,
  339. is_early_device);
  340. }
  341. /**
  342. * omap_device_build_ss - build and register an omap_device with multiple hwmods
  343. * @pdev_name: name of the platform_device driver to use
  344. * @pdev_id: this platform_device's connection ID
  345. * @oh: ptr to the single omap_hwmod that backs this omap_device
  346. * @pdata: platform_data ptr to associate with the platform_device
  347. * @pdata_len: amount of memory pointed to by @pdata
  348. * @pm_lats: pointer to a omap_device_pm_latency array for this device
  349. * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
  350. * @is_early_device: should the device be registered as an early device or not
  351. *
  352. * Convenience function for building and registering an omap_device
  353. * subsystem record. Subsystem records consist of multiple
  354. * omap_hwmods. This function in turn builds and registers a
  355. * platform_device record. Returns an ERR_PTR() on error, or passes
  356. * along the return value of omap_device_register().
  357. */
  358. struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
  359. struct omap_hwmod **ohs, int oh_cnt,
  360. void *pdata, int pdata_len,
  361. struct omap_device_pm_latency *pm_lats,
  362. int pm_lats_cnt, int is_early_device)
  363. {
  364. int ret = -ENOMEM;
  365. struct omap_device *od;
  366. char *pdev_name2;
  367. struct resource *res = NULL;
  368. int i, res_count;
  369. struct omap_hwmod **hwmods;
  370. if (!ohs || oh_cnt == 0 || !pdev_name)
  371. return ERR_PTR(-EINVAL);
  372. if (!pdata && pdata_len > 0)
  373. return ERR_PTR(-EINVAL);
  374. pr_debug("omap_device: %s: building with %d hwmods\n", pdev_name,
  375. oh_cnt);
  376. od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
  377. if (!od)
  378. return ERR_PTR(-ENOMEM);
  379. od->hwmods_cnt = oh_cnt;
  380. hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt,
  381. GFP_KERNEL);
  382. if (!hwmods)
  383. goto odbs_exit1;
  384. memcpy(hwmods, ohs, sizeof(struct omap_hwmod *) * oh_cnt);
  385. od->hwmods = hwmods;
  386. pdev_name2 = kzalloc(strlen(pdev_name) + 1, GFP_KERNEL);
  387. if (!pdev_name2)
  388. goto odbs_exit2;
  389. strcpy(pdev_name2, pdev_name);
  390. od->pdev.name = pdev_name2;
  391. od->pdev.id = pdev_id;
  392. res_count = omap_device_count_resources(od);
  393. if (res_count > 0) {
  394. res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
  395. if (!res)
  396. goto odbs_exit3;
  397. }
  398. omap_device_fill_resources(od, res);
  399. od->pdev.num_resources = res_count;
  400. od->pdev.resource = res;
  401. ret = platform_device_add_data(&od->pdev, pdata, pdata_len);
  402. if (ret)
  403. goto odbs_exit4;
  404. od->pm_lats = pm_lats;
  405. od->pm_lats_cnt = pm_lats_cnt;
  406. if (is_early_device)
  407. ret = omap_early_device_register(od);
  408. else
  409. ret = omap_device_register(od);
  410. for (i = 0; i < oh_cnt; i++) {
  411. hwmods[i]->od = od;
  412. _add_optional_clock_alias(od, hwmods[i]);
  413. }
  414. if (ret)
  415. goto odbs_exit4;
  416. return od;
  417. odbs_exit4:
  418. kfree(res);
  419. odbs_exit3:
  420. kfree(pdev_name2);
  421. odbs_exit2:
  422. kfree(hwmods);
  423. odbs_exit1:
  424. kfree(od);
  425. pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
  426. return ERR_PTR(ret);
  427. }
  428. /**
  429. * omap_early_device_register - register an omap_device as an early platform
  430. * device.
  431. * @od: struct omap_device * to register
  432. *
  433. * Register the omap_device structure. This currently just calls
  434. * platform_early_add_device() on the underlying platform_device.
  435. * Returns 0 by default.
  436. */
  437. int omap_early_device_register(struct omap_device *od)
  438. {
  439. struct platform_device *devices[1];
  440. devices[0] = &(od->pdev);
  441. early_platform_add_devices(devices, 1);
  442. return 0;
  443. }
  444. /**
  445. * omap_device_register - register an omap_device with one omap_hwmod
  446. * @od: struct omap_device * to register
  447. *
  448. * Register the omap_device structure. This currently just calls
  449. * platform_device_register() on the underlying platform_device.
  450. * Returns the return value of platform_device_register().
  451. */
  452. int omap_device_register(struct omap_device *od)
  453. {
  454. pr_debug("omap_device: %s: registering\n", od->pdev.name);
  455. od->pdev.dev.parent = &omap_device_parent;
  456. return platform_device_register(&od->pdev);
  457. }
  458. /* Public functions for use by device drivers through struct platform_data */
  459. /**
  460. * omap_device_enable - fully activate an omap_device
  461. * @od: struct omap_device * to activate
  462. *
  463. * Do whatever is necessary for the hwmods underlying omap_device @od
  464. * to be accessible and ready to operate. This generally involves
  465. * enabling clocks, setting SYSCONFIG registers; and in the future may
  466. * involve remuxing pins. Device drivers should call this function
  467. * (through platform_data function pointers) where they would normally
  468. * enable clocks, etc. Returns -EINVAL if called when the omap_device
  469. * is already enabled, or passes along the return value of
  470. * _omap_device_activate().
  471. */
  472. int omap_device_enable(struct platform_device *pdev)
  473. {
  474. int ret;
  475. struct omap_device *od;
  476. od = _find_by_pdev(pdev);
  477. if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
  478. WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
  479. od->pdev.name, od->pdev.id, __func__, od->_state);
  480. return -EINVAL;
  481. }
  482. /* Enable everything if we're enabling this device from scratch */
  483. if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
  484. od->pm_lat_level = od->pm_lats_cnt;
  485. ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
  486. od->dev_wakeup_lat = 0;
  487. od->_dev_wakeup_lat_limit = UINT_MAX;
  488. od->_state = OMAP_DEVICE_STATE_ENABLED;
  489. return ret;
  490. }
  491. /**
  492. * omap_device_idle - idle an omap_device
  493. * @od: struct omap_device * to idle
  494. *
  495. * Idle omap_device @od by calling as many .deactivate_func() entries
  496. * in the omap_device's pm_lats table as is possible without exceeding
  497. * the device's maximum wakeup latency limit, pm_lat_limit. Device
  498. * drivers should call this function (through platform_data function
  499. * pointers) where they would normally disable clocks after operations
  500. * complete, etc.. Returns -EINVAL if the omap_device is not
  501. * currently enabled, or passes along the return value of
  502. * _omap_device_deactivate().
  503. */
  504. int omap_device_idle(struct platform_device *pdev)
  505. {
  506. int ret;
  507. struct omap_device *od;
  508. od = _find_by_pdev(pdev);
  509. if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
  510. WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
  511. od->pdev.name, od->pdev.id, __func__, od->_state);
  512. return -EINVAL;
  513. }
  514. ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
  515. od->_state = OMAP_DEVICE_STATE_IDLE;
  516. return ret;
  517. }
  518. /**
  519. * omap_device_shutdown - shut down an omap_device
  520. * @od: struct omap_device * to shut down
  521. *
  522. * Shut down omap_device @od by calling all .deactivate_func() entries
  523. * in the omap_device's pm_lats table and then shutting down all of
  524. * the underlying omap_hwmods. Used when a device is being "removed"
  525. * or a device driver is being unloaded. Returns -EINVAL if the
  526. * omap_device is not currently enabled or idle, or passes along the
  527. * return value of _omap_device_deactivate().
  528. */
  529. int omap_device_shutdown(struct platform_device *pdev)
  530. {
  531. int ret, i;
  532. struct omap_device *od;
  533. od = _find_by_pdev(pdev);
  534. if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
  535. od->_state != OMAP_DEVICE_STATE_IDLE) {
  536. WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
  537. od->pdev.name, od->pdev.id, __func__, od->_state);
  538. return -EINVAL;
  539. }
  540. ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
  541. for (i = 0; i < od->hwmods_cnt; i++)
  542. omap_hwmod_shutdown(od->hwmods[i]);
  543. od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
  544. return ret;
  545. }
  546. /**
  547. * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
  548. * @od: struct omap_device *
  549. *
  550. * When a device's maximum wakeup latency limit changes, call some of
  551. * the .activate_func or .deactivate_func function pointers in the
  552. * omap_device's pm_lats array to ensure that the device's maximum
  553. * wakeup latency is less than or equal to the new latency limit.
  554. * Intended to be called by OMAP PM code whenever a device's maximum
  555. * wakeup latency limit changes (e.g., via
  556. * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be
  557. * done (e.g., if the omap_device is not currently idle, or if the
  558. * wakeup latency is already current with the new limit) or passes
  559. * along the return value of _omap_device_deactivate() or
  560. * _omap_device_activate().
  561. */
  562. int omap_device_align_pm_lat(struct platform_device *pdev,
  563. u32 new_wakeup_lat_limit)
  564. {
  565. int ret = -EINVAL;
  566. struct omap_device *od;
  567. od = _find_by_pdev(pdev);
  568. if (new_wakeup_lat_limit == od->dev_wakeup_lat)
  569. return 0;
  570. od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
  571. if (od->_state != OMAP_DEVICE_STATE_IDLE)
  572. return 0;
  573. else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
  574. ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
  575. else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
  576. ret = _omap_device_activate(od, USE_WAKEUP_LAT);
  577. return ret;
  578. }
  579. /**
  580. * omap_device_get_pwrdm - return the powerdomain * associated with @od
  581. * @od: struct omap_device *
  582. *
  583. * Return the powerdomain associated with the first underlying
  584. * omap_hwmod for this omap_device. Intended for use by core OMAP PM
  585. * code. Returns NULL on error or a struct powerdomain * upon
  586. * success.
  587. */
  588. struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
  589. {
  590. /*
  591. * XXX Assumes that all omap_hwmod powerdomains are identical.
  592. * This may not necessarily be true. There should be a sanity
  593. * check in here to WARN() if any difference appears.
  594. */
  595. if (!od->hwmods_cnt)
  596. return NULL;
  597. return omap_hwmod_get_pwrdm(od->hwmods[0]);
  598. }
  599. /**
  600. * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
  601. * @od: struct omap_device *
  602. *
  603. * Return the MPU's virtual address for the base of the hwmod, from
  604. * the ioremap() that the hwmod code does. Only valid if there is one
  605. * hwmod associated with this device. Returns NULL if there are zero
  606. * or more than one hwmods associated with this omap_device;
  607. * otherwise, passes along the return value from
  608. * omap_hwmod_get_mpu_rt_va().
  609. */
  610. void __iomem *omap_device_get_rt_va(struct omap_device *od)
  611. {
  612. if (od->hwmods_cnt != 1)
  613. return NULL;
  614. return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
  615. }
  616. /*
  617. * Public functions intended for use in omap_device_pm_latency
  618. * .activate_func and .deactivate_func function pointers
  619. */
  620. /**
  621. * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
  622. * @od: struct omap_device *od
  623. *
  624. * Enable all underlying hwmods. Returns 0.
  625. */
  626. int omap_device_enable_hwmods(struct omap_device *od)
  627. {
  628. int i;
  629. for (i = 0; i < od->hwmods_cnt; i++)
  630. omap_hwmod_enable(od->hwmods[i]);
  631. /* XXX pass along return value here? */
  632. return 0;
  633. }
  634. /**
  635. * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
  636. * @od: struct omap_device *od
  637. *
  638. * Idle all underlying hwmods. Returns 0.
  639. */
  640. int omap_device_idle_hwmods(struct omap_device *od)
  641. {
  642. int i;
  643. for (i = 0; i < od->hwmods_cnt; i++)
  644. omap_hwmod_idle(od->hwmods[i]);
  645. /* XXX pass along return value here? */
  646. return 0;
  647. }
  648. /**
  649. * omap_device_disable_clocks - disable all main and interface clocks
  650. * @od: struct omap_device *od
  651. *
  652. * Disable the main functional clock and interface clock for all of the
  653. * omap_hwmods associated with the omap_device. Returns 0.
  654. */
  655. int omap_device_disable_clocks(struct omap_device *od)
  656. {
  657. int i;
  658. for (i = 0; i < od->hwmods_cnt; i++)
  659. omap_hwmod_disable_clocks(od->hwmods[i]);
  660. /* XXX pass along return value here? */
  661. return 0;
  662. }
  663. /**
  664. * omap_device_enable_clocks - enable all main and interface clocks
  665. * @od: struct omap_device *od
  666. *
  667. * Enable the main functional clock and interface clock for all of the
  668. * omap_hwmods associated with the omap_device. Returns 0.
  669. */
  670. int omap_device_enable_clocks(struct omap_device *od)
  671. {
  672. int i;
  673. for (i = 0; i < od->hwmods_cnt; i++)
  674. omap_hwmod_enable_clocks(od->hwmods[i]);
  675. /* XXX pass along return value here? */
  676. return 0;
  677. }
  678. struct device omap_device_parent = {
  679. .init_name = "omap",
  680. .parent = &platform_bus,
  681. };
  682. static int __init omap_device_init(void)
  683. {
  684. return device_register(&omap_device_parent);
  685. }
  686. core_initcall(omap_device_init);