[alert_handler/doc] Add crashdump struct definition to docs
Signed-off-by: Michael Schaffner <msf@opentitan.org>
diff --git a/hw/ip/alert_handler/doc/_index.md b/hw/ip/alert_handler/doc/_index.md
index 8f1a907..1110c0e 100644
--- a/hw/ip/alert_handler/doc/_index.md
+++ b/hw/ip/alert_handler/doc/_index.md
@@ -173,12 +173,23 @@
attack. Note that low power states are not considered at this time, but could
affect the signaling and testing of alerts.
-The `crashdump_o` struct outputs a collection of CSRs and alert handler state
-bits that can be latched by hardware debugging circuitry. This can be useful for
-extracting more information about possible failures or bugs without having to
-use the tile-link bus interface (which may become unresponsive under certain
-circumstances). It is recommended for the top level to store this information in
-an always-on location.
+The `crashdump_o` struct outputs a collection of CSRs and alert handler state bits that can be latched by hardware debugging circuitry:
+
+```systemverilog
+ typedef struct packed {
+ // alerts
+ logic [NAlerts-1:0] alert_cause; // alert cause bits
+ logic [3:0] loc_alert_cause; // local alert cause bits
+ // class state
+ logic [3:0][15:0] class_accum_cnt; // current accumulator value
+ logic [3:0][31:0] class_esc_cnt; // current escalation counter value
+ cstate_e [3:0] class_esc_state; // current escalation protocol state
+ } alert_crashdump_t;
+```
+
+This can be useful for extracting more information about possible failures or bugs without having to use the tile-link bus interface (which may become unresponsive under certain circumstances).
+It is recommended for the top level to store this information in an always-on location.
+
## Design Details
