mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-27 12:57:53 +00:00
ef175b29a2
The DT of_device.h and of_platform.h headers date back to the separate of_platform_bus_type before it was merged into the regular platform bus. As part of that merge prepping Arm DT support 13 years ago, they "temporarily" include each other. The headers also include platform_device.h and of.h. The result was lots of drivers relied on these implicit includes. Now the entire tree has been fixed over the last couple of cycles to explicitly include the necessary headers instead of relying on of_device.h and/or of_platform.h implicit includes, so the implicit and circular includes can finally be removed. Signed-off-by: Rob Herring <robh@kernel.org>
130 lines
4.1 KiB
C
130 lines
4.1 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
#ifndef _LINUX_OF_PLATFORM_H
|
|
#define _LINUX_OF_PLATFORM_H
|
|
/*
|
|
* Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
|
|
* <benh@kernel.crashing.org>
|
|
*/
|
|
|
|
#include <linux/mod_devicetable.h>
|
|
|
|
struct device;
|
|
struct device_node;
|
|
struct of_device_id;
|
|
struct platform_device;
|
|
|
|
/**
|
|
* struct of_dev_auxdata - lookup table entry for device names & platform_data
|
|
* @compatible: compatible value of node to match against node
|
|
* @phys_addr: Start address of registers to match against node
|
|
* @name: Name to assign for matching nodes
|
|
* @platform_data: platform_data to assign for matching nodes
|
|
*
|
|
* This lookup table allows the caller of of_platform_populate() to override
|
|
* the names of devices when creating devices from the device tree. The table
|
|
* should be terminated with an empty entry. It also allows the platform_data
|
|
* pointer to be set.
|
|
*
|
|
* The reason for this functionality is that some Linux infrastructure uses
|
|
* the device name to look up a specific device, but the Linux-specific names
|
|
* are not encoded into the device tree, so the kernel needs to provide specific
|
|
* values.
|
|
*
|
|
* Note: Using an auxdata lookup table should be considered a last resort when
|
|
* converting a platform to use the DT. Normally the automatically generated
|
|
* device name will not matter, and drivers should obtain data from the device
|
|
* node instead of from an anonymous platform_data pointer.
|
|
*/
|
|
struct of_dev_auxdata {
|
|
char *compatible;
|
|
resource_size_t phys_addr;
|
|
char *name;
|
|
void *platform_data;
|
|
};
|
|
|
|
/* Macro to simplify populating a lookup table */
|
|
#define OF_DEV_AUXDATA(_compat,_phys,_name,_pdata) \
|
|
{ .compatible = _compat, .phys_addr = _phys, .name = _name, \
|
|
.platform_data = _pdata }
|
|
|
|
extern const struct of_device_id of_default_bus_match_table[];
|
|
|
|
/* Platform drivers register/unregister */
|
|
extern struct platform_device *of_device_alloc(struct device_node *np,
|
|
const char *bus_id,
|
|
struct device *parent);
|
|
|
|
extern int of_device_add(struct platform_device *pdev);
|
|
extern int of_device_register(struct platform_device *ofdev);
|
|
extern void of_device_unregister(struct platform_device *ofdev);
|
|
|
|
#ifdef CONFIG_OF
|
|
extern struct platform_device *of_find_device_by_node(struct device_node *np);
|
|
#else
|
|
static inline struct platform_device *of_find_device_by_node(struct device_node *np)
|
|
{
|
|
return NULL;
|
|
}
|
|
#endif
|
|
|
|
extern int of_platform_bus_probe(struct device_node *root,
|
|
const struct of_device_id *matches,
|
|
struct device *parent);
|
|
|
|
#ifdef CONFIG_OF_ADDRESS
|
|
/* Platform devices and busses creation */
|
|
extern struct platform_device *of_platform_device_create(struct device_node *np,
|
|
const char *bus_id,
|
|
struct device *parent);
|
|
|
|
extern int of_platform_device_destroy(struct device *dev, void *data);
|
|
|
|
extern int of_platform_populate(struct device_node *root,
|
|
const struct of_device_id *matches,
|
|
const struct of_dev_auxdata *lookup,
|
|
struct device *parent);
|
|
extern int of_platform_default_populate(struct device_node *root,
|
|
const struct of_dev_auxdata *lookup,
|
|
struct device *parent);
|
|
extern void of_platform_depopulate(struct device *parent);
|
|
|
|
extern int devm_of_platform_populate(struct device *dev);
|
|
|
|
extern void devm_of_platform_depopulate(struct device *dev);
|
|
#else
|
|
/* Platform devices and busses creation */
|
|
static inline struct platform_device *of_platform_device_create(struct device_node *np,
|
|
const char *bus_id,
|
|
struct device *parent)
|
|
{
|
|
return NULL;
|
|
}
|
|
static inline int of_platform_device_destroy(struct device *dev, void *data)
|
|
{
|
|
return -ENODEV;
|
|
}
|
|
|
|
static inline int of_platform_populate(struct device_node *root,
|
|
const struct of_device_id *matches,
|
|
const struct of_dev_auxdata *lookup,
|
|
struct device *parent)
|
|
{
|
|
return -ENODEV;
|
|
}
|
|
static inline int of_platform_default_populate(struct device_node *root,
|
|
const struct of_dev_auxdata *lookup,
|
|
struct device *parent)
|
|
{
|
|
return -ENODEV;
|
|
}
|
|
static inline void of_platform_depopulate(struct device *parent) { }
|
|
|
|
static inline int devm_of_platform_populate(struct device *dev)
|
|
{
|
|
return -ENODEV;
|
|
}
|
|
|
|
static inline void devm_of_platform_depopulate(struct device *dev) { }
|
|
#endif
|
|
|
|
#endif /* _LINUX_OF_PLATFORM_H */
|