pinctrl: add kerneldoc for pinctrl_ops device tree functions
Stephen Warren [Thu, 26 Apr 2012 16:18:52 +0000 (10:18 -0600)]
Signed-off-by: Stephen Warren <swarren@nvidia.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
(cherry picked from commit 02ae6da28fb7aa31d8bf1972c99e83c58b684198)

Change-Id: Ifffcfb9dfc89c123f6c9c83b1e2f48ffa3f7f85a
Signed-off-by: Pritesh Raithatha <praithatha@nvidia.com>

include/linux/pinctrl/pinctrl.h

index c22d040..3b894a6 100644 (file)
@@ -72,6 +72,15 @@ struct pinctrl_gpio_range {
  *     group selector @pins, and the size of the array in @num_pins
  * @pin_dbg_show: optional debugfs display hook that will provide per-device
  *     info for a certain pin in debugfs
+ * @dt_node_to_map: parse a device tree "pin configuration node", and create
+ *     mapping table entries for it. These are returned through the @map and
+ *     @num_maps output parameters. This function is optional, and may be
+ *     omitted for pinctrl drivers that do not support device tree.
+ * @dt_free_map: free mapping table entries created via @dt_node_to_map. The
+ *     top-level @map pointer must be freed, along with any dynamically
+ *     allocated members of the mapping table entries themselves. This
+ *     function is optional, and may be omitted for pinctrl drivers that do
+ *     not support device tree.
  */
 struct pinctrl_ops {
        int (*get_groups_count) (struct pinctrl_dev *pctldev);