ACPI: NHLT: Access and query helpers
Subsystems (2)
v2 cover ACPI: NHLT: Access and query helpers
The goal of this patchset is to enhance existing interface of NonHDAudioLinkTable (NHLT), that is, accessing device and format configuration spaces as well as adding query functions for finding specific endpoints and format configurations. Once that is done, existing sound-drivers can move from utilizing sound/hda/intel-nhlt.c to this very code and ultimately the former file can be removed.
It's important to highlight that currently presented implementation is not final and intention is to first transfer sound-driver to new API and then provide incremental updates to internal code in drivers/acpi/nhlt.c to improve reliability and safety.
Series starts with addition of devcfg-access helpers. The main reasoning for adding access function is inability for a user to predict whether given space (device config) is valid or not. While inheritance in the specification is allowed, e.g.: mic_devcfg being inherited by mic_vendor_devcfg, until size is verified, one shall not be accessing fields which are not guaranteed by the spec. The only field guaranteed is "capabilities_size".
The xxx_devcfg structs added here kind of duplicate few existing ones in actbl2.h. This is mainly motivated by usage improvements - simplicity, shorten wording. Intention is to have them replacing existing actbl2.h members in the future.
Follow up is the declaration of acpi_gbl_NHLT. Motivation is to make sound-drivers life easier i.e.: release them from storing pointer to the first NHLT in the system internally. Such drivers may utilize acpi_gbl_NHLT when querying endpoints and formats instead.
Table manipulation functions and macros serve as a base for the follow-up query functions. So called query functions represent standard operations performed by user (a sound driver) when attempting to open an audio stream. These more or less mimic what's present in sound/hda/intel-nhlt.c.
Changes in v2:
- minor wording improvements in kernel-doc for patch 3/4
- dropped parentheses around loop cursors in for_each_nhlt_*() macros
- readability improvements in compound if-statements within query functions
- dropped NULL-checks in query functions
Cezary Rojewski (4):
ACPI: NHLT: Device configuration access interface
ACPI: NHLT: Introduce acpi_gbl_NHLT
ACPI: NHLT: Table manipulation helpers
ACPI: NHLT: Add query functions
drivers/acpi/Kconfig | 3 + drivers/acpi/Makefile | 1 + drivers/acpi/nhlt.c | 187 ++++++++++++++++++++++++++++++++++++++ include/acpi/actbl2.h | 28 ++++++ include/acpi/nhlt.h | 206 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 425 insertions(+) create mode 100644 drivers/acpi/nhlt.c create mode 100644 include/acpi/nhlt.h
Signature · 1 line
2.25.1
PATCH v2 1/4 ACPI: NHLT: Device configuration access interface
Device configuration structures are plenty so declare a struct for each known variant. As neither of them shall be accessed without verifying the memory block first, introduce macros to make it easy to do so.
--- include/acpi/actbl2.h | 28 ++++++++++++++++++ include/acpi/nhlt.h | 66 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 include/acpi/nhlt.h
include/acpi/actbl2.h +28 -0
@@ -2014,6 +2014,25 @@ struct acpi_nhlt_vendor_mic_count {u8 microphone_count; }; +/* The only guaranteed configuration space header. Any other requires validation. */ +struct acpi_nhlt_cfg { +u32 capabilities_size; +u8 capabilities[]; +}; + +struct acpi_nhlt_devcfg { +u32 capabilities_size; +u8 virtual_slot; +u8 config_type; +}; + +struct acpi_nhlt_mic_devcfg { +u32 capabilities_size; +u8 virtual_slot; +u8 config_type; +u8 array_type; +}; +struct acpi_nhlt_vendor_mic_config {u8 type;u8 panel;
@@ -2030,6 +2049,15 @@ struct acpi_nhlt_vendor_mic_config {u16 work_horizontal_angle_end;/* -180 - + 180 with 2 deg step */ }; +struct acpi_nhlt_vendor_mic_devcfg { +u32 capabilities_size; +u8 virtual_slot; +u8 config_type; +u8 array_type; +u8 num_mics; +struct acpi_nhlt_vendor_mic_config mics[]; +}; +/* Values for Type field above */ #define ACPI_NHLT_MIC_OMNIDIRECTIONAL 0
include/acpi/nhlt.h new file +66 -0
66 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v2 2/4 ACPI: NHLT: Introduce acpi_gbl_NHLT
In reply to Cezary RojewskiWhile there is no strict limit to amount of NHLT tables present, usually just the first one is utilized. To simplify implementation of sound drivers, provide publicly accessible pointer. Accessing it after calling acpi_nhlt_get_gbl_table() yields the first NHLT table met during the scan.
--- drivers/acpi/Kconfig | 3 +++ drivers/acpi/Makefile | 1 + drivers/acpi/nhlt.c | 13 +++++++++++++ include/acpi/nhlt.h | 18 ++++++++++++++++++ 4 files changed, 35 insertions(+) create mode 100644 drivers/acpi/nhlt.c
drivers/acpi/Kconfig +3 -0
@@ -594,6 +594,9 @@ config ACPI_PRMT substantially increase computational overhead related to the initialization of some server systems. +config ACPI_NHLT + bool + endif # ACPI config X86_PM_TIMER
drivers/acpi/Makefile +1 -0
@@ -93,6 +93,7 @@ obj-$(CONFIG_ACPI) += container.o obj-$(CONFIG_ACPI_THERMAL) += thermal.o obj-$(CONFIG_ACPI_PLATFORM_PROFILE) += platform_profile.o obj-$(CONFIG_ACPI_NFIT) += nfit/ +obj-$(CONFIG_ACPI_NHLT) += nhlt.o obj-$(CONFIG_ACPI_NUMA) += numa/ obj-$(CONFIG_ACPI) += acpi_memhotplug.o obj-$(CONFIG_ACPI_HOTPLUG_IOAPIC) += ioapic.o
drivers/acpi/nhlt.c new file +13 -0
@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved. +// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);
include/acpi/nhlt.h +18 -0
@@ -13,6 +13,24 @@#include <linux/overflow.h> #include <linux/types.h> +/* System-wide pointer to the first NHLT table. */ +extern struct acpi_table_nhlt *acpi_gbl_NHLT; + +/* +* A sound driver may utilize the two below on its initialization and removal +* respectively to avoid excessive mapping and unmapping of the memory +* occupied by the table between streaming operations. +*/ +static inline acpi_status acpi_nhlt_get_gbl_table (void ) +{ +return acpi_get_table (ACPI_SIG_NHLT ,0 , (struct acpi_table_header **)(&acpi_gbl_NHLT)); +} + +static inline void acpi_nhlt_put_gbl_table (void ) +{ +acpi_put_table ((struct acpi_table_header *)acpi_gbl_NHLT); +} +#define __acpi_nhlt_endpoint_cfg (ep) ((void *)((ep) + 1))/*
Signature · 1 line
2.25.1
Re: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 5 lines · Cezary Rojewski
While there is no strict limit to amount of NHLT tables present, usually just the first one is utilized. To simplify implementation of sound drivers, provide publicly accessible pointer. Accessing it after calling
acpi_nhlt_get_gbl_table()yields the first NHLT table met during the scan.
...
Quoted 33 lines
drivers/acpi/Kconfig +3
-0@@ -594,6 +594,9 @@ config ACPI_PRMT substantially increase computational overhead related to the initialization of some server systems. +config ACPI_NHLT + bool + endif # ACPI config X86_PM_TIMERdrivers/acpi/Makefile +1
-0@@ -93,6 +93,7 @@ obj-$(CONFIG_ACPI) += container.o obj-$(CONFIG_ACPI_THERMAL) += thermal.o obj-$(CONFIG_ACPI_PLATFORM_PROFILE) += platform_profile.o obj-$(CONFIG_ACPI_NFIT) += nfit/ +obj-$(CONFIG_ACPI_NHLT) += nhlt.o obj-$(CONFIG_ACPI_NUMA) += numa/ obj-$(CONFIG_ACPI) += acpi_memhotplug.o obj-$(CONFIG_ACPI_HOTPLUG_IOAPIC) += ioapic.odrivers/acpi/nhlt.c new file +3
-0@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved.
drivers/acpi/nhlt.c line 13
Quoted 10 lines
drivers/acpi/nhlt.c new file +10
-0+// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);
This approach generates a problem with undefined symbol "acpi_gbl_NHLT" when ACPI_NHLT is disabled. As nhlt.c is not built when said kconfig is disabled, symbol is never defined.
Proposed solution - modify drivers/acpi/tables.c with:
+#include <acpi/nhlt.h>
+
+struct acpi_table_nhlt *acpi_gbl_NHLT;
+EXPORT_SYMBOL_GPL(acpi_gbl_NHLT);
as tables.c is always built the symbol is always there. The only other option I see is:
-obj-$(CONFIG_ACPI_NHLT) += nhlt.o
+obj-y += nhlt.o
and modifying nhlt.c so it's essentially split in half with:
#if IS_ENABLED(CONFIG_ACPI_NHLT)
but such solutions stinks. I prefer the first approach. What to you find guys?
Quoted 29 lines
include/acpi/nhlt.h +18
-0@@ -13,6 +13,24 @@#include <linux/overflow.h> #include <linux/types.h> +/* System-wide pointer to the first NHLT table. */ +extern struct acpi_table_nhlt *acpi_gbl_NHLT; + +/* +* A sound driver may utilize the two below on its initialization and removal +* respectively to avoid excessive mapping and unmapping of the memory +* occupied by the table between streaming operations. +*/ +static inline acpi_status acpi_nhlt_get_gbl_table (void ) +{ +return acpi_get_table (ACPI_SIG_NHLT ,0 , (struct acpi_table_header **)(&acpi_gbl_NHLT)); +} + +static inline void acpi_nhlt_put_gbl_table (void ) +{ +acpi_put_table ((struct acpi_table_header *)acpi_gbl_NHLT); +} +#define __acpi_nhlt_endpoint_cfg (ep) ((void *)((ep) + 1))/*
Re: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 1 line · Cezary Rojewski
On 2023-07-17 5:00 PM, Cezary Rojewski wrote:
...
Quoted 33 lines
Quoted 5 lines
+++
b/drivers/acpi/nhlt.cdrivers/acpi/nhlt.c new file +3
-0@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved. drivers/acpi/nhlt.c line 13
Quoted 10 lines
drivers/acpi/nhlt.c new file +10
-0+// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.Proposed solution - modify
drivers/acpi/tables.cwith:drivers/acpi/nhlt.c new file +4
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);as
tables.cis always built the symbol is always there. The only other option I see is:(quoted diff) +1
-1-obj-$(CONFIG_ACPI_NHLT) += nhlt.o +obj-y += nhlt.o
Quoted 5 lines
and modifying
nhlt.cso it's essentially split in half with:
#ifIS_ENABLED(CONFIG_ACPI_NHLT)but such solutions stinks. I prefer the first approach. What to you find guys?
I leave this to Rafael as it's his territory.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Cezary Rojewski
On 2023-07-17 5:00 PM, Cezary Rojewski wrote:
...
Quoted 33 lines
Quoted 33 lines
Quoted 5 lines
+++
b/drivers/acpi/nhlt.cdrivers/acpi/nhlt.c new file +3
-0@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved. drivers/acpi/nhlt.c line 13
Quoted 10 lines
drivers/acpi/nhlt.c new file +10
-0+// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.Proposed solution - modify
drivers/acpi/tables.cwith:drivers/acpi/nhlt.c new file +4
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);as
tables.cis always built the symbol is always there. The only other option I see is:(quoted diff) +1
-1-obj-$(CONFIG_ACPI_NHLT) += nhlt.o +obj-y += nhlt.o
Quoted 7 lines
Quoted 5 lines
and modifying
nhlt.cso it's essentially split in half with:
#ifIS_ENABLED(CONFIG_ACPI_NHLT)but such solutions stinks. I prefer the first approach. What to you find guys?
I leave this to Rafael as it's his territory.
Rafael, which option do you prefer?
Regardless of IKP and my CI returning success on compilation tests, clearly there is a problem when CONFIG_ACPI_NHLT.
Rafael J. Wysocki
maintainerRe: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 48 lines · Cezary Rojewski
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Cezary Rojewski
On 2023-07-17 5:00 PM, Cezary Rojewski wrote:
...
Quoted 33 lines
Quoted 33 lines
Quoted 5 lines
+++
b/drivers/acpi/nhlt.cdrivers/acpi/nhlt.c new file +3
-0@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved. drivers/acpi/nhlt.c line 13
Quoted 10 lines
drivers/acpi/nhlt.c new file +10
-0+// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.Proposed solution - modify
drivers/acpi/tables.cwith:drivers/acpi/nhlt.c new file +4
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);as
tables.cis always built the symbol is always there. The only other option I see is:(quoted diff) +1
-1-obj-$(CONFIG_ACPI_NHLT) += nhlt.o +obj-y += nhlt.oQuoted 7 lines
Quoted 5 lines
and modifying
nhlt.cso it's essentially split in half with:
#ifIS_ENABLED(CONFIG_ACPI_NHLT)but such solutions stinks. I prefer the first approach. What to you find guys?
I leave this to Rafael as it's his territory.
Quoted 4 lines
Rafael, which option do you prefer?
Regardless of IKP and my CI returning success on compilation tests, clearly there is a problem when
CONFIG_ACPI_NHLT.
Putting the definition of acpi_gbl_NHLT into tables.c would be fine with me, but in any case, because it is an exported symbol, it needs a description in a kerneldoc comment.
Rafael J. Wysocki
maintainerRe: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 30 lines · Rafael J. Wysocki
Quoted 27 lines · Cezary Rojewski
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Cezary Rojewski
On 2023-07-17 5:00 PM, Cezary Rojewski wrote:
...
Quoted 20 lines
Quoted 20 lines
Quoted 5 lines
+++
b/drivers/acpi/nhlt.cdrivers/acpi/nhlt.c new file +3
-0@@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright(c) 2023 Intel Corporation. All rights reserved. drivers/acpi/nhlt.c line 13
Quoted 10 lines
drivers/acpi/nhlt.c new file +10
-0+// +// Authors: Cezary Rojewski <[email protected]> +// Amadeusz Slawinski <[email protected]> +// + +#include <linux/export.h> +#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT; +EXPORT_SYMBOL_GPL (acpi_gbl_NHLT);This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
drivers/acpi/nhlt.c line 12
Quoted 5 lines
Proposed solution - modify
drivers/acpi/tables.cwith:drivers/acpi/nhlt.c new file +3
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT;
No capitals in variable names, please.
Quoted 16 lines
Quoted 16 lines
Quoted 15 lines
Quoted 8 lines
+EXPORT_SYMBOL_GPL(acpi_gbl_NHLT);
as
tables.cis always built the symbol is always there. The only other option I see is:(quoted diff) +1
-1-obj-$(CONFIG_ACPI_NHLT) += nhlt.o +obj-y += nhlt.oQuoted 5 lines
and modifying
nhlt.cso it's essentially split in half with:
#ifIS_ENABLED(CONFIG_ACPI_NHLT)but such solutions stinks. I prefer the first approach. What to you find guys?
I leave this to Rafael as it's his territory.
Quoted 8 lines
Quoted 4 lines
Rafael, which option do you prefer?
Regardless of IKP and my CI returning success on compilation tests, clearly there is a problem when
CONFIG_ACPI_NHLT.Putting the definition of
acpi_gbl_NHLTintotables.cwould be fine with me, but in any case, because it is an exported symbol, it needs a description in a kerneldoc comment.
That said, you can also do something like this in a header file:
#ifdef CONFIG_ACPI_NHLT
extern struct acpi_table_nhlt *acpi_gbl_nhlt;
#else
#define acpi_gbl_nhlt NULL
#endif
and require the acpi_gbl_nhlt users to include it.
Re: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 4 lines · Rafael J. Wysocki
Quoted 3 lines · Rafael J. Wysocki
On Thu, Jul 20, 2023 at 11:15 AM Cezary Rojewski
<[email protected]> wrote:
...
Quoted 11 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
drivers/acpi/nhlt.c line 12
Quoted 9 lines
This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.Proposed solution - modify
drivers/acpi/tables.cwith:drivers/acpi/nhlt.c new file +3
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT;No capitals in variable names, please.
acpi_gbl_NHLT follows the path set by acpi_gbl_DSDT, _FADT and others. Why would NHLT be an exception? Is this because it's not defined under ACPICA?
Uncapitalizing nonetheless in v3.
Quoted 27 lines
Quoted 16 lines
Quoted 16 lines
Quoted 15 lines
Quoted 8 lines
+EXPORT_SYMBOL_GPL(acpi_gbl_NHLT);
as
tables.cis always built the symbol is always there. The only other option I see is:(quoted diff) +1
-1-obj-$(CONFIG_ACPI_NHLT) += nhlt.o +obj-y += nhlt.oQuoted 5 lines
and modifying
nhlt.cso it's essentially split in half with:
#ifIS_ENABLED(CONFIG_ACPI_NHLT)but such solutions stinks. I prefer the first approach. What to you find guys?
I leave this to Rafael as it's his territory.
Quoted 8 lines
Quoted 4 lines
Rafael, which option do you prefer?
Regardless of IKP and my CI returning success on compilation tests, clearly there is a problem when
CONFIG_ACPI_NHLT.Putting the definition of
acpi_gbl_NHLTintotables.cwould be fine with me, but in any case, because it is an exported symbol, it needs a description in a kerneldoc comment.That said, you can also do something like this in a header file:
Quoted 7 lines
#ifdef
CONFIG_ACPI_NHLT
extern structacpi_table_nhlt*acpi_gbl_nhlt;
#else
#defineacpi_gbl_nhltNULL
#endifand require the
acpi_gbl_nhltusers to include it.
Simplest solutions usually work the best. Surprised I haven't thought about it earlier!
Rafael J. Wysocki
maintainerRe: [PATCH v2 2/4] ACPI: NHLT: Introduce acpi_gbl_NHLT
Quoted 21 lines · Cezary Rojewski
Quoted 4 lines · Rafael J. Wysocki
Quoted 3 lines · Rafael J. Wysocki
On Thu, Jul 20, 2023 at 11:15 AM Cezary Rojewski
<[email protected]> wrote:...
Quoted 11 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Review
Quoted 9 lines
This approach generates a problem with undefined symbol "
acpi_gbl_NHLT" whenACPI_NHLTis disabled. Asnhlt.cis not built when said kconfig is disabled, symbol is never defined.Proposed solution - modify
drivers/acpi/tables.cwith:(quoted diff) +3
-0+#include <acpi/nhlt.h> + +struct acpi_table_nhlt *acpi_gbl_NHLT;No capitals in variable names, please.
Quoted 3 lines
acpi_gbl_NHLTfollows the path set byacpi_gbl_DSDT,_FADTand others. Why would NHLT be an exception? Is this because it's not defined under ACPICA?
Yes, it is. ACPICA has its own rules, sort of.
PATCH v2 3/4 ACPI: NHLT: Table manipulation helpers
In reply to Cezary RojewskiThe table is composed of a range of endpoints with each describing audio formats they support. Thus most of the operations involve iterating over elements of the table. Simplify the process by implementing range of getters.
--- include/acpi/nhlt.h | 68 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+)
include/acpi/nhlt.h +68 -0
@@ -81,4 +81,72 @@ static inline void acpi_nhlt_put_gbl_table(void) __cfg->capabilities_size ==struct_size (__cfg, mics, __cfg->num_mics) ? \ __cfg : NULL; }) +/** +* acpi_nhlt_endpoint_fmtscfg - Get the formats configuration space. +* @ep: the endpoint to retrieve the space for. +* +* Return: A pointer to the formats configuration space. +*/ +static inline struct acpi_nhlt_formats_config * +acpi_nhlt_endpoint_fmtscfg (const struct acpi_nhlt_endpoint *ep) +{ +struct acpi_nhlt_cfg *cfg =__acpi_nhlt_endpoint_cfg (ep); + +return (struct acpi_nhlt_formats_config *)((u8 *)(cfg +1 ) + cfg->capabilities_size); +} + +#define __acpi_nhlt_first_endpoint (tb) \ + ((void *)(tb + 1)) + +#define __acpi_nhlt_next_endpoint (ep) \ + ((void *)((u8 *)(ep) + (ep)->descriptor_length)) + +#define __acpi_nhlt_get_endpoint (tb, ep, i) \ + ((i) ? __acpi_nhlt_next_endpoint(ep) : __acpi_nhlt_first_endpoint(tb)) + +#define __acpi_nhlt_first_fmtcfg (fmts) \ + ((void *)(fmts + 1)) + +#define __acpi_nhlt_next_fmtcfg (fmt) \ + ((void *)((u8 *)((fmt) + 1) + (fmt)->capability_size)) + +#define __acpi_nhlt_get_fmtcfg (fmts, fmt, i) \ + ((i) ? __acpi_nhlt_next_fmtcfg(fmt) : __acpi_nhlt_first_fmtcfg(fmts)) + +/* +* The for_each_nhlt_*() macros rely on an iterator to deal with the +* variable length of each endpoint structure and the possible presence +* of an OED-Config used by Windows only. +*/ + +/** +* for_each_nhlt_endpoint - Iterate over endpoints in a NHLT table. +* @tb: the pointer to a NHLT table. +* @ep: the pointer to endpoint to use as loop cursor. +*/ +#define for_each_nhlt_endpoint (tb, ep) \ + for (unsigned int __i = 0; \ + __i < (tb)->endpoint_count && \ + (ep = __acpi_nhlt_get_endpoint(tb, ep, __i)); \ + __i++) + +/** +* for_each_nhlt_fmtcfg - Iterate over format configurations. +* @fmts: the pointer to formats configuration space. +* @fmt: the pointer to format to use as loop cursor. +*/ +#define for_each_nhlt_fmtcfg (fmts, fmt) \ + for (unsigned int __i = 0; \ + __i < (fmts)->formats_count && \ + (fmt = __acpi_nhlt_get_fmtcfg(fmts, fmt, __i)); \ + __i++) + +/** +* for_each_nhlt_endpoint_fmtcfg - Iterate over format configurations in an endpoint. +* @ep: the pointer to an endpoint. +* @fmt: the pointer to format to use as loop cursor. +*/ +#define for_each_nhlt_endpoint_fmtcfg (ep, fmt) \ + for_each_nhlt_fmtcfg(acpi_nhlt_endpoint_fmtscfg(ep), fmt) +#endif /* __ACPI_NHLT_H__ */
Signature · 1 line
2.25.1
PATCH v2 4/4 ACPI: NHLT: Add query functions
In reply to Cezary RojewskiWith iteration helpers added there is a room for more complex query tasks which are commonly performed by sound drivers. Implement them in common API so that a unified mechanism is available for all of them.
While the acpi_nhlt_endpoint_dmic_count() stands out a bit, it is a critical component for any AudioDSP driver to know how many digital microphones it is dealing with. There is no one perfect method, but the best one available is provided.
--- drivers/acpi/nhlt.c | 174 ++++++++++++++++++++++++++++++++++++++++++++ include/acpi/nhlt.h | 54 ++++++++++++++ 2 files changed, 228 insertions(+)
drivers/acpi/nhlt.c +174 -0
@@ -6,8 +6,182 @@// Amadeusz Slawinski <[email protected]> // +#define pr_fmt (fmt) "ACPI: NHLT: " fmt +#include <linux/export.h> #include <acpi/nhlt.h> struct acpi_table_nhlt *acpi_gbl_NHLT;EXPORT_SYMBOL_GPL (acpi_gbl_NHLT); + +/** +* acpi_nhlt_endpoint_match - Verify if an endpoint matches criteria. +* @ep: the endpoint to check. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter when matching. +* +* Return: %true if endpoint matches specified criteria or %false otherwise. +*/ +bool acpi_nhlt_endpoint_match (const struct acpi_nhlt_endpoint *ep, +int link_type,int dev_type,int dir,int bus_id) +{ +return ep && + (link_type <0 || ep->link_type == link_type) && + (dev_type <0 || ep->device_type == dev_type) && + (bus_id <0 || ep->virtual_bus_id == bus_id) && + (dir <0 || ep->direction == dir); +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_match); + +/** +* acpi_nhlt_find_endpoint - Search a NHLT table for an endpoint. +* @tb: the table to search. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter during the search. +* +* Return: A pointer to endpoint matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_endpoint * +acpi_nhlt_find_endpoint (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id) +{ +struct acpi_nhlt_endpoint *ep; + +for_each_nhlt_endpoint (tb, ep) +if (acpi_nhlt_endpoint_match (ep, link_type, dev_type, dir, bus_id)) +return ep; +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_find_endpoint); + +/** +* acpi_nhlt_endpoint_find_fmtcfg - Search endpoint's formats configuration space +* for a specific format. +* @ep: the endpoint to search. +* @ch: number of channels. +* @rate: samples per second. +* @vbps: valid bits per sample. +* @bps: bits per sample. +* +* Return: A pointer to format matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_format_config * +acpi_nhlt_endpoint_find_fmtcfg (const struct acpi_nhlt_endpoint *ep, +u16 ch,u32 rate,u16 vbps,u16 bps) +{ +struct acpi_nhlt_wave_extensible *wav; +struct acpi_nhlt_format_config *fmt; + +for_each_nhlt_endpoint_fmtcfg (ep, fmt) { + wav = &fmt->format; + +if (wav->valid_bits_per_sample == vbps && + wav->samples_per_sec == rate && + wav->bits_per_sample == bps && + wav->channel_count == ch) +return fmt; + } + +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_find_fmtcfg); + +/** +* acpi_nhlt_find_fmtcfg - Search a NHLT table for a specific format. +* @tb: the table to search. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* @ch: number of channels. +* @rate: samples per second. +* @vbps: valid bits per sample. +* @bps: bits per sample. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter during the search. +* +* Return: A pointer to format matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_format_config * +acpi_nhlt_find_fmtcfg (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id, +u16 ch,u32 rate,u16 vbps,u16 bps) +{ +struct acpi_nhlt_format_config *fmt; +struct acpi_nhlt_endpoint *ep; + +for_each_nhlt_endpoint (tb, ep) { +if (!acpi_nhlt_endpoint_match (ep, link_type, dev_type, dir, bus_id)) +continue ; + + fmt =acpi_nhlt_endpoint_find_fmtcfg (ep, ch, rate, vbps, bps); +if (fmt) +return fmt; + } + +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_find_fmtcfg); + +/** +* acpi_nhlt_endpoint_dmic_count - Retrieve number of digital microphones for a PDM endpoint. +* @ep: the endpoint to return microphones count for. +* +* Return: A number of microphones or an error code if an invalid endpoint is provided. +*/ +int acpi_nhlt_endpoint_dmic_count (const struct acpi_nhlt_endpoint *ep) +{ +struct acpi_nhlt_vendor_mic_devcfg *vendor_cfg; +struct acpi_nhlt_format_config *fmt; +struct acpi_nhlt_mic_devcfg *devcfg; +u16 max_ch =0 ; + +if (!ep || ep->link_type !=ACPI_NHLT_PDM ) +return -EINVAL ; + +/* Find max number of channels based on formats configuration. */ +for_each_nhlt_endpoint_fmtcfg (ep, fmt) + max_ch =max (fmt->format.channel_count, max_ch); + +/* If @ep not a mic array, fallback to channels count. */ + devcfg =acpi_nhlt_endpoint_mic_devcfg (ep); +if (!devcfg || devcfg->config_type !=ACPI_NHLT_CONFIG_TYPE_MIC_ARRAY ) +return max_ch; + +switch (devcfg->array_type) { +case ACPI_NHLT_SMALL_LINEAR_2ELEMENT : +case ACPI_NHLT_BIG_LINEAR_2ELEMENT : +return 2 ; + +case ACPI_NHLT_FIRST_GEOMETRY_LINEAR_4ELEMENT : +case ACPI_NHLT_PLANAR_LSHAPED_4ELEMENT : +case ACPI_NHLT_SECOND_GEOMETRY_LINEAR_4ELEMENT : +return 4 ; + +case ACPI_NHLT_VENDOR_DEFINED : + vendor_cfg =acpi_nhlt_endpoint_vendor_mic_devcfg (ep); +if (!vendor_cfg) +return -EINVAL ; +return vendor_cfg->num_mics; + +default : +pr_warn ("undefined mic array type: %#x\n" , devcfg->array_type); +return max_ch; + } +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_dmic_count);
include/acpi/nhlt.h +54 -0
58 lines not on this page · raw message
Signature · 1 line
2.25.1
Re: [PATCH v2 4/4] ACPI: NHLT: Add query functions
Quoted 8 lines · Cezary Rojewski
With iteration helpers added there is a room for more complex query tasks which are commonly performed by sound drivers. Implement them in common API so that a unified mechanism is available for all of them.
While the
acpi_nhlt_endpoint_dmic_count()stands out a bit, it is a critical component for any AudioDSP driver to know how many digital microphones it is dealing with. There is no one perfect method, but the best one available is provided.
FWIW,
Quoted 260 lines
Reviewed-by Pierre-Louis Bossart <[email protected]>Signed-off-by Cezary Rojewski <[email protected]>--- drivers/acpi/nhlt.c | 174 ++++++++++++++++++++++++++++++++++++++++++++ include/acpi/nhlt.h | 54 ++++++++++++++ 2 files changed, 228 insertions(+)drivers/acpi/nhlt.c +174
-0@@ -6,8 +6,182 @@// Amadeusz Slawinski <[email protected]> // +#define pr_fmt (fmt) "ACPI: NHLT: " fmt +#include <linux/export.h> #include <acpi/nhlt.h> struct acpi_table_nhlt *acpi_gbl_NHLT;EXPORT_SYMBOL_GPL (acpi_gbl_NHLT); + +/** +* acpi_nhlt_endpoint_match - Verify if an endpoint matches criteria. +* @ep: the endpoint to check. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter when matching. +* +* Return: %true if endpoint matches specified criteria or %false otherwise. +*/ +bool acpi_nhlt_endpoint_match (const struct acpi_nhlt_endpoint *ep, +int link_type,int dev_type,int dir,int bus_id) +{ +return ep && + (link_type <0 || ep->link_type == link_type) && + (dev_type <0 || ep->device_type == dev_type) && + (bus_id <0 || ep->virtual_bus_id == bus_id) && + (dir <0 || ep->direction == dir); +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_match); + +/** +* acpi_nhlt_find_endpoint - Search a NHLT table for an endpoint. +* @tb: the table to search. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter during the search. +* +* Return: A pointer to endpoint matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_endpoint * +acpi_nhlt_find_endpoint (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id) +{ +struct acpi_nhlt_endpoint *ep; + +for_each_nhlt_endpoint (tb, ep) +if (acpi_nhlt_endpoint_match (ep, link_type, dev_type, dir, bus_id)) +return ep; +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_find_endpoint); + +/** +* acpi_nhlt_endpoint_find_fmtcfg - Search endpoint's formats configuration space +* for a specific format. +* @ep: the endpoint to search. +* @ch: number of channels. +* @rate: samples per second. +* @vbps: valid bits per sample. +* @bps: bits per sample. +* +* Return: A pointer to format matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_format_config * +acpi_nhlt_endpoint_find_fmtcfg (const struct acpi_nhlt_endpoint *ep, +u16 ch,u32 rate,u16 vbps,u16 bps) +{ +struct acpi_nhlt_wave_extensible *wav; +struct acpi_nhlt_format_config *fmt; + +for_each_nhlt_endpoint_fmtcfg (ep, fmt) { + wav = &fmt->format; + +if (wav->valid_bits_per_sample == vbps && + wav->samples_per_sec == rate && + wav->bits_per_sample == bps && + wav->channel_count == ch) +return fmt; + } + +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_find_fmtcfg); + +/** +* acpi_nhlt_find_fmtcfg - Search a NHLT table for a specific format. +* @tb: the table to search. +* @link_type: the hardware link type, e.g.: PDM or SSP. +* @dev_type: the device type. +* @dir: stream direction. +* @bus_id: the ID of virtual bus hosting the endpoint. +* +* @ch: number of channels. +* @rate: samples per second. +* @vbps: valid bits per sample. +* @bps: bits per sample. +* +* Either of @link_type, @dev_type, @dir or @bus_id may be set to a negative +* value to ignore the parameter during the search. +* +* Return: A pointer to format matching the criteria, %NULL if not found or +* an ERR_PTR() otherwise. +*/ +struct acpi_nhlt_format_config * +acpi_nhlt_find_fmtcfg (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id, +u16 ch,u32 rate,u16 vbps,u16 bps) +{ +struct acpi_nhlt_format_config *fmt; +struct acpi_nhlt_endpoint *ep; + +for_each_nhlt_endpoint (tb, ep) { +if (!acpi_nhlt_endpoint_match (ep, link_type, dev_type, dir, bus_id)) +continue ; + + fmt =acpi_nhlt_endpoint_find_fmtcfg (ep, ch, rate, vbps, bps); +if (fmt) +return fmt; + } + +return NULL ; +} +EXPORT_SYMBOL_GPL (acpi_nhlt_find_fmtcfg); + +/** +* acpi_nhlt_endpoint_dmic_count - Retrieve number of digital microphones for a PDM endpoint. +* @ep: the endpoint to return microphones count for. +* +* Return: A number of microphones or an error code if an invalid endpoint is provided. +*/ +int acpi_nhlt_endpoint_dmic_count (const struct acpi_nhlt_endpoint *ep) +{ +struct acpi_nhlt_vendor_mic_devcfg *vendor_cfg; +struct acpi_nhlt_format_config *fmt; +struct acpi_nhlt_mic_devcfg *devcfg; +u16 max_ch =0 ; + +if (!ep || ep->link_type !=ACPI_NHLT_PDM ) +return -EINVAL ; + +/* Find max number of channels based on formats configuration. */ +for_each_nhlt_endpoint_fmtcfg (ep, fmt) + max_ch =max (fmt->format.channel_count, max_ch); + +/* If @ep not a mic array, fallback to channels count. */ + devcfg =acpi_nhlt_endpoint_mic_devcfg (ep); +if (!devcfg || devcfg->config_type !=ACPI_NHLT_CONFIG_TYPE_MIC_ARRAY ) +return max_ch; + +switch (devcfg->array_type) { +case ACPI_NHLT_SMALL_LINEAR_2ELEMENT : +case ACPI_NHLT_BIG_LINEAR_2ELEMENT : +return 2 ; + +case ACPI_NHLT_FIRST_GEOMETRY_LINEAR_4ELEMENT : +case ACPI_NHLT_PLANAR_LSHAPED_4ELEMENT : +case ACPI_NHLT_SECOND_GEOMETRY_LINEAR_4ELEMENT : +return 4 ; + +case ACPI_NHLT_VENDOR_DEFINED : + vendor_cfg =acpi_nhlt_endpoint_vendor_mic_devcfg (ep); +if (!vendor_cfg) +return -EINVAL ; +return vendor_cfg->num_mics; + +default : +pr_warn ("undefined mic array type: %#x\n" , devcfg->array_type); +return max_ch; + } +} +EXPORT_SYMBOL_GPL (acpi_nhlt_endpoint_dmic_count);include/acpi/nhlt.h +54
-0@@ -149,4 +149,58 @@ acpi_nhlt_endpoint_fmtscfg(const struct acpi_nhlt_endpoint *ep)#define for_each_nhlt_endpoint_fmtcfg (ep, fmt) \ for_each_nhlt_fmtcfg(acpi_nhlt_endpoint_fmtscfg(ep), fmt) +#if IS_ENABLED (CONFIG_ACPI_NHLT ) + +bool acpi_nhlt_endpoint_match (const struct acpi_nhlt_endpoint *ep, +int link_type,int dev_type,int dir,int bus_id); +struct acpi_nhlt_endpoint * +acpi_nhlt_find_endpoint (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id); +struct acpi_nhlt_format_config * +acpi_nhlt_endpoint_find_fmtcfg (const struct acpi_nhlt_endpoint *ep, +u16 ch,u32 rate,u16 vbps,u16 bps); +struct acpi_nhlt_format_config * +acpi_nhlt_find_fmtcfg (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id, +u16 ch,u32 rate,u16 vpbs,u16 bps); +int acpi_nhlt_endpoint_dmic_count (const struct acpi_nhlt_endpoint *ep); + +#else /* !CONFIG_ACPI_NHLT */ + +static bool +acpi_nhlt_endpoint_match (const struct acpi_nhlt_endpoint *ep, +int link_type,int dev_type,int dir,int bus_id) +{ +return false; +} + +static inline struct acpi_nhlt_endpoint * +acpi_nhlt_find_endpoint (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id) +{ +return NULL ; +} + +static inline struct acpi_nhlt_format_config * +acpi_nhlt_endpoint_find_fmtcfg (const struct acpi_nhlt_endpoint *ep, +u16 ch,u32 rate,u16 vbps,u16 bps) +{ +return NULL ; +} + +static inline struct acpi_nhlt_format_config * +acpi_nhlt_find_fmtcfg (const struct acpi_table_nhlt *tb, +int link_type,int dev_type,int dir,int bus_id, +u16 ch,u32 rate,u16 vpbs,u16 bps); +{ +return NULL ; +} + +static inline int acpi_nhlt_endpoint_dmic_count (const struct acpi_nhlt_endpoint *ep) +{ +return 0 ; +} + +#endif /* !CONFIG_ACPI_NHLT */ +#endif /* __ACPI_NHLT_H__ */ Signature · 1 line
2.25.1
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 6 lines · Cezary Rojewski
The goal of this patchset is to enhance existing interface of NonHDAudioLinkTable (NHLT), that is, accessing device and format configuration spaces as well as adding query functions for finding specific endpoints and format configurations. Once that is done, existing sound-drivers can move from utilizing
sound/hda/intel-nhlt.cto this very code and ultimately the former file can be removed.
Hello Rafael and Robert,
Given recent question from Pierre regarding licensing, I've scanned acpi/ tree for SPDXes used and must admit that I'm lost. There is a mix of GPL-2.0, GPL-2.0-or-later and dual BSD-3.0-and-GPL-2.0. The preferred kernel license is GPL-2.0 but given what's out there I have my doubts about acpi tree.
Could you provide your insight on the subject?
Kind regards,
Czarek
Rafael J. Wysocki
maintainerQuoted 11 lines · Cezary Rojewski
Quoted 6 lines · Cezary Rojewski
The goal of this patchset is to enhance existing interface of NonHDAudioLinkTable (NHLT), that is, accessing device and format configuration spaces as well as adding query functions for finding specific endpoints and format configurations. Once that is done, existing sound-drivers can move from utilizing
sound/hda/intel-nhlt.cto this very code and ultimately the former file can be removed.Hello Rafael and Robert,
Quoted 7 lines
Given recent question from Pierre regarding licensing, I've scanned acpi/ tree for SPDXes used and must admit that I'm lost. There is a mix of GPL-2.0, GPL-2.0-or-later and dual BSD-3.0-and-GPL-2.0. The preferred kernel license is GPL-2.0 but given what's out there I have my doubts about acpi tree.
Could you provide your insight on the subject?
All ACPICA is dual BSD-3-Clause or GPL-2.0 and everything outside it in the kernel should be GPL-2.0 (especially new code), unless you specifically want to make it dual-license for some reason.