include/linux/of_graph.h

   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  */
  26 struct 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
  44 int of_graph_parse_endpoint(const struct device_node *node,
  45                                 struct of_endpoint *endpoint);
  46 int of_graph_get_endpoint_count(const struct device_node *np);
  47 struct device_node *of_graph_get_port_by_id(struct device_node *node, u32 id);
  48 struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
  49                                         struct device_node *previous);
  50 struct device_node *of_graph_get_endpoint_by_regs(
  51                 const struct device_node *parent, int port_reg, int reg);
  52 struct device_node *of_graph_get_remote_endpoint(
  53                                         const struct device_node *node);
  54 struct device_node *of_graph_get_port_parent(struct device_node *node);
  55 struct device_node *of_graph_get_remote_port_parent(
  56                                         const struct device_node *node);
  57 struct device_node *of_graph_get_remote_port(const struct device_node *node);
  58 struct device_node *of_graph_get_remote_node(const struct device_node *node,
  59                                              u32 port, u32 endpoint);
  60 #else
  61
  62 static inline int of_graph_parse_endpoint(const struct device_node *node,
  63                                         struct of_endpoint *endpoint)
  64 {
  65         return -ENOSYS;
  66 }
  67
  68 static inline int of_graph_get_endpoint_count(const struct device_node *np)
  69 {
  70         return 0;
  71 }
  72
  73 static inline struct device_node *of_graph_get_port_by_id(
  74                                         struct device_node *node, u32 id)
  75 {
  76         return NULL;
  77 }
  78
  79 static inline struct device_node *of_graph_get_next_endpoint(
  80                                         const struct device_node *parent,
  81                                         struct device_node *previous)
  82 {
  83         return NULL;
  84 }
  85
  86 static inline struct device_node *of_graph_get_endpoint_by_regs(
  87                 const struct device_node *parent, int port_reg, int reg)
  88 {
  89         return NULL;
  90 }
  91
  92 static inline struct device_node *of_graph_get_remote_endpoint(
  93                                         const struct device_node *node)
  94 {
  95         return NULL;
  96 }
  97
  98 static inline struct device_node *of_graph_get_port_parent(
  99         struct device_node *node)
 100 {
 101         return NULL;
 102 }
 103
 104 static inline struct device_node *of_graph_get_remote_port_parent(
 105                                         const struct device_node *node)
 106 {
 107         return NULL;
 108 }
 109
 110 static inline struct device_node *of_graph_get_remote_port(
 111                                         const struct device_node *node)
 112 {
 113         return NULL;
 114 }
 115 static inline struct device_node *of_graph_get_remote_node(
 116                                         const struct device_node *node,
 117                                         u32 port, u32 endpoint)
 118 {
 119         return NULL;
 120 }
 121
 122 #endif /* CONFIG_OF */
 123
 124 #endif /* __LINUX_OF_GRAPH_H */