€•„      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ)/translations/zh_CN/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ)/translations/zh_TW/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ)/translations/it_IT/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ)/translations/ja_JP/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ)/translations/ko_KR/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ)/translations/sp_SP/driver-api/gpio/board”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒGPIO Mappings”h]”hŒGPIO Mappings”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒC/var/lib/git/docbuild/linux/Documentation/driver-api/gpio/board.rst”h KubhŒ	paragraph”“”)”}”(hŒPThis document explains how GPIOs can be assigned to given devices and functions.”h]”hŒPThis document explains how GPIOs can be assigned to given devices and functions.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hXN  All platforms can enable the GPIO library, but if the platform strictly
requires GPIO functionality to be present, it needs to select GPIOLIB from its
Kconfig. Then, how GPIOs are mapped depends on what the platform uses to
describe its hardware layout. Currently, mappings can be defined through device
tree, ACPI, and platform data.”h]”hXN  All platforms can enable the GPIO library, but if the platform strictly
requires GPIO functionality to be present, it needs to select GPIOLIB from its
Kconfig. Then, how GPIOs are mapped depends on what the platform uses to
describe its hardware layout. Currently, mappings can be defined through device
tree, ACPI, and platform data.”…””}”(hhÇhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒDevice Tree”h]”hŒDevice Tree”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhÕhžhhŸh¶h Kubh¸)”}”(hŒÄGPIOs can easily be mapped to devices and functions in the device tree. The
exact way to do it depends on the GPIO controller providing the GPIOs, see the
device tree bindings for your controller.”h]”hŒÄGPIOs can easily be mapped to devices and functions in the device tree. The
exact way to do it depends on the GPIO controller providing the GPIOs, see the
device tree bindings for your controller.”…””}”(hhæhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÕhžhubh¸)”}”(hŒ»GPIOs mappings are defined in the consumer device's node, in a property named
<function>-gpios, where <function> is the function the driver will request
through gpiod_get(). For example::”h]”hŒ¼GPIOs mappings are defined in the consumer deviceâ€™s node, in a property named
<function>-gpios, where <function> is the function the driver will request
through gpiod_get(). For example:”…””}”(hhôhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÕhžhubhŒliteral_block”“”)”}”(hX"  foo_device {
        compatible = "acme,foo";
        ...
        led-gpios = <&gpio 15 GPIO_ACTIVE_HIGH>, /* red */
                    <&gpio 16 GPIO_ACTIVE_HIGH>, /* green */
                    <&gpio 17 GPIO_ACTIVE_HIGH>; /* blue */

        power-gpios = <&gpio 1 GPIO_ACTIVE_LOW>;
};”h]”hX"  foo_device {
        compatible = "acme,foo";
        ...
        led-gpios = <&gpio 15 GPIO_ACTIVE_HIGH>, /* red */
                    <&gpio 16 GPIO_ACTIVE_HIGH>, /* green */
                    <&gpio 17 GPIO_ACTIVE_HIGH>; /* blue */

        power-gpios = <&gpio 1 GPIO_ACTIVE_LOW>;
};”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j  hŸh¶h KhhÕhžhubh¸)”}”(hŒËProperties named <function>-gpio are also considered valid and old bindings use
it but are only supported for compatibility reasons and should not be used for
newer bindings since it has been deprecated.”h]”hŒËProperties named <function>-gpio are also considered valid and old bindings use
it but are only supported for compatibility reasons and should not be used for
newer bindings since it has been deprecated.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K!hhÕhžhubh¸)”}”(hŒ~This property will make GPIOs 15, 16 and 17 available to the driver under the
"led" function, and GPIO 1 as the "power" GPIO::”h]”hŒ…This property will make GPIOs 15, 16 and 17 available to the driver under the
â€œledâ€ function, and GPIO 1 as the â€œpowerâ€ GPIO:”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K%hhÕhžhubj  )”}”(hX  struct gpio_desc *red, *green, *blue, *power;

red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);

power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);”h]”hX  struct gpio_desc *red, *green, *blue, *power;

red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);

