[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_gpiod_get_index - get a GPIO descriptor from a given node
 * @dev:	GPIO consumer
 * @fwnode:	firmware node containing GPIO reference
 * @con_id:	function within the GPIO consumer
 * @index:	index of the GPIO to obtain in the consumer
 * @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_gpiod_get_index(struct device *dev,
					      struct fwnode_handle *fwnode,
					      const char *con_id, int index,
					      enum gpiod_flags flags,
					      const char *label)
{
	struct gpio_desc **dr;
	struct gpio_desc *desc;

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

	desc = fwnode_gpiod_get_index(fwnode, con_id, index, flags, label);
	if (IS_ERR(desc)) {
		devres_free(dr);
		return desc;
	}

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

	return desc;
}
EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index);

/**
 * 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 (gpiod_not_found(desc))
		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 (gpiod_not_found(descs))
		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);

static void devm_gpio_chip_release(void *data)
{
	struct gpio_chip *gc = data;

	gpiochip_remove(gc);
}

/**
 * devm_gpiochip_add_data_with_key() - Resource managed gpiochip_add_data_with_key()
 * @dev: pointer to the device that gpio_chip belongs to.
 * @gc: the GPIO chip to register
 * @data: driver-private data associated with this chip
 * @lock_key: lockdep class for IRQ lock
 * @request_key: lockdep class for IRQ request
 *
 * Context: potentially before irqs will work
 *
 * The gpio chip automatically be released when the device is unbound.
 *
 * Returns:
 * A negative errno if the chip can't be registered, such as because the
 * gc->base is invalid or already associated with a different chip.
 * Otherwise it returns zero as a success code.
 */
int devm_gpiochip_add_data_with_key(struct device *dev, struct gpio_chip *gc, void *data,
				    struct lock_class_key *lock_key,
				    struct lock_class_key *request_key)
{
	int ret;

	ret = gpiochip_add_data_with_key(gc, data, lock_key, request_key);
	if (ret < 0)
		return ret;

	return devm_add_action_or_reset(dev, devm_gpio_chip_release, gc);
}
EXPORT_SYMBOL_GPL(devm_gpiochip_add_data_with_key);
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	/**
2d2f116d	188	* devm_fwnode_gpiod_get_index - get a GPIO descriptor from a given node
40b73183	189	* @dev: GPIO consumer
2d2f116d	190	* @fwnode: firmware node containing GPIO reference
1feb57a2	191	* @con_id: function within the GPIO consumer
537b94da	192	* @index: index of the GPIO to obtain in the consumer
a264d10f	193	* @flags: GPIO initialization flags
2b7c809b	194	* @label: label to attach to the requested GPIO
40b73183 MW	195	*
	196	* GPIO descriptors returned from this function are automatically disposed on
	197	* driver detach.
a264d10f	198	*
ff21378a	199	* On successful request the GPIO pin is configured in accordance with
a264d10f	200	* provided @flags.
40b73183	201	*/
2d2f116d DT	202	struct gpio_desc devm_fwnode_gpiod_get_index(struct device dev,
	203	struct fwnode_handle *fwnode,
	204	const char *con_id, int index,
	205	enum gpiod_flags flags,
	206	const char *label)
40b73183 MW	207	{
	208	struct gpio_desc **dr;
	209	struct gpio_desc *desc;
	210
	211	dr = devres_alloc(devm_gpiod_release, sizeof(struct gpio_desc *),
	212	GFP_KERNEL);
	213	if (!dr)
	214	return ERR_PTR(-ENOMEM);
	215
13949fa9	216	desc = fwnode_gpiod_get_index(fwnode, con_id, index, flags, label);
40b73183 MW	217	if (IS_ERR(desc)) {
	218	devres_free(dr);
	219	return desc;
	220	}
	221
	222	*dr = desc;
	223	devres_add(dev, dr);
	224
	225	return desc;
	226	}
