pinctrl: qcom: add support for sparse GPIOs
Subsystems (5)
v9 cover pinctrl: qcom: add support for sparse GPIOs
A series of patches that add support for GPIO maps that have holes in them. That is, even though a client driver has N consecutive GPIOs, some are just unavailable for whatever reason, and the hardware should not be accessed for those GPIOs.
Patch 1 reverts an old patch that triggers a get_direction of every pin upon init, without attempting to request the pins first. The direction is already being queried when the pin is requested.
Patch 2 adds support to pinctrl-msm for "unavailable" GPIOs.
Patch 3 extends that support to pinctrl-qdf2xxx. A recent ACPI change on QDF2400 platforms blocks access to most pins, so the driver can only register a subset.
This version drops the availability check in gpiolib, because it's no necessary. Instead, just having pinctrl-msm return -EACCES is enough to block all unavailable GPIOs. Patch 1 removes the only instance where an unrequested GPIO is being accessed.
v9:
Removed "gpiolib: add bitmask for valid GPIO lines"
Timur Tabi (3):
[v2] Revert "gpio: set up initial state from .get_direction()" [v8] pinctrl: qcom: disable GPIO groups with no pins [v5] pinctrl: qcom: qdf2xxx: add support for new ACPI HID QCOM8002
drivers/gpio/gpiolib.c | 31 ++----- drivers/pinctrl/qcom/pinctrl-msm.c | 28 +++++-- drivers/pinctrl/qcom/pinctrl-qdf2xxx.c | 143 ++++++++++++++++++++++++--------- 3 files changed, 137 insertions(+), 65 deletions(-)
Signature · 3 lines
Qualcomm Datacenter Technologies, Inc. as an affiliate of Qualcomm Technologies, Inc. Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.
PATCH v2 1/3 Revert "gpio: set up initial state from .get_direction()"
This reverts commit 72d3200061776264941be1b5a9bb8e926b3b30a5.
We cannot blindly query the direction of all GPIOs when the pins are first registered. The get_direction callback normally triggers a read/write to hardware, but we shouldn't be touching the hardware for an individual GPIO until after it's been properly claimed.
--- drivers/gpio/gpiolib.c | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-)
drivers/gpio/gpiolib.c +7 -24
@@ -1207,31 +1207,14 @@ int gpiochip_add_data_with_key(struct gpio_chip *chip, void *data,struct gpio_desc *desc = &gdev->descs[i]; desc->gdev = gdev; -/* -* REVISIT: most hardware initializes GPIOs as inputs -* (often with pullups enabled) so power usage is -* minimized. Linux code should set the gpio direction -* first thing; but until it does, and in case -* chip->get_direction is not set, we may expose the -* wrong direction in sysfs. -*/ - -if (chip->get_direction) { -/* -* If we have .get_direction, set up the initial -* direction flag from the hardware. -*/ -int dir = chip->get_direction (chip, i); -if (!dir) -set_bit (FLAG_IS_OUT , &desc->flags); - }else if (!chip->direction_input) { -/* -* If the chip lacks the .direction_input callback -* we logically assume all lines are outputs. -*/ -set_bit (FLAG_IS_OUT , &desc->flags); - } +/* REVISIT: most hardware initializes GPIOs as inputs (often +* with pullups enabled) so power usage is minimized. Linux +* code should set the gpio direction first thing; but until +* it does, and in case chip->get_direction is not set, we may +* expose the wrong direction in sysfs. +*/ + desc->flags = !chip->direction_input ? (1 <<FLAG_IS_OUT ) :0 ; }#ifdef CONFIG_PINCTRL
Signature · 3 lines
Qualcomm Datacenter Technologies, Inc. as an affiliate of Qualcomm Technologies, Inc. Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.
PATCH v8 2/3 pinctrl: qcom: disable GPIO groups with no pins
In reply to Timur Tabipinctrl-msm only accepts an array of GPIOs from 0 to n-1, and it expects each group to support have only one pin (npins == 1).
We can support "sparse" GPIO maps if we allow for some groups to have zero pins (npins == 0). These pins are "hidden" from the rest of the driver and gpiolib.
Access to unavailable GPIOs is blocked via a request callback. If the requested GPIO is unavailable, -EACCES is returned, which prevents further access to that GPIO.
--- drivers/pinctrl/qcom/pinctrl-msm.c | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-)
drivers/pinctrl/qcom/pinctrl-msm.c +23 -5
@@ -507,6 +507,11 @@ static void msm_gpio_dbg_show_one(struct seq_file *s, }; g = &pctrl->soc->groups[offset]; + +/* If the GPIO group has no pins, then don't show it. */ +if (!g->npins) +return ; + ctl_reg =readl (pctrl->regs + g->ctl_reg); is_out = !!(ctl_reg &BIT (g->oe_bit));
@@ -516,7 +521,7 @@ static void msm_gpio_dbg_show_one(struct seq_file *s,seq_printf (s," %-8s: %-3s %d" , g->name, is_out ?"out" :"in" , func);seq_printf (s," %dmA" ,msm_regval_to_drive (drive)); -seq_printf (s," %s" , pulls[pull]); +seq_printf (s," %s\n" , pulls[pull]); }static void msm_gpio_dbg_show (struct seq_file *s,struct gpio_chip *chip)
@@ -524,23 +529,36 @@ static void msm_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)unsigned gpio = chip->base;unsigned i; -for (i =0 ; i < chip->ngpio; i++, gpio++) { +for (i =0 ; i < chip->ngpio; i++, gpio++) msm_gpio_dbg_show_one(s, NULL, chip, i, gpio); -seq_puts (s,"\n" ); - } }#else #define msm_gpio_dbg_show NULL#endif +/* +* If the requested GPIO has no pins, then treat it as unavailable. +* Otherwise, call the standard request function. +*/ +static int msm_gpio_request (struct gpio_chip *chip,unsigned int offset) +{ +struct msm_pinctrl *pctrl =gpiochip_get_data (chip); +const struct msm_pingroup *g = &pctrl->soc->groups[offset]; + +if (!g->npins) +return -EACCES ; + +return gpiochip_generic_request (chip, offset); +} +static const struct gpio_chip msm_gpio_template = { .direction_input = msm_gpio_direction_input, .direction_output = msm_gpio_direction_output, .get_direction = msm_gpio_get_direction, .get = msm_gpio_get, .set = msm_gpio_set, - .request = gpiochip_generic_request, + .request = msm_gpio_request, .free = gpiochip_generic_free, .dbg_show = msm_gpio_dbg_show, };
Signature · 3 lines
Qualcomm Datacenter Technologies, Inc. as an affiliate of Qualcomm Technologies, Inc. Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.
PATCH v8 2/3 pinctrl: qcom: disable GPIO groups with no pins
Quoted 10 lines · Timur Tabi
pinctrl-msm only accepts an array of GPIOs from 0 to n-1, and it expects
each group to support have only one pin (npins == 1).We can support "sparse" GPIO maps if we allow for some groups to have zero
pins (npins == 0). These pins are "hidden" from the rest of the driver
and gpiolib.
Quoted 3 lines
Access to unavailable GPIOs is blocked via a request callback. If the requested GPIO is unavailable,
-EACCESis returned, which prevents further access to that GPIO.
We recently have some interesting BIOS/Windows driver design which makes a need of something similar. Mika did patched pinctrl-intel for that. I dunno that approach can be used here, or your proposal be utilized in pinctrl-intel. Mika, any comments?
See some nitpicks below.
drivers/pinctrl/qcom/pinctrl-msm.c static void msm_gpio_dbg_show_one(struct seq_file *s, · line 524
Quoted 6 lines
seq_printf(s, " %-8s: %-3s %d",
g->name,is_out? "out" :
"in", func);drivers/pinctrl/qcom/pinctrl-msm.c +1
-1seq_printf (s," %dmA" ,msm_regval_to_drive (drive)); -seq_printf (s," %s" , pulls[pull]); +seq_printf (s," %s\n" , pulls[pull]);
I would rather do
seq_putc(s, '\n');
which makes code slightly more flexible for maintenance and reading.
Quoted 5 lines
}
static void msm_gpio_dbg_show(struct
seq_file*s, structgpio_chip
*chip)
drivers/pinctrl/qcom/pinctrl-msm.c static void msm_gpio_dbg_show(struct seq_file · line 531
Quoted 9 lines
drivers/pinctrl/qcom/pinctrl-msm.c +1
-3@@ -524,23 +529,36 @@ static void msm_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)unsigned gpio = chip->base;unsigned i; -for (i =0 ; i < chip->ngpio; i++, gpio++) { +for (i =0 ; i < chip->ngpio; i++, gpio++)msm_gpio_dbg_show_one (s,NULL , chip, i, gpio); -seq_puts (s,"\n" ); - }
This kind of change looks like a candidate to a separate patch, though I mentioned it's just a nit.
Signature · 2 lines
Andy Shevchenko <[email protected]> Intel Finland Oy
PATCH v5 3/3 pinctrl: qcom: qdf2xxx: add support for new ACPI HID QCOM8002
In reply to Timur TabiNewer versions of the firmware for the Qualcomm Datacenter Technologies QDF2400 restricts access to a subset of the GPIOs on the TLMM. To prevent older kernels from accidentally accessing the restricted GPIOs, we change the ACPI HID for the TLMM block from QCOM8001 to QCOM8002, and introduce a new property "gpios". This property is an array of specific GPIOs that are accessible. When an older kernel boots on newer (restricted) firmware, it will fail to probe.
To implement the sparse GPIO map, we register all of the GPIOs, but set the pin count for the unavailable GPIOs to zero. The pinctrl-msm driver will block those unavailable GPIOs from being accessed.
To allow newer kernels to support older firmware, the driver retains support for QCOM8001.
--- drivers/pinctrl/qcom/pinctrl-qdf2xxx.c | 143 ++++++++++++++++++++++++--------- 1 file changed, 107 insertions(+), 36 deletions(-)
drivers/pinctrl/qcom/pinctrl-qdf2xxx.c +107 -36
@@ -38,68 +38,145 @@/* maximum size of each gpio name (enough room for "gpioXXX" + null) */ #define NAME_SIZE 8 +enum { +QDF2XXX_V1 , +QDF2XXX_V2 , +}; + +static const struct acpi_device_id qdf2xxx_acpi_ids[] = { + {"QCOM8001" ,QDF2XXX_V1 }, + {"QCOM8002" ,QDF2XXX_V2 }, + {}, +}; +MODULE_DEVICE_TABLE (acpi, qdf2xxx_acpi_ids); +static int qdf2xxx_pinctrl_probe (struct platform_device *pdev) { +const struct acpi_device_id *id = +acpi_match_device (qdf2xxx_acpi_ids, &pdev->dev);struct pinctrl_pin_desc *pins;struct msm_pingroup *groups;char (*names)[NAME_SIZE ];unsigned int i;u32 num_gpios; +unsigned int avail_gpios;/* The number of GPIOs we support */ +u16 *gpios;/* An array of supported GPIOs */ int ret;/* Query the number of GPIOs from ACPI */ ret =device_property_read_u32 (&pdev->dev,"num-gpios" , &num_gpios);if (ret <0 ) { -dev_warn (&pdev->dev,"missing num-gpios property\n" ); +dev_err (&pdev->dev,"missing 'num-gpios' property\n" );return ret; } -if (!num_gpios || num_gpios >MAX_GPIOS ) { -dev_warn (&pdev->dev,"invalid num-gpios property\n" ); +dev_err (&pdev->dev,"invalid 'num-gpios' property\n" );return -ENODEV ; } +/* +* The QCOM8001 HID contains only the number of GPIOs, and assumes +* that all of them are available. avail_gpios is the same as num_gpios. +* +* The QCOM8002 HID introduces the 'gpios' DSD, which lists +* specific GPIOs that the driver is allowed to access. +* +* The make the common code simpler, in both cases we create an +* array of GPIOs that are accessible. So for QCOM8001, that would +* be all of the GPIOs. +*/ +if (id->driver_data ==QDF2XXX_V1 ) { + avail_gpios = num_gpios; + + gpios =devm_kmalloc_array (&pdev->dev, avail_gpios, +sizeof (gpios[0 ]),GFP_KERNEL ); +if (!gpios) +return -ENOMEM ; + +for (i =0 ; i < avail_gpios; i++) + gpios[i] = i; + }else { +/* The number of GPIOs in the approved list */ + ret =device_property_read_u16_array (&pdev->dev,"gpios" , +NULL ,0 ); +if (ret <0 ) { +dev_err (&pdev->dev,"missing 'gpios' property\n" ); +return ret; + } +/* +* The number of available GPIOs should be non-zero, and no +* more than the total number of GPIOS. +*/ +if (!ret || ret > num_gpios) { +dev_err (&pdev->dev,"invalid 'gpios' property\n" ); +return -ENODEV ; + } + avail_gpios = ret; + + gpios =devm_kmalloc_array (&pdev->dev, avail_gpios, +sizeof (gpios[0 ]),GFP_KERNEL ); +if (!gpios) +return -ENOMEM ; + + ret =device_property_read_u16_array (&pdev->dev,"gpios" , gpios, + avail_gpios); +if (ret <0 ) { +dev_err (&pdev->dev,"could not read list of GPIOs\n" ); +return ret; + } + } + pins =devm_kcalloc (&pdev->dev, num_gpios,sizeof (struct pinctrl_pin_desc ),GFP_KERNEL ); groups =devm_kcalloc (&pdev->dev, num_gpios,sizeof (struct msm_pingroup ),GFP_KERNEL ); - names =devm_kcalloc (&pdev->dev, num_gpios,NAME_SIZE ,GFP_KERNEL ); + names =devm_kcalloc (&pdev->dev, avail_gpios,NAME_SIZE ,GFP_KERNEL );if (!pins || !groups || !names)return -ENOMEM ; +/* +* Initialize the array. GPIOs not listed in the 'gpios' array +* still need a number, but nothing else. +*/ for (i =0 ; i < num_gpios; i++) { -snprintf (names[i],NAME_SIZE ,"gpio%u" , i); - pins[i].number = i; - pins[i].name = names[i]; - - groups[i].npins =1 ; - groups[i].name = names[i]; groups[i].pins = &pins[i].number; + } - groups[i].ctl_reg =0x10000 * i; - groups[i].io_reg =0x04 +0x10000 * i; - groups[i].intr_cfg_reg =0x08 +0x10000 * i; - groups[i].intr_status_reg =0x0c +0x10000 * i; - groups[i].intr_target_reg =0x08 +0x10000 * i; - - groups[i].mux_bit =2 ; - groups[i].pull_bit =0 ; - groups[i].drv_bit =6 ; - groups[i].oe_bit =9 ; - groups[i].in_bit =0 ; - groups[i].out_bit =1 ; - groups[i].intr_enable_bit =0 ; - groups[i].intr_status_bit =0 ; - groups[i].intr_target_bit =5 ; - groups[i].intr_target_kpss_val =1 ; - groups[i].intr_raw_status_bit =4 ; - groups[i].intr_polarity_bit =1 ; - groups[i].intr_detection_bit =2 ; - groups[i].intr_detection_width =2 ; +/* Populate the entries that are meant to be exposes as GPIOs. */ +for (i =0 ; i < avail_gpios; i++) { +unsigned int gpio = gpios[i]; + + groups[gpio].npins =1 ; +snprintf (names[i],NAME_SIZE ,"gpio%u" , gpio); + pins[gpio].name = names[i]; + groups[gpio].name = names[i]; + + groups[gpio].ctl_reg =0x10000 * gpio; + groups[gpio].io_reg =0x04 +0x10000 * gpio; + groups[gpio].intr_cfg_reg =0x08 +0x10000 * gpio; + groups[gpio].intr_status_reg =0x0c +0x10000 * gpio; + groups[gpio].intr_target_reg =0x08 +0x10000 * gpio; + + groups[gpio].mux_bit =2 ; + groups[gpio].pull_bit =0 ; + groups[gpio].drv_bit =6 ; + groups[gpio].oe_bit =9 ; + groups[gpio].in_bit =0 ; + groups[gpio].out_bit =1 ; + groups[gpio].intr_enable_bit =0 ; + groups[gpio].intr_status_bit =0 ; + groups[gpio].intr_target_bit =5 ; + groups[gpio].intr_target_kpss_val =1 ; + groups[gpio].intr_raw_status_bit =4 ; + groups[gpio].intr_polarity_bit =1 ; + groups[gpio].intr_detection_bit =2 ; + groups[gpio].intr_detection_width =2 ; } +devm_kfree (&pdev->dev, gpios); + qdf2xxx_pinctrl.pins = pins; qdf2xxx_pinctrl.groups = groups; qdf2xxx_pinctrl.npins = num_gpios;
@@ -109,12 +186,6 @@ static int qdf2xxx_pinctrl_probe(struct platform_device *pdev)return msm_pinctrl_probe (pdev, &qdf2xxx_pinctrl); } -static const struct acpi_device_id qdf2xxx_acpi_ids[] = { - {"QCOM8001" }, - {}, -}; -MODULE_DEVICE_TABLE (acpi, qdf2xxx_acpi_ids); -static struct platform_driver qdf2xxx_pinctrl_driver = { .driver = { .name ="qdf2xxx-pinctrl" ,
Signature · 3 lines
Qualcomm Datacenter Technologies, Inc. as an affiliate of Qualcomm Technologies, Inc. Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.
PATCH v5 3/3 pinctrl: qcom: qdf2xxx: add support for new ACPI HID QCOM8002
Quoted 10 lines · Timur Tabi
Newer versions of the firmware for the Qualcomm Datacenter Technologies
QDF2400 restricts access to a subset of the GPIOs on the TLMM. To prevent older kernels from accidentally accessing the restricted GPIOs,
we change the ACPI HID for the TLMM block from QCOM8001 to QCOM8002, and introduce a new property "gpios". This property is an array of specific GPIOs that are accessible. When an older kernel boots on newer (restricted) firmware, it will fail to probe.
Quoted 7 lines
To implement the sparse GPIO map, we register all of the GPIOs, but set
the pin count for the unavailable GPIOs to zero. The pinctrl-msm driver will block those unavailable GPIOs from being accessed.To allow newer kernels to support older firmware, the driver retains support for QCOM8001.
Please, read my comments to v8, same applies here.
Signature · 2 lines
Andy Shevchenko <[email protected]> Intel Finland Oy