power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);”…””}”hj0  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K(hhÕhžhubh¸)”}”(hŒzThe led GPIOs will be active high, while the power GPIO will be active low (i.e.
gpiod_is_active_low(power) will be true).”h]”hŒzThe led GPIOs will be active high, while the power GPIO will be active low (i.e.
gpiod_is_active_low(power) will be true).”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K0hhÕhžhubh¸)”}”(hX=  The second parameter of the gpiod_get() functions, the con_id string, has to be
the <function>-prefix of the GPIO suffixes ("gpios" or "gpio", automatically
looked up by the gpiod functions internally) used in the device tree. With above
"led-gpios" example, use the prefix without the "-" as con_id parameter: "led".”h]”hXQ  The second parameter of the gpiod_get() functions, the con_id string, has to be
the <function>-prefix of the GPIO suffixes (â€œgpiosâ€ or â€œgpioâ€, automatically
looked up by the gpiod functions internally) used in the device tree. With above
â€œled-gpiosâ€ example, use the prefix without the â€œ-â€ as con_id parameter: â€œledâ€.”…””}”(hjL  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K3hhÕhžhubh¸)”}”(hŒ½Internally, the GPIO subsystem prefixes the GPIO suffix ("gpios" or "gpio")
with the string passed in con_id to get the resulting string
(``snprintf(... "%s-%s", con_id, gpio_suffixes[]``).”h]”(hŒ’Internally, the GPIO subsystem prefixes the GPIO suffix (â€œgpiosâ€ or â€œgpioâ€)
with the string passed in con_id to get the resulting string
(”…””}”(hjZ  hžhhŸNh NubhŒliteral”“”)”}”(hŒ1``snprintf(... "%s-%s", con_id, gpio_suffixes[]``”h]”hŒ-snprintf(... "%s-%s", con_id, gpio_suffixes[]”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jb  hjZ  ubhŒ).”…””}”(hjZ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K8hhÕhžhubeh}”(h]”Œdevice-tree”ah ]”h"]”Œdevice tree”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒACPI”h]”hŒACPI”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj„  hžhhŸh¶h K=ubh¸)”}”(hŒÖACPI also supports function names for GPIOs in a similar fashion to DT.
The above DT example can be converted to an equivalent ACPI description
with the help of _DSD (Device Specific Data), introduced in ACPI 5.1::”h]”hŒÕACPI also supports function names for GPIOs in a similar fashion to DT.
The above DT example can be converted to an equivalent ACPI description
with the help of _DSD (Device Specific Data), introduced in ACPI 5.1:”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K>hj„  hžhubj  )”}”(hXè  Device (FOO) {
        Name (_CRS, ResourceTemplate () {
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 15 } // red
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 16 } // green
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 17 } // blue
                GpioIo (Exclusive, PullNone, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 1 } // power
        })

        Name (_DSD, Package () {
                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
                Package () {
                        Package () {
                                "led-gpios",
                                Package () {
                                        ^FOO, 0, 0, 1,
                                        ^FOO, 1, 0, 1,
                                        ^FOO, 2, 0, 1,
                                }
                        },
                        Package () { "power-gpios", Package () { ^FOO, 3, 0, 0 } },
                }
        })
}”h]”hXè  Device (FOO) {
        Name (_CRS, ResourceTemplate () {
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 15 } // red
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 16 } // green
                GpioIo (Exclusive, PullUp, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 17 } // blue
                GpioIo (Exclusive, PullNone, 0, 0, IoRestrictionOutputOnly,
                        "\\_SB.GPI0", 0, ResourceConsumer) { 1 } // power
        })

        Name (_DSD, Package () {
                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
                Package () {
                        Package () {
                                "led-gpios",
                                Package () {
                                        ^FOO, 0, 0, 1,
                                        ^FOO, 1, 0, 1,
                                        ^FOO, 2, 0, 1,
                                }
                        },
                        Package () { "power-gpios", Package () { ^FOO, 3, 0, 0 } },
                }
        })
}”…””}”hj£  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h KBhj„  hžhubh¸)”}”(hŒlFor more information about the ACPI GPIO bindings see
Documentation/firmware-guide/acpi/gpio-properties.rst.”h]”hŒlFor more information about the ACPI GPIO bindings see
Documentation/firmware-guide/acpi/gpio-properties.rst.”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K^hj„  hžhubeh}”(h]”Œacpi”ah ]”h"]”Œacpi”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K=ubh¢)”}”(hhh]”(h§)”}”(hŒPlatform Data”h]”hŒPlatform Data”…””}”(hjÊ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÇ  hžhhŸh¶h Kbubh¸)”}”(hŒ‘Finally, GPIOs can be bound to devices and functions using platform data. Board
files that desire to do so need to include the following header::”h]”hŒFinally, GPIOs can be bound to devices and functions using platform data. Board
files that desire to do so need to include the following header:”…””}”(hjØ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KchjÇ  hžhubj  )”}”(hŒ#include <linux/gpio/machine.h>”h]”hŒ#include <linux/gpio/machine.h>”…””}”hjæ  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h KfhjÇ  hžhubh¸)”}”(hŒ GPIOs are mapped by the means of tables of lookups, containing instances of the
gpiod_lookup structure. Two macros are defined to help declaring such mappings::”h]”hŒŸGPIOs are mapped by the means of tables of lookups, containing instances of the
gpiod_lookup structure. Two macros are defined to help declaring such mappings:”…””}”(hjô  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhjÇ  hžhubj  )”}”(hŒ`GPIO_LOOKUP(key, chip_hwnum, con_id, flags)
GPIO_LOOKUP_IDX(key, chip_hwnum, con_id, idx, flags)”h]”hŒ`GPIO_LOOKUP(key, chip_hwnum, con_id, flags)
GPIO_LOOKUP_IDX(key, chip_hwnum, con_id, idx, flags)”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h KkhjÇ  hžhubh¸)”}”(hŒwhere”h]”hŒwhere”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KnhjÇ  hžhubhŒblock_quote”“”)”}”(hXÚ  - key is either the label of the gpiod_chip instance providing the GPIO, or
  the GPIO line name
- chip_hwnum is the hardware number of the GPIO within the chip, or U16_MAX
  to indicate that key is a GPIO line name
- con_id is the name of the GPIO function from the device point of view. It
      can be NULL, in which case it will match any function.
- idx is the index of the GPIO within the function.
- flags is defined to specify the following properties:
      * GPIO_ACTIVE_HIGH      - GPIO line is active high
      * GPIO_ACTIVE_LOW       - GPIO line is active low
      * GPIO_OPEN_DRAIN       - GPIO line is set up as open drain
      * GPIO_OPEN_SOURCE      - GPIO line is set up as open source
      * GPIO_PERSISTENT       - GPIO line is persistent during
                                suspend/resume and maintains its value
      * GPIO_TRANSITORY       - GPIO line is transitory and may loose its
                                electrical state during suspend/resume
”h]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ\key is either the label of the gpiod_chip instance providing the GPIO, or
the GPIO line name”h]”h¸)”}”(hŒ\key is either the label of the gpiod_chip instance providing the GPIO, or
the GPIO line name”h]”hŒ\key is either the label of the gpiod_chip instance providing the GPIO, or
the GPIO line name”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kphj+  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj&  ubj*  )”}”(hŒrchip_hwnum is the hardware number of the GPIO within the chip, or U16_MAX
to indicate that key is a GPIO line name”h]”h¸)”}”(hŒrchip_hwnum is the hardware number of the GPIO within the chip, or U16_MAX
to indicate that key is a GPIO line name”h]”hŒrchip_hwnum is the hardware number of the GPIO within the chip, or U16_MAX
to indicate that key is a GPIO line name”…””}”(hjG  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KrhjC  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj&  ubj*  )”}”(hŒ„con_id is the name of the GPIO function from the device point of view. It
    can be NULL, in which case it will match any function.”h]”hŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒ€con_id is the name of the GPIO function from the device point of view. It
