fdthelper.py revision 13719
112267Sradhika.jagtap@arm.com# Copyright (c) 2016 ARM Limited 212267Sradhika.jagtap@arm.com# All rights reserved. 312267Sradhika.jagtap@arm.com# 412267Sradhika.jagtap@arm.com# The license below extends only to copyright in the software and shall 512267Sradhika.jagtap@arm.com# not be construed as granting a license to any other intellectual 612267Sradhika.jagtap@arm.com# property including but not limited to intellectual property relating 712267Sradhika.jagtap@arm.com# to a hardware implementation of the functionality of the software 812267Sradhika.jagtap@arm.com# licensed hereunder. You may use the software subject to the license 912267Sradhika.jagtap@arm.com# terms below provided that you ensure that this notice is replicated 1012267Sradhika.jagtap@arm.com# unmodified and in its entirety in all distributions of the software, 1112267Sradhika.jagtap@arm.com# modified or unmodified, in source code or in binary form. 1212267Sradhika.jagtap@arm.com# 1312267Sradhika.jagtap@arm.com# Redistribution and use in source and binary forms, with or without 1412267Sradhika.jagtap@arm.com# modification, are permitted provided that the following conditions are 1512267Sradhika.jagtap@arm.com# met: redistributions of source code must retain the above copyright 1612267Sradhika.jagtap@arm.com# notice, this list of conditions and the following disclaimer; 1712267Sradhika.jagtap@arm.com# redistributions in binary form must reproduce the above copyright 1812267Sradhika.jagtap@arm.com# notice, this list of conditions and the following disclaimer in the 1912267Sradhika.jagtap@arm.com# documentation and/or other materials provided with the distribution; 2012267Sradhika.jagtap@arm.com# neither the name of the copyright holders nor the names of its 2112267Sradhika.jagtap@arm.com# contributors may be used to endorse or promote products derived from 2212267Sradhika.jagtap@arm.com# this software without specific prior written permission. 2312267Sradhika.jagtap@arm.com# 2412267Sradhika.jagtap@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2512267Sradhika.jagtap@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2612267Sradhika.jagtap@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2712267Sradhika.jagtap@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2812267Sradhika.jagtap@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2912267Sradhika.jagtap@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3012267Sradhika.jagtap@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3112267Sradhika.jagtap@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3212267Sradhika.jagtap@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3312267Sradhika.jagtap@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3412267Sradhika.jagtap@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3512267Sradhika.jagtap@arm.com# 3612267Sradhika.jagtap@arm.com# Author: Glenn Bergmans 3712267Sradhika.jagtap@arm.com 3812267Sradhika.jagtap@arm.comimport six 3912564Sgabeblack@google.comif six.PY3: 4013774Sandreas.sandberg@arm.com long = int 4112564Sgabeblack@google.com 4212267Sradhika.jagtap@arm.comfrom m5.ext.pyfdt import pyfdt 4312267Sradhika.jagtap@arm.comimport re 4412267Sradhika.jagtap@arm.comimport os 4512267Sradhika.jagtap@arm.comfrom m5.SimObject import SimObject 4612267Sradhika.jagtap@arm.com 4712267Sradhika.jagtap@arm.comclass FdtProperty(pyfdt.FdtProperty): 4812267Sradhika.jagtap@arm.com """Create a property without values.""" 4913774Sandreas.sandberg@arm.com pass 5013774Sandreas.sandberg@arm.com 5113774Sandreas.sandberg@arm.comclass FdtPropertyWords(pyfdt.FdtPropertyWords): 5212267Sradhika.jagtap@arm.com """Create a property with word (32-bit unsigned) values.""" 5312267Sradhika.jagtap@arm.com def __init__(self, name, words): 5412267Sradhika.jagtap@arm.com if type(words) != list: 5512267Sradhika.jagtap@arm.com words = [words] 5612267Sradhika.jagtap@arm.com # Make sure all values are ints (use automatic base detection if the 5712267Sradhika.jagtap@arm.com # type is str) 5812267Sradhika.jagtap@arm.com words = [long(w, base=0) if type(w) == str else long(w) for w in words] 5912267Sradhika.jagtap@arm.com super(FdtPropertyWords, self).__init__(name, words) 6012267Sradhika.jagtap@arm.com 6112267Sradhika.jagtap@arm.comclass FdtPropertyStrings(pyfdt.FdtPropertyStrings): 6212267Sradhika.jagtap@arm.com """Create a property with string values.""" 6312267Sradhika.jagtap@arm.com 6412267Sradhika.jagtap@arm.com def __init__(self, name, strings): 6512267Sradhika.jagtap@arm.com if type(strings) == str: 6612267Sradhika.jagtap@arm.com strings = [strings] 6712267Sradhika.jagtap@arm.com strings = [str(string) for string in strings] # Make all values strings 6812267Sradhika.jagtap@arm.com super(FdtPropertyStrings, self).__init__(name, strings) 6912267Sradhika.jagtap@arm.com 7012267Sradhika.jagtap@arm.comclass FdtPropertyBytes(pyfdt.FdtPropertyBytes): 7112267Sradhika.jagtap@arm.com """Create a property with integer (8-bit signed) values.""" 7212267Sradhika.jagtap@arm.com 7312267Sradhika.jagtap@arm.com def __init__(self, name, values): 7412267Sradhika.jagtap@arm.com if type(values) != list: 7512267Sradhika.jagtap@arm.com values = [values] 7612267Sradhika.jagtap@arm.com # Make sure all values are ints (use automatic base detection if the 7712267Sradhika.jagtap@arm.com # type is str) 7812267Sradhika.jagtap@arm.com values = [int(v, base=0) 7912267Sradhika.jagtap@arm.com if isinstance(v, str) else int(v) for v in values] 8012267Sradhika.jagtap@arm.com super(FdtPropertyBytes, self).__init__(name, values) 8112267Sradhika.jagtap@arm.com 8212267Sradhika.jagtap@arm.comclass FdtState(object): 8312267Sradhika.jagtap@arm.com """Class for maintaining state while recursively generating a flattened 8412267Sradhika.jagtap@arm.com device tree. The state tracks address, size and CPU address cell sizes, and 8512267Sradhika.jagtap@arm.com maintains a dictionary of allocated phandles.""" 8612267Sradhika.jagtap@arm.com 8712267Sradhika.jagtap@arm.com phandle_counter = 0 8812267Sradhika.jagtap@arm.com phandles = dict() 8912267Sradhika.jagtap@arm.com 9012267Sradhika.jagtap@arm.com def __init__(self, addr_cells, size_cells, cpu_cells): 9112267Sradhika.jagtap@arm.com """Instantiate values of this state. The state can only be initialized 9212267Sradhika.jagtap@arm.com once.""" 9312267Sradhika.jagtap@arm.com 9412267Sradhika.jagtap@arm.com self.addr_cells = addr_cells 9512267Sradhika.jagtap@arm.com self.size_cells = size_cells 9612267Sradhika.jagtap@arm.com self.cpu_cells = cpu_cells 9712267Sradhika.jagtap@arm.com 9812267Sradhika.jagtap@arm.com def phandle(self, obj): 9912267Sradhika.jagtap@arm.com """Return a unique phandle number for a key. The key can be a SimObject 10012267Sradhika.jagtap@arm.com or any value that is castable to a string. If the phandle doesn't exist 10112267Sradhika.jagtap@arm.com a new one is created, otherwise the existing one is returned.""" 10212267Sradhika.jagtap@arm.com 10312267Sradhika.jagtap@arm.com if isinstance(obj, SimObject): 10412267Sradhika.jagtap@arm.com key = str(id(obj)) 10512267Sradhika.jagtap@arm.com else: 10612267Sradhika.jagtap@arm.com try: 10712267Sradhika.jagtap@arm.com key = str(obj) 10812267Sradhika.jagtap@arm.com except ValueError: 10912267Sradhika.jagtap@arm.com raise ValueError('Phandle keys must be castable to str') 11012267Sradhika.jagtap@arm.com 11112267Sradhika.jagtap@arm.com if not key in FdtState.phandles: 11212267Sradhika.jagtap@arm.com FdtState.phandle_counter += 1 11312267Sradhika.jagtap@arm.com 11412267Sradhika.jagtap@arm.com return FdtState.phandles.setdefault(key, FdtState.phandle_counter) 11512267Sradhika.jagtap@arm.com 11612267Sradhika.jagtap@arm.com def resetPhandles(self): 11712267Sradhika.jagtap@arm.com FdtState.phandle_counter = 0 11812267Sradhika.jagtap@arm.com FdtState.phandles = dict() 11912267Sradhika.jagtap@arm.com 12012267Sradhika.jagtap@arm.com def int_to_cells(self, value, cells): 12112267Sradhika.jagtap@arm.com """Helper function for: generates a list of 32 bit cells from an int, 12212267Sradhika.jagtap@arm.com used to split up addresses in appropriate 32 bit chunks.""" 12312267Sradhika.jagtap@arm.com value = long(value) 12412267Sradhika.jagtap@arm.com 12512267Sradhika.jagtap@arm.com if (value >> (32 * cells)) != 0: 12612267Sradhika.jagtap@arm.com fatal("Value %d doesn't fit in %d cells" % (value, cells)) 12712267Sradhika.jagtap@arm.com 12812267Sradhika.jagtap@arm.com return [(value >> 32*(x-1)) & 0xFFFFFFFF for x in range(cells, 0, -1)] 12912267Sradhika.jagtap@arm.com 13012267Sradhika.jagtap@arm.com def addrCells(self, addr): 13112267Sradhika.jagtap@arm.com """Format an integer type according to the address_cells value of this 13212267Sradhika.jagtap@arm.com state.""" 13312267Sradhika.jagtap@arm.com return self.int_to_cells(addr, self.addr_cells) 13412267Sradhika.jagtap@arm.com 13512267Sradhika.jagtap@arm.com def CPUAddrCells(self, addr): 13612267Sradhika.jagtap@arm.com """Format an integer type according to the cpu_cells value of this 13712267Sradhika.jagtap@arm.com state.""" 13812267Sradhika.jagtap@arm.com return self.int_to_cells(addr, self.cpu_cells) 13912267Sradhika.jagtap@arm.com 14012267Sradhika.jagtap@arm.com def sizeCells(self, size): 14112267Sradhika.jagtap@arm.com """Format an integer type according to the size_cells value of this 14212267Sradhika.jagtap@arm.com state.""" 14312267Sradhika.jagtap@arm.com return self.int_to_cells(size, self.size_cells) 14412267Sradhika.jagtap@arm.com 14512267Sradhika.jagtap@arm.com def addrCellsProperty(self): 14612267Sradhika.jagtap@arm.com """Return an #address-cells property with the value of this state.""" 14712267Sradhika.jagtap@arm.com return FdtPropertyWords("#address-cells", self.addr_cells) 14812267Sradhika.jagtap@arm.com 14912267Sradhika.jagtap@arm.com def sizeCellsProperty(self): 15012267Sradhika.jagtap@arm.com """Return an #size-cells property with the value of this state.""" 15112267Sradhika.jagtap@arm.com return FdtPropertyWords("#size-cells", self.size_cells) 15212267Sradhika.jagtap@arm.com 15312267Sradhika.jagtap@arm.com def CPUCellsProperty(self): 15412267Sradhika.jagtap@arm.com """Return an #address-cells property for cpu nodes with the value 15512267Sradhika.jagtap@arm.com of this state.""" 15612267Sradhika.jagtap@arm.com return FdtPropertyWords("#address-cells", self.cpu_cells) 15712267Sradhika.jagtap@arm.com 15812267Sradhika.jagtap@arm.comclass FdtNop(pyfdt.FdtNop): 15912267Sradhika.jagtap@arm.com """Create an empty node.""" 16012267Sradhika.jagtap@arm.com pass 16112267Sradhika.jagtap@arm.com 16212267Sradhika.jagtap@arm.comclass FdtNode(pyfdt.FdtNode): 16312267Sradhika.jagtap@arm.com def __init__(self, name, obj=None): 16412267Sradhika.jagtap@arm.com """Create a new node and immediately set the phandle property, if obj 16512267Sradhika.jagtap@arm.com is supplied""" 16612267Sradhika.jagtap@arm.com super(FdtNode, self).__init__(name) 16712267Sradhika.jagtap@arm.com if obj != None: 16812267Sradhika.jagtap@arm.com self.appendPhandle(obj) 16912267Sradhika.jagtap@arm.com 17012267Sradhika.jagtap@arm.com def append(self, subnodes): 17113731Sandreas.sandberg@arm.com """Change the behavior of the normal append to override if a node with 17212267Sradhika.jagtap@arm.com the same name already exists or merge if the name exists and is a node 17312267Sradhika.jagtap@arm.com type. Can also take a list of subnodes, that each get appended.""" 17412267Sradhika.jagtap@arm.com if not hasattr(subnodes, '__iter__'): 17513731Sandreas.sandberg@arm.com subnodes = [subnodes] 17612267Sradhika.jagtap@arm.com 17712267Sradhika.jagtap@arm.com for subnode in subnodes: 17812267Sradhika.jagtap@arm.com try: 17912267Sradhika.jagtap@arm.com if not issubclass(type(subnode), pyfdt.FdtNop): 18012267Sradhika.jagtap@arm.com index = self.index(subnode.name) 18112267Sradhika.jagtap@arm.com item = self.pop(index) 18212267Sradhika.jagtap@arm.com else: 18312267Sradhika.jagtap@arm.com item = None 18412267Sradhika.jagtap@arm.com except ValueError: 18512267Sradhika.jagtap@arm.com item = None 18612267Sradhika.jagtap@arm.com 18712267Sradhika.jagtap@arm.com if isinstance(item, pyfdt.FdtNode) and \ 18812267Sradhika.jagtap@arm.com isinstance(subnode, pyfdt.FdtNode): 18912267Sradhika.jagtap@arm.com item.merge(subnode) 19012267Sradhika.jagtap@arm.com subnode = item 19112267Sradhika.jagtap@arm.com 19212267Sradhika.jagtap@arm.com super(FdtNode, self).append(subnode) 19312267Sradhika.jagtap@arm.com 19412267Sradhika.jagtap@arm.com def appendList(self, subnode_list): 19512267Sradhika.jagtap@arm.com """Append all properties/nodes in the iterable.""" 19612267Sradhika.jagtap@arm.com for subnode in subnode_list: 19712267Sradhika.jagtap@arm.com self.append(subnode) 19812267Sradhika.jagtap@arm.com 19912267Sradhika.jagtap@arm.com def appendCompatible(self, compatible): 20012267Sradhika.jagtap@arm.com """Append a compatible property with the supplied compatibility 20112267Sradhika.jagtap@arm.com strings.""" 20212267Sradhika.jagtap@arm.com if isinstance(compatible, str): 20312267Sradhika.jagtap@arm.com compatible = [compatible] 20412267Sradhika.jagtap@arm.com self.append(FdtPropertyStrings('compatible', compatible)) 20512267Sradhika.jagtap@arm.com 20612267Sradhika.jagtap@arm.com def appendPhandle(self, obj): 20712267Sradhika.jagtap@arm.com """Append a phandle property to this node with the phandle of the 20812267Sradhika.jagtap@arm.com supplied object.""" 20912267Sradhika.jagtap@arm.com # Create a bogus state because we only need the Phandle dictionary 21012267Sradhika.jagtap@arm.com state = FdtState(addr_cells=1, size_cells=1, cpu_cells=1) 21112267Sradhika.jagtap@arm.com 21212267Sradhika.jagtap@arm.com phandle = state.phandle(obj) 21312267Sradhika.jagtap@arm.com self.append(FdtPropertyWords("phandle", [phandle])) 21412267Sradhika.jagtap@arm.com 21512267Sradhika.jagtap@arm.comclass Fdt(pyfdt.Fdt): 21612267Sradhika.jagtap@arm.com def sortNodes(self, node): 21712267Sradhika.jagtap@arm.com """Move all properties to the beginning and subnodes to the end 21812267Sradhika.jagtap@arm.com while maintaining the order of the subnodes. DTB files require the 21912267Sradhika.jagtap@arm.com properties to go before the nodes, but the PyFdt doesn't account for 22012267Sradhika.jagtap@arm.com defining nodes and properties in a random order.""" 22112267Sradhika.jagtap@arm.com properties = FdtNode(node.name) 22212267Sradhika.jagtap@arm.com subnodes = FdtNode(node.name) 22312267Sradhika.jagtap@arm.com 22412267Sradhika.jagtap@arm.com while len(node): 22512267Sradhika.jagtap@arm.com subnode = node.pop(0) 22612267Sradhika.jagtap@arm.com if issubclass(type(subnode), pyfdt.FdtNode): 22712267Sradhika.jagtap@arm.com subnode = self.sortNodes(subnode) 22812267Sradhika.jagtap@arm.com subnodes.append(subnode) 22912267Sradhika.jagtap@arm.com else: 23012267Sradhika.jagtap@arm.com properties.append(subnode) 23112267Sradhika.jagtap@arm.com 23212267Sradhika.jagtap@arm.com properties.merge(subnodes) 23312267Sradhika.jagtap@arm.com 23412267Sradhika.jagtap@arm.com return properties 23512267Sradhika.jagtap@arm.com 23612267Sradhika.jagtap@arm.com def add_rootnode(self, rootnode, prenops=None, postnops=None): 23712267Sradhika.jagtap@arm.com """First sort the device tree, so that properties are before nodes.""" 23812267Sradhika.jagtap@arm.com rootnode = self.sortNodes(rootnode) 23912267Sradhika.jagtap@arm.com super(Fdt, self).add_rootnode(rootnode, prenops, postnops) 24012267Sradhika.jagtap@arm.com 24112267Sradhika.jagtap@arm.com def writeDtbFile(self, filename): 24212267Sradhika.jagtap@arm.com """Convert the device tree to DTB and write to a file.""" 24312267Sradhika.jagtap@arm.com filename = os.path.realpath(filename) 24412267Sradhika.jagtap@arm.com try: 24512267Sradhika.jagtap@arm.com with open(filename, 'wb') as f: 24612564Sgabeblack@google.com f.write(self.to_dtb()) 24712564Sgabeblack@google.com return filename 24812564Sgabeblack@google.com except IOError: 24912564Sgabeblack@google.com raise RuntimeError("Failed to open DTB output file") 25012564Sgabeblack@google.com 25112564Sgabeblack@google.com def writeDtsFile(self, filename): 25212564Sgabeblack@google.com """Convert the device tree to DTS and write to a file.""" 25312564Sgabeblack@google.com filename = os.path.realpath(filename) 25412564Sgabeblack@google.com try: 25512564Sgabeblack@google.com with open(filename, 'w') as f: 256 f.write(self.to_dts()) 257 return filename 258 except IOError: 259 raise RuntimeError("Failed to open DTS output file") 260