Initial plugin manager release

- Format code
- Add settings to control comments and bitfield structuring

README.md

@@ -0,0 +1,24 @@
+# SVD Mapper (svdmap)
+
+Support loading SVD files into Binary Ninja.
+
+## Usage
+
+1. Open binary in Binary Ninja
+2. Run `Import SVD info` command.
+3. Select SVD file (i.e. `TC37XPD.svd`).
+4. New segments should now be automatically created for each peripheral along with the structure.
+
+## Configuration
+
+### Enable Bitfield Structuring
+As Binary Ninja does not support bitfields, all bitfields will become unions, most will find this undesired so by default
+this will be disabled. 
+
+To _enable_ bitfield structuring set `SVDMapper.enableBitfieldStructuring` to **true**.
+
+### Disable Comments
+
+Comments can be displayed poorly in some instances so if that is the case you can turn comments off.
+
+To _disable_ comments set `SVDMapper.enableComments` to **false**.

__init__.py

@@ -1,9 +1,8 @@
+import binaryninja
 import math
-
 import svd2py
-import binaryninja
 from binaryninja import BinaryView, Type, StructureBuilder, Symbol, SymbolType, SegmentFlag, SectionSemantics, \
-    StructureType, StructureVariant, StructureMember
+    StructureType, StructureVariant, StructureMember, Settings
 
 BYTE_SIZE = 8
 
@@ -18,6 +17,10 @@ def import_svd(bv: BinaryView):
     device_name: str = device['name']
     binaryninja.log_info(f'parsing device... {device_name}')
     peripherals = device['peripherals']['peripheral']
+
+    show_comments = Settings().get_bool("SVDMapper.enableComments")
+    structure_bitfields = Settings().get_bool("SVDMapper.enableBitfieldStructuring")
+
     for peripheral in peripherals:
         per_name: str = peripheral['name']
         per_desc: str = peripheral['description']
@@ -60,41 +63,61 @@ def import_svd(bv: BinaryView):
                     field_bounds: tuple[int, int] = (int(field_lsb_b), int(field_msb_b))
                     reg_struct.insert(field_bounds[0], Type.int((field_bounds[1] + 1) - field_bounds[0], False),
                                       field_name)
-                else:
+                elif structure_bitfields:
+                    # Only structure bitfields if setting is enabled.
                     # TODO: This bugs out for n fields there will be n bytes padding at the front of the union
                     field_bounds: tuple[int, int] = (math.floor(field_lsb_b), math.ceil(field_msb_b))
                     field_addr = reg_addr + field_bounds[0]
-                    bv.set_comment_at(field_addr, f'{field_name} {field_msb}:{field_lsb}')
+                    if show_comments:
+                        bv.set_comment_at(field_addr, f'{field_name} {field_msb}:{field_lsb}')
                     # The bitfield will be use the field bounds as we cannot address bits as size
                     bitfield_ty = Type.int((field_bounds[1] + 1) - field_bounds[0], False)
                     bitfield_member = StructureMember(bitfield_ty, field_name, field_bounds[0])
                     # Create or update the bitfield union with new bitfield
                     existing_bitfield = reg_struct.member_at_offset(field_bounds[0])
                     if existing_bitfield is None:
                         reg_struct.insert(field_bounds[0], Type.union([bitfield_member]), overwrite_existing=False)
-                    elif isinstance(existing_bitfield.type, StructureType) and existing_bitfield.type.type is StructureVariant.UnionStructureType:
+                    elif isinstance(existing_bitfield.type,
+                                    StructureType) and existing_bitfield.type.type is StructureVariant.UnionStructureType:
                         bitfield_members = existing_bitfield.type.members
                         bitfield_members.append(bitfield_member)
                         reg_struct.insert(existing_bitfield.offset, Type.union(bitfield_members))
 
             # TODO: This is displayed really poorly
             # Add the register description as a comment
-            bv.set_comment_at(reg_addr, reg_desc.splitlines()[0])
+            if show_comments:
+                bv.set_comment_at(reg_addr, reg_desc.splitlines()[0])
             # Define the register type in the binary view.
             reg_struct_ty = Type.structure_type(reg_struct)
             bv.define_user_type(f'{per_name}_{reg_name}', reg_struct_ty)
             # Add the register to the peripheral type
-            per_struct.insert(reg_addr_offset, bv.get_type_by_name(f'{per_name}_{reg_name}'), reg_name, overwrite_existing=False)
+            per_struct.insert(reg_addr_offset, bv.get_type_by_name(f'{per_name}_{reg_name}'), reg_name,
+                              overwrite_existing=False)
 
         # Add the peripheral description as a comment
-        bv.set_comment_at(per_base_addr, per_desc)
+        if show_comments:
+            bv.set_comment_at(per_base_addr, per_desc)
         # Define the peripheral type and data var in the binary view.
         per_struct_ty = Type.structure_type(per_struct)
         bv.define_user_type(per_name, per_struct_ty)
         bv.define_user_symbol(Symbol(SymbolType.ImportedDataSymbol, per_base_addr, per_name))
         bv.define_user_data_var(per_base_addr, bv.get_type_by_name(per_name), per_name)
 
 
+settings = Settings()
+
+bf_title = "Enable Bitfield Structuring"
+bf_description = "Bitfields will be structured as unions"
+bf_properties = f'{{"title" : "{bf_title}", "description" : "{bf_description}", "type" : "boolean", "default" : false}}'
+
+comment_title = "Enable Comment Creation"
+comment_description = "Create comments from the SVD field descriptions"
+comment_properties = f'{{"title" : "{comment_title}", "description" : "{comment_description}", "type" : "boolean", "default" : true}}'
+
+settings.register_group("SVDMapper", "SVD Mapper")
+settings.register_setting("SVDMapper.enableBitfieldStructuring", bf_properties)
+settings.register_setting("SVDMapper.enableComments", comment_properties)
+
 binaryninja.PluginCommand.register(
     "Import SVD Info",
     "Maps SVD peripherals into the binary view as new segments",

plugin.json

@@ -0,0 +1,23 @@
+{
+  "pluginmetadataversion": 3,
+  "name": "SVD Mapper",
+  "type": [
+    "helper"
+  ],
+  "api": [
+    "python3"
+  ],
+  "description": "SVD Mapper is a plugin for Binary Ninja that helps automate the process of mapping in SVD peripherals",
+  "license": {
+    "name": "Apache-2.0",
+    "text": "Copyright 2020-2024 Vector 35 Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License."
+  },
+  "platforms": [
+    "Darwin",
+    "Linux",
+    "Windows"
+  ],
+  "version": "0.1.1",
+  "author": "Vector 35 Inc",
+  "minimumbinaryninjaversion": 4860
+}