system/linux
system/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux synced 2024-07-09 04:38:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branches 'acpi-scan' and 'acpi-tables'

Browse Source 
Merge ACPI device enumeration changes and ACPI data-only tables support
updates for 6.10:

 - Rearrange fields in several structures to effectively eliminate
   computations from container_of() in some cases (Andy Shevchenko).

 - Do some assorted cleanups of the ACPI device enumeration code (Andy
   Shevchenko).

 - Make the ACPI device enumeration code skip devices with _STA values
   clearly identified by the specification as invalid (Rafael Wysocki).

 - Rework the handling of the NHLT table to simplify and clarify it and
   drop some obsolete pieces (Cezary Rojewski).

* acpi-scan:
  ACPI: scan: Avoid enumerating devices with clearly invalid _STA values
  ACPI: scan: Introduce typedef:s for struct acpi_hotplug_context members
  ACPI: scan: Use standard error checking pattern
  ACPI: scan: Move misleading comment to acpi_dma_configure_id()
  ACPI: scan: Use list_first_entry_or_null() in acpi_device_hid()
  ACPI: bus: Don't use "proxy" headers
  ACPI: bus: Make container_of() no-op where it makes sense

* acpi-tables:
  ACPI: NHLT: Streamline struct naming
  ACPI: NHLT: Drop redundant types
  ACPI: NHLT: Introduce API for the table
  ACPI: NHLT: Reintroduce types the table consists of
This commit is contained in:
Rafael J. Wysocki 2024-05-13 19:31:06 +02:00
commit 784cf44945
9 changed files with 652 additions and 238 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
drivers/acpi/Kconfig
View File

@ -469,6 +469,9 @@ config ACPI_REDUCED_HARDWARE_ONLY
If you are unsure what to do, do not enable this option.
config ACPI_NHLT
bool
source "drivers/acpi/nfit/Kconfig"
source "drivers/acpi/numa/Kconfig"
source "drivers/acpi/apei/Kconfig"

1
drivers/acpi/Makefile
View File

@ -93,6 +93,7 @@ obj-$(CONFIG_ACPI_THERMAL_LIB) += thermal_lib.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

11
drivers/acpi/bus.c
View File

