€•cz      Œ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”Œ1/translations/zh_CN/driver-api/gpio/legacy-boards”Œ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”Œ1/translations/zh_TW/driver-api/gpio/legacy-boards”Œ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”Œ1/translations/it_IT/driver-api/gpio/legacy-boards”Œ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”Œ1/translations/ja_JP/driver-api/gpio/legacy-boards”Œ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”Œ1/translations/ko_KR/driver-api/gpio/legacy-boards”Œ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”Œ1/translations/sp_SP/driver-api/gpio/legacy-boards”Œ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ŒSupporting Legacy Boards”h]”hŒSupporting Legacy Boards”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒK/var/lib/git/docbuild/linux/Documentation/driver-api/gpio/legacy-boards.rst”h KubhŒ	paragraph”“”)”}”(hX  Many drivers in the kernel, such as ``leds-gpio`` and ``gpio-keys``, are
migrating away from using board-specific ``platform_data`` to a unified device
properties interface. This interface allows drivers to be simpler and more
generic, as they can query properties in a standardized way.”h]”(hŒ$Many drivers in the kernel, such as ”…””}”(hh¹hžhhŸNh NubhŒliteral”“”)”}”(hŒ``leds-gpio``”h]”hŒ	leds-gpio”…””}”(hhÃhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhh¹ubhŒ and ”…””}”(hh¹hžhhŸNh NubhÂ)”}”(hŒ``gpio-keys``”h]”hŒ	gpio-keys”…””}”(hhÕhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhh¹ubhŒ/, are
migrating away from using board-specific ”…””}”(hh¹hžhhŸNh NubhÂ)”}”(hŒ``platform_data``”h]”hŒplatform_data”…””}”(hhçhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhh¹ubhŒœ to a unified device
properties interface. This interface allows drivers to be simpler and more
generic, as they can query properties in a standardized way.”…””}”(hh¹hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hXb  On modern systems, these properties are provided via device tree. However, some
older platforms have not been converted to device tree and instead rely on
board files to describe their hardware configuration. To bridge this gap and
allow these legacy boards to work with modern, generic drivers, the kernel
provides a mechanism called **software nodes**.”h]”(hXO  On modern systems, these properties are provided via device tree. However, some
older platforms have not been converted to device tree and instead rely on
board files to describe their hardware configuration. To bridge this gap and
allow these legacy boards to work with modern, generic drivers, the kernel
provides a mechanism called ”…””}”(hhÿhžhhŸNh NubhŒstrong”“”)”}”(hŒ**software nodes**”h]”hŒsoftware nodes”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hhÿubhŒ.”…””}”(hhÿhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K	hh£hžhubh¸)”}”(hŒÈThis document provides a guide on how to convert a legacy board file from using
``platform_data`` and ``gpiod_lookup_table`` to the modern software node
approach for describing GPIO-connected devices.”h]”(hŒPThis document provides a guide on how to convert a legacy board file from using
”…””}”(hj!  hžhhŸNh NubhÂ)”}”(hŒ``platform_data``”h]”hŒplatform_data”…””}”(hj)  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj!  ubhŒ and ”…””}”(hj!  hžhhŸNh NubhÂ)”}”(hŒ``gpiod_lookup_table``”h]”hŒgpiod_lookup_table”…””}”(hj;  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj!  ubhŒL to the modern software node
approach for describing GPIO-connected devices.”…””}”(hj!  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒThe Core Idea: Software Nodes”h]”hŒThe Core Idea: Software Nodes”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjS  hžhhŸh¶h Kubh¸)”}”(hXœ  Software nodes allow board-specific code to construct an in-memory,
device-tree-like structure using struct software_node and struct
property_entry. This structure can then be associated with a platform device,
allowing drivers to use the standard device properties API (e.g.,
device_property_read_u32(), device_property_read_string()) to query
configuration, just as they would on an ACPI or device tree system.”h]”hXœ  Software nodes allow board-specific code to construct an in-memory,
device-tree-like structure using struct software_node and struct
property_entry. This structure can then be associated with a platform device,
allowing drivers to use the standard device properties API (e.g.,
device_property_read_u32(), device_property_read_string()) to query
configuration, just as they would on an ACPI or device tree system.”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjS  hžhubh¸)”}”(hŒÞThe gpiolib code has support for handling software nodes, so that if GPIO is
described properly, as detailed in the section below, then regular gpiolib APIs,
such as gpiod_get(), gpiod_get_optional(), and others will work.”h]”hŒÞThe gpiolib code has support for handling software nodes, so that if GPIO is
described properly, as detailed in the section below, then regular gpiolib APIs,
such as gpiod_get(), gpiod_get_optional(), and others will work.”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjS  hžhubh¢)”}”(hhh]”(h§)”}”(hŒ Requirements for GPIO Properties”h]”hŒ Requirements for GPIO Properties”…””}”(hjƒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj€  hžhhŸh¶h K"ubh¸)”}”(hŒ”When using software nodes to describe GPIO connections, the following
requirements must be met for the GPIO core to correctly resolve the reference:”h]”hŒ”When using software nodes to describe GPIO connections, the following
requirements must be met for the GPIO core to correctly resolve the reference:”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K$hj€  hžhubhŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hXn  **The GPIO controller's software node "name" must match the controller's
"label".** The gpiolib core uses this name to find the corresponding
struct gpio_chip at runtime.
This software node has to be registered, but need not be attached to the
device representing the GPIO controller that is providing the GPIO in
question. It may be left as a "free floating" node.
”h]”h¸)”}”(hXm  **The GPIO controller's software node "name" must match the controller's
"label".** The gpiolib core uses this name to find the corresponding
struct gpio_chip at runtime.
This software node has to be registered, but need not be attached to the
device representing the GPIO controller that is providing the GPIO in
question. It may be left as a "free floating" node.”h]”(j  )”}”(hŒS**The GPIO controller's software node "name" must match the controller's
"label".**”h]”hŒ[The GPIO controllerâ€™s software node â€œnameâ€ must match the controllerâ€™s
â€œlabelâ€.”…””}”(hj®  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hjª  ubhX   The gpiolib core uses this name to find the corresponding
struct gpio_chip at runtime.
This software node has to be registered, but need not be attached to the
device representing the GPIO controller that is providing the GPIO in
question. It may be left as a â€œfree floatingâ€ node.”…””}”(hjª  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K'hj¦  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj¡  hžhhŸh¶h Nubj¥  )”}”(hŒŒ**The GPIO property must be a reference.** The ``PROPERTY_ENTRY_GPIO()``
macro handles this as it is an alias for ``PROPERTY_ENTRY_REF()``.
”h]”h¸)”}”(hŒ‹**The GPIO property must be a reference.** The ``PROPERTY_ENTRY_GPIO()``
macro handles this as it is an alias for ``PROPERTY_ENTRY_REF()``.”h]”(j  )”}”(hŒ***The GPIO property must be a reference.**”h]”hŒ&The GPIO property must be a reference.”…””}”(hjÔ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hjÐ  ubhŒ The ”…””}”(hjÐ  hžhhŸNh NubhÂ)”}”(hŒ``PROPERTY_ENTRY_GPIO()``”h]”hŒPROPERTY_ENTRY_GPIO()”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhjÐ  ubhŒ*
macro handles this as it is an alias for ”…””}”(hjÐ  hžhhŸNh NubhÂ)”}”(hŒ``PROPERTY_ENTRY_REF()``”h]”hŒPROPERTY_ENTRY_REF()”…””}”(hjø  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhjÐ  ubhŒ.”…””}”(hjÐ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K.hjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj¡  hžhhŸh¶h Nubj¥  )”}”(hŒÕ**The reference must have exactly two arguments:**

- The first argument is the GPIO offset within the controller.
- The second argument is the flags for the GPIO line (e.g.,
  GPIO_ACTIVE_HIGH, GPIO_ACTIVE_LOW).
”h]”(h¸)”}”(hŒ2**The reference must have exactly two arguments:**”h]”j  )”}”(hj  h]”hŒ.The reference must have exactly two arguments:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K1hj  ubhŒbullet_list”“”)”}”(hhh]”(j¥  )”}”(hŒ<The first argument is the GPIO offset within the controller.”h]”h¸)”}”(hj8  h]”hŒ<The first argument is the GPIO offset within the controller.”…””}”(hj:  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K3hj6  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj3  ubj¥  )”}”(hŒ^The second argument is the flags for the GPIO line (e.g.,
GPIO_ACTIVE_HIGH, GPIO_ACTIVE_LOW).
”h]”h¸)”}”(hŒ]The second argument is the flags for the GPIO line (e.g.,
GPIO_ACTIVE_HIGH, GPIO_ACTIVE_LOW).”h]”hŒ]The second argument is the flags for the GPIO line (e.g.,
GPIO_ACTIVE_HIGH, GPIO_ACTIVE_LOW).”…””}”(hjQ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K4hjM  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj3  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j1  hŸh¶h K3hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj¡  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1jŸ  hj€  hžhhŸh¶h K'ubh¸)”}”(hŒgThe ``PROPERTY_ENTRY_GPIO()`` macro is the preferred way of defining GPIO
properties in software nodes.”h]”(hŒThe ”…””}”(hj~  hžhhŸNh NubhÂ)”}”(hŒ``PROPERTY_ENTRY_GPIO()``”h]”hŒPROPERTY_ENTRY_GPIO()”…””}”(hj†  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj~  ubhŒJ macro is the preferred way of defining GPIO
properties in software nodes.”…””}”(hj~  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K7hj€  hžhubeh}”(h]”Œ requirements-for-gpio-properties”ah ]”h"]”Œ requirements for gpio properties”ah$]”h&]”uh1h¡hjS  hžhhŸh¶h K"ubeh}”(h]”Œthe-core-idea-software-nodes”ah ]”h"]”Œthe core idea: software nodes”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒConversion Example”h]”hŒConversion Example”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj®  hžhhŸh¶h K;ubh¸)”}”(hŒiLet's walk through an example of converting a board file that defines a GPIO-
connected LED and a button.”h]”hŒkLetâ€™s walk through an example of converting a board file that defines a GPIO-
connected LED and a button.”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K=hj®  hžhubh¢)”}”(hhh]”(h§)”}”(hŒBefore: Using Platform Data”h]”hŒBefore: Using Platform Data”…””}”(hjÐ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÍ  hžhhŸh¶h KAubh¸)”}”(hŒ1A typical legacy board file might look like this:”h]”hŒ1A typical legacy board file might look like this:”…””}”(hjÞ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KChjÍ  hžhubhŒliteral_block”“”)”}”(hXæ  #include <linux/platform_device.h>
#include <linux/leds.h>
#include <linux/gpio_keys.h>
#include <linux/gpio/machine.h>

#define MYBOARD_GPIO_CONTROLLER "gpio-foo"

/* LED setup */
static const struct gpio_led myboard_leds[] = {
      {
              .name = "myboard:green:status",
              .default_trigger = "heartbeat",
      },
};

static const struct gpio_led_platform_data myboard_leds_pdata = {
      .num_leds = ARRAY_SIZE(myboard_leds),
      .leds = myboard_leds,
};

static struct gpiod_lookup_table myboard_leds_gpios = {
      .dev_id = "leds-gpio",
      .table = {
              GPIO_LOOKUP_IDX(MYBOARD_GPIO_CONTROLLER, 42, NULL, 0, GPIO_ACTIVE_HIGH),
              { },
      },
};

/* Button setup */
static struct gpio_keys_button myboard_buttons[] = {
      {
              .code = KEY_WPS_BUTTON,
              .desc = "WPS Button",
              .active_low = 1,
      },
};

static const struct gpio_keys_platform_data myboard_buttons_pdata = {
      .buttons = myboard_buttons,
      .nbuttons = ARRAY_SIZE(myboard_buttons),
};

static struct gpiod_lookup_table myboard_buttons_gpios = {
      .dev_id = "gpio-keys",
      .table = {
              GPIO_LOOKUP_IDX(MYBOARD_GPIO_CONTROLLER, 15, NULL, 0, GPIO_ACTIVE_LOW),
              { },
      },
};

/* Device registration */
static int __init myboard_init(void)
{
      gpiod_add_lookup_table(&myboard_leds_gpios);
      gpiod_add_lookup_table(&myboard_buttons_gpios);

      platform_device_register_data(NULL, "leds-gpio", -1,
                                    &myboard_leds_pdata, sizeof(myboard_leds_pdata));
      platform_device_register_data(NULL, "gpio-keys", -1,
                                    &myboard_buttons_pdata, sizeof(myboard_buttons_pdata));

      return 0;
}”h]”hXæ  #include <linux/platform_device.h>
#include <linux/leds.h>
#include <linux/gpio_keys.h>
#include <linux/gpio/machine.h>

