[v3,16/35] acpi: Support writing a string

ACPI supports storing a simple nul-terminated string. Add support for
this.

Signed-off-by: Simon Glass <sjg at chromium.org>
Reviewed-by: Wolfgang Wallner <wolfgang.wallner at br-automation.com>
---

(no changes since v1)

 include/acpi/acpigen.h | 10 ++++++++++
 lib/acpi/acpigen.c     |  6 ++++++
 test/dm/acpigen.c      | 32 ++++++++++++++++++++++++++++++--
 3 files changed, 46 insertions(+), 2 deletions(-)

Hi Simon,

On Sun, Jun 14, 2020 at 10:55 AM Simon Glass <sjg at chromium.org> wrote:
>
> ACPI supports storing a simple nul-terminated string. Add support for

nits: null

> this.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> Reviewed-by: Wolfgang Wallner <wolfgang.wallner at br-automation.com>
> ---
>
> (no changes since v1)
>
>  include/acpi/acpigen.h | 10 ++++++++++
>  lib/acpi/acpigen.c     |  6 ++++++
>  test/dm/acpigen.c      | 32 ++++++++++++++++++++++++++++++--
>  3 files changed, 46 insertions(+), 2 deletions(-)
>
> diff --git a/include/acpi/acpigen.h b/include/acpi/acpigen.h
> index b17a9ef14c..cf7f6173db 100644
> --- a/include/acpi/acpigen.h
> +++ b/include/acpi/acpigen.h
> @@ -24,6 +24,7 @@ enum {
>         BYTE_PREFIX             = 0x0a,
>         WORD_PREFIX             = 0x0b,
>         DWORD_PREFIX            = 0x0c,
> +       STRING_PREFIX           = 0x0d,
>         QWORD_PREFIX            = 0x0e,
>         PACKAGE_OP              = 0x12,
>  };
> @@ -152,4 +153,13 @@ char *acpigen_write_package(struct acpi_ctx *ctx, int nr_el);
>   */
>  void acpigen_write_integer(struct acpi_ctx *ctx, u64 data);
>
> +/**
> + * acpigen_write_string() - Write a string
> + *
> + * This writes a STRING_PREFIX followed by a nul-terminated string

nits: unull

> + *
> + * @ctx: ACPI context pointer
> + * @str: String to write
> + */
> +void acpigen_write_string(struct acpi_ctx *ctx, const char *str);
>  #endif
> diff --git a/lib/acpi/acpigen.c b/lib/acpi/acpigen.c
> index c8c8f07897..dcf84afbe6 100644
> --- a/lib/acpi/acpigen.c
> +++ b/lib/acpi/acpigen.c
> @@ -146,3 +146,9 @@ void acpigen_emit_string(struct acpi_ctx *ctx, const char *str)
>         acpigen_emit_stream(ctx, str, str ? strlen(str) : 0);
>         acpigen_emit_byte(ctx, '\0'); /* NUL */
>  }
> +
> +void acpigen_write_string(struct acpi_ctx *ctx, const char *str)
> +{
> +       acpigen_emit_byte(ctx, STRING_PREFIX);
> +       acpigen_emit_string(ctx, str);
> +}
> diff --git a/test/dm/acpigen.c b/test/dm/acpigen.c
> index 730f5713ec..836cb4f75c 100644
> --- a/test/dm/acpigen.c
> +++ b/test/dm/acpigen.c
> @@ -20,6 +20,7 @@
>  #include <test/ut.h>
>
>  #define TEST_STRING    "frogmore"
> +#define TEST_STRING2   "ranch"
>  #define TEST_STREAM2   "\xfa\xde"
>
>  #define TEST_INT8      0x7d
> @@ -404,7 +405,7 @@ static int dm_test_acpi_len(struct unit_test_state *uts)
>  }
>  DM_TEST(dm_test_acpi_len, 0);
>
> -/* Test emitting a package */
> +/* Test writing a package */

nits: this change should be squashed in previous commit that
introduced this line in the first place

>  static int dm_test_acpi_package(struct unit_test_state *uts)
>  {
>         struct acpi_ctx *ctx;
> @@ -431,7 +432,7 @@ static int dm_test_acpi_package(struct unit_test_state *uts)
>  }
>  DM_TEST(dm_test_acpi_package, 0);
>
> -/* Test emitting an integer */
> +/* Test writing an integer */

nits: this change should be squashed in previous commit that
introduced this line in the first place

>  static int dm_test_acpi_integer(struct unit_test_state *uts)
>  {
>         struct acpi_ctx *ctx;
> @@ -471,3 +472,30 @@ static int dm_test_acpi_integer(struct unit_test_state *uts)
>         return 0;
>  }
>  DM_TEST(dm_test_acpi_integer, 0);
> +
> +/* Test writing a string */
> +static int dm_test_acpi_string(struct unit_test_state *uts)
> +{
> +       struct acpi_ctx *ctx;
> +       u8 *ptr;
> +
> +       ut_assertok(alloc_context(&ctx));
> +
> +       ptr = acpigen_get_current(ctx);
> +
> +       acpigen_write_string(ctx, TEST_STRING);
> +       acpigen_write_string(ctx, TEST_STRING2);
> +
> +       ut_asserteq(2 + sizeof(TEST_STRING) + sizeof(TEST_STRING2),
> +                   acpigen_get_current(ctx) - ptr);
> +       ut_asserteq(STRING_PREFIX, ptr[0]);
> +       ut_asserteq_str(TEST_STRING, (char *)ptr + 1);
> +       ptr += 1 + sizeof(TEST_STRING);
> +       ut_asserteq(STRING_PREFIX, ptr[0]);
> +       ut_asserteq_str(TEST_STRING2, (char *)ptr + 1);
> +
> +       free_context(&ctx);
> +
> +       return 0;
> +}
> +DM_TEST(dm_test_acpi_string, 0);

Other than above,
Reviewed-by: Bin Meng <bmeng.cn at gmail.com>

Regards,
Bin