src/broadcom/cle/gen_pack_header.py

   1 #encoding=utf-8
   2
   3 # Copyright (C) 2016 Intel Corporation
   4 # Copyright (C) 2016 Broadcom
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a
   7 # copy of this software and associated documentation files (the "Software"),
   8 # to deal in the Software without restriction, including without limitation
   9 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10 # and/or sell copies of the Software, and to permit persons to whom the
  11 # Software is furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice (including the next
  14 # paragraph) shall be included in all copies or substantial portions of the
  15 # Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  23 # IN THE SOFTWARE.
  24
  25 from __future__ import (
  26     absolute_import, division, print_function, unicode_literals
  27 )
  28 import xml.parsers.expat
  29 import re
  30 import sys
  31 import copy
  32
  33 license =  """/* Generated code, see packets.xml and gen_packet_header.py */
  34 """
  35
  36 pack_header = """%(license)s
  37
  38 /* Packets, enums and structures for %(platform)s.
  39  *
  40  * This file has been generated, do not hand edit.
  41  */
  42
  43 #ifndef %(guard)s
  44 #define %(guard)s
  45
  46 #include "cle/v3d_packet_helpers.h"
  47
  48 """
  49
  50 def to_alphanum(name):
  51     substitutions = {
  52         ' ': '_',
  53         '/': '_',
  54         '[': '',
  55         ']': '',
  56         '(': '',
  57         ')': '',
  58         '-': '_',
  59         ':': '',
  60         '.': '',
  61         ',': '',
  62         '=': '',
  63         '>': '',
  64         '#': '',
  65         'α': 'alpha',
  66         '&': '',
  67         '*': '',
  68         '"': '',
  69         '+': '',
  70         '\'': '',
  71     }
  72
  73     for i, j in substitutions.items():
  74         name = name.replace(i, j)
  75
  76     return name
  77
  78 def safe_name(name):
  79     name = to_alphanum(name)
  80     if not name[0].isalpha():
  81         name = '_' + name
  82
  83     return name
  84
  85 def prefixed_upper_name(prefix, name):
  86     if prefix:
  87         name = prefix + "_" + name
  88     return safe_name(name).upper()
  89
  90 def num_from_str(num_str):
  91     if num_str.lower().startswith('0x'):
  92         return int(num_str, base=16)
  93     else:
  94         assert(not num_str.startswith('0') and 'octals numbers not allowed')
  95         return int(num_str)
  96
  97 class Field(object):
  98     ufixed_pattern = re.compile(r"u(\d+)\.(\d+)")
  99     sfixed_pattern = re.compile(r"s(\d+)\.(\d+)")
 100
 101     def __init__(self, parser, attrs):
 102         self.parser = parser
 103         if "name" in attrs:
 104             self.name = safe_name(attrs["name"]).lower()
 105
 106         if str(attrs["start"]).endswith("b"):
 107             self.start = int(attrs["start"][:-1]) * 8
 108         else:
 109             self.start = int(attrs["start"])
 110         # packet <field> entries in XML start from the bit after the
 111         # opcode, so shift everything up by 8 since we'll also have a
 112         # Field for the opcode.
 113         if not parser.struct:
 114             self.start += 8
 115
 116         self.end = self.start + int(attrs["size"]) - 1
 117         self.type = attrs["type"]
 118
 119         if self.type == 'bool' and self.start != self.end:
 120             print("#error Field {} has bool type but more than one bit of size".format(self.name));
 121
 122         if "prefix" in attrs:
 123             self.prefix = safe_name(attrs["prefix"]).upper()
 124         else:
 125             self.prefix = None
 126
 127         if "default" in attrs:
 128             self.default = int(attrs["default"])
 129         else:
 130             self.default = None
 131
 132         if "minus_one" in attrs:
 133             assert(attrs["minus_one"] == "true")
 134             self.minus_one = True
 135         else:
 136             self.minus_one = False
 137
 138         ufixed_match = Field.ufixed_pattern.match(self.type)
 139         if ufixed_match:
 140             self.type = 'ufixed'
 141             self.fractional_size = int(ufixed_match.group(2))
 142
 143         sfixed_match = Field.sfixed_pattern.match(self.type)
 144         if sfixed_match:
 145             self.type = 'sfixed'
 146             self.fractional_size = int(sfixed_match.group(2))
 147
 148     def emit_template_struct(self, dim):
 149         if self.type == 'address':
 150             type = '__gen_address_type'
 151         elif self.type == 'bool':
 152             type = 'bool'
 153         elif self.type == 'float':
 154             type = 'float'
 155         elif self.type == 'ufixed':
 156             type = 'float'
 157         elif self.type == 'sfixed':
 158             type = 'float'
 159         elif self.type == 'uint' and self.end - self.start > 32:
 160             type = 'uint64_t'
 161         elif self.type == 'offset':
 162             type = 'uint64_t'
 163         elif self.type == 'int':
 164             type = 'int32_t'
 165         elif self.type == 'uint':
 166             type = 'uint32_t'
 167         elif self.type in self.parser.structs:
 168             type = 'struct ' + self.parser.gen_prefix(safe_name(self.type))
 169         elif self.type in self.parser.enums:
 170             type = 'enum ' + self.parser.gen_prefix(safe_name(self.type))
 171         elif self.type == 'mbo':
 172             return
 173         else:
 174             print("#error unhandled type: %s" % self.type)
 175             type = "uint32_t"
 176
 177         print("   %-36s %s%s;" % (type, self.name, dim))
 178
 179         for value in self.values:
 180             name = prefixed_upper_name(self.prefix, value.name)
 181             print("#define %-40s %d" % (name, value.value))
 182
 183     def overlaps(self, field):
 184         return self != field and max(self.start, field.start) <= min(self.end, field.end)
 185
 186
 187 class Group(object):
 188     def __init__(self, parser, parent, start, count):
 189         self.parser = parser
 190         self.parent = parent
 191         self.start = start
 192         self.count = count
 193         self.size = 0
 194         self.fields = []
 195         self.min_ver = 0
 196         self.max_ver = 0
 197
 198     def emit_template_struct(self, dim):
 199         if self.count == 0:
 200             print("   /* variable length fields follow */")
 201         else:
 202             if self.count > 1:
 203                 dim = "%s[%d]" % (dim, self.count)
 204
 205             for field in self.fields:
 206                 field.emit_template_struct(dim)
 207
 208     class Byte:
 209         def __init__(self):
 210             self.size = 8
 211             self.fields = []
 212             self.address = None
 213
 214     def collect_bytes(self, bytes):
 215         for field in self.fields:
 216             first_byte = field.start // 8
 217             last_byte = field.end // 8
 218
 219             for b in range(first_byte, last_byte + 1):
 220                 if not b in bytes:
 221                     bytes[b] = self.Byte()
 222
 223                 bytes[b].fields.append(field)
 224
 225                 if field.type == "address":
 226                     # assert bytes[index].address == None
 227                     bytes[b].address = field
 228
 229     def emit_pack_function(self, start):
 230         # Determine number of bytes in this group.
 231         self.length = max(field.end // 8 for field in self.fields) + 1
 232
 233         bytes = {}
 234         self.collect_bytes(bytes)
 235
 236         relocs_emitted = set()
 237         memcpy_fields = set()
 238
 239         for field in self.fields:
 240             if field.minus_one:
 241                 print("   assert(values->%s >= 1);" % field.name)
 242
 243         for index in range(self.length):
 244             # Handle MBZ bytes
 245             if not index in bytes:
 246                 print("   cl[%2d] = 0;" % index)
 247                 continue
 248             byte = bytes[index]
 249
 250             # Call out to the driver to note our relocations.  Inside of the
 251             # packet we only store offsets within the BOs, and we store the
 252             # handle to the packet outside.  Unlike Intel genxml, we don't
 253             # need to have the other bits that will be stored together with
 254             # the address during the reloc process, so there's no need for the
 255             # complicated combine_address() function.
 256             if byte.address and byte.address not in relocs_emitted:
 257                 print("   __gen_emit_reloc(data, &values->%s);" % byte.address.name)
 258                 relocs_emitted.add(byte.address)
 259
 260             # Special case: floats can't have any other fields packed into
 261             # them (since they'd change the meaning of the float), and the
 262             # per-byte bitshifting math below bloats the pack code for floats,
 263             # so just copy them directly here.  Also handle 16/32-bit
 264             # uints/ints with no merged fields.
 265             if len(byte.fields) == 1:
 266                 field = byte.fields[0]
 267                 if field.type in ["float", "uint", "int"] and field.start % 8 == 0 and field.end - field.start == 31 and not field.minus_one:
 268                     if field in memcpy_fields:
 269                         continue
 270
 271                     if not any(field.overlaps(scan_field) for scan_field in self.fields):
 272                         assert(field.start == index * 8)
 273                         print("")
 274                         print("   memcpy(&cl[%d], &values->%s, sizeof(values->%s));" %
 275                                 (index, field.name, field.name))
 276                         memcpy_fields.add(field)
 277                         continue
 278
 279             byte_start = index * 8
 280
 281             v = None
 282             prefix = "   cl[%2d] =" % index
 283
 284             field_index = 0
 285             for field in byte.fields:
 286                 if field.type != "mbo":
 287                     name = field.name
 288
 289                 start = field.start
 290                 end = field.end
 291                 field_byte_start = (field.start // 8) * 8
 292                 start -= field_byte_start
 293                 end -= field_byte_start
 294                 extra_shift = 0
 295
 296                 value = "values->%s" % name
 297                 if field.minus_one:
 298                     value = "%s - 1" % value
 299
 300                 if field.type == "mbo":
 301                     s = "__gen_mbo(%d, %d)" % \
 302                         (start, end)
 303                 elif field.type == "address":
 304                     extra_shift = (31 - (end - start)) // 8 * 8
 305                     s = "__gen_address_offset(&values->%s)" % byte.address.name
 306                 elif field.type == "uint":
 307                     s = "__gen_uint(%s, %d, %d)" % \
 308                         (value, start, end)
 309                 elif field.type in self.parser.enums:
 310                     s = "__gen_uint(%s, %d, %d)" % \
 311                         (value, start, end)
 312                 elif field.type == "int":
 313                     s = "__gen_sint(%s, %d, %d)" % \
 314                         (value, start, end)
 315                 elif field.type == "bool":
 316                     s = "__gen_uint(%s, %d, %d)" % \
 317                         (value, start, end)
 318                 elif field.type == "float":
 319                     s = "#error %s float value mixed in with other fields" % name
 320                 elif field.type == "offset":
 321                     s = "__gen_offset(%s, %d, %d)" % \
 322                         (value, start, end)
 323                 elif field.type == 'ufixed':
 324                     s = "__gen_ufixed(%s, %d, %d, %d)" % \
 325                         (value, start, end, field.fractional_size)
 326                 elif field.type == 'sfixed':
 327                     s = "__gen_sfixed(%s, %d, %d, %d)" % \
 328                         (value, start, end, field.fractional_size)
 329                 elif field.type in self.parser.structs:
 330                     s = "__gen_uint(v%d_%d, %d, %d)" % \
 331                         (index, field_index, start, end)
 332                     field_index = field_index + 1
 333                 else:
 334                     print("/* unhandled field %s, type %s */\n" % (name, field.type))
 335                     s = None
 336
 337                 if not s == None:
 338                     shift = byte_start - field_byte_start + extra_shift
 339                     if shift:
 340                         s = "%s >> %d" % (s, shift)
 341
 342                     if field == byte.fields[-1]:
 343                         print("%s %s;" % (prefix, s))
 344                     else:
 345                         print("%s %s |" % (prefix, s))
 346                     prefix = "           "
 347
 348             print("")
 349             continue
 350
 351     def emit_unpack_function(self, start):
 352         for field in self.fields:
 353             if field.type != "mbo":
 354                 convert = None
 355
 356                 args = []
 357                 args.append('cl')
 358                 args.append(str(start + field.start))
 359                 args.append(str(start + field.end))
 360
 361                 if field.type == "address":
 362                     convert = "__gen_unpack_address"
 363                 elif field.type == "uint":
 364                     convert = "__gen_unpack_uint"
 365                 elif field.type in self.parser.enums:
 366                     convert = "__gen_unpack_uint"
 367                 elif field.type == "int":
 368                     convert = "__gen_unpack_sint"
 369                 elif field.type == "bool":
 370                     convert = "__gen_unpack_uint"
 371                 elif field.type == "float":
 372                     convert = "__gen_unpack_float"
 373                 elif field.type == "offset":
 374                     convert = "__gen_unpack_offset"
 375                 elif field.type == 'ufixed':
 376                     args.append(str(field.fractional_size))
 377                     convert = "__gen_unpack_ufixed"
 378                 elif field.type == 'sfixed':
 379                     args.append(str(field.fractional_size))
 380                     convert = "__gen_unpack_sfixed"
 381                 else:
 382                     print("/* unhandled field %s, type %s */\n" % (field.name, field.type))
 383                     s = None
 384
 385                 plusone = ""
 386                 if field.minus_one:
 387                     plusone = " + 1"
 388                 print("   values->%s = %s(%s)%s;" % \
 389                       (field.name, convert, ', '.join(args), plusone))
 390
 391 class Value(object):
 392     def __init__(self, attrs):
 393         self.name = attrs["name"]
 394         self.value = int(attrs["value"])
 395
 396 class Parser(object):
 397     def __init__(self, ver):
 398         self.parser = xml.parsers.expat.ParserCreate()
 399         self.parser.StartElementHandler = self.start_element
 400         self.parser.EndElementHandler = self.end_element
 401
 402         self.packet = None
 403         self.struct = None
 404         self.structs = {}
 405         # Set of enum names we've seen.
 406         self.enums = set()
 407         self.registers = {}
 408         self.ver = ver
 409
 410     def gen_prefix(self, name):
 411         if name[0] == "_":
 412             return 'V3D%s%s' % (self.ver, name)
 413         else:
 414             return 'V3D%s_%s' % (self.ver, name)
 415
 416     def gen_guard(self):
 417         return self.gen_prefix("PACK_H")
 418
 419     def attrs_version_valid(self, attrs):
 420         if "min_ver" in attrs and self.ver < attrs["min_ver"]:
 421             return False
 422
 423         if "max_ver" in attrs and self.ver > attrs["max_ver"]:
 424             return False
 425
 426         return True
 427
 428     def group_enabled(self):
 429         if self.group.min_ver != 0 and self.ver < self.group.min_ver:
 430             return False
 431
 432         if self.group.max_ver != 0 and self.ver > self.group.max_ver:
 433             return False
 434
 435         return True
 436
 437     def start_element(self, name, attrs):
 438         if name == "vcxml":
 439             self.platform = "V3D {}.{}".format(self.ver[0], self.ver[1])
 440             print(pack_header % {'license': license, 'platform': self.platform, 'guard': self.gen_guard()})
 441         elif name in ("packet", "struct", "register"):
 442             default_field = None
 443
 444             object_name = self.gen_prefix(safe_name(attrs["name"].upper()))
 445             if name == "packet":
 446                 self.packet = object_name
 447
 448                 # Add a fixed Field for the opcode.  We only make <field>s in
 449                 # the XML for the fields listed in the spec, and all of those
 450                 # start from bit 0 after of the opcode.
 451                 default_field = {
 452                     "name" : "opcode",
 453                     "default" : attrs["code"],
 454                     "type" : "uint",
 455                     "start" : -8,
 456                     "size" : 8,
 457                 }
 458             elif name == "struct":
 459                 self.struct = object_name
 460                 self.structs[attrs["name"]] = 1
 461             elif name == "register":
 462                 self.register = object_name
 463                 self.reg_num = num_from_str(attrs["num"])
 464                 self.registers[attrs["name"]] = 1
 465
 466             self.group = Group(self, None, 0, 1)
 467             if default_field:
 468                 field = Field(self, default_field)
 469                 field.values = []
 470                 self.group.fields.append(field)
 471
 472             if "min_ver" in attrs:
 473                 self.group.min_ver = attrs["min_ver"]
 474             if "max_ver" in attrs:
 475                 self.group.max_ver = attrs["max_ver"]
 476
 477         elif name == "field":
 478             self.group.fields.append(Field(self, attrs))
 479             self.values = []
 480         elif name == "enum":
 481             self.values = []
 482             self.enum = safe_name(attrs["name"])
 483             self.enums.add(attrs["name"])
 484             self.enum_enabled = self.attrs_version_valid(attrs)
 485             if "prefix" in attrs:
 486                 self.prefix = attrs["prefix"]
 487             else:
 488                 self.prefix= None
 489         elif name == "value":
 490             if self.attrs_version_valid(attrs):
 491                 self.values.append(Value(attrs))
 492
 493     def end_element(self, name):
 494         if name  == "packet":
 495             self.emit_packet()
 496             self.packet = None
 497             self.group = None
 498         elif name == "struct":
 499             self.emit_struct()
 500             self.struct = None
 501             self.group = None
 502         elif name == "register":
 503             self.emit_register()
 504             self.register = None
 505             self.reg_num = None
 506             self.group = None
 507         elif name  == "field":
 508             self.group.fields[-1].values = self.values
 509         elif name  == "enum":
 510             if self.enum_enabled:
 511                 self.emit_enum()
 512             self.enum = None
 513         elif name == "vcxml":
 514             print('#endif /* %s */' % self.gen_guard())
 515
 516     def emit_template_struct(self, name, group):
 517         print("struct %s {" % name)
 518         group.emit_template_struct("")
 519         print("};\n")
 520
 521     def emit_pack_function(self, name, group):
 522         print("static inline void\n%s_pack(__gen_user_data *data, uint8_t * restrict cl,\n%sconst struct %s * restrict values)\n{" %
 523               (name, ' ' * (len(name) + 6), name))
 524
 525         group.emit_pack_function(0)
 526
 527         print("}\n")
 528
 529         print('#define %-33s %6d' %
 530               (name + "_length", self.group.length))
 531
 532     def emit_unpack_function(self, name, group):
 533         print("#ifdef __gen_unpack_address")
 534         print("static inline void")
 535         print("%s_unpack(const uint8_t * restrict cl,\n%sstruct %s * restrict values)\n{" %
 536               (name, ' ' * (len(name) + 8), name))
 537
 538         group.emit_unpack_function(0)
 539
 540         print("}\n#endif\n")
 541
 542     def emit_header(self, name):
 543         default_fields = []
 544         for field in self.group.fields:
 545             if not type(field) is Field:
 546                 continue
 547             if field.default == None:
 548                 continue
 549             default_fields.append("   .%-35s = %6d" % (field.name, field.default))
 550
 551         print('#define %-40s\\' % (name + '_header'))
 552         print(",  \\\n".join(default_fields))
 553         print('')
 554
 555     def emit_packet(self):
 556         if not self.group_enabled():
 557             return
 558
 559         name = self.packet
 560
 561         assert(self.group.fields[0].name == "opcode")
 562         print('#define %-33s %6d' %
 563               (name + "_opcode", self.group.fields[0].default))
 564
 565         self.emit_header(name)
 566         self.emit_template_struct(self.packet, self.group)
 567         self.emit_pack_function(self.packet, self.group)
 568         self.emit_unpack_function(self.packet, self.group)
 569
 570         print('')
 571
 572     def emit_register(self):
 573         if not self.group_enabled():
 574             return
 575
 576         name = self.register
 577         if not self.reg_num == None:
 578             print('#define %-33s 0x%04x' %
 579                   (self.gen_prefix(name + "_num"), self.reg_num))
 580
 581         self.emit_template_struct(self.register, self.group)
 582         self.emit_pack_function(self.register, self.group)
 583         self.emit_unpack_function(self.register, self.group)
 584
 585     def emit_struct(self):
 586         if not self.group_enabled():
 587             return
 588
 589         name = self.struct
 590
 591         self.emit_header(name)
 592         self.emit_template_struct(self.struct, self.group)
 593         self.emit_pack_function(self.struct, self.group)
 594         self.emit_unpack_function(self.struct, self.group)
 595
 596         print('')
 597
 598     def emit_enum(self):
 599         print('enum %s {' % self.gen_prefix(self.enum))
 600         for value in self.values:
 601             name = value.name
 602             if self.prefix:
 603                 name = self.prefix + "_" + name
 604             name = safe_name(name).upper()
 605             print('        % -36s = %6d,' % (name, value.value))
 606         print('};\n')
 607
 608     def parse(self, filename):
 609         file = open(filename, "rb")
 610         self.parser.ParseFile(file)
 611         file.close()
 612
 613 if len(sys.argv) < 2:
 614     print("No input xml file specified")
 615     sys.exit(1)
 616
 617 input_file = sys.argv[1]
 618
 619 p = Parser(sys.argv[2])
 620 p.parse(input_file)