2d2f116d	227	EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index);
40b73183	228
29a1f233 TR	229	/**
	230	* devm_gpiod_get_index_optional - Resource-managed gpiod_get_index_optional()
	231	* @dev: GPIO consumer
	232	* @con_id: function within the GPIO consumer
	233	* @index: index of the GPIO to obtain in the consumer
39b2bbe3	234	* @flags: optional GPIO initialization flags
29a1f233 TR	235	*
	236	* Managed gpiod_get_index_optional(). GPIO descriptors returned from this
	237	* function are automatically disposed on driver detach. See
	238	* gpiod_get_index_optional() for detailed information about behavior and
	239	* return values.
	240	*/
b17d1bf1	241	struct gpio_desc __must_check devm_gpiod_get_index_optional(struct device dev,
29a1f233	242	const char *con_id,
39b2bbe3	243	unsigned int index,
b17d1bf1	244	enum gpiod_flags flags)
29a1f233 TR	245	{
	246	struct gpio_desc *desc;
	247
39b2bbe3	248	desc = devm_gpiod_get_index(dev, con_id, index, flags);
7b58696d AS	249	if (gpiod_not_found(desc))
7b58696d AS	250	return NULL;
29a1f233 TR	251
	252	return desc;
	253	}
ac571991	254	EXPORT_SYMBOL_GPL(devm_gpiod_get_index_optional);
29a1f233	255
331758ee RI	256	/**
	257	* devm_gpiod_get_array - Resource-managed gpiod_get_array()
	258	* @dev: GPIO consumer
	259	* @con_id: function within the GPIO consumer
	260	* @flags: optional GPIO initialization flags
	261	*
	262	* Managed gpiod_get_array(). GPIO descriptors returned from this function are
	263	* automatically disposed on driver detach. See gpiod_get_array() for detailed
	264	* information about behavior and return values.
	265	*/
	266	struct gpio_descs __must_check devm_gpiod_get_array(struct device dev,
	267	const char *con_id,
	268	enum gpiod_flags flags)
	269	{
	270	struct gpio_descs **dr;
	271	struct gpio_descs *descs;
	272
	273	dr = devres_alloc(devm_gpiod_release_array,
	274	sizeof(struct gpio_descs *), GFP_KERNEL);
	275	if (!dr)
	276	return ERR_PTR(-ENOMEM);
	277
	278	descs = gpiod_get_array(dev, con_id, flags);
	279	if (IS_ERR(descs)) {
	280	devres_free(dr);
	281	return descs;
	282	}
	283
	284	*dr = descs;
	285	devres_add(dev, dr);
	286
	287	return descs;
	288	}
ac571991	289	EXPORT_SYMBOL_GPL(devm_gpiod_get_array);
331758ee RI	290
	291	/**
	292	* devm_gpiod_get_array_optional - Resource-managed gpiod_get_array_optional()
	293	* @dev: GPIO consumer
	294	* @con_id: function within the GPIO consumer
	295	* @flags: optional GPIO initialization flags
	296	*
	297	* Managed gpiod_get_array_optional(). GPIO descriptors returned from this
	298	* function are automatically disposed on driver detach.
	299	* See gpiod_get_array_optional() for detailed information about behavior and
	300	* return values.
	301	*/
	302	struct gpio_descs *__must_check
	303	devm_gpiod_get_array_optional(struct device dev, const char con_id,
	304	enum gpiod_flags flags)
	305	{
	306	struct gpio_descs *descs;
	307
	308	descs = devm_gpiod_get_array(dev, con_id, flags);
7b58696d	309	if (gpiod_not_found(descs))
331758ee RI	310	return NULL;
	311
	312	return descs;
	313	}
