DragonOS-Community/DragonOS
4
1
Fork 0
mirror of https://github.com/DragonOS-Community/DragonOS.git synced 2025-06-11 17:26:50 +00:00
Code Issues Releases Wiki Activity

增加printk文档

Browse Source
This commit is contained in:
fslongjin 2022-07-26 18:05:17 +08:00
parent e14535feaa
commit b0474540d4
1 changed files with 90 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
docs/kernel/core_api/kernel_api.md
View File

@ -42,11 +42,11 @@
**entry** **entry**
  已存在于循环链表中的一个结点   已存在于循环链表中的一个结点
**node** **node**
  待插入的结点   待插入的结点
### `void list_del(struct List *entry)` ### `void list_del(struct List *entry)`
@ -76,13 +76,13 @@
#### 描述 #### 描述
  获取entry的前一个结点   获取entry的前一个结点
#### 参数 #### 参数
**entry** **entry**
  链表中的一个结点   链表中的一个结点
### `struct List *list_next(struct List *entry)` ### `struct List *list_next(struct List *entry)`
@ -108,13 +108,13 @@
##### 描述 ##### 描述
测量并返回字符串长度。   测量并返回字符串长度。
##### 参数 ##### 参数
**src** **src**
源字符串   源字符串
#### `long strnlen(const char *src, unsigned long maxlen)` #### `long strnlen(const char *src, unsigned long maxlen)`
@ -136,7 +136,7 @@
##### 描述 ##### 描述
  测量并返回字符串长度。当字符串长度大于maxlen时，返回maxlen。   测量并返回字符串长度。当字符串长度大于maxlen时，返回maxlen。
  该函数会进行地址空间校验，要求src字符串必须来自用户空间。当源字符串来自内核空间时，将返回0.   该函数会进行地址空间校验，要求src字符串必须来自用户空间。当源字符串来自内核空间时，将返回0.
@ -144,23 +144,23 @@
**src** **src**
  源字符串，地址位于用户空间   源字符串，地址位于用户空间
**maxlen** **maxlen**
  最大长度   最大长度
#### `char *strncpy(char *dst, const char *src, long count)` #### `char *strncpy(char *dst, const char *src, long count)`
##### 描述 ##### 描述
  拷贝长度为count个字节的字符串，返回dst字符串   拷贝长度为count个字节的字符串，返回dst字符串
##### 参数 ##### 参数
**src** **src**
  源字符串   源字符串
**dst** **dst**
@ -168,9 +168,7 @@
**count** **count**
  要拷贝的源字符串的长度   要拷贝的源字符串的长度
#### `long strncpy_from_user(char *dst, const char *src, unsigned long size)` #### `long strncpy_from_user(char *dst, const char *src, unsigned long size)`
@ -188,7 +186,7 @@
**dst** **dst**
  目标字符串   目标字符串
**size** **size**
@ -212,12 +210,88 @@
**FirstPart** **FirstPart**
  第一个字符串   第一个字符串
**SecondPart** **SecondPart**
  第二个字符串   第二个字符串
#### `printk(const char* fmt, ...)`
##### 描述
  该宏能够在控制台上以黑底白字格式化输出字符串.
##### 参数
**fmt**
  源格式字符串
**...**
  可变参数
#### `printk_color(unsigned int FRcolor, unsigned int BKcolor, const char* fmt, ...)`
##### 描述
  在控制台上以指定前景色和背景色格式化输出字符串.
##### 参数
**FRcolor**
  前景色
**BKcolor**
  背景色
**fmt**
  源格式字符串
**...**
  可变参数
#### `int vsprintf(char *buf, const char *fmt, va_list args)`
##### 描述
  按照fmt格式化字符串，并将结果输出到buf中，返回写入buf的字符数量。
##### 参数
**buf**
  输出缓冲区
**fmt**
  源格式字符串
**args**
  可变参数列表
#### `int sprintk(char *buf, const char *fmt, ...)`
##### 描述
  按照fmt格式化字符串，并将结果输出到buf中，返回写入buf的字符数量。
##### 参数
**buf**
  输出缓冲区
**fmt**
  源格式字符串
**...**
  可变参数