drivers/pinctrl/core.h

   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/mutex.h>
  13 #include <linux/radix-tree.h>
  14 #include <linux/pinctrl/pinconf.h>
  15
  16 struct pinctrl_gpio_range;
  17
  18 /**
  19  * struct pinctrl_dev - pin control class device
  20  * @node: node to include this pin controller in the global pin controller list
  21  * @desc: the pin controller descriptor supplied when initializing this pin
  22  *      controller
  23  * @pin_desc_tree: each pin descriptor for this pin controller is stored in
  24  *      this radix tree
  25  * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
  26  *      ranges are added to this list at runtime
  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  * @p: result of pinctrl_get() for this device
  32  * @device_root: debugfs root for this device
  33  */
  34 struct pinctrl_dev {
  35         struct list_head node;
  36         struct pinctrl_desc *desc;
  37         struct radix_tree_root pin_desc_tree;
  38         struct list_head gpio_ranges;
  39         struct device *dev;
  40         struct module *owner;
  41         void *driver_data;
  42         struct pinctrl *p;
  43 #ifdef CONFIG_DEBUG_FS
  44         struct dentry *device_root;
  45 #endif
  46 };
  47
  48 /**
  49  * struct pinctrl - per-device pin control state holder
  50  * @node: global list node
  51  * @dev: the device using this pin control handle
  52  * @states: a list of states for this device
  53  * @state: the current state
  54  */
  55 struct pinctrl {
  56         struct list_head node;
  57         struct device *dev;
  58         struct list_head states;
  59         struct pinctrl_state *state;
  60 };
  61
  62 /**
  63  * struct pinctrl_state - a pinctrl state for a device
  64  * @node: list not for struct pinctrl's @states field
  65  * @name: the name of this state
  66  * @settings: a list of settings for this state
  67  */
  68 struct pinctrl_state {
  69         struct list_head node;
  70         const char *name;
  71         struct list_head settings;
  72 };
  73
  74 /**
  75  * struct pinctrl_setting - an individual mux setting
  76  * @node: list node for struct pinctrl_settings's @settings field
  77  * @pctldev: pin control device handling to be programmed
  78  * @group_selector: the group selector to program
  79  * @func_selector: the function selector to program
  80  */
  81 struct pinctrl_setting {
  82         struct list_head node;
  83         struct pinctrl_dev *pctldev;
  84         unsigned group_selector;
  85         unsigned func_selector;
  86 };
  87
  88 /**
  89  * struct pin_desc - pin descriptor for each physical pin in the arch
  90  * @pctldev: corresponding pin control device
  91  * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
  92  *      datasheet or such
  93  * @dynamic_name: if the name of this pin was dynamically allocated
  94  * @usecount: If zero, the pin is not claimed, and @owner should be NULL.
  95  *      If non-zero, this pin is claimed by @owner. This field is an integer
  96  *      rather than a boolean, since pinctrl_get() might process multiple
  97  *      mapping table entries that refer to, and hence claim, the same group
  98  *      or pin, and each of these will increment the @usecount.
  99  * @owner: The name of the entity owning the pin. Typically, this is the name
 100  *      of the device that called pinctrl_get(). Alternatively, it may be the
 101  *      name of the GPIO passed to pinctrl_request_gpio().
 102  */
 103 struct pin_desc {
 104         struct pinctrl_dev *pctldev;
 105         const char *name;
 106         bool dynamic_name;
 107         /* These fields only added when supporting pinmux drivers */
 108 #ifdef CONFIG_PINMUX
 109         unsigned usecount;
 110         const char *owner;
 111 #endif
 112 };
 113
 114 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
 115 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
 116 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
 117                                const char *pin_group);
 118
 119 static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
 120                                             unsigned int pin)
 121 {
 122         return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
 123 }
 124
 125 extern struct mutex pinctrl_mutex;