gpiolib-acpi.c 39.2 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8 9
/*
 * ACPI helpers for GPIO API
 *
 * Copyright (C) 2012, Intel Corporation
 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
 *          Mika Westerberg <mika.westerberg@linux.intel.com>
 */

10
#include <linux/dmi.h>
11
#include <linux/errno.h>
12
#include <linux/gpio/consumer.h>
13
#include <linux/gpio/driver.h>
14
#include <linux/gpio/machine.h>
15 16
#include <linux/export.h>
#include <linux/acpi.h>
17
#include <linux/interrupt.h>
18
#include <linux/mutex.h>
19
#include <linux/pinctrl/pinctrl.h>
20

21
#include "gpiolib.h"
22
#include "gpiolib-acpi.h"
23

24 25 26 27 28
static int run_edge_events_on_boot = -1;
module_param(run_edge_events_on_boot, int, 0444);
MODULE_PARM_DESC(run_edge_events_on_boot,
		 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");

29 30 31 32 33 34 35 36 37 38
static char *ignore_wake;
module_param(ignore_wake, charp, 0444);
MODULE_PARM_DESC(ignore_wake,
		 "controller@pin combos on which to ignore the ACPI wake flag "
		 "ignore_wake=controller@pin[,controller@pin[,...]]");

struct acpi_gpiolib_dmi_quirk {
	bool no_edge_events_on_boot;
	char *ignore_wake;
};
39

40 41 42 43 44
/**
 * struct acpi_gpio_event - ACPI GPIO event handler data
 *
 * @node:	  list-entry of the events list of the struct acpi_gpio_chip
 * @handle:	  handle of ACPI method to execute when the IRQ triggers
45 46 47 48
 * @handler:	  handler function to pass to request_irq() when requesting the IRQ
 * @pin:	  GPIO pin number on the struct gpio_chip
 * @irq:	  Linux IRQ number for the event, for request_irq() / free_irq()
 * @irqflags:	  flags to pass to request_irq() when requesting the IRQ
49
 * @irq_is_wake:  If the ACPI flags indicate the IRQ is a wakeup source
50 51
 * @irq_requested:True if request_irq() has been done
 * @desc:	  struct gpio_desc for the GPIO pin for this event
52
 */
53
struct acpi_gpio_event {
54
	struct list_head node;
55
	acpi_handle handle;
56
	irq_handler_t handler;
57 58
	unsigned int pin;
	unsigned int irq;
59 60 61
	unsigned long irqflags;
	bool irq_is_wake;
	bool irq_requested;
62
	struct gpio_desc *desc;
63 64
};

65 66
struct acpi_gpio_connection {
	struct list_head node;
67
	unsigned int pin;
68 69 70
	struct gpio_desc *desc;
};

71
struct acpi_gpio_chip {
72 73 74 75 76 77 78 79
	/*
	 * ACPICA requires that the first field of the context parameter
	 * passed to acpi_install_address_space_handler() is large enough
	 * to hold struct acpi_connection_info.
	 */
	struct acpi_connection_info conn_info;
	struct list_head conns;
	struct mutex conn_lock;
80
	struct gpio_chip *chip;
81
	struct list_head events;
82
	struct list_head deferred_req_irqs_list_entry;
83 84
};

85
/*
86
 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
87
 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
88 89
 * late_initcall_sync() handler, so that other builtin drivers can register their
 * OpRegions before the event handlers can run. This list contains GPIO chips
90
 * for which the acpi_gpiochip_request_irqs() call has been deferred.
91 92 93 94
 */
static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
static bool acpi_gpio_deferred_req_irqs_done;
95

96 97
static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
{
98
	if (!gc->parent)
99 100
		return false;

101
	return ACPI_HANDLE(gc->parent) == data;
102 103 104
}

/**
105
 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
106 107 108
 * @path:	ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
 * @pin:	ACPI GPIO pin number (0-based, controller-relative)
 *
109 110
 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
111
 * controller does not have GPIO chip registered at the moment. This is to
112
 * support probe deferral.
113
 */
114
static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
115 116 117 118 119 120 121
{
	struct gpio_chip *chip;
	acpi_handle handle;
	acpi_status status;

	status = acpi_get_handle(NULL, path, &handle);
	if (ACPI_FAILURE(status))
122
		return ERR_PTR(-ENODEV);
123 124 125

	chip = gpiochip_find(handle, acpi_gpiochip_find);
	if (!chip)
126
		return ERR_PTR(-EPROBE_DEFER);
127

128
	return gpiochip_get_desc(chip, pin);
129
}
130 131 132

static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
{
133
	struct acpi_gpio_event *event = data;
134

135
	acpi_evaluate_object(event->handle, NULL, NULL, NULL);
136 137 138 139

	return IRQ_HANDLED;
}

140 141
static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
{
142
	struct acpi_gpio_event *event = data;
143

144
	acpi_execute_simple_method(event->handle, NULL, event->pin);
145 146 147 148

	return IRQ_HANDLED;
}

149
static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
150 151 152 153
{
	/* The address of this function is used as a key. */
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
				struct acpi_resource_gpio **agpio)
{
	struct acpi_resource_gpio *gpio;

	if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
		return false;

	gpio = &ares->data.gpio;
	if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
		return false;

	*agpio = gpio;
	return true;
}
EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);

171 172 173 174 175 176
static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
				      struct acpi_gpio_event *event)
{
	int ret, value;

