[linux-2.6-block.git] / drivers / gpio / gpiolib-devres.c

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * devres.c - managed gpio resources
 * This file is based on kernel/irq/devres.c
 *
 * Copyright (c) 2011 John Crispin <john@phrozen.org>
 */

#include <linux/module.h>
#include <linux/err.h>
#include <linux/gpio.h>
#include <linux/gpio/consumer.h>
#include <linux/device.h>
#include <linux/gfp.h>

#include "gpiolib.h"

static void devm_gpiod_release(struct device *dev, void *res)
{
	struct gpio_desc **desc = res;

	gpiod_put(*desc);
}

static int devm_gpiod_match(struct device *dev, void *res, void *data)
{
	struct gpio_desc **this = res, **gpio = data;

	return *this == *gpio;
}

static void devm_gpiod_release_array(struct device *dev, void *res)
{
	struct gpio_descs **descs = res;

	gpiod_put_array(*descs);
}

static int devm_gpiod_match_array(struct device *dev, void *res, void *data)
{
	struct gpio_descs **this = res, **gpios = data;

	return *this == *gpios;
}

/**
 * devm_gpiod_get - Resource-managed gpiod_get()
 * @dev:	GPIO consumer
 * @con_id:	function within the GPIO consumer
 * @flags:	optional GPIO initialization flags
 *
 * Managed gpiod_get(). GPIO descriptors returned from this function are
 * automatically disposed on driver detach. See gpiod_get() for detailed
 * information about behavior and return values.
 */
struct gpio_desc *__must_check devm_gpiod_get(struct device *dev,
					      const char *con_id,
					      enum gpiod_flags flags)
{
	return devm_gpiod_get_index(dev, con_id, 0, flags);
}
EXPORT_SYMBOL_GPL(devm_gpiod_get);

/**
 * devm_gpiod_get_optional - Resource-managed gpiod_get_optional()
 * @dev: GPIO consumer
 * @con_id: function within the GPIO consumer
 * @flags: optional GPIO initialization flags
 *
 * Managed gpiod_get_optional(). GPIO descriptors returned from this function
 * are automatically disposed on driver detach. See gpiod_get_optional() for
 * detailed information about behavior and return values.
 */
struct gpio_desc *__must_check devm_gpiod_get_optional(struct device *dev,
						       const char *con_id,
						       enum gpiod_flags flags)
{
	return devm_gpiod_get_index_optional(dev, con_id, 0, flags);
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_optional);

/**
 * devm_gpiod_get_index - Resource-managed gpiod_get_index()
 * @dev:	GPIO consumer
 * @con_id:	function within the GPIO consumer
 * @idx:	index of the GPIO to obtain in the consumer
 * @flags:	optional GPIO initialization flags
 *
 * Managed gpiod_get_index(). GPIO descriptors returned from this function are
 * automatically disposed on driver detach. See gpiod_get_index() for detailed
 * information about behavior and return values.
 */
struct gpio_desc *__must_check devm_gpiod_get_index(struct device *dev,
						    const char *con_id,
						    unsigned int idx,
						    enum gpiod_flags flags)
{
	struct gpio_desc **dr;
	struct gpio_desc *desc;

	desc = gpiod_get_index(dev, con_id, idx, flags);
	if (IS_ERR(desc))
		return desc;

	/*
	 * For non-exclusive GPIO descriptors, check if this descriptor is
	 * already under resource management by this device.
	 */
	if (flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
		struct devres *dres;

		dres = devres_find(dev, devm_gpiod_release,
				   devm_gpiod_match, &desc);
		if (dres)
			return desc;
	}

	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
			  GFP_KERNEL);
	if (!dr) {
		gpiod_put(desc);
		return ERR_PTR(-ENOMEM);
	}

	*dr = desc;
	devres_add(dev, dr);

	return desc;
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_index);

/**
 * devm_gpiod_get_from_of_node() - obtain a GPIO from an OF node
 * @dev:	device for lifecycle management
 * @node:	handle of the OF node
 * @propname:	name of the DT property representing the GPIO
 * @index:	index of the GPIO to obtain for the consumer
 * @dflags:	GPIO initialization flags
 * @label:	label to attach to the requested GPIO
 *
 * Returns:
 * On successful request the GPIO pin is configured in accordance with
 * provided @dflags.
 *
 * In case of error an ERR_PTR() is returned.
 */
struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
					      struct device_node *node,
					      const char *propname, int index,
					      enum gpiod_flags dflags,
					      const char *label)
{
	struct gpio_desc **dr;
	struct gpio_desc *desc;

	desc = gpiod_get_from_of_node(node, propname, index, dflags, label);
	if (IS_ERR(desc))
		return desc;

	/*
	 * For non-exclusive GPIO descriptors, check if this descriptor is
	 * already under resource management by this device.
	 */
	if (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
		struct devres *dres;

		dres = devres_find(dev, devm_gpiod_release,
				   devm_gpiod_match, &desc);
		if (dres)
			return desc;
	}

	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
			  GFP_KERNEL);
	if (!dr) {
		gpiod_put(desc);
		return ERR_PTR(-ENOMEM);
	}

	*dr = desc;
	devres_add(dev, dr);

	return desc;
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_from_of_node);

/**
 * devm_fwnode_get_index_gpiod_from_child - get a GPIO descriptor from a
 *					    device's child node
 * @dev:	GPIO consumer
 * @con_id:	function within the GPIO consumer
 * @index:	index of the GPIO to obtain in the consumer
 * @child:	firmware node (child of @dev)
 * @flags:	GPIO initialization flags
 * @label:	label to attach to the requested GPIO
 *
 * GPIO descriptors returned from this function are automatically disposed on
 * driver detach.
 *
 * On successful request the GPIO pin is configured in accordance with
 * provided @flags.
 */
struct gpio_desc *devm_fwnode_get_index_gpiod_from_child(struct device *dev,
						const char *con_id, int index,
						struct fwnode_handle *child,
						enum gpiod_flags flags,
						const char *label)
{
	char prop_name[32]; /* 32 is max size of property name */
	struct gpio_desc **dr;
	struct gpio_desc *desc;
	unsigned int i;

	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
			  GFP_KERNEL);
	if (!dr)
		return ERR_PTR(-ENOMEM);

	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
		if (con_id)
			snprintf(prop_name, sizeof(prop_name), "%s-%s",
					    con_id, gpio_suffixes[i]);
		else
			snprintf(prop_name, sizeof(prop_name), "%s",
					    gpio_suffixes[i]);

		desc = fwnode_get_named_gpiod(child, prop_name, index, flags,
					      label);
		if (!IS_ERR(desc) || (PTR_ERR(desc) != -ENOENT))
			break;
	}
	if (IS_ERR(desc)) {
		devres_free(dr);
		return desc;
	}

	*dr = desc;
	devres_add(dev, dr);

	return desc;
}
EXPORT_SYMBOL_GPL(devm_fwnode_get_index_gpiod_from_child);

/**
 * devm_gpiod_get_index_optional - Resource-managed gpiod_get_index_optional()
 * @dev: GPIO consumer
 * @con_id: function within the GPIO consumer
 * @index: index of the GPIO to obtain in the consumer
 * @flags: optional GPIO initialization flags
 *
 * Managed gpiod_get_index_optional(). GPIO descriptors returned from this
 * function are automatically disposed on driver detach. See
 * gpiod_get_index_optional() for detailed information about behavior and
 * return values.
 */
struct gpio_desc *__must_check devm_gpiod_get_index_optional(struct device *dev,
							     const char *con_id,
							     unsigned int index,
							     enum gpiod_flags flags)
{
	struct gpio_desc *desc;

	desc = devm_gpiod_get_index(dev, con_id, index, flags);
	if (IS_ERR(desc)) {
		if (PTR_ERR(desc) == -ENOENT)
			return NULL;
	}

	return desc;
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_index_optional);

/**
 * devm_gpiod_get_array - Resource-managed gpiod_get_array()
 * @dev:	GPIO consumer
 * @con_id:	function within the GPIO consumer
 * @flags:	optional GPIO initialization flags
 *
 * Managed gpiod_get_array(). GPIO descriptors returned from this function are
 * automatically disposed on driver detach. See gpiod_get_array() for detailed
 * information about behavior and return values.
 */
struct gpio_descs *__must_check devm_gpiod_get_array(struct device *dev,
						     const char *con_id,
						     enum gpiod_flags flags)
{
	struct gpio_descs **dr;
	struct gpio_descs *descs;

	dr = devres_alloc(devm_gpiod_release_array,
			  sizeof(struct gpio_descs *), GFP_KERNEL);
	if (!dr)
		return ERR_PTR(-ENOMEM);

