ARK-OS/arkos/kernel/drivers/platform/x86/serdev_helpers.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * In some cases UART attached devices which require an in kernel driver,
 * e.g. UART attached Bluetooth HCIs are described in the ACPI tables
 * by an ACPI device with a broken or missing UartSerialBusV2() resource.
 *
 * This causes the kernel to create a /dev/ttyS# char-device for the UART
 * instead of creating an in kernel serdev-controller + serdev-device pair
 * for the in kernel driver.
 *
 * The quirk handling in acpi_quirk_skip_serdev_enumeration() makes the kernel
 * create a serdev-controller device for these UARTs instead of a /dev/ttyS#.
 *
 * Instantiating the actual serdev-device to bind to is up to pdx86 code,
 * this header provides a helper for getting the serdev-controller device.
 */
#include <linux/acpi.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/printk.h>
#include <linux/sprintf.h>
#include <linux/string.h>

static inline struct device *
get_serdev_controller_from_parent(struct device *ctrl_dev,
				  int serial_ctrl_port,
				  const char *serdev_ctrl_name)
{
	struct device *child;
	char name[32];
	int i;

	/* Walk host -> uart-ctrl -> port -> serdev-ctrl */
	for (i = 0; i < 3; i++) {
		switch (i) {
		case 0:
			snprintf(name, sizeof(name), "%s:0", dev_name(ctrl_dev));
			break;
		case 1:
			snprintf(name, sizeof(name), "%s.%d",
				 dev_name(ctrl_dev), serial_ctrl_port);
			break;
		case 2:
			strscpy(name, serdev_ctrl_name, sizeof(name));
			break;
		}

		child = device_find_child_by_name(ctrl_dev, name);
		put_device(ctrl_dev);
		if (!child) {
			pr_err("error could not find '%s' device\n", name);
			return ERR_PTR(-ENODEV);
		}

		ctrl_dev = child;
	}

	return ctrl_dev;
}

static inline struct device *
get_serdev_controller(const char *serial_ctrl_hid,
		      const char *serial_ctrl_uid,
		      int serial_ctrl_port,
		      const char *serdev_ctrl_name)
{
	struct acpi_device *adev;
	struct device *parent;

	adev = acpi_dev_get_first_match_dev(serial_ctrl_hid, serial_ctrl_uid, -1);
	if (!adev) {
		pr_err("error could not get %s/%s serial-ctrl adev\n",
		       serial_ctrl_hid, serial_ctrl_uid ?: "*");
		return ERR_PTR(-ENODEV);
	}

	/* get_first_physical_node() returns a weak ref */
	parent = get_device(acpi_get_first_physical_node(adev));
	acpi_dev_put(adev);
	if (!parent) {
		pr_err("error could not get %s/%s serial-ctrl physical node\n",
		       serial_ctrl_hid, serial_ctrl_uid ?: "*");
		return ERR_PTR(-ENODEV);
	}

	/* This puts our reference on parent and returns a ref on the ctrl */
	return get_serdev_controller_from_parent(parent, serial_ctrl_port, serdev_ctrl_name);
}