gpio.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
  1. GPIO Interfaces
  2. This provides an overview of GPIO access conventions on Linux.
  3. These calls use the gpio_* naming prefix. No other calls should use that
  4. prefix, or the related __gpio_* prefix.
  5. What is a GPIO?
  6. ===============
  7. A "General Purpose Input/Output" (GPIO) is a flexible software-controlled
  8. digital signal. They are provided from many kinds of chip, and are familiar
  9. to Linux developers working with embedded and custom hardware. Each GPIO
  10. represents a bit connected to a particular pin, or "ball" on Ball Grid Array
  11. (BGA) packages. Board schematics show which external hardware connects to
  12. which GPIOs. Drivers can be written generically, so that board setup code
  13. passes such pin configuration data to drivers.
  14. System-on-Chip (SOC) processors heavily rely on GPIOs. In some cases, every
  15. non-dedicated pin can be configured as a GPIO; and most chips have at least
  16. several dozen of them. Programmable logic devices (like FPGAs) can easily
  17. provide GPIOs; multifunction chips like power managers, and audio codecs
  18. often have a few such pins to help with pin scarcity on SOCs; and there are
  19. also "GPIO Expander" chips that connect using the I2C or SPI serial busses.
  20. Most PC southbridges have a few dozen GPIO-capable pins (with only the BIOS
  21. firmware knowing how they're used).
  22. The exact capabilities of GPIOs vary between systems. Common options:
  23. - Output values are writable (high=1, low=0). Some chips also have
  24. options about how that value is driven, so that for example only one
  25. value might be driven ... supporting "wire-OR" and similar schemes
  26. for the other value (notably, "open drain" signaling).
  27. - Input values are likewise readable (1, 0). Some chips support readback
  28. of pins configured as "output", which is very useful in such "wire-OR"
  29. cases (to support bidirectional signaling). GPIO controllers may have
  30. input de-glitch/debounce logic, sometimes with software controls.
  31. - Inputs can often be used as IRQ signals, often edge triggered but
  32. sometimes level triggered. Such IRQs may be configurable as system
  33. wakeup events, to wake the system from a low power state.
  34. - Usually a GPIO will be configurable as either input or output, as needed
  35. by different product boards; single direction ones exist too.
  36. - Most GPIOs can be accessed while holding spinlocks, but those accessed
  37. through a serial bus normally can't. Some systems support both types.
  38. On a given board each GPIO is used for one specific purpose like monitoring
  39. MMC/SD card insertion/removal, detecting card writeprotect status, driving
  40. a LED, configuring a transceiver, bitbanging a serial bus, poking a hardware
  41. watchdog, sensing a switch, and so on.
  42. GPIO conventions
  43. ================
  44. Note that this is called a "convention" because you don't need to do it this
  45. way, and it's no crime if you don't. There **are** cases where portability
  46. is not the main issue; GPIOs are often used for the kind of board-specific
  47. glue logic that may even change between board revisions, and can't ever be
  48. used on a board that's wired differently. Only least-common-denominator
  49. functionality can be very portable. Other features are platform-specific,
  50. and that can be critical for glue logic.
  51. Plus, this doesn't require any implementation framework, just an interface.
  52. One platform might implement it as simple inline functions accessing chip
  53. registers; another might implement it by delegating through abstractions
  54. used for several very different kinds of GPIO controller. (There is some
  55. optional code supporting such an implementation strategy, described later
  56. in this document, but drivers acting as clients to the GPIO interface must
  57. not care how it's implemented.)
  58. That said, if the convention is supported on their platform, drivers should
  59. use it when possible. Platforms must declare GENERIC_GPIO support in their
  60. Kconfig (boolean true), and provide an <asm/gpio.h> file. Drivers that can't
  61. work without standard GPIO calls should have Kconfig entries which depend
  62. on GENERIC_GPIO. The GPIO calls are available, either as "real code" or as
  63. optimized-away stubs, when drivers use the include file:
  64. #include <linux/gpio.h>
  65. If you stick to this convention then it'll be easier for other developers to
  66. see what your code is doing, and help maintain it.
  67. Note that these operations include I/O barriers on platforms which need to
  68. use them; drivers don't need to add them explicitly.
  69. Identifying GPIOs
  70. -----------------
  71. GPIOs are identified by unsigned integers in the range 0..MAX_INT. That
  72. reserves "negative" numbers for other purposes like marking signals as
  73. "not available on this board", or indicating faults. Code that doesn't
  74. touch the underlying hardware treats these integers as opaque cookies.
  75. Platforms define how they use those integers, and usually #define symbols
  76. for the GPIO lines so that board-specific setup code directly corresponds
  77. to the relevant schematics. In contrast, drivers should only use GPIO
  78. numbers passed to them from that setup code, using platform_data to hold
  79. board-specific pin configuration data (along with other board specific
  80. data they need). That avoids portability problems.
  81. So for example one platform uses numbers 32-159 for GPIOs; while another
  82. uses numbers 0..63 with one set of GPIO controllers, 64-79 with another
  83. type of GPIO controller, and on one particular board 80-95 with an FPGA.
  84. The numbers need not be contiguous; either of those platforms could also
  85. use numbers 2000-2063 to identify GPIOs in a bank of I2C GPIO expanders.
  86. If you want to initialize a structure with an invalid GPIO number, use
  87. some negative number (perhaps "-EINVAL"); that will never be valid. To
  88. test if a number could reference a GPIO, you may use this predicate:
  89. int gpio_is_valid(int number);
  90. A number that's not valid will be rejected by calls which may request
  91. or free GPIOs (see below). Other numbers may also be rejected; for
  92. example, a number might be valid but unused on a given board.
  93. Whether a platform supports multiple GPIO controllers is currently a
  94. platform-specific implementation issue.
  95. Using GPIOs
  96. -----------
  97. The first thing a system should do with a GPIO is allocate it, using
  98. the gpio_request() call; see later.
  99. One of the next things to do with a GPIO, often in board setup code when
  100. setting up a platform_device using the GPIO, is mark its direction:
  101. /* set as input or output, returning 0 or negative errno */
  102. int gpio_direction_input(unsigned gpio);
  103. int gpio_direction_output(unsigned gpio, int value);
  104. The return value is zero for success, else a negative errno. It should
  105. be checked, since the get/set calls don't have error returns and since
  106. misconfiguration is possible. You should normally issue these calls from
  107. a task context. However, for spinlock-safe GPIOs it's OK to use them
  108. before tasking is enabled, as part of early board setup.
  109. For output GPIOs, the value provided becomes the initial output value.
  110. This helps avoid signal glitching during system startup.
  111. For compatibility with legacy interfaces to GPIOs, setting the direction
  112. of a GPIO implicitly requests that GPIO (see below) if it has not been
  113. requested already. That compatibility is being removed from the optional
  114. gpiolib framework.
  115. Setting the direction can fail if the GPIO number is invalid, or when
  116. that particular GPIO can't be used in that mode. It's generally a bad
  117. idea to rely on boot firmware to have set the direction correctly, since
  118. it probably wasn't validated to do more than boot Linux. (Similarly,
  119. that board setup code probably needs to multiplex that pin as a GPIO,
  120. and configure pullups/pulldowns appropriately.)
  121. Spinlock-Safe GPIO access
  122. -------------------------
  123. Most GPIO controllers can be accessed with memory read/write instructions.
  124. Those don't need to sleep, and can safely be done from inside hard
  125. (nonthreaded) IRQ handlers and similar contexts.
  126. Use the following calls to access such GPIOs,
  127. for which gpio_cansleep() will always return false (see below):
  128. /* GPIO INPUT: return zero or nonzero */
  129. int gpio_get_value(unsigned gpio);
  130. /* GPIO OUTPUT */
  131. void gpio_set_value(unsigned gpio, int value);
  132. The values are boolean, zero for low, nonzero for high. When reading the
  133. value of an output pin, the value returned should be what's seen on the
  134. pin ... that won't always match the specified output value, because of
  135. issues including open-drain signaling and output latencies.
  136. The get/set calls have no error returns because "invalid GPIO" should have
  137. been reported earlier from gpio_direction_*(). However, note that not all
  138. platforms can read the value of output pins; those that can't should always
  139. return zero. Also, using these calls for GPIOs that can't safely be accessed
  140. without sleeping (see below) is an error.
  141. Platform-specific implementations are encouraged to optimize the two
  142. calls to access the GPIO value in cases where the GPIO number (and for
  143. output, value) are constant. It's normal for them to need only a couple
  144. of instructions in such cases (reading or writing a hardware register),
  145. and not to need spinlocks. Such optimized calls can make bitbanging
  146. applications a lot more efficient (in both space and time) than spending
  147. dozens of instructions on subroutine calls.
  148. GPIO access that may sleep
  149. --------------------------
  150. Some GPIO controllers must be accessed using message based busses like I2C
  151. or SPI. Commands to read or write those GPIO values require waiting to
  152. get to the head of a queue to transmit a command and get its response.
  153. This requires sleeping, which can't be done from inside IRQ handlers.
  154. Platforms that support this type of GPIO distinguish them from other GPIOs
  155. by returning nonzero from this call (which requires a valid GPIO number,
  156. which should have been previously allocated with gpio_request):
  157. int gpio_cansleep(unsigned gpio);
  158. To access such GPIOs, a different set of accessors is defined:
  159. /* GPIO INPUT: return zero or nonzero, might sleep */
  160. int gpio_get_value_cansleep(unsigned gpio);
  161. /* GPIO OUTPUT, might sleep */
  162. void gpio_set_value_cansleep(unsigned gpio, int value);
  163. Accessing such GPIOs requires a context which may sleep, for example
  164. a threaded IRQ handler, and those accessors must be used instead of
  165. spinlock-safe accessors without the cansleep() name suffix.
  166. Other than the fact that these accessors might sleep, and will work
  167. on GPIOs that can't be accessed from hardIRQ handlers, these calls act
  168. the same as the spinlock-safe calls.
  169. ** IN ADDITION ** calls to setup and configure such GPIOs must be made
  170. from contexts which may sleep, since they may need to access the GPIO
  171. controller chip too: (These setup calls are usually made from board
  172. setup or driver probe/teardown code, so this is an easy constraint.)
  173. gpio_direction_input()
  174. gpio_direction_output()
  175. gpio_request()
  176. ## gpio_request_one()
  177. ## gpio_request_array()
  178. ## gpio_free_array()
  179. gpio_free()
  180. gpio_set_debounce()
  181. Claiming and Releasing GPIOs
  182. ----------------------------
  183. To help catch system configuration errors, two calls are defined.
  184. /* request GPIO, returning 0 or negative errno.
  185. * non-null labels may be useful for diagnostics.
  186. */
  187. int gpio_request(unsigned gpio, const char *label);
  188. /* release previously-claimed GPIO */
  189. void gpio_free(unsigned gpio);
  190. Passing invalid GPIO numbers to gpio_request() will fail, as will requesting
  191. GPIOs that have already been claimed with that call. The return value of
  192. gpio_request() must be checked. You should normally issue these calls from
  193. a task context. However, for spinlock-safe GPIOs it's OK to request GPIOs
  194. before tasking is enabled, as part of early board setup.
  195. These calls serve two basic purposes. One is marking the signals which
  196. are actually in use as GPIOs, for better diagnostics; systems may have
  197. several hundred potential GPIOs, but often only a dozen are used on any
  198. given board. Another is to catch conflicts, identifying errors when
  199. (a) two or more drivers wrongly think they have exclusive use of that
  200. signal, or (b) something wrongly believes it's safe to remove drivers
  201. needed to manage a signal that's in active use. That is, requesting a
  202. GPIO can serve as a kind of lock.
  203. Some platforms may also use knowledge about what GPIOs are active for
  204. power management, such as by powering down unused chip sectors and, more
  205. easily, gating off unused clocks.
  206. Note that requesting a GPIO does NOT cause it to be configured in any
  207. way; it just marks that GPIO as in use. Separate code must handle any
  208. pin setup (e.g. controlling which pin the GPIO uses, pullup/pulldown).
  209. Also note that it's your responsibility to have stopped using a GPIO
  210. before you free it.
  211. Considering in most cases GPIOs are actually configured right after they
  212. are claimed, three additional calls are defined:
  213. /* request a single GPIO, with initial configuration specified by
  214. * 'flags', identical to gpio_request() wrt other arguments and
  215. * return value
  216. */
  217. int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
  218. /* request multiple GPIOs in a single call
  219. */
  220. int gpio_request_array(struct gpio *array, size_t num);
  221. /* release multiple GPIOs in a single call
  222. */
  223. void gpio_free_array(struct gpio *array, size_t num);
  224. where 'flags' is currently defined to specify the following properties:
  225. * GPIOF_DIR_IN - to configure direction as input
  226. * GPIOF_DIR_OUT - to configure direction as output
  227. * GPIOF_INIT_LOW - as output, set initial level to LOW
  228. * GPIOF_INIT_HIGH - as output, set initial level to HIGH
  229. since GPIOF_INIT_* are only valid when configured as output, so group valid
  230. combinations as:
  231. * GPIOF_IN - configure as input
  232. * GPIOF_OUT_INIT_LOW - configured as output, initial level LOW
  233. * GPIOF_OUT_INIT_HIGH - configured as output, initial level HIGH
  234. In the future, these flags can be extended to support more properties such
  235. as open-drain status.
  236. Further more, to ease the claim/release of multiple GPIOs, 'struct gpio' is
  237. introduced to encapsulate all three fields as:
  238. struct gpio {
  239. unsigned gpio;
  240. unsigned long flags;
  241. const char *label;
  242. };
  243. A typical example of usage:
  244. static struct gpio leds_gpios[] = {
  245. { 32, GPIOF_OUT_INIT_HIGH, "Power LED" }, /* default to ON */
  246. { 33, GPIOF_OUT_INIT_LOW, "Green LED" }, /* default to OFF */
  247. { 34, GPIOF_OUT_INIT_LOW, "Red LED" }, /* default to OFF */
  248. { 35, GPIOF_OUT_INIT_LOW, "Blue LED" }, /* default to OFF */
  249. { ... },
  250. };
  251. err = gpio_request_one(31, GPIOF_IN, "Reset Button");
  252. if (err)
  253. ...
  254. err = gpio_request_array(leds_gpios, ARRAY_SIZE(leds_gpios));
  255. if (err)
  256. ...
  257. gpio_free_array(leds_gpios, ARRAY_SIZE(leds_gpios));
  258. GPIOs mapped to IRQs
  259. --------------------
  260. GPIO numbers are unsigned integers; so are IRQ numbers. These make up
  261. two logically distinct namespaces (GPIO 0 need not use IRQ 0). You can
  262. map between them using calls like:
  263. /* map GPIO numbers to IRQ numbers */
  264. int gpio_to_irq(unsigned gpio);
  265. /* map IRQ numbers to GPIO numbers (avoid using this) */
  266. int irq_to_gpio(unsigned irq);
  267. Those return either the corresponding number in the other namespace, or
  268. else a negative errno code if the mapping can't be done. (For example,
  269. some GPIOs can't be used as IRQs.) It is an unchecked error to use a GPIO
  270. number that wasn't set up as an input using gpio_direction_input(), or
  271. to use an IRQ number that didn't originally come from gpio_to_irq().
  272. These two mapping calls are expected to cost on the order of a single
  273. addition or subtraction. They're not allowed to sleep.
  274. Non-error values returned from gpio_to_irq() can be passed to request_irq()
  275. or free_irq(). They will often be stored into IRQ resources for platform
  276. devices, by the board-specific initialization code. Note that IRQ trigger
  277. options are part of the IRQ interface, e.g. IRQF_TRIGGER_FALLING, as are
  278. system wakeup capabilities.
  279. Non-error values returned from irq_to_gpio() would most commonly be used
  280. with gpio_get_value(), for example to initialize or update driver state
  281. when the IRQ is edge-triggered. Note that some platforms don't support
  282. this reverse mapping, so you should avoid using it.
  283. Emulating Open Drain Signals
  284. ----------------------------
  285. Sometimes shared signals need to use "open drain" signaling, where only the
  286. low signal level is actually driven. (That term applies to CMOS transistors;
  287. "open collector" is used for TTL.) A pullup resistor causes the high signal
  288. level. This is sometimes called a "wire-AND"; or more practically, from the
  289. negative logic (low=true) perspective this is a "wire-OR".
  290. One common example of an open drain signal is a shared active-low IRQ line.
  291. Also, bidirectional data bus signals sometimes use open drain signals.
  292. Some GPIO controllers directly support open drain outputs; many don't. When
  293. you need open drain signaling but your hardware doesn't directly support it,
  294. there's a common idiom you can use to emulate it with any GPIO pin that can
  295. be used as either an input or an output:
  296. LOW: gpio_direction_output(gpio, 0) ... this drives the signal
  297. and overrides the pullup.
  298. HIGH: gpio_direction_input(gpio) ... this turns off the output,
  299. so the pullup (or some other device) controls the signal.
  300. If you are "driving" the signal high but gpio_get_value(gpio) reports a low
  301. value (after the appropriate rise time passes), you know some other component
  302. is driving the shared signal low. That's not necessarily an error. As one
  303. common example, that's how I2C clocks are stretched: a slave that needs a
  304. slower clock delays the rising edge of SCK, and the I2C master adjusts its
  305. signaling rate accordingly.
  306. What do these conventions omit?
  307. ===============================
  308. One of the biggest things these conventions omit is pin multiplexing, since
  309. this is highly chip-specific and nonportable. One platform might not need
  310. explicit multiplexing; another might have just two options for use of any
  311. given pin; another might have eight options per pin; another might be able
  312. to route a given GPIO to any one of several pins. (Yes, those examples all
  313. come from systems that run Linux today.)
  314. Related to multiplexing is configuration and enabling of the pullups or
  315. pulldowns integrated on some platforms. Not all platforms support them,
  316. or support them in the same way; and any given board might use external
  317. pullups (or pulldowns) so that the on-chip ones should not be used.
  318. (When a circuit needs 5 kOhm, on-chip 100 kOhm resistors won't do.)
  319. Likewise drive strength (2 mA vs 20 mA) and voltage (1.8V vs 3.3V) is a
  320. platform-specific issue, as are models like (not) having a one-to-one
  321. correspondence between configurable pins and GPIOs.
  322. There are other system-specific mechanisms that are not specified here,
  323. like the aforementioned options for input de-glitching and wire-OR output.
  324. Hardware may support reading or writing GPIOs in gangs, but that's usually
  325. configuration dependent: for GPIOs sharing the same bank. (GPIOs are
  326. commonly grouped in banks of 16 or 32, with a given SOC having several such
  327. banks.) Some systems can trigger IRQs from output GPIOs, or read values
  328. from pins not managed as GPIOs. Code relying on such mechanisms will
  329. necessarily be nonportable.
  330. Dynamic definition of GPIOs is not currently standard; for example, as
  331. a side effect of configuring an add-on board with some GPIO expanders.
  332. GPIO implementor's framework (OPTIONAL)
  333. =======================================
  334. As noted earlier, there is an optional implementation framework making it
  335. easier for platforms to support different kinds of GPIO controller using
  336. the same programming interface. This framework is called "gpiolib".
  337. As a debugging aid, if debugfs is available a /sys/kernel/debug/gpio file
  338. will be found there. That will list all the controllers registered through
  339. this framework, and the state of the GPIOs currently in use.
  340. Controller Drivers: gpio_chip
  341. -----------------------------
  342. In this framework each GPIO controller is packaged as a "struct gpio_chip"
  343. with information common to each controller of that type:
  344. - methods to establish GPIO direction
  345. - methods used to access GPIO values
  346. - flag saying whether calls to its methods may sleep
  347. - optional debugfs dump method (showing extra state like pullup config)
  348. - label for diagnostics
  349. There is also per-instance data, which may come from device.platform_data:
  350. the number of its first GPIO, and how many GPIOs it exposes.
  351. The code implementing a gpio_chip should support multiple instances of the
  352. controller, possibly using the driver model. That code will configure each
  353. gpio_chip and issue gpiochip_add(). Removing a GPIO controller should be
  354. rare; use gpiochip_remove() when it is unavoidable.
  355. Most often a gpio_chip is part of an instance-specific structure with state
  356. not exposed by the GPIO interfaces, such as addressing, power management,
  357. and more. Chips such as codecs will have complex non-GPIO state.
  358. Any debugfs dump method should normally ignore signals which haven't been
  359. requested as GPIOs. They can use gpiochip_is_requested(), which returns
  360. either NULL or the label associated with that GPIO when it was requested.
  361. Platform Support
  362. ----------------
  363. To support this framework, a platform's Kconfig will "select" either
  364. ARCH_REQUIRE_GPIOLIB or ARCH_WANT_OPTIONAL_GPIOLIB
  365. and arrange that its <asm/gpio.h> includes <asm-generic/gpio.h> and defines
  366. three functions: gpio_get_value(), gpio_set_value(), and gpio_cansleep().
  367. They may also want to provide a custom value for ARCH_NR_GPIOS.
  368. ARCH_REQUIRE_GPIOLIB means that the gpio-lib code will always get compiled
  369. into the kernel on that architecture.
  370. ARCH_WANT_OPTIONAL_GPIOLIB means the gpio-lib code defaults to off and the user
  371. can enable it and build it into the kernel optionally.
  372. If neither of these options are selected, the platform does not support
  373. GPIOs through GPIO-lib and the code cannot be enabled by the user.
  374. Trivial implementations of those functions can directly use framework
  375. code, which always dispatches through the gpio_chip:
  376. #define gpio_get_value __gpio_get_value
  377. #define gpio_set_value __gpio_set_value
  378. #define gpio_cansleep __gpio_cansleep
  379. Fancier implementations could instead define those as inline functions with
  380. logic optimizing access to specific SOC-based GPIOs. For example, if the
  381. referenced GPIO is the constant "12", getting or setting its value could
  382. cost as little as two or three instructions, never sleeping. When such an
  383. optimization is not possible those calls must delegate to the framework
  384. code, costing at least a few dozen instructions. For bitbanged I/O, such
  385. instruction savings can be significant.
  386. For SOCs, platform-specific code defines and registers gpio_chip instances
  387. for each bank of on-chip GPIOs. Those GPIOs should be numbered/labeled to
  388. match chip vendor documentation, and directly match board schematics. They
  389. may well start at zero and go up to a platform-specific limit. Such GPIOs
  390. are normally integrated into platform initialization to make them always be
  391. available, from arch_initcall() or earlier; they can often serve as IRQs.
  392. Board Support
  393. -------------
  394. For external GPIO controllers -- such as I2C or SPI expanders, ASICs, multi
  395. function devices, FPGAs or CPLDs -- most often board-specific code handles
  396. registering controller devices and ensures that their drivers know what GPIO
  397. numbers to use with gpiochip_add(). Their numbers often start right after
  398. platform-specific GPIOs.
  399. For example, board setup code could create structures identifying the range
  400. of GPIOs that chip will expose, and passes them to each GPIO expander chip
  401. using platform_data. Then the chip driver's probe() routine could pass that
  402. data to gpiochip_add().
  403. Initialization order can be important. For example, when a device relies on
  404. an I2C-based GPIO, its probe() routine should only be called after that GPIO
  405. becomes available. That may mean the device should not be registered until
  406. calls for that GPIO can work. One way to address such dependencies is for
  407. such gpio_chip controllers to provide setup() and teardown() callbacks to
  408. board specific code; those board specific callbacks would register devices
  409. once all the necessary resources are available, and remove them later when
  410. the GPIO controller device becomes unavailable.
  411. Sysfs Interface for Userspace (OPTIONAL)
  412. ========================================
  413. Platforms which use the "gpiolib" implementors framework may choose to
  414. configure a sysfs user interface to GPIOs. This is different from the
  415. debugfs interface, since it provides control over GPIO direction and
  416. value instead of just showing a gpio state summary. Plus, it could be
  417. present on production systems without debugging support.
  418. Given appropriate hardware documentation for the system, userspace could
  419. know for example that GPIO #23 controls the write protect line used to
  420. protect boot loader segments in flash memory. System upgrade procedures
  421. may need to temporarily remove that protection, first importing a GPIO,
  422. then changing its output state, then updating the code before re-enabling
  423. the write protection. In normal use, GPIO #23 would never be touched,
  424. and the kernel would have no need to know about it.
  425. Again depending on appropriate hardware documentation, on some systems
  426. userspace GPIO can be used to determine system configuration data that
  427. standard kernels won't know about. And for some tasks, simple userspace
  428. GPIO drivers could be all that the system really needs.
  429. Note that standard kernel drivers exist for common "LEDs and Buttons"
  430. GPIO tasks: "leds-gpio" and "gpio_keys", respectively. Use those
  431. instead of talking directly to the GPIOs; they integrate with kernel
  432. frameworks better than your userspace code could.
  433. Paths in Sysfs
  434. --------------
  435. There are three kinds of entry in /sys/class/gpio:
  436. - Control interfaces used to get userspace control over GPIOs;
  437. - GPIOs themselves; and
  438. - GPIO controllers ("gpio_chip" instances).
  439. That's in addition to standard files including the "device" symlink.
  440. The control interfaces are write-only:
  441. /sys/class/gpio/
  442. "export" ... Userspace may ask the kernel to export control of
  443. a GPIO to userspace by writing its number to this file.
  444. Example: "echo 19 > export" will create a "gpio19" node
  445. for GPIO #19, if that's not requested by kernel code.
  446. "unexport" ... Reverses the effect of exporting to userspace.
  447. Example: "echo 19 > unexport" will remove a "gpio19"
  448. node exported using the "export" file.
  449. GPIO signals have paths like /sys/class/gpio/gpio42/ (for GPIO #42)
  450. and have the following read/write attributes:
  451. /sys/class/gpio/gpioN/
  452. "direction" ... reads as either "in" or "out". This value may
  453. normally be written. Writing as "out" defaults to
  454. initializing the value as low. To ensure glitch free
  455. operation, values "low" and "high" may be written to
  456. configure the GPIO as an output with that initial value.
  457. Note that this attribute *will not exist* if the kernel
  458. doesn't support changing the direction of a GPIO, or
  459. it was exported by kernel code that didn't explicitly
  460. allow userspace to reconfigure this GPIO's direction.
  461. "value" ... reads as either 0 (low) or 1 (high). If the GPIO
  462. is configured as an output, this value may be written;
  463. any nonzero value is treated as high.
  464. "edge" ... reads as either "none", "rising", "falling", or
  465. "both". Write these strings to select the signal edge(s)
  466. that will make poll(2) on the "value" file return.
  467. This file exists only if the pin can be configured as an
  468. interrupt generating input pin.
  469. "active_low" ... reads as either 0 (false) or 1 (true). Write
  470. any nonzero value to invert the value attribute both
  471. for reading and writing. Existing and subsequent
  472. poll(2) support configuration via the edge attribute
  473. for "rising" and "falling" edges will follow this
  474. setting.
  475. GPIO controllers have paths like /sys/class/gpio/gpiochip42/ (for the
  476. controller implementing GPIOs starting at #42) and have the following
  477. read-only attributes:
  478. /sys/class/gpio/gpiochipN/
  479. "base" ... same as N, the first GPIO managed by this chip
  480. "label" ... provided for diagnostics (not always unique)
  481. "ngpio" ... how many GPIOs this manges (N to N + ngpio - 1)
  482. Board documentation should in most cases cover what GPIOs are used for
  483. what purposes. However, those numbers are not always stable; GPIOs on
  484. a daughtercard might be different depending on the base board being used,
  485. or other cards in the stack. In such cases, you may need to use the
  486. gpiochip nodes (possibly in conjunction with schematics) to determine
  487. the correct GPIO number to use for a given signal.
  488. Exporting from Kernel code
  489. --------------------------
  490. Kernel code can explicitly manage exports of GPIOs which have already been
  491. requested using gpio_request():
  492. /* export the GPIO to userspace */
  493. int gpio_export(unsigned gpio, bool direction_may_change);
  494. /* reverse gpio_export() */
  495. void gpio_unexport();
  496. /* create a sysfs link to an exported GPIO node */
  497. int gpio_export_link(struct device *dev, const char *name,
  498. unsigned gpio)
  499. /* change the polarity of a GPIO node in sysfs */
  500. int gpio_sysfs_set_active_low(unsigned gpio, int value);
  501. After a kernel driver requests a GPIO, it may only be made available in
  502. the sysfs interface by gpio_export(). The driver can control whether the
  503. signal direction may change. This helps drivers prevent userspace code
  504. from accidentally clobbering important system state.
  505. This explicit exporting can help with debugging (by making some kinds
  506. of experiments easier), or can provide an always-there interface that's
  507. suitable for documenting as part of a board support package.
  508. After the GPIO has been exported, gpio_export_link() allows creating
  509. symlinks from elsewhere in sysfs to the GPIO sysfs node. Drivers can
  510. use this to provide the interface under their own device in sysfs with
  511. a descriptive name.
  512. Drivers can use gpio_sysfs_set_active_low() to hide GPIO line polarity
  513. differences between boards from user space. This only affects the
  514. sysfs interface. Polarity change can be done both before and after
  515. gpio_export(), and previously enabled poll(2) support for either
  516. rising or falling edge will be reconfigured to follow this setting.