blob: 82294cbdc5773fddb328c1f7e8a1ac4f4494e14a [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
Simon Glass9d2cb8e2011-10-07 13:53:50 +000053 * @return 0 if ok, -1 on error
54 */
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
62 * @return 0 if ok, -1 on error
63 */
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
71 * @return 0 if ok, -1 on error
72 */
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)
81 * @return 0 if ok, -1 on error
82 */
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
Simon Glass9d2cb8e2011-10-07 13:53:50 +000091 * @return 0 if low, 1 if high, -1 on error
92 */
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)
102 * @return 0 if ok, -1 on error
103 */
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 */
Simon Glassae7123f2015-01-05 20:05:27 -0700130
131 uint offset; /* GPIO offset within the device */
132 /*
133 * We could consider adding the GPIO label in here. Possibly we could
134 * use this structure for internal GPIO information.
135 */
136};
137
Patrick Delaunay9360bb02020-01-13 11:35:05 +0100138/* helper to compute the value of the gpio output */
139#define GPIOD_FLAGS_OUTPUT_MASK (GPIOD_ACTIVE_LOW | GPIOD_IS_OUT_ACTIVE)
140#define GPIOD_FLAGS_OUTPUT(flags) \
141 (((((flags) & GPIOD_FLAGS_OUTPUT_MASK) == GPIOD_IS_OUT_ACTIVE) || \
142 (((flags) & GPIOD_FLAGS_OUTPUT_MASK) == GPIOD_ACTIVE_LOW)))
143
Simon Glass96495d92014-02-26 15:59:24 -0700144/**
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900145 * dm_gpio_is_valid() - Check if a GPIO is valid
Simon Glass3669e0e2015-01-05 20:05:29 -0700146 *
147 * @desc: GPIO description containing device, offset and flags,
148 * previously returned by gpio_request_by_name()
149 * @return true if valid, false if not
150 */
Simon Glass17c43f12016-03-06 19:27:51 -0700151static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
Simon Glass3669e0e2015-01-05 20:05:29 -0700152{
153 return desc->dev != NULL;
154}
155
156/**
Simon Glass07575352014-10-04 11:29:44 -0600157 * gpio_get_status() - get the current GPIO status as a string
158 *
159 * Obtain the current GPIO status as a string which can be presented to the
160 * user. A typical string is:
161 *
162 * "b4: in: 1 [x] sdmmc_cd"
163 *
164 * which means this is GPIO bank b, offset 4, currently set to input, current
165 * value 1, [x] means that it is requested and the owner is 'sdmmc_cd'
166 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700167 * TODO(sjg@chromium.org): This should use struct gpio_desc
168 *
Simon Glass07575352014-10-04 11:29:44 -0600169 * @dev: Device to check
170 * @offset: Offset of device GPIO to check
171 * @buf: Place to put string
172 * @buffsize: Size of string including \0
173 */
174int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize);
175
176/**
Simon Glass6449a502014-10-04 11:29:43 -0600177 * gpio_get_function() - get the current function for a GPIO pin
178 *
179 * Note this returns GPIOF_UNUSED if the GPIO is not requested.
180 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700181 * TODO(sjg@chromium.org): This should use struct gpio_desc
182 *
Simon Glass6449a502014-10-04 11:29:43 -0600183 * @dev: Device to check
184 * @offset: Offset of device GPIO to check
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900185 * @namep: If non-NULL, this is set to the name given when the GPIO
Simon Glass6449a502014-10-04 11:29:43 -0600186 * was requested, or -1 if it has not been requested
187 * @return -ENODATA if the driver returned an unknown function,
188 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
189 * GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
190 * function from enum gpio_func_t.
191 */
192int gpio_get_function(struct udevice *dev, int offset, const char **namep);
193
194/**
195 * gpio_get_raw_function() - get the current raw function for a GPIO pin
196 *
197 * Note this does not return GPIOF_UNUSED - it will always return the GPIO
198 * driver's view of a pin function, even if it is not correctly set up.
199 *
Simon Glass5d1c17e2015-01-05 20:05:30 -0700200 * TODO(sjg@chromium.org): This should use struct gpio_desc
201 *
Simon Glass6449a502014-10-04 11:29:43 -0600202 * @dev: Device to check
203 * @offset: Offset of device GPIO to check
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900204 * @namep: If non-NULL, this is set to the name given when the GPIO
Simon Glass6449a502014-10-04 11:29:43 -0600205 * was requested, or -1 if it has not been requested
206 * @return -ENODATA if the driver returned an unknown function,
207 * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
208 * Otherwise returns the function from enum gpio_func_t.
209 */
210int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep);
211
212/**
Simon Glassd44f5972014-10-04 11:29:49 -0600213 * gpio_requestf() - request a GPIO using a format string for the owner
214 *
215 * This is a helper function for gpio_request(). It allows you to provide
216 * a printf()-format string for the GPIO owner. It calls gpio_request() with
217 * the string that is created
218 */
219int gpio_requestf(unsigned gpio, const char *fmt, ...)
220 __attribute__ ((format (__printf__, 2, 3)));
221
Simon Glass0dac4d52015-01-05 20:05:28 -0700222struct fdtdec_phandle_args;
223
Simon Glassd44f5972014-10-04 11:29:49 -0600224/**
Eric Nelson6c880b72016-04-24 16:32:40 -0700225 * gpio_xlate_offs_flags() - implementation for common use of dm_gpio_ops.xlate
226 *
227 * This routine sets the offset field to args[0] and the flags field to
228 * GPIOD_ACTIVE_LOW if the GPIO_ACTIVE_LOW flag is present in args[1].
Eric Nelson6c880b72016-04-24 16:32:40 -0700229 */
230int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
Simon Glass3a571232017-05-18 20:09:18 -0600231 struct ofnode_phandle_args *args);
Eric Nelson6c880b72016-04-24 16:32:40 -0700232
233/**
Simon Glass96495d92014-02-26 15:59:24 -0700234 * struct struct dm_gpio_ops - Driver model GPIO operations
235 *
236 * Refer to functions above for description. These function largely copy
237 * the old API.
238 *
239 * This is trying to be close to Linux GPIO API. Once the U-Boot uses the
240 * new DM GPIO API, this should be really easy to flip over to the Linux
241 * GPIO API-alike interface.
242 *
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200243 * Also it would be useful to standardise additional functions like
Simon Glass96495d92014-02-26 15:59:24 -0700244 * pullup, slew rate and drive strength.
245 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900246 * gpio_request() and gpio_free() are optional - if NULL then they will
Simon Glass96495d92014-02-26 15:59:24 -0700247 * not be called.
248 *
249 * Note that @offset is the offset from the base GPIO of the device. So
250 * offset 0 is the device's first GPIO and offset o-1 is the last GPIO,
251 * where o is the number of GPIO lines controlled by the device. A device
252 * is typically used to control a single bank of GPIOs. Within complex
253 * SoCs there may be many banks and therefore many devices all referring
254 * to the different IO addresses within the SoC.
255 *
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200256 * The uclass combines all GPIO devices together to provide a consistent
Simon Glass96495d92014-02-26 15:59:24 -0700257 * numbering from 0 to n-1, where n is the number of GPIOs in total across
258 * all devices. Be careful not to confuse offset with gpio in the parameters.
259 */
260struct dm_gpio_ops {
Heiko Schocher54c5d082014-05-22 12:43:05 +0200261 int (*request)(struct udevice *dev, unsigned offset, const char *label);
Simon Glass093152f2020-02-04 20:15:17 -0700262 int (*rfree)(struct udevice *dev, unsigned int offset);
Heiko Schocher54c5d082014-05-22 12:43:05 +0200263 int (*direction_input)(struct udevice *dev, unsigned offset);
264 int (*direction_output)(struct udevice *dev, unsigned offset,
Simon Glass96495d92014-02-26 15:59:24 -0700265 int value);
Heiko Schocher54c5d082014-05-22 12:43:05 +0200266 int (*get_value)(struct udevice *dev, unsigned offset);
267 int (*set_value)(struct udevice *dev, unsigned offset, int value);
Simon Glass89e64052014-08-11 09:23:52 -0600268 /**
269 * get_function() Get the GPIO function
270 *
271 * @dev: Device to check
272 * @offset: GPIO offset within that device
273 * @return current function - GPIOF_...
274 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200275 int (*get_function)(struct udevice *dev, unsigned offset);
Simon Glass0dac4d52015-01-05 20:05:28 -0700276
277 /**
278 * xlate() - Translate phandle arguments into a GPIO description
279 *
280 * This function should set up the fields in desc according to the
281 * information in the arguments. The uclass will have set up:
282 *
283 * @desc->dev to @dev
284 * @desc->flags to 0
Eric Nelson6c880b72016-04-24 16:32:40 -0700285 * @desc->offset to 0
Simon Glass0dac4d52015-01-05 20:05:28 -0700286 *
Eric Nelson6c880b72016-04-24 16:32:40 -0700287 * This method is optional and defaults to gpio_xlate_offs_flags,
288 * which will parse offset and the GPIO_ACTIVE_LOW flag in the first
289 * two arguments.
Simon Glass0dac4d52015-01-05 20:05:28 -0700290 *
291 * Note that @dev is passed in as a parameter to follow driver model
292 * uclass conventions, even though it is already available as
293 * desc->dev.
294 *
295 * @dev: GPIO device
296 * @desc: Place to put GPIO description
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900297 * @args: Arguments provided in description
Simon Glass0dac4d52015-01-05 20:05:28 -0700298 * @return 0 if OK, -ve on error
299 */
300 int (*xlate)(struct udevice *dev, struct gpio_desc *desc,
Simon Glass3a571232017-05-18 20:09:18 -0600301 struct ofnode_phandle_args *args);
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100302
303 /**
Patrick Delaunay8fd9daf2020-01-13 11:35:09 +0100304 * set_dir_flags() - Set GPIO dir flags
305 *
306 * This function should set up the GPIO configuration according to the
307 * information provide by the direction flags bitfield.
308 *
309 * This method is optional.
310 *
311 * @dev: GPIO device
312 * @offset: GPIO offset within that device
313 * @flags: GPIO configuration to use
314 * @return 0 if OK, -ve on error
315 */
316 int (*set_dir_flags)(struct udevice *dev, unsigned int offset,
317 ulong flags);
318
319 /**
Patrick Delaunayd2c07e52020-01-13 11:35:08 +0100320 * get_dir_flags() - Get GPIO dir flags
321 *
322 * This function return the GPIO direction flags used.
323 *
324 * This method is optional.
325 *
326 * @dev: GPIO device
327 * @offset: GPIO offset within that device
328 * @flags: place to put the used direction flags by GPIO
329 * @return 0 if OK, -ve on error
330 */
331 int (*get_dir_flags)(struct udevice *dev, unsigned int offset,
332 ulong *flags);
Simon Glass29126862020-07-07 13:11:44 -0600333
334#if CONFIG_IS_ENABLED(ACPIGEN)
335 /**
336 * get_acpi() - Get the ACPI info for a GPIO
337 *
338 * This converts a GPIO to an ACPI structure for adding to the ACPI
339 * tables.
340 *
341 * @desc: GPIO description to convert
342 * @gpio: Output ACPI GPIO information
343 * @return ACPI pin number or -ve on error
344 */
345 int (*get_acpi)(const struct gpio_desc *desc, struct acpi_gpio *gpio);
346#endif
Simon Glass96495d92014-02-26 15:59:24 -0700347};
348
349/**
350 * struct gpio_dev_priv - information about a device used by the uclass
351 *
352 * The uclass combines all active GPIO devices into a unified numbering
Marcel Ziswiler25ca3852014-10-10 17:31:41 +0200353 * scheme. To do this it maintains some private information about each
Simon Glass96495d92014-02-26 15:59:24 -0700354 * device.
355 *
356 * To implement driver model support in your GPIO driver, add a probe
357 * handler, and set @gpio_count and @bank_name correctly in that handler.
358 * This tells the uclass the name of the GPIO bank and the number of GPIOs
359 * it contains.
360 *
361 * @bank_name: Name of the GPIO device (e.g 'a' means GPIOs will be called
362 * 'A0', 'A1', etc.
363 * @gpio_count: Number of GPIOs in this device
364 * @gpio_base: Base GPIO number for this device. For the first active device
365 * this will be 0; the numbering for others will follow sequentially so that
366 * @gpio_base for device 1 will equal the number of GPIOs in device 0.
Simon Glassb892d122014-10-04 11:29:42 -0600367 * @name: Array of pointers to the name for each GPIO in this bank. The
368 * value of the pointer will be NULL if the GPIO has not been claimed.
Simon Glass96495d92014-02-26 15:59:24 -0700369 */
370struct gpio_dev_priv {
371 const char *bank_name;
372 unsigned gpio_count;
373 unsigned gpio_base;
Simon Glassb892d122014-10-04 11:29:42 -0600374 char **name;
Simon Glass96495d92014-02-26 15:59:24 -0700375};
376
377/* Access the GPIO operations for a device */
378#define gpio_get_ops(dev) ((struct dm_gpio_ops *)(dev)->driver->ops)
379
380/**
381 * gpio_get_bank_info - Return information about a GPIO bank/device
382 *
383 * This looks up a device and returns both its GPIO base name and the number
384 * of GPIOs it controls.
385 *
386 * @dev: Device to look up
387 * @offset_count: Returns number of GPIOs within this bank
388 * @return bank name of this device
389 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200390const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
Simon Glass96495d92014-02-26 15:59:24 -0700391
392/**
Simon Glass32ec1592015-06-23 15:38:40 -0600393 * dm_gpio_lookup_name() - Look up a named GPIO and return its description
394 *
395 * The name of a GPIO is typically its bank name followed by a number from 0.
396 * For example A0 is the first GPIO in bank A. Each bank is a separate driver
397 * model device.
398 *
399 * @name: Name to look up
400 * @desc: Returns description, on success
401 * @return 0 if OK, -ve on error
402 */
403int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
404
405/**
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200406 * gpio_hog_lookup_name() - Look up a named GPIO and return the gpio descr.
407 *
408 * @name: Name to look up
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200409 * @desc: Returns GPIO description, on success, else NULL
410 * @return: Returns 0 if OK, else -ENODEV
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200411 */
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200412int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc);
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200413
414/**
415 * gpio_hog_probe_all() - probe all gpio devices with
416 * gpio-hog subnodes.
417 *
418 * @return: Returns return value from device_probe()
419 */
420int gpio_hog_probe_all(void);
421
422/**
Simon Glass96495d92014-02-26 15:59:24 -0700423 * gpio_lookup_name - Look up a GPIO name and return its details
424 *
425 * This is used to convert a named GPIO into a device, offset and GPIO
426 * number.
427 *
428 * @name: GPIO name to look up
429 * @devp: Returns pointer to device which contains this GPIO
430 * @offsetp: Returns the offset number within this device
431 * @gpiop: Returns the absolute GPIO number, numbered from 0
432 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200433int gpio_lookup_name(const char *name, struct udevice **devp,
Simon Glass96495d92014-02-26 15:59:24 -0700434 unsigned int *offsetp, unsigned int *gpiop);
435
Simon Glasse5901c92014-11-10 18:00:21 -0700436/**
Simon Glass962f5ca2015-04-14 21:03:20 -0600437 * gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
Simon Glasse5901c92014-11-10 18:00:21 -0700438 *
439 * This puts the value of the first GPIO into bit 0, the second into bit 1,
440 * etc. then returns the resulting integer.
441 *
442 * @gpio_list: List of GPIOs to collect
Simon Glass962f5ca2015-04-14 21:03:20 -0600443 * @return resulting integer value, or -ve on error
Simon Glasse5901c92014-11-10 18:00:21 -0700444 */
Simon Glass962f5ca2015-04-14 21:03:20 -0600445int gpio_get_values_as_int(const int *gpio_list);
446
447/**
Simon Glassbbf24782016-03-06 19:27:50 -0700448 * dm_gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
449 *
450 * This puts the value of the first GPIO into bit 0, the second into bit 1,
451 * etc. then returns the resulting integer.
452 *
453 * @desc_list: List of GPIOs to collect
454 * @count: Number of GPIOs
455 * @return resulting integer value, or -ve on error
456 */
Simon Glass17c43f12016-03-06 19:27:51 -0700457int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
Simon Glassbbf24782016-03-06 19:27:50 -0700458
459/**
Simon Glass962f5ca2015-04-14 21:03:20 -0600460 * gpio_claim_vector() - claim a number of GPIOs for input
461 *
462 * @gpio_num_array: array of gpios to claim, terminated by -1
463 * @fmt: format string for GPIO names, e.g. "board_id%d"
464 * @return 0 if OK, -ve on error
465 */
466int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
Jeroen Hofstee5b5ac642014-10-08 22:58:03 +0200467
Simon Glass3669e0e2015-01-05 20:05:29 -0700468/**
469 * gpio_request_by_name() - Locate and request a GPIO by name
470 *
471 * This operates by looking up the given list name in the device (device
472 * tree property) and requesting the GPIO for use. The property must exist
473 * in @dev's node.
474 *
475 * Use @flags to specify whether the GPIO should be an input or output. In
476 * principle this can also come from the device tree binding but most
477 * bindings don't provide this information. Specifically, when the GPIO uclass
478 * calls the xlate() method, it can return default flags, which are then
479 * ORed with this @flags.
480 *
481 * If we find that requesting the GPIO is not always needed we could add a
482 * new function or a new GPIOD_NO_REQUEST flag.
483 *
484 * At present driver model has no reference counting so if one device
485 * requests a GPIO which subsequently is unbound, the @desc->dev pointer
486 * will be invalid. However this will only happen if the GPIO device is
487 * unbound, not if it is removed, so this seems like a reasonable limitation
488 * for now. There is no real use case for unbinding drivers in normal
489 * operation.
490 *
491 * The device tree binding is doc/device-tree-bindings/gpio/gpio.txt in
492 * generate terms and each specific device may add additional details in
493 * a binding file in the same directory.
494 *
495 * @dev: Device requesting the GPIO
496 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
497 * @index: Index number of the GPIO in that list use request (0=first)
498 * @desc: Returns GPIO description information. If there is no such
Dario Binacchi7438d6a2020-10-11 14:25:47 +0200499 * GPIO, @desc->dev will be NULL.
Simon Glass3669e0e2015-01-05 20:05:29 -0700500 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
501 * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
502 * something wrong with the list, or other -ve for another error (e.g.
503 * -EBUSY if a GPIO was already requested)
504 */
505int gpio_request_by_name(struct udevice *dev, const char *list_name,
506 int index, struct gpio_desc *desc, int flags);
507
508/**
509 * gpio_request_list_by_name() - Request a list of GPIOs
510 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900511 * Reads all the GPIOs from a list and requests them. See
Simon Glass3669e0e2015-01-05 20:05:29 -0700512 * gpio_request_by_name() for additional details. Lists should not be
513 * misused to hold unrelated or optional GPIOs. They should only be used
514 * for things like parallel data lines. A zero phandle terminates the list
515 * the list.
516 *
517 * This function will either succeed, and request all GPIOs in the list, or
518 * fail and request none (it will free already-requested GPIOs in case of
519 * an error part-way through).
520 *
521 * @dev: Device requesting the GPIO
522 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
523 * @desc_list: Returns a list of GPIO description information
524 * @max_count: Maximum number of GPIOs to return (@desc_list must be at least
525 * this big)
526 * @flags: Indicates the GPIO input/output settings (GPIOD_...)
527 * @return number of GPIOs requested, or -ve on error
528 */
529int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
530 struct gpio_desc *desc_list, int max_count,
531 int flags);
532
533/**
Simon Glassefa677f2015-06-23 15:38:41 -0600534 * dm_gpio_request() - manually request a GPIO
535 *
536 * Note: This function should only be used for testing / debugging. Instead.
537 * use gpio_request_by_name() to pull GPIOs from the device tree.
538 *
539 * @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
540 * @label: Label to attach to the GPIO while claimed
541 * @return 0 if OK, -ve on error
542 */
543int dm_gpio_request(struct gpio_desc *desc, const char *label);
544
545/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700546 * gpio_get_list_count() - Returns the number of GPIOs in a list
547 *
548 * Counts the GPIOs in a list. See gpio_request_by_name() for additional
549 * details.
550 *
551 * @dev: Device requesting the GPIO
552 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
553 * @return number of GPIOs (0 for an empty property) or -ENOENT if the list
554 * does not exist
555 */
556int gpio_get_list_count(struct udevice *dev, const char *list_name);
557
558/**
559 * gpio_request_by_name_nodev() - request GPIOs without a device
560 *
561 * This is a version of gpio_request_list_by_name() that does not use a
562 * device. Avoid it unless the caller is not yet using driver model
563 */
Simon Glass150c5af2017-05-30 21:47:09 -0600564int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
565 struct gpio_desc *desc, int flags);
Simon Glass3669e0e2015-01-05 20:05:29 -0700566
567/**
568 * gpio_request_list_by_name_nodev() - request GPIOs without a device
569 *
570 * This is a version of gpio_request_list_by_name() that does not use a
571 * device. Avoid it unless the caller is not yet using driver model
572 */
Simon Glass150c5af2017-05-30 21:47:09 -0600573int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
Simon Glass3669e0e2015-01-05 20:05:29 -0700574 struct gpio_desc *desc_list, int max_count,
575 int flags);
576
577/**
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200578 * gpio_dev_request_index() - request single GPIO from gpio device
579 *
580 * @dev: GPIO device
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200581 * @nodename: Name of node for which gpio gets requested, used
582 * for the gpio label name
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200583 * @list_name: Name of GPIO list (e.g. "board-id-gpios")
584 * @index: Index number of the GPIO in that list use request (0=first)
585 * @flags: GPIOD_* flags
Heiko Schocher49b10cb2019-07-17 06:59:51 +0200586 * @dtflags: GPIO flags read from DT defined see GPIOD_*
587 * @desc: returns GPIO descriptor filled from this function
Heiko Schocher5fc7cf82019-06-12 06:11:46 +0200588 * @return: return value from gpio_request_tail()
589 */
590int gpio_dev_request_index(struct udevice *dev, const char *nodename,
591 char *list_name, int index, int flags,
592 int dtflags, struct gpio_desc *desc);
593
594/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700595 * dm_gpio_free() - Free a single GPIO
596 *
597 * This frees a single GPIOs previously returned from gpio_request_by_name().
598 *
599 * @dev: Device which requested the GPIO
600 * @desc: GPIO to free
601 * @return 0 if OK, -ve on error
602 */
603int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
604
605/**
606 * gpio_free_list() - Free a list of GPIOs
607 *
608 * This frees a list of GPIOs previously returned from
609 * gpio_request_list_by_name().
610 *
611 * @dev: Device which requested the GPIOs
612 * @desc: List of GPIOs to free
613 * @count: Number of GPIOs in the list
614 * @return 0 if OK, -ve on error
615 */
616int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
617
618/**
619 * gpio_free_list_nodev() - free GPIOs without a device
620 *
621 * This is a version of gpio_free_list() that does not use a
622 * device. Avoid it unless the caller is not yet using driver model
623 */
624int gpio_free_list_nodev(struct gpio_desc *desc, int count);
625
626/**
627 * dm_gpio_get_value() - Get the value of a GPIO
628 *
629 * This is the driver model version of the existing gpio_get_value() function
630 * and should be used instead of that.
631 *
632 * For now, these functions have a dm_ prefix since they conflict with
633 * existing names.
634 *
635 * @desc: GPIO description containing device, offset and flags,
636 * previously returned by gpio_request_by_name()
637 * @return GPIO value (0 for inactive, 1 for active) or -ve on error
638 */
Simon Glass17c43f12016-03-06 19:27:51 -0700639int dm_gpio_get_value(const struct gpio_desc *desc);
Simon Glass3669e0e2015-01-05 20:05:29 -0700640
Simon Glass17c43f12016-03-06 19:27:51 -0700641int dm_gpio_set_value(const struct gpio_desc *desc, int value);
Simon Glass3669e0e2015-01-05 20:05:29 -0700642
643/**
644 * dm_gpio_set_dir() - Set the direction for a GPIO
645 *
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100646 * This sets up the direction according to the GPIO flags: desc->flags.
Simon Glass3669e0e2015-01-05 20:05:29 -0700647 *
648 * @desc: GPIO description containing device, offset and flags,
649 * previously returned by gpio_request_by_name()
650 * @return 0 if OK, -ve on error
651 */
652int dm_gpio_set_dir(struct gpio_desc *desc);
653
654/**
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100655 * dm_gpio_set_dir_flags() - Set direction using description and added flags
Simon Glass3669e0e2015-01-05 20:05:29 -0700656 *
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100657 * This sets up the direction according to the provided flags and the GPIO
658 * description (desc->flags) which include direction information.
Simon Glass3669e0e2015-01-05 20:05:29 -0700659 * Note that desc->flags is updated by this function.
660 *
661 * @desc: GPIO description containing device, offset and flags,
662 * previously returned by gpio_request_by_name()
663 * @flags: New flags to use
664 * @return 0 if OK, -ve on error, in which case desc->flags is not updated
665 */
666int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
667
668/**
Patrick Delaunay695e5fd2020-01-13 11:35:06 +0100669 * dm_gpio_get_dir_flags() - Get direction flags
670 *
671 * read the current direction flags
672 *
673 * @desc: GPIO description containing device, offset and flags,
674 * previously returned by gpio_request_by_name()
675 * @flags: place to put the used flags
676 * @return 0 if OK, -ve on error, in which case desc->flags is not updated
677 */
678int dm_gpio_get_dir_flags(struct gpio_desc *desc, ulong *flags);
679
680/**
Simon Glass3669e0e2015-01-05 20:05:29 -0700681 * gpio_get_number() - Get the global GPIO number of a GPIO
682 *
Masahiro Yamadad9a607f2015-05-29 21:57:33 +0900683 * This should only be used for debugging or interest. It returns the number
Simon Glass3669e0e2015-01-05 20:05:29 -0700684 * that should be used for gpio_get_value() etc. to access this GPIO.
685 *
686 * @desc: GPIO description containing device, offset and flags,
687 * previously returned by gpio_request_by_name()
688 * @return GPIO number, or -ve if not found
689 */
Simon Glass17c43f12016-03-06 19:27:51 -0700690int gpio_get_number(const struct gpio_desc *desc);
Simon Glass3669e0e2015-01-05 20:05:29 -0700691
Simon Glass29126862020-07-07 13:11:44 -0600692/**
693 * gpio_get_acpi() - Get the ACPI pin for a GPIO
694 *
695 * This converts a GPIO to an ACPI pin number for adding to the ACPI
696 * tables. If the GPIO is invalid, the pin_count and pins[0] are set to 0
697 *
698 * @desc: GPIO description to convert
699 * @gpio: Output ACPI GPIO information
700 * @return ACPI pin number or -ve on error
701 */
702int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio);
703
Jean-Jacques Hiblotd4b722e2020-09-11 13:43:34 +0530704/**
705 * devm_gpiod_get_index - Resource-managed gpiod_get()
706 * @dev: GPIO consumer
707 * @con_id: function within the GPIO consumer
708 * @index: index of the GPIO to obtain in the consumer
709 * @flags: optional GPIO initialization flags
710 *
711 * Managed gpiod_get(). GPIO descriptors returned from this function are
712 * automatically disposed on device unbind.
713 * Return the GPIO descriptor corresponding to the function con_id of device
714 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
715 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
716 */
717struct gpio_desc *devm_gpiod_get_index(struct udevice *dev, const char *id,
718 unsigned int index, int flags);
719
720#define devm_gpiod_get(dev, id, flags) devm_gpiod_get_index(dev, id, 0, flags)
721/**
722 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
723 * @dev: GPIO consumer, can be NULL for system-global GPIOs
724 * @con_id: function within the GPIO consumer
725 * @index: index of the GPIO to obtain in the consumer
726 * @flags: optional GPIO initialization flags
727 *
728 * This is equivalent to devm_gpiod_get(), except that when no GPIO was
729 * assigned to the requested function it will return NULL. This is convenient
730 * for drivers that need to handle optional GPIOs.
731 */
732struct gpio_desc *devm_gpiod_get_index_optional(struct udevice *dev,
733 const char *id,
734 unsigned int index,
735 int flags);
736
737#define devm_gpiod_get_optional(dev, id, flags) \
738 devm_gpiod_get_index_optional(dev, id, 0, flags)
739
740/**
741 * devm_gpiod_put - Resource-managed gpiod_put()
742 * @dev: GPIO consumer
743 * @desc: GPIO descriptor to dispose of
744 *
745 * Dispose of a GPIO descriptor obtained with devm_gpiod_get() or
746 * devm_gpiod_get_index(). Normally this function will not be called as the GPIO
747 * will be disposed of by the resource management code.
748 */
749void devm_gpiod_put(struct udevice *dev, struct gpio_desc *desc);
750
Joe Hershberger5f533ae2011-11-11 15:55:35 -0600751#endif /* _ASM_GENERIC_GPIO_H_ */