	ret = request_threaded_irq(event->irq, NULL, event->handler,
177
				   event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
178 179 180 181 182 183 184 185 186 187 188 189 190
	if (ret) {
		dev_err(acpi_gpio->chip->parent,
			"Failed to setup interrupt handler for %d\n",
			event->irq);
		return;
	}

	if (event->irq_is_wake)
		enable_irq_wake(event->irq);

	event->irq_requested = true;

	/* Make sure we trigger the initial state of edge-triggered IRQs */
191 192 193 194 195 196 197
	if (run_edge_events_on_boot &&
	    (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
		value = gpiod_get_raw_value_cansleep(event->desc);
		if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
		    ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
			event->handler(event->irq, event);
	}
198 199 200 201 202 203 204 205 206 207
}

static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
{
	struct acpi_gpio_event *event;

	list_for_each_entry(event, &acpi_gpio->events, node)
		acpi_gpiochip_request_irq(acpi_gpio, event);
}

208
static enum gpiod_flags
209
acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio, int polarity)
210
{
211 212 213 214
	/* GpioInt() implies input configuration */
	if (agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
		return GPIOD_IN;

215 216 217 218 219 220 221
	switch (agpio->io_restriction) {
	case ACPI_IO_RESTRICT_INPUT:
		return GPIOD_IN;
	case ACPI_IO_RESTRICT_OUTPUT:
		/*
		 * ACPI GPIO resources don't contain an initial value for the
		 * GPIO. Therefore we deduce that value from the pull field
222 223 224 225 226
		 * and the polarity instead. If the pin is pulled up we assume
		 * default to be high, if it is pulled down we assume default
		 * to be low, otherwise we leave pin untouched. For active low
		 * polarity values will be switched. See also
		 * Documentation/firmware-guide/acpi/gpio-properties.rst.
227 228 229
		 */
		switch (agpio->pin_config) {
		case ACPI_PIN_CONFIG_PULLUP:
230
			return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_LOW : GPIOD_OUT_HIGH;
231
		case ACPI_PIN_CONFIG_PULLDOWN:
232
			return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
233 234 235
		default:
			break;
		}
236
		break;
237 238 239 240 241 242 243 244 245 246 247
	default:
		break;
	}

	/*
	 * Assume that the BIOS has configured the direction and pull
	 * accordingly.
	 */
	return GPIOD_ASIS;
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
static struct gpio_desc *acpi_request_own_gpiod(struct gpio_chip *chip,
						struct acpi_resource_gpio *agpio,
						unsigned int index,
						const char *label)
{
	int polarity = GPIO_ACTIVE_HIGH;
	enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio, polarity);
	unsigned int pin = agpio->pin_table[index];
	struct gpio_desc *desc;
	int ret;

	desc = gpiochip_request_own_desc(chip, pin, label, polarity, flags);
	if (IS_ERR(desc))
		return desc;

	ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout);
	if (ret)
		gpiochip_free_own_desc(desc);

	return ret ? ERR_PTR(ret) : desc;
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
{
	const char *controller, *pin_str;
	int len, pin;
	char *endp;

	controller = ignore_wake;
	while (controller) {
		pin_str = strchr(controller, '@');
		if (!pin_str)
			goto err;

		len = pin_str - controller;
		if (len == strlen(controller_in) &&
		    strncmp(controller, controller_in, len) == 0) {
			pin = simple_strtoul(pin_str + 1, &endp, 10);
			if (*endp != 0 && *endp != ',')
				goto err;

			if (pin == pin_in)
				return true;
		}

		controller = strchr(controller, ',');
		if (controller)
			controller++;
	}

	return false;
err:
	pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
		    ignore_wake);
	return false;
}

static bool acpi_gpio_irq_is_wake(struct device *parent,
				  struct acpi_resource_gpio *agpio)
{
	int pin = agpio->pin_table[0];

	if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
		return false;

	if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
		dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
		return false;
	}

	return true;
}

321
/* Always returns AE_OK so that we keep looping over the resources */
322 323
static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
					     void *context)
324
{
325
	struct acpi_gpio_chip *acpi_gpio = context;
326
	struct gpio_chip *chip = acpi_gpio->chip;
327
	struct acpi_resource_gpio *agpio;
328
	acpi_handle handle, evt_handle;
329 330 331
	struct acpi_gpio_event *event;
	irq_handler_t handler = NULL;
	struct gpio_desc *desc;
332
	int ret, pin, irq;
333

334
	if (!acpi_gpio_get_irq_resource(ares, &agpio))
335
		return AE_OK;
336

337
	handle = ACPI_HANDLE(chip->parent);
338 339 340 341
	pin = agpio->pin_table[0];

	if (pin <= 255) {
		char ev_name[5];
342
		sprintf(ev_name, "_%c%02hhX",
343 344 345 346 347 348 349 350 351 352
			agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
			pin);
		if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
			handler = acpi_gpio_irq_handler;
	}
	if (!handler) {
		if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
			handler = acpi_gpio_irq_handler_evt;
	}
	if (!handler)
353
		return AE_OK;
354

355
	desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
356
	if (IS_ERR(desc)) {
357 358 359
		dev_err(chip->parent,
			"Failed to request GPIO for pin 0x%04X, err %ld\n",
			pin, PTR_ERR(desc));
360
		return AE_OK;
361
	}
362

363
	ret = gpiochip_lock_as_irq(chip, pin);
364
	if (ret) {
365 366 367
		dev_err(chip->parent,
			"Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
			pin, ret);
368 369
		goto fail_free_desc;
	}
370

371 372
	irq = gpiod_to_irq(desc);
	if (irq < 0) {
373 374 375
		dev_err(chip->parent,
			"Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
			pin, irq);
376 377
		goto fail_unlock_irq;
	}
378

379 380 381 382 383
	event = kzalloc(sizeof(*event), GFP_KERNEL);
	if (!event)
		goto fail_unlock_irq;

	event->irqflags = IRQF_ONESHOT;
384 385
	if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
		if (agpio->polarity == ACPI_ACTIVE_HIGH)
386
			event->irqflags |= IRQF_TRIGGER_HIGH;
387
		else
388
			event->irqflags |= IRQF_TRIGGER_LOW;
389 390 391
	} else {
		switch (agpio->polarity) {
		case ACPI_ACTIVE_HIGH:
392
			event->irqflags |= IRQF_TRIGGER_RISING;
393 394
			break;
		case ACPI_ACTIVE_LOW:
395
			event->irqflags |= IRQF_TRIGGER_FALLING;
396 397
			break;
		default:
398 399
			event->irqflags |= IRQF_TRIGGER_RISING |
					   IRQF_TRIGGER_FALLING;
400
			break;
401
		}
402
	}