	descs = gpiod_get_array(dev, con_id, flags);
	if (IS_ERR(descs)) {
		devres_free(dr);
		return descs;
	}

	*dr = descs;
	devres_add(dev, dr);

	return descs;
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_array);

/**
 * devm_gpiod_get_array_optional - Resource-managed gpiod_get_array_optional()
 * @dev:	GPIO consumer
 * @con_id:	function within the GPIO consumer
 * @flags:	optional GPIO initialization flags
 *
 * Managed gpiod_get_array_optional(). GPIO descriptors returned from this
 * function are automatically disposed on driver detach.
 * See gpiod_get_array_optional() for detailed information about behavior and
 * return values.
 */
struct gpio_descs *__must_check
devm_gpiod_get_array_optional(struct device *dev, const char *con_id,
			      enum gpiod_flags flags)
{
	struct gpio_descs *descs;

	descs = devm_gpiod_get_array(dev, con_id, flags);
	if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
		return NULL;

	return descs;
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_array_optional);

/**
 * devm_gpiod_put - Resource-managed gpiod_put()
 * @dev:	GPIO consumer
 * @desc:	GPIO descriptor to dispose of
 *
 * Dispose of a GPIO descriptor obtained with devm_gpiod_get() or
 * devm_gpiod_get_index(). Normally this function will not be called as the GPIO
 * will be disposed of by the resource management code.
 */
void devm_gpiod_put(struct device *dev, struct gpio_desc *desc)
{
	WARN_ON(devres_release(dev, devm_gpiod_release, devm_gpiod_match,
		&desc));
}
EXPORT_SYMBOL_GPL(devm_gpiod_put);

/**
 * devm_gpiod_unhinge - Remove resource management from a gpio descriptor
 * @dev:	GPIO consumer
 * @desc:	GPIO descriptor to remove resource management from
 *
 * Remove resource management from a GPIO descriptor. This is needed when
 * you want to hand over lifecycle management of a descriptor to another
 * mechanism.
 */

void devm_gpiod_unhinge(struct device *dev, struct gpio_desc *desc)
{
	int ret;

	if (IS_ERR_OR_NULL(desc))
		return;
	ret = devres_destroy(dev, devm_gpiod_release,
			     devm_gpiod_match, &desc);
	/*
	 * If the GPIO descriptor is requested as nonexclusive, we
	 * may call this function several times on the same descriptor
	 * so it is OK if devres_destroy() returns -ENOENT.
	 */
	if (ret == -ENOENT)
		return;
	/* Anything else we should warn about */
	WARN_ON(ret);
}
EXPORT_SYMBOL_GPL(devm_gpiod_unhinge);

/**
 * devm_gpiod_put_array - Resource-managed gpiod_put_array()
 * @dev:	GPIO consumer
 * @descs:	GPIO descriptor array to dispose of
 *
 * Dispose of an array of GPIO descriptors obtained with devm_gpiod_get_array().
 * Normally this function will not be called as the GPIOs will be disposed of
 * by the resource management code.
 */
void devm_gpiod_put_array(struct device *dev, struct gpio_descs *descs)
{
	WARN_ON(devres_release(dev, devm_gpiod_release_array,
			       devm_gpiod_match_array, &descs));
}
EXPORT_SYMBOL_GPL(devm_gpiod_put_array);


static void devm_gpio_release(struct device *dev, void *res)
{
	unsigned *gpio = res;

	gpio_free(*gpio);
}

static int devm_gpio_match(struct device *dev, void *res, void *data)
{
	unsigned *this = res, *gpio = data;

	return *this == *gpio;
}

/**
 *      devm_gpio_request - request a GPIO for a managed device
 *      @dev: device to request the GPIO for
 *      @gpio: GPIO to allocate
 *      @label: the name of the requested GPIO
 *
 *      Except for the extra @dev argument, this function takes the
 *      same arguments and performs the same function as
 *      gpio_request().  GPIOs requested with this function will be
 *      automatically freed on driver detach.
 *
 *      If an GPIO allocated with this function needs to be freed
 *      separately, devm_gpio_free() must be used.
 */

