of_platform.h

Go to the documentation of this file.

#ifndef _LINUX_OF_PLATFORM_H
#define _LINUX_OF_PLATFORM_H
/*
 *    Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
 *           <benh@kernel.crashing.org>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 */

#ifdef CONFIG_OF_DEVICE
#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <linux/pm.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>

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 }

struct of_platform_driver
{
    int (*probe)(struct platform_device* dev,
             const struct of_device_id *match);
    int (*remove)(struct platform_device* dev);

    int (*suspend)(struct platform_device* dev, pm_message_t state);
    int (*resume)(struct platform_device* dev);
    int (*shutdown)(struct platform_device* dev);

    struct device_driver    driver;
};
#define to_of_platform_driver(drv) \
    container_of(drv,struct of_platform_driver, driver)

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 struct platform_device *of_find_device_by_node(struct device_node *np);

#ifdef CONFIG_OF_ADDRESS /* device reg helpers depend on 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_bus_probe(struct device_node *root,
                 const struct of_device_id *matches,
                 struct device *parent);
extern int of_platform_populate(struct device_node *root,
                const struct of_device_id *matches,
                const struct of_dev_auxdata *lookup,
                struct device *parent);
#endif /* CONFIG_OF_ADDRESS */

#endif /* CONFIG_OF_DEVICE */

#if !defined(CONFIG_OF_ADDRESS)
struct of_dev_auxdata;
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;
}
#endif /* !CONFIG_OF_ADDRESS */

#endif  /* _LINUX_OF_PLATFORM_H */