#define MYBOARD_GPIO_CONTROLLER "gpio-foo"

/* LED setup */
static const struct gpio_led myboard_leds[] = {
      {
              .name = "myboard:green:status",
              .default_trigger = "heartbeat",
      },
};

static const struct gpio_led_platform_data myboard_leds_pdata = {
      .num_leds = ARRAY_SIZE(myboard_leds),
      .leds = myboard_leds,
};

static struct gpiod_lookup_table myboard_leds_gpios = {
      .dev_id = "leds-gpio",
      .table = {
              GPIO_LOOKUP_IDX(MYBOARD_GPIO_CONTROLLER, 42, NULL, 0, GPIO_ACTIVE_HIGH),
              { },
      },
};

/* Button setup */
static struct gpio_keys_button myboard_buttons[] = {
      {
              .code = KEY_WPS_BUTTON,
              .desc = "WPS Button",
              .active_low = 1,
      },
};

static const struct gpio_keys_platform_data myboard_buttons_pdata = {
      .buttons = myboard_buttons,
      .nbuttons = ARRAY_SIZE(myboard_buttons),
};

static struct gpiod_lookup_table myboard_buttons_gpios = {
      .dev_id = "gpio-keys",
      .table = {
              GPIO_LOOKUP_IDX(MYBOARD_GPIO_CONTROLLER, 15, NULL, 0, GPIO_ACTIVE_LOW),
              { },
      },
};

