[PATCH 1/2] pinctrl: remove enable/disable callbacks from documentation

[PATCH 1/2] pinctrl: remove enable/disable callbacks from documentation

[Baruch Siach]

Commit 03e9f0cac5d (pinctrl: clean up after enable refactoring) updated the
documentation to remove mention of disable(), and rename enable() to set_mux().
One in-text mention was forgotten. Fix this.

Fixes: 03e9f0cac5d ('pinctrl: clean up after enable refactoring')
Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 Documentation/pinctrl.txt | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Documentation/pinctrl.txt b/Documentation/pinctrl.txt
index b8f2147b96dd..91ea46b89d83 100644
--- a/Documentation/pinctrl.txt
+++ b/Documentation/pinctrl.txt
@@ -570,9 +570,8 @@ is possible to perform the requested mux setting, poke the hardware so that
 this happens.
 
 Pinmux drivers are required to supply a few callback functions, some are
-optional. Usually the enable() and disable() functions are implemented,
-writing values into some certain registers to activate a certain mux setting
-for a certain pin.
+optional. Usually the set_mux() function is implemented, writing values into
+some certain registers to activate a certain mux setting for a certain pin.
 
 A simple driver for the above example will work by setting bits 0, 1, 2, 3 or 4
 into some register named MUX to select a certain function with a certain
-- 
2.1.4

[PATCH 2/2] pinctrl: remove doc mention of the enable/disable API

[Baruch Siach]

This API has changed in commit 6e5e959dde0 (pinctrl: API changes to support
multiple states per device).

Fixes: 6e5e959dde0 ('pinctrl: API changes to support multiple states per device')
Cc: Stephen Warren <swarren@nvidia.com>
Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 Documentation/pinctrl.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/pinctrl.txt b/Documentation/pinctrl.txt
index 91ea46b89d83..2db41b41225e 100644
--- a/Documentation/pinctrl.txt
+++ b/Documentation/pinctrl.txt
@@ -1265,7 +1265,7 @@ The semantics of the pinctrl APIs are:
 
 Usually the pin control core handled the get/put pair and call out to the
 device drivers bookkeeping operations, like checking available functions and
-the associated pins, whereas the enable/disable pass on to the pin controller
+the associated pins, whereas select_state pass on to the pin controller
 driver which takes care of activating and/or deactivating the mux setting by
 quickly poking some registers.
 
@@ -1362,8 +1362,9 @@ function, but with different named in the mapping as described under
 "Advanced mapping" above. So that for an SPI device, we have two states named
 "pos-A" and "pos-B".
 
-This snippet first muxes the function in the pins defined by group A, enables
-it, disables and releases it, and muxes it in on the pins defined by group B:
+This snippet first initializes a state object for both groups (in foo_probe()),
+then muxes the function in the pins defined by group A, and finally muxes it in
+on the pins defined by group B:
 
 #include <linux/pinctrl/consumer.h>
 
-- 
2.1.4

Re: [PATCH 1/2] pinctrl: remove enable/disable callbacks from documentation

[Linus Walleij]

On Sun, Mar 8, 2015 at 9:51 AM, Baruch Siach <baruch@tkos.co.il> wrote:

> Commit 03e9f0cac5d (pinctrl: clean up after enable refactoring) updated the
> documentation to remove mention of disable(), and rename enable() to set_mux().
> One in-text mention was forgotten. Fix this.
>
> Fixes: 03e9f0cac5d ('pinctrl: clean up after enable refactoring')
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

Patch applied.

Yours,
Linus Walleij

Re: [PATCH 2/2] pinctrl: remove doc mention of the enable/disable API

[Linus Walleij]

On Sun, Mar 8, 2015 at 9:51 AM, Baruch Siach <baruch@tkos.co.il> wrote:

> This API has changed in commit 6e5e959dde0 (pinctrl: API changes to support
> multiple states per device).
>
> Fixes: 6e5e959dde0 ('pinctrl: API changes to support multiple states per device')
> Cc: Stephen Warren <swarren@nvidia.com>
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

Patch applied.

Yours,
Linus Walleij