[020/108] acpi: Add a method to write tables for a device

A device may want to write out ACPI tables to describe itself to Linux.
Add a method to permit this.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 arch/sandbox/dts/test.dts |  4 ++++
 drivers/core/acpi.c       | 33 ++++++++++++++++++++++++++++++
 include/acpi_table.h      |  1 +
 include/dm/acpi.h         | 30 +++++++++++++++++++++++++++
 test/dm/acpi.c            | 43 +++++++++++++++++++++++++++++++++++++++
 5 files changed, 111 insertions(+)

Hi Simon,

On Mon, Jan 27, 2020 at 1:08 PM Simon Glass <sjg@chromium.org> wrote:
>
> A device may want to write out ACPI tables to describe itself to Linux.
> Add a method to permit this.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
>  arch/sandbox/dts/test.dts |  4 ++++
>  drivers/core/acpi.c       | 33 ++++++++++++++++++++++++++++++
>  include/acpi_table.h      |  1 +
>  include/dm/acpi.h         | 30 +++++++++++++++++++++++++++
>  test/dm/acpi.c            | 43 +++++++++++++++++++++++++++++++++++++++
>  5 files changed, 111 insertions(+)
>
> diff --git a/arch/sandbox/dts/test.dts b/arch/sandbox/dts/test.dts
> index 34dc7fda98..82208de5a8 100644
> --- a/arch/sandbox/dts/test.dts
> +++ b/arch/sandbox/dts/test.dts
> @@ -210,6 +210,10 @@
>                 compatible = "denx,u-boot-acpi-test";
>         };
>
> +       acpi-test2 {
> +               compatible = "denx,u-boot-acpi-test";
> +       };
> +
>         clocks {
>                 clk_fixed: clk-fixed {
>                         compatible = "fixed-clock";
> diff --git a/drivers/core/acpi.c b/drivers/core/acpi.c
> index 45542199f5..f748aa3f33 100644
> --- a/drivers/core/acpi.c
> +++ b/drivers/core/acpi.c
> @@ -30,3 +30,36 @@ int acpi_get_name(const struct udevice *dev, char *out_name)
>
>         return -ENOSYS;
>  }
> +
> +int _acpi_write_dev_tables(struct acpi_ctx *ctx, const struct udevice *parent)

Is this supposed to a public API? Otherwise we have to use static.

nits: to align with the signature of aops->write_tables(), can we
exchange the parameter order to have parent come first?

> +{
> +       struct acpi_ops *aops;
> +       struct udevice *dev;
> +       int ret;
> +
> +       aops = device_get_acpi_ops(parent);
> +       if (aops && aops->write_tables) {
> +               log_debug("- %s\n", parent->name);
> +               ret = aops->write_tables(parent, ctx);
> +               if (ret)
> +                       return ret;
> +       }
> +       device_foreach_child(dev, parent) {
> +               ret = _acpi_write_dev_tables(ctx, dev);
> +               if (ret)
> +                       return ret;
> +       }
> +
> +       return 0;
> +}
> +
> +int acpi_write_dev_tables(struct acpi_ctx *ctx)
> +{
> +       int ret;
> +
> +       log_debug("Writing device tables\n");
> +       ret = _acpi_write_dev_tables(ctx, dm_root());
> +       log_debug("Writing finished, err=%d\n", ret);
> +
> +       return ret;
> +}
> diff --git a/include/acpi_table.h b/include/acpi_table.h
> index 9904e421c3..20b8904fe7 100644
> --- a/include/acpi_table.h
> +++ b/include/acpi_table.h
> @@ -17,6 +17,7 @@
>  #define OEM_ID                 "U-BOOT"        /* U-Boot */
>  #define OEM_TABLE_ID           "U-BOOTBL"      /* U-Boot Table */
>  #define ASLC_ID                        "INTL"          /* Intel ASL Compiler */
> +#define ACPI_TABLE_CREATOR     OEM_TABLE_ID

This macro is not used in this patch. Probably need to move it to the
commit where it gets used.

>
>  #define ACPI_RSDP_REV_ACPI_1_0 0
>  #define ACPI_RSDP_REV_ACPI_2_0 2
> diff --git a/include/dm/acpi.h b/include/dm/acpi.h
> index 8d6c3fd424..dcfcf5c347 100644
> --- a/include/dm/acpi.h
> +++ b/include/dm/acpi.h
> @@ -24,6 +24,17 @@
>
>  #if !defined(__ACPI__)
>
> +/**
> + * struct acpi_ctx - Context used for writing ACPI tables
> + *
> + * This contains a few useful pieces of information used when writing
> + *
> + * @current: Current address for writing
> + */
> +struct acpi_ctx {
> +       void *current;
> +};
> +
>  /**
>   * struct acpi_ops - ACPI operations supported by driver model
>   */
> @@ -38,6 +49,15 @@ struct acpi_ops {
>          *      other error
>          */
>         int (*get_name)(const struct udevice *dev, char *out_name);
> +
> +       /**
> +        * write_tables() - Write out any tables required by this device
> +        *
> +        * @dev: Device to write
> +        * @ctx: ACPI context to use
> +        * @return 0 if OK, -ve on error
> +        */
> +       int (*write_tables)(const struct udevice *dev, struct acpi_ctx *ctx);
>  };
>
>  #define device_get_acpi_ops(dev)       ((dev)->driver->acpi_ops)
> @@ -72,6 +92,16 @@ int acpi_get_name(const struct udevice *dev, char *out_name);
>   */
>  int acpi_return_name(char *out_name, const char *name);
>
> +/**
> + * acpi_write_dev_tables() - Write ACPI tables required by devices
> + *
> + * This scans through all devices and tells them to write any tables they want
> + * to write.
> + *
> + * @return 0 if OK, -ve if any device returned an error
> + */
> +int acpi_write_dev_tables(struct acpi_ctx *ctx);
> +
>  #endif /* __ACPI__ */
>
>  #endif
> diff --git a/test/dm/acpi.c b/test/dm/acpi.c
> index e28ebf4f90..b87fbd16b0 100644
> --- a/test/dm/acpi.c
> +++ b/test/dm/acpi.c
> @@ -15,6 +15,19 @@
>  #include <test/ut.h>
>
>  #define ACPI_TEST_DEV_NAME     "ABCD"
> +#define BUF_SIZE               4096
> +
> +static int testacpi_write_tables(const struct udevice *dev,
> +                                struct acpi_ctx *ctx)
> +{
> +       struct acpi_dmar *dmar;
> +
> +       dmar = (struct acpi_dmar *)ctx->current;
> +       acpi_create_dmar(dmar, DMAR_INTR_REMAP);
> +       ctx->current += sizeof(struct acpi_dmar);
> +
> +       return 0;
> +}
>
>  static int testacpi_get_name(const struct udevice *dev, char *out_name)
>  {
> @@ -23,6 +36,7 @@ static int testacpi_get_name(const struct udevice *dev, char *out_name)
>
>  struct acpi_ops testacpi_ops = {
>         .get_name       = testacpi_get_name,
> +       .write_tables   = testacpi_write_tables,
>  };
>
>  static const struct udevice_id testacpi_ids[] = {
> @@ -109,3 +123,32 @@ static int dm_test_acpi_fill_header(struct unit_test_state *uts)
>         return 0;
>  }
>  DM_TEST(dm_test_acpi_fill_header, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
> +
> +/* Test ACPI write_tables() */
> +static int dm_test_acpi_write_tables(struct unit_test_state *uts)
> +{
> +       struct acpi_dmar *dmar;
> +       struct acpi_ctx ctx;
> +       void *buf;
> +
> +       buf = malloc(BUF_SIZE);
> +       ut_assertnonnull(buf);
> +
> +       ctx.current = buf;
> +       ut_assertok(acpi_write_dev_tables(&ctx));
> +       dmar = buf;
> +
> +       /*
> +        * We should have two dmar tables, one for each "denx,u-boot-acpi-test"
> +        * device
> +        */
> +       ut_asserteq_ptr(dmar + 2, ctx.current);
> +       ut_asserteq(DMAR_INTR_REMAP, dmar->flags);
> +       ut_asserteq(32 - 1, dmar->host_address_width);
> +
> +       ut_asserteq(DMAR_INTR_REMAP, dmar[1].flags);
> +       ut_asserteq(32 - 1, dmar[1].host_address_width);
> +
> +       return 0;
> +}
> +DM_TEST(dm_test_acpi_write_tables, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
> --

Regards,
Bin