[sensor_ctrl/doc] Remove hardcoded intersig table from spec
Signed-off-by: Michael Schaffner <msf@google.com>
diff --git a/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson b/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson
index 1d8158d..6ae0f9a 100644
--- a/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson
+++ b/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson
@@ -4210,6 +4210,7 @@
[
{
name: ast_alert
+ desc: alert requests/acknowledgements from/to `analog sensor top`
struct: ast_alert
package: ast_pkg
type: req_rsp
@@ -4224,6 +4225,7 @@
}
{
name: ast_status
+ desc: " Incoming `analog sensor top` status."
struct: ast_status
package: ast_pkg
type: uni
@@ -4238,6 +4240,7 @@
}
{
name: ast_init_done
+ desc: Initialization done indication coming from `analog sensor top`
struct: logic
type: uni
act: rcv
@@ -4252,6 +4255,7 @@
}
{
name: ast2pinmux
+ desc: Outgoing `analog sensor top` DFT signals that are being forwarded to the pinmux via ast_debug_out.
struct: logic
type: uni
act: rcv
@@ -4266,6 +4270,7 @@
}
{
name: wkup_req
+ desc: Raised if an alert event is seen during low power
struct: logic
type: uni
act: req
@@ -16769,6 +16774,7 @@
}
{
name: ast_alert
+ desc: alert requests/acknowledgements from/to `analog sensor top`
struct: ast_alert
package: ast_pkg
type: req_rsp
@@ -16783,6 +16789,7 @@
}
{
name: ast_status
+ desc: " Incoming `analog sensor top` status."
struct: ast_status
package: ast_pkg
type: uni
@@ -16797,6 +16804,7 @@
}
{
name: ast_init_done
+ desc: Initialization done indication coming from `analog sensor top`
struct: logic
type: uni
act: rcv
@@ -16811,6 +16819,7 @@
}
{
name: ast2pinmux
+ desc: Outgoing `analog sensor top` DFT signals that are being forwarded to the pinmux via ast_debug_out.
struct: logic
type: uni
act: rcv
@@ -16825,6 +16834,7 @@
}
{
name: wkup_req
+ desc: Raised if an alert event is seen during low power
struct: logic
type: uni
act: req
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/data/sensor_ctrl.hjson b/hw/top_earlgrey/ip/sensor_ctrl/data/sensor_ctrl.hjson
index a523b79..aa08d1e 100644
--- a/hw/top_earlgrey/ip/sensor_ctrl/data/sensor_ctrl.hjson
+++ b/hw/top_earlgrey/ip/sensor_ctrl/data/sensor_ctrl.hjson
@@ -16,7 +16,7 @@
],
available_output_list: [
{ name: "ast_debug_out",
- desc: "ast debug outputs to pinmux",
+ desc: "Outgoing `analog sensor top` debug output signals to `pinmux`.",
width: "9"
}
],
@@ -79,6 +79,7 @@
name: "ast_alert",
act: "rsp",
package: "ast_pkg",
+ desc: "alert requests/acknowledgements from/to `analog sensor top`"
},
{ struct: "ast_status",
@@ -86,6 +87,7 @@
name: "ast_status",
act: "rcv",
package: "ast_pkg",
+ desc: " Incoming `analog sensor top` status."
},
{ struct: "logic",
@@ -93,6 +95,7 @@
name: "ast_init_done",
act: "rcv",
package: "",
+ desc: "Initialization done indication coming from `analog sensor top`"
},
{ struct: "logic",
@@ -100,14 +103,16 @@
name: "ast2pinmux",
act: "rcv",
width: 9,
- package: ""
+ package: "",
+ desc: "Outgoing `analog sensor top` DFT signals that are being forwarded to the pinmux via ast_debug_out."
},
{ struct: "logic",
type: "uni",
name: "wkup_req",
act: "req",
- package: ""
+ package: "",
+ desc: "Raised if an alert event is seen during low power"
},
],
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/doc/_index.md b/hw/top_earlgrey/ip/sensor_ctrl/doc/_index.md
index 84da6f1..9daebb3 100644
--- a/hw/top_earlgrey/ip/sensor_ctrl/doc/_index.md
+++ b/hw/top_earlgrey/ip/sensor_ctrl/doc/_index.md
@@ -57,16 +57,6 @@
{{< incGenFromIpDesc "../data/sensor_ctrl.hjson" "hwcfg" >}}
-The table below lists other signals.
-
-Signal | Direction | Type | Description
----------------------|------------------|----------------------------------------|---------------
-`ast_alert_i` | `input` | `ast_pkg::ast_alert_req_t` | Incoming alert requests from `analog sensor top`
-`ast_alert_o` | `output` | `ast_pkg::ast_alert_rsp_t` | Outgoing alert acknowledgments to `analog sensor top`
-`status_i` | `input` | `ast_pkg::ast_status_t` | Incoming `analog sensor top` status
-`ast2pinmux_i` | `input` | `logic [ast_pkg::Ast2PadOutWidth-1:0]` | Incoming `analog sensor top` debug output signals
-`cio_ast_debug_out` | `output` | `logic [ast_pkg::Ast2PadOutWidth-1:0]` | Outgoing `analog sensor top` debug output signals to `pinmux`
-
# Programmer's Guide
Each available alert has a corresponding fatality configuration.
