Merge pull request #278 from pluveto/patch-1

Update report stmt documentation to include structured reporting

Author: Dolu1990

source/SpinalHDL/Other language features/report.rst

@@ -30,7 +30,7 @@ Since SpinalHDL 1.4.4, the following syntax is also supported:
 
     report(L"miaou $a $b $c $d")
 
-You can display the current simulation time using the REPORT_TIME object
+You can display the current simulation time using the `REPORT_TIME` object:
 
 .. code-block:: scala
 
@@ -41,3 +41,67 @@ will result in:
 .. code-block:: verilog
 
     $display("NOTE miaou %t", $time);
+
+**Automatic Handling of Scala Primitive Types (SpinalHDL ^1.12.2)**
+
+You can embed Scala primitive types (e.g., `Int`, `Boolean`, `Float`, `BigInt`, `BigDecimal`, `Char`, `Byte`, `Short`, `Long`) within `L""` interpolated strings without explicit `.toString()` calls.
+
+.. code-block:: scala
+
+    val myInt = 123
+    val myBool = True
+    val myFloat = 3.14f
+    val myBigInt = BigInt(0xABCD)
+    report(L"My values: int=$myInt, bool=$myBool, float=$myFloat, bigInt=$myBigInt")
+
+.. code-block:: scala
+
+    for (i <- 0 until cacheConfig.fetchWordsPerFetchGroup) {
+      report(L"AdvICache: sCompareTags - Instruction ${i}: ${io.cpu.rsp.payload.instructions(i)}")
+    }
+
+**Structured Reporting for Complex Data Types (like Bundles) (SpinalHDL ^1.12.2)**
+
+For `Bundle`s or other complex data structures, you can define a `Formattable` trait and implement a `format()` method returning `Seq[Any]` to define a structured, nested representation. This allows for clean, one-line reporting of entire complex objects.
+
+First, define a `Formattable` trait and implement it in your Bundles:
+
+.. code-block:: scala
+
+    trait Formattable {
+      def format(): Seq[Any]
+    }
+
+    case class DataPayload() extends Bundle with Formattable {
+      val value = UInt(16 bits)
+      val checksum = UInt(8 bits)
+      override def format(): Seq[Any] = Seq(L"DataPayload(value=0x${value}, checksum=0x${checksum})")
+    }
+
+    case class PacketHeader() extends Bundle with Formattable {
+      val packetLength = UInt(8 bits)
+      val packetType = UInt(4 bits)
+      val payload = DataPayload()
+      override def format(): Seq[Any] = Seq(
+        L"PacketHeader(",
+        L"packetLength=0x${packetLength},",
+        L" packetType=0x${packetType},",
+        L" payload=${payload.format},", // Nested format call
+        L")"
+      ).flatten
+    }
+
+Then, you can report the entire structure:
+
+.. code-block:: scala
+
+    class MyComponent extends Component {
+      val io = PacketHeader() // Assume io is an instance of PacketHeader
+      // ... some logic ...
+      report(io.format)
+    }
+
+This will produce a compact, readable output like:
+
+.. code-block:: text
+PacketHeader(packetLength=0x0c, packetType=0x1, payload=DataPayload(value=0x5678, checksum=0x78))