403

404
	event->handle = evt_handle;
405
	event->handler = handler;
406
	event->irq = irq;
407
	event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
408
	event->pin = pin;
409
	event->desc = desc;
410

411
	list_add_tail(&event->node, &acpi_gpio->events);
412

413 414 415
	return AE_OK;

fail_unlock_irq:
416
	gpiochip_unlock_as_irq(chip, pin);
417 418 419
fail_free_desc:
	gpiochip_free_own_desc(desc);

420
	return AE_OK;
421
}
422

423
/**
424
 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
425
 * @chip:      GPIO chip
426
 *
427 428
 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
 * handled by ACPI event methods which need to be called from the GPIO
429 430 431
 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
 * the ACPI event methods for those pins.
432
 */
433
void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
434
{
435 436 437
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;
438
	bool defer;
439

440
	if (!chip->parent || !chip->to_irq)
441
		return;
442

443
	handle = ACPI_HANDLE(chip->parent);
444 445 446 447 448
	if (!handle)
		return;

	status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
	if (ACPI_FAILURE(status))
449 450
		return;

451 452 453
	acpi_walk_resources(handle, "_AEI",
			    acpi_gpiochip_alloc_event, acpi_gpio);

454 455 456 457 458 459 460 461 462 463
	mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
	defer = !acpi_gpio_deferred_req_irqs_done;
	if (defer)
		list_add(&acpi_gpio->deferred_req_irqs_list_entry,
			 &acpi_gpio_deferred_req_irqs_list);
	mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);

	if (defer)
		return;

464
	acpi_gpiochip_request_irqs(acpi_gpio);
465
}
466
EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
467 468 469

/**
 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
470
 * @chip:      GPIO chip
471
 *
472 473
 * Free interrupts associated with GPIO ACPI event method for the given
 * GPIO chip.
474
 */
475
void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
476
{
477
	struct acpi_gpio_chip *acpi_gpio;
478
	struct acpi_gpio_event *event, *ep;
479 480 481
	acpi_handle handle;
	acpi_status status;

482
	if (!chip->parent || !chip->to_irq)
483
		return;
484

485
	handle = ACPI_HANDLE(chip->parent);
486 487 488 489 490
	if (!handle)
		return;

	status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
	if (ACPI_FAILURE(status))
491 492
		return;

493 494 495 496 497
	mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
	if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
		list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
	mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);

498
	list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
499 500 501 502 503 504
		if (event->irq_requested) {
			if (event->irq_is_wake)
				disable_irq_wake(event->irq);

			free_irq(event->irq, event);
		}
505

506
		gpiochip_unlock_as_irq(chip, event->pin);
507
		gpiochip_free_own_desc(event->desc);
508 509
		list_del(&event->node);
		kfree(event);
510 511
	}
}
512
EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
513

514 515 516 517 518 519 520 521 522 523 524
int acpi_dev_add_driver_gpios(struct acpi_device *adev,
			      const struct acpi_gpio_mapping *gpios)
{
	if (adev && gpios) {
		adev->driver_gpios = gpios;
		return 0;
	}
	return -EINVAL;
}
EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);

525 526 527 528 529 530 531
void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
{
	if (adev)
		adev->driver_gpios = NULL;
}
EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
{
	acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
}

int devm_acpi_dev_add_driver_gpios(struct device *dev,
				   const struct acpi_gpio_mapping *gpios)
{
	void *res;
	int ret;

	res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
	if (!res)
		return -ENOMEM;

	ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
	if (ret) {
		devres_free(res);
		return ret;
	}
	devres_add(dev, res);
	return 0;
}
EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);

void devm_acpi_dev_remove_driver_gpios(struct device *dev)
{
	WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
}
EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);

563 564
static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
				      const char *name, int index,
565
				      struct fwnode_reference_args *args,
566
				      unsigned int *quirks)
567 568 569 570 571 572 573 574 575 576
{
	const struct acpi_gpio_mapping *gm;

	if (!adev->driver_gpios)
		return false;

	for (gm = adev->driver_gpios; gm->name; gm++)
		if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
			const struct acpi_gpio_params *par = gm->data + index;

577
			args->fwnode = acpi_fwnode_handle(adev);
578 579 580 581
			args->args[0] = par->crs_entry_index;
			args->args[1] = par->line_index;
			args->args[2] = par->active_low;
			args->nargs = 3;
582 583

			*quirks = gm->quirks;
584 585 586 587 588 589
			return true;
		}

	return false;
}

