gpiolib: add batch set/get
Subsystems (7)
RFC 1/3 gpiolib: add batch set/get
Hi friends,
This is v5 of batch support for gpiolib. Thanks to Uwe Kleine-König, Ryan Mallon and others for prior feedback. The changes I've made are:
- split the patches into generic, arch specific and am300epd
- adjusting the API to remove width (note, the actual API call where width was dropped is in the arch specific code, not here.)
- updating documentation of this API in gpio.txt
- cleanup of the width, mask terms
Please let me know your thoughts and feedback.
Thanks,
jaya
--- Documentation/gpio.txt | 72 ++++++++++++ drivers/gpio/Kconfig | 5 + drivers/gpio/gpiolib.c | 272 ++++++++++++++++++++++++++++++++++++++++++++ include/asm-generic/gpio.h | 17 +++- 4 files changed, 365 insertions(+), 1 deletions(-)
Documentation/gpio.txt +72 -0
@@ -185,6 +185,78 @@ and not to need spinlocks. Such optimized calls can make bitbanging applications a lot more efficient (in both space and time) than spending dozens of instructions on subroutine calls. +[OPTIONAL] Spinlock-Safe GPIO Batch access +------------------------------------------ +The original GPIO API provides single bit access to GPIO pins. However, +some devices treat GPIO as a mechanism for bulk data transfer. In this type +of system, the performance of the single bit API may be inadequate. As such, +the user can consider enabling the batch access API. The batch access API +allows access of up-to 32-bits of GPIO at a time. This API is as follows: + + /* BATCH GPIO INPUT */ +int gpio_get_batch(unsigned startpin, u32 mask, u32 *result); + +The following examples help explain how this function is to be used. + Q: How do I get gpio pins 0 through 7? (8 bits) + A: gpio_get_batch(startpin=0, mask=0xFF, &result) result=0xnn + Q: How do I get gpio pins 58 through 73? (16 bits) + A: gpio_get_batch(startpin=58, mask=0xFFFF, &result) result=0xnnnn + Q: How do I get gpio pins 16 through 47? (32 bits) + A: gpio_get_batch(startpin=16, mask=0xFFFFFFFF, &result) + A: result=0xnnnnnnnn + Q: How do I get non-consecutive gpio pins 5 and 9? + A: Use the mask to mask out 6, 7 and 8 + A: So mask in binary is 10001 which is 0x11 + A: gpio_get_batch(startpin=5, mask=0x11, &result) + A: result is in the same form, binary n000n + + /* BATCH GPIO OUTPUT */ +int gpio_set_batch(unsigned startpin, u32 mask, u32 values); + +The following examples help explain how this function is to be used. + Q: How to set gpio pins 0 through 7 to all 0? (8 bits) + A: gpio_set_batch(startpin=0, mask=0xFF, values=0x0); + Q: How to set gpio pins 58 through 73 to all 1? (16 bits) + A: gpio_set_batch(startpin=58, mask=0xFFFF, values=0xFFFF); + Q: How to set gpio pins 16 through 47 to 0xCAFEC001? (32 bits) + A: gpio_set_batch(startpin=16, mask=0xFFFFFFFF, values=0xCAFEC001); + Q: How do I set non-consecutive gpio pins 5 and 9 to both 1? + A: Use the mask to mask out 6, 7 and 8 + A: So mask in binary is 10001 which is 0x11 + A: gpio_set_batch(startpin=5, mask=0x11, values=0x11) + +The following example shows the use of the batch API and a comparison with +the original single bit API: + +Original input method which loops through a set of pins: + for (i = 0; i <= (DB15_GPIO_PIN - DB0_GPIO_PIN) ; i++) + res |= (gpio_get_value(DB0_GPIO_PIN + i)) ? (1 << i) : 0; + +Batch input method: + u32 val; + err = gpio_get_batch(DB0_GPIO_PIN, 0xFFFF, &val); + +Original output method: + for (i = 0; i <= (DB15_GPIO_PIN - DB0_GPIO_PIN) ; i++) + gpio_set_value(DB0_GPIO_PIN + i, (data >> i) & 0x01); + +Batch output method: + int err; + err = gpio_set_batch(DB0_GPIO_PIN, 0xFFFF, data); + +Using these calls for GPIOs that can't safely be accessed without sleeping +(see below) is an error. + +Platform-specific implementations are encouraged to optimize the two +calls by checking if the batch get/set requested can be achieved within the +platform's fast path access to gpio registers. For example, if the starting +gpio and width of bits to be written is contained within a single register +then the platform specific implementation may choose to execute it. If the +request is more complex, then the platform specific implementation can +choose to call upon the platform independent __gpio_get/set_batch functions +which are able to cross gpio_chip boundaries. Implementations are also +encouraged to use the bitops macros. These will also optimize for use cases +where the masks are constants. GPIO access that may sleep --------------------------
drivers/gpio/Kconfig +5 -0
@@ -37,6 +37,11 @@ menuconfig GPIOLIB if GPIOLIB +config GPIOLIB_BATCH + bool "Batch GPIO support" + help + Say Y here to add the capability to batch set/get GPIOs. + config DEBUG_GPIO bool "Debug GPIO calls" depends on DEBUG_KERNEL
drivers/gpio/gpiolib.c +272 -0
284 lines not on this page · raw message
include/asm-generic/gpio.h +16 -1
@@ -44,6 +44,10 @@ struct module;* returns either the value actually sensed, or zero * @direction_output: configures signal "offset" as output, or returns error * @set: assigns output value for signal "offset" +* @set_batch: batch assigns output values for signals starting at +* "startpin" with mask in "mask" all within this gpio_chip +* @get_batch: batch fetches values for consecutive signals starting at +* "startpin" with mask in "mask" all within this gpio_chip * @to_irq: optional hook supporting non-static gpio_to_irq() mappings; * implementation may not sleep * @dbg_show: optional routine to show contents in debugfs; default code
@@ -84,7 +88,14 @@ struct gpio_chip { unsigned offset, int value);void (*set)(struct gpio_chip *chip,unsigned offset,int value); - +#ifdef CONFIG_GPIOLIB_BATCH +int (*set_batch)(struct gpio_chip *chip, +unsigned startpin,u32 mask, +int width,u32 values); +int (*get_batch)(struct gpio_chip *chip, +unsigned startpin,u32 mask, +int width,u32 *result); +#endif int (*to_irq)(struct gpio_chip *chip,unsigned offset);
@@ -124,6 +135,10 @@ extern void gpio_set_value_cansleep(unsigned gpio, int value);*/ extern int __gpio_get_value (unsigned gpio);extern void __gpio_set_value (unsigned gpio,int value); +#ifdef CONFIG_GPIOLIB_BATCH +extern int __gpio_set_batch (unsigned gpio,u32 mask,int width,u32 values); +extern int __gpio_get_batch (unsigned gpio,u32 mask,int width,u32 *result); +#endif extern int __gpio_cansleep (unsigned gpio);
Signature · 12 lines
1.5.2.3 ------------------------------------------------------------------------------ This SF.net email is sponsored by: SourcForge Community SourceForge wants to tell your story. http://p.sf.net/sfu/sf-spreadtheword _______________________________________________ Linux-fbdev-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-fbdev-devel
RFC 2/3 mach-pxa: gpio add batch set/get
This patch adds support for pxa specific batch set/get of gpio. This is exported to gpiolib via the gpio_chip interface. The API used conforms with the gpiolib batch set/get API described in Documentation/gpio.txt.
--- arch/arm/mach-pxa/Kconfig | 1 + arch/arm/mach-pxa/gpio.c | 63 +++++++++++++++++++++++++++++++++ arch/arm/mach-pxa/include/mach/gpio.h | 51 ++++++++++++++++++++++++++ 3 files changed, 115 insertions(+), 0 deletions(-)
arch/arm/mach-pxa/Kconfig +1 -0
@@ -41,6 +41,7 @@ config GUMSTIX_AM200EPD bool "Enable AM200EPD board support" config GUMSTIX_AM300EPD + select GPIOLIB_BATCH bool "Enable AM300EPD board support" endchoice
arch/arm/mach-pxa/gpio.c +63 -0
75 lines not on this page · raw message
arch/arm/mach-pxa/include/mach/gpio.h +51 -0
63 lines not on this page · raw message
Signature · 1 line
1.5.2.3
RFC 3/3 mach-pxa: use batch set/get in am300epd
In reply to Jaya KumarThis patch to am300epd uses the batch gpiolib set/get API in order to significantly improve performance when transferring framebuffer data.
--- arch/arm/mach-pxa/am300epd.c | 23 ++++++++++++----------- 1 files changed, 12 insertions(+), 11 deletions(-)
arch/arm/mach-pxa/am300epd.c +12 -11
@@ -187,24 +187,25 @@ static void am300_cleanup(struct broadsheetfb_par *par)static u16 am300_get_hdb (struct broadsheetfb_par *par) { -u16 res =0 ; -int i; - -for (i =0 ; i <= (DB15_GPIO_PIN -DB0_GPIO_PIN ) ; i++) - res |= (gpio_get_value (DB0_GPIO_PIN + i)) ? (1 << i) :0 ; +int err; +u32 val; -return res; + err =gpio_get_batch (DB0_GPIO_PIN ,0xFFFF , &val); +if (err) { +dev_err (&am300_device->dev,"get failed: %d\n" , err); +return 0 ; + } +return (u16 ) val; }static void am300_set_hdb (struct broadsheetfb_par *par,u16 data) { -int i; - -for (i =0 ; i <= (DB15_GPIO_PIN -DB0_GPIO_PIN ) ; i++) -gpio_set_value (DB0_GPIO_PIN + i, (data >> i) &0x01 ); +int err; + err =gpio_set_batch (DB0_GPIO_PIN ,0xFFFF , data); +if (err) +dev_err (&am300_device->dev,"set failed: %d\n" , err); } -static void am300_set_ctl (struct broadsheetfb_par *par,unsigned char bit,u8 state) {
Signature · 8 lines
1.5.2.3 ------------------------------------------------------------------------------ This SF.net email is sponsored by: SourcForge Community SourceForge wants to tell your story. http://p.sf.net/sfu/sf-spreadtheword
Hello Jaya,
Quoted 1 line · Jaya Kumar
- split the patches into generic, arch specific and am300epd
I would swap the order to have:
generic am300epd pxa specific
This way the tree of the second commit is a test case for the generic implementation.
Quoted 2 lines
- adjusting the API to remove width (note, the actual API call where width was dropped is in the arch specific code, not here.)
Nevertheless I would document the "generic" per arch specific implementation in gpio.txt. For the functions like __gpio_get_value you can just do
#define gpio_get_value(gpio) __gpio_get_value(gpio)
but for your batch functions you need something like
#define gpio_set_batch(startpin, mask, values) \
({ u32 __mask = mask; __gpio_set_batch(startpin, __mask, fls(__mask), values);})Maybe better use/recommend an inline function?
Quoted 10 lines
Cc David Brownell <[email protected]>Cc Eric Miao <[email protected]>Cc Paulius Zaleckas <[email protected]>Cc Geert Uytterhoeven <[email protected]>Cc Sam Ravnborg <[email protected]>Signed-off-by Jaya Kumar <[email protected]>
Note you didn't Cc: me.
Signature · 2 lines
Pengutronix e.K. | Uwe Kleine-König | Industrial Linux Solutions | http://www.pengutronix.de/ |