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