gpio: remove the open_drain API and ops
[oweals/u-boot.git] / include / asm-generic / gpio.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (c) 2011 The Chromium OS Authors.
4  * Copyright (c) 2011, NVIDIA Corp. All rights reserved.
5  */
6
7 #ifndef _ASM_GENERIC_GPIO_H_
8 #define _ASM_GENERIC_GPIO_H_
9
10 #include <dm/ofnode.h>
11
12 struct ofnode_phandle_args;
13
14 /*
15  * Generic GPIO API for U-Boot
16  *
17  * --
18  * NB: This is deprecated. Please use the driver model functions instead:
19  *
20  *    - gpio_request_by_name()
21  *    - dm_gpio_get_value() etc.
22  *
23  * For now we need a dm_ prefix on some functions to avoid name collision.
24  * --
25  *
26  * GPIOs are numbered from 0 to GPIO_COUNT-1 which value is defined
27  * by the SOC/architecture.
28  *
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.
34  *
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.
39  */
40
41 /**
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.
45  *
46  * Note: With driver model, the label is allocated so there is no need for
47  * the caller to preserve it.
48  *
49  * @param gpio  GPIO number
50  * @param label User label for this GPIO
51  * @return 0 if ok, -1 on error
52  */
53 int gpio_request(unsigned gpio, const char *label);
54
55 /**
56  * @deprecated  Please use driver model instead
57  * Stop using the GPIO.  This function should not alter pin configuration.
58  *
59  * @param gpio  GPIO number
60  * @return 0 if ok, -1 on error
61  */
62 int gpio_free(unsigned gpio);
63
64 /**
65  * @deprecated  Please use driver model instead
66  * Make a GPIO an input.
67  *
68  * @param gpio  GPIO number
69  * @return 0 if ok, -1 on error
70  */
71 int gpio_direction_input(unsigned gpio);
72
73 /**
74  * @deprecated  Please use driver model instead
75  * Make a GPIO an output, and set its value.
76  *
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
80  */
81 int gpio_direction_output(unsigned gpio, int value);
82
83 /**
84  * @deprecated  Please use driver model instead
85  * Get a GPIO's value. This will work whether the GPIO is an input
86  * or an output.
87  *
88  * @param gpio  GPIO number
89  * @return 0 if low, 1 if high, -1 on error
90  */
91 int gpio_get_value(unsigned gpio);
92
93 /**
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.
97  *
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
101  */
102 int gpio_set_value(unsigned gpio, int value);
103
104 /* State of a GPIO, as reported by get_function() */
105 enum gpio_func_t {
106         GPIOF_INPUT = 0,
107         GPIOF_OUTPUT,
108         GPIOF_UNUSED,           /* Not claimed */
109         GPIOF_UNKNOWN,          /* Not known */
110         GPIOF_FUNC,             /* Not used as a GPIO */
111
112         GPIOF_COUNT,
113 };
114
115 struct udevice;
116
117 struct gpio_desc {
118         struct udevice *dev;    /* Device, NULL for invalid GPIO */
119         unsigned long flags;
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)  /* value has active low */
123 #define GPIOD_IS_OUT_ACTIVE     BIT(4)  /* set output active */
124
125         uint offset;            /* GPIO offset within the device */
126         /*
127          * We could consider adding the GPIO label in here. Possibly we could
128          * use this structure for internal GPIO information.
129          */
130 };
131
132 /**
133  * dm_gpio_is_valid() - Check if a GPIO is valid
134  *
135  * @desc:       GPIO description containing device, offset and flags,
136  *              previously returned by gpio_request_by_name()
137  * @return true if valid, false if not
138  */
139 static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
140 {
141         return desc->dev != NULL;
142 }
143
144 /**
145  * gpio_get_status() - get the current GPIO status as a string
146  *
147  * Obtain the current GPIO status as a string which can be presented to the
148  * user. A typical string is:
149  *
150  * "b4:  in: 1 [x] sdmmc_cd"
151  *
152  * which means this is GPIO bank b, offset 4, currently set to input, current
153  * value 1, [x] means that it is requested and the owner is 'sdmmc_cd'
154  *
155  * TODO(sjg@chromium.org): This should use struct gpio_desc
156  *
157  * @dev:        Device to check
158  * @offset:     Offset of device GPIO to check
159  * @buf:        Place to put string
160  * @buffsize:   Size of string including \0
161  */
162 int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize);
163
164 /**
165  * gpio_get_function() - get the current function for a GPIO pin
166  *
167  * Note this returns GPIOF_UNUSED if the GPIO is not requested.
168  *
169  * TODO(sjg@chromium.org): This should use struct gpio_desc
170  *
171  * @dev:        Device to check
172  * @offset:     Offset of device GPIO to check
173  * @namep:      If non-NULL, this is set to the name given when the GPIO
174  *              was requested, or -1 if it has not been requested
175  * @return  -ENODATA if the driver returned an unknown function,
176  * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
177  * GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
178  * function from enum gpio_func_t.
179  */
180 int gpio_get_function(struct udevice *dev, int offset, const char **namep);
181
182 /**
183  * gpio_get_raw_function() - get the current raw function for a GPIO pin
184  *
185  * Note this does not return GPIOF_UNUSED - it will always return the GPIO
186  * driver's view of a pin function, even if it is not correctly set up.
187  *
188  * TODO(sjg@chromium.org): This should use struct gpio_desc
189  *
190  * @dev:        Device to check
191  * @offset:     Offset of device GPIO to check
192  * @namep:      If non-NULL, this is set to the name given when the GPIO
193  *              was requested, or -1 if it has not been requested
194  * @return  -ENODATA if the driver returned an unknown function,
195  * -ENODEV if the device is not active, -EINVAL if the offset is invalid.
196  * Otherwise returns the function from enum gpio_func_t.
197  */
198 int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep);
199
200 /**
201  * gpio_requestf() - request a GPIO using a format string for the owner
202  *
203  * This is a helper function for gpio_request(). It allows you to provide
204  * a printf()-format string for the GPIO owner. It calls gpio_request() with
205  * the string that is created
206  */
207 int gpio_requestf(unsigned gpio, const char *fmt, ...)
208                 __attribute__ ((format (__printf__, 2, 3)));
209
210 struct fdtdec_phandle_args;
211
212 /**
213  * gpio_xlate_offs_flags() - implementation for common use of dm_gpio_ops.xlate
214  *
215  * This routine sets the offset field to args[0] and the flags field to
216  * GPIOD_ACTIVE_LOW if the GPIO_ACTIVE_LOW flag is present in args[1].
217  */
218 int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
219                           struct ofnode_phandle_args *args);
220
221 /**
222  * struct struct dm_gpio_ops - Driver model GPIO operations
223  *
224  * Refer to functions above for description. These function largely copy
225  * the old API.
226  *
227  * This is trying to be close to Linux GPIO API. Once the U-Boot uses the
228  * new DM GPIO API, this should be really easy to flip over to the Linux
229  * GPIO API-alike interface.
230  *
231  * Also it would be useful to standardise additional functions like
232  * pullup, slew rate and drive strength.
233  *
234  * gpio_request() and gpio_free() are optional - if NULL then they will
235  * not be called.
236  *
237  * Note that @offset is the offset from the base GPIO of the device. So
238  * offset 0 is the device's first GPIO and offset o-1 is the last GPIO,
239  * where o is the number of GPIO lines controlled by the device. A device
240  * is typically used to control a single bank of GPIOs. Within complex
241  * SoCs there may be many banks and therefore many devices all referring
242  * to the different IO addresses within the SoC.
243  *
244  * The uclass combines all GPIO devices together to provide a consistent
245  * numbering from 0 to n-1, where n is the number of GPIOs in total across
246  * all devices. Be careful not to confuse offset with gpio in the parameters.
247  */
248 struct dm_gpio_ops {
249         int (*request)(struct udevice *dev, unsigned offset, const char *label);
250         int (*rfree)(struct udevice *dev, unsigned int offset);
251         int (*direction_input)(struct udevice *dev, unsigned offset);
252         int (*direction_output)(struct udevice *dev, unsigned offset,
253                                 int value);
254         int (*get_value)(struct udevice *dev, unsigned offset);
255         int (*set_value)(struct udevice *dev, unsigned offset, int value);
256         /**
257          * get_function() Get the GPIO function
258          *
259          * @dev:     Device to check
260          * @offset:  GPIO offset within that device
261          * @return current function - GPIOF_...
262          */
263         int (*get_function)(struct udevice *dev, unsigned offset);
264
265         /**
266          * xlate() - Translate phandle arguments into a GPIO description
267          *
268          * This function should set up the fields in desc according to the
269          * information in the arguments. The uclass will have set up:
270          *
271          *   @desc->dev to @dev
272          *   @desc->flags to 0
273          *   @desc->offset to 0
274          *
275          * This method is optional and defaults to gpio_xlate_offs_flags,
276          * which will parse offset and the GPIO_ACTIVE_LOW flag in the first
277          * two arguments.
278          *
279          * Note that @dev is passed in as a parameter to follow driver model
280          * uclass conventions, even though it is already available as
281          * desc->dev.
282          *
283          * @dev:        GPIO device
284          * @desc:       Place to put GPIO description
285          * @args:       Arguments provided in description
286          * @return 0 if OK, -ve on error
287          */
288         int (*xlate)(struct udevice *dev, struct gpio_desc *desc,
289                      struct ofnode_phandle_args *args);
290 };
291
292 /**
293  * struct gpio_dev_priv - information about a device used by the uclass
294  *
295  * The uclass combines all active GPIO devices into a unified numbering
296  * scheme. To do this it maintains some private information about each
297  * device.
298  *
299  * To implement driver model support in your GPIO driver, add a probe
300  * handler, and set @gpio_count and @bank_name correctly in that handler.
301  * This tells the uclass the name of the GPIO bank and the number of GPIOs
302  * it contains.
303  *
304  * @bank_name: Name of the GPIO device (e.g 'a' means GPIOs will be called
305  * 'A0', 'A1', etc.
306  * @gpio_count: Number of GPIOs in this device
307  * @gpio_base: Base GPIO number for this device. For the first active device
308  * this will be 0; the numbering for others will follow sequentially so that
309  * @gpio_base for device 1 will equal the number of GPIOs in device 0.
310  * @name: Array of pointers to the name for each GPIO in this bank. The
311  * value of the pointer will be NULL if the GPIO has not been claimed.
312  */
313 struct gpio_dev_priv {
314         const char *bank_name;
315         unsigned gpio_count;
316         unsigned gpio_base;
317         char **name;
318 };
319
320 /* Access the GPIO operations for a device */
321 #define gpio_get_ops(dev)       ((struct dm_gpio_ops *)(dev)->driver->ops)
322
323 /**
324  * gpio_get_bank_info - Return information about a GPIO bank/device
325  *
326  * This looks up a device and returns both its GPIO base name and the number
327  * of GPIOs it controls.
328  *
329  * @dev: Device to look up
330  * @offset_count: Returns number of GPIOs within this bank
331  * @return bank name of this device
332  */
333 const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
334
335 /**
336  * dm_gpio_lookup_name() - Look up a named GPIO and return its description
337  *
338  * The name of a GPIO is typically its bank name followed by a number from 0.
339  * For example A0 is the first GPIO in bank A. Each bank is a separate driver
340  * model device.
341  *
342  * @name:       Name to look up
343  * @desc:       Returns description, on success
344  * @return 0 if OK, -ve on error
345  */
346 int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
347
348 /**
349  * gpio_hog_lookup_name() - Look up a named GPIO and return the gpio descr.
350  *
351  * @name:       Name to look up
352  * @desc:       Returns GPIO description, on success, else NULL
353  * @return:     Returns 0 if OK, else -ENODEV
354  */
355 int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc);
356
357 /**
358  * gpio_hog_probe_all() - probe all gpio devices with
359  * gpio-hog subnodes.
360  *
361  * @return:     Returns return value from device_probe()
362  */
363 int gpio_hog_probe_all(void);
364
365 /**
366  * gpio_lookup_name - Look up a GPIO name and return its details
367  *
368  * This is used to convert a named GPIO into a device, offset and GPIO
369  * number.
370  *
371  * @name: GPIO name to look up
372  * @devp: Returns pointer to device which contains this GPIO
373  * @offsetp: Returns the offset number within this device
374  * @gpiop: Returns the absolute GPIO number, numbered from 0
375  */
376 int gpio_lookup_name(const char *name, struct udevice **devp,
377                      unsigned int *offsetp, unsigned int *gpiop);
378
379 /**
380  * gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
381  *
382  * This puts the value of the first GPIO into bit 0, the second into bit 1,
383  * etc. then returns the resulting integer.
384  *
385  * @gpio_list: List of GPIOs to collect
386  * @return resulting integer value, or -ve on error
387  */
388 int gpio_get_values_as_int(const int *gpio_list);
389
390 /**
391  * dm_gpio_get_values_as_int() - Turn the values of a list of GPIOs into an int
392  *
393  * This puts the value of the first GPIO into bit 0, the second into bit 1,
394  * etc. then returns the resulting integer.
395  *
396  * @desc_list: List of GPIOs to collect
397  * @count: Number of GPIOs
398  * @return resulting integer value, or -ve on error
399  */
400 int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
401
402 /**
403  * gpio_claim_vector() - claim a number of GPIOs for input
404  *
405  * @gpio_num_array:     array of gpios to claim, terminated by -1
406  * @fmt:                format string for GPIO names, e.g. "board_id%d"
407  * @return 0 if OK, -ve on error
408  */
409 int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
410
411 /**
412  * gpio_request_by_name() - Locate and request a GPIO by name
413  *
414  * This operates by looking up the given list name in the device (device
415  * tree property) and requesting the GPIO for use. The property must exist
416  * in @dev's node.
417  *
418  * Use @flags to specify whether the GPIO should be an input or output. In
419  * principle this can also come from the device tree binding but most
420  * bindings don't provide this information. Specifically, when the GPIO uclass
421  * calls the xlate() method, it can return default flags, which are then
422  * ORed with this @flags.
423  *
424  * If we find that requesting the GPIO is not always needed we could add a
425  * new function or a new GPIOD_NO_REQUEST flag.
426  *
427  * At present driver model has no reference counting so if one device
428  * requests a GPIO which subsequently is unbound, the @desc->dev pointer
429  * will be invalid. However this will only happen if the GPIO device is
430  * unbound, not if it is removed, so this seems like a reasonable limitation
431  * for now. There is no real use case for unbinding drivers in normal
432  * operation.
433  *
434  * The device tree binding is doc/device-tree-bindings/gpio/gpio.txt in
435  * generate terms and each specific device may add additional details in
436  * a binding file in the same directory.
437  *
438  * @dev:        Device requesting the GPIO
439  * @list_name:  Name of GPIO list (e.g. "board-id-gpios")
440  * @index:      Index number of the GPIO in that list use request (0=first)
441  * @desc:       Returns GPIO description information. If there is no such
442  *              GPIO, dev->dev will be NULL.
443  * @flags:      Indicates the GPIO input/output settings (GPIOD_...)
444  * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
445  * something wrong with the list, or other -ve for another error (e.g.
446  * -EBUSY if a GPIO was already requested)
447  */
448 int gpio_request_by_name(struct udevice *dev, const char *list_name,
449                          int index, struct gpio_desc *desc, int flags);
450
451 /**
452  * gpio_request_list_by_name() - Request a list of GPIOs
453  *
454  * Reads all the GPIOs from a list and requests them. See
455  * gpio_request_by_name() for additional details. Lists should not be
456  * misused to hold unrelated or optional GPIOs. They should only be used
457  * for things like parallel data lines. A zero phandle terminates the list
458  * the list.
459  *
460  * This function will either succeed, and request all GPIOs in the list, or
461  * fail and request none (it will free already-requested GPIOs in case of
462  * an error part-way through).
463  *
464  * @dev:        Device requesting the GPIO
465  * @list_name:  Name of GPIO list (e.g. "board-id-gpios")
466  * @desc_list:  Returns a list of GPIO description information
467  * @max_count:  Maximum number of GPIOs to return (@desc_list must be at least
468  *              this big)
469  * @flags:      Indicates the GPIO input/output settings (GPIOD_...)
470  * @return number of GPIOs requested, or -ve on error
471  */
472 int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
473                               struct gpio_desc *desc_list, int max_count,
474                               int flags);
475
476 /**
477  * dm_gpio_request() - manually request a GPIO
478  *
479  * Note: This function should only be used for testing / debugging. Instead.
480  * use gpio_request_by_name() to pull GPIOs from the device tree.
481  *
482  * @desc:       GPIO description of GPIO to request (see dm_gpio_lookup_name())
483  * @label:      Label to attach to the GPIO while claimed
484  * @return 0 if OK, -ve on error
485  */
486 int dm_gpio_request(struct gpio_desc *desc, const char *label);
487
488 /**
489  * gpio_get_list_count() - Returns the number of GPIOs in a list
490  *
491  * Counts the GPIOs in a list. See gpio_request_by_name() for additional
492  * details.
493  *
494  * @dev:        Device requesting the GPIO
495  * @list_name:  Name of GPIO list (e.g. "board-id-gpios")
496  * @return number of GPIOs (0 for an empty property) or -ENOENT if the list
497  * does not exist
498  */
499 int gpio_get_list_count(struct udevice *dev, const char *list_name);
500
501 /**
502  * gpio_request_by_name_nodev() - request GPIOs without a device
503  *
504  * This is a version of gpio_request_list_by_name() that does not use a
505  * device. Avoid it unless the caller is not yet using driver model
506  */
507 int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
508                                struct gpio_desc *desc, int flags);
509
510 /**
511  * gpio_request_list_by_name_nodev() - request GPIOs without a device
512  *
513  * This is a version of gpio_request_list_by_name() that does not use a
514  * device. Avoid it unless the caller is not yet using driver model
515  */
516 int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
517                                     struct gpio_desc *desc_list, int max_count,
518                                     int flags);
519
520 /**
521  * gpio_dev_request_index() - request single GPIO from gpio device
522  *
523  * @dev:        GPIO device
524  * @nodename:   Name of node for which gpio gets requested, used
525  *              for the gpio label name
526  * @list_name:  Name of GPIO list (e.g. "board-id-gpios")
527  * @index:      Index number of the GPIO in that list use request (0=first)
528  * @flags:      GPIOD_* flags
529  * @dtflags:    GPIO flags read from DT defined see GPIOD_*
530  * @desc:       returns GPIO descriptor filled from this function
531  * @return:     return value from gpio_request_tail()
532  */
533 int gpio_dev_request_index(struct udevice *dev, const char *nodename,
534                            char *list_name, int index, int flags,
535                            int dtflags, struct gpio_desc *desc);
536
537 /**
538  * dm_gpio_free() - Free a single GPIO
539  *
540  * This frees a single GPIOs previously returned from gpio_request_by_name().
541  *
542  * @dev:        Device which requested the GPIO
543  * @desc:       GPIO to free
544  * @return 0 if OK, -ve on error
545  */
546 int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
547
548 /**
549  * gpio_free_list() - Free a list of GPIOs
550  *
551  * This frees a list of GPIOs previously returned from
552  * gpio_request_list_by_name().
553  *
554  * @dev:        Device which requested the GPIOs
555  * @desc:       List of GPIOs to free
556  * @count:      Number of GPIOs in the list
557  * @return 0 if OK, -ve on error
558  */
559 int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
560
561 /**
562  * gpio_free_list_nodev() - free GPIOs without a device
563  *
564  * This is a version of gpio_free_list() that does not use a
565  * device. Avoid it unless the caller is not yet using driver model
566  */
567 int gpio_free_list_nodev(struct gpio_desc *desc, int count);
568
569 /**
570  * dm_gpio_get_value() - Get the value of a GPIO
571  *
572  * This is the driver model version of the existing gpio_get_value() function
573  * and should be used instead of that.
574  *
575  * For now, these functions have a dm_ prefix since they conflict with
576  * existing names.
577  *
578  * @desc:       GPIO description containing device, offset and flags,
579  *              previously returned by gpio_request_by_name()
580  * @return GPIO value (0 for inactive, 1 for active) or -ve on error
581  */
582 int dm_gpio_get_value(const struct gpio_desc *desc);
583
584 int dm_gpio_set_value(const struct gpio_desc *desc, int value);
585
586 /**
587  * dm_gpio_set_dir() - Set the direction for a GPIO
588  *
589  * This sets up the direction according tot the provided flags. It will do
590  * nothing unless the direction is actually specified.
591  *
592  * @desc:       GPIO description containing device, offset and flags,
593  *              previously returned by gpio_request_by_name()
594  * @return 0 if OK, -ve on error
595  */
596 int dm_gpio_set_dir(struct gpio_desc *desc);
597
598 /**
599  * dm_gpio_set_dir_flags() - Set direction using specific flags
600  *
601  * This is like dm_gpio_set_dir() except that the flags value is provided
602  * instead of being used from desc->flags. This is needed because in many
603  * cases the GPIO description does not include direction information.
604  * Note that desc->flags is updated by this function.
605  *
606  * @desc:       GPIO description containing device, offset and flags,
607  *              previously returned by gpio_request_by_name()
608  * @flags:      New flags to use
609  * @return 0 if OK, -ve on error, in which case desc->flags is not updated
610  */
611 int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
612
613 /**
614  * gpio_get_number() - Get the global GPIO number of a GPIO
615  *
616  * This should only be used for debugging or interest. It returns the number
617  * that should be used for gpio_get_value() etc. to access this GPIO.
618  *
619  * @desc:       GPIO description containing device, offset and flags,
620  *              previously returned by gpio_request_by_name()
621  * @return GPIO number, or -ve if not found
622  */
623 int gpio_get_number(const struct gpio_desc *desc);
624
625 #endif  /* _ASM_GENERIC_GPIO_H_ */