int devm_gpio_request(struct device *dev, unsigned gpio, const char *label)
{
	unsigned *dr;
	int rc;

	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	if (!dr)
		return -ENOMEM;

	rc = gpio_request(gpio, label);
	if (rc) {
		devres_free(dr);
		return rc;
	}

	*dr = gpio;
	devres_add(dev, dr);

	return 0;
}
EXPORT_SYMBOL_GPL(devm_gpio_request);

/**
 *	devm_gpio_request_one - request a single GPIO with initial setup
 *	@dev:   device to request for
 *	@gpio:	the GPIO number
 *	@flags:	GPIO configuration as specified by GPIOF_*
 *	@label:	a literal description string of this GPIO
 */
int devm_gpio_request_one(struct device *dev, unsigned gpio,
			  unsigned long flags, const char *label)
{
	unsigned *dr;
	int rc;

	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	if (!dr)
		return -ENOMEM;

	rc = gpio_request_one(gpio, flags, label);
	if (rc) {
		devres_free(dr);
		return rc;
	}

	*dr = gpio;
	devres_add(dev, dr);

	return 0;
}
EXPORT_SYMBOL_GPL(devm_gpio_request_one);

/**
 *      devm_gpio_free - free a GPIO
 *      @dev: device to free GPIO for
 *      @gpio: GPIO to free
 *
 *      Except for the extra @dev argument, this function takes the
 *      same arguments and performs the same function as gpio_free().
 *      This function instead of gpio_free() should be used to manually
 *      free GPIOs allocated with devm_gpio_request().
 */
void devm_gpio_free(struct device *dev, unsigned int gpio)
{

	WARN_ON(devres_release(dev, devm_gpio_release, devm_gpio_match,
		&gpio));
}
EXPORT_SYMBOL_GPL(devm_gpio_free);
Commit	Line	Data
dae5f0af	1	/* SPDX-License-Identifier: GPL-2.0 */
1a0703ed	2	/*
dae5f0af	3	* devres.c - managed gpio resources
1a0703ed JC	4	* This file is based on kernel/irq/devres.c
1a0703ed JC	5	*
baddc7ca	6	* Copyright (c) 2011 John Crispin <john@phrozen.org>
1a0703ed JC	7	*/
	8
	9	#include <linux/module.h>
3c2c628f	10	#include <linux/err.h>
1a0703ed	11	#include <linux/gpio.h>
3c2c628f	12	#include <linux/gpio/consumer.h>
1a0703ed JC	13	#include <linux/device.h>
	14	#include <linux/gfp.h>
	15
200d0177 AS	16	#include "gpiolib.h"
200d0177 AS	17
bae48da2 AC	18	static void devm_gpiod_release(struct device dev, void res)
	19	{
	20	struct gpio_desc **desc = res;
	21
	22	gpiod_put(*desc);
	23	}
	24
	25	static int devm_gpiod_match(struct device dev, void res, void *data)
	26	{
	27	struct gpio_desc this = res, gpio = data;
	28
	29	return this == gpio;
	30	}
	31
331758ee RI	32	static void devm_gpiod_release_array(struct device dev, void res)
	33	{
	34	struct gpio_descs **descs = res;
	35
	36	gpiod_put_array(*descs);
	37	}
	38
	39	static int devm_gpiod_match_array(struct device dev, void res, void *data)
	40	{
	41	struct gpio_descs this = res, gpios = data;
	42
	43	return this == gpios;
	44	}
	45
bae48da2 AC	46	/**
	47	* devm_gpiod_get - Resource-managed gpiod_get()
	48	* @dev: GPIO consumer
	49	* @con_id: function within the GPIO consumer
39b2bbe3	50	* @flags: optional GPIO initialization flags
bae48da2 AC	51	*
	52	* Managed gpiod_get(). GPIO descriptors returned from this function are
	53	* automatically disposed on driver detach. See gpiod_get() for detailed
	54	* information about behavior and return values.
	55	*/
b17d1bf1	56	struct gpio_desc __must_check devm_gpiod_get(struct device dev,
39b2bbe3 AC	57	const char *con_id,
39b2bbe3 AC	58	enum gpiod_flags flags)
bae48da2	59	{
39b2bbe3	60	return devm_gpiod_get_index(dev, con_id, 0, flags);
bae48da2	61	}
ac571991	62	EXPORT_SYMBOL_GPL(devm_gpiod_get);
bae48da2	63
29a1f233 TR	64	/**
	65	* devm_gpiod_get_optional - Resource-managed gpiod_get_optional()
	66	* @dev: GPIO consumer
	67	* @con_id: function within the GPIO consumer
39b2bbe3	68	* @flags: optional GPIO initialization flags
29a1f233 TR	69	*
	70	* Managed gpiod_get_optional(). GPIO descriptors returned from this function
	71	* are automatically disposed on driver detach. See gpiod_get_optional() for
	72	* detailed information about behavior and return values.
	73	*/
