gpiolib-acpi.c 19.7 KB
Newer Older
M
Mathias Nyman 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * 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>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/errno.h>
14
#include <linux/gpio.h>
15
#include <linux/gpio/consumer.h>
16
#include <linux/gpio/driver.h>
M
Mathias Nyman 已提交
17 18
#include <linux/export.h>
#include <linux/acpi.h>
19
#include <linux/interrupt.h>
20
#include <linux/mutex.h>
21
#include <linux/pinctrl/pinctrl.h>
M
Mathias Nyman 已提交
22

23 24
#include "gpiolib.h"

25
struct acpi_gpio_event {
26
	struct list_head node;
27
	acpi_handle handle;
28 29
	unsigned int pin;
	unsigned int irq;
30
	struct gpio_desc *desc;
31 32
};

33 34
struct acpi_gpio_connection {
	struct list_head node;
35
	unsigned int pin;
36 37 38
	struct gpio_desc *desc;
};

39
struct acpi_gpio_chip {
40 41 42 43 44 45 46 47
	/*
	 * 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;
48
	struct gpio_chip *chip;
49
	struct list_head events;
50 51
};

M
Mathias Nyman 已提交
52 53 54 55 56 57 58 59
static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
{
	if (!gc->dev)
		return false;

	return ACPI_HANDLE(gc->dev) == data;
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
#ifdef CONFIG_PINCTRL
/**
 * acpi_gpiochip_pin_to_gpio_offset() - translates ACPI GPIO to Linux GPIO
 * @chip: GPIO chip
 * @pin: ACPI GPIO pin number from GpioIo/GpioInt resource
 *
 * Function takes ACPI GpioIo/GpioInt pin number as a parameter and
 * translates it to a corresponding offset suitable to be passed to a
 * GPIO controller driver.
 *
 * Typically the returned offset is same as @pin, but if the GPIO
 * controller uses pin controller and the mapping is not contigous the
 * offset might be different.
 */
static int acpi_gpiochip_pin_to_gpio_offset(struct gpio_chip *chip, int pin)
{
	struct gpio_pin_range *pin_range;

	/* If there are no ranges in this chip, use 1:1 mapping */
	if (list_empty(&chip->pin_ranges))
		return pin;

	list_for_each_entry(pin_range, &chip->pin_ranges, node) {
		const struct pinctrl_gpio_range *range = &pin_range->range;
		int i;

		if (range->pins) {
			for (i = 0; i < range->npins; i++) {
				if (range->pins[i] == pin)
					return range->base + i - chip->base;
			}
		} else {
			if (pin >= range->pin_base &&
			    pin < range->pin_base + range->npins) {
				unsigned gpio_base;

				gpio_base = range->base - chip->base;
				return gpio_base + pin - range->pin_base;
			}
		}
	}

	return -EINVAL;
}
#else
static inline int acpi_gpiochip_pin_to_gpio_offset(struct gpio_chip *chip,
						   int pin)
{
	return pin;
}
#endif

M
Mathias Nyman 已提交
112
/**
113
 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
M
Mathias Nyman 已提交
114 115 116
 * @path:	ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
 * @pin:	ACPI GPIO pin number (0-based, controller-relative)
 *
117 118
 * Returns GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
 * error value
M
Mathias Nyman 已提交
119 120
 */

121
static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
M
Mathias Nyman 已提交
122 123 124 125
{
	struct gpio_chip *chip;
	acpi_handle handle;
	acpi_status status;
126
	int offset;
M
Mathias Nyman 已提交
127 128 129

	status = acpi_get_handle(NULL, path, &handle);
	if (ACPI_FAILURE(status))
130
		return ERR_PTR(-ENODEV);
M
Mathias Nyman 已提交
131 132 133

	chip = gpiochip_find(handle, acpi_gpiochip_find);
	if (!chip)
134
		return ERR_PTR(-ENODEV);
M
Mathias Nyman 已提交
135

136 137 138
	offset = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
	if (offset < 0)
		return ERR_PTR(offset);
M
Mathias Nyman 已提交
139

140
	return gpiochip_get_desc(chip, offset);
M
Mathias Nyman 已提交
141
}
142 143 144

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

147
	acpi_evaluate_object(event->handle, NULL, NULL, NULL);
148 149 150 151

	return IRQ_HANDLED;
}

152 153
static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
{
154
	struct acpi_gpio_event *event = data;
155

156
	acpi_execute_simple_method(event->handle, NULL, event->pin);
157 158 159 160

	return IRQ_HANDLED;
}

161
static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
162 163 164 165
{
	/* The address of this function is used as a key. */
}

