Skip to content

gpiolib: Add GPIO name support

Johan Hovold linux-arm-kernel linux-gpio 1 version New

Get series with b4
b4 am 20150728141619.GP28535@localhost

Versions newest first

  1. v1 Latest9 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/9gpiolib: Fix possible use of wrong name+0 -01 reply
3/9gpio: Allow hogged gpios to be requested+0 -02 replies
4/9gpio: Add 'name' to the gpio descriptor struct+0 -00 replies
6/9gpiolib-of: Reuse 'line-name' from DT as gpio descriptor name+0 -01 reply
7/9gpiolib-sysfs: Add gpio name parsing for sysfs export+0 -01 reply
7/9gpiolib-sysfs: Add gpio name parsing for sysfs export+0 -00 replies
8/9gpiolib-sysfs: Show gpio-name in /sys/class/gpio/gpio*/name+0 -01 reply
9/9gpiolib: Add gpio name information to /sys/kernel/debug/gpio+0 -01 reply
9/9gpiolib: Add gpio name information to /sys/kernel/debug/gpio+0 -03 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/9] gpiolib: Add GPIO name support
Quoted 36 lines · Linus Walleij
Quoted 19 lines · Markus Pargmann

This is a proposal to add GPIO names to the kernel based on devicetree descriptions.

This series adds GPIO name support. Until now it is only possible to use names for already requested GPIOs (for example what they are used for). It is not possible to identify GPIOs by a name although most of them have a name for example in the schematics of the board. This makes it difficult to identify a specific GPIO from userspace.

As the GPIO name information is a hardware description this series uses the devicetree bindings introduced by the GPIO hogging mechanism, specifically 'line-name', to identify GPIOs. The sysfs 'export' file is changed to accept names as fallback. The gpio numbers still have a higher priority to ensure backwards compatibility.

Exported GPIOs are still using their number as directory name (gpio<ID>). But the directories now contain a 'name' file which is '(null)' for non-existent names and the name otherwise.

Quoted 7 lines

This series can be used to have an easy name mapping for udev with a quite simple rule similar to this:

        SUBSYSTEM=="gpio", KERNEL=="gpio*", ATTR{name}!="(null)", ACTION=="add", \
        PROGRAM+="/bin/sh -c 'mkdir -p /dev/gpios; rm -f /dev/gpios/$attr{name}; ln -s /sys%p/ /dev/gpios/$attr{name}"

With this rule udev adds a link for each exported GPIO with a name into /dev/gpios/. This way it is not necessary to know the number of a GPIO to use it.

I must say I like this series.

Because it makes the GPIO sysfs ABI *less* insane. Especially I like the patch that makes a distinction between "label" (use) and "name" (the name of the actual line). That illustrates clearly that this is thought-through.

Quoted 5 lines

However I still have some doubts as it will expand the sysfs ABI, and we have discussed a char device for GPIO chips as a better alternative, for example since these can do get/set multiple GPIOs with a single context switch (ioctl), whereas sysfs is "one value per file" and would be able to expose some flags better.

I'm also reluctant to band-aiding the sysfs interface with more ABI that we need to maintain forever. Making it easier to use also reduces the incentives to come up with a saner interface.

As I mentioned in a comment to patch 6/9, this series introduces an incompatibility with current DT since it no longer allows two hogs to use the same name, while the current hog implementation is documented to fall back to using the (not necessarily unique) node name when a line-name property isn't specified.

Even though this looks like it could be worked around, it's an example of the kind of issues we risk running into if we keep on incrementally patching this interface.

That said, this is a step along the lines that we have discussed in the past. Adding pin functions (line names) to generic pin nodes in DT makes sense, but we need to think through the details first. For example:

- Should we allow duplicate pin functions (line names)? We need to consider not just on-chip controllers, but also hot-pluggable controllers and device-tree overlays.

- Should we allow initial configurations to be specified and still allow (some) pins to be requested later ("soft" hogging)?

- Should we specify pin directionality? I've suggested elsewhere that adding such limitations (e.g. as a mask) may make sense in cases were changing pin direction is known to cause damage.

- What would a new gpio interface look like?

Johan