Commit 77588c14 authored by Janusz Krzysztofik's avatar Janusz Krzysztofik Committed by Linus Walleij
Browse files

gpiolib: Pass array info to get/set array functions 



In order to make use of array info obtained from gpiod_get_array() and
speed up processing of arrays matching single GPIO chip layout, that
information must be passed to get/set array functions.  Extend the
functions' API with that additional parameter and update all users.
Pass NULL if a user builds an array itself from single GPIOs.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Miguel Ojeda Sandonis <miguel.ojeda.sandonis@gmail.com>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
Cc: Lukas Wunner <lukas@wunner.de>
Cc: Peter Korsgaard <peter.korsgaard@barco.com>
Cc: Peter Rosin <peda@axentia.se>
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Florian Fainelli <f.fainelli@gmail.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Rojhalat Ibrahim <imr@rtschenk.de>
Cc: Dominik Brodowski <linux@dominikbrodowski.net>
Cc: Russell King <rmk+kernel@armlinux.org.uk>
Cc: Kishon Vijay Abraham I <kishon@ti.com>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Lars-Peter Clausen <lars@metafoo.de>
Cc: Michael Hennerich <Michael.Hennerich@analog.com>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Hartmut Knaack <knaack.h@gmx.de>
Cc: Peter Meerwald-Stadler <pmeerw@pmeerw.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jslaby@suse.com>
Cc: Yegor Yefremov <yegorslists@googlemail.com>
Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: default avatarJanusz Krzysztofik <jmkrzyszt@gmail.com>
Acked-by: default avatarUlf Hansson <ulf.hansson@linaro.org>
Signed-off-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent bf9346f5

Documentation/driver-api/gpio/consumer.rst

+12 −2
Original line number Diff line number Diff line
@@ -325,28 +325,36 @@ The following functions get or set the values of an array of GPIOs:: 


	int gpiod_get_array_value(unsigned int array_size,

				  struct gpio_desc **desc_array,

				  struct gpio_array *array_info,

				  unsigned long *value_bitmap);

	int gpiod_get_raw_array_value(unsigned int array_size,

				      struct gpio_desc **desc_array,

				      struct gpio_array *array_info,

				      unsigned long *value_bitmap);

	int gpiod_get_array_value_cansleep(unsigned int array_size,

					   struct gpio_desc **desc_array,

					   struct gpio_array *array_info,

					   unsigned long *value_bitmap);

	int gpiod_get_raw_array_value_cansleep(unsigned int array_size,

					   struct gpio_desc **desc_array,

					   struct gpio_array *array_info,

					   unsigned long *value_bitmap);



	void gpiod_set_array_value(unsigned int array_size,

				   struct gpio_desc **desc_array,

				   struct gpio_array *array_info,

				   unsigned long *value_bitmap)

	void gpiod_set_raw_array_value(unsigned int array_size,

				       struct gpio_desc **desc_array,

				       struct gpio_array *array_info,

				       unsigned long *value_bitmap)

	void gpiod_set_array_value_cansleep(unsigned int array_size,

					    struct gpio_desc **desc_array,

					    struct gpio_array *array_info,

					    unsigned long *value_bitmap)

	void gpiod_set_raw_array_value_cansleep(unsigned int array_size,

						struct gpio_desc **desc_array,

						struct gpio_array *array_info,

						unsigned long *value_bitmap)



The array can be an arbitrary set of GPIOs. The functions will try to access
@@ -358,6 +366,7 @@ accessed sequentially. 
The functions take three arguments:

	* array_size	- the number of array elements

	* desc_array	- an array of GPIO descriptors

	* array_info	- optional information obtained from gpiod_array_get()

	* value_bitmap	- a bitmap to store the GPIOs' values (get) or

			  a bitmap of values to assign to the GPIOs (set)
@@ -368,12 +377,13 @@ the struct gpio_descs returned by gpiod_get_array():: 


	struct gpio_descs *my_gpio_descs = gpiod_get_array(...);

	gpiod_set_array_value(my_gpio_descs->ndescs, my_gpio_descs->desc,

			      my_gpio_value_bitmap);

			      my_gpio_descs->info, my_gpio_value_bitmap);



It is also possible to access a completely arbitrary array of descriptors. The

descriptors may be obtained using any combination of gpiod_get() and

gpiod_get_array(). Afterwards the array of descriptors has to be setup

manually before it can be passed to one of the above functions.

manually before it can be passed to one of the above functions.  In that case,

array_info should be set to NULL.



Note that for optimal performance GPIOs belonging to the same chip should be

contiguous within the array of descriptors.

drivers/auxdisplay/hd44780.c

+4 −4
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ static void hd44780_write_gpio8(struct hd44780 *hd, u8 val, unsigned int rs) 
	n = hd->pins[PIN_CTRL_RW] ? 10 : 9;



	/* Present the data to the port */

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA0], values);

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA0], NULL, values);



	hd44780_strobe_gpio(hd);

}
@@ -87,7 +87,7 @@ static void hd44780_write_gpio4(struct hd44780 *hd, u8 val, unsigned int rs) 
	n = hd->pins[PIN_CTRL_RW] ? 6 : 5;



	/* Present the data to the port */

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], values);

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);



	hd44780_strobe_gpio(hd);