590 591
static int
__acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
592
{
593 594 595
	const enum gpiod_flags mask =
		GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
		GPIOD_FLAGS_BIT_DIR_VAL;
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	int ret = 0;

	/*
	 * Check if the BIOS has IoRestriction with explicitly set direction
	 * and update @flags accordingly. Otherwise use whatever caller asked
	 * for.
	 */
	if (update & GPIOD_FLAGS_BIT_DIR_SET) {
		enum gpiod_flags diff = *flags ^ update;

		/*
		 * Check if caller supplied incompatible GPIO initialization
		 * flags.
		 *
		 * Return %-EINVAL to notify that firmware has different
		 * settings and we are going to use them.
		 */
		if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
		    ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
			ret = -EINVAL;
616
		*flags = (*flags & ~mask) | (update & mask);
617 618 619 620
	}
	return ret;
}

621 622 623 624
int
acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
{
	struct device *dev = &info->adev->dev;
625
	enum gpiod_flags old = *flags;
626 627
	int ret;

628 629 630 631 632 633 634 635 636
	ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
	if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
		if (ret)
			dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
	} else {
		if (ret)
			dev_dbg(dev, "Override GPIO initialization flags\n");
		*flags = old;
	}
637 638 639 640

	return ret;
}

641 642 643
int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
					struct acpi_gpio_info *info)
{
644 645 646 647 648 649 650 651 652 653 654
	switch (info->pin_config) {
	case ACPI_PIN_CONFIG_PULLUP:
		*lookupflags |= GPIO_PULL_UP;
		break;
	case ACPI_PIN_CONFIG_PULLDOWN:
		*lookupflags |= GPIO_PULL_DOWN;
		break;
	default:
		break;
	}

655 656 657 658 659 660
	if (info->polarity == GPIO_ACTIVE_LOW)
		*lookupflags |= GPIO_ACTIVE_LOW;

	return 0;
}

661 662 663
struct acpi_gpio_lookup {
	struct acpi_gpio_info info;
	int index;
664
	u16 pin_index;
665
	bool active_low;
666
	struct gpio_desc *desc;
667 668 669
	int n;
};

670
static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
671 672 673 674 675 676
{
	struct acpi_gpio_lookup *lookup = data;

	if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
		return 1;

677
	if (!lookup->desc) {
678
		const struct acpi_resource_gpio *agpio = &ares->data.gpio;
679
		bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
680
		struct gpio_desc *desc;
681
		u16 pin_index;
682

683 684 685 686 687 688 689
		if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
			lookup->index++;

		if (lookup->n++ != lookup->index)
			return 1;

		pin_index = lookup->pin_index;
690 691
		if (pin_index >= agpio->pin_table_length)
			return 1;
692

693 694 695 696
		if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
			desc = gpio_to_desc(agpio->pin_table[pin_index]);
		else
			desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
697
					      agpio->pin_table[pin_index]);
698
		lookup->desc = desc;
699
		lookup->info.pin_config = agpio->pin_config;
700
		lookup->info.debounce = agpio->debounce_timeout;
701
		lookup->info.gpioint = gpioint;
702 703

		/*
704 705
		 * Polarity and triggering are only specified for GpioInt
		 * resource.
706 707 708
		 * Note: we expect here:
		 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
		 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
709
		 */
710 711 712
		if (lookup->info.gpioint) {
			lookup->info.polarity = agpio->polarity;
			lookup->info.triggering = agpio->triggering;
713
		} else {
714
			lookup->info.polarity = lookup->active_low;
715
		}
716 717

		lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
718 719 720 721 722
	}

	return 1;
}

723 724 725
static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
				     struct acpi_gpio_info *info)
{
726
	struct acpi_device *adev = lookup->info.adev;
727 728 729 730 731
	struct list_head res_list;
	int ret;

	INIT_LIST_HEAD(&res_list);

732
	ret = acpi_dev_get_resources(adev, &res_list,
733
				     acpi_populate_gpio_lookup,
734 735 736 737 738 739 740 741 742
				     lookup);
	if (ret < 0)
		return ret;

	acpi_dev_free_resource_list(&res_list);

	if (!lookup->desc)
		return -ENOENT;

743
	if (info)
744 745 746 747
		*info = lookup->info;
	return 0;
}

748
static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
749 750 751
				     const char *propname, int index,
				     struct acpi_gpio_lookup *lookup)
{
752
	struct fwnode_reference_args args;
753
	unsigned int quirks = 0;
754 755 756
	int ret;

	memset(&args, 0, sizeof(args));
757 758
	ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
						 &args);
759 760
	if (ret) {
		struct acpi_device *adev = to_acpi_device_node(fwnode);
761

762 763 764
		if (!adev)
			return ret;

765 766
		if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
					       &quirks))
767 768
			return ret;
	}
769 770 771 772
	/*
	 * The property was found and resolved, so need to lookup the GPIO based
	 * on returned args.
	 */
773 774
	if (!to_acpi_device_node(args.fwnode))
		return -EINVAL;
775 776 777 778 779 780 781
	if (args.nargs != 3)
		return -EPROTO;

	lookup->index = args.args[0];
	lookup->pin_index = args.args[1];
	lookup->active_low = !!args.args[2];

782
	lookup->info.adev = to_acpi_device_node(args.fwnode);
783
	lookup->info.quirks = quirks;
784

785 786 787
	return 0;
}

