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>
12 struct ofnode_phandle_args;
15 * Generic GPIO API for U-Boot
18 * NB: This is deprecated. Please use the driver model functions instead:
20 * - gpio_request_by_name()
21 * - dm_gpio_get_value() etc.
23 * For now we need a dm_ prefix on some functions to avoid name collision.
26 * GPIOs are numbered from 0 to GPIO_COUNT-1 which value is defined
27 * by the SOC/architecture.
29 * Each GPIO can be an input or output. If an input then its value can
30 * be read as 0 or 1. If an output then its value can be set to 0 or 1.
31 * If you try to write an input then the value is undefined. If you try
32 * to read an output, barring something very unusual, you will get
33 * back the value of the output that you previously set.
35 * In some cases the operation may fail, for example if the GPIO number
36 * is out of range, or the GPIO is not available because its pin is
37 * being used by another function. In that case, functions may return
38 * an error value of -1.
42 * @deprecated Please use driver model instead
43 * Request a GPIO. This should be called before any of the other functions
44 * are used on this GPIO.
46 * Note: With driver model, the label is allocated so there is no need for
47 * the caller to preserve it.
49 * @param gpio GPIO number
50 * @param label User label for this GPIO
51 * @return 0 if ok, -1 on error
53 int gpio_request(unsigned gpio, const char *label);
56 * @deprecated Please use driver model instead
57 * Stop using the GPIO. This function should not alter pin configuration.
59 * @param gpio GPIO number
60 * @return 0 if ok, -1 on error
62 int gpio_free(unsigned gpio);
65 * @deprecated Please use driver model instead
66 * Make a GPIO an input.
68 * @param gpio GPIO number
69 * @return 0 if ok, -1 on error
71 int gpio_direction_input(unsigned gpio);
74 * @deprecated Please use driver model instead
75 * Make a GPIO an output, and set its value.
77 * @param gpio GPIO number
78 * @param value GPIO value (0 for low or 1 for high)
79 * @return 0 if ok, -1 on error
81 int gpio_direction_output(unsigned gpio, int value);
84 * @deprecated Please use driver model instead
85 * Get a GPIO's value. This will work whether the GPIO is an input
88 * @param gpio GPIO number
89 * @return 0 if low, 1 if high, -1 on error
91 int gpio_get_value(unsigned gpio);
94 * @deprecated Please use driver model instead
95 * Set an output GPIO's value. The GPIO must already be an output or
96 * this function may have no effect.
98 * @param gpio GPIO number
99 * @param value GPIO value (0 for low or 1 for high)
100 * @return 0 if ok, -1 on error
102 int gpio_set_value(unsigned gpio, int value);
104 /* State of a GPIO, as reported by get_function() */
108 GPIOF_UNUSED, /* Not claimed */
109 GPIOF_UNKNOWN, /* Not known */
110 GPIOF_FUNC, /* Not used as a GPIO */
118 struct udevice *dev; /* Device, NULL for invalid GPIO */
120 #define GPIOD_IS_OUT BIT(1) /* GPIO is an output */
121 #define GPIOD_IS_IN BIT(2) /* GPIO is an input */
122 #define GPIOD_ACTIVE_LOW BIT(3) /* GPIO is active when value is low */
123 #define GPIOD_IS_OUT_ACTIVE BIT(4) /* set output active */
124 #define GPIOD_OPEN_DRAIN BIT(5) /* GPIO is open drain type */
125 #define GPIOD_OPEN_SOURCE BIT(6) /* GPIO is open source type */
126 #define GPIOD_PULL_UP BIT(7) /* GPIO has pull-up enabled */
127 #define GPIOD_PULL_DOWN BIT(8) /* GPIO has pull-down enabled */
129 uint offset; /* GPIO offset within the device */
131 * We could consider adding the GPIO label in here. Possibly we could
132 * use this structure for internal GPIO information.
136 /* helper to compute the value of the gpio output */
137 #define GPIOD_FLAGS_OUTPUT_MASK (GPIOD_ACTIVE_LOW | GPIOD_IS_OUT_ACTIVE)
138 #define GPIOD_FLAGS_OUTPUT(flags) \
139 (((((flags) & GPIOD_FLAGS_OUTPUT_MASK) == GPIOD_IS_OUT_ACTIVE) || \
140 (((flags) & GPIOD_FLAGS_OUTPUT_MASK) == GPIOD_ACTIVE_LOW)))
143 * dm_gpio_is_valid() - Check if a GPIO is valid
145 * @desc: GPIO description containing device, offset and flags,
146 * previously returned by gpio_request_by_name()
147 * @return true if valid, false if not
149 static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
151 return desc->dev != NULL;
155 * gpio_get_status() - get the current GPIO status as a string
157 * Obtain the current GPIO status as a string which can be presented to the
158 * user. A typical string is:
160 * "b4: in: 1 [x] sdmmc_cd"
162 * which means this is GPIO bank b, offset 4, currently set to input, current
163 * value 1, [x] means that it is requested and the owner is 'sdmmc_cd'
165 * TODO(sjg@chromium.org): This should use struct gpio_desc
167 * @dev: Device to check
168 * @offset: Offset of device GPIO to check
169 * @buf: Place to put string
170 * @buffsize: Size of string including \0
172 int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize);
175 * gpio_get_function() - get the current function for a GPIO pin
177 * Note this returns GPIOF_UNUSED if the GPIO is not requested.
179 * TODO(sjg@chromium.org): This should use struct gpio_desc
181 * @dev: Device to check
182 * @offset: Offset of device GPIO to check
183 * @namep: If non-NULL, this is set to the name given when the GPIO
184 * was requested, or -1 if it has not been requested
185 * @return -ENODATA if the driver returned an unknown function,
186 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
187 * GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
188 * function from enum gpio_func_t.
190 int gpio_get_function(struct udevice *dev, int offset, const char **namep);
193 * gpio_get_raw_function() - get the current raw function for a GPIO pin
195 * Note this does not return GPIOF_UNUSED - it will always return the GPIO
196 * driver's view of a pin function, even if it is not correctly set up.
198 * TODO(sjg@chromium.org): This should use struct gpio_desc
200 * @dev: Device to check
201 * @offset: Offset of device GPIO to check
202 * @namep: If non-NULL, this is set to the name given when the GPIO
203 * was requested, or -1 if it has not been requested
204 * @return -ENODATA if the driver returned an unknown function,
205 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
206 * Otherwise returns the function from enum gpio_func_t.
208 int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep);
211 * gpio_requestf() - request a GPIO using a format string for the owner
213 * This is a helper function for gpio_request(). It allows you to provide
214 * a printf()-format string for the GPIO owner. It calls gpio_request() with
215 * the string that is created
217 int gpio_requestf(unsigned gpio, const char *fmt, ...)
218 __attribute__ ((format (__printf__, 2, 3)));
220 struct fdtdec_phandle_args;
223 * gpio_xlate_offs_flags() - implementation for common use of dm_gpio_ops.xlate
225 * This routine sets the offset field to args[0] and the flags field to
226 * GPIOD_ACTIVE_LOW if the GPIO_ACTIVE_LOW flag is present in args[1].
228 int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
229 struct ofnode_phandle_args *args);
232 * struct struct dm_gpio_ops - Driver model GPIO operations
234 * Refer to functions above for description. These function largely copy
237 * This is trying to be close to Linux GPIO API. Once the U-Boot uses the
238 * new DM GPIO API, this should be really easy to flip over to the Linux
239 * GPIO API-alike interface.
241 * Also it would be useful to standardise additional functions like
242 * pullup, slew rate and drive strength.
244 * gpio_request() and gpio_free() are optional - if NULL then they will
247 * Note that @offset is the offset from the base GPIO of the device. So
248 * offset 0 is the device's first GPIO and offset o-1 is the last GPIO,
249 * where o is the number of GPIO lines controlled by the device. A device
250 * is typically used to control a single bank of GPIOs. Within complex
251 * SoCs there may be many banks and therefore many devices all referring
252 * to the different IO addresses within the SoC.
254 * The uclass combines all GPIO devices together to provide a consistent
255 * numbering from 0 to n-1, where n is the number of GPIOs in total across
256 * all devices. Be careful not to confuse offset with gpio in the parameters.
259 int (*request)(struct udevice *dev, unsigned offset, const char *label);
260 int (*rfree)(struct udevice *dev, unsigned int offset);
261 int (*direction_input)(struct udevice *dev, unsigned offset);
262 int (*direction_output)(struct udevice *dev, unsigned offset,
264 int (*get_value)(struct udevice *dev, unsigned offset);
265 int (*set_value)(struct udevice *dev, unsigned offset, int value);
267 * get_function() Get the GPIO function
269 * @dev: Device to check
270 * @offset: GPIO offset within that device
271 * @return current function - GPIOF_...
273 int (*get_function)(struct udevice *dev, unsigned offset);
276 * xlate() - Translate phandle arguments into a GPIO description
278 * This function should set up the fields in desc according to the
279 * information in the arguments. The uclass will have set up:
285 * This method is optional and defaults to gpio_xlate_offs_flags,
286 * which will parse offset and the GPIO_ACTIVE_LOW flag in the first
289 * Note that @dev is passed in as a parameter to follow driver model
290 * uclass conventions, even though it is already available as
294 * @desc: Place to put GPIO description
295 * @args: Arguments provided in description
296 * @return 0 if OK, -ve on error
298 int (*xlate)(struct udevice *dev, struct gpio_desc *desc,
299 struct ofnode_phandle_args *args);
303 * struct gpio_dev_priv - information about a device used by the uclass
305 * The uclass combines all active GPIO devices into a unified numbering
306 * scheme. To do this it maintains some private information about each
309 * To implement driver model support in your GPIO driver, add a probe
310 * handler, and set @gpio_count and @bank_name correctly in that handler.
311 * This tells the uclass the name of the GPIO bank and the number of GPIOs
314 * @bank_name: Name of the GPIO device (e.g 'a' means GPIOs will be called
316 * @gpio_count: Number of GPIOs in this device
317 * @gpio_base: Base GPIO number for this device. For the first active device
318 * this will be 0; the numbering for others will follow sequentially so that
319 * @gpio_base for device 1 will equal the number of GPIOs in device 0.
320 * @name: Array of pointers to the name for each GPIO in this bank. The
321 * value of the pointer will be NULL if the GPIO has not been claimed.
323 struct gpio_dev_priv {
324 const char *bank_name;
330 /* Access the GPIO operations for a device */
331 #define gpio_get_ops(dev) ((struct dm_gpio_ops *)(dev)->driver->ops)
334 * gpio_get_bank_info - Return information about a GPIO bank/device
336 * This looks up a device and returns both its GPIO base name and the number
337 * of GPIOs it controls.
339 * @dev: Device to look up
340 * @offset_count: Returns number of GPIOs within this bank
341 * @return bank name of this device
343 const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
346 * dm_gpio_lookup_name() - Look up a named GPIO and return its description
348 * The name of a GPIO is typically its bank name followed by a number from 0.
349 * For example A0 is the first GPIO in bank A. Each bank is a separate driver
352 * @name: Name to look up
353 * @desc: Returns description, on success
354 * @return 0 if OK, -ve on error
356 int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
359 * gpio_hog_lookup_name() - Look up a named GPIO and return the gpio descr.
361 * @name: Name to look up
362 * @desc: Returns GPIO description, on success, else NULL
363 * @return: Returns 0 if OK, else -ENODEV
365 int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc);
368 * gpio_hog_probe_all() - probe all gpio devices with
371 * @return: Returns return value from device_probe()
373 int gpio_hog_probe_all(void);
376 * gpio_lookup_name - Look up a GPIO name and return its details
378 * This is used to convert a named GPIO into a device, offset and GPIO
381 * @name: GPIO name to look up
382 * @devp: Returns pointer to device which contains this GPIO
383 * @offsetp: Returns the offset number within this device
384 * @gpiop: Returns the absolute GPIO number, numbered from 0
386 int gpio_lookup_name(const char *name, struct udevice **devp,
387 unsigned int *offsetp, unsigned int *gpiop);
390 * gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
392 * This puts the value of the first GPIO into bit 0, the second into bit 1,
393 * etc. then returns the resulting integer.
395 * @gpio_list: List of GPIOs to collect
396 * @return resulting integer value, or -ve on error
398 int gpio_get_values_as_int(const int *gpio_list);
401 * dm_gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
403 * This puts the value of the first GPIO into bit 0, the second into bit 1,
404 * etc. then returns the resulting integer.
406 * @desc_list: List of GPIOs to collect
407 * @count: Number of GPIOs
408 * @return resulting integer value, or -ve on error
410 int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
413 * gpio_claim_vector() - claim a number of GPIOs for input
415 * @gpio_num_array: array of gpios to claim, terminated by -1
416 * @fmt: format string for GPIO names, e.g. "board_id%d"
417 * @return 0 if OK, -ve on error
419 int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
422 * gpio_request_by_name() - Locate and request a GPIO by name
424 * This operates by looking up the given list name in the device (device
425 * tree property) and requesting the GPIO for use. The property must exist
428 * Use @flags to specify whether the GPIO should be an input or output. In
429 * principle this can also come from the device tree binding but most
430 * bindings don't provide this information. Specifically, when the GPIO uclass
431 * calls the xlate() method, it can return default flags, which are then
432 * ORed with this @flags.
434 * If we find that requesting the GPIO is not always needed we could add a
435 * new function or a new GPIOD_NO_REQUEST flag.
437 * At present driver model has no reference counting so if one device
438 * requests a GPIO which subsequently is unbound, the @desc->dev pointer
439 * will be invalid. However this will only happen if the GPIO device is
440 * unbound, not if it is removed, so this seems like a reasonable limitation
441 * for now. There is no real use case for unbinding drivers in normal
444 * The device tree binding is doc/device-tree-bindings/gpio/gpio.txt in
445 * generate terms and each specific device may add additional details in
446 * a binding file in the same directory.
448 * @dev: Device requesting the GPIO
449 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
450 * @index: Index number of the GPIO in that list use request (0=first)
451 * @desc: Returns GPIO description information. If there is no such
452 * GPIO, dev->dev will be NULL.
453 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
454 * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
455 * something wrong with the list, or other -ve for another error (e.g.
456 * -EBUSY if a GPIO was already requested)
458 int gpio_request_by_name(struct udevice *dev, const char *list_name,
459 int index, struct gpio_desc *desc, int flags);
462 * gpio_request_list_by_name() - Request a list of GPIOs
464 * Reads all the GPIOs from a list and requests them. See
465 * gpio_request_by_name() for additional details. Lists should not be
466 * misused to hold unrelated or optional GPIOs. They should only be used
467 * for things like parallel data lines. A zero phandle terminates the list
470 * This function will either succeed, and request all GPIOs in the list, or
471 * fail and request none (it will free already-requested GPIOs in case of
472 * an error part-way through).
474 * @dev: Device requesting the GPIO
475 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
476 * @desc_list: Returns a list of GPIO description information
477 * @max_count: Maximum number of GPIOs to return (@desc_list must be at least
479 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
480 * @return number of GPIOs requested, or -ve on error
482 int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
483 struct gpio_desc *desc_list, int max_count,
487 * dm_gpio_request() - manually request a GPIO
489 * Note: This function should only be used for testing / debugging. Instead.
490 * use gpio_request_by_name() to pull GPIOs from the device tree.
492 * @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
493 * @label: Label to attach to the GPIO while claimed
494 * @return 0 if OK, -ve on error
496 int dm_gpio_request(struct gpio_desc *desc, const char *label);
499 * gpio_get_list_count() - Returns the number of GPIOs in a list
501 * Counts the GPIOs in a list. See gpio_request_by_name() for additional
504 * @dev: Device requesting the GPIO
505 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
506 * @return number of GPIOs (0 for an empty property) or -ENOENT if the list
509 int gpio_get_list_count(struct udevice *dev, const char *list_name);
512 * gpio_request_by_name_nodev() - request GPIOs without a device
514 * This is a version of gpio_request_list_by_name() that does not use a
515 * device. Avoid it unless the caller is not yet using driver model
517 int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
518 struct gpio_desc *desc, int flags);
521 * gpio_request_list_by_name_nodev() - request GPIOs without a device
523 * This is a version of gpio_request_list_by_name() that does not use a
524 * device. Avoid it unless the caller is not yet using driver model
526 int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
527 struct gpio_desc *desc_list, int max_count,
531 * gpio_dev_request_index() - request single GPIO from gpio device
534 * @nodename: Name of node for which gpio gets requested, used
535 * for the gpio label name
536 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
537 * @index: Index number of the GPIO in that list use request (0=first)
538 * @flags: GPIOD_* flags
539 * @dtflags: GPIO flags read from DT defined see GPIOD_*
540 * @desc: returns GPIO descriptor filled from this function
541 * @return: return value from gpio_request_tail()
543 int gpio_dev_request_index(struct udevice *dev, const char *nodename,
544 char *list_name, int index, int flags,
545 int dtflags, struct gpio_desc *desc);
548 * dm_gpio_free() - Free a single GPIO
550 * This frees a single GPIOs previously returned from gpio_request_by_name().
552 * @dev: Device which requested the GPIO
553 * @desc: GPIO to free
554 * @return 0 if OK, -ve on error
556 int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
559 * gpio_free_list() - Free a list of GPIOs
561 * This frees a list of GPIOs previously returned from
562 * gpio_request_list_by_name().
564 * @dev: Device which requested the GPIOs
565 * @desc: List of GPIOs to free
566 * @count: Number of GPIOs in the list
567 * @return 0 if OK, -ve on error
569 int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
572 * gpio_free_list_nodev() - free GPIOs without a device
574 * This is a version of gpio_free_list() that does not use a
575 * device. Avoid it unless the caller is not yet using driver model
577 int gpio_free_list_nodev(struct gpio_desc *desc, int count);
580 * dm_gpio_get_value() - Get the value of a GPIO
582 * This is the driver model version of the existing gpio_get_value() function
583 * and should be used instead of that.
585 * For now, these functions have a dm_ prefix since they conflict with
588 * @desc: GPIO description containing device, offset and flags,
589 * previously returned by gpio_request_by_name()
590 * @return GPIO value (0 for inactive, 1 for active) or -ve on error
592 int dm_gpio_get_value(const struct gpio_desc *desc);
594 int dm_gpio_set_value(const struct gpio_desc *desc, int value);
597 * dm_gpio_set_dir() - Set the direction for a GPIO
599 * This sets up the direction according to the GPIO flags: desc->flags.
601 * @desc: GPIO description containing device, offset and flags,
602 * previously returned by gpio_request_by_name()
603 * @return 0 if OK, -ve on error
605 int dm_gpio_set_dir(struct gpio_desc *desc);
608 * dm_gpio_set_dir_flags() - Set direction using description and added flags
610 * This sets up the direction according to the provided flags and the GPIO
611 * description (desc->flags) which include direction information.
612 * Note that desc->flags is updated by this function.
614 * @desc: GPIO description containing device, offset and flags,
615 * previously returned by gpio_request_by_name()
616 * @flags: New flags to use
617 * @return 0 if OK, -ve on error, in which case desc->flags is not updated
619 int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
622 * dm_gpio_get_dir_flags() - Get direction flags
624 * read the current direction flags
626 * @desc: GPIO description containing device, offset and flags,
627 * previously returned by gpio_request_by_name()
628 * @flags: place to put the used flags
629 * @return 0 if OK, -ve on error, in which case desc->flags is not updated
631 int dm_gpio_get_dir_flags(struct gpio_desc *desc, ulong *flags);
634 * gpio_get_number() - Get the global GPIO number of a GPIO
636 * This should only be used for debugging or interest. It returns the number
637 * that should be used for gpio_get_value() etc. to access this GPIO.
639 * @desc: GPIO description containing device, offset and flags,
640 * previously returned by gpio_request_by_name()
641 * @return GPIO number, or -ve if not found
643 int gpio_get_number(const struct gpio_desc *desc);
645 #endif /* _ASM_GENERIC_GPIO_H_ */