166 167
static acpi_status acpi_gpiochip_request_interrupt(struct acpi_resource *ares,
						   void *context)
168
{
169
	struct acpi_gpio_chip *acpi_gpio = context;
170
	struct gpio_chip *chip = acpi_gpio->chip;
171
	struct acpi_resource_gpio *agpio;
172
	acpi_handle handle, evt_handle;
173 174 175 176 177
	struct acpi_gpio_event *event;
	irq_handler_t handler = NULL;
	struct gpio_desc *desc;
	unsigned long irqflags;
	int ret, pin, irq;
178

179 180 181 182 183 184
	if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
		return AE_OK;

	agpio = &ares->data.gpio;
	if (agpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
		return AE_OK;
185 186

	handle = ACPI_HANDLE(chip->dev);
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
	pin = agpio->pin_table[0];

	if (pin <= 255) {
		char ev_name[5];
		sprintf(ev_name, "_%c%02X",
			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)
		return AE_BAD_PARAMETER;
203

204 205 206 207
	pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
	if (pin < 0)
		return AE_BAD_PARAMETER;

208
	desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
209 210 211 212
	if (IS_ERR(desc)) {
		dev_err(chip->dev, "Failed to request GPIO\n");
		return AE_ERROR;
	}
213

214
	gpiod_direction_input(desc);
215

216
	ret = gpiochip_lock_as_irq(chip, pin);
217 218 219 220
	if (ret) {
		dev_err(chip->dev, "Failed to lock GPIO as interrupt\n");
		goto fail_free_desc;
	}
221

222 223 224 225 226
	irq = gpiod_to_irq(desc);
	if (irq < 0) {
		dev_err(chip->dev, "Failed to translate GPIO to IRQ\n");
		goto fail_unlock_irq;
	}
227

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
	irqflags = IRQF_ONESHOT;
	if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
		if (agpio->polarity == ACPI_ACTIVE_HIGH)
			irqflags |= IRQF_TRIGGER_HIGH;
		else
			irqflags |= IRQF_TRIGGER_LOW;
	} else {
		switch (agpio->polarity) {
		case ACPI_ACTIVE_HIGH:
			irqflags |= IRQF_TRIGGER_RISING;
			break;
		case ACPI_ACTIVE_LOW:
			irqflags |= IRQF_TRIGGER_FALLING;
			break;
		default:
			irqflags |= IRQF_TRIGGER_RISING |
				    IRQF_TRIGGER_FALLING;
			break;
246
		}
247
	}
248

249 250 251
	event = kzalloc(sizeof(*event), GFP_KERNEL);
	if (!event)
		goto fail_unlock_irq;
252

253 254 255
	event->handle = evt_handle;
	event->irq = irq;
	event->pin = pin;
256
	event->desc = desc;
257

258 259 260 261 262 263
	ret = request_threaded_irq(event->irq, NULL, handler, irqflags,
				   "ACPI:Event", event);
	if (ret) {
		dev_err(chip->dev, "Failed to setup interrupt handler for %d\n",
			event->irq);
		goto fail_free_event;
264
	}
265 266 267 268 269 270 271

	list_add_tail(&event->node, &acpi_gpio->events);
	return AE_OK;

fail_free_event:
	kfree(event);
fail_unlock_irq:
272
	gpiochip_unlock_as_irq(chip, pin);
273 274 275 276
fail_free_desc:
	gpiochip_free_own_desc(desc);

	return AE_ERROR;
277
}
278

279
/**
280
 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
281
 * @chip:      GPIO chip
282
 *
283 284 285 286 287 288
 * 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
 * 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.
 */
289
void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
290
{
291 292 293 294 295 296
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;

	if (!chip->dev || !chip->to_irq)
		return;
297

298 299 300 301 302 303
	handle = ACPI_HANDLE(chip->dev);
	if (!handle)
		return;

	status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
	if (ACPI_FAILURE(status))
304 305 306
		return;

	INIT_LIST_HEAD(&acpi_gpio->events);
307
	acpi_walk_resources(handle, "_AEI",
308 309 310 311 312
			    acpi_gpiochip_request_interrupt, acpi_gpio);
}

/**
 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
313
 * @chip:      GPIO chip
314
 *
315 316
 * Free interrupts associated with GPIO ACPI event method for the given
 * GPIO chip.
317
 */
318
void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
319
{
320
	struct acpi_gpio_chip *acpi_gpio;
321
	struct acpi_gpio_event *event, *ep;
322 323 324 325 326
	acpi_handle handle;
	acpi_status status;

	if (!chip->dev || !chip->to_irq)
		return;
327

328 329 330 331 332 333
	handle = ACPI_HANDLE(chip->dev);
	if (!handle)
		return;

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

336
	list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
337 338 339
		struct gpio_desc *desc;

		free_irq(event->irq, event);
340
		desc = event->desc;
341 342
		if (WARN_ON(IS_ERR(desc)))
			continue;
343
		gpiochip_unlock_as_irq(chip, event->pin);
344
		gpiochip_free_own_desc(desc);
345 346
		list_del(&event->node);
		kfree(event);
347 348 349
	}
}

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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);

