pinmux.h

  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 * Internal interface between the core pin control system and the
  4 * pinmux portions
  5 *
  6 * Copyright (C) 2011 ST-Ericsson SA
  7 * Written on behalf of Linaro for ST-Ericsson
  8 * Based on bits of regulator core, gpio core and clk core
  9 *
 10 * Author: Linus Walleij <linus.walleij@linaro.org>
 11 */
 12
 13#include <linux/types.h>
 14
 15struct dentry;
 16struct seq_file;
 17
 18struct pinctrl_dev;
 19struct pinctrl_gpio_range;
 20struct pinctrl_map;
 21struct pinctrl_setting;
 22
 23#ifdef CONFIG_PINMUX
 24
 25int pinmux_check_ops(struct pinctrl_dev *pctldev);
 26
 27int pinmux_validate_map(const struct pinctrl_map *map, int i);
 28
 29bool pinmux_can_be_used_for_gpio(struct pinctrl_dev *pctldev, unsigned int pin);
 30
 31int pinmux_request_gpio(struct pinctrl_dev *pctldev,
 32			struct pinctrl_gpio_range *range,
 33			unsigned int pin, unsigned int gpio);
 34void pinmux_free_gpio(struct pinctrl_dev *pctldev, unsigned int pin,
 35		      struct pinctrl_gpio_range *range);
 36int pinmux_gpio_direction(struct pinctrl_dev *pctldev,
 37			  struct pinctrl_gpio_range *range,
 38			  unsigned int pin, bool input);
 39
 40int pinmux_map_to_setting(const struct pinctrl_map *map,
 41			  struct pinctrl_setting *setting);
 42void pinmux_free_setting(const struct pinctrl_setting *setting);
 43int pinmux_enable_setting(const struct pinctrl_setting *setting);
 44void pinmux_disable_setting(const struct pinctrl_setting *setting);
 45
 46#else
 47
 48static inline int pinmux_check_ops(struct pinctrl_dev *pctldev)
 49{
 50	return 0;
 51}
 52
 53static inline int pinmux_validate_map(const struct pinctrl_map *map, int i)
 54{
 55	return 0;
 56}
 57
 58static inline bool pinmux_can_be_used_for_gpio(struct pinctrl_dev *pctldev,
 59					       unsigned int pin)
 60{
 61	return true;
 62}
 63
 64static inline int pinmux_request_gpio(struct pinctrl_dev *pctldev,
 65			struct pinctrl_gpio_range *range,
 66			unsigned int pin, unsigned int gpio)
 67{
 68	return 0;
 69}
 70
 71static inline void pinmux_free_gpio(struct pinctrl_dev *pctldev,
 72				    unsigned int pin,
 73				    struct pinctrl_gpio_range *range)
 74{
 75}
 76
 77static inline int pinmux_gpio_direction(struct pinctrl_dev *pctldev,
 78					struct pinctrl_gpio_range *range,
 79					unsigned int pin, bool input)
 80{
 81	return 0;
 82}
 83
 84static inline int pinmux_map_to_setting(const struct pinctrl_map *map,
 85			  struct pinctrl_setting *setting)
 86{
 87	return 0;
 88}
 89
 90static inline void pinmux_free_setting(const struct pinctrl_setting *setting)
 91{
 92}
 93
 94static inline int pinmux_enable_setting(const struct pinctrl_setting *setting)
 95{
 96	return 0;
 97}
 98
 99static inline void pinmux_disable_setting(const struct pinctrl_setting *setting)
100{
101}
102
103#endif
104
105#if defined(CONFIG_PINMUX) && defined(CONFIG_DEBUG_FS)
106
107void pinmux_show_map(struct seq_file *s, const struct pinctrl_map *map);
108void pinmux_show_setting(struct seq_file *s,
109			 const struct pinctrl_setting *setting);
110void pinmux_init_device_debugfs(struct dentry *devroot,
111				struct pinctrl_dev *pctldev);
112
113#else
114
115static inline void pinmux_show_map(struct seq_file *s,
116				   const struct pinctrl_map *map)
117{
118}
119
120static inline void pinmux_show_setting(struct seq_file *s,
121				       const struct pinctrl_setting *setting)
122{
123}
124
125static inline void pinmux_init_device_debugfs(struct dentry *devroot,
126					      struct pinctrl_dev *pctldev)
127{
128}
129
130#endif
131
132#ifdef CONFIG_GENERIC_PINMUX_FUNCTIONS
133
134/**
135 * struct function_desc - generic function descriptor
136 * @func: generic data of the pin function (name and groups of pins)
137 * @data: pin controller driver specific data
138 */
139struct function_desc {
140	const struct pinfunction *func;
141	void *data;
142};
143
144int pinmux_generic_get_function_count(struct pinctrl_dev *pctldev);
145
146const char *
147pinmux_generic_get_function_name(struct pinctrl_dev *pctldev,
148				 unsigned int selector);
149
150int pinmux_generic_get_function_groups(struct pinctrl_dev *pctldev,
151				       unsigned int selector,
152				       const char * const **groups,
153				       unsigned int * const ngroups);
154
155const struct function_desc *
156pinmux_generic_get_function(struct pinctrl_dev *pctldev, unsigned int selector);
157
158int pinmux_generic_add_function(struct pinctrl_dev *pctldev,
159				const char *name,
160				const char * const *groups,
161				unsigned int const ngroups,
162				void *data);
163
164int pinmux_generic_add_pinfunction(struct pinctrl_dev *pctldev,
165				   const struct pinfunction *func, void *data);
166
167int pinmux_generic_remove_function(struct pinctrl_dev *pctldev,
168				   unsigned int selector);
169
170void pinmux_generic_free_functions(struct pinctrl_dev *pctldev);
171
172bool pinmux_generic_function_is_gpio(struct pinctrl_dev *pctldev,
173				     unsigned int selector);
174
175#else
176
177static inline void pinmux_generic_free_functions(struct pinctrl_dev *pctldev)
178{
179}
180
181#endif /* CONFIG_GENERIC_PINMUX_FUNCTIONS */