core.h revision ae6b4d8588f4fc95520b0e62c4b1f474c82191a9 
1/*
2 * Core private header for the pin control subsystem
3 *
4 * Copyright (C) 2011 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
6 *
7 * Author: Linus Walleij <linus.walleij@linaro.org>
8 *
9 * License terms: GNU General Public License (GPL) version 2
10 */
11
12#include <linux/pinctrl/pinconf.h>
13
14struct pinctrl_gpio_range;
15
16/**
17 * struct pinctrl_dev - pin control class device
18 * @node: node to include this pin controller in the global pin controller list
19 * @desc: the pin controller descriptor supplied when initializing this pin
20 *	controller
21 * @pin_desc_tree: each pin descriptor for this pin controller is stored in
22 *	this radix tree
23 * @pin_desc_tree_lock: lock for the descriptor tree
24 * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
25 *	ranges are added to this list at runtime
26 * @gpio_ranges_lock: lock for the GPIO ranges list
27 * @dev: the device entry for this pin controller
28 * @owner: module providing the pin controller, used for refcounting
29 * @driver_data: driver data for drivers registering to the pin controller
30 *	subsystem
31 * @pinmux_hogs_lock: lock for the pinmux hog list
32 * @pinmux_hogs: list of pinmux maps hogged by this device
33 */
34struct pinctrl_dev {
35	struct list_head node;
36	struct pinctrl_desc *desc;
37	struct radix_tree_root pin_desc_tree;
38	spinlock_t pin_desc_tree_lock;
39	struct list_head gpio_ranges;
40	struct mutex gpio_ranges_lock;
41	struct device dev;
42	struct module *owner;
43	void *driver_data;
44#ifdef CONFIG_PINMUX
45	struct mutex pinmux_hogs_lock;
46	struct list_head pinmux_hogs;
47#endif
48};
49
50/**
51 * struct pin_desc - pin descriptor for each physical pin in the arch
52 * @pctldev: corresponding pin control device
53 * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
54 *	datasheet or such
55 * @lock: a lock to protect the descriptor structure
56 * @mux_requested: whether the pin is already requested by pinmux or not
57 * @mux_function: a named muxing function for the pin that will be passed to
58 *	subdrivers and shown in debugfs etc
59 */
60struct pin_desc {
61	struct pinctrl_dev *pctldev;
62	const char *name;
63	spinlock_t lock;
64	/* These fields only added when supporting pinmux drivers */
65#ifdef CONFIG_PINMUX
66	const char *mux_function;
67#endif
68};
69
70struct pinctrl_dev *get_pinctrl_dev_from_dev(struct device *dev,
71					     const char *dev_name);
72struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev, unsigned int pin);
73int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
74int pinctrl_get_device_gpio_range(unsigned gpio,
75				  struct pinctrl_dev **outdev,
76				  struct pinctrl_gpio_range **outrange);
77int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
78			       const char *pin_group);
79