Re: [PATCH v5 10/12] gpio: Support for unified device properties interface

[Arnd Bergmann <arnd@arndb.de>]

On Friday 17 October 2014 20:09:51 Arnd Bergmann wrote:
> On October 17, 2014 2:16:00 PM CEST, "Rafael J. Wysocki" <rjw@rjwysocki.net> wrote:
> >From: Mika Westerberg <mika.westerberg@linux.intel.com>
> >
> >Some drivers need to deal with only firmware representation of its
> >GPIOs. An example would be a GPIO button array driver where each button
> >is described as a separate firmware node in device tree. Typically
> >these
> >child nodes do not have physical representation in the Linux device
> >model.
> >
> >In order to help device drivers to handle such firmware child nodes we
> >add dev[m]_get_named_gpiod_from_child() that takes a child firmware
> >node pointer as its second argument (the first one is the parent device
> >itself), finds the GPIO using whatever is the underlying firmware
> >method, and requests the GPIO properly.
> 
> Could we also have a wrapper around this function without a "name" argument,
> using just the index?

Expanding on this thought: I think we should mandate for new bindings
that they use either a name and no index, or an index but not name,
and I also think that for named gpios, we should try to converge on a
common naming scheme. As discussed, we will probably want to support all
the existing ways to do this even with ACPI and with the unified
interface, but it doesn't have to be the obvious way.

We could do it like this:

// internal implementation, may be called from drivers with legacy bindings 
struct gpio_desc *__fwnode_get_gpiod_from_property(struct fwnode_handle *fwnode,
                                           const char *propname, int index)
{
	... /* your current code */
}

// recommended interface
static inline struct gpio_desc *fwnode_get_gpiod(struct fwnode_handle *fwnode,
						  int index)
{
	return __fwnode_get_gpiod_from_property(fwnode, "gpios", index);
}

// alternative interface
struct gpio_desc *fwnode_get_gpiod(struct fwnode_handle *fwnode, const char *name)
{
	char propname[64];
	int ret;
	
	ret = snprintf(propname, sizeof(propname), "%s-gpios", name);
	if (ret > sizeof(propname))
		return -EINVAL;

	return __fwnode_get_gpiod_from_property(fwnode, propname, 0);
}

The above is just a suggestion, I'm hoping for the GPIO maintainers to
provide more guidance if they have other ideas.

	Arnd