Merge branch 'MinMax-Field-Func' of github.com:Thomas-Vreys/ipxact2systemverilog into Thomas-Vreys-MinMax-Field-Func

oddball · oddball · commit b442512560d9 · 2025-08-06T23:36:21.000+02:00
diff --git a/example/input/test.xml b/example/input/test.xml
@@ -30,6 +30,10 @@
                   <spirit:description>write something useful for field0</spirit:description>
                   <spirit:bitOffset>0</spirit:bitOffset>
                   <spirit:bitWidth>8</spirit:bitWidth>
+                  <spirit:writeValueConstraint>
+                     <spirit:minimum>0</spirit:minimum>
+                     <spirit:maximum>7</spirit:maximum>
+                  </spirit:writeValueConstraint>
                </spirit:field>
                <spirit:field>
                   <spirit:name>byte1</spirit:name>
@@ -63,6 +67,10 @@
                   <spirit:description>write something useful for field0</spirit:description>
                   <spirit:bitOffset>0</spirit:bitOffset>
                   <spirit:bitWidth>32</spirit:bitWidth>
+                  <spirit:writeValueConstraint>
+                     <spirit:minimum>4</spirit:minimum>
+                     <spirit:maximum>20</spirit:maximum>
+                  </spirit:writeValueConstraint>
                </spirit:field>
             </spirit:register>
             <spirit:register>
diff --git a/example/input/test2.xml b/example/input/test2.xml
@@ -43,6 +43,10 @@
                   <spirit:description>read something useful for field0</spirit:description>
                   <spirit:bitOffset>0</spirit:bitOffset>
                   <spirit:bitWidth>8</spirit:bitWidth>
+                  <spirit:writeValueConstraint>
+                     <spirit:minimum>0</spirit:minimum>
+                     <spirit:maximum>7</spirit:maximum>
+                  </spirit:writeValueConstraint>
                </spirit:field>
             </spirit:register>
          </spirit:addressBlock>
diff --git a/example/output/example.docx b/example/output/example.docx
diff --git a/example/output/example.h b/example/output/example.h
@@ -38,6 +38,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG0_BYTE0_SHIFT	0
 #define EXAMPLE_REG0_BYTE0_MASK 	0xFF
+#define EXAMPLE_REG0_BYTE0_MIN 	0x00
+#define EXAMPLE_REG0_BYTE0_MAX 	0x07
 
 #define EXAMPLE_REG0_BYTE1_SHIFT	8
 #define EXAMPLE_REG0_BYTE1_MASK 	0xFF
@@ -53,6 +55,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG1_FIELD0_SHIFT	0
 #define EXAMPLE_REG1_FIELD0_MASK 	0xFFFFFFFF
+#define EXAMPLE_REG1_FIELD0_MIN 	0x00000004
+#define EXAMPLE_REG1_FIELD0_MAX 	0x00000014
 
 // ------------------------------------------------
 //  Bit operations for register reg2
diff --git a/example/output/example.html b/example/output/example.html
@@ -308,6 +308,17 @@ <h1 id="reg0">reg0</h1>
 </tr>
 </tbody>
 </table>
+<h2 id="byte0">byte0</h2>
+<dl>
+<dt>Minimum</dt>
+<dd>
+0x00
+</dd>
+<dt>Maximum</dt>
+<dd>
+0x07
+</dd>
+</dl>
 <h1 id="reg1">reg1</h1>
 <dl>
 <dt>Name</dt>
@@ -355,6 +366,17 @@ <h1 id="reg1">reg1</h1>
 </tr>
 </tbody>
 </table>
+<h2 id="field0">field0</h2>
+<dl>
+<dt>Minimum</dt>
+<dd>
+0x00000004
+</dd>
+<dt>Maximum</dt>
+<dd>
+0x00000014
+</dd>
+</dl>
 <h1 id="reg2">reg2</h1>
 <dl>
 <dt>Name</dt>
diff --git a/example/output/example.md b/example/output/example.md
@@ -35,6 +35,11 @@ Base Address: 0x0
 |[15:8]|byte1|0x00|write something useful for field1|
 |[7:0]|byte0|0x00|write something useful for field0|
 
+#### byte0
+
+**Minimum** 0x00
+**Maximum** 0x07
+
 ### reg1
 
 **Name** reg1