b17d1bf1	74	struct gpio_desc __must_check devm_gpiod_get_optional(struct device dev,
39b2bbe3 AC	75	const char *con_id,
39b2bbe3 AC	76	enum gpiod_flags flags)
29a1f233	77	{
39b2bbe3	78	return devm_gpiod_get_index_optional(dev, con_id, 0, flags);
29a1f233	79	}
ac571991	80	EXPORT_SYMBOL_GPL(devm_gpiod_get_optional);
29a1f233	81
bae48da2 AC	82	/**
	83	* devm_gpiod_get_index - Resource-managed gpiod_get_index()
	84	* @dev: GPIO consumer
	85	* @con_id: function within the GPIO consumer
	86	* @idx: index of the GPIO to obtain in the consumer
39b2bbe3	87	* @flags: optional GPIO initialization flags
bae48da2 AC	88	*
	89	* Managed gpiod_get_index(). GPIO descriptors returned from this function are
	90	* automatically disposed on driver detach. See gpiod_get_index() for detailed
	91	* information about behavior and return values.
	92	*/
b17d1bf1	93	struct gpio_desc __must_check devm_gpiod_get_index(struct device dev,
bae48da2	94	const char *con_id,
39b2bbe3 AC	95	unsigned int idx,
39b2bbe3 AC	96	enum gpiod_flags flags)
bae48da2 AC	97	{
	98	struct gpio_desc **dr;
	99	struct gpio_desc *desc;
	100
cb28ee38 LW	101	desc = gpiod_get_index(dev, con_id, idx, flags);
	102	if (IS_ERR(desc))
	103	return desc;
	104
	105	/*
	106	* For non-exclusive GPIO descriptors, check if this descriptor is
	107	* already under resource management by this device.
	108	*/
	109	if (flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
	110	struct devres *dres;
	111
	112	dres = devres_find(dev, devm_gpiod_release,
	113	devm_gpiod_match, &desc);
	114	if (dres)
	115	return desc;
	116	}
	117
0f05a3ae	118	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
bae48da2	119	GFP_KERNEL);
cb28ee38 LW	120	if (!dr) {
cb28ee38 LW	121	gpiod_put(desc);
bae48da2	122	return ERR_PTR(-ENOMEM);
bae48da2 AC	123	}
	124
	125	*dr = desc;
	126	devres_add(dev, dr);
	127
5fcdb9dc	128	return desc;
bae48da2	129	}
ac571991	130	EXPORT_SYMBOL_GPL(devm_gpiod_get_index);
bae48da2	131
92542edc LW	132	/**
	133	* devm_gpiod_get_from_of_node() - obtain a GPIO from an OF node
	134	* @dev: device for lifecycle management
	135	* @node: handle of the OF node
	136	* @propname: name of the DT property representing the GPIO
	137	* @index: index of the GPIO to obtain for the consumer
	138	* @dflags: GPIO initialization flags
	139	* @label: label to attach to the requested GPIO
	140	*
	141	* Returns:
	142	* On successful request the GPIO pin is configured in accordance with
	143	* provided @dflags.
	144	*
	145	* In case of error an ERR_PTR() is returned.
	146	*/
	147	struct gpio_desc devm_gpiod_get_from_of_node(struct device dev,
	148	struct device_node *node,
	149	const char *propname, int index,
	150	enum gpiod_flags dflags,
	151	const char *label)
	152	{
	153	struct gpio_desc **dr;
	154	struct gpio_desc *desc;
	155
cb28ee38 LW	156	desc = gpiod_get_from_of_node(node, propname, index, dflags, label);
	157	if (IS_ERR(desc))
	158	return desc;
	159
	160	/*
	161	* For non-exclusive GPIO descriptors, check if this descriptor is
	162	* already under resource management by this device.
	163	*/
	164	if (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
	165	struct devres *dres;
	166
	167	dres = devres_find(dev, devm_gpiod_release,
	168	devm_gpiod_match, &desc);
	169	if (dres)
	170	return desc;
	171	}
	172
92542edc LW	173	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
92542edc LW	174	GFP_KERNEL);
cb28ee38 LW	175	if (!dr) {
cb28ee38 LW	176	gpiod_put(desc);
92542edc	177	return ERR_PTR(-ENOMEM);
92542edc LW	178	}
	179
	180	*dr = desc;
	181	devres_add(dev, dr);
	182
	183	return desc;
	184	}