/* Device registration */
static int __init myboard_init(void)
{
      gpiod_add_lookup_table(&myboard_leds_gpios);
      gpiod_add_lookup_table(&myboard_buttons_gpios);

      platform_device_register_data(NULL, "leds-gpio", -1,
                                    &myboard_leds_pdata, sizeof(myboard_leds_pdata));
      platform_device_register_data(NULL, "gpio-keys", -1,
                                    &myboard_buttons_pdata, sizeof(myboard_buttons_pdata));

      return 0;
}”…””}”hjî  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”Œforce”‰Œlanguage”Œc”Œhighlight_args”}”uh1jì  hŸh¶h KEhjÍ  hžhubeh}”(h]”Œbefore-using-platform-data”ah ]”h"]”Œbefore: using platform data”ah$]”h&]”uh1h¡hj®  hžhhŸh¶h KAubh¢)”}”(hhh]”(h§)”}”(hŒAfter: Using Software Nodes”h]”hŒAfter: Using Software Nodes”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h Kˆubh¸)”}”(hŒIHere is how the same configuration can be expressed using software nodes.”h]”hŒIHere is how the same configuration can be expressed using software nodes.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŠhj  hžhubh¢)”}”(hhh]”(h§)”}”(hŒ'Step 1: Define the GPIO Controller Node”h]”hŒ'Step 1: Define the GPIO Controller Node”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj*  hžhhŸh¶h Kubh¸)”}”(hŒÕFirst, define a software node that represents the GPIO controller that the
LEDs and buttons are connected to. The ``name`` of this node must match the
name of the driver for the GPIO controller (e.g., "gpio-foo").”h]”(hŒrFirst, define a software node that represents the GPIO controller that the
LEDs and buttons are connected to. The ”…””}”(hj;  hžhhŸNh NubhÂ)”}”(hŒ``name``”h]”hŒname”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj;  ubhŒ_ of this node must match the
name of the driver for the GPIO controller (e.g., â€œgpio-fooâ€).”…””}”(hj;  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj*  hžhubjí  )”}”(hŒÖ#include <linux/property.h>
#include <linux/gpio/property.h>

#define MYBOARD_GPIO_CONTROLLER "gpio-foo"

static const struct software_node myboard_gpio_controller_node = {
      .name = MYBOARD_GPIO_CONTROLLER,
};”h]”hŒÖ#include <linux/property.h>
#include <linux/gpio/property.h>

