Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1e90e9e authored by Viresh Kumar's avatar Viresh Kumar Committed by Linus Walleij
Browse files

pinctrl: replace list_*() with get_*_count() 



Most of the SoC drivers implement list_groups() and list_functions()
routines for pinctrl and pinmux. These routines continue returning
zero until the selector argument is greater than total count of
available groups or functions.

This patch replaces these list_*() routines with get_*_count()
routines, which returns the number of available selection for SoC
driver. pinctrl layer will use this value to check the range it can
choose.

This patch fixes all user drivers for this change. There are other
routines in user drivers, which have checks to check validity of
selector passed to them. It is also no more required and hence
removed.

Documentation updated as well.

Acked-by: default avatarStephen Warren <swarren@wwwdotorg.org>
Signed-off-by: default avatarViresh Kumar <viresh.kumar@st.com>
[Folded in fix and fixed a minor merge artifact manually]
Signed-off-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent 122dbe7e

Documentation/pinctrl.txt

+15 −22
Original line number Diff line number Diff line
@@ -152,11 +152,9 @@ static const struct foo_group foo_groups[] = { 
};





static int foo_list_groups(struct pinctrl_dev *pctldev, unsigned selector)

static int foo_get_groups_count(struct pinctrl_dev *pctldev)

{

	if (selector >= ARRAY_SIZE(foo_groups))

		return -EINVAL;

	return 0;

	return ARRAY_SIZE(foo_groups);

}



static const char *foo_get_group_name(struct pinctrl_dev *pctldev,
@@ -175,7 +173,7 @@ static int foo_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector, 
}



static struct pinctrl_ops foo_pctrl_ops = {

	.list_groups = foo_list_groups,

	.get_groups_count = foo_get_groups_count,

	.get_group_name = foo_get_group_name,

	.get_group_pins = foo_get_group_pins,

};
@@ -186,13 +184,12 @@ static struct pinctrl_desc foo_desc = { 
       .pctlops = &foo_pctrl_ops,

};



The pin control subsystem will call the .list_groups() function repeatedly

beginning on 0 until it returns non-zero to determine legal selectors, then

it will call the other functions to retrieve the name and pins of the group.

Maintaining the data structure of the groups is up to the driver, this is

just a simple example - in practice you may need more entries in your group

structure, for example specific register ranges associated with each group

and so on.

The pin control subsystem will call the .get_groups_count() function to

determine total number of legal selectors, then it will call the other functions

to retrieve the name and pins of the group. Maintaining the data structure of

the groups is up to the driver, this is just a simple example - in practice you

may need more entries in your group structure, for example specific register

ranges associated with each group and so on.





Pin configuration
@@ -606,11 +603,9 @@ static const struct foo_group foo_groups[] = { 
};





static int foo_list_groups(struct pinctrl_dev *pctldev, unsigned selector)

static int foo_get_groups_count(struct pinctrl_dev *pctldev)

{

	if (selector >= ARRAY_SIZE(foo_groups))

		return -EINVAL;

	return 0;

	return ARRAY_SIZE(foo_groups);

}



static const char *foo_get_group_name(struct pinctrl_dev *pctldev,
@@ -629,7 +624,7 @@ static int foo_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector, 
}



static struct pinctrl_ops foo_pctrl_ops = {

	.list_groups = foo_list_groups,

	.get_groups_count = foo_get_groups_count,

	.get_group_name = foo_get_group_name,

	.get_group_pins = foo_get_group_pins,

};
@@ -663,11 +658,9 @@ static const struct foo_pmx_func foo_functions[] = { 
	},

};



int foo_list_funcs(struct pinctrl_dev *pctldev, unsigned selector)

int foo_get_functions_count(struct pinctrl_dev *pctldev)

{

	if (selector >= ARRAY_SIZE(foo_functions))

		return -EINVAL;

	return 0;

	return ARRAY_SIZE(foo_functions);

}



const char *foo_get_fname(struct pinctrl_dev *pctldev, unsigned selector)
@@ -703,7 +696,7 @@ void foo_disable(struct pinctrl_dev *pctldev, unsigned selector, 
}



struct pinmux_ops foo_pmxops = {

	.list_functions = foo_list_funcs,

	.get_functions_count = foo_get_functions_count,

	.get_function_name = foo_get_fname,

	.get_function_groups = foo_get_groups,

