Merge pull request #21 from syswonder/dev

more sub-chapters for crates part
syswonder · Jun 12, 2024 · 2dc74e6 · 2dc74e6
2 parents c23253e + 09dae29
commit 2dc74e6
Show file tree

Hide file tree

Showing 12 changed files with 752 additions and 11 deletions.
diff --git a/src/Contributors.md b/src/Contributors.md
@@ -1,7 +1,7 @@
 
 # 贡献者
 
-感谢以下同学、单位的支持和贡献：
+感谢以下同学对 RuxOS 的支持和贡献：
 
 |姓名|github ID|单位|
 |----|---------|----|

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -58,6 +58,8 @@
 
         - [页表项及页表](./chap06/crates/pte-pt.md)
 
+        - [percpu类](./chap06/crates/percpu.md)
+
     - [功能模块](./chap06/modules/modules.md)
 
         - [配置及运行时初始化](./chap06/modules/config-and-initialization.md)

diff --git a/src/chap02/arguments.md b/src/chap02/arguments.md
@@ -12,7 +12,7 @@ RuxOS 提供了灵活、明确的诸多编译参数，来针对多种类型的
 | MODE | 与 `cargo build` 相关的模式，默认为 release。 |
 | **LOG** | 日志等级: warn, error, info, debug, trace。默认是 warn。 |
 | V | Verbose 等级: (empty), 1, 2 |
-| ARGS | 命令行参数，使用逗号分隔，不允许空格，可以为空。用来给应用程序传递具体的参数，即 `argc`，`argv`。 |
+| **ARGS** | 命令行参数，使用逗号分隔，不允许空格，可以为空。用来给应用程序传递具体的参数，即 `argc`，`argv`。 |
 | ENVS | 环境变量参数，使用逗号分隔，不允许空格，可以为空。 |
 
 ## 应用参数

diff --git a/src/chap05/multiplatforms.md b/src/chap05/multiplatforms.md
@@ -3,6 +3,6 @@
 
 在前面的章节中，RuxOS 均是运行在 QEMU 环境中，后续矽望社区将结合自研虚拟机监控器 Hvisor，将 RuxOS 运行在 Hvisor 上，借助 Hvisor 适配各类不同的硬件。
 
-但在 RuxOS 的初期探索中，也完成了逻辑环境的适配，RuxOS 能够运行在树莓派4B上，支持了相应的 SD 卡驱动，并进行了验证。
+但在 RuxOS 的初期探索中，也完成了裸机环境的适配，RuxOS 能够运行在树莓派4B上，支持了相应的 SD 卡驱动，并进行了验证。
 
 
diff --git a/src/chap06/crates/arch-related.md b/src/chap06/crates/arch-related.md
@@ -1,17 +1,199 @@
 
 # 架构相关
 
+不同的架构在中断异常处理等方面有着很大的不同，在 Arm 架构上，有专门用于处理一般中断异常的通用中断控制器（Generic Interrupt Controller）、串口设备PL011、设备树，RuxOS 底层组件提供了相关的驱动支持。
+
 ### ARM GIC
 
+Arm 架构上中断被分为了：SGI、PPI、SPI 三种类型：
+
+- SGI：Software Generated Interrupt，软件中断，分配中断号0-15，用于处理器间通信。
+
+- PPI：Private Peripheral Interrupt，私有外设中断，来源于指定的外设，并且由指定的 CPU 进行处理，分配中断号16-31。
+
+- SPI：Shared Peripheral Interrupt，共享外设中断，来源于外设，可由任意的 CPU 进行处理，分配中断号32-1019。
+
+GIC 分为了 GICD（GIC Distributor）和 GICC（GIC Cpu Interface）两端的接口及相关寄存器：
+
+- GICD：用于中断仲裁和转发，具体功能包括使能中断、设置中断优先级、设置中断转发到 CPU 端的转发表、设置中断触发方式（边沿触发/水平触发）、转发 SGI 中断到一个或多个目标处理器、维护中断状态。
+
+- GICC：用于管理到达指定 CPU 的相关中断，包括识别中断、发送中断完成信号、设置当前 CPU 的中断优先级掩码、定义抢占策略。
 
 ### ARM PL011
 