#define MYBOARD_GPIO_CONTROLLER "gpio-foo"

static const struct software_node myboard_gpio_controller_node = {
      .name = MYBOARD_GPIO_CONTROLLER,
};”…””}”hj[  sbah}”(h]”h ]”h"]”h$]”h&]”jü  jý  jþ  ‰jÿ  j   j  }”uh1jì  hŸh¶h K“hj*  hžhubeh}”(h]”Œ&step-1-define-the-gpio-controller-node”ah ]”h"]”Œ'step 1: define the gpio controller node”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒ3Step 2: Define Consumer Device Nodes and Properties”h]”hŒ3Step 2: Define Consumer Device Nodes and Properties”…””}”(hju  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjr  hžhhŸh¶h KŸubh¸)”}”(hŒ½Next, define the software nodes for the consumer devices (the LEDs and buttons).
This involves creating a parent node for each device type and child nodes for
each individual LED or button.”h]”hŒ½Next, define the software nodes for the consumer devices (the LEDs and buttons).
This involves creating a parent node for each device type and child nodes for
each individual LED or button.”…””}”(hjƒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¡hjr  hžhubjí  )”}”(hXw  /* LED setup */
static const struct software_node myboard_leds_node = {
      .name = "myboard-leds",
};

static const struct property_entry myboard_status_led_props[] = {
      PROPERTY_ENTRY_STRING("label", "myboard:green:status"),
      PROPERTY_ENTRY_STRING("linux,default-trigger", "heartbeat"),
      PROPERTY_ENTRY_GPIO("gpios", &myboard_gpio_controller_node, 42, GPIO_ACTIVE_HIGH),
      { }
};

static const struct software_node myboard_status_led_swnode = {
      .name = "status-led",
      .parent = &myboard_leds_node,
      .properties = myboard_status_led_props,
};

/* Button setup */
static const struct software_node myboard_keys_node = {
      .name = "myboard-keys",
};

static const struct property_entry myboard_wps_button_props[] = {
      PROPERTY_ENTRY_STRING("label", "WPS Button"),
      PROPERTY_ENTRY_U32("linux,code", KEY_WPS_BUTTON),
      PROPERTY_ENTRY_GPIO("gpios", &myboard_gpio_controller_node, 15, GPIO_ACTIVE_LOW),
      { }
};

static const struct software_node myboard_wps_button_swnode = {
      .name = "wps-button",
      .parent = &myboard_keys_node,
      .properties = myboard_wps_button_props,
};”h]”hXw  /* LED setup */
static const struct software_node myboard_leds_node = {
      .name = "myboard-leds",
};

