summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-02 19:42:53 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-17 07:51:53 +0200
commitec3417264d7be552593477bc8ac942fd6f187c89 (patch)
treef3c7845e9306592be3ff89e39156f45be8d2fef9
parentinterface: Support register sets (diff)
downloadrtems-central-ec3417264d7be552593477bc8ac942fd6f187c89.tar.bz2
interface: Change register bits brief
-rw-r--r--rtemsspec/interface.py5
-rw-r--r--rtemsspec/tests/test_interface.py32
2 files changed, 21 insertions, 16 deletions
diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py
index 1f951b40..9df5576d 100644
--- a/rtemsspec/interface.py
+++ b/rtemsspec/interface.py
@@ -350,9 +350,10 @@ class Node:
ctx.regs[name]["size"] = width // 8
ctx.regs[name]["type"] = f"uint{width}_t"
ctx.regs[name]["group"] = group_ident
- with self.content.defgroup_block(group_ident, name):
+ brief = self.substitute_text(register["brief"])
+ with self.content.defgroup_block(group_ident, f"{brief} ({name})"):
self.content.add_brief_description(
- self.substitute_text(register["brief"]))
+ "This group contains register bit definitions.")
self.content.doxyfy(
self.substitute_text(register["description"]))
self.content.add("@{")
diff --git a/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py
index 14fce46d..f1d4d70d 100644
--- a/rtemsspec/tests/test_interface.py
+++ b/rtemsspec/tests/test_interface.py
@@ -253,9 +253,10 @@ void Function6( int Param0 );
*/
/**
- * @defgroup IrqampTimestampITCNT ITCNT
+ * @defgroup IrqampTimestampITCNT \\
+ * Interrupt timestamp counter n register (ITCNT)
*
- * @brief Interrupt timestamp counter n register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -269,9 +270,10 @@ void Function6( int Param0 );
/** @} */
/**
- * @defgroup IrqampTimestampITSTMPC ITSTMPC
+ * @defgroup IrqampTimestampITSTMPC \\
+ * Interrupt timestamp n control register (ITSTMPC)
*
- * @brief Interrupt timestamp n control register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -297,9 +299,10 @@ void Function6( int Param0 );
/** @} */
/**
- * @defgroup IrqampTimestampITSTMPAS ITSTMPAS
+ * @defgroup IrqampTimestampITSTMPAS \\
+ * Interrupt Assertion Timestamp n register (ITSTMPAS)
*
- * @brief Interrupt Assertion Timestamp n register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -313,9 +316,10 @@ void Function6( int Param0 );
/** @} */
/**
- * @defgroup IrqampTimestampITSTMPAC ITSTMPAC
+ * @defgroup IrqampTimestampITSTMPAC \\
+ * Interrupt Acknowledge Timestamp n register (ITSTMPAC)
*
- * @brief Interrupt Acknowledge Timestamp n register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -367,9 +371,9 @@ typedef struct irqamp_timestamp {
*/
/**
- * @defgroup IrqampILEVEL ILEVEL
+ * @defgroup IrqampILEVEL Interrupt level register (ILEVEL)
*
- * @brief Interrupt level register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -383,9 +387,9 @@ typedef struct irqamp_timestamp {
/** @} */
/**
- * @defgroup IrqampIPEND8 IPEND8
+ * @defgroup IrqampIPEND8 Interrupt pending register (IPEND8)
*
- * @brief Interrupt pending register
+ * @brief This group contains register bit definitions.
*
* @{
*/
@@ -495,9 +499,9 @@ typedef struct irqamp {
*/
/**
- * @defgroup RBNSR R
+ * @defgroup RBNSR Brief. (R)
*
- * @brief Brief.
+ * @brief This group contains register bit definitions.
*
* @{
*/