@@ -96,7 +96,7 @@ static void hd44780_write_gpio4(struct hd44780 *hd, u8 val, unsigned int rs) 
	values[0] |= val & 0x0f;



	/* Present the data to the port */

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], values);

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);



	hd44780_strobe_gpio(hd);

}
@@ -152,7 +152,7 @@ static void hd44780_write_cmd_raw_gpio4(struct charlcd *lcd, int cmd) 
	n = hd->pins[PIN_CTRL_RW] ? 6 : 5;



	/* Present the data to the port */

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], values);

	gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);



	hd44780_strobe_gpio(hd);

}

drivers/bus/ts-nbus.c

+3 −2
Original line number Diff line number Diff line
@@ -114,7 +114,8 @@ static void ts_nbus_reset_bus(struct ts_nbus *ts_nbus) 


	values[0] = 0;



	gpiod_set_array_value_cansleep(8, ts_nbus->data->desc, values);

	gpiod_set_array_value_cansleep(8, ts_nbus->data->desc,

				       ts_nbus->data->info, values);

	gpiod_set_value_cansleep(ts_nbus->csn, 0);

	gpiod_set_value_cansleep(ts_nbus->strobe, 0);

	gpiod_set_value_cansleep(ts_nbus->ale, 0);
@@ -159,7 +160,7 @@ static void ts_nbus_write_byte(struct ts_nbus *ts_nbus, u8 byte) 


	values[0] = byte;



	gpiod_set_array_value_cansleep(8, gpios->desc, values);

	gpiod_set_array_value_cansleep(8, gpios->desc, gpios->info, values);

}



/*

drivers/gpio/gpio-max3191x.c

+4 −2
Original line number Diff line number Diff line
@@ -313,6 +313,7 @@ static int max3191x_set_config(struct gpio_chip *gpio, unsigned int offset, 


static void gpiod_set_array_single_value_cansleep(unsigned int ndescs,

						  struct gpio_desc **desc,

						  struct gpio_array *info,

						  int value)

{

	unsigned long *values;
@@ -326,7 +327,7 @@ static void gpiod_set_array_single_value_cansleep(unsigned int ndescs, 
	else

		bitmap_zero(values, ndescs);



	gpiod_set_array_value_cansleep(ndescs, desc, values);

	gpiod_set_array_value_cansleep(ndescs, desc, info, values);

	kfree(values);

}
@@ -399,7 +400,8 @@ static int max3191x_probe(struct spi_device *spi) 
	if (max3191x->modesel_pins)

		gpiod_set_array_single_value_cansleep(

				 max3191x->modesel_pins->ndescs,

				 max3191x->modesel_pins->desc, max3191x->mode);

				 max3191x->modesel_pins->desc,

				 max3191x->modesel_pins->info, max3191x->mode);



	max3191x->ignore_uv = device_property_read_bool(dev,

						  "maxim,ignore-undervoltage");

drivers/gpio/gpiolib.c

+32 −8
Original line number Diff line number Diff line
@@ -436,6 +436,7 @@ static long linehandle_ioctl(struct file *filep, unsigned int cmd, 
							true,

							lh->numdescs,

							lh->descs,

							NULL,

							vals);

		if (ret)

			return ret;
@@ -468,6 +469,7 @@ static long linehandle_ioctl(struct file *filep, unsigned int cmd, 
					      true,

					      lh->numdescs,

					      lh->descs,

					      NULL,

					      vals);

	}

	return -EINVAL;
@@ -2784,6 +2786,7 @@ static int gpio_chip_get_multiple(struct gpio_chip *chip, 
int gpiod_get_array_value_complex(bool raw, bool can_sleep,

				  unsigned int array_size,

				  struct gpio_desc **desc_array,

				  struct gpio_array *array_info,

				  unsigned long *value_bitmap)

{

	int i = 0;
@@ -2897,6 +2900,7 @@ EXPORT_SYMBOL_GPL(gpiod_get_value); 
 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be read

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap to store the read values

 *

 * Read the raw values of the GPIOs, i.e. the values of the physical lines
@@ -2908,12 +2912,14 @@ EXPORT_SYMBOL_GPL(gpiod_get_value); 
 */

int gpiod_get_raw_array_value(unsigned int array_size,

			      struct gpio_desc **desc_array,

			      struct gpio_array *array_info,

			      unsigned long *value_bitmap)

{

	if (!desc_array)

		return -EINVAL;

	return gpiod_get_array_value_complex(true, false, array_size,

					     desc_array, value_bitmap);

					     desc_array, array_info,

					     value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
@@ -2921,6 +2927,7 @@ EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value); 
 * gpiod_get_array_value() - read values from an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be read

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap to store the read values

 *

 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