ac571991	314	EXPORT_SYMBOL_GPL(devm_gpiod_get_array_optional);
331758ee	315
bae48da2 AC	316	/**
bae48da2 AC	317	* devm_gpiod_put - Resource-managed gpiod_put()
2b7c809b	318	* @dev: GPIO consumer
bae48da2 AC	319	* @desc: GPIO descriptor to dispose of
	320	*
	321	* Dispose of a GPIO descriptor obtained with devm_gpiod_get() or
	322	* devm_gpiod_get_index(). Normally this function will not be called as the GPIO
	323	* will be disposed of by the resource management code.
	324	*/
	325	void devm_gpiod_put(struct device dev, struct gpio_desc desc)
	326	{
	327	WARN_ON(devres_release(dev, devm_gpiod_release, devm_gpiod_match,
	328	&desc));
	329	}
ac571991	330	EXPORT_SYMBOL_GPL(devm_gpiod_put);
bae48da2	331
891ddbc7 LW	332	/**
	333	* devm_gpiod_unhinge - Remove resource management from a gpio descriptor
	334	* @dev: GPIO consumer
	335	* @desc: GPIO descriptor to remove resource management from
	336	*
	337	* Remove resource management from a GPIO descriptor. This is needed when
	338	* you want to hand over lifecycle management of a descriptor to another
	339	* mechanism.
	340	*/
	341
	342	void devm_gpiod_unhinge(struct device dev, struct gpio_desc desc)
	343	{
	344	int ret;
	345
	346	if (IS_ERR_OR_NULL(desc))
	347	return;
	348	ret = devres_destroy(dev, devm_gpiod_release,
	349	devm_gpiod_match, &desc);
	350	/*
	351	* If the GPIO descriptor is requested as nonexclusive, we
	352	* may call this function several times on the same descriptor
	353	* so it is OK if devres_destroy() returns -ENOENT.
	354	*/
	355	if (ret == -ENOENT)
	356	return;
	357	/* Anything else we should warn about */
	358	WARN_ON(ret);
	359	}
ac571991	360	EXPORT_SYMBOL_GPL(devm_gpiod_unhinge);
891ddbc7	361
331758ee RI	362	/**
331758ee RI	363	* devm_gpiod_put_array - Resource-managed gpiod_put_array()
2b7c809b	364	* @dev: GPIO consumer
331758ee RI	365	* @descs: GPIO descriptor array to dispose of
	366	*
	367	* Dispose of an array of GPIO descriptors obtained with devm_gpiod_get_array().
	368	* Normally this function will not be called as the GPIOs will be disposed of
	369	* by the resource management code.
	370	*/
	371	void devm_gpiod_put_array(struct device dev, struct gpio_descs descs)
	372	{
	373	WARN_ON(devres_release(dev, devm_gpiod_release_array,
	374	devm_gpiod_match_array, &descs));
	375	}
ac571991	376	EXPORT_SYMBOL_GPL(devm_gpiod_put_array);
331758ee	377
bae48da2 AC	378
	379
	380
1a0703ed JC	381	static void devm_gpio_release(struct device dev, void res)
	382	{
	383	unsigned *gpio = res;
	384
	385	gpio_free(*gpio);
	386	}
	387
	388	static int devm_gpio_match(struct device dev, void res, void *data)
	389	{
	390	unsigned this = res, gpio = data;
	391
	392	return this == gpio;
	393	}
	394
	395	/**
713b7ef8 WS	396	* devm_gpio_request - request a GPIO for a managed device
	397	* @dev: device to request the GPIO for
	398	* @gpio: GPIO to allocate
	399	* @label: the name of the requested GPIO
1a0703ed JC	400	*
	401	* Except for the extra @dev argument, this function takes the
	402	* same arguments and performs the same function as
	403	* gpio_request(). GPIOs requested with this function will be
	404	* automatically freed on driver detach.
	405	*
	406	* If an GPIO allocated with this function needs to be freed
	407	* separately, devm_gpio_free() must be used.
	408	*/
	409
	410	int devm_gpio_request(struct device dev, unsigned gpio, const char label)
	411	{
	412	unsigned *dr;
	413	int rc;
	414
	415	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	416	if (!dr)
	417	return -ENOMEM;
	418
	419	rc = gpio_request(gpio, label);
	420	if (rc) {
	421	devres_free(dr);
	422	return rc;
	423	}
	424
	425	*dr = gpio;
	426	devres_add(dev, dr);
	427
	428	return 0;
	429	}
