LXR linux/include/linux/of

   1/*
   2 * OF graph binding parsing helpers
   3 *
   4 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
   5 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
   6 *
   7 * Copyright (C) 2012 Renesas Electronics Corp.
   8 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of version 2 of the GNU General Public License as
  12 * published by the Free Software Foundation.
  13 */
  14#ifndef __LINUX_OF_GRAPH_H
  15#define __LINUX_OF_GRAPH_H
  16
  17#include <linux/types.h>
  18#include <linux/errno.h>
  19
  20/**
  21 * struct of_endpoint - the OF graph endpoint data structure
  22 * @port: identifier (value of reg property) of a port this endpoint belongs to
  23 * @id: identifier (value of reg property) of this endpoint
  24 * @local_node: pointer to device_node of this endpoint
  25 */
  26struct of_endpoint {
  27        unsigned int port;
  28        unsigned int id;
  29        const struct device_node *local_node;
  30};
  31
  32/**
  33 * for_each_endpoint_of_node - iterate over every endpoint in a device node
  34 * @parent: parent device node containing ports and endpoints
  35 * @child: loop variable pointing to the current endpoint node
  36 *
  37 * When breaking out of the loop, of_node_put(child) has to be called manually.
  38 */
  39#define for_each_endpoint_of_node(parent, child) \
  40        for (child = of_graph_get_next_endpoint(parent, NULL); child != NULL; \
  41             child = of_graph_get_next_endpoint(parent, child))
  42
  43#ifdef CONFIG_OF
  44int of_graph_parse_endpoint(const struct device_node *node,
  45                                struct of_endpoint *endpoint);
  46struct device_node *of_graph_get_port_by_id(struct device_node *node, u32 id);
  47struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
  48                                        struct device_node *previous);
  49struct device_node *of_graph_get_endpoint_by_regs(
  50                const struct device_node *parent, int port_reg, int reg);
  51struct device_node *of_graph_get_remote_port_parent(
  52                                        const struct device_node *node);
  53struct device_node *of_graph_get_remote_port(const struct device_node *node);
  54#else
  55
  56static inline int of_graph_parse_endpoint(const struct device_node *node,
  57                                        struct of_endpoint *endpoint)
  58{
  59        return -ENOSYS;
  60}
  61
  62static inline struct device_node *of_graph_get_port_by_id(
  63                                        struct device_node *node, u32 id)
  64{
  65        return NULL;
  66}
  67
  68static inline struct device_node *of_graph_get_next_endpoint(
  69                                        const struct device_node *parent,
  70                                        struct device_node *previous)
  71{
  72        return NULL;
  73}
  74
  75static inline struct device_node *of_graph_get_endpoint_by_regs(
  76                const struct device_node *parent, int port_reg, int reg)
  77{
  78        return NULL;
  79}
  80
  81static inline struct device_node *of_graph_get_remote_port_parent(
  82                                        const struct device_node *node)
  83{
  84        return NULL;
  85}
  86
  87static inline struct device_node *of_graph_get_remote_port(
  88                                        const struct device_node *node)
  89{
  90        return NULL;
  91}
  92
  93#endif /* CONFIG_OF */
  94
  95#endif /* __LINUX_OF_GRAPH_H */
  96