@ -112,6 +112,17 @@ int acpi_bus_get_status(struct acpi_device *device)
if (ACPI_FAILURE(status))
return -ENODEV;
if (!device->status.present && device->status.enabled) {
pr_info(FW_BUG "Device [%s] status [%08x]: not present and enabled\n",
device->pnp.bus_id, (u32)sta);
device->status.enabled = 0;
/*
* The status is clearly invalid, so clear the functional bit as
* well to avoid attempting to use the device.
*/
device->status.functional = 0;
}
acpi_set_device_status(device, sta);
if (device->status.functional && !device->status.present) {

48
drivers/acpi/dock.c
View File

@ -88,43 +88,29 @@ static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event,
enum dock_callback_type cb_type)
{
struct acpi_device *adev = dd->adev;
acpi_hp_fixup fixup = NULL;
acpi_hp_uevent uevent = NULL;
acpi_hp_notify notify = NULL;
acpi_lock_hp_context();
if (!adev->hp)
goto out;
if (cb_type == DOCK_CALL_FIXUP) {
void (*fixup)(struct acpi_device *);
fixup = adev->hp->fixup;
if (fixup) {
acpi_unlock_hp_context();
fixup(adev);
return;
}
} else if (cb_type == DOCK_CALL_UEVENT) {
void (*uevent)(struct acpi_device *, u32);
uevent = adev->hp->uevent;
if (uevent) {
acpi_unlock_hp_context();
uevent(adev, event);
return;
}
} else {
int (*notify)(struct acpi_device *, u32);
notify = adev->hp->notify;
if (notify) {
acpi_unlock_hp_context();
notify(adev, event);
return;
}
if (adev->hp) {
if (cb_type == DOCK_CALL_FIXUP)
fixup = adev->hp->fixup;
else if (cb_type == DOCK_CALL_UEVENT)
uevent = adev->hp->uevent;
else
notify = adev->hp->notify;
}
out:
acpi_unlock_hp_context();
if (fixup)
fixup(adev);
else if (uevent)
uevent(adev, event);
else if (notify)
notify(adev, event);
}
static struct dock_station *find_dock_station(acpi_handle handle)

289
drivers/acpi/nhlt.c Normal file
View File

@ -0,0 +1,289 @@
// SPDX-License-Identifier: GPL-2.0-only
/*
* Copyright(c) 2023-2024 Intel Corporation
*
* Authors: Cezary Rojewski <cezary.rojewski@intel.com>
* Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
*/
#define pr_fmt(fmt) "ACPI: NHLT: " fmt
#include <linux/acpi.h>
#include <linux/errno.h>
#include <linux/export.h>
#include <linux/minmax.h>
#include <linux/printk.h>
#include <linux/types.h>
#include <acpi/nhlt.h>
static struct acpi_table_nhlt *acpi_gbl_nhlt;
static struct acpi_table_nhlt empty_nhlt = {
.header = {
.signature = ACPI_SIG_NHLT,
},
};
/**
* acpi_nhlt_get_gbl_table - Retrieve a pointer to the first NHLT table.
*
* If there is no NHLT in the system, acpi_gbl_nhlt will instead point to an
* empty table.
*
* Return: ACPI status code of the operation.
*/
acpi_status acpi_nhlt_get_gbl_table(void)
{
acpi_status status;
status = acpi_get_table(ACPI_SIG_NHLT, 0, (struct acpi_table_header **)(&acpi_gbl_nhlt));
if (!acpi_gbl_nhlt)
acpi_gbl_nhlt = &empty_nhlt;
return status;
}
EXPORT_SYMBOL_GPL(acpi_nhlt_get_gbl_table);
/**
* acpi_nhlt_put_gbl_table - Release the global NHLT table.
*/
void acpi_nhlt_put_gbl_table(void)
{
acpi_put_table((struct acpi_table_header *)acpi_gbl_nhlt);
}
EXPORT_SYMBOL_GPL(acpi_nhlt_put_gbl_table);
/**
* 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_tb_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_tb_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_tb_find_endpoint);
/**
* acpi_nhlt_find_endpoint - Search all NHLT tables for an endpoint.
* @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(int link_type, int dev_type, int dir, int bus_id)
{
/* TODO: Currently limited to table of index 0. */
return acpi_nhlt_tb_find_endpoint(acpi_gbl_nhlt, link_type, dev_type, dir, bus_id);
}
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_formatext *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_tb_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_tb_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_tb_find_fmtcfg);
/**
* acpi_nhlt_find_fmtcfg - Search all NHLT tables for a specific format.
* @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(int link_type, int dev_type, int dir, int bus_id,
u16 ch, u32 rate, u16 vbps, u16 bps)
{
/* TODO: Currently limited to table of index 0. */
return acpi_nhlt_tb_find_fmtcfg(acpi_gbl_nhlt, link_type, dev_type, dir, bus_id,
ch, rate, vbps, bps);
}
EXPORT_SYMBOL_GPL(acpi_nhlt_find_fmtcfg);
static bool acpi_nhlt_config_is_micdevice(struct acpi_nhlt_config *cfg)
{
return cfg->capabilities_size >= sizeof(struct acpi_nhlt_micdevice_config);
}
static bool acpi_nhlt_config_is_vendor_micdevice(struct acpi_nhlt_config *cfg)
{
struct acpi_nhlt_vendor_micdevice_config *devcfg = __acpi_nhlt_config_caps(cfg);
return cfg->capabilities_size >= sizeof(*devcfg) &&
cfg->capabilities_size == struct_size(devcfg, mics, devcfg->mics_count);
}
/**
* acpi_nhlt_endpoint_mic_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_mic_count(const struct acpi_nhlt_endpoint *ep)
{
union acpi_nhlt_device_config *devcfg;
struct acpi_nhlt_format_config *fmt;
struct acpi_nhlt_config *cfg;
u16 max_ch = 0;
if (!ep || ep->link_type != ACPI_NHLT_LINKTYPE_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);
cfg = __acpi_nhlt_endpoint_config(ep);
devcfg = __acpi_nhlt_config_caps(cfg);
/* If @ep is not a mic array, fallback to channels count. */
if (!acpi_nhlt_config_is_micdevice(cfg) ||
devcfg->gen.config_type != ACPI_NHLT_CONFIGTYPE_MICARRAY)
return max_ch;
switch (devcfg->mic.array_type) {
case ACPI_NHLT_ARRAYTYPE_LINEAR2_SMALL:
case ACPI_NHLT_ARRAYTYPE_LINEAR2_BIG:
return 2;
case ACPI_NHLT_ARRAYTYPE_LINEAR4_GEO1:
case ACPI_NHLT_ARRAYTYPE_PLANAR4_LSHAPED:
case ACPI_NHLT_ARRAYTYPE_LINEAR4_GEO2:
return 4;
case ACPI_NHLT_ARRAYTYPE_VENDOR:
if (!acpi_nhlt_config_is_vendor_micdevice(cfg))
return -EINVAL;
return devcfg->vendor_mic.mics_count;
default:
pr_warn("undefined mic array type: %#x\n", devcfg->mic.array_type);
return max_ch;
}
}
EXPORT_SYMBOL_GPL(acpi_nhlt_endpoint_mic_count);

