[mirror_ubuntu-jammy-kernel.git] / drivers / bus / simple-pm-bus.c

/*
 * Simple Power-Managed Bus Driver
 *
 * Copyright (C) 2014-2015 Glider bvba
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 */

#include <linux/module.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>

static int simple_pm_bus_probe(struct platform_device *pdev)
{
	const struct device *dev = &pdev->dev;
	const struct of_dev_auxdata *lookup = dev_get_platdata(dev);
	struct device_node *np = dev->of_node;
	const struct of_device_id *match;

	/*
	 * Allow user to use driver_override to bind this driver to a
	 * transparent bus device which has a different compatible string
	 * that's not listed in simple_pm_bus_of_match. We don't want to do any
	 * of the simple-pm-bus tasks for these devices, so return early.
	 */
	if (pdev->driver_override)
		return 0;

	match = of_match_device(dev->driver->of_match_table, dev);
	/*
	 * These are transparent bus devices (not simple-pm-bus matches) that
	 * have their child nodes populated automatically.  So, don't need to
	 * do anything more. We only match with the device if this driver is
	 * the most specific match because we don't want to incorrectly bind to
	 * a device that has a more specific driver.
	 */
	if (match && match->data) {
		if (of_property_match_string(np, "compatible", match->compatible) == 0)
			return 0;
		else
			return -ENODEV;
	}

	dev_dbg(&pdev->dev, "%s\n", __func__);

	pm_runtime_enable(&pdev->dev);

	if (np)
		of_platform_populate(np, NULL, lookup, &pdev->dev);

	return 0;
}

static int simple_pm_bus_remove(struct platform_device *pdev)
{
	const void *data = of_device_get_match_data(&pdev->dev);

	if (pdev->driver_override || data)
		return 0;

	dev_dbg(&pdev->dev, "%s\n", __func__);

	pm_runtime_disable(&pdev->dev);
	return 0;
}

#define ONLY_BUS	((void *) 1) /* Match if the device is only a bus. */

static const struct of_device_id simple_pm_bus_of_match[] = {
	{ .compatible = "simple-pm-bus", },
	{ .compatible = "simple-bus",	.data = ONLY_BUS },
	{ .compatible = "simple-mfd",	.data = ONLY_BUS },
	{ .compatible = "isa",		.data = ONLY_BUS },
	{ .compatible = "arm,amba-bus",	.data = ONLY_BUS },
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(of, simple_pm_bus_of_match);

static struct platform_driver simple_pm_bus_driver = {
	.probe = simple_pm_bus_probe,
	.remove = simple_pm_bus_remove,
	.driver = {
		.name = "simple-pm-bus",
		.of_match_table = simple_pm_bus_of_match,
	},
};

module_platform_driver(simple_pm_bus_driver);

MODULE_DESCRIPTION("Simple Power-Managed Bus Driver");
MODULE_AUTHOR("Geert Uytterhoeven <geert+renesas@glider.be>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
89d463ea GU	1	/*
	2	* Simple Power-Managed Bus Driver
	3	*
	4	* Copyright (C) 2014-2015 Glider bvba
	5	*
	6	* This file is subject to the terms and conditions of the GNU General Public
	7	* License. See the file "COPYING" in the main directory of this archive
	8	* for more details.
	9	*/
	10
	11	#include <linux/module.h>
	12	#include <linux/of_platform.h>
	13	#include <linux/platform_device.h>
	14	#include <linux/pm_runtime.h>
	15
89d463ea GU	16	static int simple_pm_bus_probe(struct platform_device *pdev)
89d463ea GU	17	{
98e96cf8 SK	18	const struct device *dev = &pdev->dev;
	19	const struct of_dev_auxdata *lookup = dev_get_platdata(dev);
	20	struct device_node *np = dev->of_node;
	21	const struct of_device_id *match;
	22
	23	/*
	24	* Allow user to use driver_override to bind this driver to a
	25	* transparent bus device which has a different compatible string
	26	* that's not listed in simple_pm_bus_of_match. We don't want to do any
	27	* of the simple-pm-bus tasks for these devices, so return early.
	28	*/
	29	if (pdev->driver_override)
	30	return 0;
	31
	32	match = of_match_device(dev->driver->of_match_table, dev);
	33	/*
	34	* These are transparent bus devices (not simple-pm-bus matches) that
	35	* have their child nodes populated automatically. So, don't need to
	36	* do anything more. We only match with the device if this driver is
	37	* the most specific match because we don't want to incorrectly bind to
	38	* a device that has a more specific driver.
	39	*/
	40	if (match && match->data) {
	41	if (of_property_match_string(np, "compatible", match->compatible) == 0)
	42	return 0;
	43	else
	44	return -ENODEV;
	45	}
89d463ea GU	46
	47	dev_dbg(&pdev->dev, "%s\n", __func__);
	48
	49	pm_runtime_enable(&pdev->dev);
	50
	51	if (np)
eda080ea	52	of_platform_populate(np, NULL, lookup, &pdev->dev);
89d463ea GU	53
	54	return 0;
	55	}
	56
	57	static int simple_pm_bus_remove(struct platform_device *pdev)
	58	{
98e96cf8 SK	59	const void *data = of_device_get_match_data(&pdev->dev);
	60
	61	if (pdev->driver_override \|\| data)
	62	return 0;
	63
89d463ea GU	64	dev_dbg(&pdev->dev, "%s\n", __func__);
	65
	66	pm_runtime_disable(&pdev->dev);
	67	return 0;
	68	}
	69
98e96cf8 SK	70	#define ONLY_BUS ((void ) 1) / Match if the device is only a bus. */
98e96cf8 SK	71
89d463ea GU	72	static const struct of_device_id simple_pm_bus_of_match[] = {
89d463ea GU	73	{ .compatible = "simple-pm-bus", },
98e96cf8 SK	74	{ .compatible = "simple-bus", .data = ONLY_BUS },
	75	{ .compatible = "simple-mfd", .data = ONLY_BUS },
	76	{ .compatible = "isa", .data = ONLY_BUS },
	77	{ .compatible = "arm,amba-bus", .data = ONLY_BUS },
89d463ea GU	78	{ /* sentinel */ }
	79	};
	80	MODULE_DEVICE_TABLE(of, simple_pm_bus_of_match);
	81
	82	static struct platform_driver simple_pm_bus_driver = {
	83	.probe = simple_pm_bus_probe,
	84	.remove = simple_pm_bus_remove,
	85	.driver = {
	86	.name = "simple-pm-bus",
	87	.of_match_table = simple_pm_bus_of_match,
	88	},
	89	};
	90
	91	module_platform_driver(simple_pm_bus_driver);
	92
	93	MODULE_DESCRIPTION("Simple Power-Managed Bus Driver");
	94	MODULE_AUTHOR("Geert Uytterhoeven <geert+renesas@glider.be>");
	95	MODULE_LICENSE("GPL v2");