	.enable = foo_enable,

drivers/pinctrl/core.c

+6 −4
Original line number Diff line number Diff line
@@ -319,9 +319,10 @@ int pinctrl_get_group_selector(struct pinctrl_dev *pctldev, 
			       const char *pin_group)

{

	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;

	unsigned ngroups = pctlops->get_groups_count(pctldev);

	unsigned group_selector = 0;



	while (pctlops->list_groups(pctldev, group_selector) >= 0) {

	while (group_selector < ngroups) {

		const char *gname = pctlops->get_group_name(pctldev,

							    group_selector);

		if (!strcmp(gname, pin_group)) {
@@ -941,12 +942,13 @@ static int pinctrl_groups_show(struct seq_file *s, void *what) 
{

	struct pinctrl_dev *pctldev = s->private;

	const struct pinctrl_ops *ops = pctldev->desc->pctlops;

	unsigned selector = 0;

	unsigned ngroups, selector = 0;



	ngroups = ops->get_groups_count(pctldev);

	mutex_lock(&pinctrl_mutex);



	seq_puts(s, "registered pin groups:\n");

	while (ops->list_groups(pctldev, selector) >= 0) {

	while (selector < ngroups) {

		const unsigned *pins;

		unsigned num_pins;

		const char *gname = ops->get_group_name(pctldev, selector);
@@ -1261,7 +1263,7 @@ static int pinctrl_check_ops(struct pinctrl_dev *pctldev) 
	const struct pinctrl_ops *ops = pctldev->desc->pctlops;



	if (!ops ||

	    !ops->list_groups ||

	    !ops->get_groups_count ||

	    !ops->get_group_name ||

	    !ops->get_group_pins)

		return -EINVAL;

drivers/pinctrl/pinconf.c

+2 −1
Original line number Diff line number Diff line
@@ -495,6 +495,7 @@ static int pinconf_groups_show(struct seq_file *s, void *what) 
	struct pinctrl_dev *pctldev = s->private;

	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;

	const struct pinconf_ops *ops = pctldev->desc->confops;

	unsigned ngroups = pctlops->get_groups_count(pctldev);

	unsigned selector = 0;



	if (!ops || !ops->pin_config_group_get)
@@ -505,7 +506,7 @@ static int pinconf_groups_show(struct seq_file *s, void *what) 


	mutex_lock(&pinctrl_mutex);



	while (pctlops->list_groups(pctldev, selector) >= 0) {

	while (selector < ngroups) {

		const char *gname = pctlops->get_group_name(pctldev, selector);



		seq_printf(s, "%u (%s):", selector, gname);

drivers/pinctrl/pinctrl-pxa3xx.c

+10 −14
Original line number Diff line number Diff line
@@ -25,20 +25,18 @@ static struct pinctrl_gpio_range pxa3xx_pinctrl_gpio_range = { 
	.pin_base	= 0,

};



static int pxa3xx_list_groups(struct pinctrl_dev *pctrldev, unsigned selector)

static int pxa3xx_get_groups_count(struct pinctrl_dev *pctrldev)

{

	struct pxa3xx_pinmux_info *info = pinctrl_dev_get_drvdata(pctrldev);

	if (selector >= info->num_grps)

		return -EINVAL;

	return 0;



	return info->num_grps;

}



static const char *pxa3xx_get_group_name(struct pinctrl_dev *pctrldev,

					 unsigned selector)

{

	struct pxa3xx_pinmux_info *info = pinctrl_dev_get_drvdata(pctrldev);

	if (selector >= info->num_grps)

		return NULL;



	return info->grps[selector].name;

}
@@ -48,25 +46,23 @@ static int pxa3xx_get_group_pins(struct pinctrl_dev *pctrldev, 
				 unsigned *num_pins)

{

	struct pxa3xx_pinmux_info *info = pinctrl_dev_get_drvdata(pctrldev);

	if (selector >= info->num_grps)

		return -EINVAL;



	*pins = info->grps[selector].pins;

	*num_pins = info->grps[selector].npins;

	return 0;

}



static struct pinctrl_ops pxa3xx_pctrl_ops = {

	.list_groups	= pxa3xx_list_groups,

	.get_groups_count = pxa3xx_get_groups_count,

	.get_group_name	= pxa3xx_get_group_name,

	.get_group_pins	= pxa3xx_get_group_pins,

};



static int pxa3xx_pmx_list_func(struct pinctrl_dev *pctrldev, unsigned func)

static int pxa3xx_pmx_get_funcs_count(struct pinctrl_dev *pctrldev)

{

	struct pxa3xx_pinmux_info *info = pinctrl_dev_get_drvdata(pctrldev);

	if (func >= info->num_funcs)

		return -EINVAL;

	return 0;



	return info->num_funcs;

}



static const char *pxa3xx_pmx_get_func_name(struct pinctrl_dev *pctrldev,
@@ -170,7 +166,7 @@ static int pxa3xx_pmx_request_gpio(struct pinctrl_dev *pctrldev, 
}



static struct pinmux_ops pxa3xx_pmx_ops = {

	.list_functions		= pxa3xx_pmx_list_func,

	.get_functions_count	= pxa3xx_pmx_get_funcs_count,

	.get_function_name	= pxa3xx_pmx_get_func_name,

	.get_function_groups	= pxa3xx_pmx_get_groups,

	.enable			= pxa3xx_pmx_enable,

drivers/pinctrl/pinctrl-sirf.c

+6 −14
Original line number Diff line number Diff line
@@ -853,18 +853,14 @@ static const struct sirfsoc_pin_group sirfsoc_pin_groups[] = { 
	SIRFSOC_PIN_GROUP("gpsgrp", gps_pins),

};



static int sirfsoc_list_groups(struct pinctrl_dev *pctldev, unsigned selector)

static int sirfsoc_get_groups_count(struct pinctrl_dev *pctldev)

{

	if (selector >= ARRAY_SIZE(sirfsoc_pin_groups))

		return -EINVAL;

	return 0;

	return ARRAY_SIZE(sirfsoc_pin_groups);

}



static const char *sirfsoc_get_group_name(struct pinctrl_dev *pctldev,

				       unsigned selector)

{

	if (selector >= ARRAY_SIZE(sirfsoc_pin_groups))

		return NULL;

	return sirfsoc_pin_groups[selector].name;

}
@@ -872,8 +868,6 @@ static int sirfsoc_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector 
			       const unsigned **pins,

			       unsigned *num_pins)

{

	if (selector >= ARRAY_SIZE(sirfsoc_pin_groups))

		return -EINVAL;

	*pins = sirfsoc_pin_groups[selector].pins;

	*num_pins = sirfsoc_pin_groups[selector].num_pins;

	return 0;
@@ -886,7 +880,7 @@ static void sirfsoc_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s 
}



static struct pinctrl_ops sirfsoc_pctrl_ops = {

	.list_groups = sirfsoc_list_groups,

	.get_groups_count = sirfsoc_get_groups_count,

	.get_group_name = sirfsoc_get_group_name,

	.get_group_pins = sirfsoc_get_group_pins,

	.pin_dbg_show = sirfsoc_pin_dbg_show,
@@ -1033,11 +1027,9 @@ static void sirfsoc_pinmux_disable(struct pinctrl_dev *pmxdev, unsigned selector 
	sirfsoc_pinmux_endisable(spmx, selector, false);

}



static int sirfsoc_pinmux_list_funcs(struct pinctrl_dev *pmxdev, unsigned selector)

static int sirfsoc_pinmux_get_funcs_count(struct pinctrl_dev *pmxdev)

{

	if (selector >= ARRAY_SIZE(sirfsoc_pmx_functions))

		return -EINVAL;

	return 0;

	return ARRAY_SIZE(sirfsoc_pmx_functions);

}



static const char *sirfsoc_pinmux_get_func_name(struct pinctrl_dev *pctldev,
@@ -1074,9 +1066,9 @@ static int sirfsoc_pinmux_request_gpio(struct pinctrl_dev *pmxdev, 
}



static struct pinmux_ops sirfsoc_pinmux_ops = {

	.list_functions = sirfsoc_pinmux_list_funcs,

	.enable = sirfsoc_pinmux_enable,

	.disable = sirfsoc_pinmux_disable,

	.get_functions_count = sirfsoc_pinmux_get_funcs_count,

	.get_function_name = sirfsoc_pinmux_get_func_name,

	.get_function_groups = sirfsoc_pinmux_get_groups,

	.gpio_request_enable = sirfsoc_pinmux_request_gpio,