gpiolib.c 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883
  1. #include <linux/kernel.h>
  2. #include <linux/module.h>
  3. #include <linux/interrupt.h>
  4. #include <linux/irq.h>
  5. #include <linux/spinlock.h>
  6. #include <linux/device.h>
  7. #include <linux/err.h>
  8. #include <linux/debugfs.h>
  9. #include <linux/seq_file.h>
  10. #include <linux/gpio.h>
  11. #include <linux/of_gpio.h>
  12. #include <linux/idr.h>
  13. #include <linux/slab.h>
  14. #define CREATE_TRACE_POINTS
  15. #include <trace/events/gpio.h>
  16. /* Optional implementation infrastructure for GPIO interfaces.
  17. *
  18. * Platforms may want to use this if they tend to use very many GPIOs
  19. * that aren't part of a System-On-Chip core; or across I2C/SPI/etc.
  20. *
  21. * When kernel footprint or instruction count is an issue, simpler
  22. * implementations may be preferred. The GPIO programming interface
  23. * allows for inlining speed-critical get/set operations for common
  24. * cases, so that access to SOC-integrated GPIOs can sometimes cost
  25. * only an instruction or two per bit.
  26. */
  27. /* When debugging, extend minimal trust to callers and platform code.
  28. * Also emit diagnostic messages that may help initial bringup, when
  29. * board setup or driver bugs are most common.
  30. *
  31. * Otherwise, minimize overhead in what may be bitbanging codepaths.
  32. */
  33. #ifdef DEBUG
  34. #define extra_checks 1
  35. #else
  36. #define extra_checks 0
  37. #endif
  38. /* gpio_lock prevents conflicts during gpio_desc[] table updates.
  39. * While any GPIO is requested, its gpio_chip is not removable;
  40. * each GPIO's "requested" flag serves as a lock and refcount.
  41. */
  42. static DEFINE_SPINLOCK(gpio_lock);
  43. struct gpio_desc {
  44. struct gpio_chip *chip;
  45. unsigned long flags;
  46. /* flag symbols are bit numbers */
  47. #define FLAG_REQUESTED 0
  48. #define FLAG_IS_OUT 1
  49. #define FLAG_RESERVED 2
  50. #define FLAG_EXPORT 3 /* protected by sysfs_lock */
  51. #define FLAG_SYSFS 4 /* exported via /sys/class/gpio/control */
  52. #define FLAG_TRIG_FALL 5 /* trigger on falling edge */
  53. #define FLAG_TRIG_RISE 6 /* trigger on rising edge */
  54. #define FLAG_ACTIVE_LOW 7 /* sysfs value has active low */
  55. #define FLAG_OPEN_DRAIN 8 /* Gpio is open drain type */
  56. #define FLAG_OPEN_SOURCE 9 /* Gpio is open source type */
  57. #define ID_SHIFT 16 /* add new flags before this one */
  58. #define GPIO_FLAGS_MASK ((1 << ID_SHIFT) - 1)
  59. #define GPIO_TRIGGER_MASK (BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
  60. #ifdef CONFIG_DEBUG_FS
  61. const char *label;
  62. #endif
  63. };
  64. static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];
  65. #ifdef CONFIG_GPIO_SYSFS
  66. static DEFINE_IDR(dirent_idr);
  67. #endif
  68. static inline void desc_set_label(struct gpio_desc *d, const char *label)
  69. {
  70. #ifdef CONFIG_DEBUG_FS
  71. d->label = label;
  72. #endif
  73. }
  74. /* Warn when drivers omit gpio_request() calls -- legal but ill-advised
  75. * when setting direction, and otherwise illegal. Until board setup code
  76. * and drivers use explicit requests everywhere (which won't happen when
  77. * those calls have no teeth) we can't avoid autorequesting. This nag
  78. * message should motivate switching to explicit requests... so should
  79. * the weaker cleanup after faults, compared to gpio_request().
  80. *
  81. * NOTE: the autorequest mechanism is going away; at this point it's
  82. * only "legal" in the sense that (old) code using it won't break yet,
  83. * but instead only triggers a WARN() stack dump.
  84. */
  85. static int gpio_ensure_requested(struct gpio_desc *desc, unsigned offset)
  86. {
  87. const struct gpio_chip *chip = desc->chip;
  88. const int gpio = chip->base + offset;
  89. if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
  90. "autorequest GPIO-%d\n", gpio)) {
  91. if (!try_module_get(chip->owner)) {
  92. pr_err("GPIO-%d: module can't be gotten \n", gpio);
  93. clear_bit(FLAG_REQUESTED, &desc->flags);
  94. /* lose */
  95. return -EIO;
  96. }
  97. desc_set_label(desc, "[auto]");
  98. /* caller must chip->request() w/o spinlock */
  99. if (chip->request)
  100. return 1;
  101. }
  102. return 0;
  103. }
  104. /* caller holds gpio_lock *OR* gpio is marked as requested */
  105. struct gpio_chip *gpio_to_chip(unsigned gpio)
  106. {
  107. return gpio_desc[gpio].chip;
  108. }
  109. /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
  110. static int gpiochip_find_base(int ngpio)
  111. {
  112. int i;
  113. int spare = 0;
  114. int base = -ENOSPC;
  115. for (i = ARCH_NR_GPIOS - 1; i >= 0 ; i--) {
  116. struct gpio_desc *desc = &gpio_desc[i];
  117. struct gpio_chip *chip = desc->chip;
  118. if (!chip && !test_bit(FLAG_RESERVED, &desc->flags)) {
  119. spare++;
  120. if (spare == ngpio) {
  121. base = i;
  122. break;
  123. }
  124. } else {
  125. spare = 0;
  126. if (chip)
  127. i -= chip->ngpio - 1;
  128. }
  129. }
  130. if (gpio_is_valid(base))
  131. pr_debug("%s: found new base at %d\n", __func__, base);
  132. return base;
  133. }
  134. /**
  135. * gpiochip_reserve() - reserve range of gpios to use with platform code only
  136. * @start: starting gpio number
  137. * @ngpio: number of gpios to reserve
  138. * Context: platform init, potentially before irqs or kmalloc will work
  139. *
  140. * Returns a negative errno if any gpio within the range is already reserved
  141. * or registered, else returns zero as a success code. Use this function
  142. * to mark a range of gpios as unavailable for dynamic gpio number allocation,
  143. * for example because its driver support is not yet loaded.
  144. */
  145. int __init gpiochip_reserve(int start, int ngpio)
  146. {
  147. int ret = 0;
  148. unsigned long flags;
  149. int i;
  150. if (!gpio_is_valid(start) || !gpio_is_valid(start + ngpio - 1))
  151. return -EINVAL;
  152. spin_lock_irqsave(&gpio_lock, flags);
  153. for (i = start; i < start + ngpio; i++) {
  154. struct gpio_desc *desc = &gpio_desc[i];
  155. if (desc->chip || test_bit(FLAG_RESERVED, &desc->flags)) {
  156. ret = -EBUSY;
  157. goto err;
  158. }
  159. set_bit(FLAG_RESERVED, &desc->flags);
  160. }
  161. pr_debug("%s: reserved gpios from %d to %d\n",
  162. __func__, start, start + ngpio - 1);
  163. err:
  164. spin_unlock_irqrestore(&gpio_lock, flags);
  165. return ret;
  166. }
  167. #ifdef CONFIG_GPIO_SYSFS
  168. /* lock protects against unexport_gpio() being called while
  169. * sysfs files are active.
  170. */
  171. static DEFINE_MUTEX(sysfs_lock);
  172. /*
  173. * /sys/class/gpio/gpioN... only for GPIOs that are exported
  174. * /direction
  175. * * MAY BE OMITTED if kernel won't allow direction changes
  176. * * is read/write as "in" or "out"
  177. * * may also be written as "high" or "low", initializing
  178. * output value as specified ("out" implies "low")
  179. * /value
  180. * * always readable, subject to hardware behavior
  181. * * may be writable, as zero/nonzero
  182. * /edge
  183. * * configures behavior of poll(2) on /value
  184. * * available only if pin can generate IRQs on input
  185. * * is read/write as "none", "falling", "rising", or "both"
  186. * /active_low
  187. * * configures polarity of /value
  188. * * is read/write as zero/nonzero
  189. * * also affects existing and subsequent "falling" and "rising"
  190. * /edge configuration
  191. */
  192. static ssize_t gpio_direction_show(struct device *dev,
  193. struct device_attribute *attr, char *buf)
  194. {
  195. const struct gpio_desc *desc = dev_get_drvdata(dev);
  196. ssize_t status;
  197. mutex_lock(&sysfs_lock);
  198. if (!test_bit(FLAG_EXPORT, &desc->flags))
  199. status = -EIO;
  200. else
  201. status = sprintf(buf, "%s\n",
  202. test_bit(FLAG_IS_OUT, &desc->flags)
  203. ? "out" : "in");
  204. mutex_unlock(&sysfs_lock);
  205. return status;
  206. }
  207. static ssize_t gpio_direction_store(struct device *dev,
  208. struct device_attribute *attr, const char *buf, size_t size)
  209. {
  210. const struct gpio_desc *desc = dev_get_drvdata(dev);
  211. unsigned gpio = desc - gpio_desc;
  212. ssize_t status;
  213. mutex_lock(&sysfs_lock);
  214. if (!test_bit(FLAG_EXPORT, &desc->flags))
  215. status = -EIO;
  216. else if (sysfs_streq(buf, "high"))
  217. status = gpio_direction_output(gpio, 1);
  218. else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
  219. status = gpio_direction_output(gpio, 0);
  220. else if (sysfs_streq(buf, "in"))
  221. status = gpio_direction_input(gpio);
  222. else
  223. status = -EINVAL;
  224. mutex_unlock(&sysfs_lock);
  225. return status ? : size;
  226. }
  227. static /* const */ DEVICE_ATTR(direction, 0644,
  228. gpio_direction_show, gpio_direction_store);
  229. static ssize_t gpio_value_show(struct device *dev,
  230. struct device_attribute *attr, char *buf)
  231. {
  232. const struct gpio_desc *desc = dev_get_drvdata(dev);
  233. unsigned gpio = desc - gpio_desc;
  234. ssize_t status;
  235. mutex_lock(&sysfs_lock);
  236. if (!test_bit(FLAG_EXPORT, &desc->flags)) {
  237. status = -EIO;
  238. } else {
  239. int value;
  240. value = !!gpio_get_value_cansleep(gpio);
  241. if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
  242. value = !value;
  243. status = sprintf(buf, "%d\n", value);
  244. }
  245. mutex_unlock(&sysfs_lock);
  246. return status;
  247. }
  248. static ssize_t gpio_value_store(struct device *dev,
  249. struct device_attribute *attr, const char *buf, size_t size)
  250. {
  251. const struct gpio_desc *desc = dev_get_drvdata(dev);
  252. unsigned gpio = desc - gpio_desc;
  253. ssize_t status;
  254. mutex_lock(&sysfs_lock);
  255. if (!test_bit(FLAG_EXPORT, &desc->flags))
  256. status = -EIO;
  257. else if (!test_bit(FLAG_IS_OUT, &desc->flags))
  258. status = -EPERM;
  259. else {
  260. long value;
  261. status = strict_strtol(buf, 0, &value);
  262. if (status == 0) {
  263. if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
  264. value = !value;
  265. gpio_set_value_cansleep(gpio, value != 0);
  266. status = size;
  267. }
  268. }
  269. mutex_unlock(&sysfs_lock);
  270. return status;
  271. }
  272. static const DEVICE_ATTR(value, 0644,
  273. gpio_value_show, gpio_value_store);
  274. static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
  275. {
  276. struct sysfs_dirent *value_sd = priv;
  277. sysfs_notify_dirent(value_sd);
  278. return IRQ_HANDLED;
  279. }
  280. static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
  281. unsigned long gpio_flags)
  282. {
  283. struct sysfs_dirent *value_sd;
  284. unsigned long irq_flags;
  285. int ret, irq, id;
  286. if ((desc->flags & GPIO_TRIGGER_MASK) == gpio_flags)
  287. return 0;
  288. irq = gpio_to_irq(desc - gpio_desc);
  289. if (irq < 0)
  290. return -EIO;
  291. id = desc->flags >> ID_SHIFT;
  292. value_sd = idr_find(&dirent_idr, id);
  293. if (value_sd)
  294. free_irq(irq, value_sd);
  295. desc->flags &= ~GPIO_TRIGGER_MASK;
  296. if (!gpio_flags) {
  297. ret = 0;
  298. goto free_id;
  299. }
  300. irq_flags = IRQF_SHARED;
  301. if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
  302. irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
  303. IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
  304. if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
  305. irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
  306. IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
  307. if (!value_sd) {
  308. value_sd = sysfs_get_dirent(dev->kobj.sd, NULL, "value");
  309. if (!value_sd) {
  310. ret = -ENODEV;
  311. goto err_out;
  312. }
  313. do {
  314. ret = -ENOMEM;
  315. if (idr_pre_get(&dirent_idr, GFP_KERNEL))
  316. ret = idr_get_new_above(&dirent_idr, value_sd,
  317. 1, &id);
  318. } while (ret == -EAGAIN);
  319. if (ret)
  320. goto free_sd;
  321. desc->flags &= GPIO_FLAGS_MASK;
  322. desc->flags |= (unsigned long)id << ID_SHIFT;
  323. if (desc->flags >> ID_SHIFT != id) {
  324. ret = -ERANGE;
  325. goto free_id;
  326. }
  327. }
  328. ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
  329. "gpiolib", value_sd);
  330. if (ret < 0)
  331. goto free_id;
  332. desc->flags |= gpio_flags;
  333. return 0;
  334. free_id:
  335. idr_remove(&dirent_idr, id);
  336. desc->flags &= GPIO_FLAGS_MASK;
  337. free_sd:
  338. if (value_sd)
  339. sysfs_put(value_sd);
  340. err_out:
  341. return ret;
  342. }
  343. static const struct {
  344. const char *name;
  345. unsigned long flags;
  346. } trigger_types[] = {
  347. { "none", 0 },
  348. { "falling", BIT(FLAG_TRIG_FALL) },
  349. { "rising", BIT(FLAG_TRIG_RISE) },
  350. { "both", BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE) },
  351. };
  352. static ssize_t gpio_edge_show(struct device *dev,
  353. struct device_attribute *attr, char *buf)
  354. {
  355. const struct gpio_desc *desc = dev_get_drvdata(dev);
  356. ssize_t status;
  357. mutex_lock(&sysfs_lock);
  358. if (!test_bit(FLAG_EXPORT, &desc->flags))
  359. status = -EIO;
  360. else {
  361. int i;
  362. status = 0;
  363. for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
  364. if ((desc->flags & GPIO_TRIGGER_MASK)
  365. == trigger_types[i].flags) {
  366. status = sprintf(buf, "%s\n",
  367. trigger_types[i].name);
  368. break;
  369. }
  370. }
  371. mutex_unlock(&sysfs_lock);
  372. return status;
  373. }
  374. static ssize_t gpio_edge_store(struct device *dev,
  375. struct device_attribute *attr, const char *buf, size_t size)
  376. {
  377. struct gpio_desc *desc = dev_get_drvdata(dev);
  378. ssize_t status;
  379. int i;
  380. for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
  381. if (sysfs_streq(trigger_types[i].name, buf))
  382. goto found;
  383. return -EINVAL;
  384. found:
  385. mutex_lock(&sysfs_lock);
  386. if (!test_bit(FLAG_EXPORT, &desc->flags))
  387. status = -EIO;
  388. else {
  389. status = gpio_setup_irq(desc, dev, trigger_types[i].flags);
  390. if (!status)
  391. status = size;
  392. }
  393. mutex_unlock(&sysfs_lock);
  394. return status;
  395. }
  396. static DEVICE_ATTR(edge, 0644, gpio_edge_show, gpio_edge_store);
  397. static int sysfs_set_active_low(struct gpio_desc *desc, struct device *dev,
  398. int value)
  399. {
  400. int status = 0;
  401. if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
  402. return 0;
  403. if (value)
  404. set_bit(FLAG_ACTIVE_LOW, &desc->flags);
  405. else
  406. clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
  407. /* reconfigure poll(2) support if enabled on one edge only */
  408. if (dev != NULL && (!!test_bit(FLAG_TRIG_RISE, &desc->flags) ^
  409. !!test_bit(FLAG_TRIG_FALL, &desc->flags))) {
  410. unsigned long trigger_flags = desc->flags & GPIO_TRIGGER_MASK;
  411. gpio_setup_irq(desc, dev, 0);
  412. status = gpio_setup_irq(desc, dev, trigger_flags);
  413. }
  414. return status;
  415. }
  416. static ssize_t gpio_active_low_show(struct device *dev,
  417. struct device_attribute *attr, char *buf)
  418. {
  419. const struct gpio_desc *desc = dev_get_drvdata(dev);
  420. ssize_t status;
  421. mutex_lock(&sysfs_lock);
  422. if (!test_bit(FLAG_EXPORT, &desc->flags))
  423. status = -EIO;
  424. else
  425. status = sprintf(buf, "%d\n",
  426. !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
  427. mutex_unlock(&sysfs_lock);
  428. return status;
  429. }
  430. static ssize_t gpio_active_low_store(struct device *dev,
  431. struct device_attribute *attr, const char *buf, size_t size)
  432. {
  433. struct gpio_desc *desc = dev_get_drvdata(dev);
  434. ssize_t status;
  435. mutex_lock(&sysfs_lock);
  436. if (!test_bit(FLAG_EXPORT, &desc->flags)) {
  437. status = -EIO;
  438. } else {
  439. long value;
  440. status = strict_strtol(buf, 0, &value);
  441. if (status == 0)
  442. status = sysfs_set_active_low(desc, dev, value != 0);
  443. }
  444. mutex_unlock(&sysfs_lock);
  445. return status ? : size;
  446. }
  447. static const DEVICE_ATTR(active_low, 0644,
  448. gpio_active_low_show, gpio_active_low_store);
  449. static const struct attribute *gpio_attrs[] = {
  450. &dev_attr_value.attr,
  451. &dev_attr_active_low.attr,
  452. NULL,
  453. };
  454. static const struct attribute_group gpio_attr_group = {
  455. .attrs = (struct attribute **) gpio_attrs,
  456. };
  457. /*
  458. * /sys/class/gpio/gpiochipN/
  459. * /base ... matching gpio_chip.base (N)
  460. * /label ... matching gpio_chip.label
  461. * /ngpio ... matching gpio_chip.ngpio
  462. */
  463. static ssize_t chip_base_show(struct device *dev,
  464. struct device_attribute *attr, char *buf)
  465. {
  466. const struct gpio_chip *chip = dev_get_drvdata(dev);
  467. return sprintf(buf, "%d\n", chip->base);
  468. }
  469. static DEVICE_ATTR(base, 0444, chip_base_show, NULL);
  470. static ssize_t chip_label_show(struct device *dev,
  471. struct device_attribute *attr, char *buf)
  472. {
  473. const struct gpio_chip *chip = dev_get_drvdata(dev);
  474. return sprintf(buf, "%s\n", chip->label ? : "");
  475. }
  476. static DEVICE_ATTR(label, 0444, chip_label_show, NULL);
  477. static ssize_t chip_ngpio_show(struct device *dev,
  478. struct device_attribute *attr, char *buf)
  479. {
  480. const struct gpio_chip *chip = dev_get_drvdata(dev);
  481. return sprintf(buf, "%u\n", chip->ngpio);
  482. }
  483. static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);
  484. static const struct attribute *gpiochip_attrs[] = {
  485. &dev_attr_base.attr,
  486. &dev_attr_label.attr,
  487. &dev_attr_ngpio.attr,
  488. NULL,
  489. };
  490. static const struct attribute_group gpiochip_attr_group = {
  491. .attrs = (struct attribute **) gpiochip_attrs,
  492. };
  493. /*
  494. * /sys/class/gpio/export ... write-only
  495. * integer N ... number of GPIO to export (full access)
  496. * /sys/class/gpio/unexport ... write-only
  497. * integer N ... number of GPIO to unexport
  498. */
  499. static ssize_t export_store(struct class *class,
  500. struct class_attribute *attr,
  501. const char *buf, size_t len)
  502. {
  503. long gpio;
  504. int status;
  505. status = strict_strtol(buf, 0, &gpio);
  506. if (status < 0)
  507. goto done;
  508. /* No extra locking here; FLAG_SYSFS just signifies that the
  509. * request and export were done by on behalf of userspace, so
  510. * they may be undone on its behalf too.
  511. */
  512. status = gpio_request(gpio, "sysfs");
  513. if (status < 0)
  514. goto done;
  515. status = gpio_export(gpio, true);
  516. if (status < 0)
  517. gpio_free(gpio);
  518. else
  519. set_bit(FLAG_SYSFS, &gpio_desc[gpio].flags);
  520. done:
  521. if (status)
  522. pr_debug("%s: status %d\n", __func__, status);
  523. return status ? : len;
  524. }
  525. static ssize_t unexport_store(struct class *class,
  526. struct class_attribute *attr,
  527. const char *buf, size_t len)
  528. {
  529. long gpio;
  530. int status;
  531. status = strict_strtol(buf, 0, &gpio);
  532. if (status < 0)
  533. goto done;
  534. status = -EINVAL;
  535. /* reject bogus commands (gpio_unexport ignores them) */
  536. if (!gpio_is_valid(gpio))
  537. goto done;
  538. /* No extra locking here; FLAG_SYSFS just signifies that the
  539. * request and export were done by on behalf of userspace, so
  540. * they may be undone on its behalf too.
  541. */
  542. if (test_and_clear_bit(FLAG_SYSFS, &gpio_desc[gpio].flags)) {
  543. status = 0;
  544. gpio_free(gpio);
  545. }
  546. done:
  547. if (status)
  548. pr_debug("%s: status %d\n", __func__, status);
  549. return status ? : len;
  550. }
  551. static struct class_attribute gpio_class_attrs[] = {
  552. __ATTR(export, 0200, NULL, export_store),
  553. __ATTR(unexport, 0200, NULL, unexport_store),
  554. __ATTR_NULL,
  555. };
  556. static struct class gpio_class = {
  557. .name = "gpio",
  558. .owner = THIS_MODULE,
  559. .class_attrs = gpio_class_attrs,
  560. };
  561. /**
  562. * gpio_export - export a GPIO through sysfs
  563. * @gpio: gpio to make available, already requested
  564. * @direction_may_change: true if userspace may change gpio direction
  565. * Context: arch_initcall or later
  566. *
  567. * When drivers want to make a GPIO accessible to userspace after they
  568. * have requested it -- perhaps while debugging, or as part of their
  569. * public interface -- they may use this routine. If the GPIO can
  570. * change direction (some can't) and the caller allows it, userspace
  571. * will see "direction" sysfs attribute which may be used to change
  572. * the gpio's direction. A "value" attribute will always be provided.
  573. *
  574. * Returns zero on success, else an error.
  575. */
  576. int gpio_export(unsigned gpio, bool direction_may_change)
  577. {
  578. unsigned long flags;
  579. struct gpio_desc *desc;
  580. int status = -EINVAL;
  581. const char *ioname = NULL;
  582. /* can't export until sysfs is available ... */
  583. if (!gpio_class.p) {
  584. pr_debug("%s: called too early!\n", __func__);
  585. return -ENOENT;
  586. }
  587. if (!gpio_is_valid(gpio))
  588. goto done;
  589. mutex_lock(&sysfs_lock);
  590. spin_lock_irqsave(&gpio_lock, flags);
  591. desc = &gpio_desc[gpio];
  592. if (test_bit(FLAG_REQUESTED, &desc->flags)
  593. && !test_bit(FLAG_EXPORT, &desc->flags)) {
  594. status = 0;
  595. if (!desc->chip->direction_input
  596. || !desc->chip->direction_output)
  597. direction_may_change = false;
  598. }
  599. spin_unlock_irqrestore(&gpio_lock, flags);
  600. if (desc->chip->names && desc->chip->names[gpio - desc->chip->base])
  601. ioname = desc->chip->names[gpio - desc->chip->base];
  602. if (status == 0) {
  603. struct device *dev;
  604. dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
  605. desc, ioname ? ioname : "gpio%u", gpio);
  606. if (!IS_ERR(dev)) {
  607. status = sysfs_create_group(&dev->kobj,
  608. &gpio_attr_group);
  609. if (!status && direction_may_change)
  610. status = device_create_file(dev,
  611. &dev_attr_direction);
  612. if (!status && gpio_to_irq(gpio) >= 0
  613. && (direction_may_change
  614. || !test_bit(FLAG_IS_OUT,
  615. &desc->flags)))
  616. status = device_create_file(dev,
  617. &dev_attr_edge);
  618. if (status != 0)
  619. device_unregister(dev);
  620. } else
  621. status = PTR_ERR(dev);
  622. if (status == 0)
  623. set_bit(FLAG_EXPORT, &desc->flags);
  624. }
  625. mutex_unlock(&sysfs_lock);
  626. done:
  627. if (status)
  628. pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
  629. return status;
  630. }
  631. EXPORT_SYMBOL_GPL(gpio_export);
  632. static int match_export(struct device *dev, void *data)
  633. {
  634. return dev_get_drvdata(dev) == data;
  635. }
  636. /**
  637. * gpio_export_link - create a sysfs link to an exported GPIO node
  638. * @dev: device under which to create symlink
  639. * @name: name of the symlink
  640. * @gpio: gpio to create symlink to, already exported
  641. *
  642. * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
  643. * node. Caller is responsible for unlinking.
  644. *
  645. * Returns zero on success, else an error.
  646. */
  647. int gpio_export_link(struct device *dev, const char *name, unsigned gpio)
  648. {
  649. struct gpio_desc *desc;
  650. int status = -EINVAL;
  651. if (!gpio_is_valid(gpio))
  652. goto done;
  653. mutex_lock(&sysfs_lock);
  654. desc = &gpio_desc[gpio];
  655. if (test_bit(FLAG_EXPORT, &desc->flags)) {
  656. struct device *tdev;
  657. tdev = class_find_device(&gpio_class, NULL, desc, match_export);
  658. if (tdev != NULL) {
  659. status = sysfs_create_link(&dev->kobj, &tdev->kobj,
  660. name);
  661. } else {
  662. status = -ENODEV;
  663. }
  664. }
  665. mutex_unlock(&sysfs_lock);
  666. done:
  667. if (status)
  668. pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
  669. return status;
  670. }
  671. EXPORT_SYMBOL_GPL(gpio_export_link);
  672. /**
  673. * gpio_sysfs_set_active_low - set the polarity of gpio sysfs value
  674. * @gpio: gpio to change
  675. * @value: non-zero to use active low, i.e. inverted values
  676. *
  677. * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
  678. * The GPIO does not have to be exported yet. If poll(2) support has
  679. * been enabled for either rising or falling edge, it will be
  680. * reconfigured to follow the new polarity.
  681. *
  682. * Returns zero on success, else an error.
  683. */
  684. int gpio_sysfs_set_active_low(unsigned gpio, int value)
  685. {
  686. struct gpio_desc *desc;
  687. struct device *dev = NULL;
  688. int status = -EINVAL;
  689. if (!gpio_is_valid(gpio))
  690. goto done;
  691. mutex_lock(&sysfs_lock);
  692. desc = &gpio_desc[gpio];
  693. if (test_bit(FLAG_EXPORT, &desc->flags)) {
  694. dev = class_find_device(&gpio_class, NULL, desc, match_export);
  695. if (dev == NULL) {
  696. status = -ENODEV;
  697. goto unlock;
  698. }
  699. }
  700. status = sysfs_set_active_low(desc, dev, value);
  701. unlock:
  702. mutex_unlock(&sysfs_lock);
  703. done:
  704. if (status)
  705. pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
  706. return status;
  707. }
  708. EXPORT_SYMBOL_GPL(gpio_sysfs_set_active_low);
  709. /**
  710. * gpio_unexport - reverse effect of gpio_export()
  711. * @gpio: gpio to make unavailable
  712. *
  713. * This is implicit on gpio_free().
  714. */
  715. void gpio_unexport(unsigned gpio)
  716. {
  717. struct gpio_desc *desc;
  718. int status = 0;
  719. struct device *dev = NULL;
  720. if (!gpio_is_valid(gpio)) {
  721. status = -EINVAL;
  722. goto done;
  723. }
  724. mutex_lock(&sysfs_lock);
  725. desc = &gpio_desc[gpio];
  726. if (test_bit(FLAG_EXPORT, &desc->flags)) {
  727. dev = class_find_device(&gpio_class, NULL, desc, match_export);
  728. if (dev) {
  729. gpio_setup_irq(desc, dev, 0);
  730. clear_bit(FLAG_EXPORT, &desc->flags);
  731. } else
  732. status = -ENODEV;
  733. }
  734. mutex_unlock(&sysfs_lock);
  735. if (dev) {
  736. device_unregister(dev);
  737. put_device(dev);
  738. }
  739. done:
  740. if (status)
  741. pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
  742. }
  743. EXPORT_SYMBOL_GPL(gpio_unexport);
  744. static int gpiochip_export(struct gpio_chip *chip)
  745. {
  746. int status;
  747. struct device *dev;
  748. /* Many systems register gpio chips for SOC support very early,
  749. * before driver model support is available. In those cases we
  750. * export this later, in gpiolib_sysfs_init() ... here we just
  751. * verify that _some_ field of gpio_class got initialized.
  752. */
  753. if (!gpio_class.p)
  754. return 0;
  755. /* use chip->base for the ID; it's already known to be unique */
  756. mutex_lock(&sysfs_lock);
  757. dev = device_create(&gpio_class, chip->dev, MKDEV(0, 0), chip,
  758. "gpiochip%d", chip->base);
  759. if (!IS_ERR(dev)) {
  760. status = sysfs_create_group(&dev->kobj,
  761. &gpiochip_attr_group);
  762. } else
  763. status = PTR_ERR(dev);
  764. chip->exported = (status == 0);
  765. mutex_unlock(&sysfs_lock);
  766. if (status) {
  767. unsigned long flags;
  768. unsigned gpio;
  769. spin_lock_irqsave(&gpio_lock, flags);
  770. gpio = chip->base;
  771. while (gpio_desc[gpio].chip == chip)
  772. gpio_desc[gpio++].chip = NULL;
  773. spin_unlock_irqrestore(&gpio_lock, flags);
  774. pr_debug("%s: chip %s status %d\n", __func__,
  775. chip->label, status);
  776. }
  777. return status;
  778. }
  779. static void gpiochip_unexport(struct gpio_chip *chip)
  780. {
  781. int status;
  782. struct device *dev;
  783. mutex_lock(&sysfs_lock);
  784. dev = class_find_device(&gpio_class, NULL, chip, match_export);
  785. if (dev) {
  786. put_device(dev);
  787. device_unregister(dev);
  788. chip->exported = 0;
  789. status = 0;
  790. } else
  791. status = -ENODEV;
  792. mutex_unlock(&sysfs_lock);
  793. if (status)
  794. pr_debug("%s: chip %s status %d\n", __func__,
  795. chip->label, status);
  796. }
  797. static int __init gpiolib_sysfs_init(void)
  798. {
  799. int status;
  800. unsigned long flags;
  801. unsigned gpio;
  802. status = class_register(&gpio_class);
  803. if (status < 0)
  804. return status;
  805. /* Scan and register the gpio_chips which registered very
  806. * early (e.g. before the class_register above was called).
  807. *
  808. * We run before arch_initcall() so chip->dev nodes can have
  809. * registered, and so arch_initcall() can always gpio_export().
  810. */
  811. spin_lock_irqsave(&gpio_lock, flags);
  812. for (gpio = 0; gpio < ARCH_NR_GPIOS; gpio++) {
  813. struct gpio_chip *chip;
  814. chip = gpio_desc[gpio].chip;
  815. if (!chip || chip->exported)
  816. continue;
  817. spin_unlock_irqrestore(&gpio_lock, flags);
  818. status = gpiochip_export(chip);
  819. spin_lock_irqsave(&gpio_lock, flags);
  820. }
  821. spin_unlock_irqrestore(&gpio_lock, flags);
  822. return status;
  823. }
  824. postcore_initcall(gpiolib_sysfs_init);
  825. #else
  826. static inline int gpiochip_export(struct gpio_chip *chip)
  827. {
  828. return 0;
  829. }
  830. static inline void gpiochip_unexport(struct gpio_chip *chip)
  831. {
  832. }
  833. #endif /* CONFIG_GPIO_SYSFS */
  834. /**
  835. * gpiochip_add() - register a gpio_chip
  836. * @chip: the chip to register, with chip->base initialized
  837. * Context: potentially before irqs or kmalloc will work
  838. *
  839. * Returns a negative errno if the chip can't be registered, such as
  840. * because the chip->base is invalid or already associated with a
  841. * different chip. Otherwise it returns zero as a success code.
  842. *
  843. * When gpiochip_add() is called very early during boot, so that GPIOs
  844. * can be freely used, the chip->dev device must be registered before
  845. * the gpio framework's arch_initcall(). Otherwise sysfs initialization
  846. * for GPIOs will fail rudely.
  847. *
  848. * If chip->base is negative, this requests dynamic assignment of
  849. * a range of valid GPIOs.
  850. */
  851. int gpiochip_add(struct gpio_chip *chip)
  852. {
  853. unsigned long flags;
  854. int status = 0;
  855. unsigned id;
  856. int base = chip->base;
  857. if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
  858. && base >= 0) {
  859. status = -EINVAL;
  860. goto fail;
  861. }
  862. spin_lock_irqsave(&gpio_lock, flags);
  863. if (base < 0) {
  864. base = gpiochip_find_base(chip->ngpio);
  865. if (base < 0) {
  866. status = base;
  867. goto unlock;
  868. }
  869. chip->base = base;
  870. }
  871. /* these GPIO numbers must not be managed by another gpio_chip */
  872. for (id = base; id < base + chip->ngpio; id++) {
  873. if (gpio_desc[id].chip != NULL) {
  874. status = -EBUSY;
  875. break;
  876. }
  877. }
  878. if (status == 0) {
  879. for (id = base; id < base + chip->ngpio; id++) {
  880. gpio_desc[id].chip = chip;
  881. /* REVISIT: most hardware initializes GPIOs as
  882. * inputs (often with pullups enabled) so power
  883. * usage is minimized. Linux code should set the
  884. * gpio direction first thing; but until it does,
  885. * we may expose the wrong direction in sysfs.
  886. */
  887. gpio_desc[id].flags = !chip->direction_input
  888. ? (1 << FLAG_IS_OUT)
  889. : 0;
  890. }
  891. }
  892. of_gpiochip_add(chip);
  893. unlock:
  894. spin_unlock_irqrestore(&gpio_lock, flags);
  895. if (status)
  896. goto fail;
  897. status = gpiochip_export(chip);
  898. if (status)
  899. goto fail;
  900. pr_debug("gpiochip_add: registered GPIOs %d to %d on device: %s\n",
  901. chip->base, chip->base + chip->ngpio - 1,
  902. chip->label ? : "generic");
  903. return 0;
  904. fail:
  905. /* failures here can mean systems won't boot... */
  906. pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
  907. chip->base, chip->base + chip->ngpio - 1,
  908. chip->label ? : "generic");
  909. return status;
  910. }
  911. EXPORT_SYMBOL_GPL(gpiochip_add);
  912. /**
  913. * gpiochip_remove() - unregister a gpio_chip
  914. * @chip: the chip to unregister
  915. *
  916. * A gpio_chip with any GPIOs still requested may not be removed.
  917. */
  918. int gpiochip_remove(struct gpio_chip *chip)
  919. {
  920. unsigned long flags;
  921. int status = 0;
  922. unsigned id;
  923. spin_lock_irqsave(&gpio_lock, flags);
  924. of_gpiochip_remove(chip);
  925. for (id = chip->base; id < chip->base + chip->ngpio; id++) {
  926. if (test_bit(FLAG_REQUESTED, &gpio_desc[id].flags)) {
  927. status = -EBUSY;
  928. break;
  929. }
  930. }
  931. if (status == 0) {
  932. for (id = chip->base; id < chip->base + chip->ngpio; id++)
  933. gpio_desc[id].chip = NULL;
  934. }
  935. spin_unlock_irqrestore(&gpio_lock, flags);
  936. if (status == 0)
  937. gpiochip_unexport(chip);
  938. return status;
  939. }
  940. EXPORT_SYMBOL_GPL(gpiochip_remove);
  941. /**
  942. * gpiochip_find() - iterator for locating a specific gpio_chip
  943. * @data: data to pass to match function
  944. * @callback: Callback function to check gpio_chip
  945. *
  946. * Similar to bus_find_device. It returns a reference to a gpio_chip as
  947. * determined by a user supplied @match callback. The callback should return
  948. * 0 if the device doesn't match and non-zero if it does. If the callback is
  949. * non-zero, this function will return to the caller and not iterate over any
  950. * more gpio_chips.
  951. */
  952. struct gpio_chip *gpiochip_find(void *data,
  953. int (*match)(struct gpio_chip *chip,
  954. void *data))
  955. {
  956. struct gpio_chip *chip = NULL;
  957. unsigned long flags;
  958. int i;
  959. spin_lock_irqsave(&gpio_lock, flags);
  960. for (i = 0; i < ARCH_NR_GPIOS; i++) {
  961. if (!gpio_desc[i].chip)
  962. continue;
  963. if (match(gpio_desc[i].chip, data)) {
  964. chip = gpio_desc[i].chip;
  965. break;
  966. }
  967. }
  968. spin_unlock_irqrestore(&gpio_lock, flags);
  969. return chip;
  970. }
  971. EXPORT_SYMBOL_GPL(gpiochip_find);
  972. /* These "optional" allocation calls help prevent drivers from stomping
  973. * on each other, and help provide better diagnostics in debugfs.
  974. * They're called even less than the "set direction" calls.
  975. */
  976. int gpio_request(unsigned gpio, const char *label)
  977. {
  978. struct gpio_desc *desc;
  979. struct gpio_chip *chip;
  980. int status = -EPROBE_DEFER;
  981. unsigned long flags;
  982. spin_lock_irqsave(&gpio_lock, flags);
  983. if (!gpio_is_valid(gpio))
  984. goto done;
  985. desc = &gpio_desc[gpio];
  986. chip = desc->chip;
  987. if (chip == NULL)
  988. goto done;
  989. if (!try_module_get(chip->owner))
  990. goto done;
  991. /* NOTE: gpio_request() can be called in early boot,
  992. * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
  993. */
  994. if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
  995. desc_set_label(desc, label ? : "?");
  996. status = 0;
  997. } else {
  998. status = -EBUSY;
  999. module_put(chip->owner);
  1000. goto done;
  1001. }
  1002. if (chip->request) {
  1003. /* chip->request may sleep */
  1004. spin_unlock_irqrestore(&gpio_lock, flags);
  1005. status = chip->request(chip, gpio - chip->base);
  1006. spin_lock_irqsave(&gpio_lock, flags);
  1007. if (status < 0) {
  1008. desc_set_label(desc, NULL);
  1009. module_put(chip->owner);
  1010. clear_bit(FLAG_REQUESTED, &desc->flags);
  1011. }
  1012. }
  1013. done:
  1014. if (status)
  1015. pr_debug("gpio_request: gpio-%d (%s) status %d\n",
  1016. gpio, label ? : "?", status);
  1017. spin_unlock_irqrestore(&gpio_lock, flags);
  1018. return status;
  1019. }
  1020. EXPORT_SYMBOL_GPL(gpio_request);
  1021. void gpio_free(unsigned gpio)
  1022. {
  1023. unsigned long flags;
  1024. struct gpio_desc *desc;
  1025. struct gpio_chip *chip;
  1026. might_sleep();
  1027. if (!gpio_is_valid(gpio)) {
  1028. WARN_ON(extra_checks);
  1029. return;
  1030. }
  1031. gpio_unexport(gpio);
  1032. spin_lock_irqsave(&gpio_lock, flags);
  1033. desc = &gpio_desc[gpio];
  1034. chip = desc->chip;
  1035. if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
  1036. if (chip->free) {
  1037. spin_unlock_irqrestore(&gpio_lock, flags);
  1038. might_sleep_if(chip->can_sleep);
  1039. chip->free(chip, gpio - chip->base);
  1040. spin_lock_irqsave(&gpio_lock, flags);
  1041. }
  1042. desc_set_label(desc, NULL);
  1043. module_put(desc->chip->owner);
  1044. clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
  1045. clear_bit(FLAG_REQUESTED, &desc->flags);
  1046. clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
  1047. clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
  1048. } else
  1049. WARN_ON(extra_checks);
  1050. spin_unlock_irqrestore(&gpio_lock, flags);
  1051. }
  1052. EXPORT_SYMBOL_GPL(gpio_free);
  1053. /**
  1054. * gpio_request_one - request a single GPIO with initial configuration
  1055. * @gpio: the GPIO number
  1056. * @flags: GPIO configuration as specified by GPIOF_*
  1057. * @label: a literal description string of this GPIO
  1058. */
  1059. int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
  1060. {
  1061. int err;
  1062. err = gpio_request(gpio, label);
  1063. if (err)
  1064. return err;
  1065. if (flags & GPIOF_OPEN_DRAIN)
  1066. set_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags);
  1067. if (flags & GPIOF_OPEN_SOURCE)
  1068. set_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags);
  1069. if (flags & GPIOF_DIR_IN)
  1070. err = gpio_direction_input(gpio);
  1071. else
  1072. err = gpio_direction_output(gpio,
  1073. (flags & GPIOF_INIT_HIGH) ? 1 : 0);
  1074. if (err)
  1075. goto free_gpio;
  1076. if (flags & GPIOF_EXPORT) {
  1077. err = gpio_export(gpio, flags & GPIOF_EXPORT_CHANGEABLE);
  1078. if (err)
  1079. goto free_gpio;
  1080. }
  1081. return 0;
  1082. free_gpio:
  1083. gpio_free(gpio);
  1084. return err;
  1085. }
  1086. EXPORT_SYMBOL_GPL(gpio_request_one);
  1087. /**
  1088. * gpio_request_array - request multiple GPIOs in a single call
  1089. * @array: array of the 'struct gpio'
  1090. * @num: how many GPIOs in the array
  1091. */
  1092. int gpio_request_array(const struct gpio *array, size_t num)
  1093. {
  1094. int i, err;
  1095. for (i = 0; i < num; i++, array++) {
  1096. err = gpio_request_one(array->gpio, array->flags, array->label);
  1097. if (err)
  1098. goto err_free;
  1099. }
  1100. return 0;
  1101. err_free:
  1102. while (i--)
  1103. gpio_free((--array)->gpio);
  1104. return err;
  1105. }
  1106. EXPORT_SYMBOL_GPL(gpio_request_array);
  1107. /**
  1108. * gpio_free_array - release multiple GPIOs in a single call
  1109. * @array: array of the 'struct gpio'
  1110. * @num: how many GPIOs in the array
  1111. */
  1112. void gpio_free_array(const struct gpio *array, size_t num)
  1113. {
  1114. while (num--)
  1115. gpio_free((array++)->gpio);
  1116. }
  1117. EXPORT_SYMBOL_GPL(gpio_free_array);
  1118. /**
  1119. * gpiochip_is_requested - return string iff signal was requested
  1120. * @chip: controller managing the signal
  1121. * @offset: of signal within controller's 0..(ngpio - 1) range
  1122. *
  1123. * Returns NULL if the GPIO is not currently requested, else a string.
  1124. * If debugfs support is enabled, the string returned is the label passed
  1125. * to gpio_request(); otherwise it is a meaningless constant.
  1126. *
  1127. * This function is for use by GPIO controller drivers. The label can
  1128. * help with diagnostics, and knowing that the signal is used as a GPIO
  1129. * can help avoid accidentally multiplexing it to another controller.
  1130. */
  1131. const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
  1132. {
  1133. unsigned gpio = chip->base + offset;
  1134. if (!gpio_is_valid(gpio) || gpio_desc[gpio].chip != chip)
  1135. return NULL;
  1136. if (test_bit(FLAG_REQUESTED, &gpio_desc[gpio].flags) == 0)
  1137. return NULL;
  1138. #ifdef CONFIG_DEBUG_FS
  1139. return gpio_desc[gpio].label;
  1140. #else
  1141. return "?";
  1142. #endif
  1143. }
  1144. EXPORT_SYMBOL_GPL(gpiochip_is_requested);
  1145. /* Drivers MUST set GPIO direction before making get/set calls. In
  1146. * some cases this is done in early boot, before IRQs are enabled.
  1147. *
  1148. * As a rule these aren't called more than once (except for drivers
  1149. * using the open-drain emulation idiom) so these are natural places
  1150. * to accumulate extra debugging checks. Note that we can't (yet)
  1151. * rely on gpio_request() having been called beforehand.
  1152. */
  1153. int gpio_direction_input(unsigned gpio)
  1154. {
  1155. unsigned long flags;
  1156. struct gpio_chip *chip;
  1157. struct gpio_desc *desc = &gpio_desc[gpio];
  1158. int status = -EINVAL;
  1159. spin_lock_irqsave(&gpio_lock, flags);
  1160. if (!gpio_is_valid(gpio))
  1161. goto fail;
  1162. chip = desc->chip;
  1163. if (!chip || !chip->get || !chip->direction_input)
  1164. goto fail;
  1165. gpio -= chip->base;
  1166. if (gpio >= chip->ngpio)
  1167. goto fail;
  1168. status = gpio_ensure_requested(desc, gpio);
  1169. if (status < 0)
  1170. goto fail;
  1171. /* now we know the gpio is valid and chip won't vanish */
  1172. spin_unlock_irqrestore(&gpio_lock, flags);
  1173. might_sleep_if(chip->can_sleep);
  1174. if (status) {
  1175. status = chip->request(chip, gpio);
  1176. if (status < 0) {
  1177. pr_debug("GPIO-%d: chip request fail, %d\n",
  1178. chip->base + gpio, status);
  1179. /* and it's not available to anyone else ...
  1180. * gpio_request() is the fully clean solution.
  1181. */
  1182. goto lose;
  1183. }
  1184. }
  1185. status = chip->direction_input(chip, gpio);
  1186. if (status == 0)
  1187. clear_bit(FLAG_IS_OUT, &desc->flags);
  1188. trace_gpio_direction(chip->base + gpio, 1, status);
  1189. lose:
  1190. return status;
  1191. fail:
  1192. spin_unlock_irqrestore(&gpio_lock, flags);
  1193. if (status)
  1194. pr_debug("%s: gpio-%d status %d\n",
  1195. __func__, gpio, status);
  1196. return status;
  1197. }
  1198. EXPORT_SYMBOL_GPL(gpio_direction_input);
  1199. int gpio_direction_output(unsigned gpio, int value)
  1200. {
  1201. unsigned long flags;
  1202. struct gpio_chip *chip;
  1203. struct gpio_desc *desc = &gpio_desc[gpio];
  1204. int status = -EINVAL;
  1205. /* Open drain pin should not be driven to 1 */
  1206. if (value && test_bit(FLAG_OPEN_DRAIN, &desc->flags))
  1207. return gpio_direction_input(gpio);
  1208. /* Open source pin should not be driven to 0 */
  1209. if (!value && test_bit(FLAG_OPEN_SOURCE, &desc->flags))
  1210. return gpio_direction_input(gpio);
  1211. spin_lock_irqsave(&gpio_lock, flags);
  1212. if (!gpio_is_valid(gpio))
  1213. goto fail;
  1214. chip = desc->chip;
  1215. if (!chip || !chip->set || !chip->direction_output)
  1216. goto fail;
  1217. gpio -= chip->base;
  1218. if (gpio >= chip->ngpio)
  1219. goto fail;
  1220. status = gpio_ensure_requested(desc, gpio);
  1221. if (status < 0)
  1222. goto fail;
  1223. /* now we know the gpio is valid and chip won't vanish */
  1224. spin_unlock_irqrestore(&gpio_lock, flags);
  1225. might_sleep_if(chip->can_sleep);
  1226. if (status) {
  1227. status = chip->request(chip, gpio);
  1228. if (status < 0) {
  1229. pr_debug("GPIO-%d: chip request fail, %d\n",
  1230. chip->base + gpio, status);
  1231. /* and it's not available to anyone else ...
  1232. * gpio_request() is the fully clean solution.
  1233. */
  1234. goto lose;
  1235. }
  1236. }
  1237. status = chip->direction_output(chip, gpio, value);
  1238. if (status == 0)
  1239. set_bit(FLAG_IS_OUT, &desc->flags);
  1240. trace_gpio_value(chip->base + gpio, 0, value);
  1241. trace_gpio_direction(chip->base + gpio, 0, status);
  1242. lose:
  1243. return status;
  1244. fail:
  1245. spin_unlock_irqrestore(&gpio_lock, flags);
  1246. if (status)
  1247. pr_debug("%s: gpio-%d status %d\n",
  1248. __func__, gpio, status);
  1249. return status;
  1250. }
  1251. EXPORT_SYMBOL_GPL(gpio_direction_output);
  1252. /**
  1253. * gpio_set_debounce - sets @debounce time for a @gpio
  1254. * @gpio: the gpio to set debounce time
  1255. * @debounce: debounce time is microseconds
  1256. */
  1257. int gpio_set_debounce(unsigned gpio, unsigned debounce)
  1258. {
  1259. unsigned long flags;
  1260. struct gpio_chip *chip;
  1261. struct gpio_desc *desc = &gpio_desc[gpio];
  1262. int status = -EINVAL;
  1263. spin_lock_irqsave(&gpio_lock, flags);
  1264. if (!gpio_is_valid(gpio))
  1265. goto fail;
  1266. chip = desc->chip;
  1267. if (!chip || !chip->set || !chip->set_debounce)
  1268. goto fail;
  1269. gpio -= chip->base;
  1270. if (gpio >= chip->ngpio)
  1271. goto fail;
  1272. status = gpio_ensure_requested(desc, gpio);
  1273. if (status < 0)
  1274. goto fail;
  1275. /* now we know the gpio is valid and chip won't vanish */
  1276. spin_unlock_irqrestore(&gpio_lock, flags);
  1277. might_sleep_if(chip->can_sleep);
  1278. return chip->set_debounce(chip, gpio, debounce);
  1279. fail:
  1280. spin_unlock_irqrestore(&gpio_lock, flags);
  1281. if (status)
  1282. pr_debug("%s: gpio-%d status %d\n",
  1283. __func__, gpio, status);
  1284. return status;
  1285. }
  1286. EXPORT_SYMBOL_GPL(gpio_set_debounce);
  1287. /* I/O calls are only valid after configuration completed; the relevant
  1288. * "is this a valid GPIO" error checks should already have been done.
  1289. *
  1290. * "Get" operations are often inlinable as reading a pin value register,
  1291. * and masking the relevant bit in that register.
  1292. *
  1293. * When "set" operations are inlinable, they involve writing that mask to
  1294. * one register to set a low value, or a different register to set it high.
  1295. * Otherwise locking is needed, so there may be little value to inlining.
  1296. *
  1297. *------------------------------------------------------------------------
  1298. *
  1299. * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
  1300. * have requested the GPIO. That can include implicit requesting by
  1301. * a direction setting call. Marking a gpio as requested locks its chip
  1302. * in memory, guaranteeing that these table lookups need no more locking
  1303. * and that gpiochip_remove() will fail.
  1304. *
  1305. * REVISIT when debugging, consider adding some instrumentation to ensure
  1306. * that the GPIO was actually requested.
  1307. */
  1308. /**
  1309. * __gpio_get_value() - return a gpio's value
  1310. * @gpio: gpio whose value will be returned
  1311. * Context: any
  1312. *
  1313. * This is used directly or indirectly to implement gpio_get_value().
  1314. * It returns the zero or nonzero value provided by the associated
  1315. * gpio_chip.get() method; or zero if no such method is provided.
  1316. */
  1317. int __gpio_get_value(unsigned gpio)
  1318. {
  1319. struct gpio_chip *chip;
  1320. int value;
  1321. chip = gpio_to_chip(gpio);
  1322. /* Should be using gpio_get_value_cansleep() */
  1323. WARN_ON(chip->can_sleep);
  1324. value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
  1325. trace_gpio_value(gpio, 1, value);
  1326. return value;
  1327. }
  1328. EXPORT_SYMBOL_GPL(__gpio_get_value);
  1329. /*
  1330. * _gpio_set_open_drain_value() - Set the open drain gpio's value.
  1331. * @gpio: Gpio whose state need to be set.
  1332. * @chip: Gpio chip.
  1333. * @value: Non-zero for setting it HIGH otherise it will set to LOW.
  1334. */
  1335. static void _gpio_set_open_drain_value(unsigned gpio,
  1336. struct gpio_chip *chip, int value)
  1337. {
  1338. int err = 0;
  1339. if (value) {
  1340. err = chip->direction_input(chip, gpio - chip->base);
  1341. if (!err)
  1342. clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
  1343. } else {
  1344. err = chip->direction_output(chip, gpio - chip->base, 0);
  1345. if (!err)
  1346. set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
  1347. }
  1348. trace_gpio_direction(gpio, value, err);
  1349. if (err < 0)
  1350. pr_err("%s: Error in set_value for open drain gpio%d err %d\n",
  1351. __func__, gpio, err);
  1352. }
  1353. /*
  1354. * _gpio_set_open_source() - Set the open source gpio's value.
  1355. * @gpio: Gpio whose state need to be set.
  1356. * @chip: Gpio chip.
  1357. * @value: Non-zero for setting it HIGH otherise it will set to LOW.
  1358. */
  1359. static void _gpio_set_open_source_value(unsigned gpio,
  1360. struct gpio_chip *chip, int value)
  1361. {
  1362. int err = 0;
  1363. if (value) {
  1364. err = chip->direction_output(chip, gpio - chip->base, 1);
  1365. if (!err)
  1366. set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
  1367. } else {
  1368. err = chip->direction_input(chip, gpio - chip->base);
  1369. if (!err)
  1370. clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
  1371. }
  1372. trace_gpio_direction(gpio, !value, err);
  1373. if (err < 0)
  1374. pr_err("%s: Error in set_value for open source gpio%d err %d\n",
  1375. __func__, gpio, err);
  1376. }
  1377. /**
  1378. * __gpio_set_value() - assign a gpio's value
  1379. * @gpio: gpio whose value will be assigned
  1380. * @value: value to assign
  1381. * Context: any
  1382. *
  1383. * This is used directly or indirectly to implement gpio_set_value().
  1384. * It invokes the associated gpio_chip.set() method.
  1385. */
  1386. void __gpio_set_value(unsigned gpio, int value)
  1387. {
  1388. struct gpio_chip *chip;
  1389. chip = gpio_to_chip(gpio);
  1390. /* Should be using gpio_set_value_cansleep() */
  1391. WARN_ON(chip->can_sleep);
  1392. trace_gpio_value(gpio, 0, value);
  1393. if (test_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags))
  1394. _gpio_set_open_drain_value(gpio, chip, value);
  1395. else if (test_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags))
  1396. _gpio_set_open_source_value(gpio, chip, value);
  1397. else
  1398. chip->set(chip, gpio - chip->base, value);
  1399. }
  1400. EXPORT_SYMBOL_GPL(__gpio_set_value);
  1401. /**
  1402. * __gpio_cansleep() - report whether gpio value access will sleep
  1403. * @gpio: gpio in question
  1404. * Context: any
  1405. *
  1406. * This is used directly or indirectly to implement gpio_cansleep(). It
  1407. * returns nonzero if access reading or writing the GPIO value can sleep.
  1408. */
  1409. int __gpio_cansleep(unsigned gpio)
  1410. {
  1411. struct gpio_chip *chip;
  1412. /* only call this on GPIOs that are valid! */
  1413. chip = gpio_to_chip(gpio);
  1414. return chip->can_sleep;
  1415. }
  1416. EXPORT_SYMBOL_GPL(__gpio_cansleep);
  1417. /**
  1418. * __gpio_to_irq() - return the IRQ corresponding to a GPIO
  1419. * @gpio: gpio whose IRQ will be returned (already requested)
  1420. * Context: any
  1421. *
  1422. * This is used directly or indirectly to implement gpio_to_irq().
  1423. * It returns the number of the IRQ signaled by this (input) GPIO,
  1424. * or a negative errno.
  1425. */
  1426. int __gpio_to_irq(unsigned gpio)
  1427. {
  1428. struct gpio_chip *chip;
  1429. chip = gpio_to_chip(gpio);
  1430. return chip->to_irq ? chip->to_irq(chip, gpio - chip->base) : -ENXIO;
  1431. }
  1432. EXPORT_SYMBOL_GPL(__gpio_to_irq);
  1433. /* There's no value in making it easy to inline GPIO calls that may sleep.
  1434. * Common examples include ones connected to I2C or SPI chips.
  1435. */
  1436. int gpio_get_value_cansleep(unsigned gpio)
  1437. {
  1438. struct gpio_chip *chip;
  1439. int value;
  1440. might_sleep_if(extra_checks);
  1441. chip = gpio_to_chip(gpio);
  1442. value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
  1443. trace_gpio_value(gpio, 1, value);
  1444. return value;
  1445. }
  1446. EXPORT_SYMBOL_GPL(gpio_get_value_cansleep);
  1447. void gpio_set_value_cansleep(unsigned gpio, int value)
  1448. {
  1449. struct gpio_chip *chip;
  1450. might_sleep_if(extra_checks);
  1451. chip = gpio_to_chip(gpio);
  1452. trace_gpio_value(gpio, 0, value);
  1453. if (test_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags))
  1454. _gpio_set_open_drain_value(gpio, chip, value);
  1455. else if (test_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags))
  1456. _gpio_set_open_source_value(gpio, chip, value);
  1457. else
  1458. chip->set(chip, gpio - chip->base, value);
  1459. }
  1460. EXPORT_SYMBOL_GPL(gpio_set_value_cansleep);
  1461. #ifdef CONFIG_DEBUG_FS
  1462. static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
  1463. {
  1464. unsigned i;
  1465. unsigned gpio = chip->base;
  1466. struct gpio_desc *gdesc = &gpio_desc[gpio];
  1467. int is_out;
  1468. for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
  1469. if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
  1470. continue;
  1471. is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
  1472. seq_printf(s, " gpio-%-3d (%-20.20s) %s %s",
  1473. gpio, gdesc->label,
  1474. is_out ? "out" : "in ",
  1475. chip->get
  1476. ? (chip->get(chip, i) ? "hi" : "lo")
  1477. : "? ");
  1478. seq_printf(s, "\n");
  1479. }
  1480. }
  1481. static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
  1482. {
  1483. struct gpio_chip *chip = NULL;
  1484. unsigned int gpio;
  1485. void *ret = NULL;
  1486. loff_t index = 0;
  1487. /* REVISIT this isn't locked against gpio_chip removal ... */
  1488. for (gpio = 0; gpio_is_valid(gpio); gpio++) {
  1489. if (gpio_desc[gpio].chip == chip)
  1490. continue;
  1491. chip = gpio_desc[gpio].chip;
  1492. if (!chip)
  1493. continue;
  1494. if (index++ >= *pos) {
  1495. ret = chip;
  1496. break;
  1497. }
  1498. }
  1499. s->private = "";
  1500. return ret;
  1501. }
  1502. static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
  1503. {
  1504. struct gpio_chip *chip = v;
  1505. unsigned int gpio;
  1506. void *ret = NULL;
  1507. /* skip GPIOs provided by the current chip */
  1508. for (gpio = chip->base + chip->ngpio; gpio_is_valid(gpio); gpio++) {
  1509. chip = gpio_desc[gpio].chip;
  1510. if (chip) {
  1511. ret = chip;
  1512. break;
  1513. }
  1514. }
  1515. s->private = "\n";
  1516. ++*pos;
  1517. return ret;
  1518. }
  1519. static void gpiolib_seq_stop(struct seq_file *s, void *v)
  1520. {
  1521. }
  1522. static int gpiolib_seq_show(struct seq_file *s, void *v)
  1523. {
  1524. struct gpio_chip *chip = v;
  1525. struct device *dev;
  1526. seq_printf(s, "%sGPIOs %d-%d", (char *)s->private,
  1527. chip->base, chip->base + chip->ngpio - 1);
  1528. dev = chip->dev;
  1529. if (dev)
  1530. seq_printf(s, ", %s/%s", dev->bus ? dev->bus->name : "no-bus",
  1531. dev_name(dev));
  1532. if (chip->label)
  1533. seq_printf(s, ", %s", chip->label);
  1534. if (chip->can_sleep)
  1535. seq_printf(s, ", can sleep");
  1536. seq_printf(s, ":\n");
  1537. if (chip->dbg_show)
  1538. chip->dbg_show(s, chip);
  1539. else
  1540. gpiolib_dbg_show(s, chip);
  1541. return 0;
  1542. }
  1543. static const struct seq_operations gpiolib_seq_ops = {
  1544. .start = gpiolib_seq_start,
  1545. .next = gpiolib_seq_next,
  1546. .stop = gpiolib_seq_stop,
  1547. .show = gpiolib_seq_show,
  1548. };
  1549. static int gpiolib_open(struct inode *inode, struct file *file)
  1550. {
  1551. return seq_open(file, &gpiolib_seq_ops);
  1552. }
  1553. static const struct file_operations gpiolib_operations = {
  1554. .owner = THIS_MODULE,
  1555. .open = gpiolib_open,
  1556. .read = seq_read,
  1557. .llseek = seq_lseek,
  1558. .release = seq_release,
  1559. };
  1560. static int __init gpiolib_debugfs_init(void)
  1561. {
  1562. /* /sys/kernel/debug/gpio */
  1563. (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
  1564. NULL, NULL, &gpiolib_operations);
  1565. return 0;
  1566. }
  1567. subsys_initcall(gpiolib_debugfs_init);
  1568. #endif /* DEBUG_FS */