xref: /linux-6.15/include/linux/pinctrl/pinconf.h (revision e8d4f892)
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 <[email protected]>
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 struct pinctrl_dev;
18 struct seq_file;
19 
20 /**
21  * struct pinconf_ops - pin config operations, to be implemented by
22  * pin configuration capable drivers.
23  * @is_generic: for pin controllers that want to use the generic interface,
24  *	this flag tells the framework that it's generic.
25  * @pin_config_get: get the config of a certain pin, if the requested config
26  *	is not available on this controller this should return -ENOTSUPP
27  *	and if it is available but disabled it should return -EINVAL
28  * @pin_config_set: configure an individual pin
29  * @pin_config_group_get: get configurations for an entire pin group; should
30  *	return -ENOTSUPP and -EINVAL using the same rules as pin_config_get.
31  * @pin_config_group_set: configure all pins in a group
32  * @pin_config_dbg_show: optional debugfs display hook that will provide
33  *	per-device info for a certain pin in debugfs
34  * @pin_config_group_dbg_show: optional debugfs display hook that will provide
35  *	per-device info for a certain group in debugfs
36  * @pin_config_config_dbg_show: optional debugfs display hook that will decode
37  *	and display a driver's pin configuration parameter
38  */
39 struct pinconf_ops {
40 #ifdef CONFIG_GENERIC_PINCONF
41 	bool is_generic;
42 #endif
43 	int (*pin_config_get) (struct pinctrl_dev *pctldev,
44 			       unsigned pin,
45 			       unsigned long *config);
46 	int (*pin_config_set) (struct pinctrl_dev *pctldev,
47 			       unsigned pin,
48 			       unsigned long *configs,
49 			       unsigned num_configs);
50 	int (*pin_config_group_get) (struct pinctrl_dev *pctldev,
51 				     unsigned selector,
52 				     unsigned long *config);
53 	int (*pin_config_group_set) (struct pinctrl_dev *pctldev,
54 				     unsigned selector,
55 				     unsigned long *configs,
56 				     unsigned num_configs);
57 	void (*pin_config_dbg_show) (struct pinctrl_dev *pctldev,
58 				     struct seq_file *s,
59 				     unsigned offset);
60 	void (*pin_config_group_dbg_show) (struct pinctrl_dev *pctldev,
61 					   struct seq_file *s,
62 					   unsigned selector);
63 	void (*pin_config_config_dbg_show) (struct pinctrl_dev *pctldev,
64 					    struct seq_file *s,
65 					    unsigned long config);
66 };
67 
68 #endif
69 
70 #endif /* __LINUX_PINCTRL_PINCONF_H */
71