1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (c) 2011 The Chromium OS Authors.
4 * Copyright (c) 2011, NVIDIA Corp. All rights reserved.
7 #ifndef _ASM_GENERIC_GPIO_H_
8 #define _ASM_GENERIC_GPIO_H_
10 #include <dm/ofnode.h>
11 #include <linux/bitops.h>
14 struct ofnode_phandle_args;
17 * Generic GPIO API for U-Boot
20 * NB: This is deprecated. Please use the driver model functions instead:
22 * - gpio_request_by_name()
23 * - dm_gpio_get_value() etc.
25 * For now we need a dm_ prefix on some functions to avoid name collision.
28 * GPIOs are numbered from 0 to GPIO_COUNT-1 which value is defined
29 * by the SOC/architecture.
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.
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.
44 * @deprecated Please use driver model instead
45 * Request a GPIO. This should be called before any of the other functions
46 * are used on this GPIO.
48 * Note: With driver model, the label is allocated so there is no need for
49 * the caller to preserve it.
51 * @param gpio GPIO number
52 * @param label User label for this GPIO
53 * Return: 0 if ok, -1 on error
55 int gpio_request(unsigned gpio, const char *label);
58 * @deprecated Please use driver model instead
59 * Stop using the GPIO. This function should not alter pin configuration.
61 * @param gpio GPIO number
62 * Return: 0 if ok, -1 on error
64 int gpio_free(unsigned gpio);
67 * @deprecated Please use driver model instead
68 * Make a GPIO an input.
70 * @param gpio GPIO number
71 * Return: 0 if ok, -1 on error
73 int gpio_direction_input(unsigned gpio);
76 * @deprecated Please use driver model instead
77 * Make a GPIO an output, and set its value.
79 * @param gpio GPIO number
80 * @param value GPIO value (0 for low or 1 for high)
81 * Return: 0 if ok, -1 on error
83 int gpio_direction_output(unsigned gpio, int value);
86 * @deprecated Please use driver model instead
87 * Get a GPIO's value. This will work whether the GPIO is an input
90 * @param gpio GPIO number
91 * Return: 0 if low, 1 if high, -1 on error
93 int gpio_get_value(unsigned gpio);
96 * @deprecated Please use driver model instead
97 * Set an output GPIO's value. The GPIO must already be an output or
98 * this function may have no effect.
100 * @param gpio GPIO number
101 * @param value GPIO value (0 for low or 1 for high)
102 * Return: 0 if ok, -1 on error
104 int gpio_set_value(unsigned gpio, int value);
106 /* State of a GPIO, as reported by get_function() */
110 GPIOF_UNUSED, /* Not claimed */
111 GPIOF_UNKNOWN, /* Not known */
112 GPIOF_FUNC, /* Not used as a GPIO */
120 struct udevice *dev; /* Device, NULL for invalid GPIO */
122 #define GPIOD_IS_OUT BIT(1) /* GPIO is an output */
123 #define GPIOD_IS_IN BIT(2) /* GPIO is an input */
124 #define GPIOD_ACTIVE_LOW BIT(3) /* GPIO is active when value is low */
125 #define GPIOD_IS_OUT_ACTIVE BIT(4) /* set output active */
126 #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 */
130 #define GPIOD_IS_AF BIT(9) /* GPIO is an alternate function */
132 /* Flags for updating the above */
133 #define GPIOD_MASK_DIR (GPIOD_IS_OUT | GPIOD_IS_IN | \
135 #define GPIOD_MASK_DSTYPE (GPIOD_OPEN_DRAIN | GPIOD_OPEN_SOURCE)
136 #define GPIOD_MASK_PULL (GPIOD_PULL_UP | GPIOD_PULL_DOWN)
138 uint offset; /* GPIO offset within the device */
140 * We could consider adding the GPIO label in here. Possibly we could
141 * use this structure for internal GPIO information.
146 * dm_gpio_is_valid() - Check if a GPIO is valid
148 * @desc: GPIO description containing device, offset and flags,
149 * previously returned by gpio_request_by_name()
150 * Return: true if valid, false if not
152 static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
154 return desc->dev != NULL;
158 * gpio_get_status() - get the current GPIO status as a string
160 * Obtain the current GPIO status as a string which can be presented to the
161 * user. A typical string is:
163 * "b4: in: 1 [x] sdmmc_cd"
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'
168 * TODO(sjg@chromium.org): This should use struct gpio_desc
170 * @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
175 int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize);
178 * gpio_get_function() - get the current function for a GPIO pin
180 * Note this returns GPIOF_UNUSED if the GPIO is not requested.
182 * TODO(sjg@chromium.org): This should use struct gpio_desc
184 * @dev: Device to check
185 * @offset: Offset of device GPIO to check
186 * @namep: If non-NULL, this is set to the name given when the GPIO
187 * was requested, or -1 if it has not been requested
188 * Return: -ENODATA if the driver returned an unknown function,
189 * -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.
193 int gpio_get_function(struct udevice *dev, int offset, const char **namep);
196 * gpio_get_raw_function() - get the current raw function for a GPIO pin
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.
201 * TODO(sjg@chromium.org): This should use struct gpio_desc
203 * @dev: Device to check
204 * @offset: Offset of device GPIO to check
205 * @namep: If non-NULL, this is set to the name given when the GPIO
206 * was requested, or -1 if it has not been requested
207 * Return: -ENODATA if the driver returned an unknown function,
208 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
209 * Otherwise returns the function from enum gpio_func_t.
211 int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep);
214 * gpio_requestf() - request a GPIO using a format string for the owner
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
220 int gpio_requestf(unsigned gpio, const char *fmt, ...)
221 __attribute__ ((format (__printf__, 2, 3)));
223 struct fdtdec_phandle_args;
226 * gpio_flags_xlate() - convert DT flags to internal flags
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.
231 unsigned long gpio_flags_xlate(uint32_t arg);
234 * gpio_xlate_offs_flags() - implementation for common use of dm_gpio_ops.xlate
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].
239 int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
240 struct ofnode_phandle_args *args);
243 * struct struct dm_gpio_ops - Driver model GPIO operations
245 * Refer to functions above for description. These function largely copy
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.
252 * Also it would be useful to standardise additional functions like
253 * pullup, slew rate and drive strength.
255 * gpio_request() and gpio_free() are optional - if NULL then they will
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.
265 * The uclass combines all GPIO devices together to provide a consistent
266 * 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.
270 int (*request)(struct udevice *dev, unsigned offset, const char *label);
271 int (*rfree)(struct udevice *dev, unsigned int offset);
274 * direction_input() - deprecated
276 * Equivalent to set_flags(...GPIOD_IS_IN)
278 int (*direction_input)(struct udevice *dev, unsigned offset);
281 * direction_output() - deprecated
283 * Equivalent to set_flags(...GPIOD_IS_OUT) with GPIOD_IS_OUT_ACTIVE
286 int (*direction_output)(struct udevice *dev, unsigned offset,
289 int (*get_value)(struct udevice *dev, unsigned offset);
292 * set_value() - Sets the GPIO value of an output
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
298 int (*set_value)(struct udevice *dev, unsigned offset, int value);
300 * get_function() Get the GPIO function
302 * @dev: Device to check
303 * @offset: GPIO offset within that device
304 * @return current function - GPIOF_...
306 int (*get_function)(struct udevice *dev, unsigned offset);
309 * xlate() - Translate phandle arguments into a GPIO description
311 * This function should set up the fields in desc according to the
312 * information in the arguments. The uclass will have set up:
318 * 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
322 * Note that @dev is passed in as a parameter to follow driver model
323 * uclass conventions, even though it is already available as
327 * @desc: Place to put GPIO description
328 * @args: Arguments provided in description
329 * @return 0 if OK, -ve on error
331 int (*xlate)(struct udevice *dev, struct gpio_desc *desc,
332 struct ofnode_phandle_args *args);
335 * set_flags() - Adjust GPIO flags
337 * This function should set up the GPIO configuration according to the
338 * information provided by @flags.
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.
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
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).
354 * 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.
359 * @offset: GPIO offset within that device
360 * @flags: New flags value (GPIOD_...)
362 * @return 0 if OK, -EINVAL if unsupported, -ERECALLCONFLICT if flags
363 * conflict in some * non-obvious way and were not applied,
366 int (*set_flags)(struct udevice *dev, unsigned int offset, ulong flags);
369 * get_flags() - Get GPIO flags
371 * This function return the GPIO flags used. It should read this from
372 * the hardware directly.
374 * This method is optional.
377 * @offset: GPIO offset within that device
378 * @flagsp: place to put the current flags value
379 * @return 0 if OK, -ve on error
381 int (*get_flags)(struct udevice *dev, unsigned int offset,
384 #if CONFIG_IS_ENABLED(ACPIGEN)
386 * get_acpi() - Get the ACPI info for a GPIO
388 * This converts a GPIO to an ACPI structure for adding to the ACPI
391 * @desc: GPIO description to convert
392 * @gpio: Output ACPI GPIO information
393 * @return ACPI pin number or -ve on error
395 int (*get_acpi)(const struct gpio_desc *desc, struct acpi_gpio *gpio);
400 * struct gpio_dev_priv - information about a device used by the uclass
402 * The uclass combines all active GPIO devices into a unified numbering
403 * scheme. To do this it maintains some private information about each
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
411 * @bank_name: Name of the GPIO device (e.g 'a' means GPIOs will be called
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.
417 * @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.
420 struct gpio_dev_priv {
421 const char *bank_name;
427 /* Access the GPIO operations for a device */
428 #define gpio_get_ops(dev) ((struct dm_gpio_ops *)(dev)->driver->ops)
431 * gpio_get_bank_info - Return information about a GPIO bank/device
433 * This looks up a device and returns both its GPIO base name and the number
434 * of GPIOs it controls.
436 * @dev: Device to look up
437 * @offset_count: Returns number of GPIOs within this bank
438 * Return: bank name of this device
440 const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
443 * dm_gpio_lookup_name() - Look up a named GPIO and return its description
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
449 * @name: Name to look up
450 * @desc: Returns description, on success
451 * Return: 0 if OK, -ve on error
453 int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
456 * gpio_hog_lookup_name() - Look up a named GPIO and return the gpio descr.
458 * @name: Name to look up
459 * @desc: Returns GPIO description, on success, else NULL
460 * @return: Returns 0 if OK, else -ENODEV
462 int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc);
465 * gpio_lookup_name - Look up a GPIO name and return its details
467 * This is used to convert a named GPIO into a device, offset and GPIO
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
475 int gpio_lookup_name(const char *name, struct udevice **devp,
476 unsigned int *offsetp, unsigned int *gpiop);
479 * gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
481 * This puts the value of the first GPIO into bit 0, the second into bit 1,
482 * etc. then returns the resulting integer.
484 * @gpio_list: List of GPIOs to collect
485 * Return: resulting integer value, or -ve on error
487 int gpio_get_values_as_int(const int *gpio_list);
490 * dm_gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
492 * This puts the value of the first GPIO into bit 0, the second into bit 1,
493 * etc. then returns the resulting integer.
495 * @desc_list: List of GPIOs to collect
496 * @count: Number of GPIOs
497 * Return: resulting integer value, or -ve on error
499 int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
502 * dm_gpio_get_values_as_int_base3() - Create a base-3 int from a list of GPIOs
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
507 * 0 : external pull-down
508 * 1 : external pull-up
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,
516 * With 2 pins, 6 combinations are possible, compared with 4
517 * With 3 pins, 27 are possible, compared with 8
519 * @desc_list: List of GPIOs to collect
520 * @count: Number of GPIOs
521 * Return: resulting integer value, or -ve on error
523 int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list,
527 * gpio_claim_vector() - claim a number of GPIOs for input
529 * @gpio_num_array: array of gpios to claim, terminated by -1
530 * @fmt: format string for GPIO names, e.g. "board_id%d"
531 * Return: 0 if OK, -ve on error
533 int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
536 * gpio_request_by_name() - Locate and request a GPIO by name
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
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.
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.
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
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.
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
566 * GPIO, @desc->dev will be NULL.
567 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
568 * Return: 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
569 * something wrong with the list, or other -ve for another error (e.g.
570 * -EBUSY if a GPIO was already requested)
572 int gpio_request_by_name(struct udevice *dev, const char *list_name,
573 int index, struct gpio_desc *desc, int flags);
575 /* gpio_request_by_line_name - Locate and request a GPIO by line name
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.
580 * This allows boards to implement common behaviours using GPIOs while not
581 * requiring specific GPIO offsets be used.
583 * @dev: An instance of a GPIO controller udevice, or NULL to search
584 * all GPIO controller devices
585 * @line_name: The name of the GPIO (e.g. "bmc-secure-boot")
586 * @desc: A GPIO descriptor that is populated with the requested GPIO
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.
592 int gpio_request_by_line_name(struct udevice *dev, const char *line_name,
593 struct gpio_desc *desc, int flags);
596 * gpio_request_list_by_name() - Request a list of GPIOs
598 * Reads all the GPIOs from a list and requests them. See
599 * 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
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).
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
613 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
614 * Return: number of GPIOs requested, or -ve on error
616 int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
617 struct gpio_desc *desc_list, int max_count,
621 * dm_gpio_request() - manually request a GPIO
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.
626 * @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
627 * @label: Label to attach to the GPIO while claimed
628 * Return: 0 if OK, -ve on error
630 int dm_gpio_request(struct gpio_desc *desc, const char *label);
632 struct phandle_2_arg;
633 int gpio_request_by_phandle(struct udevice *dev,
634 const struct phandle_2_arg *cells,
635 struct gpio_desc *desc, int flags);
638 * gpio_get_list_count() - Returns the number of GPIOs in a list
640 * Counts the GPIOs in a list. See gpio_request_by_name() for additional
643 * @dev: Device requesting the GPIO
644 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
645 * Return: number of GPIOs (0 for an empty property) or -ENOENT if the list
648 int gpio_get_list_count(struct udevice *dev, const char *list_name);
651 * gpio_request_by_name_nodev() - request GPIOs without a device
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
656 int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
657 struct gpio_desc *desc, int flags);
660 * gpio_request_list_by_name_nodev() - request GPIOs without a device
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
665 int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
666 struct gpio_desc *desc_list, int max_count,
670 * gpio_dev_request_index() - request single GPIO from gpio device
673 * @nodename: Name of node for which gpio gets requested, used
674 * for the gpio label name
675 * @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
678 * @dtflags: GPIO flags read from DT defined see GPIOD_*
679 * @desc: returns GPIO descriptor filled from this function
680 * @return: return value from gpio_request_tail()
682 int 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);
687 * dm_gpio_free() - Free a single GPIO
689 * This frees a single GPIOs previously returned from gpio_request_by_name().
691 * @dev: Device which requested the GPIO
692 * @desc: GPIO to free
693 * Return: 0 if OK, -ve on error
695 int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
698 * gpio_free_list() - Free a list of GPIOs
700 * This frees a list of GPIOs previously returned from
701 * gpio_request_list_by_name().
703 * @dev: Device which requested the GPIOs
704 * @desc: List of GPIOs to free
705 * @count: Number of GPIOs in the list
706 * Return: 0 if OK, -ve on error
708 int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
711 * gpio_free_list_nodev() - free GPIOs without a device
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
716 int gpio_free_list_nodev(struct gpio_desc *desc, int count);
719 * dm_gpio_get_value() - Get the value of a GPIO
721 * This is the driver model version of the existing gpio_get_value() function
722 * and should be used instead of that.
724 * For now, these functions have a dm_ prefix since they conflict with
727 * @desc: GPIO description containing device, offset and flags,
728 * previously returned by gpio_request_by_name()
729 * Return: GPIO value (0 for inactive, 1 for active) or -ve on error
731 int dm_gpio_get_value(const struct gpio_desc *desc);
733 int dm_gpio_set_value(const struct gpio_desc *desc, int value);
736 * dm_gpio_clrset_flags() - Update flags
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.
741 * By use of @clr and @set any of flags can be individually updated, or left
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_...)
748 * Return: 0 if OK, -EINVAL if the flags had obvious conflicts,
749 * -ERECALLCONFLICT if there was a non-obvious hardware conflict when attempting
752 int dm_gpio_clrset_flags(struct gpio_desc *desc, ulong clr, ulong set);
755 * dm_gpio_set_dir_flags() - Set direction using description and added flags
757 * This sets up the direction according to the provided flags and the GPIO
758 * description (desc->flags) which include direction information.
759 * Note that desc->flags is updated by this function.
761 * @desc: GPIO description containing device, offset and flags,
762 * previously returned by gpio_request_by_name()
763 * @flags: New flags to use
764 * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
766 int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
769 * dm_gpios_clrset_flags() - Sets flags for a set of GPIOs
771 * This clears and sets flags individually for each GPIO.
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_...)
778 * Return: 0 if OK, -ve on error
780 int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr,
784 * dm_gpio_get_flags() - Get flags
786 * Read the current flags
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
791 * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
793 int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags);
796 * gpio_get_number() - Get the global GPIO number of a GPIO
798 * This should only be used for debugging or interest. It returns the number
799 * that should be used for gpio_get_value() etc. to access this GPIO.
801 * @desc: GPIO description containing device, offset and flags,
802 * previously returned by gpio_request_by_name()
803 * Return: GPIO number, or -ve if not found
805 int gpio_get_number(const struct gpio_desc *desc);
808 * gpio_get_acpi() - Get the ACPI pin for a GPIO
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
813 * @desc: GPIO description to convert
814 * @gpio: Output ACPI GPIO information
815 * Return: ACPI pin number or -ve on error
817 int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio);
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
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.
832 struct gpio_desc *devm_gpiod_get_index(struct udevice *dev, const char *id,
833 unsigned int index, int flags);
835 #define devm_gpiod_get(dev, id, flags) devm_gpiod_get_index(dev, id, 0, flags)
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
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.
847 struct gpio_desc *devm_gpiod_get_index_optional(struct udevice *dev,
852 #define devm_gpiod_get_optional(dev, id, flags) \
853 devm_gpiod_get_index_optional(dev, id, 0, flags)
856 * devm_gpiod_put - Resource-managed gpiod_put()
857 * @dev: GPIO consumer
858 * @desc: GPIO descriptor to dispose of
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.
864 void devm_gpiod_put(struct udevice *dev, struct gpio_desc *desc);
866 #endif /* _ASM_GENERIC_GPIO_H_ */