@@ -46,6 +51,11 @@ Base Address: 0x0
 | :--- | :--- | :--- | :--- |
 |[31:0]|field0|0x00000001|write something useful for field0|
 
+#### field0
+
+**Minimum** 0x00000004
+**Maximum** 0x00000014
+
 ### reg2
 
 **Name** reg2
diff --git a/example/output/example.rst b/example/output/example.rst
@@ -52,6 +52,12 @@ reg0
 | [7:0]   | byte0        | 0x00    | write something useful for field0 |
 +---------+--------------+---------+-----------------------------------+
 
+byte0
+~~~~~
+
+:Minimum: 0x00
+:Maximum: 0x07
+
 reg1
 ----
 
@@ -67,6 +73,12 @@ reg1
 | [31:0] | field0       | 0x00000001 | write something useful for field0 |
 +--------+--------------+------------+-----------------------------------+
 
+field0
+~~~~~~
+
+:Minimum: 0x00000004
+:Maximum: 0x00000014
+
 reg2
 ----
 
diff --git a/example/output/example.rtf b/example/output/example.rtf
@@ -252,6 +252,11 @@ reg8
 }
 \intbl\row}
 {\pard \ql \f0 \sa180 \li0 \fi0 \par}
+{\pard \ql \f0 \sa180 \li0 \fi0 \outlinelevel1 \b \fs32 byte0\par}
+{\pard \ql \f0 \sa0 \li0 \fi0 Minimum\par}
+{\pard \ql \f0 \sa0 \li360 \fi0 0x00\par}
+{\pard \ql \f0 \sa0 \li0 \fi0 Maximum\par}
+{\pard \ql \f0 \sa0 \li360 \fi0 0x07\sa180\par}
 {\pard \ql \f0 \sa180 \li0 \fi0 \outlinelevel0 \b \fs36 reg1\par}
 {\pard \ql \f0 \sa0 \li0 \fi0 Name\par}
 {\pard \ql \f0 \sa0 \li360 \fi0 reg1\par}
@@ -293,6 +298,11 @@ reg8
 }
 \intbl\row}
 {\pard \ql \f0 \sa180 \li0 \fi0 \par}
+{\pard \ql \f0 \sa180 \li0 \fi0 \outlinelevel1 \b \fs32 field0\par}
+{\pard \ql \f0 \sa0 \li0 \fi0 Minimum\par}
+{\pard \ql \f0 \sa0 \li360 \fi0 0x00000004\par}
+{\pard \ql \f0 \sa0 \li0 \fi0 Maximum\par}
+{\pard \ql \f0 \sa0 \li360 \fi0 0x00000014\sa180\par}
 {\pard \ql \f0 \sa180 \li0 \fi0 \outlinelevel0 \b \fs36 reg2\par}
 {\pard \ql \f0 \sa0 \li0 \fi0 Name\par}
 {\pard \ql \f0 \sa0 \li360 \fi0 reg2\par}
diff --git a/example/output/example2.h b/example/output/example2.h
@@ -40,6 +40,8 @@
 // ------------------------------------------------
 #define EXAMPLE2_REG1_FIELD0_SHIFT	0
 #define EXAMPLE2_REG1_FIELD0_MASK 	0xFF
+#define EXAMPLE2_REG1_FIELD0_MIN 	0x00
+#define EXAMPLE2_REG1_FIELD0_MAX 	0x07
 
 
 // ------------------------------------------------
diff --git a/example/output/example2.md b/example/output/example2.md
@@ -34,3 +34,8 @@ Base Address: 0x0
 |Bits|Field name|Description|
 | :--- | :--- | :--- |
 |[7:0]|field0|read something useful for field0|
+
+#### field0
+
+**Minimum** 0x00
+**Maximum** 0x07
diff --git a/example/output/example2.rst b/example/output/example2.rst
@@ -48,3 +48,9 @@ reg1
 | [7:0]  | field0       | read something useful for field0 |
 +--------+--------------+----------------------------------+
 