ac571991	430	EXPORT_SYMBOL_GPL(devm_gpio_request);
1a0703ed	431
09d71ff1 MB	432	/**
	433	* devm_gpio_request_one - request a single GPIO with initial setup
	434	* @dev: device to request for
	435	* @gpio: the GPIO number
	436	* @flags: GPIO configuration as specified by GPIOF_*
	437	* @label: a literal description string of this GPIO
	438	*/
	439	int devm_gpio_request_one(struct device *dev, unsigned gpio,
	440	unsigned long flags, const char *label)
	441	{
	442	unsigned *dr;
	443	int rc;
	444
	445	dr = devres_alloc(devm_gpio_release, sizeof(unsigned), GFP_KERNEL);
	446	if (!dr)
	447	return -ENOMEM;
	448
	449	rc = gpio_request_one(gpio, flags, label);
	450	if (rc) {
	451	devres_free(dr);
	452	return rc;
	453	}
	454
	455	*dr = gpio;
	456	devres_add(dev, dr);
	457
	458	return 0;
	459	}
ac571991	460	EXPORT_SYMBOL_GPL(devm_gpio_request_one);
09d71ff1	461
1a0703ed	462	/**
713b7ef8 WS	463	* devm_gpio_free - free a GPIO
	464	* @dev: device to free GPIO for
	465	* @gpio: GPIO to free
1a0703ed JC	466	*
	467	* Except for the extra @dev argument, this function takes the
	468	* same arguments and performs the same function as gpio_free().
	469	* This function instead of gpio_free() should be used to manually
	470	* free GPIOs allocated with devm_gpio_request().
	471	*/
	472	void devm_gpio_free(struct device *dev, unsigned int gpio)
	473	{
	474
a85990b3	475	WARN_ON(devres_release(dev, devm_gpio_release, devm_gpio_match,
1a0703ed	476	&gpio));
1a0703ed	477	}
ac571991	478	EXPORT_SYMBOL_GPL(devm_gpio_free);
a28e1c05	479
3c6e73e4	480	static void devm_gpio_chip_release(void *data)
a28e1c05	481	{
3c6e73e4	482	struct gpio_chip *gc = data;
a28e1c05 LW	483
	484	gpiochip_remove(gc);
	485	}
	486
	487	/**
5f402bb1	488	* devm_gpiochip_add_data_with_key() - Resource managed gpiochip_add_data_with_key()
a28e1c05 LW	489	* @dev: pointer to the device that gpio_chip belongs to.
	490	* @gc: the GPIO chip to register
	491	* @data: driver-private data associated with this chip
5f402bb1 AF	492	* @lock_key: lockdep class for IRQ lock
5f402bb1 AF	493	* @request_key: lockdep class for IRQ request
a28e1c05 LW	494	*
	495	* Context: potentially before irqs will work
	496	*
	497	* The gpio chip automatically be released when the device is unbound.
	498	*
	499	* Returns:
	500	* A negative errno if the chip can't be registered, such as because the
	501	* gc->base is invalid or already associated with a different chip.
	502	* Otherwise it returns zero as a success code.
	503	*/
5f402bb1 AF	504	int devm_gpiochip_add_data_with_key(struct device dev, struct gpio_chip gc, void *data,
	505	struct lock_class_key *lock_key,
	506	struct lock_class_key *request_key)
a28e1c05	507	{
a28e1c05 LW	508	int ret;
a28e1c05 LW	509
5f402bb1	510	ret = gpiochip_add_data_with_key(gc, data, lock_key, request_key);
3c6e73e4	511	if (ret < 0)
a28e1c05	512	return ret;
a28e1c05	513
3c6e73e4	514	return devm_add_action_or_reset(dev, devm_gpio_chip_release, gc);
a28e1c05	515	}
5f402bb1	516	EXPORT_SYMBOL_GPL(devm_gpiochip_add_data_with_key);