tools/: move JSON register definition files

so as to load those files directly from the module location:

- move *_regs.json files to proxyclient/m1n1 module's folder
- load definition files using Python's resource loader

This has the benefit of avoiding path traversal and is a prerequisite
to the packaging of proxyclient as a PyPi package.

Signed-off-by: Alexis Deruelle <alexis.deruelle@gmail.com>

Author: alxdrl

tools/apple_regs.json proxyclient/m1n1/apple_regs.jsontools/apple_regs.json renamed to proxyclient/m1n1/apple_regs.json

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: MIT
-import json, os, re
+import json, re
+import importlib.resources as resources
 from enum import Enum, IntEnum, IntFlag
 from .utils import Register, Register64, Register32
 
@@ -11,7 +12,8 @@ def _load_registers():
     sysreg_fwd = {}
     sysop_fwd = {}
     for fname in ["arm_regs.json", "apple_regs.json"]:
-        data = json.load(open(os.path.join(os.path.dirname(__file__), "..", "..", "tools", fname)))
+        data = json.loads(resources.read_text(__package__, fname, encoding="utf-8"))
+
         for reg in data:
             if "accessors" in reg:
                 for acc in reg["accessors"]:

tools/arm_regs.json proxyclient/m1n1/arm_regs.jsontools/arm_regs.json renamed to proxyclient/m1n1/arm_regs.json

@@ -0,0 +1,20 @@
+# Register definition tools
+
+This folder contains various scripts that handle ARM and Apple register
+symbolic definition used by `proxyclient` (see `proxyclient/m1n1/sysreg.py`).
+
+## Script description
+
+- `gen_reg_class.py` generates Python class from JSON register definition file
+- `gen_reg_include.py` generates C include definition (see src/\*\_regs.h)
+- `reg2json.py` generates JSON definition files from XML input
+- `reg_filter.py` loads JSON register definition file and translates system
+  register encoding to symbolic names
+
+## Note on file location
+
+There's two register definition files, `apple_regs.json` and `arm_regs.json`,
+that were initially stored alongside these scripts.
+
+Register now resides in the `proxyclient/m1n1` folder, so that `proxyclient`
+can load them while avoiding path traversal, using Python's resource loader.