static const struct property_entry myboard_status_led_props[] = {
      PROPERTY_ENTRY_STRING("label", "myboard:green:status"),
      PROPERTY_ENTRY_STRING("linux,default-trigger", "heartbeat"),
      PROPERTY_ENTRY_GPIO("gpios", &myboard_gpio_controller_node, 42, GPIO_ACTIVE_HIGH),
      { }
};

static const struct software_node myboard_status_led_swnode = {
      .name = "status-led",
      .parent = &myboard_leds_node,
      .properties = myboard_status_led_props,
};

/* Button setup */
static const struct software_node myboard_keys_node = {
      .name = "myboard-keys",
};

static const struct property_entry myboard_wps_button_props[] = {
      PROPERTY_ENTRY_STRING("label", "WPS Button"),
      PROPERTY_ENTRY_U32("linux,code", KEY_WPS_BUTTON),
      PROPERTY_ENTRY_GPIO("gpios", &myboard_gpio_controller_node, 15, GPIO_ACTIVE_LOW),
      { }
};

static const struct software_node myboard_wps_button_swnode = {
      .name = "wps-button",
      .parent = &myboard_keys_node,
      .properties = myboard_wps_button_props,
};”…””}”hj‘  sbah}”(h]”h ]”h"]”h$]”h&]”jü  jý  jþ  ‰jÿ  j   j  }”uh1jì  hŸh¶h K¥hjr  hžhubeh}”(h]”Œ2step-2-define-consumer-device-nodes-and-properties”ah ]”h"]”Œ3step 2: define consumer device nodes and properties”ah$]”h&]”uh1h¡hj  hžhhŸh¶h KŸubh¢)”}”(hhh]”(h§)”}”(hŒ$Step 3: Group and Register the Nodes”h]”hŒ$Step 3: Group and Register the Nodes”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj¨  hžhhŸh¶h KÎubh¸)”}”(hŒ|For maintainability, it is often beneficial to group all software nodes into a
single array and register them with one call.”h]”hŒ|For maintainability, it is often beneficial to group all software nodes into a
single array and register them with one call.”…””}”(hj¹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÐhj¨  hžhubjí  )”}”(hX  static const struct software_node * const myboard_swnodes[] = {
      &myboard_gpio_controller_node,
      &myboard_leds_node,
      &myboard_status_led_swnode,
      &myboard_keys_node,
      &myboard_wps_button_swnode,
      NULL
};

static int __init myboard_init(void)
{
      int error;

      error = software_node_register_node_group(myboard_swnodes);
      if (error) {
              pr_err("Failed to register software nodes: %d\n", error);
              return error;
      }

      // ... platform device registration follows
}”h]”hX  static const struct software_node * const myboard_swnodes[] = {
      &myboard_gpio_controller_node,
      &myboard_leds_node,
      &myboard_status_led_swnode,
      &myboard_keys_node,
      &myboard_wps_button_swnode,
      NULL
};