ac571991	185	EXPORT_SYMBOL_GPL(devm_gpiod_get_from_of_node);
92542edc	186
40b73183	187	/**
537b94da BB	188	* devm_fwnode_get_index_gpiod_from_child - get a GPIO descriptor from a
537b94da BB	189	* device's child node
40b73183	190	* @dev: GPIO consumer
1feb57a2	191	* @con_id: function within the GPIO consumer
537b94da	192	* @index: index of the GPIO to obtain in the consumer
40b73183	193	* @child: firmware node (child of @dev)
a264d10f	194	* @flags: GPIO initialization flags
2b7c809b	195	* @label: label to attach to the requested GPIO
40b73183 MW	196	*
	197	* GPIO descriptors returned from this function are automatically disposed on
	198	* driver detach.
a264d10f	199	*
ff21378a	200	* On successful request the GPIO pin is configured in accordance with
a264d10f	201	* provided @flags.
40b73183	202	*/
537b94da BB	203	struct gpio_desc devm_fwnode_get_index_gpiod_from_child(struct device dev,
	204	const char *con_id, int index,
	205	struct fwnode_handle *child,
	206	enum gpiod_flags flags,
	207	const char *label)
40b73183	208	{
1feb57a2	209	char prop_name[32]; /* 32 is max size of property name */
40b73183 MW	210	struct gpio_desc **dr;
40b73183 MW	211	struct gpio_desc *desc;
1feb57a2	212	unsigned int i;
40b73183 MW	213
	214	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
	215	GFP_KERNEL);
	216	if (!dr)
	217	return ERR_PTR(-ENOMEM);
	218
200d0177	219	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1feb57a2 OS	220	if (con_id)
1feb57a2 OS	221	snprintf(prop_name, sizeof(prop_name), "%s-%s",
200d0177	222	con_id, gpio_suffixes[i]);
1feb57a2 OS	223	else
1feb57a2 OS	224	snprintf(prop_name, sizeof(prop_name), "%s",
200d0177	225	gpio_suffixes[i]);
1feb57a2	226
537b94da BB	227	desc = fwnode_get_named_gpiod(child, prop_name, index, flags,
537b94da BB	228	label);
40c8eaba	229	if (!IS_ERR(desc) \|\| (PTR_ERR(desc) != -ENOENT))
1feb57a2 OS	230	break;
1feb57a2 OS	231	}
40b73183 MW	232	if (IS_ERR(desc)) {
	233	devres_free(dr);
	234	return desc;
	235	}
	236
	237	*dr = desc;
	238	devres_add(dev, dr);
	239
	240	return desc;
	241	}
ac571991	242	EXPORT_SYMBOL_GPL(devm_fwnode_get_index_gpiod_from_child);
40b73183	243
29a1f233 TR	244	/**
	245	* devm_gpiod_get_index_optional - Resource-managed gpiod_get_index_optional()
	246	* @dev: GPIO consumer
	247	* @con_id: function within the GPIO consumer
	248	* @index: index of the GPIO to obtain in the consumer
39b2bbe3	249	* @flags: optional GPIO initialization flags
29a1f233 TR	250	*
	251	* Managed gpiod_get_index_optional(). GPIO descriptors returned from this
	252	* function are automatically disposed on driver detach. See
	253	* gpiod_get_index_optional() for detailed information about behavior and
	254	* return values.
	255	*/
b17d1bf1	256	struct gpio_desc __must_check devm_gpiod_get_index_optional(struct device dev,
29a1f233	257	const char *con_id,
39b2bbe3	258	unsigned int index,
b17d1bf1	259	enum gpiod_flags flags)
29a1f233 TR	260	{
	261	struct gpio_desc *desc;
	262
39b2bbe3	263	desc = devm_gpiod_get_index(dev, con_id, index, flags);
29a1f233 TR	264	if (IS_ERR(desc)) {
	265	if (PTR_ERR(desc) == -ENOENT)
	266	return NULL;
	267	}
	268
	269	return desc;
	270	}
