diff mbox

pinctrl: documentation update

Message ID 1320913807-19928-1-git-send-email-linus.walleij@stericsson.com
State Accepted
Commit 336cdba09a5df706402628fb20b7660d186aff6c
Headers show

Commit Message

Linus Walleij Nov. 10, 2011, 8:30 a.m. UTC 
From: Linus Walleij <linus.walleij@linaro.org>

Update the docs removing an obsolete __refdata tag and document
the mysterious return value of pin_free().

Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 Documentation/pinctrl.txt |    2 +-
 drivers/pinctrl/pinmux.c  |    4 ++++
 2 files changed, 5 insertions(+), 1 deletions(-)
diff mbox

Patch

diff --git a/Documentation/pinctrl.txt b/Documentation/pinctrl.txt
index 328adb7..a05e23b 100644
--- a/Documentation/pinctrl.txt
+++ b/Documentation/pinctrl.txt
@@ -59,7 +59,7 @@  this in our driver:
 
 #include <linux/pinctrl/pinctrl.h>
 
-const struct pinctrl_pin_desc __refdata foo_pins[] = {
+const struct pinctrl_pin_desc foo_pins[] = {
       PINCTRL_PIN(0, "A1"),
       PINCTRL_PIN(1, "A2"),
       PINCTRL_PIN(2, "A3"),
diff --git a/drivers/pinctrl/pinmux.c b/drivers/pinctrl/pinmux.c
index 06bee1b..6738162 100644
--- a/drivers/pinctrl/pinmux.c
+++ b/drivers/pinctrl/pinmux.c
@@ -178,6 +178,10 @@  out:
  * @pin: the pin to free
  * @gpio_range: the range matching the GPIO pin if this is a request for a
  *	single GPIO pin
+ *
+ * This function returns a pointer to the function name in use. This is used
+ * for callers that dynamically allocate a function name so it can be free:ed
+ * once the pin is free. This is done for GPIO request functions.
  */
 static const char *pin_free(struct pinctrl_dev *pctldev, int pin,
 			    struct pinctrl_gpio_range *gpio_range)