can be NULL, in which case it will match any function.”h]”(hŒterm”“”)”}”(hŒIcon_id is the name of the GPIO function from the device point of view. It”h]”hŒIcon_id is the name of the GPIO function from the device point of view. It”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jj  hŸh¶h Kthjf  ubhŒ
definition”“”)”}”(hhh]”h¸)”}”(hŒ6can be NULL, in which case it will match any function.”h]”hŒ6can be NULL, in which case it will match any function.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kuhj|  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hjf  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jd  hŸh¶h Kthja  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j_  hj[  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj&  ubj*  )”}”(hŒ1idx is the index of the GPIO within the function.”h]”h¸)”}”(hj§  h]”hŒ1idx is the index of the GPIO within the function.”…””}”(hj©  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kvhj¥  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj&  ubj*  )”}”(hX3  flags is defined to specify the following properties:
    * GPIO_ACTIVE_HIGH      - GPIO line is active high
    * GPIO_ACTIVE_LOW       - GPIO line is active low
    * GPIO_OPEN_DRAIN       - GPIO line is set up as open drain
    * GPIO_OPEN_SOURCE      - GPIO line is set up as open source
    * GPIO_PERSISTENT       - GPIO line is persistent during
                              suspend/resume and maintains its value
    * GPIO_TRANSITORY       - GPIO line is transitory and may loose its
                              electrical state during suspend/resume
”h]”j`  )”}”(hhh]”je  )”}”(hX  flags is defined to specify the following properties:
* GPIO_ACTIVE_HIGH      - GPIO line is active high
* GPIO_ACTIVE_LOW       - GPIO line is active low
* GPIO_OPEN_DRAIN       - GPIO line is set up as open drain
* GPIO_OPEN_SOURCE      - GPIO line is set up as open source
* GPIO_PERSISTENT       - GPIO line is persistent during
                          suspend/resume and maintains its value
* GPIO_TRANSITORY       - GPIO line is transitory and may loose its
                          electrical state during suspend/resume
”h]”(jk  )”}”(hŒ5flags is defined to specify the following properties:”h]”hŒ5flags is defined to specify the following properties:”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jj  hŸh¶h KhjÃ  ubj{  )”}”(hhh]”j%  )”}”(hhh]”(j*  )”}”(hŒ0GPIO_ACTIVE_HIGH      - GPIO line is active high”h]”h¸)”}”(hjÝ  h]”hŒ0GPIO_ACTIVE_HIGH      - GPIO line is active high”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KxhjÛ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubj*  )”}”(hŒ/GPIO_ACTIVE_LOW       - GPIO line is active low”h]”h¸)”}”(hjô  h]”hŒ/GPIO_ACTIVE_LOW       - GPIO line is active low”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kyhjò  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubj*  )”}”(hŒ9GPIO_OPEN_DRAIN       - GPIO line is set up as open drain”h]”h¸)”}”(hj  h]”hŒ9GPIO_OPEN_DRAIN       - GPIO line is set up as open drain”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kzhj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubj*  )”}”(hŒ:GPIO_OPEN_SOURCE      - GPIO line is set up as open source”h]”h¸)”}”(hj"  h]”hŒ:GPIO_OPEN_SOURCE      - GPIO line is set up as open source”…””}”(hj$  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K{hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubj*  )”}”(hŒuGPIO_PERSISTENT       - GPIO line is persistent during
                        suspend/resume and maintains its value”h]”j`  )”}”(hhh]”je  )”}”(hŒ]GPIO_PERSISTENT       - GPIO line is persistent during
