blob: c4a7fd28439bca439052e555d72431b0c9d80fca [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass9d2cb8e2011-10-07 13:53:50 +00002/*
3 * Copyright (c) 2011 The Chromium OS Authors.
Joe Hershberger5f533ae2011-11-11 15:55:35 -06004 * Copyright (c) 2011, NVIDIA Corp. All rights reserved.
Simon Glass9d2cb8e2011-10-07 13:53:50 +00005 */
6
Joe Hershberger5f533ae2011-11-11 15:55:35 -06007#ifndef _ASM_GENERIC_GPIO_H_
8#define _ASM_GENERIC_GPIO_H_
9
Simon Glass150c5af2017-05-30 21:47:09 -060010#include <dm/ofnode.h>
Simon Glasscd93d622020-05-10 11:40:13 -060011#include <linux/bitops.h>
Simon Glass150c5af2017-05-30 21:47:09 -060012
Simon Glass29126862020-07-07 13:11:44 -060013struct acpi_gpio;
Simon Glass3a571232017-05-18 20:09:18 -060014struct ofnode_phandle_args;
15
Simon Glass9d2cb8e2011-10-07 13:53:50 +000016/*
17 * Generic GPIO API for U-Boot
18 *
Simon Glass5d1c17e2015-01-05 20:05:30 -070019 * --
20 * NB: This is deprecated. Please use the driver model functions instead:
21 *
22 * - gpio_request_by_name()
23 * - dm_gpio_get_value() etc.
24 *
25 * For now we need a dm_ prefix on some functions to avoid name collision.
26 * --
27 *
Simon Glass9d2cb8e2011-10-07 13:53:50 +000028 * GPIOs are numbered from 0 to GPIO_COUNT-1 which value is defined
29 * by the SOC/architecture.
30 *
31 * Each GPIO can be an input or output. If an input then its value can
32 * be read as 0 or 1. If an output then its value can be set to 0 or 1.
33 * If you try to write an input then the value is undefined. If you try
34 * to read an output, barring something very unusual, you will get
35 * back the value of the output that you previously set.
36 *
37 * In some cases the operation may fail, for example if the GPIO number
38 * is out of range, or the GPIO is not available because its pin is
39 * being used by another function. In that case, functions may return
40 * an error value of -1.
41 */
42
43/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070044 * @deprecated Please use driver model instead
Marcel Ziswiler25ca3852014-10-10 17:31:41 +020045 * Request a GPIO. This should be called before any of the other functions
46 * are used on this GPIO.
Simon Glass9d2cb8e2011-10-07 13:53:50 +000047 *
Simon Glassb892d122014-10-04 11:29:42 -060048 * Note: With driver model, the label is allocated so there is no need for
49 * the caller to preserve it.
50 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +090051 * @param gpio GPIO number
Nikita Kiryanov94740e42012-11-26 23:06:32 +000052 * @param label User label for this GPIO
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010053 * Return: 0 if ok, -1 on error
Simon Glass9d2cb8e2011-10-07 13:53:50 +000054 */
Joe Hershberger5f533ae2011-11-11 15:55:35 -060055int gpio_request(unsigned gpio, const char *label);
56
57/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070058 * @deprecated Please use driver model instead
Joe Hershberger5f533ae2011-11-11 15:55:35 -060059 * Stop using the GPIO. This function should not alter pin configuration.
60 *
61 * @param gpio GPIO number
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010062 * Return: 0 if ok, -1 on error
Joe Hershberger5f533ae2011-11-11 15:55:35 -060063 */
64int gpio_free(unsigned gpio);
65
66/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070067 * @deprecated Please use driver model instead
Joe Hershberger5f533ae2011-11-11 15:55:35 -060068 * Make a GPIO an input.
69 *
70 * @param gpio GPIO number
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010071 * Return: 0 if ok, -1 on error
Joe Hershberger5f533ae2011-11-11 15:55:35 -060072 */
73int gpio_direction_input(unsigned gpio);
Simon Glass9d2cb8e2011-10-07 13:53:50 +000074
75/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070076 * @deprecated Please use driver model instead
Simon Glass9d2cb8e2011-10-07 13:53:50 +000077 * Make a GPIO an output, and set its value.
78 *
Joe Hershberger5f533ae2011-11-11 15:55:35 -060079 * @param gpio GPIO number
Simon Glass9d2cb8e2011-10-07 13:53:50 +000080 * @param value GPIO value (0 for low or 1 for high)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010081 * Return: 0 if ok, -1 on error
Simon Glass9d2cb8e2011-10-07 13:53:50 +000082 */
Joe Hershberger5f533ae2011-11-11 15:55:35 -060083int gpio_direction_output(unsigned gpio, int value);
Simon Glass9d2cb8e2011-10-07 13:53:50 +000084
85/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070086 * @deprecated Please use driver model instead
Simon Glass9d2cb8e2011-10-07 13:53:50 +000087 * Get a GPIO's value. This will work whether the GPIO is an input
88 * or an output.
89 *
Joe Hershberger5f533ae2011-11-11 15:55:35 -060090 * @param gpio GPIO number
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010091 * Return: 0 if low, 1 if high, -1 on error
Simon Glass9d2cb8e2011-10-07 13:53:50 +000092 */
Joe Hershberger5f533ae2011-11-11 15:55:35 -060093int gpio_get_value(unsigned gpio);
Simon Glass9d2cb8e2011-10-07 13:53:50 +000094
95/**
Simon Glass5d1c17e2015-01-05 20:05:30 -070096 * @deprecated Please use driver model instead
Joe Hershberger5f533ae2011-11-11 15:55:35 -060097 * Set an output GPIO's value. The GPIO must already be an output or
Simon Glass9d2cb8e2011-10-07 13:53:50 +000098 * this function may have no effect.
99 *
Joe Hershberger5f533ae2011-11-11 15:55:35 -0600100 * @param gpio GPIO number
Simon Glass9d2cb8e2011-10-07 13:53:50 +0000101 * @param value GPIO value (0 for low or 1 for high)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100102 * Return: 0 if ok, -1 on error
Simon Glass9d2cb8e2011-10-07 13:53:50 +0000103 */
Joe Hershberger5f533ae2011-11-11 15:55:35 -0600104int gpio_set_value(unsigned gpio, int value);
Simon Glass96495d92014-02-26 15:59:24 -0700105
Simon Glass89e64052014-08-11 09:23:52 -0600106/* State of a GPIO, as reported by get_function() */
Simon Glass6449a502014-10-04 11:29:43 -0600107enum gpio_func_t {
Simon Glass96495d92014-02-26 15:59:24 -0700108 GPIOF_INPUT = 0,
109 GPIOF_OUTPUT,
Simon Glass89e64052014-08-11 09:23:52 -0600110 GPIOF_UNUSED, /* Not claimed */
111 GPIOF_UNKNOWN, /* Not known */
112 GPIOF_FUNC, /* Not used as a GPIO */
113
114 GPIOF_COUNT,
Simon Glass96495d92014-02-26 15:59:24 -0700115};
116
Heiko Schocher54c5d082014-05-22 12:43:05 +0200117struct udevice;
Simon Glass96495d92014-02-26 15:59:24 -0700118
Simon Glassae7123f2015-01-05 20:05:27 -0700119struct gpio_desc {
120 struct udevice *dev; /* Device, NULL for invalid GPIO */
121 unsigned long flags;
Patrick Delaunay277a0ad2020-01-13 11:34:59 +0100122#define GPIOD_IS_OUT BIT(1) /* GPIO is an output */
123#define GPIOD_IS_IN BIT(2) /* GPIO is an input */
Patrick Delaunay477ca572020-01-13 11:35:07 +0100124#define GPIOD_ACTIVE_LOW BIT(3) /* GPIO is active when value is low */
Patrick Delaunay277a0ad2020-01-13 11:34:59 +0100125#define GPIOD_IS_OUT_ACTIVE BIT(4) /* set output active */
Patrick Delaunay477ca572020-01-13 11:35:07 +0100126#define GPIOD_OPEN_DRAIN BIT(5) /* GPIO is open drain type */
127#define GPIOD_OPEN_SOURCE BIT(6) /* GPIO is open source type */
128#define GPIOD_PULL_UP BIT(7) /* GPIO has pull-up enabled */
129#define GPIOD_PULL_DOWN BIT(8) /* GPIO has pull-down enabled */
Patrice Chotardf6f68162022-08-30 14:09:14 +0200130#define GPIOD_IS_AF BIT(9) /* GPIO is an alternate function */
Simon Glassae7123f2015-01-05 20:05:27 -0700131
Simon Glass7e0a96d2021-02-04 21:22:03 -0700132/* Flags for updating the above */
133#define GPIOD_MASK_DIR (GPIOD_IS_OUT | GPIOD_IS_IN | \
134 GPIOD_IS_OUT_ACTIVE)
135#define GPIOD_MASK_DSTYPE (GPIOD_OPEN_DRAIN | GPIOD_OPEN_SOURCE)
136#define GPIOD_MASK_PULL (GPIOD_PULL_UP | GPIOD_PULL_DOWN)
137
Simon Glassae7123f2015-01-05 20:05:27 -0700138 uint offset; /* GPIO offset within the device */
139 /*
140 * We could consider adding the GPIO label in here. Possibly we could
141 * use this structure for internal GPIO information.
142 */
143};
144
Simon Glass96495d92014-02-26 15:59:24 -0700145/**
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900146 * dm_gpio_is_valid() - Check if a GPIO is valid
Simon Glass3669e0e2015-01-05 20:05:29 -0700147 *
148 * @desc: GPIO description containing device, offset and flags,
149 * previously returned by gpio_request_by_name()
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100150 * Return: true if valid, false if not
Simon Glass3669e0e2015-01-05 20:05:29 -0700151 */
Simon Glass17c43f12016-03-06 19:27:51 -0700152static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
Simon Glass3669e0e2015-01-05 20:05:29 -0700153{
154 return desc->dev != NULL;
155}
156
157/**
Simon Glass07575352014-10-04 11:29:44 -0600158 * gpio_get_status() - get the current GPIO status as a string
159 *
160 * Obtain the current GPIO status as a string which can be presented to the
161 * user. A typical string is:
162 *
163 * "b4: in: 1 [x] sdmmc_cd"
164 *
165 * which means this is GPIO bank b, offset 4, currently set to input, current
166 * value 1, [x] means that it is requested and the owner is 'sdmmc_cd'
167 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700168 * TODO(sjg@chromium.org): This should use struct gpio_desc
169 *
Simon Glass07575352014-10-04 11:29:44 -0600170 * @dev: Device to check
171 * @offset: Offset of device GPIO to check
172 * @buf: Place to put string
173 * @buffsize: Size of string including \0
174 */
175int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize);
176
177/**
Simon Glass6449a502014-10-04 11:29:43 -0600178 * gpio_get_function() - get the current function for a GPIO pin
179 *
180 * Note this returns GPIOF_UNUSED if the GPIO is not requested.
181 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700182 * TODO(sjg@chromium.org): This should use struct gpio_desc
183 *
Simon Glass6449a502014-10-04 11:29:43 -0600184 * @dev: Device to check
185 * @offset: Offset of device GPIO to check
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900186 * @namep: If non-NULL, this is set to the name given when the GPIO
Simon Glass6449a502014-10-04 11:29:43 -0600187 * was requested, or -1 if it has not been requested
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100188 * Return: -ENODATA if the driver returned an unknown function,
Simon Glass6449a502014-10-04 11:29:43 -0600189 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
190 * GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
191 * function from enum gpio_func_t.
192 */
193int gpio_get_function(struct udevice *dev, int offset, const char **namep);
194
195/**
196 * gpio_get_raw_function() - get the current raw function for a GPIO pin
197 *
198 * Note this does not return GPIOF_UNUSED - it will always return the GPIO
199 * driver's view of a pin function, even if it is not correctly set up.
200 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700201 * TODO(sjg@chromium.org): This should use struct gpio_desc
202 *
Simon Glass6449a502014-10-04 11:29:43 -0600203 * @dev: Device to check
204 * @offset: Offset of device GPIO to check
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900205 * @namep: If non-NULL, this is set to the name given when the GPIO
Simon Glass6449a502014-10-04 11:29:43 -0600206 * was requested, or -1 if it has not been requested
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100207 * Return: -ENODATA if the driver returned an unknown function,
Simon Glass6449a502014-10-04 11:29:43 -0600208 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
209 * Otherwise returns the function from enum gpio_func_t.
210 */
211int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep);
212
213/**
Simon Glassd44f5972014-10-04 11:29:49 -0600214 * gpio_requestf() - request a GPIO using a format string for the owner
215 *
216 * This is a helper function for gpio_request(). It allows you to provide
217 * a printf()-format string for the GPIO owner. It calls gpio_request() with
218 * the string that is created
219 */
220int gpio_requestf(unsigned gpio, const char *fmt, ...)
221 __attribute__ ((format (__printf__, 2, 3)));
222
Simon Glass0dac4d52015-01-05 20:05:28 -0700223struct fdtdec_phandle_args;
224
Simon Glassd44f5972014-10-04 11:29:49 -0600225/**
Samuel Holland8a479822021-09-11 17:05:53 -0500226 * gpio_flags_xlate() - convert DT flags to internal flags
227 *
228 * This routine converts the GPIO_* flags from the generic DT binding to the
229 * GPIOD_* flags used internally. It can be called from driver xlate functions.
230 */
231unsigned long gpio_flags_xlate(uint32_t arg);
232
233/**
Eric Nelson6c880b72016-04-24 16:32:40 -0700234 * gpio_xlate_offs_flags() - implementation for common use of dm_gpio_ops.xlate
235 *
236 * This routine sets the offset field to args[0] and the flags field to
237 * GPIOD_ACTIVE_LOW if the GPIO_ACTIVE_LOW flag is present in args[1].
Eric Nelson6c880b72016-04-24 16:32:40 -0700238 */
239int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
Simon Glass3a571232017-05-18 20:09:18 -0600240 struct ofnode_phandle_args *args);
Eric Nelson6c880b72016-04-24 16:32:40 -0700241
242/**
Simon Glass96495d92014-02-26 15:59:24 -0700243 * struct struct dm_gpio_ops - Driver model GPIO operations
244 *
245 * Refer to functions above for description. These function largely copy
246 * the old API.
247 *
248 * This is trying to be close to Linux GPIO API. Once the U-Boot uses the
249 * new DM GPIO API, this should be really easy to flip over to the Linux
250 * GPIO API-alike interface.
251 *
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200252 * Also it would be useful to standardise additional functions like
Simon Glass96495d92014-02-26 15:59:24 -0700253 * pullup, slew rate and drive strength.
254 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900255 * gpio_request() and gpio_free() are optional - if NULL then they will
Simon Glass96495d92014-02-26 15:59:24 -0700256 * not be called.
257 *
258 * Note that @offset is the offset from the base GPIO of the device. So
259 * offset 0 is the device's first GPIO and offset o-1 is the last GPIO,
260 * where o is the number of GPIO lines controlled by the device. A device
261 * is typically used to control a single bank of GPIOs. Within complex
262 * SoCs there may be many banks and therefore many devices all referring
263 * to the different IO addresses within the SoC.
264 *
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200265 * The uclass combines all GPIO devices together to provide a consistent
Simon Glass96495d92014-02-26 15:59:24 -0700266 * numbering from 0 to n-1, where n is the number of GPIOs in total across
267 * all devices. Be careful not to confuse offset with gpio in the parameters.
268 */
269struct dm_gpio_ops {
Heiko Schocher54c5d082014-05-22 12:43:05 +0200270 int (*request)(struct udevice *dev, unsigned offset, const char *label);
Simon Glass093152f2020-02-04 20:15:17 -0700271 int (*rfree)(struct udevice *dev, unsigned int offset);
Simon Glassca1e1f52021-02-04 21:22:04 -0700272
273 /**
274 * direction_input() - deprecated
275 *
276 * Equivalent to set_flags(...GPIOD_IS_IN)
277 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200278 int (*direction_input)(struct udevice *dev, unsigned offset);
Simon Glassca1e1f52021-02-04 21:22:04 -0700279
280 /**
281 * direction_output() - deprecated
282 *
283 * Equivalent to set_flags(...GPIOD_IS_OUT) with GPIOD_IS_OUT_ACTIVE
284 * also set if @value
285 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200286 int (*direction_output)(struct udevice *dev, unsigned offset,
Simon Glass96495d92014-02-26 15:59:24 -0700287 int value);
Simon Glassca1e1f52021-02-04 21:22:04 -0700288
Heiko Schocher54c5d082014-05-22 12:43:05 +0200289 int (*get_value)(struct udevice *dev, unsigned offset);
Simon Glassca1e1f52021-02-04 21:22:04 -0700290
291 /**
292 * set_value() - Sets the GPIO value of an output
293 *
294 * If the driver provides an @set_flags() method then that is used
295 * in preference to this, with GPIOD_IS_OUT_ACTIVE set according to
296 * @value.
297 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200298 int (*set_value)(struct udevice *dev, unsigned offset, int value);
Simon Glass89e64052014-08-11 09:23:52 -0600299 /**
300 * get_function() Get the GPIO function
301 *
302 * @dev: Device to check
303 * @offset: GPIO offset within that device
304 * @return current function - GPIOF_...
305 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200306 int (*get_function)(struct udevice *dev, unsigned offset);
Simon Glass0dac4d52015-01-05 20:05:28 -0700307
308 /**
309 * xlate() - Translate phandle arguments into a GPIO description
310 *
311 * This function should set up the fields in desc according to the
312 * information in the arguments. The uclass will have set up:
313 *
314 * @desc->dev to @dev
315 * @desc->flags to 0
Eric Nelson6c880b72016-04-24 16:32:40 -0700316 * @desc->offset to 0
Simon Glass0dac4d52015-01-05 20:05:28 -0700317 *
Eric Nelson6c880b72016-04-24 16:32:40 -0700318 * This method is optional and defaults to gpio_xlate_offs_flags,
319 * which will parse offset and the GPIO_ACTIVE_LOW flag in the first
320 * two arguments.
Simon Glass0dac4d52015-01-05 20:05:28 -0700321 *
322 * Note that @dev is passed in as a parameter to follow driver model
323 * uclass conventions, even though it is already available as
324 * desc->dev.
325 *
326 * @dev: GPIO device
327 * @desc: Place to put GPIO description
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900328 * @args: Arguments provided in description
Simon Glass0dac4d52015-01-05 20:05:28 -0700329 * @return 0 if OK, -ve on error
330 */
331 int (*xlate)(struct udevice *dev, struct gpio_desc *desc,
Simon Glass3a571232017-05-18 20:09:18 -0600332 struct ofnode_phandle_args *args);
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100333
334 /**
Simon Glass13979fc2021-02-04 21:21:55 -0700335 * set_flags() - Adjust GPIO flags
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100336 *
337 * This function should set up the GPIO configuration according to the
Simon Glass13979fc2021-02-04 21:21:55 -0700338 * information provided by @flags.
339 *
340 * If any flags cannot be set (e.g. the driver or hardware does not
341 * support them or this particular GPIO does not have the requested
342 * feature), the driver should return -EINVAL.
343 *
344 * The uclass checks that flags do not obviously conflict (e.g. input
345 * and output). If the driver finds other conflicts it should return
346 * -ERECALLCONFLICT
347 *
348 * Note that GPIOD_ACTIVE_LOW should be ignored, since the uclass
349 * adjusts for it automatically. For example, for an output GPIO,
350 * GPIOD_ACTIVE_LOW causes GPIOD_IS_OUT_ACTIVE to be inverted by the
351 * uclass, so the driver always sees the value that should be set at the
352 * pin (1=high, 0=low).
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100353 *
Simon Glassca1e1f52021-02-04 21:22:04 -0700354 * This method is required and should be implemented by new drivers. At
355 * some point, it will supersede direction_input() and
356 * direction_output(), which wil be removed.
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100357 *
358 * @dev: GPIO device
359 * @offset: GPIO offset within that device
Simon Glass13979fc2021-02-04 21:21:55 -0700360 * @flags: New flags value (GPIOD_...)
361 *
362 * @return 0 if OK, -EINVAL if unsupported, -ERECALLCONFLICT if flags
363 * conflict in some * non-obvious way and were not applied,
364 * other -ve on error
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100365 */
Simon Glass13979fc2021-02-04 21:21:55 -0700366 int (*set_flags)(struct udevice *dev, unsigned int offset, ulong flags);
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100367
368 /**
Simon Glass96487892021-02-04 21:21:56 -0700369 * get_flags() - Get GPIO flags
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100370 *
Simon Glass96487892021-02-04 21:21:56 -0700371 * This function return the GPIO flags used. It should read this from
372 * the hardware directly.
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100373 *
374 * This method is optional.
375 *
376 * @dev: GPIO device
377 * @offset: GPIO offset within that device
Simon Glass96487892021-02-04 21:21:56 -0700378 * @flagsp: place to put the current flags value
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100379 * @return 0 if OK, -ve on error
380 */
Simon Glass96487892021-02-04 21:21:56 -0700381 int (*get_flags)(struct udevice *dev, unsigned int offset,
382 ulong *flagsp);
Simon Glass29126862020-07-07 13:11:44 -0600383
384#if CONFIG_IS_ENABLED(ACPIGEN)
385 /**
386 * get_acpi() - Get the ACPI info for a GPIO
387 *
388 * This converts a GPIO to an ACPI structure for adding to the ACPI
389 * tables.
390 *
391 * @desc: GPIO description to convert
392 * @gpio: Output ACPI GPIO information
393 * @return ACPI pin number or -ve on error
394 */
395 int (*get_acpi)(const struct gpio_desc *desc, struct acpi_gpio *gpio);
396#endif
Simon Glass96495d92014-02-26 15:59:24 -0700397};
398
399/**
400 * struct gpio_dev_priv - information about a device used by the uclass
401 *
402 * The uclass combines all active GPIO devices into a unified numbering
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200403 * scheme. To do this it maintains some private information about each
Simon Glass96495d92014-02-26 15:59:24 -0700404 * device.
405 *
406 * To implement driver model support in your GPIO driver, add a probe
407 * handler, and set @gpio_count and @bank_name correctly in that handler.
408 * This tells the uclass the name of the GPIO bank and the number of GPIOs
409 * it contains.
410 *
411 * @bank_name: Name of the GPIO device (e.g 'a' means GPIOs will be called
412 * 'A0', 'A1', etc.
413 * @gpio_count: Number of GPIOs in this device
414 * @gpio_base: Base GPIO number for this device. For the first active device
415 * this will be 0; the numbering for others will follow sequentially so that
416 * @gpio_base for device 1 will equal the number of GPIOs in device 0.
Simon Glassb892d122014-10-04 11:29:42 -0600417 * @name: Array of pointers to the name for each GPIO in this bank. The
418 * value of the pointer will be NULL if the GPIO has not been claimed.
Simon Glass96495d92014-02-26 15:59:24 -0700419 */
420struct gpio_dev_priv {
421 const char *bank_name;
422 unsigned gpio_count;
423 unsigned gpio_base;
Simon Glassb892d122014-10-04 11:29:42 -0600424 char **name;
Simon Glass96495d92014-02-26 15:59:24 -0700425};
426
427/* Access the GPIO operations for a device */
428#define gpio_get_ops(dev) ((struct dm_gpio_ops *)(dev)->driver->ops)
429
430/**
431 * gpio_get_bank_info - Return information about a GPIO bank/device
432 *
433 * This looks up a device and returns both its GPIO base name and the number
434 * of GPIOs it controls.
435 *
436 * @dev: Device to look up
437 * @offset_count: Returns number of GPIOs within this bank
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100438 * Return: bank name of this device
Simon Glass96495d92014-02-26 15:59:24 -0700439 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200440const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
Simon Glass96495d92014-02-26 15:59:24 -0700441
442/**
Simon Glass32ec1592015-06-23 15:38:40 -0600443 * dm_gpio_lookup_name() - Look up a named GPIO and return its description
444 *
445 * The name of a GPIO is typically its bank name followed by a number from 0.
446 * For example A0 is the first GPIO in bank A. Each bank is a separate driver
447 * model device.
448 *
449 * @name: Name to look up
450 * @desc: Returns description, on success
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100451 * Return: 0 if OK, -ve on error
Simon Glass32ec1592015-06-23 15:38:40 -0600452 */
453int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
454
455/**
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200456 * gpio_hog_lookup_name() - Look up a named GPIO and return the gpio descr.
457 *
458 * @name: Name to look up
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200459 * @desc: Returns GPIO description, on success, else NULL
460 * @return: Returns 0 if OK, else -ENODEV
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200461 */
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200462int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc);
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200463
464/**
Simon Glass96495d92014-02-26 15:59:24 -0700465 * gpio_lookup_name - Look up a GPIO name and return its details
466 *
467 * This is used to convert a named GPIO into a device, offset and GPIO
468 * number.
469 *
470 * @name: GPIO name to look up
471 * @devp: Returns pointer to device which contains this GPIO
472 * @offsetp: Returns the offset number within this device
473 * @gpiop: Returns the absolute GPIO number, numbered from 0
474 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200475int gpio_lookup_name(const char *name, struct udevice **devp,
Simon Glass96495d92014-02-26 15:59:24 -0700476 unsigned int *offsetp, unsigned int *gpiop);
477
Simon Glasse5901c92014-11-10 18:00:21 -0700478/**
Simon Glass962f5ca2015-04-14 21:03:20 -0600479 * gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
Simon Glasse5901c92014-11-10 18:00:21 -0700480 *
481 * This puts the value of the first GPIO into bit 0, the second into bit 1,
482 * etc. then returns the resulting integer.
483 *
484 * @gpio_list: List of GPIOs to collect
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100485 * Return: resulting integer value, or -ve on error
Simon Glasse5901c92014-11-10 18:00:21 -0700486 */
Simon Glass962f5ca2015-04-14 21:03:20 -0600487int gpio_get_values_as_int(const int *gpio_list);
488
489/**
Simon Glassbbf24782016-03-06 19:27:50 -0700490 * dm_gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
491 *
492 * This puts the value of the first GPIO into bit 0, the second into bit 1,
493 * etc. then returns the resulting integer.
494 *
495 * @desc_list: List of GPIOs to collect
496 * @count: Number of GPIOs
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100497 * Return: resulting integer value, or -ve on error
Simon Glassbbf24782016-03-06 19:27:50 -0700498 */
Simon Glass17c43f12016-03-06 19:27:51 -0700499int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
Simon Glassbbf24782016-03-06 19:27:50 -0700500
501/**
Simon Glass8a45b222021-02-04 21:22:09 -0700502 * dm_gpio_get_values_as_int_base3() - Create a base-3 int from a list of GPIOs
503 *
504 * This uses pull-ups/pull-downs to figure out whether a GPIO line is externally
505 * pulled down, pulled up or floating. This allows three different strap values
506 * for each pin:
507 * 0 : external pull-down
508 * 1 : external pull-up
509 * 2 : floating
510 *
511 * With this it is possible to obtain more combinations from the same number of
512 * strapping pins, when compared to dm_gpio_get_values_as_int(). The external
513 * pull resistors should be made stronger that the internal SoC pull resistors,
514 * for this to work.
515 *
516 * With 2 pins, 6 combinations are possible, compared with 4
517 * With 3 pins, 27 are possible, compared with 8
518 *
519 * @desc_list: List of GPIOs to collect
520 * @count: Number of GPIOs
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100521 * Return: resulting integer value, or -ve on error
Simon Glass8a45b222021-02-04 21:22:09 -0700522 */
523int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list,
524 int count);
525
526/**
Simon Glass962f5ca2015-04-14 21:03:20 -0600527 * gpio_claim_vector() - claim a number of GPIOs for input
528 *
529 * @gpio_num_array: array of gpios to claim, terminated by -1
530 * @fmt: format string for GPIO names, e.g. "board_id%d"
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100531 * Return: 0 if OK, -ve on error
Simon Glass962f5ca2015-04-14 21:03:20 -0600532 */
533int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
Jeroen Hofstee5b5ac642014-10-08 22:58:03 +0200534
Simon Glass3669e0e2015-01-05 20:05:29 -0700535/**
536 * gpio_request_by_name() - Locate and request a GPIO by name
537 *
538 * This operates by looking up the given list name in the device (device
539 * tree property) and requesting the GPIO for use. The property must exist
540 * in @dev's node.
541 *
542 * Use @flags to specify whether the GPIO should be an input or output. In
543 * principle this can also come from the device tree binding but most
544 * bindings don't provide this information. Specifically, when the GPIO uclass
545 * calls the xlate() method, it can return default flags, which are then
546 * ORed with this @flags.
547 *
548 * If we find that requesting the GPIO is not always needed we could add a
549 * new function or a new GPIOD_NO_REQUEST flag.
550 *
551 * At present driver model has no reference counting so if one device
552 * requests a GPIO which subsequently is unbound, the @desc->dev pointer
553 * will be invalid. However this will only happen if the GPIO device is
554 * unbound, not if it is removed, so this seems like a reasonable limitation
555 * for now. There is no real use case for unbinding drivers in normal
556 * operation.
557 *
558 * The device tree binding is doc/device-tree-bindings/gpio/gpio.txt in
559 * generate terms and each specific device may add additional details in
560 * a binding file in the same directory.
561 *
562 * @dev: Device requesting the GPIO
563 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
564 * @index: Index number of the GPIO in that list use request (0=first)
565 * @desc: Returns GPIO description information. If there is no such
Dario Binacchi7438d6a2020-10-11 14:25:47 +0200566 * GPIO, @desc->dev will be NULL.
Simon Glass3669e0e2015-01-05 20:05:29 -0700567 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100568 * Return: 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
Simon Glass3669e0e2015-01-05 20:05:29 -0700569 * something wrong with the list, or other -ve for another error (e.g.
570 * -EBUSY if a GPIO was already requested)
571 */
572int gpio_request_by_name(struct udevice *dev, const char *list_name,
573 int index, struct gpio_desc *desc, int flags);
574
Andrew Jeffery34be6962022-01-31 13:54:05 +1030575/* gpio_request_by_line_name - Locate and request a GPIO by line name
576 *
577 * Request a GPIO using the offset of the provided line name in the
578 * gpio-line-names property found in the OF node of the GPIO udevice.
579 *
580 * This allows boards to implement common behaviours using GPIOs while not
581 * requiring specific GPIO offsets be used.
582 *
Rasmus Villemoese1c97942023-03-17 21:12:22 +0100583 * @dev: An instance of a GPIO controller udevice, or NULL to search
584 * all GPIO controller devices
Andrew Jeffery34be6962022-01-31 13:54:05 +1030585 * @line_name: The name of the GPIO (e.g. "bmc-secure-boot")
586 * @desc: A GPIO descriptor that is populated with the requested GPIO
587 * upon return
588 * @flags: The GPIO settings apply to the request
589 * @return 0 if the named line was found and requested successfully, or a
590 * negative error code if the GPIO cannot be found or the request failed.
591 */
592int gpio_request_by_line_name(struct udevice *dev, const char *line_name,
593 struct gpio_desc *desc, int flags);
594
Simon Glass3669e0e2015-01-05 20:05:29 -0700595/**
596 * gpio_request_list_by_name() - Request a list of GPIOs
597 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900598 * Reads all the GPIOs from a list and requests them. See
Simon Glass3669e0e2015-01-05 20:05:29 -0700599 * gpio_request_by_name() for additional details. Lists should not be
600 * misused to hold unrelated or optional GPIOs. They should only be used
601 * for things like parallel data lines. A zero phandle terminates the list
602 * the list.
603 *
604 * This function will either succeed, and request all GPIOs in the list, or
605 * fail and request none (it will free already-requested GPIOs in case of
606 * an error part-way through).
607 *
608 * @dev: Device requesting the GPIO
609 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
610 * @desc_list: Returns a list of GPIO description information
611 * @max_count: Maximum number of GPIOs to return (@desc_list must be at least
612 * this big)
613 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100614 * Return: number of GPIOs requested, or -ve on error
Simon Glass3669e0e2015-01-05 20:05:29 -0700615 */
616int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
617 struct gpio_desc *desc_list, int max_count,
618 int flags);
619
620/**
Simon Glassefa677f2015-06-23 15:38:41 -0600621 * dm_gpio_request() - manually request a GPIO
622 *
623 * Note: This function should only be used for testing / debugging. Instead.
624 * use gpio_request_by_name() to pull GPIOs from the device tree.
625 *
626 * @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
627 * @label: Label to attach to the GPIO while claimed
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100628 * Return: 0 if OK, -ve on error
Simon Glassefa677f2015-06-23 15:38:41 -0600629 */
630int dm_gpio_request(struct gpio_desc *desc, const char *label);
631
Simon Glass48609d02021-08-07 07:24:12 -0600632struct phandle_2_arg;
633int gpio_request_by_phandle(struct udevice *dev,
634 const struct phandle_2_arg *cells,
635 struct gpio_desc *desc, int flags);
636
Simon Glassefa677f2015-06-23 15:38:41 -0600637/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700638 * gpio_get_list_count() - Returns the number of GPIOs in a list
639 *
640 * Counts the GPIOs in a list. See gpio_request_by_name() for additional
641 * details.
642 *
643 * @dev: Device requesting the GPIO
644 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100645 * Return: number of GPIOs (0 for an empty property) or -ENOENT if the list
Simon Glass3669e0e2015-01-05 20:05:29 -0700646 * does not exist
647 */
648int gpio_get_list_count(struct udevice *dev, const char *list_name);
649
650/**
651 * gpio_request_by_name_nodev() - request GPIOs without a device
652 *
653 * This is a version of gpio_request_list_by_name() that does not use a
654 * device. Avoid it unless the caller is not yet using driver model
655 */
Simon Glass150c5af2017-05-30 21:47:09 -0600656int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
657 struct gpio_desc *desc, int flags);
Simon Glass3669e0e2015-01-05 20:05:29 -0700658
659/**
660 * gpio_request_list_by_name_nodev() - request GPIOs without a device
661 *
662 * This is a version of gpio_request_list_by_name() that does not use a
663 * device. Avoid it unless the caller is not yet using driver model
664 */
Simon Glass150c5af2017-05-30 21:47:09 -0600665int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
Simon Glass3669e0e2015-01-05 20:05:29 -0700666 struct gpio_desc *desc_list, int max_count,
667 int flags);
668
669/**
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200670 * gpio_dev_request_index() - request single GPIO from gpio device
671 *
672 * @dev: GPIO device
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200673 * @nodename: Name of node for which gpio gets requested, used
674 * for the gpio label name
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200675 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
676 * @index: Index number of the GPIO in that list use request (0=first)
677 * @flags: GPIOD_* flags
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200678 * @dtflags: GPIO flags read from DT defined see GPIOD_*
679 * @desc: returns GPIO descriptor filled from this function
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200680 * @return: return value from gpio_request_tail()
681 */
682int gpio_dev_request_index(struct udevice *dev, const char *nodename,
683 char *list_name, int index, int flags,
684 int dtflags, struct gpio_desc *desc);
685
686/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700687 * dm_gpio_free() - Free a single GPIO
688 *
689 * This frees a single GPIOs previously returned from gpio_request_by_name().
690 *
691 * @dev: Device which requested the GPIO
692 * @desc: GPIO to free
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100693 * Return: 0 if OK, -ve on error
Simon Glass3669e0e2015-01-05 20:05:29 -0700694 */
695int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
696
697/**
698 * gpio_free_list() - Free a list of GPIOs
699 *
700 * This frees a list of GPIOs previously returned from
701 * gpio_request_list_by_name().
702 *
703 * @dev: Device which requested the GPIOs
704 * @desc: List of GPIOs to free
705 * @count: Number of GPIOs in the list
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100706 * Return: 0 if OK, -ve on error
Simon Glass3669e0e2015-01-05 20:05:29 -0700707 */
708int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
709
710/**
711 * gpio_free_list_nodev() - free GPIOs without a device
712 *
713 * This is a version of gpio_free_list() that does not use a
714 * device. Avoid it unless the caller is not yet using driver model
715 */
716int gpio_free_list_nodev(struct gpio_desc *desc, int count);
717
718/**
719 * dm_gpio_get_value() - Get the value of a GPIO
720 *
721 * This is the driver model version of the existing gpio_get_value() function
722 * and should be used instead of that.
723 *
724 * For now, these functions have a dm_ prefix since they conflict with
725 * existing names.
726 *
727 * @desc: GPIO description containing device, offset and flags,
728 * previously returned by gpio_request_by_name()
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100729 * Return: GPIO value (0 for inactive, 1 for active) or -ve on error
Simon Glass3669e0e2015-01-05 20:05:29 -0700730 */
Simon Glass17c43f12016-03-06 19:27:51 -0700731int dm_gpio_get_value(const struct gpio_desc *desc);
Simon Glass3669e0e2015-01-05 20:05:29 -0700732
Simon Glass17c43f12016-03-06 19:27:51 -0700733int dm_gpio_set_value(const struct gpio_desc *desc, int value);
Simon Glass3669e0e2015-01-05 20:05:29 -0700734
735/**
Simon Glass7e0a96d2021-02-04 21:22:03 -0700736 * dm_gpio_clrset_flags() - Update flags
737 *
738 * This updates the flags as directled. Note that desc->flags is updated by this
739 * function on success. If any changes cannot be made, best efforts are made.
740 *
741 * By use of @clr and @set any of flags can be individually updated, or left
742 * alone
743 *
744 * @desc: GPIO description containing device, offset and flags,
745 * previously returned by gpio_request_by_name()
746 * @clr: Flags to clear (GPIOD_...)
747 * @set: Flags to set (GPIOD_...)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100748 * Return: 0 if OK, -EINVAL if the flags had obvious conflicts,
Simon Glass7e0a96d2021-02-04 21:22:03 -0700749 * -ERECALLCONFLICT if there was a non-obvious hardware conflict when attempting
750 * to set the flags
751 */
752int dm_gpio_clrset_flags(struct gpio_desc *desc, ulong clr, ulong set);
753
754/**
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100755 * dm_gpio_set_dir_flags() - Set direction using description and added flags
Simon Glass3669e0e2015-01-05 20:05:29 -0700756 *
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100757 * This sets up the direction according to the provided flags and the GPIO
758 * description (desc->flags) which include direction information.
Simon Glass3669e0e2015-01-05 20:05:29 -0700759 * Note that desc->flags is updated by this function.
760 *
761 * @desc: GPIO description containing device, offset and flags,
762 * previously returned by gpio_request_by_name()
763 * @flags: New flags to use
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100764 * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
Simon Glass3669e0e2015-01-05 20:05:29 -0700765 */
766int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
767
768/**
Simon Glass8a45b222021-02-04 21:22:09 -0700769 * dm_gpios_clrset_flags() - Sets flags for a set of GPIOs
770 *
771 * This clears and sets flags individually for each GPIO.
772 *
773 * @desc: List of GPIOs to update
774 * @count: Number of GPIOs in the list
775 * @clr: Flags to clear (GPIOD_...), e.g. GPIOD_MASK_DIR if you are
776 * changing the direction
777 * @set: Flags to set (GPIOD_...)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100778 * Return: 0 if OK, -ve on error
Simon Glass8a45b222021-02-04 21:22:09 -0700779 */
780int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr,
781 ulong set);
782
783/**
Simon Glassc0c1e622021-02-04 21:21:57 -0700784 * dm_gpio_get_flags() - Get flags
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100785 *
Simon Glassc0c1e622021-02-04 21:21:57 -0700786 * Read the current flags
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100787 *
788 * @desc: GPIO description containing device, offset and flags,
789 * previously returned by gpio_request_by_name()
790 * @flags: place to put the used flags
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100791 * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100792 */
Simon Glassc0c1e622021-02-04 21:21:57 -0700793int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags);
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100794
795/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700796 * gpio_get_number() - Get the global GPIO number of a GPIO
797 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900798 * This should only be used for debugging or interest. It returns the number
Simon Glass3669e0e2015-01-05 20:05:29 -0700799 * that should be used for gpio_get_value() etc. to access this GPIO.
800 *
801 * @desc: GPIO description containing device, offset and flags,
802 * previously returned by gpio_request_by_name()
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100803 * Return: GPIO number, or -ve if not found
Simon Glass3669e0e2015-01-05 20:05:29 -0700804 */
Simon Glass17c43f12016-03-06 19:27:51 -0700805int gpio_get_number(const struct gpio_desc *desc);
Simon Glass3669e0e2015-01-05 20:05:29 -0700806
Simon Glass29126862020-07-07 13:11:44 -0600807/**
808 * gpio_get_acpi() - Get the ACPI pin for a GPIO
809 *
810 * This converts a GPIO to an ACPI pin number for adding to the ACPI
811 * tables. If the GPIO is invalid, the pin_count and pins[0] are set to 0
812 *
813 * @desc: GPIO description to convert
814 * @gpio: Output ACPI GPIO information
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100815 * Return: ACPI pin number or -ve on error
Simon Glass29126862020-07-07 13:11:44 -0600816 */
817int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio);
818
Jean-Jacques Hiblotd4b722e2020-09-11 13:43:34 +0530819/**
820 * devm_gpiod_get_index - Resource-managed gpiod_get()
821 * @dev: GPIO consumer
822 * @con_id: function within the GPIO consumer
823 * @index: index of the GPIO to obtain in the consumer
824 * @flags: optional GPIO initialization flags
825 *
826 * Managed gpiod_get(). GPIO descriptors returned from this function are
827 * automatically disposed on device unbind.
828 * Return the GPIO descriptor corresponding to the function con_id of device
829 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
830 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
831 */
832struct gpio_desc *devm_gpiod_get_index(struct udevice *dev, const char *id,
833 unsigned int index, int flags);
834
835#define devm_gpiod_get(dev, id, flags) devm_gpiod_get_index(dev, id, 0, flags)
836/**
837 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
838 * @dev: GPIO consumer, can be NULL for system-global GPIOs
839 * @con_id: function within the GPIO consumer
840 * @index: index of the GPIO to obtain in the consumer
841 * @flags: optional GPIO initialization flags
842 *
843 * This is equivalent to devm_gpiod_get(), except that when no GPIO was
844 * assigned to the requested function it will return NULL. This is convenient
845 * for drivers that need to handle optional GPIOs.
846 */
847struct gpio_desc *devm_gpiod_get_index_optional(struct udevice *dev,
848 const char *id,
849 unsigned int index,
850 int flags);
851
852#define devm_gpiod_get_optional(dev, id, flags) \
853 devm_gpiod_get_index_optional(dev, id, 0, flags)
854
855/**
856 * devm_gpiod_put - Resource-managed gpiod_put()
857 * @dev: GPIO consumer
858 * @desc: GPIO descriptor to dispose of
859 *
860 * Dispose of a GPIO descriptor obtained with devm_gpiod_get() or
861 * devm_gpiod_get_index(). Normally this function will not be called as the GPIO
862 * will be disposed of by the resource management code.
863 */
864void devm_gpiod_put(struct udevice *dev, struct gpio_desc *desc);
865
Joe Hershberger5f533ae2011-11-11 15:55:35 -0600866#endif /* _ASM_GENERIC_GPIO_H_ */