static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
				      const char *name, int index,
				      struct acpi_reference_args *args)
{
	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;

			args->adev = adev;
			args->args[0] = par->crs_entry_index;
			args->args[1] = par->line_index;
			args->args[2] = par->active_low;
			args->nargs = 3;
			return true;
		}

	return false;
}

385 386 387
struct acpi_gpio_lookup {
	struct acpi_gpio_info info;
	int index;
388
	int pin_index;
389
	struct gpio_desc *desc;
390 391 392 393 394 395 396 397 398 399
	int n;
};

static int acpi_find_gpio(struct acpi_resource *ares, void *data)
{
	struct acpi_gpio_lookup *lookup = data;

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

400
	if (lookup->n++ == lookup->index && !lookup->desc) {
401
		const struct acpi_resource_gpio *agpio = &ares->data.gpio;
402 403 404 405
		int pin_index = lookup->pin_index;

		if (pin_index >= agpio->pin_table_length)
			return 1;
406

407
		lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
408
					      agpio->pin_table[pin_index]);
409 410
		lookup->info.gpioint =
			agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
411 412 413 414 415 416 417 418 419

		/*
		 * ActiveLow is only specified for GpioInt resource. If
		 * GpioIo is used then the only way to set the flag is
		 * to use _DSD "gpios" property.
		 */
		if (lookup->info.gpioint)
			lookup->info.active_low =
				agpio->polarity == ACPI_ACTIVE_LOW;
420 421 422 423 424 425
	}

	return 1;
}

/**
426
 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
427 428
 * @adev: pointer to a ACPI device to get GPIO from
 * @propname: Property name of the GPIO (optional)
429 430 431
 * @index: index of GpioIo/GpioInt resource (starting from %0)
 * @info: info pointer to fill in (optional)
 *
432
 * Function goes through ACPI resources for @adev and based on @index looks
433
 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
434 435 436
 * and returns it. @index matches GpioIo/GpioInt resources only so if there
 * are total %3 GPIO resources, the index goes from %0 to %2.
 *
437 438 439 440
 * 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).
 *
441
 * If the GPIO cannot be translated or there is an error an ERR_PTR is
442 443 444 445 446
 * returned.
 *
 * Note: if the GPIO resource has multiple entries in the pin list, this
 * function only returns the first.
 */
447 448
struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
					  const char *propname, int index,
449
					  struct acpi_gpio_info *info)
450 451 452
{
	struct acpi_gpio_lookup lookup;
	struct list_head resource_list;
453
	bool active_low = false;
454 455
	int ret;

456
	if (!adev)
457
		return ERR_PTR(-ENODEV);
458 459 460 461

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

462 463 464 465 466 467
	if (propname) {
		struct acpi_reference_args args;

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

		memset(&args, 0, sizeof(args));
468
		ret = acpi_dev_get_property_reference(adev, propname,
469
						      index, &args);
470 471 472 473 474 475
		if (ret) {
			bool found = acpi_get_driver_gpio_data(adev, propname,
							       index, &args);
			if (!found)
				return ERR_PTR(ret);
		}
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499

		/*
		 * The property was found and resolved so need to
		 * lookup the GPIO based on returned args instead.
		 */
		adev = args.adev;
		if (args.nargs >= 2) {
			lookup.index = args.args[0];
			lookup.pin_index = args.args[1];
			/*
			 * 3rd argument, if present is used to
			 * specify active_low.
			 */
			if (args.nargs >= 3)
				active_low = !!args.args[2];
		}

		dev_dbg(&adev->dev, "GPIO: _DSD returned %s %zd %llu %llu %llu\n",
			dev_name(&adev->dev), args.nargs,
			args.args[0], args.args[1], args.args[2]);
	} else {
		dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
	}

500 501 502 503
	INIT_LIST_HEAD(&resource_list);
	ret = acpi_dev_get_resources(adev, &resource_list, acpi_find_gpio,
				     &lookup);
	if (ret < 0)
504
		return ERR_PTR(ret);
505 506 507

	acpi_dev_free_resource_list(&resource_list);

508
	if (lookup.desc && info) {
509
		*info = lookup.info;
510 511 512
		if (active_low)
			info->active_low = active_low;
	}
513

514
	return lookup.desc ? lookup.desc : ERR_PTR(-ENOENT);
515
}
516