ac571991	271	EXPORT_SYMBOL_GPL(devm_gpiod_get_index_optional);
29a1f233	272
331758ee RI	273	/**
	274	* devm_gpiod_get_array - Resource-managed gpiod_get_array()
	275	* @dev: GPIO consumer
	276	* @con_id: function within the GPIO consumer
	277	* @flags: optional GPIO initialization flags
	278	*
	279	* Managed gpiod_get_array(). GPIO descriptors returned from this function are
	280	* automatically disposed on driver detach. See gpiod_get_array() for detailed
	281	* information about behavior and return values.
	282	*/
	283	struct gpio_descs __must_check devm_gpiod_get_array(struct device dev,
	284	const char *con_id,
	285	enum gpiod_flags flags)
	286	{
	287	struct gpio_descs **dr;
	288	struct gpio_descs *descs;
	289
	290	dr = devres_alloc(devm_gpiod_release_array,
	291	sizeof(struct gpio_descs *), GFP_KERNEL);
	292	if (!dr)
	293	return ERR_PTR(-ENOMEM);
	294
	295	descs = gpiod_get_array(dev, con_id, flags);
	296	if (IS_ERR(descs)) {
	297	devres_free(dr);
	298	return descs;
	299	}
	300
	301	*dr = descs;
	302	devres_add(dev, dr);
	303
	304	return descs;
	305	}
ac571991	306	EXPORT_SYMBOL_GPL(devm_gpiod_get_array);
331758ee RI	307
	308	/**
	309	* devm_gpiod_get_array_optional - Resource-managed gpiod_get_array_optional()
	310	* @dev: GPIO consumer
	311	* @con_id: function within the GPIO consumer
	312	* @flags: optional GPIO initialization flags
	313	*
	314	* Managed gpiod_get_array_optional(). GPIO descriptors returned from this
	315	* function are automatically disposed on driver detach.
	316	* See gpiod_get_array_optional() for detailed information about behavior and
	317	* return values.
	318	*/
	319	struct gpio_descs *__must_check
	320	devm_gpiod_get_array_optional(struct device dev, const char con_id,
	321	enum gpiod_flags flags)
	322	{
	323	struct gpio_descs *descs;
	324
	325	descs = devm_gpiod_get_array(dev, con_id, flags);
	326	if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
	327	return NULL;
	328
	329	return descs;
	330	}
ac571991	331	EXPORT_SYMBOL_GPL(devm_gpiod_get_array_optional);
331758ee	332
bae48da2 AC	333	/**
bae48da2 AC	334	* devm_gpiod_put - Resource-managed gpiod_put()
2b7c809b	335	* @dev: GPIO consumer
bae48da2 AC	336	* @desc: GPIO descriptor to dispose of
	337	*
	338	* Dispose of a GPIO descriptor obtained with devm_gpiod_get() or
	339	* devm_gpiod_get_index(). Normally this function will not be called as the GPIO
	340	* will be disposed of by the resource management code.
	341	*/
	342	void devm_gpiod_put(struct device dev, struct gpio_desc desc)
	343	{
	344	WARN_ON(devres_release(dev, devm_gpiod_release, devm_gpiod_match,
	345	&desc));
	346	}
ac571991	347	EXPORT_SYMBOL_GPL(devm_gpiod_put);
bae48da2	348
891ddbc7 LW	349	/**
	350	* devm_gpiod_unhinge - Remove resource management from a gpio descriptor
	351	* @dev: GPIO consumer
	352	* @desc: GPIO descriptor to remove resource management from
	353	*
	354	* Remove resource management from a GPIO descriptor. This is needed when
	355	* you want to hand over lifecycle management of a descriptor to another
	356	* mechanism.
	357	*/
	358
	359	void devm_gpiod_unhinge(struct device dev, struct gpio_desc desc)
	360	{
	361	int ret;
	362
	363	if (IS_ERR_OR_NULL(desc))
	364	return;
	365	ret = devres_destroy(dev, devm_gpiod_release,
	366	devm_gpiod_match, &desc);
	367	/*
	368	* If the GPIO descriptor is requested as nonexclusive, we
	369	* may call this function several times on the same descriptor
	370	* so it is OK if devres_destroy() returns -ENOENT.
	371	*/
	372	if (ret == -ENOENT)
	373	return;
	374	/* Anything else we should warn about */
	375	WARN_ON(ret);
	376	}