30
drivers/acpi/scan.c
View File

@ -73,8 +73,7 @@ void acpi_unlock_hp_context(void)
void acpi_initialize_hp_context(struct acpi_device *adev,
struct acpi_hotplug_context *hp,
int (*notify)(struct acpi_device *, u32),
void (*uevent)(struct acpi_device *, u32))
acpi_hp_notify notify, acpi_hp_uevent uevent)
{
acpi_lock_hp_context();
hp->notify = notify;
@ -428,7 +427,7 @@ void acpi_device_hotplug(struct acpi_device *adev, u32 src)
} else if (adev->flags.hotplug_notify) {
error = acpi_generic_hotplug_event(adev, src);
} else {
int (*notify)(struct acpi_device *, u32);
acpi_hp_notify notify;
acpi_lock_hp_context();
notify = adev->hp ? adev->hp->notify : NULL;
@ -1298,10 +1297,10 @@ const char *acpi_device_hid(struct acpi_device *device)
{
struct acpi_hardware_id *hid;
if (list_empty(&device->pnp.ids))
hid = list_first_entry_or_null(&device->pnp.ids, struct acpi_hardware_id, list);
if (!hid)
return dummy_hid;
hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
return hid->id;
}
EXPORT_SYMBOL(acpi_device_hid);
@ -1581,12 +1580,13 @@ int acpi_iommu_fwspec_init(struct device *dev, u32 id,
struct fwnode_handle *fwnode,
const struct iommu_ops *ops)
{
int ret = iommu_fwspec_init(dev, fwnode, ops);
int ret;
if (!ret)
ret = iommu_fwspec_add_ids(dev, &id, 1);
ret = iommu_fwspec_init(dev, fwnode, ops);
if (ret)
return ret;
return ret;
return iommu_fwspec_add_ids(dev, &id, 1);
}
static inline const struct iommu_ops *acpi_iommu_fwspec_ops(struct device *dev)
@ -1625,12 +1625,11 @@ static int acpi_iommu_configure_id(struct device *dev, const u32 *id_in)
if (!err && dev->bus)
err = iommu_probe_device(dev);
/* Ignore all other errors apart from EPROBE_DEFER */
if (err == -EPROBE_DEFER) {
if (err == -EPROBE_DEFER)
return err;
} else if (err) {
if (err) {
dev_dbg(dev, "Adding to IOMMU failed: %d\n", err);
return -ENODEV;
return err;
}
if (!acpi_iommu_fwspec_ops(dev))
return -ENODEV;
@ -1671,13 +1670,14 @@ int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
acpi_arch_dma_setup(dev);
/* Ignore all other errors apart from EPROBE_DEFER */
ret = acpi_iommu_configure_id(dev, input_id);
if (ret == -EPROBE_DEFER)
return -EPROBE_DEFER;
/*
* Historically this routine doesn't fail driver probing due to errors
* in acpi_iommu_configure_id()
* in acpi_iommu_configure_id().
*/
arch_setup_dma_ops(dev, 0, U64_MAX, attr == DEV_DMA_COHERENT);
@ -1962,7 +1962,7 @@ bool acpi_device_is_present(const struct acpi_device *adev)
bool acpi_device_is_enabled(const struct acpi_device *adev)
{
return adev->status.present && adev->status.enabled;
return adev->status.enabled;
}
static bool acpi_scan_handler_matching(struct acpi_scan_handler *handler,

28
include/acpi/acpi_bus.h
View File

@ -9,8 +9,13 @@
#ifndef __ACPI_BUS_H__
#define __ACPI_BUS_H__
#include <linux/completion.h>
#include <linux/container_of.h>
#include <linux/device.h>
#include <linux/kobject.h>
#include <linux/mutex.h>
#include <linux/property.h>
#include <linux/types.h>
struct acpi_handle_list {
u32 count;
@ -124,8 +129,8 @@ static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
}
struct acpi_scan_handler {
const struct acpi_device_id *ids;
struct list_head list_node;
const struct acpi_device_id *ids;
bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
void (*detach)(struct acpi_device *dev);
@ -139,11 +144,15 @@ struct acpi_scan_handler {
* --------------------
*/
typedef int (*acpi_hp_notify) (struct acpi_device *, u32);
typedef void (*acpi_hp_uevent) (struct acpi_device *, u32);
typedef void (*acpi_hp_fixup) (struct acpi_device *);
struct acpi_hotplug_context {
struct acpi_device *self;
int (*notify)(struct acpi_device *, u32);
void (*uevent)(struct acpi_device *, u32);
void (*fixup)(struct acpi_device *);
acpi_hp_notify notify;
acpi_hp_uevent uevent;
acpi_hp_fixup fixup;
};
/*
@ -268,6 +277,7 @@ struct acpi_device_power_flags {
};
struct acpi_device_power_state {
struct list_head resources; /* Power resources referenced */
struct {
u8 valid:1;
u8 explicit_set:1; /* _PSx present? */
@ -275,7 +285,6 @@ struct acpi_device_power_state {
} flags;
int power; /* % Power (compared to D0) */
int latency; /* Dx->D0 time (microseconds) */
struct list_head resources; /* Power resources referenced */
};
struct acpi_device_power {
@ -341,16 +350,16 @@ struct acpi_device_wakeup {
};
struct acpi_device_physical_node {
unsigned int node_id;
struct list_head node;
struct device *dev;
unsigned int node_id;
bool put_online:1;
};
struct acpi_device_properties {
struct list_head list;
const guid_t *guid;
union acpi_object *properties;
struct list_head list;
void **bufs;
};
@ -487,12 +496,12 @@ struct acpi_device {
/* Non-device subnode */
struct acpi_data_node {
struct list_head sibling;
const char *name;
acpi_handle handle;
struct fwnode_handle fwnode;
struct fwnode_handle *parent;
struct acpi_device_data data;
struct list_head sibling;
struct kobject kobj;
struct completion kobj_done;
};
@ -577,8 +586,7 @@ static inline void acpi_set_hp_context(struct acpi_device *adev,
void acpi_initialize_hp_context(struct acpi_device *adev,
struct acpi_hotplug_context *hp,
int (*notify)(struct acpi_device *, u32),
void (*uevent)(struct acpi_device *, u32));
acpi_hp_notify notify, acpi_hp_uevent uevent);
/* acpi_device.dev.bus == &acpi_bus_type */
extern const struct bus_type acpi_bus_type;

299
include/acpi/actbl2.h
View File

@ -1966,22 +1966,22 @@ struct nfit_device_handle {
/*******************************************************************************
*
* NHLT - Non HD Audio Link Table
*
* Conforms to: Intel Smart Sound Technology NHLT Specification
* Version 0.8.1, January 2020.
* NHLT - Non HDAudio Link Table
* Version 1
*
******************************************************************************/
/* Main table */
struct acpi_table_nhlt {
struct acpi_table_header header; /* Common ACPI table header */
u8 endpoint_count;
u8 endpoints_count;
/*
* struct acpi_nhlt_endpoint endpoints[];
* struct acpi_nhlt_config oed_config;
*/
};
struct acpi_nhlt_endpoint {
u32 descriptor_length;
u32 length;
u8 link_type;
u8 instance_id;
u16 vendor_id;
@ -1991,84 +1991,135 @@ struct acpi_nhlt_endpoint {
u8 device_type;
u8 direction;
u8 virtual_bus_id;
/*
* struct acpi_nhlt_config device_config;
* struct acpi_nhlt_formats_config formats_config;
* struct acpi_nhlt_devices_info devices_info;
*/
};
/* Types for link_type field above */
#define ACPI_NHLT_RESERVED_HD_AUDIO 0
#define ACPI_NHLT_RESERVED_DSP 1
#define ACPI_NHLT_PDM 2
#define ACPI_NHLT_SSP 3
#define ACPI_NHLT_RESERVED_SLIMBUS 4
#define ACPI_NHLT_RESERVED_SOUNDWIRE 5
#define ACPI_NHLT_TYPE_RESERVED 6 /* 6 and above are reserved */
/* All other values above are reserved */
/*
* Values for link_type field above
*
* Only types PDM and SSP are used
*/
#define ACPI_NHLT_LINKTYPE_HDA 0
#define ACPI_NHLT_LINKTYPE_DSP 1
#define ACPI_NHLT_LINKTYPE_PDM 2
#define ACPI_NHLT_LINKTYPE_SSP 3
#define ACPI_NHLT_LINKTYPE_SLIMBUS 4
#define ACPI_NHLT_LINKTYPE_SDW 5
#define ACPI_NHLT_LINKTYPE_UAOL 6
/* Values for device_id field above */
#define ACPI_NHLT_PDM_DMIC 0xAE20
#define ACPI_NHLT_BT_SIDEBAND 0xAE30
#define ACPI_NHLT_I2S_TDM_CODECS 0xAE23
#define ACPI_NHLT_DEVICEID_DMIC 0xAE20
#define ACPI_NHLT_DEVICEID_BT 0xAE30
#define ACPI_NHLT_DEVICEID_I2S 0xAE34
/* Values for device_type field above */
/* SSP Link */
#define ACPI_NHLT_LINK_BT_SIDEBAND 0
#define ACPI_NHLT_LINK_FM 1
#define ACPI_NHLT_LINK_MODEM 2
/* 3 is reserved */
#define ACPI_NHLT_LINK_SSP_ANALOG_CODEC 4
/* PDM Link */
#define ACPI_NHLT_PDM_ON_CAVS_1P8 0
#define ACPI_NHLT_PDM_ON_CAVS_1P5 1
/*
* Device types unique to endpoint of link_type=PDM
*
* Type PDM used for all SKL+ platforms
*/
#define ACPI_NHLT_DEVICETYPE_PDM 0
#define ACPI_NHLT_DEVICETYPE_PDM_SKL 1
/* Device types unique to endpoint of link_type=SSP */
#define ACPI_NHLT_DEVICETYPE_BT 0
#define ACPI_NHLT_DEVICETYPE_FM 1
#define ACPI_NHLT_DEVICETYPE_MODEM 2
#define ACPI_NHLT_DEVICETYPE_CODEC 4
/* Values for Direction field above */
#define ACPI_NHLT_DIR_RENDER 0
#define ACPI_NHLT_DIR_CAPTURE 1
#define ACPI_NHLT_DIR_RENDER_LOOPBACK 2
#define ACPI_NHLT_DIR_RENDER_FEEDBACK 3
#define ACPI_NHLT_DIR_RESERVED 4 /* 4 and above are reserved */
#define ACPI_NHLT_DIR_RENDER 0
#define ACPI_NHLT_DIR_CAPTURE 1
struct acpi_nhlt_device_specific_config {
struct acpi_nhlt_config {
u32 capabilities_size;
u8 capabilities[];
};
struct acpi_nhlt_gendevice_config {
u8 virtual_slot;
u8 config_type;
};
struct acpi_nhlt_device_specific_config_a {
u32 capabilities_size;
/* Values for config_type field above */
#define ACPI_NHLT_CONFIGTYPE_GENERIC 0
#define ACPI_NHLT_CONFIGTYPE_MICARRAY 1
struct acpi_nhlt_micdevice_config {
u8 virtual_slot;
u8 config_type;
u8 array_type;
};
/* Values for Config Type above */
/* Values for array_type field above */
#define ACPI_NHLT_CONFIG_TYPE_GENERIC 0x00
#define ACPI_NHLT_CONFIG_TYPE_MIC_ARRAY 0x01
#define ACPI_NHLT_CONFIG_TYPE_RENDER_FEEDBACK 0x03
#define ACPI_NHLT_CONFIG_TYPE_RESERVED 0x04 /* 4 and above are reserved */
#define ACPI_NHLT_ARRAYTYPE_LINEAR2_SMALL 0xA
#define ACPI_NHLT_ARRAYTYPE_LINEAR2_BIG 0xB
#define ACPI_NHLT_ARRAYTYPE_LINEAR4_GEO1 0xC
#define ACPI_NHLT_ARRAYTYPE_PLANAR4_LSHAPED 0xD
#define ACPI_NHLT_ARRAYTYPE_LINEAR4_GEO2 0xE
#define ACPI_NHLT_ARRAYTYPE_VENDOR 0xF
struct acpi_nhlt_device_specific_config_b {
u32 capabilities_size;
struct acpi_nhlt_vendor_mic_config {
u8 type;
u8 panel;
u16 speaker_position_distance; /* mm */
u16 horizontal_offset; /* mm */
u16 vertical_offset; /* mm */
u8 frequency_low_band; /* 5*Hz */
u8 frequency_high_band; /* 500*Hz */
u16 direction_angle; /* -180 - +180 */
u16 elevation_angle; /* -180 - +180 */
u16 work_vertical_angle_begin; /* -180 - +180 with 2 deg step */
u16 work_vertical_angle_end; /* -180 - +180 with 2 deg step */
u16 work_horizontal_angle_begin; /* -180 - +180 with 2 deg step */
u16 work_horizontal_angle_end; /* -180 - +180 with 2 deg step */
};
struct acpi_nhlt_device_specific_config_c {
u32 capabilities_size;
/* Values for Type field above */
#define ACPI_NHLT_MICTYPE_OMNIDIRECTIONAL 0
#define ACPI_NHLT_MICTYPE_SUBCARDIOID 1
#define ACPI_NHLT_MICTYPE_CARDIOID 2
#define ACPI_NHLT_MICTYPE_SUPERCARDIOID 3
#define ACPI_NHLT_MICTYPE_HYPERCARDIOID 4
#define ACPI_NHLT_MICTYPE_8SHAPED 5
#define ACPI_NHLT_MICTYPE_RESERVED 6
#define ACPI_NHLT_MICTYPE_VENDORDEFINED 7
/* Values for Panel field above */
#define ACPI_NHLT_MICLOCATION_TOP 0
#define ACPI_NHLT_MICLOCATION_BOTTOM 1
#define ACPI_NHLT_MICLOCATION_LEFT 2
#define ACPI_NHLT_MICLOCATION_RIGHT 3
#define ACPI_NHLT_MICLOCATION_FRONT 4
#define ACPI_NHLT_MICLOCATION_REAR 5
struct acpi_nhlt_vendor_micdevice_config {
u8 virtual_slot;
u8 config_type;
u8 array_type;
u8 mics_count;
struct acpi_nhlt_vendor_mic_config mics[];
};
struct acpi_nhlt_render_device_specific_config {
u32 capabilities_size;
union acpi_nhlt_device_config {
u8 virtual_slot;
struct acpi_nhlt_gendevice_config gen;
struct acpi_nhlt_micdevice_config mic;
struct acpi_nhlt_vendor_micdevice_config vendor_mic;
};
struct acpi_nhlt_wave_extensible {
/* Inherited from Microsoft's WAVEFORMATEXTENSIBLE. */
struct acpi_nhlt_wave_formatext {
u16 format_tag;
u16 channel_count;
u32 samples_per_sec;
@ -2078,144 +2129,28 @@ struct acpi_nhlt_wave_extensible {
u16 extra_format_size;
u16 valid_bits_per_sample;
u32 channel_mask;
u8 sub_format_guid[16];
u8 subformat[16];
};
/* Values for channel_mask above */
#define ACPI_NHLT_SPKR_FRONT_LEFT 0x1
#define ACPI_NHLT_SPKR_FRONT_RIGHT 0x2
#define ACPI_NHLT_SPKR_FRONT_CENTER 0x4
#define ACPI_NHLT_SPKR_LOW_FREQ 0x8
#define ACPI_NHLT_SPKR_BACK_LEFT 0x10
#define ACPI_NHLT_SPKR_BACK_RIGHT 0x20
#define ACPI_NHLT_SPKR_FRONT_LEFT_OF_CENTER 0x40
#define ACPI_NHLT_SPKR_FRONT_RIGHT_OF_CENTER 0x80
#define ACPI_NHLT_SPKR_BACK_CENTER 0x100
#define ACPI_NHLT_SPKR_SIDE_LEFT 0x200
#define ACPI_NHLT_SPKR_SIDE_RIGHT 0x400
#define ACPI_NHLT_SPKR_TOP_CENTER 0x800
#define ACPI_NHLT_SPKR_TOP_FRONT_LEFT 0x1000
#define ACPI_NHLT_SPKR_TOP_FRONT_CENTER 0x2000
#define ACPI_NHLT_SPKR_TOP_FRONT_RIGHT 0x4000
#define ACPI_NHLT_SPKR_TOP_BACK_LEFT 0x8000
#define ACPI_NHLT_SPKR_TOP_BACK_CENTER 0x10000
#define ACPI_NHLT_SPKR_TOP_BACK_RIGHT 0x20000
struct acpi_nhlt_format_config {
struct acpi_nhlt_wave_extensible format;
u32 capability_size;
u8 capabilities[];
struct acpi_nhlt_wave_formatext format;
struct acpi_nhlt_config config;
};
struct acpi_nhlt_formats_config {
u8 formats_count;
};
struct acpi_nhlt_device_specific_hdr {
u8 virtual_slot;
u8 config_type;
};
/* Types for config_type above */
#define ACPI_NHLT_GENERIC 0
#define ACPI_NHLT_MIC 1
#define ACPI_NHLT_RENDER 3
struct acpi_nhlt_mic_device_specific_config {
struct acpi_nhlt_device_specific_hdr device_config;
u8 array_type_ext;
};
/* Values for array_type_ext above */
#define ACPI_NHLT_ARRAY_TYPE_RESERVED 0x09 /* 9 and below are reserved */
#define ACPI_NHLT_SMALL_LINEAR_2ELEMENT 0x0A
#define ACPI_NHLT_BIG_LINEAR_2ELEMENT 0x0B
#define ACPI_NHLT_FIRST_GEOMETRY_LINEAR_4ELEMENT 0x0C
#define ACPI_NHLT_PLANAR_LSHAPED_4ELEMENT 0x0D
#define ACPI_NHLT_SECOND_GEOMETRY_LINEAR_4ELEMENT 0x0E
#define ACPI_NHLT_VENDOR_DEFINED 0x0F
#define ACPI_NHLT_ARRAY_TYPE_MASK 0x0F
#define ACPI_NHLT_ARRAY_TYPE_EXT_MASK 0x10
#define ACPI_NHLT_NO_EXTENSION 0x0
#define ACPI_NHLT_MIC_SNR_SENSITIVITY_EXT (1<<4)
struct acpi_nhlt_vendor_mic_count {
u8 microphone_count;
};
struct acpi_nhlt_vendor_mic_config {
u8 type;
u8 panel;
u16 speaker_position_distance; /* mm */
u16 horizontal_offset; /* mm */
u16 vertical_offset; /* mm */
u8 frequency_low_band; /* 5*Hz */
u8 frequency_high_band; /* 500*Hz */
u16 direction_angle; /* -180 - + 180 */
u16 elevation_angle; /* -180 - + 180 */
u16 work_vertical_angle_begin; /* -180 - + 180 with 2 deg step */
u16 work_vertical_angle_end; /* -180 - + 180 with 2 deg step */
u16 work_horizontal_angle_begin; /* -180 - + 180 with 2 deg step */
u16 work_horizontal_angle_end; /* -180 - + 180 with 2 deg step */
};
/* Values for Type field above */
#define ACPI_NHLT_MIC_OMNIDIRECTIONAL 0
#define ACPI_NHLT_MIC_SUBCARDIOID 1
#define ACPI_NHLT_MIC_CARDIOID 2
#define ACPI_NHLT_MIC_SUPER_CARDIOID 3
#define ACPI_NHLT_MIC_HYPER_CARDIOID 4
#define ACPI_NHLT_MIC_8_SHAPED 5
#define ACPI_NHLT_MIC_RESERVED6 6 /* 6 is reserved */
#define ACPI_NHLT_MIC_VENDOR_DEFINED 7
#define ACPI_NHLT_MIC_RESERVED 8 /* 8 and above are reserved */
/* Values for Panel field above */
#define ACPI_NHLT_MIC_POSITION_TOP 0
#define ACPI_NHLT_MIC_POSITION_BOTTOM 1
#define ACPI_NHLT_MIC_POSITION_LEFT 2
#define ACPI_NHLT_MIC_POSITION_RIGHT 3
#define ACPI_NHLT_MIC_POSITION_FRONT 4
#define ACPI_NHLT_MIC_POSITION_BACK 5
#define ACPI_NHLT_MIC_POSITION_RESERVED 6 /* 6 and above are reserved */
struct acpi_nhlt_vendor_mic_device_specific_config {
struct acpi_nhlt_mic_device_specific_config mic_array_device_config;
u8 number_of_microphones;
struct acpi_nhlt_vendor_mic_config mic_config[]; /* Indexed by number_of_microphones */
};
/* Microphone SNR and Sensitivity extension */
struct acpi_nhlt_mic_snr_sensitivity_extension {
u32 SNR;
u32 sensitivity;
};
/* Render device with feedback */
struct acpi_nhlt_render_feedback_device_specific_config {
u8 feedback_virtual_slot; /* Render slot in case of capture */
u16 feedback_channels; /* Informative only */
u16 feedback_valid_bits_per_sample;
};
/* Non documented structures */
struct acpi_nhlt_device_info_count {
u8 structure_count;
struct acpi_nhlt_format_config formats[];
};
struct acpi_nhlt_device_info {
u8 device_id[16];
u8 device_instance_id;
u8 device_port_id;
u8 id[16];
u8 instance_id;
u8 port_id;
};
struct acpi_nhlt_devices_info {
u8 devices_count;
struct acpi_nhlt_device_info devices[];
};
/*******************************************************************************

181
include/acpi/nhlt.h Normal file
View File

@ -0,0 +1,181 @@
/* SPDX-License-Identifier: GPL-2.0-only */
/*
* Copyright(c) 2023-2024 Intel Corporation
*
* Authors: Cezary Rojewski <cezary.rojewski@intel.com>
* Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
*/
#ifndef __ACPI_NHLT_H__
#define __ACPI_NHLT_H__
#include <linux/acpi.h>
#include <linux/kconfig.h>
#include <linux/overflow.h>
#include <linux/types.h>
#define __acpi_nhlt_endpoint_config(ep) ((void *)((ep) + 1))
#define __acpi_nhlt_config_caps(cfg) ((void *)((cfg) + 1))
/**
* 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_config *cfg = __acpi_nhlt_endpoint_config(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)->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)->config.capabilities_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)->endpoints_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)
#if IS_ENABLED(CONFIG_ACPI_NHLT)
/*
* System-wide pointer to the first NHLT table.
*
* A sound driver may utilize acpi_nhlt_get/put_gbl_table() on its
* initialization and removal respectively to avoid excessive mapping
* and unmapping of the memory occupied by the table between streaming
* operations.
*/
acpi_status acpi_nhlt_get_gbl_table(void);
void acpi_nhlt_put_gbl_table(void);
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_tb_find_endpoint(const struct acpi_table_nhlt *tb,
int link_type, int dev_type, int dir, int bus_id);
struct acpi_nhlt_endpoint *
acpi_nhlt_find_endpoint(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_tb_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);
struct acpi_nhlt_format_config *
acpi_nhlt_find_fmtcfg(int link_type, int dev_type, int dir, int bus_id,
u16 ch, u32 rate, u16 vpbs, u16 bps);
int acpi_nhlt_endpoint_mic_count(const struct acpi_nhlt_endpoint *ep);
#else /* !CONFIG_ACPI_NHLT */
static inline acpi_status acpi_nhlt_get_gbl_table(void)
{
return AE_NOT_FOUND;
}
static inline void acpi_nhlt_put_gbl_table(void)
{
}
static inline 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_tb_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_tb_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_mic_count(const struct acpi_nhlt_endpoint *ep)
{
return 0;
}
static inline struct acpi_nhlt_endpoint *
acpi_nhlt_find_endpoint(int link_type, int dev_type, int dir, int bus_id)
{
return NULL;
}
static inline struct acpi_nhlt_format_config *
acpi_nhlt_find_fmtcfg(int link_type, int dev_type, int dir, int bus_id,
u16 ch, u32 rate, u16 vpbs, u16 bps)
{
return NULL;
}
#endif /* CONFIG_ACPI_NHLT */
#endif /* __ACPI_NHLT_H__ */