Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * Interface 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_PINCTRL_H
13#define __LINUX_PINCTRL_PINCTRL_H
14
15#ifdef CONFIG_PINCTRL
16
17#include <linux/radix-tree.h>
18#include <linux/list.h>
19#include <linux/seq_file.h>
20#include <linux/pinctrl/pinctrl-state.h>
21
22struct device;
23struct pinctrl_dev;
24struct pinctrl_map;
25struct pinmux_ops;
26struct pinconf_ops;
27struct gpio_chip;
28struct device_node;
29
30/**
31 * struct pinctrl_pin_desc - boards/machines provide information on their
32 * pins, pads or other muxable units in this struct
33 * @number: unique pin number from the global pin number space
34 * @name: a name for this pin
35 */
36struct pinctrl_pin_desc {
37 unsigned number;
38 const char *name;
39};
40
41/* Convenience macro to define a single named or anonymous pin descriptor */
42#define PINCTRL_PIN(a, b) { .number = a, .name = b }
43#define PINCTRL_PIN_ANON(a) { .number = a }
44
45/**
46 * struct pinctrl_gpio_range - each pin controller can provide subranges of
47 * the GPIO number space to be handled by the controller
48 * @node: list node for internal use
49 * @name: a name for the chip in this range
50 * @id: an ID number for the chip in this range
51 * @base: base offset of the GPIO range
52 * @pin_base: base pin number of the GPIO range
53 * @npins: number of pins in the GPIO range, including the base number
54 * @gc: an optional pointer to a gpio_chip
55 */
56struct pinctrl_gpio_range {
57 struct list_head node;
58 const char *name;
59 unsigned int id;
60 unsigned int base;
61 unsigned int pin_base;
62 unsigned int npins;
63 struct gpio_chip *gc;
64};
65
66/**
67 * struct pinctrl_ops - global pin control operations, to be implemented by
68 * pin controller drivers.
69 * @get_groups_count: Returns the count of total number of groups registered.
70 * @get_group_name: return the group name of the pin group
71 * @get_group_pins: return an array of pins corresponding to a certain
72 * group selector @pins, and the size of the array in @num_pins
73 * @pin_dbg_show: optional debugfs display hook that will provide per-device
74 * info for a certain pin in debugfs
75 * @dt_node_to_map: parse a device tree "pin configuration node", and create
76 * mapping table entries for it. These are returned through the @map and
77 * @num_maps output parameters. This function is optional, and may be
78 * omitted for pinctrl drivers that do not support device tree.
79 * @dt_free_map: free mapping table entries created via @dt_node_to_map. The
80 * top-level @map pointer must be freed, along with any dynamically
81 * allocated members of the mapping table entries themselves. This
82 * function is optional, and may be omitted for pinctrl drivers that do
83 * not support device tree.
84 */
85struct pinctrl_ops {
86 int (*get_groups_count) (struct pinctrl_dev *pctldev);
87 const char *(*get_group_name) (struct pinctrl_dev *pctldev,
88 unsigned selector);
89 int (*get_group_pins) (struct pinctrl_dev *pctldev,
90 unsigned selector,
91 const unsigned **pins,
92 unsigned *num_pins);
93 void (*pin_dbg_show) (struct pinctrl_dev *pctldev, struct seq_file *s,
94 unsigned offset);
95 int (*dt_node_to_map) (struct pinctrl_dev *pctldev,
96 struct device_node *np_config,
97 struct pinctrl_map **map, unsigned *num_maps);
98 void (*dt_free_map) (struct pinctrl_dev *pctldev,
99 struct pinctrl_map *map, unsigned num_maps);
100};
101
102/**
103 * struct pinctrl_desc - pin controller descriptor, register this to pin
104 * control subsystem
105 * @name: name for the pin controller
106 * @pins: an array of pin descriptors describing all the pins handled by
107 * this pin controller
108 * @npins: number of descriptors in the array, usually just ARRAY_SIZE()
109 * of the pins field above
110 * @pctlops: pin control operation vtable, to support global concepts like
111 * grouping of pins, this is optional.
112 * @pmxops: pinmux operations vtable, if you support pinmuxing in your driver
113 * @confops: pin config operations vtable, if you support pin configuration in
114 * your driver
115 * @owner: module providing the pin controller, used for refcounting
116 */
117struct pinctrl_desc {
118 const char *name;
119 struct pinctrl_pin_desc const *pins;
120 unsigned int npins;
121 struct pinctrl_ops *pctlops;
122 struct pinmux_ops *pmxops;
123 struct pinconf_ops *confops;
124 struct module *owner;
125};
126
127/* External interface to pin controller */
128extern struct pinctrl_dev *pinctrl_register(struct pinctrl_desc *pctldesc,
129 struct device *dev, void *driver_data);
130extern void pinctrl_unregister(struct pinctrl_dev *pctldev);
131extern bool pin_is_valid(struct pinctrl_dev *pctldev, int pin);
132extern void pinctrl_add_gpio_range(struct pinctrl_dev *pctldev,
133 struct pinctrl_gpio_range *range);
134extern void pinctrl_add_gpio_ranges(struct pinctrl_dev *pctldev,
135 struct pinctrl_gpio_range *ranges,
136 unsigned nranges);
137extern void pinctrl_remove_gpio_range(struct pinctrl_dev *pctldev,
138 struct pinctrl_gpio_range *range);
139
140extern struct pinctrl_dev *pinctrl_find_and_add_gpio_range(const char *devname,
141 struct pinctrl_gpio_range *range);
142extern struct pinctrl_gpio_range *
143pinctrl_find_gpio_range_from_pin(struct pinctrl_dev *pctldev,
144 unsigned int pin);
145
146#ifdef CONFIG_OF
147extern struct pinctrl_dev *of_pinctrl_get(struct device_node *np);
148#else
149static inline
150struct pinctrl_dev *of_pinctrl_get(struct device_node *np)
151{
152 return NULL;
153}
154#endif /* CONFIG_OF */
155
156extern const char *pinctrl_dev_get_name(struct pinctrl_dev *pctldev);
157extern const char *pinctrl_dev_get_devname(struct pinctrl_dev *pctldev);
158extern void *pinctrl_dev_get_drvdata(struct pinctrl_dev *pctldev);
159#else
160
161struct pinctrl_dev;
162
163/* Sufficiently stupid default functions when pinctrl is not in use */
164static inline bool pin_is_valid(struct pinctrl_dev *pctldev, int pin)
165{
166 return pin >= 0;
167}
168
169#endif /* !CONFIG_PINCTRL */
170
171#endif /* __LINUX_PINCTRL_PINCTRL_H */