3 # Copyright (C) 2016 Google, Inc
4 # Written by Simon Glass <sjg@chromium.org>
6 # SPDX-License-Identifier: GPL-2.0+
11 from fdt import Fdt, NodeBase, PropBase
15 # This deals with a device tree, presenting it as a list of Node and Prop
16 # objects, representing nodes and properties, respectively.
18 # This implementation uses the fdtget tool to access the device tree, so it
19 # is not very efficient for larger trees. The tool is called once for each
20 # node and property in the tree.
23 """A device tree property
26 name: Property name (as per the device tree)
27 value: Property value as a string of bytes, or a list of strings of
31 def __init__(self, node, name, byte_list_str):
32 PropBase.__init__(self, node, 0, name)
33 if not byte_list_str.strip():
34 self.type = fdt.TYPE_BOOL
36 self.bytes = [chr(int(byte, 16))
37 for byte in byte_list_str.strip().split(' ')]
38 self.type, self.value = self.BytesToValue(''.join(self.bytes))
45 name: Device tree node tname
46 path: Full path to node, along with the node name itself
47 _fdt: Device tree object
48 subnodes: A list of subnodes for this node, each a Node object
49 props: A dict of properties for this node, each a Prop object.
50 Keyed by property name
52 def __init__(self, fdt, offset, name, path):
53 NodeBase.__init__(self, fdt, offset, name, path)
56 """Scan a node's properties and subnodes
58 This fills in the props and subnodes properties, recursively
59 searching into subnodes so that the entire tree is built.
61 for name, byte_list_str in self._fdt.GetProps(self.path).iteritems():
62 prop = Prop(self, name, byte_list_str)
63 self.props[name] = prop
65 for name in self._fdt.GetSubNodes(self.path):
66 sep = '' if self.path[-1] == '/' else '/'
67 path = self.path + sep + name
68 node = Node(self._fdt, 0, name, path)
69 self.subnodes.append(node)
73 def DeleteProp(self, prop_name):
74 """Delete a property of a node
76 The property is deleted using fdtput.
79 prop_name: Name of the property to delete
81 CommandError if the property does not exist
83 args = [self._fdt._fname, '-d', self.path, prop_name]
84 command.Output('fdtput', *args)
85 del self.props[prop_name]
87 class FdtFallback(Fdt):
88 """Provides simple access to a flat device tree blob using fdtget/fdtput
94 def __init__(self, fname):
95 Fdt.__init__(self, fname)
97 self._fname = fdt_util.EnsureCompiled(self._fname)
99 def GetSubNodes(self, node):
100 """Returns a list of sub-nodes of a given node
103 node: Node name to return children from
106 List of children in the node (each a string node name)
109 CmdError: if the node does not exist.
111 out = command.Output('fdtget', self._fname, '-l', node)
112 return out.strip().splitlines()
114 def GetProps(self, node):
115 """Get all properties from a node
118 node: full path to node name to look in
121 A dictionary containing all the properties, indexed by node name.
122 The entries are simply strings - no decoding of lists or numbers
126 CmdError: if the node does not exist.
128 out = command.Output('fdtget', self._fname, node, '-p')
129 props = out.strip().splitlines()
133 props_dict[prop] = self.GetProp(node, name)
136 def GetProp(self, node, prop, default=None, typespec=None):
137 """Get a property from a device tree.
139 This looks up the given node and property, and returns the value as a
142 If the node or property does not exist, this will return the default
146 node: Full path to node to look up.
147 prop: Property name to look up.
148 default: Default value to return if nothing is present in the fdt,
149 or None to raise in this case. This will be converted to a
151 typespec: Type character to use (None for default, 's' for string)
154 string containing the property value.
157 CmdError: if the property does not exist and no default is provided.
159 args = [self._fname, node, prop, '-t', 'bx']
160 if default is not None:
161 args += ['-d', str(default)]
162 if typespec is not None:
163 args += ['-t%s' % typespec]
164 out = command.Output('fdtget', *args)
168 def Node(self, fdt, offset, name, path):
171 This is used by Fdt.Scan() to create a new node using the correct
176 offset: Offset of node
178 path: Full path to node
180 node = Node(fdt, offset, name, path)