update the docs

rel4team · Nov 2, 2024 · 493b5dc · 493b5dc
1 parent c1bea74
commit 493b5dc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 16 deletions.
diff --git a/docs/组件化微内核文档.md b/docs/组件化微内核文档.md
@@ -316,16 +316,15 @@ kernel ─┬─> cspace ─┬─> common
 
 ### Macros
 
-| MacroName            | 描述                              |
-| -------------------- | --------------------------------- |
-| BIT                  | set some of the bits              |
-| IS_ALIGNED           | judge whether an value is aligned |
-| MASK                 | mask some bits                    |
-| ROUND_DOWN           | round down with an align          |
-| ROUND_UP             | round up with an align            |
-| print                | print string macro                |
-| println              | println string macro              |
-| plus_define_bitfield |                                   |
+| MacroName  | 描述                              |
+| ---------- | --------------------------------- |
+| BIT        | set some of the bits              |
+| IS_ALIGNED | judge whether an value is aligned |
+| MASK       | mask some bits                    |
+| ROUND_DOWN | round down with an align          |
+| ROUND_UP   | round up with an align            |
+| print      | print string macro                |
+| println    | println string macro              |
 
 ### fault
 
@@ -529,7 +528,7 @@ interface提供了若干个方法，其接口名称及含义如下
 ### endpoint
 
 endpoint是一种基本的通信机制，用于线程（或进程）之间的同步和异步消息传递。endpoint允许线程以发送（Send）、接收（Recv）或回复（Reply）的形式进行通信。这些操作可以通过IPC（Inter-Process Communication）机制实现，允许线程之间安全地交换信息。
-在rel4_kernel中，endpoint被表示为一个结构体（通过plus_define_bitfield!宏定义），其中包含了队列头部、队列尾部和状态等字段。这些字段用于管理通过endpoint发送和接收消息的tcb队列。EPState枚举定义了endpoint可能的状态，包括：
+在rel4_kernel中，endpoint被表示为一个结构体（通过rust_sel4_pbf_parser脚本生成的），其中包含了队列头部、队列尾部和状态等字段。这些字段用于管理通过endpoint发送和接收消息的tcb队列。EPState枚举定义了endpoint可能的状态，包括：
 
 - Idle：表示endpoint当前没有进行任何消息传递操作。
 - Send：表示有线程正在尝试通过endpoint发送消息。

diff --git a/sel4_cspace/src/capability/mod.rs b/sel4_cspace/src/capability/mod.rs
@@ -1,7 +1,4 @@
-//! 该模块定义了几乎全部的`capability`，可以在`sel4_common`中找到`plus_define_bitfield!`宏的具体实现，
-//! 该宏在生成`capability`的同时，会生成每个字段的`get``set`方法
-//! cap_t 表示一个capability，由两个机器字组成，包含了类型、对象元数据以及指向内核对象的指针。
-//! 每个类型的capability的每个字段都实现了get和set方法。
+//! 该模块在rust_sel4_pbf_parser模块生成的结构体的基础上，进行了一些功能的添加和封装。
 //!
 //! 记录在阅读代码段过程中用到的`cap`的特定字段含义：
 //!

diff --git a/sel4_ipc/doc.md b/sel4_ipc/doc.md
@@ -1,6 +1,6 @@
 # endpoint
 endpoint是一种基本的通信机制，用于线程（或进程）之间的同步和异步消息传递。endpoint允许线程以发送（Send）、接收（Recv）或回复（Reply）的形式进行通信。这些操作可以通过IPC（Inter-Process Communication）机制实现，允许线程之间安全地交换信息。
-在rel4_kernel中，endpoint被表示为一个结构体（通过plus_define_bitfield!宏定义），其中包含了队列头部、队列尾部和状态等字段。这些字段用于管理通过endpoint发送和接收消息的tcb队列。EPState枚举定义了endpoint可能的状态，包括：
+在rel4_kernel中，endpoint被表示为一个结构体（通过rust_sel4_pbf_parser脚本生成的），其中包含了队列头部、队列尾部和状态等字段。这些字段用于管理通过endpoint发送和接收消息的tcb队列。EPState枚举定义了endpoint可能的状态，包括：
 - Idle：表示endpoint当前没有进行任何消息传递操作。
 - Send：表示有线程正在尝试通过endpoint发送消息。
 - Recv：表示有线程正在尝试从endpoint接收消息。