+PL011 串口设备遵循[官方文档](https://developer.arm.com/documentation/ddi0183/latest)来进行实现，提供如下编程接口：
+
+- 创建、初始化一个 PL011 串口实例。
+
+- 从该 UART 设备读或向其写入一个字符。
+
+- 处理 UART 中断。
+
 
 ### DTB
 
+设备树借助了 Rust 第三方库 [`fdt-rs`](https://crates.io/crates/fdt-rs) 来进行解析，目前支持读取相关外设信息和获取设备树上指定类型的节点信息，该库目前仍在完善中。
+
+在后期的工作中，将对 DTB 进行更深的解析和使用，通过规范的设备树文件来获取当前运行环境中的内存大小、内存起始地址、外设地址等信息。
 
 ### Linux 错误类型 axerrno
 
+RuxOS 移植了 ArceOS 的 axerrno 模块，用于匹配标准的 Linux 错误类型，方便上层的相关模块实现和进行错误处理。
+
+目前支持的错误类型如下：
+
+```C
+/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
+/* Copy from /usr/include/asm-generic/errno-base.h and /usr/include/asm-generic/errno.h */
+#ifndef _ASM_GENERIC_ERRNO_BASE_H
+#define _ASM_GENERIC_ERRNO_BASE_H
+
+#define EPERM           1      /* Operation not permitted */
+#define ENOENT          2      /* No such file or directory */
+#define ESRCH           3      /* No such process */
+#define EINTR           4      /* Interrupted system call */
+#define EIO             5      /* I/O error */
+#define ENXIO           6      /* No such device or address */
+#define E2BIG           7      /* Argument list too long */
+#define ENOEXEC         8      /* Exec format error */
+#define EBADF           9      /* Bad file number */
+#define ECHILD          10     /* No child processes */
+#define EAGAIN          11     /* Try again */
+#define ENOMEM          12     /* Out of memory */
+#define EACCES          13     /* Permission denied */
+#define EFAULT          14     /* Bad address */
+#define ENOTBLK         15     /* Block device required */
+#define EBUSY           16     /* Device or resource busy */
+#define EEXIST          17     /* File exists */
+#define EXDEV           18     /* Cross-device link */
+#define ENODEV          19     /* No such device */
+#define ENOTDIR         20     /* Not a directory */
+#define EISDIR          21     /* Is a directory */
+#define EINVAL          22     /* Invalid argument */
+#define ENFILE          23     /* File table overflow */
+#define EMFILE          24     /* Too many open files */
+#define ENOTTY          25     /* Not a typewriter */
+#define ETXTBSY         26     /* Text file busy */
+#define EFBIG           27     /* File too large */
+#define ENOSPC          28     /* No space left on device */
+#define ESPIPE          29     /* Illegal seek */
+#define EROFS           30     /* Read-only file system */
+#define EMLINK          31     /* Too many links */
+#define EPIPE           32     /* Broken pipe */
+#define EDOM            33     /* Math argument out of domain of func */
+#define ERANGE          34     /* Math result not representable */
+#define EDEADLK         35     /* Resource deadlock would occur */
+#define ENAMETOOLONG    36     /* File name too long */
+#define ENOLCK          37     /* No record locks available */
+
+/*
+ * This error code is special: arch syscall entry code will return
+ * -ENOSYS if users try to call a syscall that doesn't exist.  To keep
+ * failures of syscalls that really do exist distinguishable from
+ * failures due to attempts to use a nonexistent syscall, syscall
+ * implementations should refrain from returning -ENOSYS.
+ */
+#define ENOSYS          38     /* Invalid system call number */
+#define ENOTEMPTY       39     /* Directory not empty */
+#define ELOOP           40     /* Too many symbolic links encountered */
+// #define EWOULDBLOCK     EAGAIN /* Operation would block */
+#define ENOMSG          42     /* No message of desired type */
+#define EIDRM           43     /* Identifier removed */
+#define ECHRNG          44     /* Channel number out of range */
+#define EL2NSYNC        45     /* Level 2 not synchronized */
+#define EL3HLT          46     /* Level 3 halted */
+#define EL3RST          47     /* Level 3 reset */
+#define ELNRNG          48     /* Link number out of range */
+#define EUNATCH         49     /* Protocol driver not attached */
+#define ENOCSI          50     /* No CSI structure available */
+#define EL2HLT          51     /* Level 2 halted */
+#define EBADE           52     /* Invalid exchange */
+#define EBADR           53     /* Invalid request descriptor */
+#define EXFULL          54     /* Exchange full */
+#define ENOANO          55     /* No anode */
+#define EBADRQC         56     /* Invalid request code */
+#define EBADSLT         57     /* Invalid slot */
+// #define EDEADLOCK       EDEADLK
+#define EBFONT          59  /* Bad font file format */
+#define ENOSTR          60  /* Device not a stream */
+#define ENODATA         61  /* No data available */
+#define ETIME           62  /* Timer expired */
+#define ENOSR           63  /* Out of streams resources */
+#define ENONET          64  /* Machine is not on the network */
+#define ENOPKG          65  /* Package not installed */
+#define EREMOTE         66  /* Object is remote */
+#define ENOLINK         67  /* Link has been severed */
+#define EADV            68  /* Advertise error */
+#define ESRMNT          69  /* Srmount error */
+#define ECOMM           70  /* Communication error on send */
+#define EPROTO          71  /* Protocol error */
+#define EMULTIHOP       72  /* Multihop attempted */
+#define EDOTDOT         73  /* RFS specific error */
+#define EBADMSG         74  /* Not a data message */
+#define EOVERFLOW       75  /* Value too large for defined data type */
+#define ENOTUNIQ        76  /* Name not unique on network */
+#define EBADFD          77  /* File descriptor in bad state */
+#define EREMCHG         78  /* Remote address changed */
+#define ELIBACC         79  /* Can not access a needed shared library */
+#define ELIBBAD         80  /* Accessing a corrupted shared library */
+#define ELIBSCN         81  /* .lib section in a.out corrupted */
+#define ELIBMAX         82  /* Attempting to link in too many shared libraries */
+#define ELIBEXEC        83  /* Cannot exec a shared library directly */
+#define EILSEQ          84  /* Illegal byte sequence */
+#define ERESTART        85  /* Interrupted system call should be restarted */
+#define ESTRPIPE        86  /* Streams pipe error */
+#define EUSERS          87  /* Too many users */
+#define ENOTSOCK        88  /* Socket operation on non-socket */
+#define EDESTADDRREQ    89  /* Destination address required */
+#define EMSGSIZE        90  /* Message too long */
+#define EPROTOTYPE      91  /* Protocol wrong type for socket */
+#define ENOPROTOOPT     92  /* Protocol not available */
+#define EPROTONOSUPPORT 93  /* Protocol not supported */
+#define ESOCKTNOSUPPORT 94  /* Socket type not supported */
+#define EOPNOTSUPP      95  /* Operation not supported on transport endpoint */
+#define EPFNOSUPPORT    96  /* Protocol family not supported */
+#define EAFNOSUPPORT    97  /* Address family not supported by protocol */
+#define EADDRINUSE      98  /* Address already in use */
+#define EADDRNOTAVAIL   99  /* Cannot assign requested address */
+#define ENETDOWN        100 /* Network is down */
+#define ENETUNREACH     101 /* Network is unreachable */
+#define ENETRESET       102 /* Network dropped connection because of reset */
+#define ECONNABORTED    103 /* Software caused connection abort */
+#define ECONNRESET      104 /* Connection reset by peer */
+#define ENOBUFS         105 /* No buffer space available */
+#define EISCONN         106 /* Transport endpoint is already connected */
+#define ENOTCONN        107 /* Transport endpoint is not connected */
+#define ESHUTDOWN       108 /* Cannot send after transport endpoint shutdown */
+#define ETOOMANYREFS    109 /* Too many references: cannot splice */
+#define ETIMEDOUT       110 /* Connection timed out */
+#define ECONNREFUSED    111 /* Connection refused */
+#define EHOSTDOWN       112 /* Host is down */
+#define EHOSTUNREACH    113 /* No route to host */
+#define EALREADY        114 /* Operation already in progress */
+#define EINPROGRESS     115 /* Operation now in progress */
+#define ESTALE          116 /* Stale file handle */
+#define EUCLEAN         117 /* Structure needs cleaning */
+#define ENOTNAM         118 /* Not a XENIX named type file */
+#define ENAVAIL         119 /* No XENIX semaphores available */
+#define EISNAM          120 /* Is a named type file */
+#define EREMOTEIO       121 /* Remote I/O error */
+#define EDQUOT          122 /* Quota exceeded */
+
+#define ENOMEDIUM       123 /* No medium found */
+#define EMEDIUMTYPE     124 /* Wrong medium type */
+#define ECANCELED       125 /* Operation Canceled */
+#define ENOKEY          126 /* Required key not available */
+#define EKEYEXPIRED     127 /* Key has expired */
+#define EKEYREVOKED     128 /* Key has been revoked */
+#define EKEYREJECTED    129 /* Key was rejected by service */
+#define EOWNERDEAD      130 /* Owner died */
+#define ENOTRECOVERABLE 131 /* State not recoverable */
+#define ERFKILL         132 /* Operation not possible due to RF-kill */
+#define EHWPOISON       133 /* Memory page has hardware error */
+
+
+#endif
+```
 
 
 
diff --git a/src/chap06/crates/crates.md b/src/chap06/crates/crates.md
@@ -24,3 +24,7 @@ RuxOS 底层组件有如下特点：
 - [文件系统及 IO 类](./fs-IO.md)。包含了 RuxOS 目前适配的各类文件系统，以及为上层定义的基于 Rust 标准库的 IO 相关 trait。
 
 - [页表项及页表](./pte-pt.md)。涵盖了多种架构，RuxOS 实现的页表项定义及相关方法实现。
+
+- [percpu类](./percpu.md)。提供了定义percpu数据结构的相关方法和宏。
+
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,6 +3,6 @@

		在前面的章节中，RuxOS 均是运行在 QEMU 环境中，后续矽望社区将结合自研虚拟机监控器 Hvisor，将 RuxOS 运行在 Hvisor 上，借助 Hvisor 适配各类不同的硬件。

		但在 RuxOS 的初期探索中，也完成了逻辑环境的适配，RuxOS 能够运行在树莓派4B上，支持了相应的 SD 卡驱动，并进行了验证。
		但在 RuxOS 的初期探索中，也完成了裸机环境的适配，RuxOS 能够运行在树莓派4B上，支持了相应的 SD 卡驱动，并进行了验证。
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,3 +24,7 @@ RuxOS 底层组件有如下特点：
		- [文件系统及 IO 类](./fs-IO.md)。包含了 RuxOS 目前适配的各类文件系统，以及为上层定义的基于 Rust 标准库的 IO 相关 trait。

		- [页表项及页表](./pte-pt.md)。涵盖了多种架构，RuxOS 实现的页表项定义及相关方法实现。

		- [percpu类](./percpu.md)。提供了定义percpu数据结构的相关方法和宏。