sddf: cleanup begin string sort of things

Signed-off-by: Ivan-Velickovic <i.velickovic@unsw.edu.au>

Author: Ivan-Velickovic

src/c/c.zig

@@ -457,11 +457,18 @@ export fn sdfgen_sddf_timer_serialise_config(system: *align(8) anyopaque, output
     return true;
 }
 
-export fn sdfgen_sddf_serial(c_sdf: *align(8) anyopaque, c_device: ?*align(8) anyopaque, driver: *align(8) anyopaque, virt_tx: *align(8) anyopaque, virt_rx: ?*align(8) anyopaque, enable_color: bool) ?*anyopaque {
+export fn sdfgen_sddf_serial(c_sdf: *align(8) anyopaque, c_device: ?*align(8) anyopaque, driver: *align(8) anyopaque, virt_tx: *align(8) anyopaque, virt_rx: ?*align(8) anyopaque, enable_color: bool, begin_str: [*c]u8) ?*anyopaque {
     const sdf: *SystemDescription = @ptrCast(c_sdf);
     const device: *dtb.Node = @ptrCast(c_device);
+    var options: sddf.Serial.Options = .{
+        .virt_rx = @ptrCast(virt_rx),
+        .enable_color = enable_color,
+    };
+    if (begin_str != null) {
+        options.begin_str = std.mem.span(begin_str);
+    }
     const serial = allocator.create(sddf.Serial) catch @panic("OOM");
-    serial.* = sddf.Serial.init(allocator, sdf, device, @ptrCast(driver), @ptrCast(virt_tx), .{ .virt_rx = @ptrCast(virt_rx), .enable_color = enable_color }) catch |e| {
+    serial.* = sddf.Serial.init(allocator, sdf, device, @ptrCast(driver), @ptrCast(virt_tx), options) catch |e| {
         log.err("failed to initialiase serial system for device '{s}': {any}", .{ device.name, e });
         allocator.destroy(serial);
         return null;
@@ -483,7 +490,7 @@ export fn sdfgen_sddf_serial_add_client(system: *align(8) anyopaque, client: *al
             sddf.Serial.Error.DuplicateClient => return 1,
             sddf.Serial.Error.InvalidClient => return 2,
             // Should never happen when adding a client
-            sddf.Serial.Error.InvalidVirt, sddf.Serial.Error.NotConnected => @panic("internal error"),
+            sddf.Serial.Error.InvalidBeginString, sddf.Serial.Error.InvalidVirt, sddf.Serial.Error.NotConnected => @panic("internal error"),
         }
     };
 

src/data.zig

@@ -171,7 +171,6 @@ pub const Resources = struct {
             clients: [MAX_NUM_CLIENTS]VirtTxClient,
             num_clients: u8,
             begin_str: [MAX_BEGIN_STR_LEN]u8,
-            begin_str_len: u8,
             enable_colour: u8,
             enable_rx: u8,
         };

src/python/module.py

@@ -169,7 +169,7 @@ class SddfStatus(IntEnum):
 libsdfgen.sdfgen_sddf_blk_serialise_config.argtypes = [c_void_p, c_char_p]
 
 libsdfgen.sdfgen_sddf_serial.restype = c_void_p
-libsdfgen.sdfgen_sddf_serial.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_bool]
+libsdfgen.sdfgen_sddf_serial.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_bool, c_char_p]
 libsdfgen.sdfgen_sddf_serial_destroy.restype = None
 libsdfgen.sdfgen_sddf_serial_destroy.argtypes = [c_void_p]
 
@@ -719,7 +719,8 @@ def __init__(
             virt_tx: SystemDescription.ProtectionDomain,
             *,
             virt_rx: Optional[SystemDescription.ProtectionDomain] = None,
-            enable_color: bool = True
+            enable_color: bool = True,
+            begin_str: Optional[str] = None,
         ) -> None:
             if device is None:
                 device_obj = None
@@ -731,8 +732,12 @@ def __init__(
             else:
                 virt_rx_obj = virt_rx._obj
 
+            if begin_str:
+                c_begin_str = c_char_p(begin_str.encode("utf-8"))
+            else:
+                c_begin_str = None
             self._obj = libsdfgen.sdfgen_sddf_serial(
-                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx_obj, c_bool(enable_color)
+                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx_obj, c_bool(enable_color), c_begin_str
             )
             if self._obj is None:
                 raise Exception("failed to create serial system")

src/sddf.zig

@@ -913,6 +913,7 @@ pub const Serial = struct {
     connected: bool = false,
     enable_color: bool,
     serialised: bool = false,
+    begin_str: [:0]const u8,
 
     driver_config: ConfigResources.Serial.Driver,
     virt_rx_config: ConfigResources.Serial.VirtRx,
@@ -921,20 +922,26 @@ pub const Serial = struct {
 
     pub const Error = SystemError || error{
         InvalidVirt,
+        InvalidBeginString,
     };
 
+    const MAX_BEGIN_STR_LEN = 128;
+    const DEFAULT_BEGIN_STR = "Begin input\r\n";
+
     pub const Options = struct {
         data_size: usize = 0x10000,
         queue_size: usize = 0x1000,
         virt_rx: ?*Pd = null,
         enable_color: bool = true,
+        begin_str: [:0]const u8 = DEFAULT_BEGIN_STR,
     };
 
     pub fn init(allocator: Allocator, sdf: *SystemDescription, device: *dtb.Node, driver: *Pd, virt_tx: *Pd, options: Options) Error!Serial {
         if (std.mem.eql(u8, driver.name, virt_tx.name)) {
             log.err("invalid serial tx virtualiser, same name as driver '{s}", .{virt_tx.name});
             return Error.InvalidVirt;
         }
+
         if (options.virt_rx) |virt_rx| {
             if (std.mem.eql(u8, driver.name, virt_rx.name)) {
                 log.err("invalid serial rx virtualiser, same name as driver '{s}", .{virt_rx.name});
@@ -945,6 +952,12 @@ pub const Serial = struct {
                 return Error.InvalidVirt;
             }
         }
+
+        if (options.begin_str.len > MAX_BEGIN_STR_LEN) {
+            log.err("invalid begin string '{s}', length of {} is greater than max length {}", .{ options.begin_str, options.begin_str.len, MAX_BEGIN_STR_LEN });
+            return error.InvalidBeginString;
+        }
+
         return .{
             .allocator = allocator,
             .sdf = sdf,
@@ -957,6 +970,7 @@ pub const Serial = struct {
             .virt_rx = options.virt_rx,
             .virt_tx = virt_tx,
             .enable_color = options.enable_color,
+            .begin_str = allocator.dupeZ(u8, options.begin_str) catch @panic("OOM"),
 
             .driver_config = std.mem.zeroInit(ConfigResources.Serial.Driver, .{}),
             .virt_rx_config = std.mem.zeroInit(ConfigResources.Serial.VirtRx, .{}),
@@ -968,6 +982,7 @@ pub const Serial = struct {
     pub fn deinit(system: *Serial) void {
         system.clients.deinit();
         system.client_configs.deinit();
+        system.allocator.free(system.begin_str);
     }
 
     pub fn addClient(system: *Serial, client: *Pd) Error!void {
@@ -1052,11 +1067,8 @@ pub const Serial = struct {
 
         system.virt_tx_config.enable_colour = @intFromBool(system.enable_color);
 
-        const begin_str = "Begin input\n";
-        @memcpy(system.virt_tx_config.begin_str[0..begin_str.len], begin_str);
-        assert(system.virt_tx_config.begin_str[begin_str.len] == 0);
-
-        system.virt_tx_config.begin_str_len = begin_str.len;
+        @memcpy(system.virt_tx_config.begin_str[0..system.begin_str.len], system.begin_str);
+        assert(system.virt_tx_config.begin_str[system.begin_str.len] == 0);
 
         system.connected = true;
     }