Linux Audio

Check our new training course

Loading...
v6.8
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 * drivers/acpi/resource.c - ACPI device resources interpretation.
   4 *
   5 * Copyright (C) 2012, Intel Corp.
   6 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
   7 *
   8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9 *
 
 
 
 
 
 
 
 
 
  10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11 */
  12
  13#include <linux/acpi.h>
  14#include <linux/device.h>
  15#include <linux/export.h>
  16#include <linux/ioport.h>
  17#include <linux/slab.h>
  18#include <linux/irq.h>
  19#include <linux/dmi.h>
  20
  21#ifdef CONFIG_X86
  22#define valid_IRQ(i) (((i) != 0) && ((i) != 2))
  23static inline bool acpi_iospace_resource_valid(struct resource *res)
  24{
  25	/* On X86 IO space is limited to the [0 - 64K] IO port range */
  26	return res->end < 0x10003;
  27}
  28#else
  29#define valid_IRQ(i) (true)
  30/*
  31 * ACPI IO descriptors on arches other than X86 contain MMIO CPU physical
  32 * addresses mapping IO space in CPU physical address space, IO space
  33 * resources can be placed anywhere in the 64-bit physical address space.
  34 */
  35static inline bool
  36acpi_iospace_resource_valid(struct resource *res) { return true; }
  37#endif
  38
  39#if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
  40static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
  41{
  42	return ext_irq->resource_source.string_length == 0 &&
  43	       ext_irq->producer_consumer == ACPI_CONSUMER;
  44}
  45#else
  46static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
  47{
  48	return true;
  49}
  50#endif
  51
  52static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
  53{
  54	u64 reslen = end - start + 1;
  55
  56	/*
  57	 * CHECKME: len might be required to check versus a minimum
  58	 * length as well. 1 for io is fine, but for memory it does
  59	 * not make any sense at all.
  60	 * Note: some BIOSes report incorrect length for ACPI address space
  61	 * descriptor, so remove check of 'reslen == len' to avoid regression.
  62	 */
  63	if (len && reslen && start <= end)
  64		return true;
  65
  66	pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
  67		io ? "io" : "mem", start, end, len);
  68
  69	return false;
  70}
  71
  72static void acpi_dev_memresource_flags(struct resource *res, u64 len,
  73				       u8 write_protect)
  74{
  75	res->flags = IORESOURCE_MEM;
  76
  77	if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
  78		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
  79
  80	if (write_protect == ACPI_READ_WRITE_MEMORY)
  81		res->flags |= IORESOURCE_MEM_WRITEABLE;
  82}
  83
  84static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
  85				     u8 write_protect)
  86{
  87	res->start = start;
  88	res->end = start + len - 1;
  89	acpi_dev_memresource_flags(res, len, write_protect);
  90}
  91
  92/**
  93 * acpi_dev_resource_memory - Extract ACPI memory resource information.
  94 * @ares: Input ACPI resource object.
  95 * @res: Output generic resource object.
  96 *
  97 * Check if the given ACPI resource object represents a memory resource and
  98 * if that's the case, use the information in it to populate the generic
  99 * resource object pointed to by @res.
 100 *
 101 * Return:
 102 * 1) false with res->flags setting to zero: not the expected resource type
 103 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
 104 * 3) true: valid assigned resource
 105 */
 106bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
 107{
 108	struct acpi_resource_memory24 *memory24;
 109	struct acpi_resource_memory32 *memory32;
 110	struct acpi_resource_fixed_memory32 *fixed_memory32;
 111
 112	switch (ares->type) {
 113	case ACPI_RESOURCE_TYPE_MEMORY24:
 114		memory24 = &ares->data.memory24;
 115		acpi_dev_get_memresource(res, memory24->minimum << 8,
 116					 memory24->address_length << 8,
 117					 memory24->write_protect);
 118		break;
 119	case ACPI_RESOURCE_TYPE_MEMORY32:
 120		memory32 = &ares->data.memory32;
 121		acpi_dev_get_memresource(res, memory32->minimum,
 122					 memory32->address_length,
 123					 memory32->write_protect);
 124		break;
 125	case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
 126		fixed_memory32 = &ares->data.fixed_memory32;
 127		acpi_dev_get_memresource(res, fixed_memory32->address,
 128					 fixed_memory32->address_length,
 129					 fixed_memory32->write_protect);
 130		break;
 131	default:
 132		res->flags = 0;
 133		return false;
 134	}
 135
 136	return !(res->flags & IORESOURCE_DISABLED);
 137}
 138EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
 139
 140static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
 141				      u8 io_decode, u8 translation_type)
 142{
 143	res->flags = IORESOURCE_IO;
 144
 145	if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
 146		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
 147
 148	if (!acpi_iospace_resource_valid(res))
 149		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
 150
 151	if (io_decode == ACPI_DECODE_16)
 152		res->flags |= IORESOURCE_IO_16BIT_ADDR;
 153	if (translation_type == ACPI_SPARSE_TRANSLATION)
 154		res->flags |= IORESOURCE_IO_SPARSE;
 155}
 156
 157static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
 158				    u8 io_decode)
 159{
 160	res->start = start;
 161	res->end = start + len - 1;
 162	acpi_dev_ioresource_flags(res, len, io_decode, 0);
 163}
 164
 165/**
 166 * acpi_dev_resource_io - Extract ACPI I/O resource information.
 167 * @ares: Input ACPI resource object.
 168 * @res: Output generic resource object.
 169 *
 170 * Check if the given ACPI resource object represents an I/O resource and
 171 * if that's the case, use the information in it to populate the generic
 172 * resource object pointed to by @res.
 173 *
 174 * Return:
 175 * 1) false with res->flags setting to zero: not the expected resource type
 176 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
 177 * 3) true: valid assigned resource
 178 */
 179bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
 180{
 181	struct acpi_resource_io *io;
 182	struct acpi_resource_fixed_io *fixed_io;
 183
 184	switch (ares->type) {
 185	case ACPI_RESOURCE_TYPE_IO:
 186		io = &ares->data.io;
 187		acpi_dev_get_ioresource(res, io->minimum,
 188					io->address_length,
 189					io->io_decode);
 190		break;
 191	case ACPI_RESOURCE_TYPE_FIXED_IO:
 192		fixed_io = &ares->data.fixed_io;
 193		acpi_dev_get_ioresource(res, fixed_io->address,
 194					fixed_io->address_length,
 195					ACPI_DECODE_10);
 196		break;
 197	default:
 198		res->flags = 0;
 199		return false;
 200	}
 201
 202	return !(res->flags & IORESOURCE_DISABLED);
 203}
 204EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
 205
 206static bool acpi_decode_space(struct resource_win *win,
 207			      struct acpi_resource_address *addr,
 208			      struct acpi_address64_attribute *attr)
 209{
 210	u8 iodec = attr->granularity == 0xfff ? ACPI_DECODE_10 : ACPI_DECODE_16;
 211	bool wp = addr->info.mem.write_protect;
 212	u64 len = attr->address_length;
 213	u64 start, end, offset = 0;
 214	struct resource *res = &win->res;
 215
 216	/*
 217	 * Filter out invalid descriptor according to ACPI Spec 5.0, section
 218	 * 6.4.3.5 Address Space Resource Descriptors.
 219	 */
 220	if ((addr->min_address_fixed != addr->max_address_fixed && len) ||
 221	    (addr->min_address_fixed && addr->max_address_fixed && !len))
 222		pr_debug("ACPI: Invalid address space min_addr_fix %d, max_addr_fix %d, len %llx\n",
 223			 addr->min_address_fixed, addr->max_address_fixed, len);
 224
 225	/*
 226	 * For bridges that translate addresses across the bridge,
 227	 * translation_offset is the offset that must be added to the
 228	 * address on the secondary side to obtain the address on the
 229	 * primary side. Non-bridge devices must list 0 for all Address
 230	 * Translation offset bits.
 231	 */
 232	if (addr->producer_consumer == ACPI_PRODUCER)
 233		offset = attr->translation_offset;
 234	else if (attr->translation_offset)
 235		pr_debug("ACPI: translation_offset(%lld) is invalid for non-bridge device.\n",
 236			 attr->translation_offset);
 237	start = attr->minimum + offset;
 238	end = attr->maximum + offset;
 239
 240	win->offset = offset;
 241	res->start = start;
 242	res->end = end;
 243	if (sizeof(resource_size_t) < sizeof(u64) &&
 244	    (offset != win->offset || start != res->start || end != res->end)) {
 245		pr_warn("acpi resource window ([%#llx-%#llx] ignored, not CPU addressable)\n",
 246			attr->minimum, attr->maximum);
 247		return false;
 248	}
 249
 250	switch (addr->resource_type) {
 251	case ACPI_MEMORY_RANGE:
 252		acpi_dev_memresource_flags(res, len, wp);
 253		break;
 254	case ACPI_IO_RANGE:
 255		acpi_dev_ioresource_flags(res, len, iodec,
 256					  addr->info.io.translation_type);
 257		break;
 258	case ACPI_BUS_NUMBER_RANGE:
 259		res->flags = IORESOURCE_BUS;
 260		break;
 261	default:
 262		return false;
 263	}
 264
 265	if (addr->producer_consumer == ACPI_PRODUCER)
 266		res->flags |= IORESOURCE_WINDOW;
 267
 268	if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
 269		res->flags |= IORESOURCE_PREFETCH;
 270
 271	return !(res->flags & IORESOURCE_DISABLED);
 272}
 273
 274/**
 275 * acpi_dev_resource_address_space - Extract ACPI address space information.
 276 * @ares: Input ACPI resource object.
 277 * @win: Output generic resource object.
 278 *
 279 * Check if the given ACPI resource object represents an address space resource
 280 * and if that's the case, use the information in it to populate the generic
 281 * resource object pointed to by @win.
 282 *
 283 * Return:
 284 * 1) false with win->res.flags setting to zero: not the expected resource type
 285 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
 286 *    resource
 287 * 3) true: valid assigned resource
 288 */
 289bool acpi_dev_resource_address_space(struct acpi_resource *ares,
 290				     struct resource_win *win)
 291{
 292	struct acpi_resource_address64 addr;
 293
 294	win->res.flags = 0;
 295	if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
 296		return false;
 297
 298	return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
 299				 &addr.address);
 300}
 301EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
 302
 303/**
 304 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
 305 * @ares: Input ACPI resource object.
 306 * @win: Output generic resource object.
 307 *
 308 * Check if the given ACPI resource object represents an extended address space
 309 * resource and if that's the case, use the information in it to populate the
 310 * generic resource object pointed to by @win.
 311 *
 312 * Return:
 313 * 1) false with win->res.flags setting to zero: not the expected resource type
 314 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
 315 *    resource
 316 * 3) true: valid assigned resource
 317 */
 318bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
 319					 struct resource_win *win)
 320{
 321	struct acpi_resource_extended_address64 *ext_addr;
 322
 323	win->res.flags = 0;
 324	if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
 325		return false;
 326
 327	ext_addr = &ares->data.ext_address64;
 328
 329	return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
 330				 &ext_addr->address);
 331}
 332EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
 333
 334/**
 335 * acpi_dev_irq_flags - Determine IRQ resource flags.
 336 * @triggering: Triggering type as provided by ACPI.
 337 * @polarity: Interrupt polarity as provided by ACPI.
 338 * @shareable: Whether or not the interrupt is shareable.
 339 * @wake_capable: Wake capability as provided by ACPI.
 340 */
 341unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable, u8 wake_capable)
 342{
 343	unsigned long flags;
 344
 345	if (triggering == ACPI_LEVEL_SENSITIVE)
 346		flags = polarity == ACPI_ACTIVE_LOW ?
 347			IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
 348	else
 349		flags = polarity == ACPI_ACTIVE_LOW ?
 350			IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
 351
 352	if (shareable == ACPI_SHARED)
 353		flags |= IORESOURCE_IRQ_SHAREABLE;
 354
 355	if (wake_capable == ACPI_WAKE_CAPABLE)
 356		flags |= IORESOURCE_IRQ_WAKECAPABLE;
 357
 358	return flags | IORESOURCE_IRQ;
 359}
 360EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
 361
 362/**
 363 * acpi_dev_get_irq_type - Determine irq type.
 364 * @triggering: Triggering type as provided by ACPI.
 365 * @polarity: Interrupt polarity as provided by ACPI.
 366 */
 367unsigned int acpi_dev_get_irq_type(int triggering, int polarity)
 368{
 369	switch (polarity) {
 370	case ACPI_ACTIVE_LOW:
 371		return triggering == ACPI_EDGE_SENSITIVE ?
 372		       IRQ_TYPE_EDGE_FALLING :
 373		       IRQ_TYPE_LEVEL_LOW;
 374	case ACPI_ACTIVE_HIGH:
 375		return triggering == ACPI_EDGE_SENSITIVE ?
 376		       IRQ_TYPE_EDGE_RISING :
 377		       IRQ_TYPE_LEVEL_HIGH;
 378	case ACPI_ACTIVE_BOTH:
 379		if (triggering == ACPI_EDGE_SENSITIVE)
 380			return IRQ_TYPE_EDGE_BOTH;
 381		fallthrough;
 382	default:
 383		return IRQ_TYPE_NONE;
 384	}
 385}
 386EXPORT_SYMBOL_GPL(acpi_dev_get_irq_type);
 387
 388/*
 389 * DMI matches for boards where the DSDT specifies the kbd IRQ as
 390 * level active-low and using the override changes this to rising edge,
 391 * stopping the keyboard from working.
 392 */
 393static const struct dmi_system_id irq1_level_low_skip_override[] = {
 394	{
 395		/* MEDION P15651 */
 396		.matches = {
 397			DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
 398			DMI_MATCH(DMI_BOARD_NAME, "M15T"),
 399		},
 400	},
 401	{
 402		/* MEDION S17405 */
 403		.matches = {
 404			DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
 405			DMI_MATCH(DMI_BOARD_NAME, "M17T"),
 406		},
 407	},
 408	{
 409		/* MEDION S17413 */
 410		.matches = {
 411			DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
 412			DMI_MATCH(DMI_BOARD_NAME, "M1xA"),
 413		},
 414	},
 415	{
 416		/* Asus Vivobook K3402ZA */
 417		.matches = {
 418			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 419			DMI_MATCH(DMI_BOARD_NAME, "K3402ZA"),
 420		},
 421	},
 422	{
 423		/* Asus Vivobook K3502ZA */
 424		.matches = {
 425			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 426			DMI_MATCH(DMI_BOARD_NAME, "K3502ZA"),
 427		},
 428	},
 429	{
 430		/* Asus Vivobook S5402ZA */
 431		.matches = {
 432			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 433			DMI_MATCH(DMI_BOARD_NAME, "S5402ZA"),
 434		},
 435	},
 436	{
 437		/* Asus Vivobook S5602ZA */
 438		.matches = {
 439			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 440			DMI_MATCH(DMI_BOARD_NAME, "S5602ZA"),
 441		},
 442	},
 443	{
 444		/* Asus ExpertBook B1402CBA */
 445		.matches = {
 446			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 447			DMI_MATCH(DMI_BOARD_NAME, "B1402CBA"),
 448		},
 449	},
 450	{
 451		/* Asus ExpertBook B1402CVA */
 452		.matches = {
 453			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 454			DMI_MATCH(DMI_BOARD_NAME, "B1402CVA"),
 455		},
 456	},
 457	{
 458		/* Asus ExpertBook B1502CBA */
 459		.matches = {
 460			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 461			DMI_MATCH(DMI_BOARD_NAME, "B1502CBA"),
 462		},
 463	},
 464	{
 465		/* Asus ExpertBook B1502CGA */
 466		.matches = {
 467			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 468			DMI_MATCH(DMI_BOARD_NAME, "B1502CGA"),
 469		},
 470	},
 471	{
 472		/* Asus ExpertBook B2402CBA */
 473		.matches = {
 474			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 475			DMI_MATCH(DMI_BOARD_NAME, "B2402CBA"),
 476		},
 477	},
 478	{
 479		/* Asus ExpertBook B2402FBA */
 480		.matches = {
 481			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 482			DMI_MATCH(DMI_BOARD_NAME, "B2402FBA"),
 483		},
 484	},
 485	{
 486		/* Asus ExpertBook B2502 */
 487		.matches = {
 488			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 489			DMI_MATCH(DMI_BOARD_NAME, "B2502CBA"),
 490		},
 491	},
 492	{
 493		/* Asus Vivobook E1504GA */
 494		.matches = {
 495			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 496			DMI_MATCH(DMI_BOARD_NAME, "E1504GA"),
 497		},
 498	},
 499	{
 500		/* Asus Vivobook E1504GAB */
 501		.matches = {
 502			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 503			DMI_MATCH(DMI_BOARD_NAME, "E1504GAB"),
 504		},
 505	},
 506	{
 507		/* LG Electronics 17U70P */
 508		.matches = {
 509			DMI_MATCH(DMI_SYS_VENDOR, "LG Electronics"),
 510			DMI_MATCH(DMI_BOARD_NAME, "17U70P"),
 511		},
 512	},
 513	{ }
 514};
 515
 516/*
 517 * DMI matches for AMD Zen boards where the DSDT specifies the kbd IRQ
 518 * as falling edge and this must be overridden to rising edge,
 519 * to have a working keyboard.
 520 */
 521static const struct dmi_system_id irq1_edge_low_force_override[] = {
 522	{
 523		/* TongFang GMxRGxx/XMG CORE 15 (M22)/TUXEDO Stellaris 15 Gen4 AMD */
 524		.matches = {
 525			DMI_MATCH(DMI_BOARD_NAME, "GMxRGxx"),
 526		},
 527	},
 528	{
 529		/* TongFang GMxXGxx/TUXEDO Polaris 15 Gen5 AMD */
 530		.matches = {
 531			DMI_MATCH(DMI_BOARD_NAME, "GMxXGxx"),
 532		},
 533	},
 534	{
 535		/* TongFang GMxXGxx sold as Eluktronics Inc. RP-15 */
 536		.matches = {
 537			DMI_MATCH(DMI_SYS_VENDOR, "Eluktronics Inc."),
 538			DMI_MATCH(DMI_BOARD_NAME, "RP-15"),
 539		},
 540	},
 541	{
 542		/* TongFang GM6XGxX/TUXEDO Stellaris 16 Gen5 AMD */
 543		.matches = {
 544			DMI_MATCH(DMI_BOARD_NAME, "GM6XGxX"),
 545		},
 546	},
 547	{
 548		/* MAINGEAR Vector Pro 2 15 */
 549		.matches = {
 550			DMI_MATCH(DMI_SYS_VENDOR, "Micro Electronics Inc"),
 551			DMI_MATCH(DMI_PRODUCT_NAME, "MG-VCP2-15A3070T"),
 552		}
 553	},
 554	{
 555		/* MAINGEAR Vector Pro 2 17 */
 556		.matches = {
 557			DMI_MATCH(DMI_SYS_VENDOR, "Micro Electronics Inc"),
 558			DMI_MATCH(DMI_PRODUCT_NAME, "MG-VCP2-17A3070T"),
 559		},
 560	},
 561	{
 562		/* TongFang GM6BGEQ / PCSpecialist Elimina Pro 16 M, RTX 3050 */
 563		.matches = {
 564			DMI_MATCH(DMI_BOARD_NAME, "GM6BGEQ"),
 565		},
 566	},
 567	{
 568		/* TongFang GM6BG5Q, RTX 4050 */
 569		.matches = {
 570			DMI_MATCH(DMI_BOARD_NAME, "GM6BG5Q"),
 571		},
 572	},
 573	{
 574		/* TongFang GM6BG0Q / PCSpecialist Elimina Pro 16 M, RTX 4060 */
 575		.matches = {
 576			DMI_MATCH(DMI_BOARD_NAME, "GM6BG0Q"),
 577		},
 578	},
 579	{
 580		/* Infinity E15-5A165-BM */
 581		.matches = {
 582			DMI_MATCH(DMI_BOARD_NAME, "GM5RG1E0009COM"),
 583		},
 584	},
 585	{
 586		/* Infinity E15-5A305-1M */
 587		.matches = {
 588			DMI_MATCH(DMI_BOARD_NAME, "GM5RGEE0016COM"),
 589		},
 590	},
 591	{ }
 592};
 593
 594struct irq_override_cmp {
 595	const struct dmi_system_id *system;
 596	unsigned char irq;
 597	unsigned char triggering;
 598	unsigned char polarity;
 599	unsigned char shareable;
 600	bool override;
 601};
 602
 603static const struct irq_override_cmp override_table[] = {
 604	{ irq1_level_low_skip_override, 1, ACPI_LEVEL_SENSITIVE, ACPI_ACTIVE_LOW, 0, false },
 605	{ irq1_edge_low_force_override, 1, ACPI_EDGE_SENSITIVE, ACPI_ACTIVE_LOW, 1, true },
 606};
 607
 608static bool acpi_dev_irq_override(u32 gsi, u8 triggering, u8 polarity,
 609				  u8 shareable)
 610{
 611	int i;
 612
 613	for (i = 0; i < ARRAY_SIZE(override_table); i++) {
 614		const struct irq_override_cmp *entry = &override_table[i];
 615
 616		if (dmi_check_system(entry->system) &&
 617		    entry->irq == gsi &&
 618		    entry->triggering == triggering &&
 619		    entry->polarity == polarity &&
 620		    entry->shareable == shareable)
 621			return entry->override;
 622	}
 623
 624#ifdef CONFIG_X86
 625	/*
 626	 * Always use the MADT override info, except for the i8042 PS/2 ctrl
 627	 * IRQs (1 and 12). For these the DSDT IRQ settings should sometimes
 628	 * be used otherwise PS/2 keyboards / mice will not work.
 629	 */
 630	if (gsi != 1 && gsi != 12)
 631		return true;
 632
 633	/* If the override comes from an INT_SRC_OVR MADT entry, honor it. */
 634	if (acpi_int_src_ovr[gsi])
 635		return true;
 636
 637	/*
 638	 * IRQ override isn't needed on modern AMD Zen systems and
 639	 * this override breaks active low IRQs on AMD Ryzen 6000 and
 640	 * newer systems. Skip it.
 641	 */
 642	if (boot_cpu_has(X86_FEATURE_ZEN))
 643		return false;
 644#endif
 645
 646	return true;
 647}
 648
 649static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
 650				     u8 triggering, u8 polarity, u8 shareable,
 651				     u8 wake_capable, bool check_override)
 652{
 653	int irq, p, t;
 654
 655	if (!valid_IRQ(gsi)) {
 656		irqresource_disabled(res, gsi);
 657		return;
 658	}
 659
 660	/*
 661	 * In IO-APIC mode, use overridden attribute. Two reasons:
 662	 * 1. BIOS bug in DSDT
 663	 * 2. BIOS uses IO-APIC mode Interrupt Source Override
 664	 *
 665	 * We do this only if we are dealing with IRQ() or IRQNoFlags()
 666	 * resource (the legacy ISA resources). With modern ACPI 5 devices
 667	 * using extended IRQ descriptors we take the IRQ configuration
 668	 * from _CRS directly.
 669	 */
 670	if (check_override &&
 671	    acpi_dev_irq_override(gsi, triggering, polarity, shareable) &&
 672	    !acpi_get_override_irq(gsi, &t, &p)) {
 673		u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
 674		u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
 675
 676		if (triggering != trig || polarity != pol) {
 677			pr_warn("ACPI: IRQ %d override to %s%s, %s%s\n", gsi,
 678				t ? "level" : "edge",
 679				trig == triggering ? "" : "(!)",
 680				p ? "low" : "high",
 681				pol == polarity ? "" : "(!)");
 682			triggering = trig;
 683			polarity = pol;
 684		}
 685	}
 686
 687	res->flags = acpi_dev_irq_flags(triggering, polarity, shareable, wake_capable);
 688	irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
 689	if (irq >= 0) {
 690		res->start = irq;
 691		res->end = irq;
 692	} else {
 693		irqresource_disabled(res, gsi);
 694	}
 695}
 696
 697/**
 698 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
 699 * @ares: Input ACPI resource object.
 700 * @index: Index into the array of GSIs represented by the resource.
 701 * @res: Output generic resource object.
 702 *
 703 * Check if the given ACPI resource object represents an interrupt resource
 704 * and @index does not exceed the resource's interrupt count (true is returned
 705 * in that case regardless of the results of the other checks)).  If that's the
 706 * case, register the GSI corresponding to @index from the array of interrupts
 707 * represented by the resource and populate the generic resource object pointed
 708 * to by @res accordingly.  If the registration of the GSI is not successful,
 709 * IORESOURCE_DISABLED will be set it that object's flags.
 710 *
 711 * Return:
 712 * 1) false with res->flags setting to zero: not the expected resource type
 713 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
 714 * 3) true: valid assigned resource
 715 */
 716bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
 717				 struct resource *res)
 718{
 719	struct acpi_resource_irq *irq;
 720	struct acpi_resource_extended_irq *ext_irq;
 721
 722	switch (ares->type) {
 723	case ACPI_RESOURCE_TYPE_IRQ:
 724		/*
 725		 * Per spec, only one interrupt per descriptor is allowed in
 726		 * _CRS, but some firmware violates this, so parse them all.
 727		 */
 728		irq = &ares->data.irq;
 729		if (index >= irq->interrupt_count) {
 730			irqresource_disabled(res, 0);
 731			return false;
 732		}
 733		acpi_dev_get_irqresource(res, irq->interrupts[index],
 734					 irq->triggering, irq->polarity,
 735					 irq->shareable, irq->wake_capable,
 736					 true);
 737		break;
 738	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 739		ext_irq = &ares->data.extended_irq;
 740		if (index >= ext_irq->interrupt_count) {
 741			irqresource_disabled(res, 0);
 742			return false;
 743		}
 744		if (is_gsi(ext_irq))
 745			acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
 746					 ext_irq->triggering, ext_irq->polarity,
 747					 ext_irq->shareable, ext_irq->wake_capable,
 748					 false);
 749		else
 750			irqresource_disabled(res, 0);
 751		break;
 752	default:
 753		res->flags = 0;
 754		return false;
 755	}
 756
 757	return true;
 758}
 759EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
 760
 761/**
 762 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
 763 * @list: The head of the resource list to free.
 764 */
 765void acpi_dev_free_resource_list(struct list_head *list)
 766{
 767	resource_list_free(list);
 768}
 769EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
 770
 771struct res_proc_context {
 772	struct list_head *list;
 773	int (*preproc)(struct acpi_resource *, void *);
 774	void *preproc_data;
 775	int count;
 776	int error;
 777};
 778
 779static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
 780					       struct res_proc_context *c)
 781{
 782	struct resource_entry *rentry;
 783
 784	rentry = resource_list_create_entry(NULL, 0);
 785	if (!rentry) {
 786		c->error = -ENOMEM;
 787		return AE_NO_MEMORY;
 788	}
 789	*rentry->res = win->res;
 790	rentry->offset = win->offset;
 791	resource_list_add_tail(rentry, c->list);
 792	c->count++;
 793	return AE_OK;
 794}
 795
 796static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
 797					     void *context)
 798{
 799	struct res_proc_context *c = context;
 800	struct resource_win win;
 801	struct resource *res = &win.res;
 802	int i;
 803
 804	if (c->preproc) {
 805		int ret;
 806
 807		ret = c->preproc(ares, c->preproc_data);
 808		if (ret < 0) {
 809			c->error = ret;
 810			return AE_ABORT_METHOD;
 811		} else if (ret > 0) {
 812			return AE_OK;
 813		}
 814	}
 815
 816	memset(&win, 0, sizeof(win));
 817
 818	if (acpi_dev_resource_memory(ares, res)
 819	    || acpi_dev_resource_io(ares, res)
 820	    || acpi_dev_resource_address_space(ares, &win)
 821	    || acpi_dev_resource_ext_address_space(ares, &win))
 822		return acpi_dev_new_resource_entry(&win, c);
 823
 824	for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
 825		acpi_status status;
 826
 827		status = acpi_dev_new_resource_entry(&win, c);
 828		if (ACPI_FAILURE(status))
 829			return status;
 830	}
 831
 832	return AE_OK;
 833}
 834
 835static int __acpi_dev_get_resources(struct acpi_device *adev,
 836				    struct list_head *list,
 837				    int (*preproc)(struct acpi_resource *, void *),
 838				    void *preproc_data, char *method)
 839{
 840	struct res_proc_context c;
 841	acpi_status status;
 842
 843	if (!adev || !adev->handle || !list_empty(list))
 844		return -EINVAL;
 845
 846	if (!acpi_has_method(adev->handle, method))
 847		return 0;
 848
 849	c.list = list;
 850	c.preproc = preproc;
 851	c.preproc_data = preproc_data;
 852	c.count = 0;
 853	c.error = 0;
 854	status = acpi_walk_resources(adev->handle, method,
 855				     acpi_dev_process_resource, &c);
 856	if (ACPI_FAILURE(status)) {
 857		acpi_dev_free_resource_list(list);
 858		return c.error ? c.error : -EIO;
 859	}
 860
 861	return c.count;
 862}
 863
 864/**
 865 * acpi_dev_get_resources - Get current resources of a device.
 866 * @adev: ACPI device node to get the resources for.
 867 * @list: Head of the resultant list of resources (must be empty).
 868 * @preproc: The caller's preprocessing routine.
 869 * @preproc_data: Pointer passed to the caller's preprocessing routine.
 870 *
 871 * Evaluate the _CRS method for the given device node and process its output by
 872 * (1) executing the @preproc() routine provided by the caller, passing the
 873 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
 874 * returned and (2) converting all of the returned ACPI resources into struct
 875 * resource objects if possible.  If the return value of @preproc() in step (1)
 876 * is different from 0, step (2) is not applied to the given ACPI resource and
 877 * if that value is negative, the whole processing is aborted and that value is
 878 * returned as the final error code.
 879 *
 880 * The resultant struct resource objects are put on the list pointed to by
 881 * @list, that must be empty initially, as members of struct resource_entry
 882 * objects.  Callers of this routine should use %acpi_dev_free_resource_list() to
 883 * free that list.
 884 *
 885 * The number of resources in the output list is returned on success, an error
 886 * code reflecting the error condition is returned otherwise.
 887 */
 888int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
 889			   int (*preproc)(struct acpi_resource *, void *),
 890			   void *preproc_data)
 891{
 892	return __acpi_dev_get_resources(adev, list, preproc, preproc_data,
 893					METHOD_NAME__CRS);
 894}
 895EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
 896
 897static int is_memory(struct acpi_resource *ares, void *not_used)
 898{
 899	struct resource_win win;
 900	struct resource *res = &win.res;
 901
 902	memset(&win, 0, sizeof(win));
 903
 904	if (acpi_dev_filter_resource_type(ares, IORESOURCE_MEM))
 905		return 1;
 906
 907	return !(acpi_dev_resource_memory(ares, res)
 908	       || acpi_dev_resource_address_space(ares, &win)
 909	       || acpi_dev_resource_ext_address_space(ares, &win));
 910}
 911
 912/**
 913 * acpi_dev_get_dma_resources - Get current DMA resources of a device.
 914 * @adev: ACPI device node to get the resources for.
 915 * @list: Head of the resultant list of resources (must be empty).
 916 *
 917 * Evaluate the _DMA method for the given device node and process its
 918 * output.
 919 *
 920 * The resultant struct resource objects are put on the list pointed to
 921 * by @list, that must be empty initially, as members of struct
 922 * resource_entry objects.  Callers of this routine should use
 923 * %acpi_dev_free_resource_list() to free that list.
 924 *
 925 * The number of resources in the output list is returned on success,
 926 * an error code reflecting the error condition is returned otherwise.
 927 */
 928int acpi_dev_get_dma_resources(struct acpi_device *adev, struct list_head *list)
 929{
 930	return __acpi_dev_get_resources(adev, list, is_memory, NULL,
 931					METHOD_NAME__DMA);
 932}
 933EXPORT_SYMBOL_GPL(acpi_dev_get_dma_resources);
 934
 935/**
 936 * acpi_dev_get_memory_resources - Get current memory resources of a device.
 937 * @adev: ACPI device node to get the resources for.
 938 * @list: Head of the resultant list of resources (must be empty).
 939 *
 940 * This is a helper function that locates all memory type resources of @adev
 941 * with acpi_dev_get_resources().
 942 *
 943 * The number of resources in the output list is returned on success, an error
 944 * code reflecting the error condition is returned otherwise.
 945 */
 946int acpi_dev_get_memory_resources(struct acpi_device *adev, struct list_head *list)
 947{
 948	return acpi_dev_get_resources(adev, list, is_memory, NULL);
 949}
 950EXPORT_SYMBOL_GPL(acpi_dev_get_memory_resources);
 951
 952/**
 953 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
 954 *				   types
 955 * @ares: Input ACPI resource object.
 956 * @types: Valid resource types of IORESOURCE_XXX
 957 *
 958 * This is a helper function to support acpi_dev_get_resources(), which filters
 959 * ACPI resource objects according to resource types.
 960 */
 961int acpi_dev_filter_resource_type(struct acpi_resource *ares,
 962				  unsigned long types)
 963{
 964	unsigned long type = 0;
 965
 966	switch (ares->type) {
 967	case ACPI_RESOURCE_TYPE_MEMORY24:
 968	case ACPI_RESOURCE_TYPE_MEMORY32:
 969	case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
 970		type = IORESOURCE_MEM;
 971		break;
 972	case ACPI_RESOURCE_TYPE_IO:
 973	case ACPI_RESOURCE_TYPE_FIXED_IO:
 974		type = IORESOURCE_IO;
 975		break;
 976	case ACPI_RESOURCE_TYPE_IRQ:
 977	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 978		type = IORESOURCE_IRQ;
 979		break;
 980	case ACPI_RESOURCE_TYPE_DMA:
 981	case ACPI_RESOURCE_TYPE_FIXED_DMA:
 982		type = IORESOURCE_DMA;
 983		break;
 984	case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
 985		type = IORESOURCE_REG;
 986		break;
 987	case ACPI_RESOURCE_TYPE_ADDRESS16:
 988	case ACPI_RESOURCE_TYPE_ADDRESS32:
 989	case ACPI_RESOURCE_TYPE_ADDRESS64:
 990	case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
 991		if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
 992			type = IORESOURCE_MEM;
 993		else if (ares->data.address.resource_type == ACPI_IO_RANGE)
 994			type = IORESOURCE_IO;
 995		else if (ares->data.address.resource_type ==
 996			 ACPI_BUS_NUMBER_RANGE)
 997			type = IORESOURCE_BUS;
 998		break;
 999	default:
1000		break;
1001	}
1002
1003	return (type & types) ? 0 : 1;
1004}
1005EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
1006
1007static int acpi_dev_consumes_res(struct acpi_device *adev, struct resource *res)
1008{
1009	struct list_head resource_list;
1010	struct resource_entry *rentry;
1011	int ret, found = 0;
1012
1013	INIT_LIST_HEAD(&resource_list);
1014	ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
1015	if (ret < 0)
1016		return 0;
1017
1018	list_for_each_entry(rentry, &resource_list, node) {
1019		if (resource_contains(rentry->res, res)) {
1020			found = 1;
1021			break;
1022		}
1023
1024	}
1025
1026	acpi_dev_free_resource_list(&resource_list);
1027	return found;
1028}
1029
1030static acpi_status acpi_res_consumer_cb(acpi_handle handle, u32 depth,
1031					 void *context, void **ret)
1032{
1033	struct resource *res = context;
1034	struct acpi_device **consumer = (struct acpi_device **) ret;
1035	struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
1036
1037	if (!adev)
1038		return AE_OK;
1039
1040	if (acpi_dev_consumes_res(adev, res)) {
1041		*consumer = adev;
1042		return AE_CTRL_TERMINATE;
1043	}
1044
1045	return AE_OK;
1046}
1047
1048/**
1049 * acpi_resource_consumer - Find the ACPI device that consumes @res.
1050 * @res: Resource to search for.
1051 *
1052 * Search the current resource settings (_CRS) of every ACPI device node
1053 * for @res.  If we find an ACPI device whose _CRS includes @res, return
1054 * it.  Otherwise, return NULL.
1055 */
1056struct acpi_device *acpi_resource_consumer(struct resource *res)
1057{
1058	struct acpi_device *consumer = NULL;
1059
1060	acpi_get_devices(NULL, acpi_res_consumer_cb, res, (void **) &consumer);
1061	return consumer;
1062}
v4.17
 
  1/*
  2 * drivers/acpi/resource.c - ACPI device resources interpretation.
  3 *
  4 * Copyright (C) 2012, Intel Corp.
  5 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  6 *
  7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  8 *
  9 *  This program is free software; you can redistribute it and/or modify
 10 *  it under the terms of the GNU General Public License version 2 as published
 11 *  by the Free Software Foundation.
 12 *
 13 *  This program is distributed in the hope that it will be useful, but
 14 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 15 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 16 *  General Public License for more details.
 17 *
 18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 19 */
 20
 21#include <linux/acpi.h>
 22#include <linux/device.h>
 23#include <linux/export.h>
 24#include <linux/ioport.h>
 25#include <linux/slab.h>
 26#include <linux/irq.h>
 
 27
 28#ifdef CONFIG_X86
 29#define valid_IRQ(i) (((i) != 0) && ((i) != 2))
 30static inline bool acpi_iospace_resource_valid(struct resource *res)
 31{
 32	/* On X86 IO space is limited to the [0 - 64K] IO port range */
 33	return res->end < 0x10003;
 34}
 35#else
 36#define valid_IRQ(i) (true)
 37/*
 38 * ACPI IO descriptors on arches other than X86 contain MMIO CPU physical
 39 * addresses mapping IO space in CPU physical address space, IO space
 40 * resources can be placed anywhere in the 64-bit physical address space.
 41 */
 42static inline bool
 43acpi_iospace_resource_valid(struct resource *res) { return true; }
 44#endif
 45
 46#if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
 47static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
 48{
 49	return ext_irq->resource_source.string_length == 0 &&
 50	       ext_irq->producer_consumer == ACPI_CONSUMER;
 51}
 52#else
 53static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
 54{
 55	return true;
 56}
 57#endif
 58
 59static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
 60{
 61	u64 reslen = end - start + 1;
 62
 63	/*
 64	 * CHECKME: len might be required to check versus a minimum
 65	 * length as well. 1 for io is fine, but for memory it does
 66	 * not make any sense at all.
 67	 * Note: some BIOSes report incorrect length for ACPI address space
 68	 * descriptor, so remove check of 'reslen == len' to avoid regression.
 69	 */
 70	if (len && reslen && start <= end)
 71		return true;
 72
 73	pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
 74		io ? "io" : "mem", start, end, len);
 75
 76	return false;
 77}
 78
 79static void acpi_dev_memresource_flags(struct resource *res, u64 len,
 80				       u8 write_protect)
 81{
 82	res->flags = IORESOURCE_MEM;
 83
 84	if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
 85		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
 86
 87	if (write_protect == ACPI_READ_WRITE_MEMORY)
 88		res->flags |= IORESOURCE_MEM_WRITEABLE;
 89}
 90
 91static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
 92				     u8 write_protect)
 93{
 94	res->start = start;
 95	res->end = start + len - 1;
 96	acpi_dev_memresource_flags(res, len, write_protect);
 97}
 98
 99/**
100 * acpi_dev_resource_memory - Extract ACPI memory resource information.
101 * @ares: Input ACPI resource object.
102 * @res: Output generic resource object.
103 *
104 * Check if the given ACPI resource object represents a memory resource and
105 * if that's the case, use the information in it to populate the generic
106 * resource object pointed to by @res.
107 *
108 * Return:
109 * 1) false with res->flags setting to zero: not the expected resource type
110 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
111 * 3) true: valid assigned resource
112 */
113bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
114{
115	struct acpi_resource_memory24 *memory24;
116	struct acpi_resource_memory32 *memory32;
117	struct acpi_resource_fixed_memory32 *fixed_memory32;
118
119	switch (ares->type) {
120	case ACPI_RESOURCE_TYPE_MEMORY24:
121		memory24 = &ares->data.memory24;
122		acpi_dev_get_memresource(res, memory24->minimum << 8,
123					 memory24->address_length << 8,
124					 memory24->write_protect);
125		break;
126	case ACPI_RESOURCE_TYPE_MEMORY32:
127		memory32 = &ares->data.memory32;
128		acpi_dev_get_memresource(res, memory32->minimum,
129					 memory32->address_length,
130					 memory32->write_protect);
131		break;
132	case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
133		fixed_memory32 = &ares->data.fixed_memory32;
134		acpi_dev_get_memresource(res, fixed_memory32->address,
135					 fixed_memory32->address_length,
136					 fixed_memory32->write_protect);
137		break;
138	default:
139		res->flags = 0;
140		return false;
141	}
142
143	return !(res->flags & IORESOURCE_DISABLED);
144}
145EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
146
147static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
148				      u8 io_decode, u8 translation_type)
149{
150	res->flags = IORESOURCE_IO;
151
152	if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
153		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
154
155	if (!acpi_iospace_resource_valid(res))
156		res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
157
158	if (io_decode == ACPI_DECODE_16)
159		res->flags |= IORESOURCE_IO_16BIT_ADDR;
160	if (translation_type == ACPI_SPARSE_TRANSLATION)
161		res->flags |= IORESOURCE_IO_SPARSE;
162}
163
164static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
165				    u8 io_decode)
166{
167	res->start = start;
168	res->end = start + len - 1;
169	acpi_dev_ioresource_flags(res, len, io_decode, 0);
170}
171
172/**
173 * acpi_dev_resource_io - Extract ACPI I/O resource information.
174 * @ares: Input ACPI resource object.
175 * @res: Output generic resource object.
176 *
177 * Check if the given ACPI resource object represents an I/O resource and
178 * if that's the case, use the information in it to populate the generic
179 * resource object pointed to by @res.
180 *
181 * Return:
182 * 1) false with res->flags setting to zero: not the expected resource type
183 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
184 * 3) true: valid assigned resource
185 */
186bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
187{
188	struct acpi_resource_io *io;
189	struct acpi_resource_fixed_io *fixed_io;
190
191	switch (ares->type) {
192	case ACPI_RESOURCE_TYPE_IO:
193		io = &ares->data.io;
194		acpi_dev_get_ioresource(res, io->minimum,
195					io->address_length,
196					io->io_decode);
197		break;
198	case ACPI_RESOURCE_TYPE_FIXED_IO:
199		fixed_io = &ares->data.fixed_io;
200		acpi_dev_get_ioresource(res, fixed_io->address,
201					fixed_io->address_length,
202					ACPI_DECODE_10);
203		break;
204	default:
205		res->flags = 0;
206		return false;
207	}
208
209	return !(res->flags & IORESOURCE_DISABLED);
210}
211EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
212
213static bool acpi_decode_space(struct resource_win *win,
214			      struct acpi_resource_address *addr,
215			      struct acpi_address64_attribute *attr)
216{
217	u8 iodec = attr->granularity == 0xfff ? ACPI_DECODE_10 : ACPI_DECODE_16;
218	bool wp = addr->info.mem.write_protect;
219	u64 len = attr->address_length;
220	u64 start, end, offset = 0;
221	struct resource *res = &win->res;
222
223	/*
224	 * Filter out invalid descriptor according to ACPI Spec 5.0, section
225	 * 6.4.3.5 Address Space Resource Descriptors.
226	 */
227	if ((addr->min_address_fixed != addr->max_address_fixed && len) ||
228	    (addr->min_address_fixed && addr->max_address_fixed && !len))
229		pr_debug("ACPI: Invalid address space min_addr_fix %d, max_addr_fix %d, len %llx\n",
230			 addr->min_address_fixed, addr->max_address_fixed, len);
231
232	/*
233	 * For bridges that translate addresses across the bridge,
234	 * translation_offset is the offset that must be added to the
235	 * address on the secondary side to obtain the address on the
236	 * primary side. Non-bridge devices must list 0 for all Address
237	 * Translation offset bits.
238	 */
239	if (addr->producer_consumer == ACPI_PRODUCER)
240		offset = attr->translation_offset;
241	else if (attr->translation_offset)
242		pr_debug("ACPI: translation_offset(%lld) is invalid for non-bridge device.\n",
243			 attr->translation_offset);
244	start = attr->minimum + offset;
245	end = attr->maximum + offset;
246
247	win->offset = offset;
248	res->start = start;
249	res->end = end;
250	if (sizeof(resource_size_t) < sizeof(u64) &&
251	    (offset != win->offset || start != res->start || end != res->end)) {
252		pr_warn("acpi resource window ([%#llx-%#llx] ignored, not CPU addressable)\n",
253			attr->minimum, attr->maximum);
254		return false;
255	}
256
257	switch (addr->resource_type) {
258	case ACPI_MEMORY_RANGE:
259		acpi_dev_memresource_flags(res, len, wp);
260		break;
261	case ACPI_IO_RANGE:
262		acpi_dev_ioresource_flags(res, len, iodec,
263					  addr->info.io.translation_type);
264		break;
265	case ACPI_BUS_NUMBER_RANGE:
266		res->flags = IORESOURCE_BUS;
267		break;
268	default:
269		return false;
270	}
271
272	if (addr->producer_consumer == ACPI_PRODUCER)
273		res->flags |= IORESOURCE_WINDOW;
274
275	if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
276		res->flags |= IORESOURCE_PREFETCH;
277
278	return !(res->flags & IORESOURCE_DISABLED);
279}
280
281/**
282 * acpi_dev_resource_address_space - Extract ACPI address space information.
283 * @ares: Input ACPI resource object.
284 * @win: Output generic resource object.
285 *
286 * Check if the given ACPI resource object represents an address space resource
287 * and if that's the case, use the information in it to populate the generic
288 * resource object pointed to by @win.
289 *
290 * Return:
291 * 1) false with win->res.flags setting to zero: not the expected resource type
292 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
293 *    resource
294 * 3) true: valid assigned resource
295 */
296bool acpi_dev_resource_address_space(struct acpi_resource *ares,
297				     struct resource_win *win)
298{
299	struct acpi_resource_address64 addr;
300
301	win->res.flags = 0;
302	if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
303		return false;
304
305	return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
306				 &addr.address);
307}
308EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
309
310/**
311 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
312 * @ares: Input ACPI resource object.
313 * @win: Output generic resource object.
314 *
315 * Check if the given ACPI resource object represents an extended address space
316 * resource and if that's the case, use the information in it to populate the
317 * generic resource object pointed to by @win.
318 *
319 * Return:
320 * 1) false with win->res.flags setting to zero: not the expected resource type
321 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
322 *    resource
323 * 3) true: valid assigned resource
324 */
325bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
326					 struct resource_win *win)
327{
328	struct acpi_resource_extended_address64 *ext_addr;
329
330	win->res.flags = 0;
331	if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
332		return false;
333
334	ext_addr = &ares->data.ext_address64;
335
336	return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
337				 &ext_addr->address);
338}
339EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
340
341/**
342 * acpi_dev_irq_flags - Determine IRQ resource flags.
343 * @triggering: Triggering type as provided by ACPI.
344 * @polarity: Interrupt polarity as provided by ACPI.
345 * @shareable: Whether or not the interrupt is shareable.
 
346 */
347unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
348{
349	unsigned long flags;
350
351	if (triggering == ACPI_LEVEL_SENSITIVE)
352		flags = polarity == ACPI_ACTIVE_LOW ?
353			IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
354	else
355		flags = polarity == ACPI_ACTIVE_LOW ?
356			IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
357
358	if (shareable == ACPI_SHARED)
359		flags |= IORESOURCE_IRQ_SHAREABLE;
360
 
 
 
361	return flags | IORESOURCE_IRQ;
362}
363EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
364
365/**
366 * acpi_dev_get_irq_type - Determine irq type.
367 * @triggering: Triggering type as provided by ACPI.
368 * @polarity: Interrupt polarity as provided by ACPI.
369 */
370unsigned int acpi_dev_get_irq_type(int triggering, int polarity)
371{
372	switch (polarity) {
373	case ACPI_ACTIVE_LOW:
374		return triggering == ACPI_EDGE_SENSITIVE ?
375		       IRQ_TYPE_EDGE_FALLING :
376		       IRQ_TYPE_LEVEL_LOW;
377	case ACPI_ACTIVE_HIGH:
378		return triggering == ACPI_EDGE_SENSITIVE ?
379		       IRQ_TYPE_EDGE_RISING :
380		       IRQ_TYPE_LEVEL_HIGH;
381	case ACPI_ACTIVE_BOTH:
382		if (triggering == ACPI_EDGE_SENSITIVE)
383			return IRQ_TYPE_EDGE_BOTH;
384		/* fall through */
385	default:
386		return IRQ_TYPE_NONE;
387	}
388}
389EXPORT_SYMBOL_GPL(acpi_dev_get_irq_type);
390
391static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
392{
393	res->start = gsi;
394	res->end = gsi;
395	res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
396}
397
398static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
399				     u8 triggering, u8 polarity, u8 shareable,
400				     bool legacy)
401{
402	int irq, p, t;
403
404	if (!valid_IRQ(gsi)) {
405		acpi_dev_irqresource_disabled(res, gsi);
406		return;
407	}
408
409	/*
410	 * In IO-APIC mode, use overridden attribute. Two reasons:
411	 * 1. BIOS bug in DSDT
412	 * 2. BIOS uses IO-APIC mode Interrupt Source Override
413	 *
414	 * We do this only if we are dealing with IRQ() or IRQNoFlags()
415	 * resource (the legacy ISA resources). With modern ACPI 5 devices
416	 * using extended IRQ descriptors we take the IRQ configuration
417	 * from _CRS directly.
418	 */
419	if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
 
 
420		u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
421		u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
422
423		if (triggering != trig || polarity != pol) {
424			pr_warning("ACPI: IRQ %d override to %s, %s\n", gsi,
425				   t ? "level" : "edge", p ? "low" : "high");
 
 
 
426			triggering = trig;
427			polarity = pol;
428		}
429	}
430
431	res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
432	irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
433	if (irq >= 0) {
434		res->start = irq;
435		res->end = irq;
436	} else {
437		acpi_dev_irqresource_disabled(res, gsi);
438	}
439}
440
441/**
442 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
443 * @ares: Input ACPI resource object.
444 * @index: Index into the array of GSIs represented by the resource.
445 * @res: Output generic resource object.
446 *
447 * Check if the given ACPI resource object represents an interrupt resource
448 * and @index does not exceed the resource's interrupt count (true is returned
449 * in that case regardless of the results of the other checks)).  If that's the
450 * case, register the GSI corresponding to @index from the array of interrupts
451 * represented by the resource and populate the generic resource object pointed
452 * to by @res accordingly.  If the registration of the GSI is not successful,
453 * IORESOURCE_DISABLED will be set it that object's flags.
454 *
455 * Return:
456 * 1) false with res->flags setting to zero: not the expected resource type
457 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
458 * 3) true: valid assigned resource
459 */
460bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
461				 struct resource *res)
462{
463	struct acpi_resource_irq *irq;
464	struct acpi_resource_extended_irq *ext_irq;
465
466	switch (ares->type) {
467	case ACPI_RESOURCE_TYPE_IRQ:
468		/*
469		 * Per spec, only one interrupt per descriptor is allowed in
470		 * _CRS, but some firmware violates this, so parse them all.
471		 */
472		irq = &ares->data.irq;
473		if (index >= irq->interrupt_count) {
474			acpi_dev_irqresource_disabled(res, 0);
475			return false;
476		}
477		acpi_dev_get_irqresource(res, irq->interrupts[index],
478					 irq->triggering, irq->polarity,
479					 irq->sharable, true);
 
480		break;
481	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
482		ext_irq = &ares->data.extended_irq;
483		if (index >= ext_irq->interrupt_count) {
484			acpi_dev_irqresource_disabled(res, 0);
485			return false;
486		}
487		if (is_gsi(ext_irq))
488			acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
489					 ext_irq->triggering, ext_irq->polarity,
490					 ext_irq->sharable, false);
 
491		else
492			acpi_dev_irqresource_disabled(res, 0);
493		break;
494	default:
495		res->flags = 0;
496		return false;
497	}
498
499	return true;
500}
501EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
502
503/**
504 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
505 * @list: The head of the resource list to free.
506 */
507void acpi_dev_free_resource_list(struct list_head *list)
508{
509	resource_list_free(list);
510}
511EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
512
513struct res_proc_context {
514	struct list_head *list;
515	int (*preproc)(struct acpi_resource *, void *);
516	void *preproc_data;
517	int count;
518	int error;
519};
520
521static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
522					       struct res_proc_context *c)
523{
524	struct resource_entry *rentry;
525
526	rentry = resource_list_create_entry(NULL, 0);
527	if (!rentry) {
528		c->error = -ENOMEM;
529		return AE_NO_MEMORY;
530	}
531	*rentry->res = win->res;
532	rentry->offset = win->offset;
533	resource_list_add_tail(rentry, c->list);
534	c->count++;
535	return AE_OK;
536}
537
538static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
539					     void *context)
540{
541	struct res_proc_context *c = context;
542	struct resource_win win;
543	struct resource *res = &win.res;
544	int i;
545
546	if (c->preproc) {
547		int ret;
548
549		ret = c->preproc(ares, c->preproc_data);
550		if (ret < 0) {
551			c->error = ret;
552			return AE_CTRL_TERMINATE;
553		} else if (ret > 0) {
554			return AE_OK;
555		}
556	}
557
558	memset(&win, 0, sizeof(win));
559
560	if (acpi_dev_resource_memory(ares, res)
561	    || acpi_dev_resource_io(ares, res)
562	    || acpi_dev_resource_address_space(ares, &win)
563	    || acpi_dev_resource_ext_address_space(ares, &win))
564		return acpi_dev_new_resource_entry(&win, c);
565
566	for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
567		acpi_status status;
568
569		status = acpi_dev_new_resource_entry(&win, c);
570		if (ACPI_FAILURE(status))
571			return status;
572	}
573
574	return AE_OK;
575}
576
577static int __acpi_dev_get_resources(struct acpi_device *adev,
578				    struct list_head *list,
579				    int (*preproc)(struct acpi_resource *, void *),
580				    void *preproc_data, char *method)
581{
582	struct res_proc_context c;
583	acpi_status status;
584
585	if (!adev || !adev->handle || !list_empty(list))
586		return -EINVAL;
587
588	if (!acpi_has_method(adev->handle, method))
589		return 0;
590
591	c.list = list;
592	c.preproc = preproc;
593	c.preproc_data = preproc_data;
594	c.count = 0;
595	c.error = 0;
596	status = acpi_walk_resources(adev->handle, method,
597				     acpi_dev_process_resource, &c);
598	if (ACPI_FAILURE(status)) {
599		acpi_dev_free_resource_list(list);
600		return c.error ? c.error : -EIO;
601	}
602
603	return c.count;
604}
605
606/**
607 * acpi_dev_get_resources - Get current resources of a device.
608 * @adev: ACPI device node to get the resources for.
609 * @list: Head of the resultant list of resources (must be empty).
610 * @preproc: The caller's preprocessing routine.
611 * @preproc_data: Pointer passed to the caller's preprocessing routine.
612 *
613 * Evaluate the _CRS method for the given device node and process its output by
614 * (1) executing the @preproc() rountine provided by the caller, passing the
615 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
616 * returned and (2) converting all of the returned ACPI resources into struct
617 * resource objects if possible.  If the return value of @preproc() in step (1)
618 * is different from 0, step (2) is not applied to the given ACPI resource and
619 * if that value is negative, the whole processing is aborted and that value is
620 * returned as the final error code.
621 *
622 * The resultant struct resource objects are put on the list pointed to by
623 * @list, that must be empty initially, as members of struct resource_entry
624 * objects.  Callers of this routine should use %acpi_dev_free_resource_list() to
625 * free that list.
626 *
627 * The number of resources in the output list is returned on success, an error
628 * code reflecting the error condition is returned otherwise.
629 */
630int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
631			   int (*preproc)(struct acpi_resource *, void *),
632			   void *preproc_data)
633{
634	return __acpi_dev_get_resources(adev, list, preproc, preproc_data,
635					METHOD_NAME__CRS);
636}
637EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
638
639static int is_memory(struct acpi_resource *ares, void *not_used)
640{
641	struct resource_win win;
642	struct resource *res = &win.res;
643
644	memset(&win, 0, sizeof(win));
645
 
 
 
646	return !(acpi_dev_resource_memory(ares, res)
647	       || acpi_dev_resource_address_space(ares, &win)
648	       || acpi_dev_resource_ext_address_space(ares, &win));
649}
650
651/**
652 * acpi_dev_get_dma_resources - Get current DMA resources of a device.
653 * @adev: ACPI device node to get the resources for.
654 * @list: Head of the resultant list of resources (must be empty).
655 *
656 * Evaluate the _DMA method for the given device node and process its
657 * output.
658 *
659 * The resultant struct resource objects are put on the list pointed to
660 * by @list, that must be empty initially, as members of struct
661 * resource_entry objects.  Callers of this routine should use
662 * %acpi_dev_free_resource_list() to free that list.
663 *
664 * The number of resources in the output list is returned on success,
665 * an error code reflecting the error condition is returned otherwise.
666 */
667int acpi_dev_get_dma_resources(struct acpi_device *adev, struct list_head *list)
668{
669	return __acpi_dev_get_resources(adev, list, is_memory, NULL,
670					METHOD_NAME__DMA);
671}
672EXPORT_SYMBOL_GPL(acpi_dev_get_dma_resources);
673
674/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
675 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
676 *				   types
677 * @ares: Input ACPI resource object.
678 * @types: Valid resource types of IORESOURCE_XXX
679 *
680 * This is a helper function to support acpi_dev_get_resources(), which filters
681 * ACPI resource objects according to resource types.
682 */
683int acpi_dev_filter_resource_type(struct acpi_resource *ares,
684				  unsigned long types)
685{
686	unsigned long type = 0;
687
688	switch (ares->type) {
689	case ACPI_RESOURCE_TYPE_MEMORY24:
690	case ACPI_RESOURCE_TYPE_MEMORY32:
691	case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
692		type = IORESOURCE_MEM;
693		break;
694	case ACPI_RESOURCE_TYPE_IO:
695	case ACPI_RESOURCE_TYPE_FIXED_IO:
696		type = IORESOURCE_IO;
697		break;
698	case ACPI_RESOURCE_TYPE_IRQ:
699	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
700		type = IORESOURCE_IRQ;
701		break;
702	case ACPI_RESOURCE_TYPE_DMA:
703	case ACPI_RESOURCE_TYPE_FIXED_DMA:
704		type = IORESOURCE_DMA;
705		break;
706	case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
707		type = IORESOURCE_REG;
708		break;
709	case ACPI_RESOURCE_TYPE_ADDRESS16:
710	case ACPI_RESOURCE_TYPE_ADDRESS32:
711	case ACPI_RESOURCE_TYPE_ADDRESS64:
712	case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
713		if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
714			type = IORESOURCE_MEM;
715		else if (ares->data.address.resource_type == ACPI_IO_RANGE)
716			type = IORESOURCE_IO;
717		else if (ares->data.address.resource_type ==
718			 ACPI_BUS_NUMBER_RANGE)
719			type = IORESOURCE_BUS;
720		break;
721	default:
722		break;
723	}
724
725	return (type & types) ? 0 : 1;
726}
727EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
728
729static int acpi_dev_consumes_res(struct acpi_device *adev, struct resource *res)
730{
731	struct list_head resource_list;
732	struct resource_entry *rentry;
733	int ret, found = 0;
734
735	INIT_LIST_HEAD(&resource_list);
736	ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
737	if (ret < 0)
738		return 0;
739
740	list_for_each_entry(rentry, &resource_list, node) {
741		if (resource_contains(rentry->res, res)) {
742			found = 1;
743			break;
744		}
745
746	}
747
748	acpi_dev_free_resource_list(&resource_list);
749	return found;
750}
751
752static acpi_status acpi_res_consumer_cb(acpi_handle handle, u32 depth,
753					 void *context, void **ret)
754{
755	struct resource *res = context;
756	struct acpi_device **consumer = (struct acpi_device **) ret;
757	struct acpi_device *adev;
758
759	if (acpi_bus_get_device(handle, &adev))
760		return AE_OK;
761
762	if (acpi_dev_consumes_res(adev, res)) {
763		*consumer = adev;
764		return AE_CTRL_TERMINATE;
765	}
766
767	return AE_OK;
768}
769
770/**
771 * acpi_resource_consumer - Find the ACPI device that consumes @res.
772 * @res: Resource to search for.
773 *
774 * Search the current resource settings (_CRS) of every ACPI device node
775 * for @res.  If we find an ACPI device whose _CRS includes @res, return
776 * it.  Otherwise, return NULL.
777 */
778struct acpi_device *acpi_resource_consumer(struct resource *res)
779{
780	struct acpi_device *consumer = NULL;
781
782	acpi_get_devices(NULL, acpi_res_consumer_cb, res, (void **) &consumer);
783	return consumer;
784}