suspend/resume and maintains its value”h]”(jk  )”}”(hŒ6GPIO_PERSISTENT       - GPIO line is persistent during”h]”hŒ6GPIO_PERSISTENT       - GPIO line is persistent during”…””}”(hjB  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jj  hŸh¶h K|hj>  ubj{  )”}”(hhh]”h¸)”}”(hŒ&suspend/resume and maintains its value”h]”hŒ&suspend/resume and maintains its value”…””}”(hjS  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K}hjP  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hj>  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jd  hŸh¶h K|hj;  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j_  hj7  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubj*  )”}”(hŒGPIO_TRANSITORY       - GPIO line is transitory and may loose its
                        electrical state during suspend/resume
”h]”j`  )”}”(hhh]”je  )”}”(hŒiGPIO_TRANSITORY       - GPIO line is transitory and may loose its
electrical state during suspend/resume
”h]”(jk  )”}”(hŒAGPIO_TRANSITORY       - GPIO line is transitory and may loose its”h]”hŒAGPIO_TRANSITORY       - GPIO line is transitory and may loose its”…””}”(hj„  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jj  hŸh¶h Khj€  ubj{  )”}”(hhh]”h¸)”}”(hŒ&electrical state during suspend/resume”h]”hŒ&electrical state during suspend/resume”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj’  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hj€  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jd  hŸh¶h Khj}  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j_  hjy  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjØ  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1j$  hŸh¶h KxhjÕ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hjÃ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jd  hŸh¶h KhjÀ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j_  hj¼  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj&  ubeh}”(h]”h ]”h"]”h$]”h&]”jÁ  Œ-”uh1j$  hŸh¶h Kphj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh¶h KphjÇ  hžhubh¸)”}”(hŒHIn the future, these flags might be extended to support more properties.”h]”hŒHIn the future, these flags might be extended to support more properties.”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjÇ  hžhubj`  )”}”(hhh]”je  )”}”(hŒºNote that:
1. GPIO line names are not guaranteed to be globally unique, so the first
   match found will be used.
2. GPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.
”h]”(jk  )”}”(hŒ
Note that:”h]”hŒ
Note that:”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jj  hŸh¶h K†hjù  ubj{  )”}”(hhh]”hŒenumerated_list”“”)”}”(hhh]”(j*  )”}”(hŒ`GPIO line names are not guaranteed to be globally unique, so the first
match found will be used.”h]”h¸)”}”(hŒ`GPIO line names are not guaranteed to be globally unique, so the first
match found will be used.”h]”hŒ`GPIO line names are not guaranteed to be globally unique, so the first
match found will be used.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K„hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj  ubj*  )”}”(hŒEGPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.
”h]”h¸)”}”(hŒDGPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.”h]”hŒDGPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K†hj+  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1j  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hjù  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jd  hŸh¶h K†hjö  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j_  hjÇ  hžhhŸNh Nubh¸)”}”(hX  A lookup table can then be defined as follows, with an empty entry defining its
end. The 'dev_id' field of the table is the identifier of the device that will
make use of these GPIOs. It can be NULL, in which case it will be matched for
calls to gpiod_get() with a NULL device.”h]”hX  A lookup table can then be defined as follows, with an empty entry defining its
end. The â€˜dev_idâ€™ field of the table is the identifier of the device that will
make use of these GPIOs. It can be NULL, in which case it will be matched for
calls to gpiod_get() with a NULL device.”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KˆhjÇ  hžhubj  )”}”(hXŸ  struct gpiod_lookup_table gpios_table = {
        .dev_id = "foo.0",
        .table = {
                GPIO_LOOKUP_IDX("gpio.0", 15, "led", 0, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("gpio.0", 16, "led", 1, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("gpio.0", 17, "led", 2, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP("gpio.0", 1, "power", GPIO_ACTIVE_LOW),
                { },
        },
};”h]”hXŸ  struct gpiod_lookup_table gpios_table = {
        .dev_id = "foo.0",
        .table = {
                GPIO_LOOKUP_IDX("gpio.0", 15, "led", 0, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("gpio.0", 16, "led", 1, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("gpio.0", 17, "led", 2, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP("gpio.0", 1, "power", GPIO_ACTIVE_LOW),
                { },
        },
};”…””}”hjn  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  Œforce”‰Œlanguage”Œc”Œhighlight_args”}”uh1j  hŸh¶h KhjÇ  hžhubh¸)”}”(hŒ9And the table can be added by the board code as follows::”h]”hŒ8And the table can be added by the board code as follows:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KšhjÇ  hžhubj  )”}”(hŒ%gpiod_add_lookup_table(&gpios_table);”h]”hŒ%gpiod_add_lookup_table(&gpios_table);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h KœhjÇ  hžhubh¸)”}”(hŒQThe driver controlling "foo.0" will then be able to obtain its GPIOs as follows::”h]”hŒTThe driver controlling â€œfoo.0â€ will then be able to obtain its GPIOs as follows:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KžhjÇ  hžhubj  )”}”(hX  struct gpio_desc *red, *green, *blue, *power;

red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);

power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);”h]”hX  struct gpio_desc *red, *green, *blue, *power;

red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);

power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);”…””}”hj«  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K hjÇ  hžhubh¸)”}”(hXg  Since the "led" GPIOs are mapped as active-high, this example will switch their
signals to 1, i.e. enabling the LEDs. And for the "power" GPIO, which is mapped
as active-low, its actual signal will be 0 after this code. Contrary to the
legacy integer GPIO interface, the active-low property is handled during
mapping and is thus transparent to GPIO consumers.”h]”hXo  Since the â€œledâ€ GPIOs are mapped as active-high, this example will switch their
signals to 1, i.e. enabling the LEDs. And for the â€œpowerâ€ GPIO, which is mapped
as active-low, its actual signal will be 0 after this code. Contrary to the
legacy integer GPIO interface, the active-low property is handled during
mapping and is thus transparent to GPIO consumers.”…””}”(hj¹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¨hjÇ  hžhubh¸)”}”(hŒmA set of functions such as gpiod_set_value() is available to work with
the new descriptor-oriented interface.”h]”hŒmA set of functions such as gpiod_set_value() is available to work with
the new descriptor-oriented interface.”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K®hjÇ  hžhubh¸)”}”(hŒOBoards using platform data can also hog GPIO lines by defining GPIO hog tables.”h]”hŒOBoards using platform data can also hog GPIO lines by defining GPIO hog tables.”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K±hjÇ  hžhubj  )”}”(hŒ|struct gpiod_hog gpio_hog_table[] = {
        GPIO_HOG("gpio.0", 10, "foo", GPIO_ACTIVE_LOW, GPIOD_OUT_HIGH),
        { }
};”h]”hŒ|struct gpiod_hog gpio_hog_table[] = {
        GPIO_HOG("gpio.0", 10, "foo", GPIO_ACTIVE_LOW, GPIOD_OUT_HIGH),
        { }
};”…””}”hjã  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  j|  ‰j}  j~  j  }”uh1j  hŸh¶h K³hjÇ  hžhubh¸)”}”(hŒ9And the table can be added to the board code as follows::”h]”hŒ8And the table can be added to the board code as follows:”…””}”(hjò  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KºhjÇ  hžhubj  )”}”(hŒgpiod_add_hogs(gpio_hog_table);”h]”hŒgpiod_add_hogs(gpio_hog_table);”…””}”hj   sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K¼hjÇ  hžhubh¸)”}”(hŒˆThe line will be hogged as soon as the gpiochip is created or - in case the
chip was created earlier - when the hog table is registered.”h]”hŒˆThe line will be hogged as soon as the gpiochip is created or - in case the
chip was created earlier - when the hog table is registered.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¾hjÇ  hžhubeh}”(h]”Œplatform-data”ah ]”h"]”Œplatform data”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kbubh¢)”}”(hhh]”(h§)”}”(hŒArrays of pins”h]”hŒArrays of pins”…””}”(hj'  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj$  hžhhŸh¶h KÂubh¸)”}”(hXƒ  In addition to requesting pins belonging to a function one by one, a device may
also request an array of pins assigned to the function.  The way those pins are
mapped to the device determines if the array qualifies for fast bitmap
processing.  If yes, a bitmap is passed over get/set array functions directly
between a caller and a respective .get/set_multiple() callback of a GPIO chip.”h]”hXƒ  In addition to requesting pins belonging to a function one by one, a device may
also request an array of pins assigned to the function.  The way those pins are
mapped to the device determines if the array qualifies for fast bitmap
processing.  If yes, a bitmap is passed over get/set array functions directly
between a caller and a respective .get/set_multiple() callback of a GPIO chip.”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÃhj$  hžhubh¸)”}”(hŒ_In order to qualify for fast bitmap processing, the array must meet the
following requirements:”h]”hŒ_In order to qualify for fast bitmap processing, the array must meet the
following requirements:”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÉhj$  hžhubj%  )”}”(hhh]”(j*  )”}”(hŒ5pin hardware number of array member 0 must also be 0,”h]”h¸)”}”(hjV  h]”hŒ5pin hardware number of array member 0 must also be 0,”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÌhjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjQ  hžhhŸh¶h Nubj*  )”}”(hŒ†pin hardware numbers of consecutive array members which belong to the same
chip as member 0 does must also match their array indexes.
”h]”h¸)”}”(hŒ…pin hardware numbers of consecutive array members which belong to the same
chip as member 0 does must also match their array indexes.”h]”hŒ…pin hardware numbers of consecutive array members which belong to the same
chip as member 0 does must also match their array indexes.”…””}”(hjo  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÍhjk  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hjQ  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”jÁ  já  uh1j$  hŸh¶h KÌhj$  hžhubh¸)”}”(hŒ¬Otherwise fast bitmap processing path is not used in order to avoid consecutive
pins which belong to the same chip but are not in hardware order being processed
separately.”h]”hŒ¬Otherwise fast bitmap processing path is not used in order to avoid consecutive
pins which belong to the same chip but are not in hardware order being processed
separately.”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÐhj$  hžhubh¸)”}”(hXK  If the array applies for fast bitmap processing path, pins which belong to
different chips than member 0 does, as well as those with indexes different from
their hardware pin numbers, are excluded from the fast path, both input and
output.  Moreover, open drain and open source pins are excluded from fast bitmap
output processing.”h]”hXK  If the array applies for fast bitmap processing path, pins which belong to
different chips than member 0 does, as well as those with indexes different from
their hardware pin numbers, are excluded from the fast path, both input and
output.  Moreover, open drain and open source pins are excluded from fast bitmap
output processing.”…””}”(hj—  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÔhj$  hžhubeh}”(h]”Œarrays-of-pins”ah ]”h"]”Œarrays of pins”ah$]”h&]”uh1h¡hh£hžhhŸh¶h KÂubeh}”(h]”Œgpio-mappings”ah ]”h"]”Œgpio mappings”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jØ  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j²  j¯  j  j~  jÄ  jÁ  j!  j  jª  j§  uŒ	nametypes”}”(j²  ‰j  ‰jÄ  ‰j!  ‰jª  ‰uh}”(j¯  h£j~  hÕjÁ  j„  j  jÇ  j§  j$  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.