ac571991	377	EXPORT_SYMBOL_GPL(devm_gpiod_unhinge);
891ddbc7	378
331758ee RI	379	/**
331758ee RI	380	* devm_gpiod_put_array - Resource-managed gpiod_put_array()
2b7c809b	381	* @dev: GPIO consumer
331758ee RI	382	* @descs: GPIO descriptor array to dispose of
	383	*
	384	* Dispose of an array of GPIO descriptors obtained with devm_gpiod_get_array().
	385	* Normally this function will not be called as the GPIOs will be disposed of
	386	* by the resource management code.
	387	*/
	388	void devm_gpiod_put_array(struct device dev, struct gpio_descs descs)
	389	{
	390	WARN_ON(devres_release(dev, devm_gpiod_release_array,
	391	devm_gpiod_match_array, &descs));
	392	}
ac571991	393	EXPORT_SYMBOL_GPL(devm_gpiod_put_array);
331758ee	394
bae48da2 AC	395
	396
	397
1a0703ed JC	398	static void devm_gpio_release(struct device dev, void res)
	399	{
	400	unsigned *gpio = res;
	401
	402	gpio_free(*gpio);
	403	}
	404
	405	static int devm_gpio_match(struct device dev, void res, void *data)
	406	{
	407	unsigned this = res, gpio = data;
	408
	409	return this == gpio;
	410	}
	411
	412	/**
713b7ef8 WS	413	* devm_gpio_request - request a GPIO for a managed device
	414	* @dev: device to request the GPIO for
	415	* @gpio: GPIO to allocate
	416	* @label: the name of the requested GPIO
1a0703ed JC	417	*
	418	* Except for the extra @dev argument, this function takes the
	419	* same arguments and performs the same function as
	420	* gpio_request(). GPIOs requested with this function will be
	421	* automatically freed on driver detach.
	422	*
	423	* If an GPIO allocated with this function needs to be freed
	424	* separately, devm_gpio_free() must be used.
	425	*/
	426
	427	int devm_gpio_request(struct device dev, unsigned gpio, const char label)
	428	{
	429	unsigned *dr;
	430	int rc;
	431
	432	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	433	if (!dr)
	434	return -ENOMEM;
	435
	436	rc = gpio_request(gpio, label);
	437	if (rc) {
	438	devres_free(dr);
	439	return rc;
	440	}
	441
	442	*dr = gpio;
	443	devres_add(dev, dr);
	444
	445	return 0;
	446	}
ac571991	447	EXPORT_SYMBOL_GPL(devm_gpio_request);
1a0703ed	448
09d71ff1 MB	449	/**
	450	* devm_gpio_request_one - request a single GPIO with initial setup
	451	* @dev: device to request for
	452	* @gpio: the GPIO number
	453	* @flags: GPIO configuration as specified by GPIOF_*
	454	* @label: a literal description string of this GPIO
	455	*/
	456	int devm_gpio_request_one(struct device *dev, unsigned gpio,
	457	unsigned long flags, const char *label)
	458	{
	459	unsigned *dr;
	460	int rc;
	461
	462	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	463	if (!dr)
	464	return -ENOMEM;
	465
	466	rc = gpio_request_one(gpio, flags, label);
	467	if (rc) {
	468	devres_free(dr);
	469	return rc;
	470	}
	471
	472	*dr = gpio;
	473	devres_add(dev, dr);
	474
	475	return 0;
	476	}
ac571991	477	EXPORT_SYMBOL_GPL(devm_gpio_request_one);
09d71ff1	478
1a0703ed	479	/**
713b7ef8 WS	480	* devm_gpio_free - free a GPIO
	481	* @dev: device to free GPIO for
	482	* @gpio: GPIO to free
1a0703ed JC	483	*
	484	* Except for the extra @dev argument, this function takes the
	485	* same arguments and performs the same function as gpio_free().
	486	* This function instead of gpio_free() should be used to manually
	487	* free GPIOs allocated with devm_gpio_request().
	488	*/
	489	void devm_gpio_free(struct device *dev, unsigned int gpio)
	490	{
	491
a85990b3	492	WARN_ON(devres_release(dev, devm_gpio_release, devm_gpio_match,
1a0703ed	493	&gpio));
1a0703ed	494	}
ac571991	495	EXPORT_SYMBOL_GPL(devm_gpio_free);