GNU Linux-libre 4.19.264-gnu1
[releases.git] / include / linux / pinctrl / pinconf.h
1 /*
2  * Interface the pinconfig portions of the pinctrl subsystem
3  *
4  * Copyright (C) 2011 ST-Ericsson SA
5  * Written on behalf of Linaro for ST-Ericsson
6  * This interface is used in the core to keep track of pins.
7  *
8  * Author: Linus Walleij <linus.walleij@linaro.org>
9  *
10  * License terms: GNU General Public License (GPL) version 2
11  */
12 #ifndef __LINUX_PINCTRL_PINCONF_H
13 #define __LINUX_PINCTRL_PINCONF_H
14
15 #ifdef CONFIG_PINCONF
16
17 #include <linux/pinctrl/machine.h>
18
19 struct pinctrl_dev;
20 struct seq_file;
21
22 /**
23  * struct pinconf_ops - pin config operations, to be implemented by
24  * pin configuration capable drivers.
25  * @is_generic: for pin controllers that want to use the generic interface,
26  *      this flag tells the framework that it's generic.
27  * @pin_config_get: get the config of a certain pin, if the requested config
28  *      is not available on this controller this should return -ENOTSUPP
29  *      and if it is available but disabled it should return -EINVAL
30  * @pin_config_set: configure an individual pin
31  * @pin_config_group_get: get configurations for an entire pin group; should
32  *      return -ENOTSUPP and -EINVAL using the same rules as pin_config_get.
33  * @pin_config_group_set: configure all pins in a group
34  * @pin_config_dbg_parse_modify: optional debugfs to modify a pin configuration
35  * @pin_config_dbg_show: optional debugfs display hook that will provide
36  *      per-device info for a certain pin in debugfs
37  * @pin_config_group_dbg_show: optional debugfs display hook that will provide
38  *      per-device info for a certain group in debugfs
39  * @pin_config_config_dbg_show: optional debugfs display hook that will decode
40  *      and display a driver's pin configuration parameter
41  */
42 struct pinconf_ops {
43 #ifdef CONFIG_GENERIC_PINCONF
44         bool is_generic;
45 #endif
46         int (*pin_config_get) (struct pinctrl_dev *pctldev,
47                                unsigned pin,
48                                unsigned long *config);
49         int (*pin_config_set) (struct pinctrl_dev *pctldev,
50                                unsigned pin,
51                                unsigned long *configs,
52                                unsigned num_configs);
53         int (*pin_config_group_get) (struct pinctrl_dev *pctldev,
54                                      unsigned selector,
55                                      unsigned long *config);
56         int (*pin_config_group_set) (struct pinctrl_dev *pctldev,
57                                      unsigned selector,
58                                      unsigned long *configs,
59                                      unsigned num_configs);
60         int (*pin_config_dbg_parse_modify) (struct pinctrl_dev *pctldev,
61                                            const char *arg,
62                                            unsigned long *config);
63         void (*pin_config_dbg_show) (struct pinctrl_dev *pctldev,
64                                      struct seq_file *s,
65                                      unsigned offset);
66         void (*pin_config_group_dbg_show) (struct pinctrl_dev *pctldev,
67                                            struct seq_file *s,
68                                            unsigned selector);
69         void (*pin_config_config_dbg_show) (struct pinctrl_dev *pctldev,
70                                             struct seq_file *s,
71                                             unsigned long config);
72 };
73
74 #endif
75
76 #endif /* __LINUX_PINCTRL_PINCONF_H */