@@ -2931,12 +2938,14 @@ EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value); 
 */

int gpiod_get_array_value(unsigned int array_size,

			  struct gpio_desc **desc_array,

			  struct gpio_array *array_info,

			  unsigned long *value_bitmap)

{

	if (!desc_array)

		return -EINVAL;

	return gpiod_get_array_value_complex(false, false, array_size,

					     desc_array, value_bitmap);

					     desc_array, array_info,

					     value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_get_array_value);
@@ -3029,6 +3038,7 @@ static void gpio_chip_set_multiple(struct gpio_chip *chip, 
int gpiod_set_array_value_complex(bool raw, bool can_sleep,

				   unsigned int array_size,

				   struct gpio_desc **desc_array,

				   struct gpio_array *array_info,

				   unsigned long *value_bitmap)

{

	int i = 0;
@@ -3156,6 +3166,7 @@ EXPORT_SYMBOL_GPL(gpiod_set_value); 
 * gpiod_set_raw_array_value() - assign values to an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be assigned

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap of values to assign

 *

 * Set the raw values of the GPIOs, i.e. the values of the physical lines
@@ -3166,12 +3177,13 @@ EXPORT_SYMBOL_GPL(gpiod_set_value); 
 */

int gpiod_set_raw_array_value(unsigned int array_size,

			 struct gpio_desc **desc_array,

			 struct gpio_array *array_info,

			 unsigned long *value_bitmap)

{

	if (!desc_array)

		return -EINVAL;

	return gpiod_set_array_value_complex(true, false, array_size,

					desc_array, value_bitmap);

					desc_array, array_info, value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
@@ -3179,6 +3191,7 @@ EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value); 
 * gpiod_set_array_value() - assign values to an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be assigned

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap of values to assign

 *

 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
@@ -3189,12 +3202,13 @@ EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value); 
 */

void gpiod_set_array_value(unsigned int array_size,

			   struct gpio_desc **desc_array,

			   struct gpio_array *array_info,

			   unsigned long *value_bitmap)

{

	if (!desc_array)

		return;

	gpiod_set_array_value_complex(false, false, array_size, desc_array,

				      value_bitmap);

				      array_info, value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_set_array_value);
@@ -3416,6 +3430,7 @@ EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep); 
 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be read

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap to store the read values

 *

 * Read the raw values of the GPIOs, i.e. the values of the physical lines
@@ -3426,13 +3441,15 @@ EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep); 
 */

int gpiod_get_raw_array_value_cansleep(unsigned int array_size,

				       struct gpio_desc **desc_array,

				       struct gpio_array *array_info,

				       unsigned long *value_bitmap)

{

	might_sleep_if(extra_checks);

	if (!desc_array)

		return -EINVAL;

	return gpiod_get_array_value_complex(true, true, array_size,

					     desc_array, value_bitmap);

					     desc_array, array_info,

					     value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
@@ -3440,6 +3457,7 @@ EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep); 
 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be read

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap to store the read values

 *

 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
@@ -3449,13 +3467,15 @@ EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep); 
 */

int gpiod_get_array_value_cansleep(unsigned int array_size,

				   struct gpio_desc **desc_array,

				   struct gpio_array *array_info,

				   unsigned long *value_bitmap)

{

	might_sleep_if(extra_checks);

	if (!desc_array)

		return -EINVAL;

	return gpiod_get_array_value_complex(false, true, array_size,

					     desc_array, value_bitmap);

					     desc_array, array_info,

					     value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
@@ -3499,6 +3519,7 @@ EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep); 
 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be assigned

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap of values to assign

 *

 * Set the raw values of the GPIOs, i.e. the values of the physical lines
@@ -3508,13 +3529,14 @@ EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep); 
 */

int gpiod_set_raw_array_value_cansleep(unsigned int array_size,

					struct gpio_desc **desc_array,

					struct gpio_array *array_info,

					unsigned long *value_bitmap)

{

	might_sleep_if(extra_checks);

	if (!desc_array)

		return -EINVAL;

	return gpiod_set_array_value_complex(true, true, array_size, desc_array,

				      value_bitmap);

				      array_info, value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
@@ -3539,6 +3561,7 @@ void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n) 
 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs

 * @array_size: number of elements in the descriptor array / value bitmap

 * @desc_array: array of GPIO descriptors whose values will be assigned

 * @array_info: information on applicability of fast bitmap processing path

 * @value_bitmap: bitmap of values to assign

 *

 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
@@ -3548,13 +3571,14 @@ void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n) 
 */

void gpiod_set_array_value_cansleep(unsigned int array_size,

				    struct gpio_desc **desc_array,

				    struct gpio_array *array_info,

				    unsigned long *value_bitmap)

{

	might_sleep_if(extra_checks);

	if (!desc_array)

		return;

	gpiod_set_array_value_complex(false, true, array_size, desc_array,

				      value_bitmap);

				      array_info, value_bitmap);

}

EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);

CRA Git | Maintained and supported by SUSTech CRA and CCSE