517 518 519 520 521 522 523 524 525
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;
526
	int pin_index = (int)address;
527 528
	acpi_status status;
	bool pull_up;
529
	int length;
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
	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;
	pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;

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

551 552
	length = min(agpio->pin_table_length, (u16)(pin_index + bits));
	for (i = pin_index; i < length; ++i) {
553 554 555 556 557
		unsigned pin = agpio->pin_table[i];
		struct acpi_gpio_connection *conn;
		struct gpio_desc *desc;
		bool found;

558 559 560 561 562 563
		pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
		if (pin < 0) {
			status = AE_BAD_PARAMETER;
			goto out;
		}

564 565 566 567
		mutex_lock(&achip->conn_lock);

		found = false;
		list_for_each_entry(conn, &achip->conns, node) {
568
			if (conn->pin == pin) {
569
				found = true;
570
				desc = conn->desc;
571 572 573 574
				break;
			}
		}
		if (!found) {
575 576
			desc = gpiochip_request_own_desc(chip, pin,
							 "ACPI:OpRegion");
577
			if (IS_ERR(desc)) {
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
				status = AE_ERROR;
				mutex_unlock(&achip->conn_lock);
				goto out;
			}

			switch (agpio->io_restriction) {
			case ACPI_IO_RESTRICT_INPUT:
				gpiod_direction_input(desc);
				break;
			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
				 * instead. If the pin is pulled up we
				 * assume default to be high, otherwise
				 * low.
				 */
				gpiod_direction_output(desc, pull_up);
				break;
			default:
				/*
				 * Assume that the BIOS has configured the
				 * direction and pull accordingly.
				 */
				break;
			}

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

614
			conn->pin = pin;
615 616 617 618 619 620 621
			conn->desc = desc;
			list_add_tail(&conn->node, &achip->conns);
		}

		mutex_unlock(&achip->conn_lock);

		if (function == ACPI_WRITE)
622 623
			gpiod_set_raw_value_cansleep(desc,
						     !!((1 << i) & *value));
624
		else
625
			*value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	}

out:
	ACPI_FREE(ares);
	return status;
}

static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
{
	struct gpio_chip *chip = achip->chip;
	acpi_handle handle = ACPI_HANDLE(chip->dev);
	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))
		dev_err(chip->dev, "Failed to install GPIO OpRegion handler\n");
}

static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
{
	struct gpio_chip *chip = achip->chip;
	acpi_handle handle = ACPI_HANDLE(chip->dev);
	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)) {
		dev_err(chip->dev, "Failed to remove GPIO OpRegion handler\n");
		return;
	}

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

669 670
void acpi_gpiochip_add(struct gpio_chip *chip)
{
671 672 673 674
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;

675 676 677
	if (!chip || !chip->dev)
		return;

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
	handle = ACPI_HANDLE(chip->dev);
	if (!handle)
		return;

	acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
	if (!acpi_gpio) {
		dev_err(chip->dev,
			"Failed to allocate memory for ACPI GPIO chip\n");
		return;
	}

	acpi_gpio->chip = chip;

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

698
	acpi_gpiochip_request_regions(acpi_gpio);
699 700 701 702
}

void acpi_gpiochip_remove(struct gpio_chip *chip)
{
703 704 705 706
	struct acpi_gpio_chip *acpi_gpio;
	acpi_handle handle;
	acpi_status status;

707 708 709
	if (!chip || !chip->dev)
		return;

710 711 712 713 714 715 716 717 718 719
	handle = ACPI_HANDLE(chip->dev);
	if (!handle)
		return;

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

720
	acpi_gpiochip_free_regions(acpi_gpio);
721 722 723

	acpi_detach_data(handle, acpi_gpio_chip_dh);
	kfree(acpi_gpio);
724
}
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808

static unsigned int acpi_gpio_package_count(const union acpi_object *obj)
{
	const union acpi_object *element = obj->package.elements;
	const union acpi_object *end = element + obj->package.count;
	unsigned int count = 0;

	while (element < end) {
		if (element->type == ACPI_TYPE_LOCAL_REFERENCE)
			count++;

		element++;
	}
	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;
}

/**
 * acpi_gpio_count - return the number of GPIOs associated with a
 *		device / function or -ENOENT if no GPIO has been
 *		assigned to the requested function.
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
 * @con_id:	function within the GPIO consumer
 */
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++) {
		if (con_id && strcmp(con_id, "gpios"))
			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;
				}
		}
		if (count >= 0)
			break;
	}

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

		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;
	}
	return count;
}