domain.c 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787
  1. /*
  2. * drivers/base/power/domain.c - Common code related to device power domains.
  3. *
  4. * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
  5. *
  6. * This file is released under the GPLv2.
  7. */
  8. #include <linux/delay.h>
  9. #include <linux/kernel.h>
  10. #include <linux/io.h>
  11. #include <linux/platform_device.h>
  12. #include <linux/pm_runtime.h>
  13. #include <linux/pm_domain.h>
  14. #include <linux/pm_qos.h>
  15. #include <linux/pm_clock.h>
  16. #include <linux/slab.h>
  17. #include <linux/err.h>
  18. #include <linux/sched.h>
  19. #include <linux/suspend.h>
  20. #include <linux/export.h>
  21. #include "power.h"
  22. #define GENPD_RETRY_MAX_MS 250 /* Approximate */
  23. #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
  24. ({ \
  25. type (*__routine)(struct device *__d); \
  26. type __ret = (type)0; \
  27. \
  28. __routine = genpd->dev_ops.callback; \
  29. if (__routine) { \
  30. __ret = __routine(dev); \
  31. } \
  32. __ret; \
  33. })
  34. static LIST_HEAD(gpd_list);
  35. static DEFINE_MUTEX(gpd_list_lock);
  36. /*
  37. * Get the generic PM domain for a particular struct device.
  38. * This validates the struct device pointer, the PM domain pointer,
  39. * and checks that the PM domain pointer is a real generic PM domain.
  40. * Any failure results in NULL being returned.
  41. */
  42. struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
  43. {
  44. struct generic_pm_domain *genpd = NULL, *gpd;
  45. if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
  46. return NULL;
  47. mutex_lock(&gpd_list_lock);
  48. list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
  49. if (&gpd->domain == dev->pm_domain) {
  50. genpd = gpd;
  51. break;
  52. }
  53. }
  54. mutex_unlock(&gpd_list_lock);
  55. return genpd;
  56. }
  57. /*
  58. * This should only be used where we are certain that the pm_domain
  59. * attached to the device is a genpd domain.
  60. */
  61. static struct generic_pm_domain *dev_to_genpd(struct device *dev)
  62. {
  63. if (IS_ERR_OR_NULL(dev->pm_domain))
  64. return ERR_PTR(-EINVAL);
  65. return pd_to_genpd(dev->pm_domain);
  66. }
  67. static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
  68. {
  69. return GENPD_DEV_CALLBACK(genpd, int, stop, dev);
  70. }
  71. static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
  72. {
  73. return GENPD_DEV_CALLBACK(genpd, int, start, dev);
  74. }
  75. static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
  76. {
  77. bool ret = false;
  78. if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
  79. ret = !!atomic_dec_and_test(&genpd->sd_count);
  80. return ret;
  81. }
  82. static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
  83. {
  84. atomic_inc(&genpd->sd_count);
  85. smp_mb__after_atomic();
  86. }
  87. static int genpd_power_on(struct generic_pm_domain *genpd, bool timed)
  88. {
  89. unsigned int state_idx = genpd->state_idx;
  90. ktime_t time_start;
  91. s64 elapsed_ns;
  92. int ret;
  93. if (!genpd->power_on)
  94. return 0;
  95. if (!timed)
  96. return genpd->power_on(genpd);
  97. time_start = ktime_get();
  98. ret = genpd->power_on(genpd);
  99. if (ret)
  100. return ret;
  101. elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
  102. if (elapsed_ns <= genpd->states[state_idx].power_on_latency_ns)
  103. return ret;
  104. genpd->states[state_idx].power_on_latency_ns = elapsed_ns;
  105. genpd->max_off_time_changed = true;
  106. pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
  107. genpd->name, "on", elapsed_ns);
  108. return ret;
  109. }
  110. static int genpd_power_off(struct generic_pm_domain *genpd, bool timed)
  111. {
  112. unsigned int state_idx = genpd->state_idx;
  113. ktime_t time_start;
  114. s64 elapsed_ns;
  115. int ret;
  116. if (!genpd->power_off)
  117. return 0;
  118. if (!timed)
  119. return genpd->power_off(genpd);
  120. time_start = ktime_get();
  121. ret = genpd->power_off(genpd);
  122. if (ret == -EBUSY)
  123. return ret;
  124. elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
  125. if (elapsed_ns <= genpd->states[state_idx].power_off_latency_ns)
  126. return ret;
  127. genpd->states[state_idx].power_off_latency_ns = elapsed_ns;
  128. genpd->max_off_time_changed = true;
  129. pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
  130. genpd->name, "off", elapsed_ns);
  131. return ret;
  132. }
  133. /**
  134. * genpd_queue_power_off_work - Queue up the execution of genpd_poweroff().
  135. * @genpd: PM domain to power off.
  136. *
  137. * Queue up the execution of genpd_poweroff() unless it's already been done
  138. * before.
  139. */
  140. static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
  141. {
  142. queue_work(pm_wq, &genpd->power_off_work);
  143. }
  144. /**
  145. * genpd_poweron - Restore power to a given PM domain and its masters.
  146. * @genpd: PM domain to power up.
  147. * @depth: nesting count for lockdep.
  148. *
  149. * Restore power to @genpd and all of its masters so that it is possible to
  150. * resume a device belonging to it.
  151. */
  152. static int genpd_poweron(struct generic_pm_domain *genpd, unsigned int depth)
  153. {
  154. struct gpd_link *link;
  155. int ret = 0;
  156. if (genpd->status == GPD_STATE_ACTIVE)
  157. return 0;
  158. /*
  159. * The list is guaranteed not to change while the loop below is being
  160. * executed, unless one of the masters' .power_on() callbacks fiddles
  161. * with it.
  162. */
  163. list_for_each_entry(link, &genpd->slave_links, slave_node) {
  164. struct generic_pm_domain *master = link->master;
  165. genpd_sd_counter_inc(master);
  166. mutex_lock_nested(&master->lock, depth + 1);
  167. ret = genpd_poweron(master, depth + 1);
  168. mutex_unlock(&master->lock);
  169. if (ret) {
  170. genpd_sd_counter_dec(master);
  171. goto err;
  172. }
  173. }
  174. ret = genpd_power_on(genpd, true);
  175. if (ret)
  176. goto err;
  177. genpd->status = GPD_STATE_ACTIVE;
  178. return 0;
  179. err:
  180. list_for_each_entry_continue_reverse(link,
  181. &genpd->slave_links,
  182. slave_node) {
  183. genpd_sd_counter_dec(link->master);
  184. genpd_queue_power_off_work(link->master);
  185. }
  186. return ret;
  187. }
  188. static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
  189. unsigned long val, void *ptr)
  190. {
  191. struct generic_pm_domain_data *gpd_data;
  192. struct device *dev;
  193. gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
  194. dev = gpd_data->base.dev;
  195. for (;;) {
  196. struct generic_pm_domain *genpd;
  197. struct pm_domain_data *pdd;
  198. spin_lock_irq(&dev->power.lock);
  199. pdd = dev->power.subsys_data ?
  200. dev->power.subsys_data->domain_data : NULL;
  201. if (pdd && pdd->dev) {
  202. to_gpd_data(pdd)->td.constraint_changed = true;
  203. genpd = dev_to_genpd(dev);
  204. } else {
  205. genpd = ERR_PTR(-ENODATA);
  206. }
  207. spin_unlock_irq(&dev->power.lock);
  208. if (!IS_ERR(genpd)) {
  209. mutex_lock(&genpd->lock);
  210. genpd->max_off_time_changed = true;
  211. mutex_unlock(&genpd->lock);
  212. }
  213. dev = dev->parent;
  214. if (!dev || dev->power.ignore_children)
  215. break;
  216. }
  217. return NOTIFY_DONE;
  218. }
  219. /**
  220. * genpd_poweroff - Remove power from a given PM domain.
  221. * @genpd: PM domain to power down.
  222. * @is_async: PM domain is powered down from a scheduled work
  223. *
  224. * If all of the @genpd's devices have been suspended and all of its subdomains
  225. * have been powered down, remove power from @genpd.
  226. */
  227. static int genpd_poweroff(struct generic_pm_domain *genpd, bool is_async)
  228. {
  229. struct pm_domain_data *pdd;
  230. struct gpd_link *link;
  231. unsigned int not_suspended = 0;
  232. /*
  233. * Do not try to power off the domain in the following situations:
  234. * (1) The domain is already in the "power off" state.
  235. * (2) System suspend is in progress.
  236. */
  237. if (genpd->status == GPD_STATE_POWER_OFF
  238. || genpd->prepared_count > 0)
  239. return 0;
  240. if (atomic_read(&genpd->sd_count) > 0)
  241. return -EBUSY;
  242. list_for_each_entry(pdd, &genpd->dev_list, list_node) {
  243. enum pm_qos_flags_status stat;
  244. stat = dev_pm_qos_flags(pdd->dev,
  245. PM_QOS_FLAG_NO_POWER_OFF
  246. | PM_QOS_FLAG_REMOTE_WAKEUP);
  247. if (stat > PM_QOS_FLAGS_NONE)
  248. return -EBUSY;
  249. if (!pm_runtime_suspended(pdd->dev) || pdd->dev->power.irq_safe)
  250. not_suspended++;
  251. }
  252. if (not_suspended > 1 || (not_suspended == 1 && is_async))
  253. return -EBUSY;
  254. if (genpd->gov && genpd->gov->power_down_ok) {
  255. if (!genpd->gov->power_down_ok(&genpd->domain))
  256. return -EAGAIN;
  257. }
  258. if (genpd->power_off) {
  259. int ret;
  260. if (atomic_read(&genpd->sd_count) > 0)
  261. return -EBUSY;
  262. /*
  263. * If sd_count > 0 at this point, one of the subdomains hasn't
  264. * managed to call genpd_poweron() for the master yet after
  265. * incrementing it. In that case genpd_poweron() will wait
  266. * for us to drop the lock, so we can call .power_off() and let
  267. * the genpd_poweron() restore power for us (this shouldn't
  268. * happen very often).
  269. */
  270. ret = genpd_power_off(genpd, true);
  271. if (ret)
  272. return ret;
  273. }
  274. genpd->status = GPD_STATE_POWER_OFF;
  275. list_for_each_entry(link, &genpd->slave_links, slave_node) {
  276. genpd_sd_counter_dec(link->master);
  277. genpd_queue_power_off_work(link->master);
  278. }
  279. return 0;
  280. }
  281. /**
  282. * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
  283. * @work: Work structure used for scheduling the execution of this function.
  284. */
  285. static void genpd_power_off_work_fn(struct work_struct *work)
  286. {
  287. struct generic_pm_domain *genpd;
  288. genpd = container_of(work, struct generic_pm_domain, power_off_work);
  289. mutex_lock(&genpd->lock);
  290. genpd_poweroff(genpd, true);
  291. mutex_unlock(&genpd->lock);
  292. }
  293. /**
  294. * __genpd_runtime_suspend - walk the hierarchy of ->runtime_suspend() callbacks
  295. * @dev: Device to handle.
  296. */
  297. static int __genpd_runtime_suspend(struct device *dev)
  298. {
  299. int (*cb)(struct device *__dev);
  300. if (dev->type && dev->type->pm)
  301. cb = dev->type->pm->runtime_suspend;
  302. else if (dev->class && dev->class->pm)
  303. cb = dev->class->pm->runtime_suspend;
  304. else if (dev->bus && dev->bus->pm)
  305. cb = dev->bus->pm->runtime_suspend;
  306. else
  307. cb = NULL;
  308. if (!cb && dev->driver && dev->driver->pm)
  309. cb = dev->driver->pm->runtime_suspend;
  310. return cb ? cb(dev) : 0;
  311. }
  312. /**
  313. * __genpd_runtime_resume - walk the hierarchy of ->runtime_resume() callbacks
  314. * @dev: Device to handle.
  315. */
  316. static int __genpd_runtime_resume(struct device *dev)
  317. {
  318. int (*cb)(struct device *__dev);
  319. if (dev->type && dev->type->pm)
  320. cb = dev->type->pm->runtime_resume;
  321. else if (dev->class && dev->class->pm)
  322. cb = dev->class->pm->runtime_resume;
  323. else if (dev->bus && dev->bus->pm)
  324. cb = dev->bus->pm->runtime_resume;
  325. else
  326. cb = NULL;
  327. if (!cb && dev->driver && dev->driver->pm)
  328. cb = dev->driver->pm->runtime_resume;
  329. return cb ? cb(dev) : 0;
  330. }
  331. /**
  332. * genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
  333. * @dev: Device to suspend.
  334. *
  335. * Carry out a runtime suspend of a device under the assumption that its
  336. * pm_domain field points to the domain member of an object of type
  337. * struct generic_pm_domain representing a PM domain consisting of I/O devices.
  338. */
  339. static int genpd_runtime_suspend(struct device *dev)
  340. {
  341. struct generic_pm_domain *genpd;
  342. bool (*suspend_ok)(struct device *__dev);
  343. struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
  344. bool runtime_pm = pm_runtime_enabled(dev);
  345. ktime_t time_start;
  346. s64 elapsed_ns;
  347. int ret;
  348. dev_dbg(dev, "%s()\n", __func__);
  349. genpd = dev_to_genpd(dev);
  350. if (IS_ERR(genpd))
  351. return -EINVAL;
  352. /*
  353. * A runtime PM centric subsystem/driver may re-use the runtime PM
  354. * callbacks for other purposes than runtime PM. In those scenarios
  355. * runtime PM is disabled. Under these circumstances, we shall skip
  356. * validating/measuring the PM QoS latency.
  357. */
  358. suspend_ok = genpd->gov ? genpd->gov->suspend_ok : NULL;
  359. if (runtime_pm && suspend_ok && !suspend_ok(dev))
  360. return -EBUSY;
  361. /* Measure suspend latency. */
  362. if (runtime_pm)
  363. time_start = ktime_get();
  364. ret = __genpd_runtime_suspend(dev);
  365. if (ret)
  366. return ret;
  367. ret = genpd_stop_dev(genpd, dev);
  368. if (ret) {
  369. __genpd_runtime_resume(dev);
  370. return ret;
  371. }
  372. /* Update suspend latency value if the measured time exceeds it. */
  373. if (runtime_pm) {
  374. elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
  375. if (elapsed_ns > td->suspend_latency_ns) {
  376. td->suspend_latency_ns = elapsed_ns;
  377. dev_dbg(dev, "suspend latency exceeded, %lld ns\n",
  378. elapsed_ns);
  379. genpd->max_off_time_changed = true;
  380. td->constraint_changed = true;
  381. }
  382. }
  383. /*
  384. * If power.irq_safe is set, this routine will be run with interrupts
  385. * off, so it can't use mutexes.
  386. */
  387. if (dev->power.irq_safe)
  388. return 0;
  389. mutex_lock(&genpd->lock);
  390. genpd_poweroff(genpd, false);
  391. mutex_unlock(&genpd->lock);
  392. return 0;
  393. }
  394. /**
  395. * genpd_runtime_resume - Resume a device belonging to I/O PM domain.
  396. * @dev: Device to resume.
  397. *
  398. * Carry out a runtime resume of a device under the assumption that its
  399. * pm_domain field points to the domain member of an object of type
  400. * struct generic_pm_domain representing a PM domain consisting of I/O devices.
  401. */
  402. static int genpd_runtime_resume(struct device *dev)
  403. {
  404. struct generic_pm_domain *genpd;
  405. struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
  406. bool runtime_pm = pm_runtime_enabled(dev);
  407. ktime_t time_start;
  408. s64 elapsed_ns;
  409. int ret;
  410. bool timed = true;
  411. dev_dbg(dev, "%s()\n", __func__);
  412. genpd = dev_to_genpd(dev);
  413. if (IS_ERR(genpd))
  414. return -EINVAL;
  415. /* If power.irq_safe, the PM domain is never powered off. */
  416. if (dev->power.irq_safe) {
  417. timed = false;
  418. goto out;
  419. }
  420. mutex_lock(&genpd->lock);
  421. ret = genpd_poweron(genpd, 0);
  422. mutex_unlock(&genpd->lock);
  423. if (ret)
  424. return ret;
  425. out:
  426. /* Measure resume latency. */
  427. if (timed && runtime_pm)
  428. time_start = ktime_get();
  429. ret = genpd_start_dev(genpd, dev);
  430. if (ret)
  431. goto err_poweroff;
  432. ret = __genpd_runtime_resume(dev);
  433. if (ret)
  434. goto err_stop;
  435. /* Update resume latency value if the measured time exceeds it. */
  436. if (timed && runtime_pm) {
  437. elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
  438. if (elapsed_ns > td->resume_latency_ns) {
  439. td->resume_latency_ns = elapsed_ns;
  440. dev_dbg(dev, "resume latency exceeded, %lld ns\n",
  441. elapsed_ns);
  442. genpd->max_off_time_changed = true;
  443. td->constraint_changed = true;
  444. }
  445. }
  446. return 0;
  447. err_stop:
  448. genpd_stop_dev(genpd, dev);
  449. err_poweroff:
  450. if (!dev->power.irq_safe) {
  451. mutex_lock(&genpd->lock);
  452. genpd_poweroff(genpd, 0);
  453. mutex_unlock(&genpd->lock);
  454. }
  455. return ret;
  456. }
  457. static bool pd_ignore_unused;
  458. static int __init pd_ignore_unused_setup(char *__unused)
  459. {
  460. pd_ignore_unused = true;
  461. return 1;
  462. }
  463. __setup("pd_ignore_unused", pd_ignore_unused_setup);
  464. /**
  465. * genpd_poweroff_unused - Power off all PM domains with no devices in use.
  466. */
  467. static int __init genpd_poweroff_unused(void)
  468. {
  469. struct generic_pm_domain *genpd;
  470. if (pd_ignore_unused) {
  471. pr_warn("genpd: Not disabling unused power domains\n");
  472. return 0;
  473. }
  474. mutex_lock(&gpd_list_lock);
  475. list_for_each_entry(genpd, &gpd_list, gpd_list_node)
  476. genpd_queue_power_off_work(genpd);
  477. mutex_unlock(&gpd_list_lock);
  478. return 0;
  479. }
  480. late_initcall(genpd_poweroff_unused);
  481. #ifdef CONFIG_PM_SLEEP
  482. /**
  483. * pm_genpd_present - Check if the given PM domain has been initialized.
  484. * @genpd: PM domain to check.
  485. */
  486. static bool pm_genpd_present(const struct generic_pm_domain *genpd)
  487. {
  488. const struct generic_pm_domain *gpd;
  489. if (IS_ERR_OR_NULL(genpd))
  490. return false;
  491. list_for_each_entry(gpd, &gpd_list, gpd_list_node)
  492. if (gpd == genpd)
  493. return true;
  494. return false;
  495. }
  496. static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
  497. struct device *dev)
  498. {
  499. return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
  500. }
  501. /**
  502. * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
  503. * @genpd: PM domain to power off, if possible.
  504. * @timed: True if latency measurements are allowed.
  505. *
  506. * Check if the given PM domain can be powered off (during system suspend or
  507. * hibernation) and do that if so. Also, in that case propagate to its masters.
  508. *
  509. * This function is only called in "noirq" and "syscore" stages of system power
  510. * transitions, so it need not acquire locks (all of the "noirq" callbacks are
  511. * executed sequentially, so it is guaranteed that it will never run twice in
  512. * parallel).
  513. */
  514. static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd,
  515. bool timed)
  516. {
  517. struct gpd_link *link;
  518. if (genpd->status == GPD_STATE_POWER_OFF)
  519. return;
  520. if (genpd->suspended_count != genpd->device_count
  521. || atomic_read(&genpd->sd_count) > 0)
  522. return;
  523. /* Choose the deepest state when suspending */
  524. genpd->state_idx = genpd->state_count - 1;
  525. genpd_power_off(genpd, timed);
  526. genpd->status = GPD_STATE_POWER_OFF;
  527. list_for_each_entry(link, &genpd->slave_links, slave_node) {
  528. genpd_sd_counter_dec(link->master);
  529. pm_genpd_sync_poweroff(link->master, timed);
  530. }
  531. }
  532. /**
  533. * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
  534. * @genpd: PM domain to power on.
  535. * @timed: True if latency measurements are allowed.
  536. *
  537. * This function is only called in "noirq" and "syscore" stages of system power
  538. * transitions, so it need not acquire locks (all of the "noirq" callbacks are
  539. * executed sequentially, so it is guaranteed that it will never run twice in
  540. * parallel).
  541. */
  542. static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd,
  543. bool timed)
  544. {
  545. struct gpd_link *link;
  546. if (genpd->status == GPD_STATE_ACTIVE)
  547. return;
  548. list_for_each_entry(link, &genpd->slave_links, slave_node) {
  549. pm_genpd_sync_poweron(link->master, timed);
  550. genpd_sd_counter_inc(link->master);
  551. }
  552. genpd_power_on(genpd, timed);
  553. genpd->status = GPD_STATE_ACTIVE;
  554. }
  555. /**
  556. * resume_needed - Check whether to resume a device before system suspend.
  557. * @dev: Device to check.
  558. * @genpd: PM domain the device belongs to.
  559. *
  560. * There are two cases in which a device that can wake up the system from sleep
  561. * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
  562. * to wake up the system and it has to remain active for this purpose while the
  563. * system is in the sleep state and (2) if the device is not enabled to wake up
  564. * the system from sleep states and it generally doesn't generate wakeup signals
  565. * by itself (those signals are generated on its behalf by other parts of the
  566. * system). In the latter case it may be necessary to reconfigure the device's
  567. * wakeup settings during system suspend, because it may have been set up to
  568. * signal remote wakeup from the system's working state as needed by runtime PM.
  569. * Return 'true' in either of the above cases.
  570. */
  571. static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
  572. {
  573. bool active_wakeup;
  574. if (!device_can_wakeup(dev))
  575. return false;
  576. active_wakeup = genpd_dev_active_wakeup(genpd, dev);
  577. return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
  578. }
  579. /**
  580. * pm_genpd_prepare - Start power transition of a device in a PM domain.
  581. * @dev: Device to start the transition of.
  582. *
  583. * Start a power transition of a device (during a system-wide power transition)
  584. * under the assumption that its pm_domain field points to the domain member of
  585. * an object of type struct generic_pm_domain representing a PM domain
  586. * consisting of I/O devices.
  587. */
  588. static int pm_genpd_prepare(struct device *dev)
  589. {
  590. struct generic_pm_domain *genpd;
  591. int ret;
  592. dev_dbg(dev, "%s()\n", __func__);
  593. genpd = dev_to_genpd(dev);
  594. if (IS_ERR(genpd))
  595. return -EINVAL;
  596. /*
  597. * If a wakeup request is pending for the device, it should be woken up
  598. * at this point and a system wakeup event should be reported if it's
  599. * set up to wake up the system from sleep states.
  600. */
  601. if (resume_needed(dev, genpd))
  602. pm_runtime_resume(dev);
  603. mutex_lock(&genpd->lock);
  604. if (genpd->prepared_count++ == 0)
  605. genpd->suspended_count = 0;
  606. mutex_unlock(&genpd->lock);
  607. ret = pm_generic_prepare(dev);
  608. if (ret) {
  609. mutex_lock(&genpd->lock);
  610. genpd->prepared_count--;
  611. mutex_unlock(&genpd->lock);
  612. }
  613. return ret;
  614. }
  615. /**
  616. * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
  617. * @dev: Device to suspend.
  618. *
  619. * Stop the device and remove power from the domain if all devices in it have
  620. * been stopped.
  621. */
  622. static int pm_genpd_suspend_noirq(struct device *dev)
  623. {
  624. struct generic_pm_domain *genpd;
  625. int ret;
  626. dev_dbg(dev, "%s()\n", __func__);
  627. genpd = dev_to_genpd(dev);
  628. if (IS_ERR(genpd))
  629. return -EINVAL;
  630. if (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev))
  631. return 0;
  632. if (genpd->dev_ops.stop && genpd->dev_ops.start) {
  633. ret = pm_runtime_force_suspend(dev);
  634. if (ret)
  635. return ret;
  636. }
  637. /*
  638. * Since all of the "noirq" callbacks are executed sequentially, it is
  639. * guaranteed that this function will never run twice in parallel for
  640. * the same PM domain, so it is not necessary to use locking here.
  641. */
  642. genpd->suspended_count++;
  643. pm_genpd_sync_poweroff(genpd, true);
  644. return 0;
  645. }
  646. /**
  647. * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
  648. * @dev: Device to resume.
  649. *
  650. * Restore power to the device's PM domain, if necessary, and start the device.
  651. */
  652. static int pm_genpd_resume_noirq(struct device *dev)
  653. {
  654. struct generic_pm_domain *genpd;
  655. int ret = 0;
  656. dev_dbg(dev, "%s()\n", __func__);
  657. genpd = dev_to_genpd(dev);
  658. if (IS_ERR(genpd))
  659. return -EINVAL;
  660. if (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev))
  661. return 0;
  662. /*
  663. * Since all of the "noirq" callbacks are executed sequentially, it is
  664. * guaranteed that this function will never run twice in parallel for
  665. * the same PM domain, so it is not necessary to use locking here.
  666. */
  667. pm_genpd_sync_poweron(genpd, true);
  668. genpd->suspended_count--;
  669. if (genpd->dev_ops.stop && genpd->dev_ops.start)
  670. ret = pm_runtime_force_resume(dev);
  671. return ret;
  672. }
  673. /**
  674. * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
  675. * @dev: Device to freeze.
  676. *
  677. * Carry out a late freeze of a device under the assumption that its
  678. * pm_domain field points to the domain member of an object of type
  679. * struct generic_pm_domain representing a power domain consisting of I/O
  680. * devices.
  681. */
  682. static int pm_genpd_freeze_noirq(struct device *dev)
  683. {
  684. struct generic_pm_domain *genpd;
  685. int ret = 0;
  686. dev_dbg(dev, "%s()\n", __func__);
  687. genpd = dev_to_genpd(dev);
  688. if (IS_ERR(genpd))
  689. return -EINVAL;
  690. if (genpd->dev_ops.stop && genpd->dev_ops.start)
  691. ret = pm_runtime_force_suspend(dev);
  692. return ret;
  693. }
  694. /**
  695. * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
  696. * @dev: Device to thaw.
  697. *
  698. * Start the device, unless power has been removed from the domain already
  699. * before the system transition.
  700. */
  701. static int pm_genpd_thaw_noirq(struct device *dev)
  702. {
  703. struct generic_pm_domain *genpd;
  704. int ret = 0;
  705. dev_dbg(dev, "%s()\n", __func__);
  706. genpd = dev_to_genpd(dev);
  707. if (IS_ERR(genpd))
  708. return -EINVAL;
  709. if (genpd->dev_ops.stop && genpd->dev_ops.start)
  710. ret = pm_runtime_force_resume(dev);
  711. return ret;
  712. }
  713. /**
  714. * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
  715. * @dev: Device to resume.
  716. *
  717. * Make sure the domain will be in the same power state as before the
  718. * hibernation the system is resuming from and start the device if necessary.
  719. */
  720. static int pm_genpd_restore_noirq(struct device *dev)
  721. {
  722. struct generic_pm_domain *genpd;
  723. int ret = 0;
  724. dev_dbg(dev, "%s()\n", __func__);
  725. genpd = dev_to_genpd(dev);
  726. if (IS_ERR(genpd))
  727. return -EINVAL;
  728. /*
  729. * Since all of the "noirq" callbacks are executed sequentially, it is
  730. * guaranteed that this function will never run twice in parallel for
  731. * the same PM domain, so it is not necessary to use locking here.
  732. *
  733. * At this point suspended_count == 0 means we are being run for the
  734. * first time for the given domain in the present cycle.
  735. */
  736. if (genpd->suspended_count++ == 0)
  737. /*
  738. * The boot kernel might put the domain into arbitrary state,
  739. * so make it appear as powered off to pm_genpd_sync_poweron(),
  740. * so that it tries to power it on in case it was really off.
  741. */
  742. genpd->status = GPD_STATE_POWER_OFF;
  743. pm_genpd_sync_poweron(genpd, true);
  744. if (genpd->dev_ops.stop && genpd->dev_ops.start)
  745. ret = pm_runtime_force_resume(dev);
  746. return ret;
  747. }
  748. /**
  749. * pm_genpd_complete - Complete power transition of a device in a power domain.
  750. * @dev: Device to complete the transition of.
  751. *
  752. * Complete a power transition of a device (during a system-wide power
  753. * transition) under the assumption that its pm_domain field points to the
  754. * domain member of an object of type struct generic_pm_domain representing
  755. * a power domain consisting of I/O devices.
  756. */
  757. static void pm_genpd_complete(struct device *dev)
  758. {
  759. struct generic_pm_domain *genpd;
  760. dev_dbg(dev, "%s()\n", __func__);
  761. genpd = dev_to_genpd(dev);
  762. if (IS_ERR(genpd))
  763. return;
  764. pm_generic_complete(dev);
  765. mutex_lock(&genpd->lock);
  766. genpd->prepared_count--;
  767. if (!genpd->prepared_count)
  768. genpd_queue_power_off_work(genpd);
  769. mutex_unlock(&genpd->lock);
  770. }
  771. /**
  772. * genpd_syscore_switch - Switch power during system core suspend or resume.
  773. * @dev: Device that normally is marked as "always on" to switch power for.
  774. *
  775. * This routine may only be called during the system core (syscore) suspend or
  776. * resume phase for devices whose "always on" flags are set.
  777. */
  778. static void genpd_syscore_switch(struct device *dev, bool suspend)
  779. {
  780. struct generic_pm_domain *genpd;
  781. genpd = dev_to_genpd(dev);
  782. if (!pm_genpd_present(genpd))
  783. return;
  784. if (suspend) {
  785. genpd->suspended_count++;
  786. pm_genpd_sync_poweroff(genpd, false);
  787. } else {
  788. pm_genpd_sync_poweron(genpd, false);
  789. genpd->suspended_count--;
  790. }
  791. }
  792. void pm_genpd_syscore_poweroff(struct device *dev)
  793. {
  794. genpd_syscore_switch(dev, true);
  795. }
  796. EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);
  797. void pm_genpd_syscore_poweron(struct device *dev)
  798. {
  799. genpd_syscore_switch(dev, false);
  800. }
  801. EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
  802. #else /* !CONFIG_PM_SLEEP */
  803. #define pm_genpd_prepare NULL
  804. #define pm_genpd_suspend_noirq NULL
  805. #define pm_genpd_resume_noirq NULL
  806. #define pm_genpd_freeze_noirq NULL
  807. #define pm_genpd_thaw_noirq NULL
  808. #define pm_genpd_restore_noirq NULL
  809. #define pm_genpd_complete NULL
  810. #endif /* CONFIG_PM_SLEEP */
  811. static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev,
  812. struct generic_pm_domain *genpd,
  813. struct gpd_timing_data *td)
  814. {
  815. struct generic_pm_domain_data *gpd_data;
  816. int ret;
  817. ret = dev_pm_get_subsys_data(dev);
  818. if (ret)
  819. return ERR_PTR(ret);
  820. gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
  821. if (!gpd_data) {
  822. ret = -ENOMEM;
  823. goto err_put;
  824. }
  825. if (td)
  826. gpd_data->td = *td;
  827. gpd_data->base.dev = dev;
  828. gpd_data->td.constraint_changed = true;
  829. gpd_data->td.effective_constraint_ns = -1;
  830. gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
  831. spin_lock_irq(&dev->power.lock);
  832. if (dev->power.subsys_data->domain_data) {
  833. ret = -EINVAL;
  834. goto err_free;
  835. }
  836. dev->power.subsys_data->domain_data = &gpd_data->base;
  837. spin_unlock_irq(&dev->power.lock);
  838. dev_pm_domain_set(dev, &genpd->domain);
  839. return gpd_data;
  840. err_free:
  841. spin_unlock_irq(&dev->power.lock);
  842. kfree(gpd_data);
  843. err_put:
  844. dev_pm_put_subsys_data(dev);
  845. return ERR_PTR(ret);
  846. }
  847. static void genpd_free_dev_data(struct device *dev,
  848. struct generic_pm_domain_data *gpd_data)
  849. {
  850. dev_pm_domain_set(dev, NULL);
  851. spin_lock_irq(&dev->power.lock);
  852. dev->power.subsys_data->domain_data = NULL;
  853. spin_unlock_irq(&dev->power.lock);
  854. kfree(gpd_data);
  855. dev_pm_put_subsys_data(dev);
  856. }
  857. /**
  858. * __pm_genpd_add_device - Add a device to an I/O PM domain.
  859. * @genpd: PM domain to add the device to.
  860. * @dev: Device to be added.
  861. * @td: Set of PM QoS timing parameters to attach to the device.
  862. */
  863. int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
  864. struct gpd_timing_data *td)
  865. {
  866. struct generic_pm_domain_data *gpd_data;
  867. int ret = 0;
  868. dev_dbg(dev, "%s()\n", __func__);
  869. if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
  870. return -EINVAL;
  871. gpd_data = genpd_alloc_dev_data(dev, genpd, td);
  872. if (IS_ERR(gpd_data))
  873. return PTR_ERR(gpd_data);
  874. mutex_lock(&genpd->lock);
  875. if (genpd->prepared_count > 0) {
  876. ret = -EAGAIN;
  877. goto out;
  878. }
  879. ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
  880. if (ret)
  881. goto out;
  882. genpd->device_count++;
  883. genpd->max_off_time_changed = true;
  884. list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
  885. out:
  886. mutex_unlock(&genpd->lock);
  887. if (ret)
  888. genpd_free_dev_data(dev, gpd_data);
  889. else
  890. dev_pm_qos_add_notifier(dev, &gpd_data->nb);
  891. return ret;
  892. }
  893. EXPORT_SYMBOL_GPL(__pm_genpd_add_device);
  894. /**
  895. * pm_genpd_remove_device - Remove a device from an I/O PM domain.
  896. * @genpd: PM domain to remove the device from.
  897. * @dev: Device to be removed.
  898. */
  899. int pm_genpd_remove_device(struct generic_pm_domain *genpd,
  900. struct device *dev)
  901. {
  902. struct generic_pm_domain_data *gpd_data;
  903. struct pm_domain_data *pdd;
  904. int ret = 0;
  905. dev_dbg(dev, "%s()\n", __func__);
  906. if (!genpd || genpd != pm_genpd_lookup_dev(dev))
  907. return -EINVAL;
  908. /* The above validation also means we have existing domain_data. */
  909. pdd = dev->power.subsys_data->domain_data;
  910. gpd_data = to_gpd_data(pdd);
  911. dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
  912. mutex_lock(&genpd->lock);
  913. if (genpd->prepared_count > 0) {
  914. ret = -EAGAIN;
  915. goto out;
  916. }
  917. genpd->device_count--;
  918. genpd->max_off_time_changed = true;
  919. if (genpd->detach_dev)
  920. genpd->detach_dev(genpd, dev);
  921. list_del_init(&pdd->list_node);
  922. mutex_unlock(&genpd->lock);
  923. genpd_free_dev_data(dev, gpd_data);
  924. return 0;
  925. out:
  926. mutex_unlock(&genpd->lock);
  927. dev_pm_qos_add_notifier(dev, &gpd_data->nb);
  928. return ret;
  929. }
  930. EXPORT_SYMBOL_GPL(pm_genpd_remove_device);
  931. /**
  932. * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
  933. * @genpd: Master PM domain to add the subdomain to.
  934. * @subdomain: Subdomain to be added.
  935. */
  936. int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
  937. struct generic_pm_domain *subdomain)
  938. {
  939. struct gpd_link *link, *itr;
  940. int ret = 0;
  941. if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
  942. || genpd == subdomain)
  943. return -EINVAL;
  944. link = kzalloc(sizeof(*link), GFP_KERNEL);
  945. if (!link)
  946. return -ENOMEM;
  947. mutex_lock(&subdomain->lock);
  948. mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
  949. if (genpd->status == GPD_STATE_POWER_OFF
  950. && subdomain->status != GPD_STATE_POWER_OFF) {
  951. ret = -EINVAL;
  952. goto out;
  953. }
  954. list_for_each_entry(itr, &genpd->master_links, master_node) {
  955. if (itr->slave == subdomain && itr->master == genpd) {
  956. ret = -EINVAL;
  957. goto out;
  958. }
  959. }
  960. link->master = genpd;
  961. list_add_tail(&link->master_node, &genpd->master_links);
  962. link->slave = subdomain;
  963. list_add_tail(&link->slave_node, &subdomain->slave_links);
  964. if (subdomain->status != GPD_STATE_POWER_OFF)
  965. genpd_sd_counter_inc(genpd);
  966. out:
  967. mutex_unlock(&genpd->lock);
  968. mutex_unlock(&subdomain->lock);
  969. if (ret)
  970. kfree(link);
  971. return ret;
  972. }
  973. EXPORT_SYMBOL_GPL(pm_genpd_add_subdomain);
  974. /**
  975. * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
  976. * @genpd: Master PM domain to remove the subdomain from.
  977. * @subdomain: Subdomain to be removed.
  978. */
  979. int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
  980. struct generic_pm_domain *subdomain)
  981. {
  982. struct gpd_link *link;
  983. int ret = -EINVAL;
  984. if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
  985. return -EINVAL;
  986. mutex_lock(&subdomain->lock);
  987. mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
  988. if (!list_empty(&subdomain->master_links) || subdomain->device_count) {
  989. pr_warn("%s: unable to remove subdomain %s\n", genpd->name,
  990. subdomain->name);
  991. ret = -EBUSY;
  992. goto out;
  993. }
  994. list_for_each_entry(link, &genpd->master_links, master_node) {
  995. if (link->slave != subdomain)
  996. continue;
  997. list_del(&link->master_node);
  998. list_del(&link->slave_node);
  999. kfree(link);
  1000. if (subdomain->status != GPD_STATE_POWER_OFF)
  1001. genpd_sd_counter_dec(genpd);
  1002. ret = 0;
  1003. break;
  1004. }
  1005. out:
  1006. mutex_unlock(&genpd->lock);
  1007. mutex_unlock(&subdomain->lock);
  1008. return ret;
  1009. }
  1010. EXPORT_SYMBOL_GPL(pm_genpd_remove_subdomain);
  1011. /**
  1012. * pm_genpd_init - Initialize a generic I/O PM domain object.
  1013. * @genpd: PM domain object to initialize.
  1014. * @gov: PM domain governor to associate with the domain (may be NULL).
  1015. * @is_off: Initial value of the domain's power_is_off field.
  1016. *
  1017. * Returns 0 on successful initialization, else a negative error code.
  1018. */
  1019. int pm_genpd_init(struct generic_pm_domain *genpd,
  1020. struct dev_power_governor *gov, bool is_off)
  1021. {
  1022. if (IS_ERR_OR_NULL(genpd))
  1023. return -EINVAL;
  1024. INIT_LIST_HEAD(&genpd->master_links);
  1025. INIT_LIST_HEAD(&genpd->slave_links);
  1026. INIT_LIST_HEAD(&genpd->dev_list);
  1027. mutex_init(&genpd->lock);
  1028. genpd->gov = gov;
  1029. INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
  1030. atomic_set(&genpd->sd_count, 0);
  1031. genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
  1032. genpd->device_count = 0;
  1033. genpd->max_off_time_ns = -1;
  1034. genpd->max_off_time_changed = true;
  1035. genpd->domain.ops.runtime_suspend = genpd_runtime_suspend;
  1036. genpd->domain.ops.runtime_resume = genpd_runtime_resume;
  1037. genpd->domain.ops.prepare = pm_genpd_prepare;
  1038. genpd->domain.ops.suspend = pm_generic_suspend;
  1039. genpd->domain.ops.suspend_late = pm_generic_suspend_late;
  1040. genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
  1041. genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
  1042. genpd->domain.ops.resume_early = pm_generic_resume_early;
  1043. genpd->domain.ops.resume = pm_generic_resume;
  1044. genpd->domain.ops.freeze = pm_generic_freeze;
  1045. genpd->domain.ops.freeze_late = pm_generic_freeze_late;
  1046. genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
  1047. genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
  1048. genpd->domain.ops.thaw_early = pm_generic_thaw_early;
  1049. genpd->domain.ops.thaw = pm_generic_thaw;
  1050. genpd->domain.ops.poweroff = pm_generic_poweroff;
  1051. genpd->domain.ops.poweroff_late = pm_generic_poweroff_late;
  1052. genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
  1053. genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
  1054. genpd->domain.ops.restore_early = pm_generic_restore_early;
  1055. genpd->domain.ops.restore = pm_generic_restore;
  1056. genpd->domain.ops.complete = pm_genpd_complete;
  1057. if (genpd->flags & GENPD_FLAG_PM_CLK) {
  1058. genpd->dev_ops.stop = pm_clk_suspend;
  1059. genpd->dev_ops.start = pm_clk_resume;
  1060. }
  1061. if (genpd->state_idx >= GENPD_MAX_NUM_STATES) {
  1062. pr_warn("Initial state index out of bounds.\n");
  1063. genpd->state_idx = GENPD_MAX_NUM_STATES - 1;
  1064. }
  1065. if (genpd->state_count > GENPD_MAX_NUM_STATES) {
  1066. pr_warn("Limiting states to %d\n", GENPD_MAX_NUM_STATES);
  1067. genpd->state_count = GENPD_MAX_NUM_STATES;
  1068. }
  1069. /* Use only one "off" state if there were no states declared */
  1070. if (genpd->state_count == 0)
  1071. genpd->state_count = 1;
  1072. mutex_lock(&gpd_list_lock);
  1073. list_add(&genpd->gpd_list_node, &gpd_list);
  1074. mutex_unlock(&gpd_list_lock);
  1075. return 0;
  1076. }
  1077. EXPORT_SYMBOL_GPL(pm_genpd_init);
  1078. #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
  1079. /*
  1080. * Device Tree based PM domain providers.
  1081. *
  1082. * The code below implements generic device tree based PM domain providers that
  1083. * bind device tree nodes with generic PM domains registered in the system.
  1084. *
  1085. * Any driver that registers generic PM domains and needs to support binding of
  1086. * devices to these domains is supposed to register a PM domain provider, which
  1087. * maps a PM domain specifier retrieved from the device tree to a PM domain.
  1088. *
  1089. * Two simple mapping functions have been provided for convenience:
  1090. * - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
  1091. * - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
  1092. * index.
  1093. */
  1094. /**
  1095. * struct of_genpd_provider - PM domain provider registration structure
  1096. * @link: Entry in global list of PM domain providers
  1097. * @node: Pointer to device tree node of PM domain provider
  1098. * @xlate: Provider-specific xlate callback mapping a set of specifier cells
  1099. * into a PM domain.
  1100. * @data: context pointer to be passed into @xlate callback
  1101. */
  1102. struct of_genpd_provider {
  1103. struct list_head link;
  1104. struct device_node *node;
  1105. genpd_xlate_t xlate;
  1106. void *data;
  1107. };
  1108. /* List of registered PM domain providers. */
  1109. static LIST_HEAD(of_genpd_providers);
  1110. /* Mutex to protect the list above. */
  1111. static DEFINE_MUTEX(of_genpd_mutex);
  1112. /**
  1113. * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
  1114. * @genpdspec: OF phandle args to map into a PM domain
  1115. * @data: xlate function private data - pointer to struct generic_pm_domain
  1116. *
  1117. * This is a generic xlate function that can be used to model PM domains that
  1118. * have their own device tree nodes. The private data of xlate function needs
  1119. * to be a valid pointer to struct generic_pm_domain.
  1120. */
  1121. struct generic_pm_domain *__of_genpd_xlate_simple(
  1122. struct of_phandle_args *genpdspec,
  1123. void *data)
  1124. {
  1125. if (genpdspec->args_count != 0)
  1126. return ERR_PTR(-EINVAL);
  1127. return data;
  1128. }
  1129. EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple);
  1130. /**
  1131. * __of_genpd_xlate_onecell() - Xlate function using a single index.
  1132. * @genpdspec: OF phandle args to map into a PM domain
  1133. * @data: xlate function private data - pointer to struct genpd_onecell_data
  1134. *
  1135. * This is a generic xlate function that can be used to model simple PM domain
  1136. * controllers that have one device tree node and provide multiple PM domains.
  1137. * A single cell is used as an index into an array of PM domains specified in
  1138. * the genpd_onecell_data struct when registering the provider.
  1139. */
  1140. struct generic_pm_domain *__of_genpd_xlate_onecell(
  1141. struct of_phandle_args *genpdspec,
  1142. void *data)
  1143. {
  1144. struct genpd_onecell_data *genpd_data = data;
  1145. unsigned int idx = genpdspec->args[0];
  1146. if (genpdspec->args_count != 1)
  1147. return ERR_PTR(-EINVAL);
  1148. if (idx >= genpd_data->num_domains) {
  1149. pr_err("%s: invalid domain index %u\n", __func__, idx);
  1150. return ERR_PTR(-EINVAL);
  1151. }
  1152. if (!genpd_data->domains[idx])
  1153. return ERR_PTR(-ENOENT);
  1154. return genpd_data->domains[idx];
  1155. }
  1156. EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell);
  1157. /**
  1158. * __of_genpd_add_provider() - Register a PM domain provider for a node
  1159. * @np: Device node pointer associated with the PM domain provider.
  1160. * @xlate: Callback for decoding PM domain from phandle arguments.
  1161. * @data: Context pointer for @xlate callback.
  1162. */
  1163. int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
  1164. void *data)
  1165. {
  1166. struct of_genpd_provider *cp;
  1167. cp = kzalloc(sizeof(*cp), GFP_KERNEL);
  1168. if (!cp)
  1169. return -ENOMEM;
  1170. cp->node = of_node_get(np);
  1171. cp->data = data;
  1172. cp->xlate = xlate;
  1173. mutex_lock(&of_genpd_mutex);
  1174. list_add(&cp->link, &of_genpd_providers);
  1175. mutex_unlock(&of_genpd_mutex);
  1176. pr_debug("Added domain provider from %s\n", np->full_name);
  1177. return 0;
  1178. }
  1179. EXPORT_SYMBOL_GPL(__of_genpd_add_provider);
  1180. /**
  1181. * of_genpd_del_provider() - Remove a previously registered PM domain provider
  1182. * @np: Device node pointer associated with the PM domain provider
  1183. */
  1184. void of_genpd_del_provider(struct device_node *np)
  1185. {
  1186. struct of_genpd_provider *cp;
  1187. mutex_lock(&of_genpd_mutex);
  1188. list_for_each_entry(cp, &of_genpd_providers, link) {
  1189. if (cp->node == np) {
  1190. list_del(&cp->link);
  1191. of_node_put(cp->node);
  1192. kfree(cp);
  1193. break;
  1194. }
  1195. }
  1196. mutex_unlock(&of_genpd_mutex);
  1197. }
  1198. EXPORT_SYMBOL_GPL(of_genpd_del_provider);
  1199. /**
  1200. * of_genpd_get_from_provider() - Look-up PM domain
  1201. * @genpdspec: OF phandle args to use for look-up
  1202. *
  1203. * Looks for a PM domain provider under the node specified by @genpdspec and if
  1204. * found, uses xlate function of the provider to map phandle args to a PM
  1205. * domain.
  1206. *
  1207. * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
  1208. * on failure.
  1209. */
  1210. struct generic_pm_domain *of_genpd_get_from_provider(
  1211. struct of_phandle_args *genpdspec)
  1212. {
  1213. struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
  1214. struct of_genpd_provider *provider;
  1215. if (!genpdspec)
  1216. return ERR_PTR(-EINVAL);
  1217. mutex_lock(&of_genpd_mutex);
  1218. /* Check if we have such a provider in our array */
  1219. list_for_each_entry(provider, &of_genpd_providers, link) {
  1220. if (provider->node == genpdspec->np)
  1221. genpd = provider->xlate(genpdspec, provider->data);
  1222. if (!IS_ERR(genpd))
  1223. break;
  1224. }
  1225. mutex_unlock(&of_genpd_mutex);
  1226. return genpd;
  1227. }
  1228. EXPORT_SYMBOL_GPL(of_genpd_get_from_provider);
  1229. /**
  1230. * genpd_dev_pm_detach - Detach a device from its PM domain.
  1231. * @dev: Device to detach.
  1232. * @power_off: Currently not used
  1233. *
  1234. * Try to locate a corresponding generic PM domain, which the device was
  1235. * attached to previously. If such is found, the device is detached from it.
  1236. */
  1237. static void genpd_dev_pm_detach(struct device *dev, bool power_off)
  1238. {
  1239. struct generic_pm_domain *pd;
  1240. unsigned int i;
  1241. int ret = 0;
  1242. pd = pm_genpd_lookup_dev(dev);
  1243. if (!pd)
  1244. return;
  1245. dev_dbg(dev, "removing from PM domain %s\n", pd->name);
  1246. for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
  1247. ret = pm_genpd_remove_device(pd, dev);
  1248. if (ret != -EAGAIN)
  1249. break;
  1250. mdelay(i);
  1251. cond_resched();
  1252. }
  1253. if (ret < 0) {
  1254. dev_err(dev, "failed to remove from PM domain %s: %d",
  1255. pd->name, ret);
  1256. return;
  1257. }
  1258. /* Check if PM domain can be powered off after removing this device. */
  1259. genpd_queue_power_off_work(pd);
  1260. }
  1261. static void genpd_dev_pm_sync(struct device *dev)
  1262. {
  1263. struct generic_pm_domain *pd;
  1264. pd = dev_to_genpd(dev);
  1265. if (IS_ERR(pd))
  1266. return;
  1267. genpd_queue_power_off_work(pd);
  1268. }
  1269. /**
  1270. * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
  1271. * @dev: Device to attach.
  1272. *
  1273. * Parse device's OF node to find a PM domain specifier. If such is found,
  1274. * attaches the device to retrieved pm_domain ops.
  1275. *
  1276. * Both generic and legacy Samsung-specific DT bindings are supported to keep
  1277. * backwards compatibility with existing DTBs.
  1278. *
  1279. * Returns 0 on successfully attached PM domain or negative error code. Note
  1280. * that if a power-domain exists for the device, but it cannot be found or
  1281. * turned on, then return -EPROBE_DEFER to ensure that the device is not
  1282. * probed and to re-try again later.
  1283. */
  1284. int genpd_dev_pm_attach(struct device *dev)
  1285. {
  1286. struct of_phandle_args pd_args;
  1287. struct generic_pm_domain *pd;
  1288. unsigned int i;
  1289. int ret;
  1290. if (!dev->of_node)
  1291. return -ENODEV;
  1292. if (dev->pm_domain)
  1293. return -EEXIST;
  1294. ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
  1295. "#power-domain-cells", 0, &pd_args);
  1296. if (ret < 0) {
  1297. if (ret != -ENOENT)
  1298. return ret;
  1299. /*
  1300. * Try legacy Samsung-specific bindings
  1301. * (for backwards compatibility of DT ABI)
  1302. */
  1303. pd_args.args_count = 0;
  1304. pd_args.np = of_parse_phandle(dev->of_node,
  1305. "samsung,power-domain", 0);
  1306. if (!pd_args.np)
  1307. return -ENOENT;
  1308. }
  1309. pd = of_genpd_get_from_provider(&pd_args);
  1310. of_node_put(pd_args.np);
  1311. if (IS_ERR(pd)) {
  1312. dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
  1313. __func__, PTR_ERR(pd));
  1314. return -EPROBE_DEFER;
  1315. }
  1316. dev_dbg(dev, "adding to PM domain %s\n", pd->name);
  1317. for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
  1318. ret = pm_genpd_add_device(pd, dev);
  1319. if (ret != -EAGAIN)
  1320. break;
  1321. mdelay(i);
  1322. cond_resched();
  1323. }
  1324. if (ret < 0) {
  1325. dev_err(dev, "failed to add to PM domain %s: %d",
  1326. pd->name, ret);
  1327. goto out;
  1328. }
  1329. dev->pm_domain->detach = genpd_dev_pm_detach;
  1330. dev->pm_domain->sync = genpd_dev_pm_sync;
  1331. mutex_lock(&pd->lock);
  1332. ret = genpd_poweron(pd, 0);
  1333. mutex_unlock(&pd->lock);
  1334. out:
  1335. return ret ? -EPROBE_DEFER : 0;
  1336. }
  1337. EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
  1338. #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
  1339. /*** debugfs support ***/
  1340. #ifdef CONFIG_PM_ADVANCED_DEBUG
  1341. #include <linux/pm.h>
  1342. #include <linux/device.h>
  1343. #include <linux/debugfs.h>
  1344. #include <linux/seq_file.h>
  1345. #include <linux/init.h>
  1346. #include <linux/kobject.h>
  1347. static struct dentry *pm_genpd_debugfs_dir;
  1348. /*
  1349. * TODO: This function is a slightly modified version of rtpm_status_show
  1350. * from sysfs.c, so generalize it.
  1351. */
  1352. static void rtpm_status_str(struct seq_file *s, struct device *dev)
  1353. {
  1354. static const char * const status_lookup[] = {
  1355. [RPM_ACTIVE] = "active",
  1356. [RPM_RESUMING] = "resuming",
  1357. [RPM_SUSPENDED] = "suspended",
  1358. [RPM_SUSPENDING] = "suspending"
  1359. };
  1360. const char *p = "";
  1361. if (dev->power.runtime_error)
  1362. p = "error";
  1363. else if (dev->power.disable_depth)
  1364. p = "unsupported";
  1365. else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
  1366. p = status_lookup[dev->power.runtime_status];
  1367. else
  1368. WARN_ON(1);
  1369. seq_puts(s, p);
  1370. }
  1371. static int pm_genpd_summary_one(struct seq_file *s,
  1372. struct generic_pm_domain *genpd)
  1373. {
  1374. static const char * const status_lookup[] = {
  1375. [GPD_STATE_ACTIVE] = "on",
  1376. [GPD_STATE_POWER_OFF] = "off"
  1377. };
  1378. struct pm_domain_data *pm_data;
  1379. const char *kobj_path;
  1380. struct gpd_link *link;
  1381. char state[16];
  1382. int ret;
  1383. ret = mutex_lock_interruptible(&genpd->lock);
  1384. if (ret)
  1385. return -ERESTARTSYS;
  1386. if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
  1387. goto exit;
  1388. if (genpd->status == GPD_STATE_POWER_OFF)
  1389. snprintf(state, sizeof(state), "%s-%u",
  1390. status_lookup[genpd->status], genpd->state_idx);
  1391. else
  1392. snprintf(state, sizeof(state), "%s",
  1393. status_lookup[genpd->status]);
  1394. seq_printf(s, "%-30s %-15s ", genpd->name, state);
  1395. /*
  1396. * Modifications on the list require holding locks on both
  1397. * master and slave, so we are safe.
  1398. * Also genpd->name is immutable.
  1399. */
  1400. list_for_each_entry(link, &genpd->master_links, master_node) {
  1401. seq_printf(s, "%s", link->slave->name);
  1402. if (!list_is_last(&link->master_node, &genpd->master_links))
  1403. seq_puts(s, ", ");
  1404. }
  1405. list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
  1406. kobj_path = kobject_get_path(&pm_data->dev->kobj, GFP_KERNEL);
  1407. if (kobj_path == NULL)
  1408. continue;
  1409. seq_printf(s, "\n %-50s ", kobj_path);
  1410. rtpm_status_str(s, pm_data->dev);
  1411. kfree(kobj_path);
  1412. }
  1413. seq_puts(s, "\n");
  1414. exit:
  1415. mutex_unlock(&genpd->lock);
  1416. return 0;
  1417. }
  1418. static int pm_genpd_summary_show(struct seq_file *s, void *data)
  1419. {
  1420. struct generic_pm_domain *genpd;
  1421. int ret = 0;
  1422. seq_puts(s, "domain status slaves\n");
  1423. seq_puts(s, " /device runtime status\n");
  1424. seq_puts(s, "----------------------------------------------------------------------\n");
  1425. ret = mutex_lock_interruptible(&gpd_list_lock);
  1426. if (ret)
  1427. return -ERESTARTSYS;
  1428. list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
  1429. ret = pm_genpd_summary_one(s, genpd);
  1430. if (ret)
  1431. break;
  1432. }
  1433. mutex_unlock(&gpd_list_lock);
  1434. return ret;
  1435. }
  1436. static int pm_genpd_summary_open(struct inode *inode, struct file *file)
  1437. {
  1438. return single_open(file, pm_genpd_summary_show, NULL);
  1439. }
  1440. static const struct file_operations pm_genpd_summary_fops = {
  1441. .open = pm_genpd_summary_open,
  1442. .read = seq_read,
  1443. .llseek = seq_lseek,
  1444. .release = single_release,
  1445. };
  1446. static int __init pm_genpd_debug_init(void)
  1447. {
  1448. struct dentry *d;
  1449. pm_genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
  1450. if (!pm_genpd_debugfs_dir)
  1451. return -ENOMEM;
  1452. d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
  1453. pm_genpd_debugfs_dir, NULL, &pm_genpd_summary_fops);
  1454. if (!d)
  1455. return -ENOMEM;
  1456. return 0;
  1457. }
  1458. late_initcall(pm_genpd_debug_init);
  1459. static void __exit pm_genpd_debug_exit(void)
  1460. {
  1461. debugfs_remove_recursive(pm_genpd_debugfs_dir);
  1462. }
  1463. __exitcall(pm_genpd_debug_exit);
  1464. #endif /* CONFIG_PM_ADVANCED_DEBUG */