GPIO device tree configuration

Purpose

The purpose of this article is to explain how to configure the GPIO internal peripheral through the GPIOLib framework when this peripheral is assigned to Linux^® OS. The configuration is performed using the device tree.

To better understand I/O management, it is recommended to read the I/O pins overview article .

This article also provides an example explaining how to add a new GPIO in the device tree.

If the peripheral is assigned to another execution context, refer to How to assign an internal peripheral to a runtime context article for guidelines on peripheral assignment and configuration.

DT bindings documentation

The STM32 GPIO bindings are composed of:

• Bindings for GPIO controller

• Bindings for devices using a GPIO

It is recommended to read these reference documents if you have never played with GPIO DT.

DT configuration

DT configuration (STM32 level)

The GPIO controller node (gpio controller) is located in the pin controller node that is declared Inside the pinctrl dtsi file, stm32mp157-pinctrl.dtsi. See Device tree for more explanations about device tree files split.

There is one gpio controller node per GPIO bank.

Refer to Pin controller configuration and to GPIO controller node bindings for explanations on the gpio controller node.

This device tree part is related to STM32 microprocessors. It should be kept as is, without being modified by the end-user.

DT configuration (board level)

Generic guidelines for adding a GPIO to a client device can be found in the document "GPIO bindings for board" .

• Below an example of basic GPIO usage extracted from "GPIO bindings for board" :

GPIO mappings are defined in the consumer device node, through a property named <function>-gpios, where <function> is requested by the Linux driver through gpiod_get().

foo_device {
		...
		led-gpios = <&gpioa 15 GPIO_ACTIVE_HIGH>, /* red */
			    <&gpioa 16 GPIO_ACTIVE_HIGH>, /* green */
			    <&gpioa 17 GPIO_ACTIVE_HIGH>; /* blue */

		power-gpios = <&gpiob 1 GPIO_ACTIVE_LOW>;
	};

Where:

- &gpiox: phandle on gpio-controller node.

- 15: line offset in gpio-controller.

- GPIO_ACTIVE_HIGH: flag to be used for the GPIO. The list of all available GPIO flags can be found in Linux kernel source code.

DT configuration examples

How to add a GPIO dedicated to a device connected on the board

The example below shows how to add a GPIOB5 (PB5 on schematics) to a foo_device.

foo_device {
		...
		x-gpios = <&gpiob 5 GPIO_ACTIVE_HIGH>; /* x function */
                ...
	};

Note: GPIO_ACTIVE_HIGH means that the GPIO line is driven by the logical level 1 , while GPIO_ACTIVE_LOW means that it is driven by the logical level 0.

How to configure GPIOs using STM32CubeMX

The STM32CubeMX tool can be used to configure the STM32MPU device and get the corresponding platform configuration device tree files.
The STM32CubeMX may not support all the properties described in the above DT bindings documentation paragraph. If so, the tool inserts user sections in the generated device tree. These sections can then be edited to add some properties and they are preserved from one generation to another. Refer to STM32CubeMX user manual for further information.

References

Please refer to the following links for additional information:

<securetransclude src="ProtectedTemplate:PublicationRequestId" params="8782 | 2018-09-14 | AnneJ"></securetransclude> <securetransclude src="ProtectedTemplate:ArticleBasedOnModel" params="Peripheral or framework device tree configuration model"></securetransclude> <securetransclude src="ProtectedTemplate:ReviewsComments" params="JCT 1840: alignment needed with the last version of the model<br>"></securetransclude>{{#set:Has reviews comments=true}}