+field0
+~~~~~~
+
+:Minimum: 0x00
+:Maximum: 0x07
+
diff --git a/example/output/example2_sv_pkg.sv b/example/output/example2_sv_pkg.sv
@@ -35,7 +35,7 @@ typedef struct packed {
 
 
 typedef struct packed {
-   bit [7:0] field0;//bits [7:0]
+   bit [7:0] field0;//bits [7:0], Min: 0x00, Max: 0x07
 } reg1_struct_type;
 
 
diff --git a/example/output/example2_vhd_pkg.vhd b/example/output/example2_vhd_pkg.vhd
@@ -29,7 +29,7 @@ package example2_vhd_pkg is
   end record;
 
   type reg1_record_type is record
-    field0 : std_ulogic_vector(7 downto 0); -- [7:0]
+    field0 : std_ulogic_vector(7 downto 0); -- [7:0], Min: 0x00, Max: 0x07
   end record;
 
   type example2_in_record_type is record
diff --git a/example/output/example_sv_pkg.sv b/example/output/example_sv_pkg.sv
@@ -60,12 +60,12 @@ typedef struct packed {
    bit [7:0] byte3;//bits [31:24]
    bit [7:0] byte2;//bits [23:16]
    bit [7:0] byte1;//bits [15:8]
-   bit [7:0] byte0;//bits [7:0]
+   bit [7:0] byte0;//bits [7:0], Min: 0x00, Max: 0x07
 } reg0_struct_type;
 
 
 typedef struct packed {
-   bit [31:0] field0;//bits [31:0]
+   bit [31:0] field0;//bits [31:0], Min: 0x00000004, Max: 0x00000014
 } reg1_struct_type;
 
 
diff --git a/example/output/example_vhd_pkg.vhd b/example/output/example_vhd_pkg.vhd
@@ -69,11 +69,11 @@ package example_vhd_pkg is
     byte3 : std_ulogic_vector(7 downto 0); -- [31:24]
     byte2 : std_ulogic_vector(7 downto 0); -- [23:16]
     byte1 : std_ulogic_vector(7 downto 0); -- [15:8]
-    byte0 : std_ulogic_vector(7 downto 0); -- [7:0]
+    byte0 : std_ulogic_vector(7 downto 0); -- [7:0], Min: 0x00, Max: 0x07
   end record;
 
   type reg1_record_type is record
-    field0 : std_ulogic_vector(31 downto 0); -- [31:0]
+    field0 : std_ulogic_vector(31 downto 0); -- [31:0], Min: 0x00000004, Max: 0x00000014
   end record;
 
   type reg2_record_type is record
diff --git a/example/output_default/example.h b/example/output_default/example.h
@@ -38,6 +38,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG0_BYTE0_SHIFT	0
 #define EXAMPLE_REG0_BYTE0_MASK 	0xFF
+#define EXAMPLE_REG0_BYTE0_MIN 	0x00
+#define EXAMPLE_REG0_BYTE0_MAX 	0x07
 
 #define EXAMPLE_REG0_BYTE1_SHIFT	8
 #define EXAMPLE_REG0_BYTE1_MASK 	0xFF
@@ -53,6 +55,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG1_FIELD0_SHIFT	0
 #define EXAMPLE_REG1_FIELD0_MASK 	0xFFFFFFFF
+#define EXAMPLE_REG1_FIELD0_MIN 	0x00000004
+#define EXAMPLE_REG1_FIELD0_MAX 	0x00000014
 
 // ------------------------------------------------
 //  Bit operations for register reg2
diff --git a/example/output_default/example.md b/example/output_default/example.md
@@ -35,6 +35,11 @@ Base Address: 0x0
 |[15:8]|byte1|0x00|write something useful for field1|
 |[7:0]|byte0|0x00|write something useful for field0|
 
+#### byte0
+
+**Minimum** 0x00
+**Maximum** 0x07
+
 ### reg1
 
 **Name** reg1
@@ -46,6 +51,11 @@ Base Address: 0x0
 | :--- | :--- | :--- | :--- |
 |[31:0]|field0|0x00000001|write something useful for field0|
 
+#### field0
+
+**Minimum** 0x00000004
+**Maximum** 0x00000014
+
 ### reg2
 
 **Name** reg2
diff --git a/example/output_default/example.rst b/example/output_default/example.rst
@@ -52,6 +52,12 @@ reg0
 | [7:0]   | byte0        | 0x00    | write something useful for field0 |
 +---------+--------------+---------+-----------------------------------+
 
+byte0
+~~~~~
+
+:Minimum: 0x00
+:Maximum: 0x07
+
 reg1
 ----
 
@@ -67,6 +73,12 @@ reg1
 | [31:0] | field0       | 0x00000001 | write something useful for field0 |
 +--------+--------------+------------+-----------------------------------+
 
+field0
+~~~~~~
+
+:Minimum: 0x00000004
+:Maximum: 0x00000014
+
 reg2
 ----
 
diff --git a/example/output_default/example_sv_pkg.sv b/example/output_default/example_sv_pkg.sv
@@ -60,12 +60,12 @@ typedef struct packed {
    bit [7:0] byte3;//bits [31:24]
    bit [7:0] byte2;//bits [23:16]
    bit [7:0] byte1;//bits [15:8]
-   bit [7:0] byte0;//bits [7:0]
+   bit [7:0] byte0;//bits [7:0], Min: 0x00, Max: 0x07
 } reg0_struct_type;
 
 
 typedef struct packed {
-   bit [31:0] field0;//bits [31:0]
+   bit [31:0] field0;//bits [31:0], Min: 0x00000004, Max: 0x00000014
 } reg1_struct_type;
 
 
diff --git a/example/output_default/example_vhd_pkg.vhd b/example/output_default/example_vhd_pkg.vhd
@@ -69,11 +69,11 @@ package example_vhd_pkg is
     byte3 : std_ulogic_vector(7 downto 0); -- [31:24]
     byte2 : std_ulogic_vector(7 downto 0); -- [23:16]
     byte1 : std_ulogic_vector(7 downto 0); -- [15:8]
-    byte0 : std_ulogic_vector(7 downto 0); -- [7:0]
+    byte0 : std_ulogic_vector(7 downto 0); -- [7:0], Min: 0x00, Max: 0x07
   end record;
 
   type reg1_record_type is record
-    field0 : std_ulogic_vector(31 downto 0); -- [31:0]
+    field0 : std_ulogic_vector(31 downto 0); -- [31:0], Min: 0x00000004, Max: 0x00000014
   end record;
 
   type reg2_record_type is record
diff --git a/example/output_no_default/example.h b/example/output_no_default/example.h
@@ -38,6 +38,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG0_BYTE0_SHIFT	0
 #define EXAMPLE_REG0_BYTE0_MASK 	0xFF
+#define EXAMPLE_REG0_BYTE0_MIN 	0x00
+#define EXAMPLE_REG0_BYTE0_MAX 	0x07
 
 #define EXAMPLE_REG0_BYTE1_SHIFT	8
 #define EXAMPLE_REG0_BYTE1_MASK 	0xFF
@@ -53,6 +55,8 @@
 // ------------------------------------------------
 #define EXAMPLE_REG1_FIELD0_SHIFT	0
 #define EXAMPLE_REG1_FIELD0_MASK 	0xFFFFFFFF
+#define EXAMPLE_REG1_FIELD0_MIN 	0x00000004
+#define EXAMPLE_REG1_FIELD0_MAX 	0x00000014
 
 // ------------------------------------------------
 //  Bit operations for register reg2
diff --git a/example/output_no_default/example.md b/example/output_no_default/example.md
@@ -35,6 +35,11 @@ Base Address: 0x0
 |[15:8]|byte1|0x00|write something useful for field1|
 |[7:0]|byte0|0x00|write something useful for field0|
 
+#### byte0
+
+**Minimum** 0x00
+**Maximum** 0x07
+
 ### reg1
 
 **Name** reg1
@@ -46,6 +51,11 @@ Base Address: 0x0
 | :--- | :--- | :--- | :--- |
 |[31:0]|field0|0x00000001|write something useful for field0|
 
+#### field0
+
+**Minimum** 0x00000004
+**Maximum** 0x00000014
+
 ### reg2
 
 **Name** reg2
diff --git a/example/output_no_default/example.rst b/example/output_no_default/example.rst
diff --git a/example/output_no_default/example_sv_pkg.sv b/example/output_no_default/example_sv_pkg.sv
diff --git a/example/output_no_default/example_vhd_pkg.vhd b/example/output_no_default/example_vhd_pkg.vhd
diff --git a/example/output_sphinx/example.pdf b/example/output_sphinx/example.pdf
diff --git a/example/output_sphinx/example.rst b/example/output_sphinx/example.rst
diff --git a/ipxact2systemverilog/ipxact2hdlCommon.py b/ipxact2systemverilog/ipxact2hdlCommon.py