static int __init myboard_init(void)
{
      int error;

      error = software_node_register_node_group(myboard_swnodes);
      if (error) {
              pr_err("Failed to register software nodes: %d\n", error);
              return error;
      }

      // ... platform device registration follows
}”…””}”hjÇ  sbah}”(h]”h ]”h"]”h$]”h&]”jü  jý  jþ  ‰jÿ  j   j  }”uh1jì  hŸh¶h KÓhj¨  hžhubhŒnote”“”)”}”(hŒÓWhen splitting registration of nodes by devices that they represent, it is
essential that the software node representing the GPIO controller itself
is registered first, before any of the nodes that reference it.”h]”h¸)”}”(hŒÓWhen splitting registration of nodes by devices that they represent, it is
essential that the software node representing the GPIO controller itself
is registered first, before any of the nodes that reference it.”h]”hŒÓWhen splitting registration of nodes by devices that they represent, it is
essential that the software node representing the GPIO controller itself
is registered first, before any of the nodes that reference it.”…””}”(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¨  hžhhŸh¶h Nubeh}”(h]”Œ#step-3-group-and-register-the-nodes”ah ]”h"]”Œ$step 3: group and register the nodes”ah$]”h&]”uh1h¡hj  hžhhŸh¶h KÎubh¢)”}”(hhh]”(h§)”}”(hŒ5Step 4: Register Platform Devices with Software Nodes”h]”hŒ5Step 4: Register Platform Devices with Software Nodes”…””}”(hjû  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjø  hžhhŸh¶h Kñubh¸)”}”(hŒ™Finally, register the platform devices and associate them with their respective
software nodes using the ``fwnode`` field in struct platform_device_info.”h]”(hŒiFinally, register the platform devices and associate them with their respective
software nodes using the ”…””}”(hj	  hžhhŸNh NubhÂ)”}”(hŒ
``fwnode``”h]”hŒfwnode”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj	  ubhŒ& field in struct platform_device_info.”…””}”(hj	  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kóhjø  hžhubjí  )”}”(hX‹  static struct platform_device *leds_pdev;
static struct platform_device *keys_pdev;

static int __init myboard_init(void)
{
      struct platform_device_info pdev_info;
      int error;

      error = software_node_register_node_group(myboard_swnodes);
      if (error)
              return error;

      memset(&pdev_info, 0, sizeof(pdev_info));
      pdev_info.name = "leds-gpio";
      pdev_info.id = PLATFORM_DEVID_NONE;
      pdev_info.fwnode = software_node_fwnode(&myboard_leds_node);
      leds_pdev = platform_device_register_full(&pdev_info);
      if (IS_ERR(leds_pdev)) {
              error = PTR_ERR(leds_pdev);
              goto err_unregister_nodes;
      }

      memset(&pdev_info, 0, sizeof(pdev_info));
      pdev_info.name = "gpio-keys";
      pdev_info.id = PLATFORM_DEVID_NONE;
      pdev_info.fwnode = software_node_fwnode(&myboard_keys_node);
      keys_pdev = platform_device_register_full(&pdev_info);
      if (IS_ERR(keys_pdev)) {
              error = PTR_ERR(keys_pdev);
              platform_device_unregister(leds_pdev);
              goto err_unregister_nodes;
      }

      return 0;

err_unregister_nodes:
      software_node_unregister_node_group(myboard_swnodes);
      return error;
}

static void __exit myboard_exit(void)
{
      platform_device_unregister(keys_pdev);
      platform_device_unregister(leds_pdev);
      software_node_unregister_node_group(myboard_swnodes);
}”h]”hX‹  static struct platform_device *leds_pdev;
static struct platform_device *keys_pdev;

