| // SPDX-License-Identifier: GPL-2.0 |
| /* |
| * Generation of tables for particular device types |
| * |
| * Copyright 2019 Google LLC |
| * Mostly taken from coreboot file of the same name |
| */ |
| |
| #include <common.h> |
| #include <dm.h> |
| #include <irq.h> |
| #include <log.h> |
| #include <acpi/acpi_device.h> |
| #include <acpi/acpigen.h> |
| #include <asm-generic/gpio.h> |
| #include <dm/acpi.h> |
| |
| /** |
| * acpi_device_path_fill() - Find the root device and build a path from there |
| * |
| * This recursively reaches back to the root device and progressively adds path |
| * elements until the device is reached. |
| * |
| * @dev: Device to return path of |
| * @buf: Buffer to hold the path |
| * @buf_len: Length of buffer |
| * @cur: Current position in the buffer |
| * @return new position in buffer after adding @dev, or -ve on error |
| */ |
| static int acpi_device_path_fill(const struct udevice *dev, char *buf, |
| size_t buf_len, int cur) |
| { |
| char name[ACPI_NAME_MAX]; |
| int next = 0; |
| int ret; |
| |
| ret = acpi_get_name(dev, name); |
| if (ret) |
| return ret; |
| |
| /* |
| * Make sure this name segment will fit, including the path segment |
| * separator and possible NULL terminator, if this is the last segment. |
| */ |
| if (cur + strlen(name) + 2 > buf_len) |
| return -ENOSPC; |
| |
| /* Walk up the tree to the root device */ |
| if (dev_get_parent(dev)) { |
| next = acpi_device_path_fill(dev_get_parent(dev), buf, buf_len, |
| cur); |
| if (next < 0) |
| return next; |
| } |
| |
| /* Fill in the path from the root device */ |
| next += snprintf(buf + next, buf_len - next, "%s%s", |
| dev_get_parent(dev) && *name ? "." : "", name); |
| |
| return next; |
| } |
| |
| int acpi_device_path(const struct udevice *dev, char *buf, int maxlen) |
| { |
| int ret; |
| |
| ret = acpi_device_path_fill(dev, buf, maxlen, 0); |
| if (ret < 0) |
| return ret; |
| |
| return 0; |
| } |
| |
| int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen) |
| { |
| int ret; |
| |
| if (!dev_get_parent(dev)) |
| return log_msg_ret("noparent", -EINVAL); |
| |
| ret = acpi_device_path_fill(dev_get_parent(dev), scope, maxlen, 0); |
| if (ret < 0) |
| return log_msg_ret("fill", ret); |
| |
| return 0; |
| } |
| |
| enum acpi_dev_status acpi_device_status(const struct udevice *dev) |
| { |
| return ACPI_DSTATUS_ALL_ON; |
| } |
| |
| /** |
| * largeres_write_len_f() - Write a placeholder word value |
| * |
| * Write a forward length for a large resource (2 bytes) |
| * |
| * @return pointer to the zero word (for fixing up later) |
| */ |
| static void *largeres_write_len_f(struct acpi_ctx *ctx) |
| { |
| u8 *p = acpigen_get_current(ctx); |
| |
| acpigen_emit_word(ctx, 0); |
| |
| return p; |
| } |
| |
| /** |
| * largeres_fill_from_len() - Fill in a length value |
| * |
| * This calculated the number of bytes since the provided @start and writes it |
| * to @ptr, which was previous returned by largeres_write_len_f(). |
| * |
| * @ptr: Word to update |
| * @start: Start address to count from to calculated the length |
| */ |
| static void largeres_fill_from_len(struct acpi_ctx *ctx, char *ptr, u8 *start) |
| { |
| u16 len = acpigen_get_current(ctx) - start; |
| |
| ptr[0] = len & 0xff; |
| ptr[1] = (len >> 8) & 0xff; |
| } |
| |
| /** |
| * largeres_fill_len() - Fill in a length value, excluding the length itself |
| * |
| * Fill in the length field with the value calculated from after the 16bit |
| * field to acpigen current. This is useful since the length value does not |
| * include the length field itself. |
| * |
| * This calls acpi_device_largeres_fill_len() passing @ptr + 2 as @start |
| * |
| * @ptr: Word to update. |
| */ |
| static void largeres_fill_len(struct acpi_ctx *ctx, void *ptr) |
| { |
| largeres_fill_from_len(ctx, ptr, ptr + sizeof(u16)); |
| } |
| |
| /* ACPI 6.3 section 6.4.3.6: Extended Interrupt Descriptor */ |
| static int acpi_device_write_interrupt(struct acpi_ctx *ctx, |
| const struct acpi_irq *irq) |
| { |
| void *desc_length; |
| u8 flags; |
| |
| if (!irq->pin) |
| return -ENOENT; |
| |
| /* This is supported by GpioInt() but not Interrupt() */ |
| if (irq->polarity == ACPI_IRQ_ACTIVE_BOTH) |
| return -EINVAL; |
| |
| /* Byte 0: Descriptor Type */ |
| acpigen_emit_byte(ctx, ACPI_DESCRIPTOR_INTERRUPT); |
| |
| /* Byte 1-2: Length (filled in later) */ |
| desc_length = largeres_write_len_f(ctx); |
| |
| /* |
| * Byte 3: Flags |
| * [7:5]: Reserved |
| * [4]: Wake (0=NO_WAKE 1=WAKE) |
| * [3]: Sharing (0=EXCLUSIVE 1=SHARED) |
| * [2]: Polarity (0=HIGH 1=LOW) |
| * [1]: Mode (0=LEVEL 1=EDGE) |
| * [0]: Resource (0=PRODUCER 1=CONSUMER) |
| */ |
| flags = BIT(0); /* ResourceConsumer */ |
| if (irq->mode == ACPI_IRQ_EDGE_TRIGGERED) |
| flags |= BIT(1); |
| if (irq->polarity == ACPI_IRQ_ACTIVE_LOW) |
| flags |= BIT(2); |
| if (irq->shared == ACPI_IRQ_SHARED) |
| flags |= BIT(3); |
| if (irq->wake == ACPI_IRQ_WAKE) |
| flags |= BIT(4); |
| acpigen_emit_byte(ctx, flags); |
| |
| /* Byte 4: Interrupt Table Entry Count */ |
| acpigen_emit_byte(ctx, 1); |
| |
| /* Byte 5-8: Interrupt Number */ |
| acpigen_emit_dword(ctx, irq->pin); |
| |
| /* Fill in Descriptor Length (account for len word) */ |
| largeres_fill_len(ctx, desc_length); |
| |
| return 0; |
| } |
| |
| int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx, |
| const struct irq *req_irq) |
| { |
| struct acpi_irq irq; |
| int ret; |
| |
| ret = irq_get_acpi(req_irq, &irq); |
| if (ret) |
| return log_msg_ret("get", ret); |
| ret = acpi_device_write_interrupt(ctx, &irq); |
| if (ret) |
| return log_msg_ret("write", ret); |
| |
| return irq.pin; |
| } |
| |
| /* ACPI 6.3 section 6.4.3.8.1 - GPIO Interrupt or I/O */ |
| int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio) |
| { |
| void *start, *desc_length; |
| void *pin_table_offset, *vendor_data_offset, *resource_offset; |
| u16 flags = 0; |
| int pin; |
| |
| if (gpio->type > ACPI_GPIO_TYPE_IO) |
| return -EINVAL; |
| |
| start = acpigen_get_current(ctx); |
| |
| /* Byte 0: Descriptor Type */ |
| acpigen_emit_byte(ctx, ACPI_DESCRIPTOR_GPIO); |
| |
| /* Byte 1-2: Length (fill in later) */ |
| desc_length = largeres_write_len_f(ctx); |
| |
| /* Byte 3: Revision ID */ |
| acpigen_emit_byte(ctx, ACPI_GPIO_REVISION_ID); |
| |
| /* Byte 4: GpioIo or GpioInt */ |
| acpigen_emit_byte(ctx, gpio->type); |
| |
| /* |
| * Byte 5-6: General Flags |
| * [15:1]: 0 => Reserved |
| * [0]: 1 => ResourceConsumer |
| */ |
| acpigen_emit_word(ctx, 1 << 0); |
| |
| switch (gpio->type) { |
| case ACPI_GPIO_TYPE_INTERRUPT: |
| /* |
| * Byte 7-8: GPIO Interrupt Flags |
| * [15:5]: 0 => Reserved |
| * [4]: Wake (0=NO_WAKE 1=WAKE) |
| * [3]: Sharing (0=EXCLUSIVE 1=SHARED) |
| * [2:1]: Polarity (0=HIGH 1=LOW 2=BOTH) |
| * [0]: Mode (0=LEVEL 1=EDGE) |
| */ |
| if (gpio->irq.mode == ACPI_IRQ_EDGE_TRIGGERED) |
| flags |= 1 << 0; |
| if (gpio->irq.shared == ACPI_IRQ_SHARED) |
| flags |= 1 << 3; |
| if (gpio->irq.wake == ACPI_IRQ_WAKE) |
| flags |= 1 << 4; |
| |
| switch (gpio->irq.polarity) { |
| case ACPI_IRQ_ACTIVE_HIGH: |
| flags |= 0 << 1; |
| break; |
| case ACPI_IRQ_ACTIVE_LOW: |
| flags |= 1 << 1; |
| break; |
| case ACPI_IRQ_ACTIVE_BOTH: |
| flags |= 2 << 1; |
| break; |
| } |
| break; |
| |
| case ACPI_GPIO_TYPE_IO: |
| /* |
| * Byte 7-8: GPIO IO Flags |
| * [15:4]: 0 => Reserved |
| * [3]: Sharing (0=EXCLUSIVE 1=SHARED) |
| * [2]: 0 => Reserved |
| * [1:0]: IO Restriction |
| * 0 => IoRestrictionNone |
| * 1 => IoRestrictionInputOnly |
| * 2 => IoRestrictionOutputOnly |
| * 3 => IoRestrictionNoneAndPreserve |
| */ |
| flags |= gpio->io_restrict & 3; |
| if (gpio->io_shared) |
| flags |= 1 << 3; |
| break; |
| } |
| acpigen_emit_word(ctx, flags); |
| |
| /* |
| * Byte 9: Pin Configuration |
| * 0x01 => Default (no configuration applied) |
| * 0x02 => Pull-up |
| * 0x03 => Pull-down |
| * 0x04-0x7F => Reserved |
| * 0x80-0xff => Vendor defined |
| */ |
| acpigen_emit_byte(ctx, gpio->pull); |
| |
| /* Byte 10-11: Output Drive Strength in 1/100 mA */ |
| acpigen_emit_word(ctx, gpio->output_drive_strength); |
| |
| /* Byte 12-13: Debounce Timeout in 1/100 ms */ |
| acpigen_emit_word(ctx, gpio->interrupt_debounce_timeout); |
| |
| /* Byte 14-15: Pin Table Offset, relative to start */ |
| pin_table_offset = largeres_write_len_f(ctx); |
| |
| /* Byte 16: Reserved */ |
| acpigen_emit_byte(ctx, 0); |
| |
| /* Byte 17-18: Resource Source Name Offset, relative to start */ |
| resource_offset = largeres_write_len_f(ctx); |
| |
| /* Byte 19-20: Vendor Data Offset, relative to start */ |
| vendor_data_offset = largeres_write_len_f(ctx); |
| |
| /* Byte 21-22: Vendor Data Length */ |
| acpigen_emit_word(ctx, 0); |
| |
| /* Fill in Pin Table Offset */ |
| largeres_fill_from_len(ctx, pin_table_offset, start); |
| |
| /* Pin Table, one word for each pin */ |
| for (pin = 0; pin < gpio->pin_count; pin++) |
| acpigen_emit_word(ctx, gpio->pins[pin]); |
| |
| /* Fill in Resource Source Name Offset */ |
| largeres_fill_from_len(ctx, resource_offset, start); |
| |
| /* Resource Source Name String */ |
| acpigen_emit_string(ctx, gpio->resource); |
| |
| /* Fill in Vendor Data Offset */ |
| largeres_fill_from_len(ctx, vendor_data_offset, start); |
| |
| /* Fill in GPIO Descriptor Length (account for len word) */ |
| largeres_fill_len(ctx, desc_length); |
| |
| return gpio->pins[0]; |
| } |
| |
| int acpi_device_write_gpio_desc(struct acpi_ctx *ctx, |
| const struct gpio_desc *desc) |
| { |
| struct acpi_gpio gpio; |
| int ret; |
| |
| ret = gpio_get_acpi(desc, &gpio); |
| if (ret) |
| return log_msg_ret("desc", ret); |
| ret = acpi_device_write_gpio(ctx, &gpio); |
| if (ret < 0) |
| return log_msg_ret("gpio", ret); |
| |
| return ret; |
| } |
| |
| int acpi_device_write_interrupt_or_gpio(struct acpi_ctx *ctx, |
| struct udevice *dev, const char *prop) |
| { |
| struct irq req_irq; |
| int pin; |
| int ret; |
| |
| ret = irq_get_by_index(dev, 0, &req_irq); |
| if (!ret) { |
| ret = acpi_device_write_interrupt_irq(ctx, &req_irq); |
| if (ret < 0) |
| return log_msg_ret("irq", ret); |
| pin = ret; |
| } else { |
| struct gpio_desc req_gpio; |
| |
| ret = gpio_request_by_name(dev, prop, 0, &req_gpio, |
| GPIOD_IS_IN); |
| if (ret) |
| return log_msg_ret("no gpio", ret); |
| ret = acpi_device_write_gpio_desc(ctx, &req_gpio); |
| if (ret < 0) |
| return log_msg_ret("gpio", ret); |
| pin = ret; |
| } |
| |
| return pin; |
| } |
| |
| /* ACPI 6.3 section 6.4.3.8.2.1 - I2cSerialBus() */ |
| static void acpi_device_write_i2c(struct acpi_ctx *ctx, |
| const struct acpi_i2c *i2c) |
| { |
| void *desc_length, *type_length; |
| |
| /* Byte 0: Descriptor Type */ |
| acpigen_emit_byte(ctx, ACPI_DESCRIPTOR_SERIAL_BUS); |
| |
| /* Byte 1+2: Length (filled in later) */ |
| desc_length = largeres_write_len_f(ctx); |
| |
| /* Byte 3: Revision ID */ |
| acpigen_emit_byte(ctx, ACPI_I2C_SERIAL_BUS_REVISION_ID); |
| |
| /* Byte 4: Resource Source Index is Reserved */ |
| acpigen_emit_byte(ctx, 0); |
| |
| /* Byte 5: Serial Bus Type is I2C */ |
| acpigen_emit_byte(ctx, ACPI_SERIAL_BUS_TYPE_I2C); |
| |
| /* |
| * Byte 6: Flags |
| * [7:2]: 0 => Reserved |
| * [1]: 1 => ResourceConsumer |
| * [0]: 0 => ControllerInitiated |
| */ |
| acpigen_emit_byte(ctx, 1 << 1); |
| |
| /* |
| * Byte 7-8: Type Specific Flags |
| * [15:1]: 0 => Reserved |
| * [0]: 0 => 7bit, 1 => 10bit |
| */ |
| acpigen_emit_word(ctx, i2c->mode_10bit); |
| |
| /* Byte 9: Type Specific Revision ID */ |
| acpigen_emit_byte(ctx, ACPI_I2C_TYPE_SPECIFIC_REVISION_ID); |
| |
| /* Byte 10-11: I2C Type Data Length */ |
| type_length = largeres_write_len_f(ctx); |
| |
| /* Byte 12-15: I2C Bus Speed */ |
| acpigen_emit_dword(ctx, i2c->speed); |
| |
| /* Byte 16-17: I2C Slave Address */ |
| acpigen_emit_word(ctx, i2c->address); |
| |
| /* Fill in Type Data Length */ |
| largeres_fill_len(ctx, type_length); |
| |
| /* Byte 18+: ResourceSource */ |
| acpigen_emit_string(ctx, i2c->resource); |
| |
| /* Fill in I2C Descriptor Length */ |
| largeres_fill_len(ctx, desc_length); |
| } |
| |
| /** |
| * acpi_device_set_i2c() - Set up an ACPI I2C struct from a device |
| * |
| * The value of @scope is not copied, but only referenced. This implies the |
| * caller has to ensure it stays valid for the lifetime of @i2c. |
| * |
| * @dev: I2C device to convert |
| * @i2c: Place to put the new structure |
| * @scope: Scope of the I2C device (this is the controller path) |
| * @return chip address of device |
| */ |
| static int acpi_device_set_i2c(const struct udevice *dev, struct acpi_i2c *i2c, |
| const char *scope) |
| { |
| struct dm_i2c_chip *chip = dev_get_parent_platdata(dev); |
| struct udevice *bus = dev_get_parent(dev); |
| |
| memset(i2c, '\0', sizeof(*i2c)); |
| i2c->address = chip->chip_addr; |
| i2c->mode_10bit = 0; |
| |
| /* |
| * i2c_bus->speed_hz is set if this device is probed, but if not we |
| * must use the device tree |
| */ |
| i2c->speed = dev_read_u32_default(bus, "clock-frequency", |
| I2C_SPEED_STANDARD_RATE); |
| i2c->resource = scope; |
| |
| return i2c->address; |
| } |
| |
| int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev) |
| { |
| char scope[ACPI_PATH_MAX]; |
| struct acpi_i2c i2c; |
| int ret; |
| |
| ret = acpi_device_scope(dev, scope, sizeof(scope)); |
| if (ret) |
| return log_msg_ret("scope", ret); |
| ret = acpi_device_set_i2c(dev, &i2c, scope); |
| if (ret < 0) |
| return log_msg_ret("set", ret); |
| acpi_device_write_i2c(ctx, &i2c); |
| |
| return ret; |
| } |