788
/**
789
 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
790 791
 * @adev: pointer to a ACPI device to get GPIO from
 * @propname: Property name of the GPIO (optional)
792 793 794
 * @index: index of GpioIo/GpioInt resource (starting from %0)
 * @info: info pointer to fill in (optional)
 *
795
 * Function goes through ACPI resources for @adev and based on @index looks
796
 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
797 798 799
 * and returns it. @index matches GpioIo/GpioInt resources only so if there
 * are total %3 GPIO resources, the index goes from %0 to %2.
 *
800 801 802 803
 * If @propname is specified the GPIO is looked using device property. In
 * that case @index is used to select the GPIO entry in the property value
 * (in case of multiple).
 *
804
 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
805 806 807 808 809
 * returned.
 *
 * Note: if the GPIO resource has multiple entries in the pin list, this
 * function only returns the first.
 */
810
static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
811
					  const char *propname, int index,
812
					  struct acpi_gpio_info *info)
813 814 815 816
{
	struct acpi_gpio_lookup lookup;
	int ret;

817
	if (!adev)
818
		return ERR_PTR(-ENODEV);
819 820 821 822

	memset(&lookup, 0, sizeof(lookup));
	lookup.index = index;

823 824 825
	if (propname) {
		dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);

826 827
		ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
						propname, index, &lookup);
828 829
		if (ret)
			return ERR_PTR(ret);
830

831
		dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
832
			dev_name(&lookup.info.adev->dev), lookup.index,
833
			lookup.pin_index, lookup.active_low);
834 835
	} else {
		dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
836
		lookup.info.adev = adev;
837 838
	}

839 840
	ret = acpi_gpio_resource_lookup(&lookup, info);
	return ret ? ERR_PTR(ret) : lookup.desc;
841
}
842

843 844 845 846 847 848 849 850 851 852
static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
				     const char *con_id)
{
	/* Never allow fallback if the device has properties */
	if (acpi_dev_has_props(adev) || adev->driver_gpios)
		return false;

	return con_id == NULL;
}

853 854 855
struct gpio_desc *acpi_find_gpio(struct device *dev,
				 const char *con_id,
				 unsigned int idx,
856
				 enum gpiod_flags *dflags,
857
				 unsigned long *lookupflags)
858 859 860 861 862 863 864 865 866
{
	struct acpi_device *adev = ACPI_COMPANION(dev);
	struct acpi_gpio_info info;
	struct gpio_desc *desc;
	char propname[32];
	int i;

	/* Try first from _DSD */
	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
867
		if (con_id) {
868 869 870 871 872 873 874 875
			snprintf(propname, sizeof(propname), "%s-%s",
				 con_id, gpio_suffixes[i]);
		} else {
			snprintf(propname, sizeof(propname), "%s",
				 gpio_suffixes[i]);
		}

		desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
876
		if (!IS_ERR(desc))
877
			break;
878 879
		if (PTR_ERR(desc) == -EPROBE_DEFER)
			return ERR_CAST(desc);
880 881 882 883 884 885 886 887 888 889
	}

	/* Then from plain _CRS GPIOs */
	if (IS_ERR(desc)) {
		if (!acpi_can_fallback_to_crs(adev, con_id))
			return ERR_PTR(-ENOENT);

		desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
		if (IS_ERR(desc))
			return desc;
890
	}
891

892
	if (info.gpioint &&
893
	    (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
894 895
		dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
		return ERR_PTR(-ENOENT);
896 897
	}

898
	acpi_gpio_update_gpiod_flags(dflags, &info);
899
	acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
900 901 902
	return desc;
}

903 904 905 906 907 908 909
/**
 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
 * @propname: Property name of the GPIO
 * @index: index of GpioIo/GpioInt resource (starting from %0)
 * @info: info pointer to fill in (optional)
 *
910 911
 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
 * Otherwise (i.e. it is a data-only non-device object), use the property-based
912 913
 * GPIO lookup to get to the GPIO resource with the relevant information and use
 * that to obtain the GPIO descriptor to return.
914 915 916
 *
 * If the GPIO cannot be translated or there is an error an ERR_PTR is
 * returned.
917 918 919 920 921 922 923 924
 */
struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
				      const char *propname, int index,
				      struct acpi_gpio_info *info)
{
	struct acpi_gpio_lookup lookup;
	struct acpi_device *adev;
	int ret;
925

926 927 928
	adev = to_acpi_device_node(fwnode);
	if (adev)
		return acpi_get_gpiod_by_index(adev, propname, index, info);
929

930 931 932 933 934 935 936 937 938 939 940 941
	if (!is_acpi_data_node(fwnode))
		return ERR_PTR(-ENODEV);

	if (!propname)
		return ERR_PTR(-EINVAL);

	memset(&lookup, 0, sizeof(lookup));
	lookup.index = index;

	ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
	if (ret)
		return ERR_PTR(ret);
942

943 944
	ret = acpi_gpio_resource_lookup(&lookup, info);
	return ret ? ERR_PTR(ret) : lookup.desc;
945
}
946

947
/**
948
 * acpi_dev_gpio_irq_get_by() - Find GpioInt and translate it to Linux IRQ number
949
 * @adev: pointer to a ACPI device to get IRQ from
950
 * @name: optional name of GpioInt resource
951 952 953 954 955 956
 * @index: index of GpioInt resource (starting from %0)
 *
 * If the device has one or more GpioInt resources, this function can be
 * used to translate from the GPIO offset in the resource to the Linux IRQ
 * number.
 *
957 958 959
 * The function is idempotent, though each time it runs it will configure GPIO
 * pin direction according to the flags in GpioInt resource.
 *
960 961 962
 * The function takes optional @name parameter. If the resource has a property
 * name, then only those will be taken into account.
 *
963
 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
964
 */