static int __init myboard_init(void)
{
      struct platform_device_info pdev_info;
      int error;

      error = software_node_register_node_group(myboard_swnodes);
      if (error)
              return error;

      memset(&pdev_info, 0, sizeof(pdev_info));
      pdev_info.name = "leds-gpio";
      pdev_info.id = PLATFORM_DEVID_NONE;
      pdev_info.fwnode = software_node_fwnode(&myboard_leds_node);
      leds_pdev = platform_device_register_full(&pdev_info);
      if (IS_ERR(leds_pdev)) {
              error = PTR_ERR(leds_pdev);
              goto err_unregister_nodes;
      }

      memset(&pdev_info, 0, sizeof(pdev_info));
      pdev_info.name = "gpio-keys";
      pdev_info.id = PLATFORM_DEVID_NONE;
      pdev_info.fwnode = software_node_fwnode(&myboard_keys_node);
      keys_pdev = platform_device_register_full(&pdev_info);
      if (IS_ERR(keys_pdev)) {
              error = PTR_ERR(keys_pdev);
              platform_device_unregister(leds_pdev);
              goto err_unregister_nodes;
      }

      return 0;

err_unregister_nodes:
      software_node_unregister_node_group(myboard_swnodes);
      return error;
}

static void __exit myboard_exit(void)
{
      platform_device_unregister(keys_pdev);
      platform_device_unregister(leds_pdev);
      software_node_unregister_node_group(myboard_swnodes);
}”…””}”hj)  sbah}”(h]”h ]”h"]”h$]”h&]”jü  jý  jþ  ‰jÿ  j   j  }”uh1jì  hŸh¶h Köhjø  hžhubh¸)”}”(hŒíWith these changes, the generic ``leds-gpio`` and ``gpio-keys`` drivers will
be able to probe successfully and get their configuration from the properties
defined in the software nodes, removing the need for board-specific platform
data.”h]”(hŒ With these changes, the generic ”…””}”(hj8  hžhhŸNh NubhÂ)”}”(hŒ``leds-gpio``”h]”hŒ	leds-gpio”…””}”(hj@  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj8  ubhŒ and ”…””}”(hj8  hžhhŸNh NubhÂ)”}”(hŒ``gpio-keys``”h]”hŒ	gpio-keys”…””}”(hjR  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÁhj8  ubhŒ® drivers will
be able to probe successfully and get their configuration from the properties
defined in the software nodes, removing the need for board-specific platform
data.”…””}”(hj8  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M'hjø  hžhubeh}”(h]”Œ4step-4-register-platform-devices-with-software-nodes”ah ]”h"]”Œ5step 4: register platform devices with software nodes”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kñubeh}”(h]”Œafter-using-software-nodes”ah ]”h"]”Œafter: using software nodes”ah$]”h&]”uh1h¡hj®  hžhhŸh¶h Kˆubeh}”(h]”Œconversion-example”ah ]”h"]”Œconversion example”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K;ubeh}”(h]”Œsupporting-legacy-boards”ah ]”h"]”Œsupporting legacy boards”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  jw  jt  jo  jl  j¥  j¢  jõ  jò  jo  jl  uŒ	nametypes”}”(j‡  ‰j«  ‰j£  ‰j  ‰j  ‰jw  ‰jo  ‰j¥  ‰jõ  ‰jo  ‰uh}”(j„  h£j¨  jS  j   j€  j|  j®  j  jÍ  jt  j  jl  j*  j¢  jr  jò  j¨  jl  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.