Acacia I2C, Serial and Timer + new Python tooling by omeh-a · Pull Request #751 · au-ts/sddf

omeh-a · 2026-07-08T00:56:21Z

This PR introduces Acacia to the sDDF and reworks all of our meta tooling around it.

Instead of storing our sDDF driver generation code in sdf_gen, we now store it locally in ./acacia_sddf/driver_class.py. Common logic is in ./acacia_sddf/sddf.py
tools/meta is removed and remaining Python like board.py is moved to ./acacia_sddf. This is to allow all of the Python in the sDDF to sit in one module that can be imported all in one blast. I moved acacia_sddf to the root of the repository to reflect its significance, as this code is in fact critical to assemble anything in the sDDF (as opposed to being a "two generic subdirectories deep tool")
board.py has been changed to get rid of some indirection, we now store compatible strings there for sanity.
All config.jsons are redundant and replaced with new functionality in driver_manifest.py. This file offers an API to let this same information be stored globally, and I intend for this to be used by each driver_class.py ... e.g. in i2c.py

# meson
add_driver_config(
    "meson",
    sDDFDriverConfig(
        compatible="amlogic,meson-axg-i2c",
        regions=[DTSRegion("regs", "rw", 4096, 0)],
        irqs=[DTSIRQ(0), DTSIRQ(1)],
    ),
)

# opentitan
add_driver_config(
    "opentitan",
    sDDFDriverConfig(
        compatible="eth,i2c",
        regions=[DTSRegion("regs", "rw", 4096, 0)],
        irqs=[DTSIRQ(4), DTSIRQ(0), DTSIRQ(1), DTSIRQ(7), DTSIRQ(9)],
    ),
)

... i.e. we store the old config.json in i2c.py.

There's not too much to see otherwise besides the new Acacia subsystem generation in i2c.py, serial.py and timer.py. Please let me know what you think about these.

I am leaving this PR as a draft until we have merged Acacia, just in case API changes occur.

I've implemented these three classes as an exemplar for Acacia usage in advance of porting the other classes by others. These three are also mutually dependent and it isn't possible to do i2c without the other two.

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au> Timer tests out with acacia Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au> Serial tests out with Acacia Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au> Refactor: acacia_sddf is now a python module that inherits all subfiles, sDDF itself is a python module for import! Needed for SDK Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au> Fix issues with i2c.py - maps were swapped. Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au> Further fixes to keep up with Acacia PR request changes Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

wom-bat · 2026-07-08T05:12:39Z

+    blk: Optional[DriverDouble] = DriverDouble(None, None)
+    partition: int = 0
+    baud_rate: Optional[int] = None
+


How does this work when you have multiple ethernet devices (of the same or different kinds) in the same board? I think these should be lists of DriverDouble

wom-bat · 2026-07-08T05:14:00Z

+
+# Keep this list in alphabetical order by board name
+# TODO: convert to Dictionary
+BOARDS: List[Board] = [


I personally would prefer splitting these out one per supported board, then just importing the one you want.

(I know the old sdfgen tooling did it this way)

wom-bat · 2026-07-08T05:14:24Z

+        paddr_top=0xEC000000,
+        serial=DriverDouble("snps,dw-apb-uart", "serial@fe660000"),
+        timer=DriverDouble("rockchip,rk3568-timer", "rktimer@fe5f0000"),
+        ethernet=DriverDouble("", "ethernet@fe2a0000"),


This one has two ethernet ports

wom-bat · 2026-07-08T05:14:42Z

+        arch=aarch64,
+        paddr_top=0x80000000,
+        timer=DriverDouble("cdns,ttc", "axi/timer@ff140000"),
+        serial=DriverDouble("xlnx,zynqmp-uart", "axi/serial@ff000000"),


wom-bat · 2026-07-08T05:16:16Z

+from .sddf import sDDFDriverClass, DeviceResourcesFactory, RegionResourceFactory
+from collections import defaultdict
+from typing import List, Dict, Type, Union, Optional
+


rearrange imports to put standard ones first

wom-bat · 2026-07-08T05:18:23Z

+                    raise RuntimeError(
+                        f"Multiple MRs with paddr={d_paddr}! -> {existing_mr}"
+                    )
+                else:


No need of else after a raise

wom-bat · 2026-07-08T05:20:00Z

+
+
+# pulp
+add_driver_config(


I reckon these should be in per-driver files imported rather than enumerated here. So that the tooling can be used with third-party drivers without changing this file.

wom-bat · 2026-07-08T05:21:16Z


 SUPPORTED_BOARDS := \
 		odroidc4 \
+		maaxboard \


separate change, different PR

wom-bat · 2026-07-08T05:35:56Z

    board = next(filter(lambda b: b.name == args.board, BOARDS))
+    if board.arch != x86_64:
+        dtb = DeviceTreeBlob(args.dtb)
+    else:


An alternative would be to fudge up a DTS for the X86 systems we use. Linux X86 can use a DTB as an additional source of information (mainly to get the PCI and IOAPIC info)

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

omeh-a added 3 commits July 3, 2026 09:20

Updated ina219 and bus scan i2c examples to use acacia

a55c47c

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

Lint Python with Acacia additions

013449b

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

omeh-a added drivers Issues pertaining to driver code for a device class driver-examples Issues related to examples for drivers for a target serial timer i2c labels Jul 8, 2026

wom-bat requested changes Jul 8, 2026

View reviewed changes

Update signatures to put SDF first for Acacia

6d06dfb

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

omeh-a force-pushed the sdfgenpy branch from 370e7a7 to 6d06dfb Compare July 12, 2026 23:39

omeh-a added 2 commits July 13, 2026 10:09

Extract per-board / x86 metaprogram hacks to class.py

de0f706

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

Add I2CAddress type and I2C address decoding for I2C class

55b8d7b

Signed-off-by: Lesley Rossouw <lesley.rossouw@unsw.edu.au>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Acacia I2C, Serial and Timer + new Python tooling#751

Acacia I2C, Serial and Timer + new Python tooling#751
omeh-a wants to merge 6 commits into
mainfrom
sdfgenpy

omeh-a commented Jul 8, 2026 •

edited

Loading

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

wom-bat Jul 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

omeh-a commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

omeh-a commented Jul 8, 2026 •

edited

Loading