965
int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index)
966 967
{
	int idx, i;
968
	unsigned int irq_flags;
969
	int ret;
970 971 972 973 974

	for (i = 0, idx = 0; idx <= index; i++) {
		struct acpi_gpio_info info;
		struct gpio_desc *desc;

975
		desc = acpi_get_gpiod_by_index(adev, name, i, &info);
976 977 978 979 980

		/* Ignore -EPROBE_DEFER, it only matters if idx matches */
		if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
			return PTR_ERR(desc);

981
		if (info.gpioint && idx++ == index) {
982
			unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
983
			enum gpiod_flags dflags = GPIOD_ASIS;
984
			char label[32];
985
			int irq;
986

987 988
			if (IS_ERR(desc))
				return PTR_ERR(desc);
989

990
			irq = gpiod_to_irq(desc);
991 992 993
			if (irq < 0)
				return irq;

994 995 996
			acpi_gpio_update_gpiod_flags(&dflags, &info);
			acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);

997
			snprintf(label, sizeof(label), "GpioInt() %d", index);
998
			ret = gpiod_configure_flags(desc, label, lflags, dflags);
999 1000 1001
			if (ret < 0)
				return ret;

1002 1003 1004 1005
			ret = gpio_set_debounce_timeout(desc, info.debounce);
			if (ret)
				return ret;

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
			irq_flags = acpi_dev_get_irq_type(info.triggering,
							  info.polarity);

			/* Set type if specified and different than the current one */
			if (irq_flags != IRQ_TYPE_NONE &&
			    irq_flags != irq_get_trigger_type(irq))
				irq_set_irq_type(irq, irq_flags);

			return irq;
		}

1017
	}
1018
	return -ENOENT;
1019
}
1020
EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get_by);
1021

1022 1023 1024 1025 1026 1027 1028 1029 1030
static acpi_status
acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
			    u32 bits, u64 *value, void *handler_context,
			    void *region_context)
{
	struct acpi_gpio_chip *achip = region_context;
	struct gpio_chip *chip = achip->chip;
	struct acpi_resource_gpio *agpio;
	struct acpi_resource *ares;
1031
	u16 pin_index = address;
1032
	acpi_status status;
1033
	int length;
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
	int i;

	status = acpi_buffer_to_resource(achip->conn_info.connection,
					 achip->conn_info.length, &ares);
	if (ACPI_FAILURE(status))
		return status;

	if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
		ACPI_FREE(ares);
		return AE_BAD_PARAMETER;
	}

	agpio = &ares->data.gpio;

	if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
	    function == ACPI_WRITE)) {
		ACPI_FREE(ares);
		return AE_BAD_PARAMETER;
	}

1054
	length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1055
	for (i = pin_index; i < length; ++i) {
1056
		int pin = agpio->pin_table[i];
1057 1058 1059 1060 1061 1062 1063 1064
		struct acpi_gpio_connection *conn;
		struct gpio_desc *desc;
		bool found;

		mutex_lock(&achip->conn_lock);

		found = false;
		list_for_each_entry(conn, &achip->conns, node) {
1065
			if (conn->pin == pin) {
1066
				found = true;
1067
				desc = conn->desc;
1068 1069 1070
				break;
			}
		}
1071 1072 1073 1074 1075 1076

		/*
		 * The same GPIO can be shared between operation region and
		 * event but only if the access here is ACPI_READ. In that
		 * case we "borrow" the event GPIO instead.
		 */
1077
		if (!found && agpio->shareable == ACPI_SHARED &&
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
		     function == ACPI_READ) {
			struct acpi_gpio_event *event;

			list_for_each_entry(event, &achip->events, node) {
				if (event->pin == pin) {
					desc = event->desc;
					found = true;
					break;
				}
			}
		}

1090
		if (!found) {
1091
			desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1092
			if (IS_ERR(desc)) {
1093
				mutex_unlock(&achip->conn_lock);
1094
				status = AE_ERROR;
1095 1096 1097 1098 1099 1100 1101
				goto out;
			}

			conn = kzalloc(sizeof(*conn), GFP_KERNEL);
			if (!conn) {
				gpiochip_free_own_desc(desc);
				mutex_unlock(&achip->conn_lock);
1102
				status = AE_NO_MEMORY;
1103 1104 1105
				goto out;
			}

1106
			conn->pin = pin;
1107 1108 1109 1110 1111 1112 1113
			conn->desc = desc;
			list_add_tail(&conn->node, &achip->conns);
		}

		mutex_unlock(&achip->conn_lock);

		if (function == ACPI_WRITE)
1114
			gpiod_set_raw_value_cansleep(desc, !!(*value & BIT(i)));
1115
		else
1116
			*value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
	}

out:
	ACPI_FREE(ares);
	return status;
}

static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
{
	struct gpio_chip *chip = achip->chip;
1127
	acpi_handle handle = ACPI_HANDLE(chip->parent);
1128 1129 1130 1131 1132 1133 1134 1135
	acpi_status status;

	INIT_LIST_HEAD(&achip->conns);
	mutex_init(&achip->conn_lock);
	status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
						    acpi_gpio_adr_space_handler,
						    NULL, achip);
	if (ACPI_FAILURE(status))
1136 1137
		dev_err(chip->parent,
		        "Failed to install GPIO OpRegion handler\n");
1138 1139 1140 1141 1142
}

static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
{
	struct gpio_chip *chip = achip->chip;
1143
	acpi_handle handle = ACPI_HANDLE(chip->parent);
1144 1145 1146 1147 1148 1149
	struct acpi_gpio_connection *conn, *tmp;
	acpi_status status;

	status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
						   acpi_gpio_adr_space_handler);
	if (ACPI_FAILURE(status)) {
1150 1151
		dev_err(chip->parent,
			"Failed to remove GPIO OpRegion handler\n");
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
		return;
	}

	list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
		gpiochip_free_own_desc(conn->desc);
		list_del(&conn->node);
		kfree(conn);
	}
}

