Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 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 | |
Stephen Warren | 57b676f | 2012-03-02 13:05:44 -0700 | [diff] [blame] | 12 | #include <linux/mutex.h> |
| 13 | #include <linux/radix-tree.h> |
Linus Walleij | ae6b4d8 | 2011-10-19 18:14:33 +0200 | [diff] [blame] | 14 | #include <linux/pinctrl/pinconf.h> |
Linus Walleij | 872acc3 | 2012-03-06 13:52:22 +0100 | [diff] [blame] | 15 | #include <linux/pinctrl/machine.h> |
Linus Walleij | ae6b4d8 | 2011-10-19 18:14:33 +0200 | [diff] [blame] | 16 | |
| 17 | struct pinctrl_gpio_range; |
| 18 | |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 19 | /** |
| 20 | * struct pinctrl_dev - pin control class device |
| 21 | * @node: node to include this pin controller in the global pin controller list |
| 22 | * @desc: the pin controller descriptor supplied when initializing this pin |
| 23 | * controller |
| 24 | * @pin_desc_tree: each pin descriptor for this pin controller is stored in |
| 25 | * this radix tree |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 26 | * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller, |
| 27 | * ranges are added to this list at runtime |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 28 | * @dev: the device entry for this pin controller |
| 29 | * @owner: module providing the pin controller, used for refcounting |
| 30 | * @driver_data: driver data for drivers registering to the pin controller |
| 31 | * subsystem |
Stephen Warren | 46919ae | 2012-03-01 18:48:32 -0700 | [diff] [blame] | 32 | * @p: result of pinctrl_get() for this device |
Linus Walleij | befe5bd | 2012-02-09 19:47:48 +0100 | [diff] [blame] | 33 | * @device_root: debugfs root for this device |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 34 | */ |
| 35 | struct pinctrl_dev { |
| 36 | struct list_head node; |
| 37 | struct pinctrl_desc *desc; |
| 38 | struct radix_tree_root pin_desc_tree; |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 39 | struct list_head gpio_ranges; |
Stephen Warren | 51cd24e | 2011-12-09 16:59:05 -0700 | [diff] [blame] | 40 | struct device *dev; |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 41 | struct module *owner; |
| 42 | void *driver_data; |
Stephen Warren | 46919ae | 2012-03-01 18:48:32 -0700 | [diff] [blame] | 43 | struct pinctrl *p; |
Tony Lindgren | 0215716 | 2012-01-20 08:17:22 -0800 | [diff] [blame] | 44 | #ifdef CONFIG_DEBUG_FS |
| 45 | struct dentry *device_root; |
| 46 | #endif |
Linus Walleij | befe5bd | 2012-02-09 19:47:48 +0100 | [diff] [blame] | 47 | }; |
| 48 | |
| 49 | /** |
| 50 | * struct pinctrl - per-device pin control state holder |
| 51 | * @node: global list node |
| 52 | * @dev: the device using this pin control handle |
Stephen Warren | 6e5e959 | 2012-03-02 13:05:47 -0700 | [diff] [blame] | 53 | * @states: a list of states for this device |
| 54 | * @state: the current state |
Stephen Warren | 57291ce | 2012-03-23 10:29:46 -0600 | [diff] [blame] | 55 | * @dt_maps: the mapping table chunks dynamically parsed from device tree for |
| 56 | * this device, if any |
Linus Walleij | befe5bd | 2012-02-09 19:47:48 +0100 | [diff] [blame] | 57 | */ |
| 58 | struct pinctrl { |
| 59 | struct list_head node; |
| 60 | struct device *dev; |
Stephen Warren | 6e5e959 | 2012-03-02 13:05:47 -0700 | [diff] [blame] | 61 | struct list_head states; |
| 62 | struct pinctrl_state *state; |
Stephen Warren | 57291ce | 2012-03-23 10:29:46 -0600 | [diff] [blame] | 63 | struct list_head dt_maps; |
Stephen Warren | 6e5e959 | 2012-03-02 13:05:47 -0700 | [diff] [blame] | 64 | }; |
| 65 | |
| 66 | /** |
| 67 | * struct pinctrl_state - a pinctrl state for a device |
| 68 | * @node: list not for struct pinctrl's @states field |
| 69 | * @name: the name of this state |
| 70 | * @settings: a list of settings for this state |
| 71 | */ |
| 72 | struct pinctrl_state { |
| 73 | struct list_head node; |
| 74 | const char *name; |
Stephen Warren | 7ecdb16 | 2012-03-02 13:05:45 -0700 | [diff] [blame] | 75 | struct list_head settings; |
| 76 | }; |
| 77 | |
| 78 | /** |
Stephen Warren | 1e2082b | 2012-03-02 13:05:48 -0700 | [diff] [blame] | 79 | * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP |
| 80 | * @group: the group selector to program |
| 81 | * @func: the function selector to program |
| 82 | */ |
| 83 | struct pinctrl_setting_mux { |
| 84 | unsigned group; |
| 85 | unsigned func; |
| 86 | }; |
| 87 | |
| 88 | /** |
| 89 | * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_* |
| 90 | * @group_or_pin: the group selector or pin ID to program |
| 91 | * @configs: a pointer to an array of config parameters/values to program into |
| 92 | * hardware. Each individual pin controller defines the format and meaning |
| 93 | * of config parameters. |
| 94 | * @num_configs: the number of entries in array @configs |
| 95 | */ |
| 96 | struct pinctrl_setting_configs { |
| 97 | unsigned group_or_pin; |
| 98 | unsigned long *configs; |
| 99 | unsigned num_configs; |
| 100 | }; |
| 101 | |
| 102 | /** |
Linus Walleij | 872acc3 | 2012-03-06 13:52:22 +0100 | [diff] [blame] | 103 | * struct pinctrl_setting - an individual mux or config setting |
Stephen Warren | 6e5e959 | 2012-03-02 13:05:47 -0700 | [diff] [blame] | 104 | * @node: list node for struct pinctrl_settings's @settings field |
Stephen Warren | 1e2082b | 2012-03-02 13:05:48 -0700 | [diff] [blame] | 105 | * @type: the type of setting |
Stephen Warren | 57291ce | 2012-03-23 10:29:46 -0600 | [diff] [blame] | 106 | * @pctldev: pin control device handling to be programmed. Not used for |
| 107 | * PIN_MAP_TYPE_DUMMY_STATE. |
Linus Walleij | 1a78958 | 2012-10-17 20:51:54 +0200 | [diff] [blame] | 108 | * @dev_name: the name of the device using this state |
Stephen Warren | 1e2082b | 2012-03-02 13:05:48 -0700 | [diff] [blame] | 109 | * @data: Data specific to the setting type |
Stephen Warren | 7ecdb16 | 2012-03-02 13:05:45 -0700 | [diff] [blame] | 110 | */ |
| 111 | struct pinctrl_setting { |
| 112 | struct list_head node; |
Stephen Warren | 1e2082b | 2012-03-02 13:05:48 -0700 | [diff] [blame] | 113 | enum pinctrl_map_type type; |
Linus Walleij | befe5bd | 2012-02-09 19:47:48 +0100 | [diff] [blame] | 114 | struct pinctrl_dev *pctldev; |
Linus Walleij | 1a78958 | 2012-10-17 20:51:54 +0200 | [diff] [blame] | 115 | const char *dev_name; |
Stephen Warren | 1e2082b | 2012-03-02 13:05:48 -0700 | [diff] [blame] | 116 | union { |
| 117 | struct pinctrl_setting_mux mux; |
| 118 | struct pinctrl_setting_configs configs; |
| 119 | } data; |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 120 | }; |
| 121 | |
| 122 | /** |
| 123 | * struct pin_desc - pin descriptor for each physical pin in the arch |
| 124 | * @pctldev: corresponding pin control device |
| 125 | * @name: a name for the pin, e.g. the name of the pin/pad/finger on a |
| 126 | * datasheet or such |
Linus Walleij | ca53c5f | 2011-12-14 20:33:37 +0100 | [diff] [blame] | 127 | * @dynamic_name: if the name of this pin was dynamically allocated |
Stephen Warren | 652162d | 2012-03-05 17:22:15 -0700 | [diff] [blame] | 128 | * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL. |
Stephen Warren | 0e3db173 | 2012-03-02 13:05:46 -0700 | [diff] [blame] | 129 | * If non-zero, this pin is claimed by @owner. This field is an integer |
| 130 | * rather than a boolean, since pinctrl_get() might process multiple |
| 131 | * mapping table entries that refer to, and hence claim, the same group |
| 132 | * or pin, and each of these will increment the @usecount. |
Stephen Warren | 652162d | 2012-03-05 17:22:15 -0700 | [diff] [blame] | 133 | * @mux_owner: The name of device that called pinctrl_get(). |
Stephen Warren | ba110d9 | 2012-03-02 13:05:49 -0700 | [diff] [blame] | 134 | * @mux_setting: The most recent selected mux setting for this pin, if any. |
Stephen Warren | 652162d | 2012-03-05 17:22:15 -0700 | [diff] [blame] | 135 | * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is |
| 136 | * the name of the GPIO that "owns" this pin. |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 137 | */ |
| 138 | struct pin_desc { |
| 139 | struct pinctrl_dev *pctldev; |
Stephen Warren | 9af1e44 | 2011-10-19 16:19:27 -0600 | [diff] [blame] | 140 | const char *name; |
Linus Walleij | ca53c5f | 2011-12-14 20:33:37 +0100 | [diff] [blame] | 141 | bool dynamic_name; |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 142 | /* These fields only added when supporting pinmux drivers */ |
| 143 | #ifdef CONFIG_PINMUX |
Stephen Warren | 652162d | 2012-03-05 17:22:15 -0700 | [diff] [blame] | 144 | unsigned mux_usecount; |
| 145 | const char *mux_owner; |
Stephen Warren | ba110d9 | 2012-03-02 13:05:49 -0700 | [diff] [blame] | 146 | const struct pinctrl_setting_mux *mux_setting; |
Stephen Warren | 652162d | 2012-03-05 17:22:15 -0700 | [diff] [blame] | 147 | const char *gpio_owner; |
Linus Walleij | 2744e8a | 2011-05-02 20:50:54 +0200 | [diff] [blame] | 148 | #endif |
| 149 | }; |
| 150 | |
Linus Walleij | 9dfac4f | 2012-02-01 18:02:47 +0100 | [diff] [blame] | 151 | struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name); |
Linus Walleij | ae6b4d8 | 2011-10-19 18:14:33 +0200 | [diff] [blame] | 152 | int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name); |
Dong Aisheng | dcb5dbc | 2012-04-17 15:00:46 +0800 | [diff] [blame] | 153 | const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin); |
Linus Walleij | 7afde8b | 2011-10-19 17:07:16 +0200 | [diff] [blame] | 154 | int pinctrl_get_group_selector(struct pinctrl_dev *pctldev, |
| 155 | const char *pin_group); |
Stephen Warren | 2304b47 | 2012-02-22 14:26:01 -0700 | [diff] [blame] | 156 | |
| 157 | static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev, |
| 158 | unsigned int pin) |
| 159 | { |
| 160 | return radix_tree_lookup(&pctldev->pin_desc_tree, pin); |
| 161 | } |
Stephen Warren | 57b676f | 2012-03-02 13:05:44 -0700 | [diff] [blame] | 162 | |
Stephen Warren | 57291ce | 2012-03-23 10:29:46 -0600 | [diff] [blame] | 163 | int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps, |
| 164 | bool dup, bool locked); |
| 165 | void pinctrl_unregister_map(struct pinctrl_map const *map); |
| 166 | |
Stephen Warren | 57b676f | 2012-03-02 13:05:44 -0700 | [diff] [blame] | 167 | extern struct mutex pinctrl_mutex; |
Stephen Warren | 57291ce | 2012-03-23 10:29:46 -0600 | [diff] [blame] | 168 | extern struct list_head pinctrldev_list; |