2 # SPDX-License-Identifier: GPL-2.0+
4 # Copyright (C) 2016 Google, Inc
5 # Written by Simon Glass <sjg@chromium.org>
8 # Utility functions for reading from a device tree. Once the upstream pylibfdt
9 # implementation advances far enough, we should be able to drop these.
16 from patman import command
17 from patman import tools
19 def fdt32_to_cpu(val):
20 """Convert a device tree cell to an integer
23 Value to convert (4-character string representing the cell value)
26 A native-endian integer value
28 return struct.unpack('>I', val)[0]
30 def fdt64_to_cpu(val):
31 """Convert a device tree cell to an integer
34 val (list): Value to convert (list of 2 4-character strings representing
38 int: A native-endian integer value
40 return fdt32_to_cpu(val[0]) << 32 | fdt32_to_cpu(val[1])
42 def fdt_cells_to_cpu(val, cells):
43 """Convert one or two cells to a long integer
46 Value to convert (array of one or more 4-character strings)
49 A native-endian integer value
53 out = int(fdt32_to_cpu(val[0]))
55 out = out << 32 | fdt32_to_cpu(val[1])
58 def EnsureCompiled(fname, tmpdir=None, capture_stderr=False):
59 """Compile an fdt .dts source file into a .dtb binary blob if needed.
62 fname: Filename (if .dts it will be compiled). It not it will be
64 tmpdir: Temporary directory for output files, or None to use the
65 tools-module output directory
68 Filename of resulting .dtb file
70 _, ext = os.path.splitext(fname)
75 dts_input = os.path.join(tmpdir, 'source.dts')
76 dtb_output = os.path.join(tmpdir, 'source.dtb')
78 dts_input = tools.GetOutputFilename('source.dts')
79 dtb_output = tools.GetOutputFilename('source.dtb')
81 search_paths = [os.path.join(os.getcwd(), 'include')]
82 root, _ = os.path.splitext(fname)
83 cc, args = tools.GetTargetCompileTool('cc')
84 args += ['-E', '-P', '-x', 'assembler-with-cpp', '-D__ASSEMBLY__']
86 for path in search_paths:
87 args.extend(['-I', path])
88 args += ['-o', dts_input, fname]
89 command.Run(cc, *args)
91 # If we don't have a directory, put it in the tools tempdir
93 for path in search_paths:
94 search_list.extend(['-i', path])
95 dtc, args = tools.GetTargetCompileTool('dtc')
96 args += ['-I', 'dts', '-o', dtb_output, '-O', 'dtb',
97 '-W', 'no-unit_address_vs_reg']
98 args.extend(search_list)
99 args.append(dts_input)
100 command.Run(dtc, *args, capture_stderr=capture_stderr)
103 def GetInt(node, propname, default=None):
104 """Get an integer from a property
107 node: Node object to read from
108 propname: property name to read
109 default: Default value to use if the node/property do not exist
112 Integer value read, or default if none
114 prop = node.props.get(propname)
117 if isinstance(prop.value, list):
118 raise ValueError("Node '%s' property '%s' has list value: expecting "
119 "a single integer" % (node.name, propname))
120 value = fdt32_to_cpu(prop.value)
123 def GetInt64(node, propname, default=None):
124 """Get a 64-bit integer from a property
127 node (Node): Node object to read from
128 propname (str): property name to read
129 default (int): Default value to use if the node/property do not exist
132 int: value read, or default if none
135 ValueError: Property is not of the correct size
137 prop = node.props.get(propname)
140 if not isinstance(prop.value, list) or len(prop.value) != 2:
141 raise ValueError("Node '%s' property '%s' should be a list with 2 items for 64-bit values" %
142 (node.name, propname))
143 value = fdt64_to_cpu(prop.value)
146 def GetString(node, propname, default=None):
147 """Get a string from a property
150 node: Node object to read from
151 propname: property name to read
152 default: Default value to use if the node/property do not exist
155 String value read, or default if none
157 prop = node.props.get(propname)
161 if isinstance(value, list):
162 raise ValueError("Node '%s' property '%s' has list value: expecting "
163 "a single string" % (node.name, propname))
166 def GetStringList(node, propname, default=None):
167 """Get a string list from a property
170 node (Node): Node object to read from
171 propname (str): property name to read
172 default (list of str): Default value to use if the node/property do not
176 String value read, or default if none
178 prop = node.props.get(propname)
182 if not isinstance(value, list):
183 strval = GetString(node, propname)
187 def GetBool(node, propname, default=False):
188 """Get an boolean from a property
191 node: Node object to read from
192 propname: property name to read
193 default: Default value to use if the node/property do not exist
196 Boolean value read, or default if none (if you set this to True the
197 function will always return True)
199 if propname in node.props:
203 def GetByte(node, propname, default=None):
204 """Get an byte from a property
207 node: Node object to read from
208 propname: property name to read
209 default: Default value to use if the node/property do not exist
212 Byte value read, or default if none
214 prop = node.props.get(propname)
218 if isinstance(value, list):
219 raise ValueError("Node '%s' property '%s' has list value: expecting "
220 "a single byte" % (node.name, propname))
222 raise ValueError("Node '%s' property '%s' has length %d, expecting %d" %
223 (node.name, propname, len(value), 1))
226 def GetBytes(node, propname, size, default=None):
227 """Get a set of bytes from a property
230 node (Node): Node object to read from
231 propname (str): property name to read
232 size (int): Number of bytes to expect
233 default (bytes): Default value or None
236 bytes: Bytes value read, or default if none
238 prop = node.props.get(propname)
241 if len(prop.bytes) != size:
242 raise ValueError("Node '%s' property '%s' has length %d, expecting %d" %
243 (node.name, propname, len(prop.bytes), size))
246 def GetPhandleList(node, propname):
247 """Get a list of phandles from a property
250 node: Node object to read from
251 propname: property name to read
254 List of phandles read, each an integer
256 prop = node.props.get(propname)
260 if not isinstance(value, list):
262 return [fdt32_to_cpu(v) for v in value]
264 def GetDatatype(node, propname, datatype):
265 """Get a value of a given type from a property
268 node: Node object to read from
269 propname: property name to read
270 datatype: Type to read (str or int)
273 value read, or None if none
276 ValueError if datatype is not str or int
279 return GetString(node, propname)
280 elif datatype == int:
281 return GetInt(node, propname)
282 raise ValueError("fdt_util internal error: Unknown data type '%s'" %