1162 1163 1164 1165 1166
static struct gpio_desc *
acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
			     struct fwnode_handle *fwnode,
			     const char **name,
			     unsigned long *lflags,
1167
			     enum gpiod_flags *dflags)
1168 1169 1170 1171 1172 1173
{
	struct gpio_chip *chip = achip->chip;
	struct gpio_desc *desc;
	u32 gpios[2];
	int ret;

1174
	*lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1175
	*dflags = GPIOD_ASIS;
1176 1177
	*name = NULL;

1178 1179 1180 1181 1182
	ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
					     ARRAY_SIZE(gpios));
	if (ret < 0)
		return ERR_PTR(ret);

1183
	desc = gpiochip_get_desc(chip, gpios[0]);
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
	if (IS_ERR(desc))
		return desc;

	if (gpios[1])
		*lflags |= GPIO_ACTIVE_LOW;

	if (fwnode_property_present(fwnode, "input"))
		*dflags |= GPIOD_IN;
	else if (fwnode_property_present(fwnode, "output-low"))
		*dflags |= GPIOD_OUT_LOW;
	else if (fwnode_property_present(fwnode, "output-high"))
		*dflags |= GPIOD_OUT_HIGH;
	else
		return ERR_PTR(-EINVAL);

	fwnode_property_read_string(fwnode, "line-name", name);

	return desc;
}

static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
{
	struct gpio_chip *chip = achip->chip;
	struct fwnode_handle *fwnode;

	device_for_each_child_node(chip->parent, fwnode) {
1210
		unsigned long lflags;
1211
		enum gpiod_flags dflags;
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
		struct gpio_desc *desc;
		const char *name;
		int ret;

		if (!fwnode_property_present(fwnode, "gpio-hog"))
			continue;

		desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
						    &lflags, &dflags);
		if (IS_ERR(desc))
			continue;

		ret = gpiod_hog(desc, name, lflags, dflags);
		if (ret) {
			dev_err(chip->parent, "Failed to hog GPIO\n");
1227
			fwnode_handle_put(fwnode);
1228 1229 1230 1231 1232
			return;
		}
	}
}

1233 1234
void acpi_gpiochip_add(struct gpio_chip *chip)
{
1235 1236 1237 1238
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;

1239
	if (!chip || !chip->parent)
1240 1241
		return;

1242
	handle = ACPI_HANDLE(chip->parent);
1243 1244 1245 1246 1247
	if (!handle)
		return;

	acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
	if (!acpi_gpio) {
1248
		dev_err(chip->parent,
1249 1250 1251 1252 1253
			"Failed to allocate memory for ACPI GPIO chip\n");
		return;
	}

	acpi_gpio->chip = chip;
1254
	INIT_LIST_HEAD(&acpi_gpio->events);
1255
	INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1256 1257 1258

	status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
	if (ACPI_FAILURE(status)) {
1259
		dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1260 1261 1262 1263
		kfree(acpi_gpio);
		return;
	}

1264
	acpi_gpiochip_request_regions(acpi_gpio);
1265
	acpi_gpiochip_scan_gpios(acpi_gpio);
1266
	acpi_walk_dep_device_list(handle);
1267 1268 1269 1270
}

void acpi_gpiochip_remove(struct gpio_chip *chip)
{
1271 1272 1273 1274
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;

1275
	if (!chip || !chip->parent)
1276 1277
		return;

1278
	handle = ACPI_HANDLE(chip->parent);
1279 1280 1281 1282 1283
	if (!handle)
		return;

	status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
	if (ACPI_FAILURE(status)) {
1284
		dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1285 1286 1287
		return;
	}

1288
	acpi_gpiochip_free_regions(acpi_gpio);
1289 1290 1291

	acpi_detach_data(handle, acpi_gpio_chip_dh);
	kfree(acpi_gpio);
1292
}
1293

1294
static int acpi_gpio_package_count(const union acpi_object *obj)
1295 1296 1297 1298 1299 1300
{
	const union acpi_object *element = obj->package.elements;
	const union acpi_object *end = element + obj->package.count;
	unsigned int count = 0;

	while (element < end) {
1301 1302 1303
		switch (element->type) {
		case ACPI_TYPE_LOCAL_REFERENCE:
			element += 3;
1304
			fallthrough;
1305 1306
		case ACPI_TYPE_INTEGER:
			element++;
1307
			count++;
1308
			break;
1309

1310 1311 1312
		default:
			return -EPROTO;
		}
1313
	}
1314

1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
	return count;
}

static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
{
	unsigned int *count = data;

	if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
		*count += ares->data.gpio.pin_table_length;

	return 1;
}

/**
1329 1330
 * acpi_gpio_count - count the GPIOs associated with a device / function
 * @dev:	GPIO consumer, can be %NULL for system-global GPIOs
1331
 * @con_id:	function within the GPIO consumer
1332 1333 1334 1335
 *
 * Return:
 * The number of GPIOs associated with a device / function or %-ENOENT,
 * if no GPIO has been assigned to the requested function.
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
 */
int acpi_gpio_count(struct device *dev, const char *con_id)
{
	struct acpi_device *adev = ACPI_COMPANION(dev);
	const union acpi_object *obj;
	const struct acpi_gpio_mapping *gm;
	int count = -ENOENT;
	int ret;
	char propname[32];
	unsigned int i;

	/* Try first from _DSD */
	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1349
		if (con_id)
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
			snprintf(propname, sizeof(propname), "%s-%s",
				 con_id, gpio_suffixes[i]);
		else
			snprintf(propname, sizeof(propname), "%s",
				 gpio_suffixes[i]);

		ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
					    &obj);
		if (ret == 0) {
			if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
				count = 1;
			else if (obj->type == ACPI_TYPE_PACKAGE)
				count = acpi_gpio_package_count(obj);
		} else if (adev->driver_gpios) {
			for (gm = adev->driver_gpios; gm->name; gm++)
				if (strcmp(propname, gm->name) == 0) {
					count = gm->size;
					break;
				}
		}
1370
		if (count > 0)
1371 1372 1373 1374 1375 1376 1377 1378
			break;
	}

	/* Then from plain _CRS GPIOs */
	if (count < 0) {
		struct list_head resource_list;
		unsigned int crs_count = 0;

1379 1380 1381
		if (!acpi_can_fallback_to_crs(adev, con_id))
			return count;

1382 1383 1384 1385 1386 1387 1388
		INIT_LIST_HEAD(&resource_list);
		acpi_dev_get_resources(adev, &resource_list,
				       acpi_find_gpio_count, &crs_count);
		acpi_dev_free_resource_list(&resource_list);
		if (crs_count > 0)
			count = crs_count;
	}
1389
	return count ? count : -ENOENT;
1390
}
1391

1392
/* Run deferred acpi_gpiochip_request_irqs() */
1393
static int __init acpi_gpio_handle_deferred_request_irqs(void)
1394
{
1395 1396 1397 1398 1399
	struct acpi_gpio_chip *acpi_gpio, *tmp;

	mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
	list_for_each_entry_safe(acpi_gpio, tmp,
				 &acpi_gpio_deferred_req_irqs_list,
1400 1401
				 deferred_req_irqs_list_entry)
		acpi_gpiochip_request_irqs(acpi_gpio);
1402 1403 1404

	acpi_gpio_deferred_req_irqs_done = true;
	mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1405 1406 1407 1408

	return 0;
}
/* We must use _sync so that this runs after the first deferred_probe run */
1409
late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1410

1411
static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1412
	{
1413 1414 1415 1416 1417
		/*
		 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
		 * a non existing micro-USB-B connector which puts the HDMI
		 * DDC pins in GPIO mode, breaking HDMI support.
		 */
1418 1419 1420
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
			DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1421
		},
1422 1423 1424
		.driver_data = &(struct acpi_gpiolib_dmi_quirk) {
			.no_edge_events_on_boot = true,
		},
1425
	},
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
	{
		/*
		 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
		 * instead of controlling the actual micro-USB-B turns the 5V
		 * boost for its USB-A connector off. The actual micro-USB-B
		 * connector is wired for charging only.
		 */
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
			DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1436
		},
1437 1438 1439
		.driver_data = &(struct acpi_gpiolib_dmi_quirk) {
			.no_edge_events_on_boot = true,
		},
1440
	},
1441 1442
	{
		/*
1443 1444 1445 1446 1447 1448 1449 1450
		 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
		 * external embedded-controller connected via I2C + an ACPI GPIO
		 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
		 * When suspending by closing the LID, the power to the USB
		 * keyboard is turned off, causing INT0002 ACPI events to
		 * trigger once the XHCI controller notices the keyboard is
		 * gone. So INT0002 events cause spurious wakeups too. Ignoring
		 * EC wakes breaks wakeup when opening the lid, the user needs
1451 1452 1453 1454 1455 1456 1457
		 * to press the power-button to wakeup the system. The
		 * alternative is suspend simply not working, which is worse.
		 */
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "HP"),
			DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
		},
1458 1459 1460
		.driver_data = &(struct acpi_gpiolib_dmi_quirk) {
			.ignore_wake = "INT33FF:01@0,INT0002:00@2",
		},
1461
	},
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
	{
		/*
		 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
		 * external embedded-controller connected via I2C + an ACPI GPIO
		 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
		 */
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
			DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
			DMI_MATCH(DMI_BOARD_NAME, "815D"),
		},
		.driver_data = &(struct acpi_gpiolib_dmi_quirk) {
			.ignore_wake = "INT33FC:02@28",
		},
	},
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
	{
		/*
		 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
		 * external embedded-controller connected via I2C + an ACPI GPIO
		 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
		 */
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "HP"),
			DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
			DMI_MATCH(DMI_BOARD_NAME, "813E"),
		},
		.driver_data = &(struct acpi_gpiolib_dmi_quirk) {
			.ignore_wake = "INT33FF:01@0",
		},
	},
1492 1493 1494
	{} /* Terminating entry */
};

1495
static int __init acpi_gpio_setup_params(void)
1496
{
1497
	const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1498 1499 1500 1501
	const struct dmi_system_id *id;

	id = dmi_first_match(gpiolib_acpi_quirks);
	if (id)
1502
		quirk = id->driver_data;
1503

1504
	if (run_edge_events_on_boot < 0) {
1505
		if (quirk && quirk->no_edge_events_on_boot)
1506 1507 1508 1509 1510
			run_edge_events_on_boot = 0;
		else
			run_edge_events_on_boot = 1;
	}

1511 1512
	if (ignore_wake == NULL && quirk && quirk->ignore_wake)
		ignore_wake = quirk->ignore_wake;
1513

1514 1515 1516 1517 1518
	return 0;
}

/* Directly after dmi_setup() which runs as core_initcall() */
postcore_initcall(acpi_gpio_setup_params);