结构体
struct	CirBufSendCB
	发送环形buf控制块,通过事件发送更多...

struct	CONSOLE_CB
	控制台控制块(描述符) 更多...

函数
INT32	system_console_init (const CHAR *deviceName)
	https://man7.org/linux/man-pages/man3/tcflow.3.html termios 是在POSIX规范中定义的标准接口，表示终端设备，包括虚拟终端、串口等。串口通过termios进行配置。 struct termios { unsigned short c_iflag; // 输入模式标志 unsigned short c_oflag; // 输出模式标志 unsigned short c_cflag; // 控制模式标志 unsigned short c_lflag; // 本地模式标志例如: 设置非规范模式 tios.c_lflag = ~(ICANON \| ECHO \| ECHOE \| ISIG); unsigned char c_line; // 线路规程 unsigned char c_cc[NCC]; // 控制特性 speed_t c_ispeed; // 输入速度 speed_t c_ospeed; // 输出速度 } 终端有三种工作模式：规范模式（canonical mode）、非规范模式（non-canonical mode）原始模式（raw mode）。 https://www.jianshu.com/p/fe5812469801 https://blog.csdn.net/wumenglu1018/article/details/53098794 更多...

INT32	system_console_deinit (const CHAR *deviceName)
	控制台结束前的处理和 system_console_init成对出现,像控制台的析构函数更多...

BOOL	SetSerialNonBlock (const CONSOLE_CB *consoleCB)
	无锁方式设置串口更多...

BOOL	SetSerialBlock (const CONSOLE_CB *consoleCB)
	锁方式设置串口更多...

BOOL	SetTelnetNonBlock (const CONSOLE_CB *consoleCB)
	无锁方式设置远程登录更多...

BOOL	SetTelnetBlock (const CONSOLE_CB *consoleCB)
	锁方式设置远程登录更多...

CONSOLE_CB *	OsGetConsoleByID (INT32 consoleID)
	获取参数控制台ID 获取对应的控制台控制块(描述符) 更多...

CONSOLE_CB *	OsGetConsoleByTaskID (UINT32 taskID)
	获取参数任务的控制台控制块(描述符) 更多...

INT32	ConsoleTaskReg (INT32 consoleID, UINT32 taskID)
	任务注册控制台,每个shell任务都有属于自己的控制台更多...

INT32	ConsoleUpdateFd (VOID)
	控制台更新文件句柄更多...

BOOL	ConsoleEnable (VOID)
	控制台使能更多...

BOOL	is_nonblock (const CONSOLE_CB *consoleCB)

BOOL	IsConsoleOccupied (const CONSOLE_CB *consoleCB)
	控制台是否被占用更多...

INT32	FilepOpen (struct file filep, const struct file_operations_vfs fops)
	打开串口或远程登录更多...

INT32	FilepClose (struct file filep, const struct file_operations_vfs fops)
	关闭串口或远程登录更多...

INT32	FilepRead (struct file filep, const struct file_operations_vfs fops, CHAR *buffer, size_t bufLen)
	从串口或远程登录中读数据更多...

INT32	FilepWrite (struct file filep, const struct file_operations_vfs fops, const CHAR *buffer, size_t bufLen)
	写数据到串口或远程登录更多...

INT32	FilepPoll (struct file filep, const struct file_operations_vfs fops, poll_table *fds)

INT32	FilepIoctl (struct file filep, const struct file_operations_vfs fops, INT32 cmd, unsigned long arg)

INT32	GetFilepOps (const struct file filep, struct file privFilep, const struct file_operations_vfs *fops)

VOID	OsWaitConsoleSendTaskPend (UINT32 taskID)

VOID	OsWakeConsoleSendTask (VOID)
	唤醒控制台发送任务更多...

VOID	KillPgrp (UINT16 consoleId)
	杀死进程组更多...

详细描述

https://www.cnblogs.com/sparkdev/p/11460821.html

TTY 是 Teletype 或 Teletypewriter 的缩写，字符设备的通称,原来是指电传打字机，
后来这种设备逐渐键盘和显示器取代。不管是电传打字机还是键盘,显示器，
都是作为计算机的终端设备存在的，所以 TTY 也泛指计算机的终端(terminal)设备。
为了支持这些 TTY 设备，Linux 实现了一个叫做 TTY 的子系统。所以 TTY 既指终端，也指 Linux 的 TTY 子系统

/dev/console是一个虚拟的tty，在鸿蒙它映射到真正的dev/ttyS0(UART0)上
能直接显示系统消息的那个终端称为控制台，其他的则称为终端

版本

作者: weharmonyos.com | 鸿蒙研究站 | 每天死磕一点点

日期: 2021-12-8

在文件 console.h 中定义.

函数说明

◆ ConsoleEnable()

BOOL ConsoleEnable ( VOID )

控制台使能

ShellEntry是否在运行,其为负责接受来自终端敲入的一个个字符

在文件 console.c 第 1415 行定义.

函数调用图:

这是这个函数的调用关系图:

◆ ConsoleTaskReg()

INT32 ConsoleTaskReg	(	INT32	consoleID,
		UINT32	taskID
	)

任务注册控制台,每个shell任务都有属于自己的控制台

在文件 console.c 第 1454 行定义.

{
    UINT32 intSave;
 
    LOS_SpinLockSave(&g_consoleSpin, &intSave);
    if (!IsShellEntryRunning(g_console[consoleID - 1]->shellEntryId)) {//如果控制台还没有捆绑shell客户端任务 
        g_console[consoleID - 1]->shellEntryId = taskID;    //给控制台捆绑一个shell客户端任务,接受终端输入.
        LOS_SpinUnlockRestore(&g_consoleSpin, intSave);
        (VOID)OsSetCurrProcessGroupID(OsGetUserInitProcessID());// @notethinking 为何要在此处设置当前进程的组ID?
        return LOS_OK;
    }
    LOS_SpinUnlockRestore(&g_consoleSpin, intSave);
    return (g_console[consoleID - 1]->shellEntryId == taskID) ? LOS_OK : LOS_NOK;
}

函数调用图:

这是这个函数的调用关系图:

◆ ConsoleUpdateFd()

INT32 ConsoleUpdateFd ( VOID )

控制台更新文件句柄

在文件 console.c 第 1517 行定义.

{
    INT32 consoleID;
 
    if (OsCurrTaskGet() != NULL) {
        consoleID = g_taskConsoleIDArray[(OsCurrTaskGet())->taskID];//获取当前任务的控制台 (1,2,-1)
    } else {
        return -1;
    }
 
    if (g_uart_fputc_en == 0) {
        if (g_console[CONSOLE_TELNET - 1] != NULL) {
            consoleID = CONSOLE_TELNET;
        }
    } else if (consoleID == 0) {
        if (g_console[CONSOLE_SERIAL - 1] != NULL) {
            consoleID = CONSOLE_SERIAL;
        } else if (g_console[CONSOLE_TELNET - 1] != NULL) {
            consoleID = CONSOLE_TELNET;
        } else {
            PRINTK("No console dev used.\n");
            return -1;
        }
    }
 
    return (g_console[consoleID - 1] != NULL) ? g_console[consoleID - 1]->fd : -1;
}

函数调用图:

◆ FilepClose()

INT32 FilepClose	(	struct file *	filep,
		const struct file_operations_vfs *	fops
	)

关闭串口或远程登录

在文件 console.c 第 545 行定义.

{
    INT32 ret;
    if ((fops == NULL) || (fops->close == NULL)) {
        return -EFAULT;
    }
 
    /*
     * adopt uart close function to open filep (filep is
     * corresponding to filep of /dev/console)
     */
    ret = fops->close(filep);
    return ret < 0 ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ FilepIoctl()

INT32 FilepIoctl	(	struct file *	filep,
		const struct file_operations_vfs *	fops,
		INT32	cmd,
		unsigned long	arg
	)

在文件 console.c 第 560 行定义.

{
    INT32 ret;
    if (fops->ioctl == NULL) {
        return -EFAULT;
    }
 
    ret = fops->ioctl(filep, cmd, arg);
    return (ret < 0) ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ FilepOpen()

INT32 FilepOpen	(	struct file *	filep,
		const struct file_operations_vfs *	fops
	)

打开串口或远程登录

在文件 console.c 第 337 行定义.

{
    INT32 ret;
    if (fops->open == NULL) {
        return -EFAULT;
    }
    //使用 uart open函数打开filep（filep是对应 /dev/console 的 filep)
    /*
     * adopt uart open function to open filep (filep is
     * corresponding to filep of /dev/console)
     */
    ret = fops->open(filep);
    return (ret < 0) ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ FilepPoll()

INT32 FilepPoll	(	struct file *	filep,
		const struct file_operations_vfs *	fops,
		poll_table *	fds
	)

在文件 console.c 第 571 行定义.

{
    INT32 ret;
    if (fops->poll == NULL) {
        return -EFAULT;
    }
 
    /*
     * adopt uart poll function to poll filep (filep is
     * corresponding to filep of /dev/serial)
     */
    ret = fops->poll(filep, fds);
    return (ret < 0) ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ FilepRead()

INT32 FilepRead	(	struct file *	filep,
		const struct file_operations_vfs *	fops,
		CHAR *	buffer,
		size_t	bufLen
	)

从串口或远程登录中读数据

在文件 console.c 第 517 行定义.

{
    INT32 ret;
    if (fops->read == NULL) {
        return -EFAULT;
    }
    /*
     * adopt uart read function to read data from filep
     * and write data to buffer (filep is
     * corresponding to filep of /dev/console)
     *///采用uart read函数从文件中读取数据，将数据写入缓冲区（文件对应/dev/console的filep）
    ret = fops->read(filep, buffer, bufLen);
    return (ret < 0) ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ FilepWrite()

INT32 FilepWrite	(	struct file *	filep,
		const struct file_operations_vfs *	fops,
		const CHAR *	buffer,
		size_t	bufLen
	)

写数据到串口或远程登录

在文件 console.c 第 533 行定义.

{
    INT32 ret;
    if (fops->write == NULL) {
        return -EFAULT;
    }
 
    ret = fops->write(filep, buffer, bufLen);
    return (ret < 0) ? -EPERM : ret;
}

这是这个函数的调用关系图:

◆ GetFilepOps()

INT32 GetFilepOps	(	const struct file *	filep,
		struct file **	privFilep,
		const struct file_operations_vfs **	fops
	)

在文件 console.c 第 93 行定义.

{
    INT32 ret;
 
    if ((filep == NULL) || (filep->f_vnode == NULL) || (filep->f_vnode->data == NULL)) {
        ret = EINVAL;
        goto ERROUT;
    }
    //通过 is_private 查找控制台设备的文件（现在是 *privFile）
    /* to find console device's filep(now it is *privFilep) throught i_private */
    struct drv_data *drv = (struct drv_data *)filep->f_vnode->data;
    *privFilep = (struct file *)drv->priv;// file 例如 g_serialFilep
    if (((*privFilep)->f_vnode == NULL) || ((*privFilep)->f_vnode->data == NULL)) {
        ret = EINVAL;
        goto ERROUT;
    }
 
    /* to find uart driver operation function throutht u.i_opss */
 
    drv = (struct drv_data *)(*privFilep)->f_vnode->data;
 
    *filepOps = (const struct file_operations_vfs *)drv->ops;//拿到串口驱动程序
 
    return ENOERR;
ERROUT:
    set_errno(ret);
    return VFS_ERROR;
}

这是这个函数的调用关系图:

◆ is_nonblock()

BOOL is_nonblock ( const CONSOLE_CB * consoleCB )

在文件 console.c 第 1508 行定义.

{
    if (consoleCB == NULL) {
        PRINT_ERR("%s: Input parameter is illegal\n", __FUNCTION__);
        return FALSE;
    }
    return consoleCB->isNonBlock;
}

这是这个函数的调用关系图:

◆ IsConsoleOccupied()

BOOL IsConsoleOccupied ( const CONSOLE_CB * consoleCB )

控制台是否被占用

在文件 console.c 第 173 行定义.

{
    return ConsoleRefcountGet(consoleCB);
}

函数调用图:

这是这个函数的调用关系图:

◆ KillPgrp()

VOID KillPgrp ( UINT16 consoleId )

杀死进程组

在文件 console.c 第 442 行定义.

{
    if ((consoleId > CONSOLE_NUM) || (consoleId <= 0)) {
        return;
    }
    CONSOLE_CB *consoleCB = g_console[consoleId-1];
    /* the default of consoleCB->pgrpId is -1, may not be set yet, avoid killing all processes */
    if (consoleCB->pgrpId < 0) {
        return;
    }
    (VOID)OsKillLock(consoleCB->pgrpId, SIGINT);//发送信号 SIGINT对应 键盘中断（ctrl + c）信号
}

函数调用图:

这是这个函数的调用关系图:

◆ OsGetConsoleByID()

CONSOLE_CB * OsGetConsoleByID ( INT32 consoleID )

获取参数控制台ID 获取对应的控制台控制块(描述符)

在文件 console.c 第 1546 行定义.

{
    if (consoleID != CONSOLE_TELNET) {//只允许 1,2存在，> 3 时统统变成1
        consoleID = CONSOLE_SERIAL;
    }
    return g_console[consoleID - 1];
}

这是这个函数的调用关系图:

◆ OsGetConsoleByTaskID()

CONSOLE_CB * OsGetConsoleByTaskID ( UINT32 taskID )

获取参数任务的控制台控制块(描述符)

在文件 console.c 第 1554 行定义.

{
    INT32 consoleID = g_taskConsoleIDArray[taskID];
 
    return OsGetConsoleByID(consoleID);
}

函数调用图:

这是这个函数的调用关系图:

◆ OsWaitConsoleSendTaskPend()

VOID OsWaitConsoleSendTaskPend ( UINT32 taskID )

在文件 console.c 第 1633 行定义.

{
    UINT32 i;
    CONSOLE_CB *console = NULL;
    LosTaskCB *taskCB = NULL;
    INT32 waitTime = 3000; /* 3000: 3 seconds */
 
    for (i = 0; i < CONSOLE_NUM; i++) {//轮询控制台
        console = g_console[i];
        if (console == NULL) {
            continue;
        }
 
        if (OS_TID_CHECK_INVALID(console->sendTaskID)) {
            continue;
        }
 
        taskCB = OS_TCB_FROM_TID(console->sendTaskID);
        while ((waitTime > 0) && (taskCB->taskEvent == NULL) && (taskID != console->sendTaskID)) {
            LOS_Mdelay(1); /* 1: wait console task pend */ //等待控制台任务挂起/待办
            --waitTime;
        }
    }
}

函数调用图:

这是这个函数的调用关系图:

◆ OsWakeConsoleSendTask()

VOID OsWakeConsoleSendTask ( VOID )

唤醒控制台发送任务

在文件 console.c 第 1658 行定义.

{
    UINT32 i;
    CONSOLE_CB *console = NULL;
 
    for (i = 0; i < CONSOLE_NUM; i++) {//循环控制台数量，只有2个
        console = g_console[i];
        if (console == NULL) {
            continue;
        }
 
        if (console->cirBufSendCB != NULL) {//循环缓存描述符
            (VOID)LOS_EventWrite(&console->cirBufSendCB->sendEvent, CONSOLE_CIRBUF_EVENT);//写循环缓存区buf事件
        }
    }
}

函数调用图:

这是这个函数的调用关系图:

◆ SetSerialBlock()

BOOL SetSerialBlock ( const CONSOLE_CB * consoleCB )

锁方式设置串口

在文件 console.c 第 1479 行定义.

{
    if (consoleCB == NULL) {
        PRINT_ERR("%s: Input parameter is illegal\n", __FUNCTION__);
        return TRUE;
    }
    return ioctl(consoleCB->fd, CONSOLE_CMD_RD_BLOCK_SERIAL, CONSOLE_RD_BLOCK) != 0;
}

这是这个函数的调用关系图:

◆ SetSerialNonBlock()

BOOL SetSerialNonBlock ( const CONSOLE_CB * consoleCB )

无锁方式设置串口

在文件 console.c 第 1469 行定义.

{
    if (consoleCB == NULL) {
        PRINT_ERR("%s: Input parameter is illegal\n", __FUNCTION__);
        return FALSE;
    }
    return ioctl(consoleCB->fd, CONSOLE_CMD_RD_BLOCK_SERIAL, CONSOLE_RD_NONBLOCK) == 0;
}

◆ SetTelnetBlock()

BOOL SetTelnetBlock ( const CONSOLE_CB * consoleCB )

锁方式设置远程登录

在文件 console.c 第 1499 行定义.

{
    if (consoleCB == NULL) {
        PRINT_ERR("%s: Input parameter is illegal\n", __FUNCTION__);
        return TRUE;
    }
    return ioctl(consoleCB->fd, CONSOLE_CMD_RD_BLOCK_TELNET, CONSOLE_RD_BLOCK) != 0;
}

这是这个函数的调用关系图:

◆ SetTelnetNonBlock()

BOOL SetTelnetNonBlock ( const CONSOLE_CB * consoleCB )

无锁方式设置远程登录

在文件 console.c 第 1489 行定义.

{
    if (consoleCB == NULL) {
        PRINT_ERR("%s: Input parameter is illegal\n", __FUNCTION__);
        return FALSE;
    }
    return ioctl(consoleCB->fd, CONSOLE_CMD_RD_BLOCK_TELNET, CONSOLE_RD_NONBLOCK) == 0;
}

◆ system_console_deinit()

INT32 system_console_deinit ( const CHAR * deviceName )

控制台结束前的处理和 system_console_init成对出现,像控制台的析构函数

在文件 console.c 第 1375 行定义.

{
    UINT32 ret;
    CONSOLE_CB *consoleCB = NULL;
    UINT32 taskIdx;
    LosTaskCB *taskCB = NULL;
    UINT32 intSave;
 
    consoleCB = OsGetConsoleByDevice(deviceName);//通过设备名称获取控制台描述符
    if (consoleCB == NULL) {
        return VFS_ERROR;
    }
 
#ifdef LOSCFG_SHELL
    (VOID)OsShellDeinit((INT32)consoleCB->consoleID);//shell结束前的处理，shell的析构函数
#endif
 
    LOS_SpinLockSave(&g_consoleSpin, &intSave);
    /* Redirect all tasks to serial as telnet was unavailable after deinitializing */
    //在远程登陆去初始化后变成无效时，将所有任务的控制台重定向到串口方式。
    for (taskIdx = 0; taskIdx < g_taskMaxNum; taskIdx++) {//这里是对所有的任务控制台方式设为串口化
        taskCB = ((LosTaskCB *)g_taskCBArray) + taskIdx;
        if (OsTaskIsUnused(taskCB)) {//任务还没被使用过
            continue;//继续
        } else {
            g_taskConsoleIDArray[taskCB->taskID] = CONSOLE_SERIAL;//任务对于的控制台变成串口方式
        }
    }
    g_console[consoleCB->consoleID - 1] = NULL;
    LOS_SpinUnlockRestore(&g_consoleSpin, intSave);
 
    ret = OsConsoleDelete(consoleCB);//删除控制台
    if (ret != LOS_OK) {
        PRINT_ERR("%s, Failed to system_console_deinit\n", __FUNCTION__);
        return VFS_ERROR;
    }
 
    return ENOERR;
}

函数调用图:

这是这个函数的调用关系图:

◆ system_console_init()

INT32 system_console_init ( const CHAR * deviceName )

https://man7.org/linux/man-pages/man3/tcflow.3.html termios 是在POSIX规范中定义的标准接口，表示终端设备，包括虚拟终端、串口等。串口通过termios进行配置。 struct termios { unsigned short c_iflag; // 输入模式标志 unsigned short c_oflag; // 输出模式标志 unsigned short c_cflag; // 控制模式标志 unsigned short c_lflag; // 本地模式标志例如: 设置非规范模式 tios.c_lflag = ~(ICANON | ECHO | ECHOE | ISIG); unsigned char c_line; // 线路规程 unsigned char c_cc[NCC]; // 控制特性 speed_t c_ispeed; // 输入速度 speed_t c_ospeed; // 输出速度 } 终端有三种工作模式：规范模式（canonical mode）、非规范模式（non-canonical mode）原始模式（raw mode）。 https://www.jianshu.com/p/fe5812469801 https://blog.csdn.net/wumenglu1018/article/details/53098794

在文件 console.c 第 1329 行定义.

{
#ifdef LOSCFG_SHELL
    UINT32 ret;
#endif
    INT32 consoleID;
    UINT32 intSave;
    CONSOLE_CB *consoleCB = NULL;
 
    consoleID = OsGetConsoleID(deviceName);//获取控制台ID 返回[ CONSOLE_SERIAL(1) | CONSOLE_TELNET(2) | -1 ]三种结果
    if (consoleID == -1) {
        PRINT_ERR("device is full.\n");
        return VFS_ERROR;
    }
 
    consoleCB = OsConsoleCreate((UINT32)consoleID, deviceName);//创建一个控制台
    if (consoleCB == NULL) {
        PRINT_ERR("%s, %d\n", __FUNCTION__, __LINE__);
        return VFS_ERROR;
    }
 
    LOS_SpinLockSave(&g_consoleSpin, &intSave);
    g_console[consoleID - 1] = consoleCB;//全局变量,  g_console最大值只有2 ,所有任务共用控制台.
    if (OsCurrTaskGet() != NULL) {//当前task
        g_taskConsoleIDArray[OsCurrTaskGet()->taskID] = (UINT8)consoleID;//任务绑定控制台ID
    }
    LOS_SpinUnlockRestore(&g_consoleSpin, intSave);
 
#ifdef LOSCFG_SHELL //shell支持
    ret = OsShellInit(consoleID);//初始化shell
    if (ret != LOS_OK) {//初始化shell失败
        PRINT_ERR("%s, %d\n", __FUNCTION__, __LINE__);
        LOS_SpinLockSave(&g_consoleSpin, &intSave);
        (VOID)OsConsoleDelete(consoleCB);//删除控制台
        g_console[consoleID - 1] = NULL;
        if (OsCurrTaskGet() != NULL) {
            g_taskConsoleIDArray[OsCurrTaskGet()->taskID] = 0;//表示当前任务还没有控制台。
        }
        LOS_SpinUnlockRestore(&g_consoleSpin, intSave);
        return VFS_ERROR;
    }
#endif
 
    return ENOERR;
}

函数调用图:

这是这个函数的调用关系图:

结构体

函数

详细描述

函数说明

◆ ConsoleEnable()

◆ ConsoleTaskReg()

◆ ConsoleUpdateFd()

◆ FilepClose()

◆ FilepIoctl()

◆ FilepOpen()

◆ FilepPoll()

◆ FilepRead()

◆ FilepWrite()

◆ GetFilepOps()

◆ is_nonblock()

◆ IsConsoleOccupied()

◆ KillPgrp()

◆ OsGetConsoleByID()

◆ OsGetConsoleByTaskID()

◆ OsWaitConsoleSendTaskPend()

◆ OsWakeConsoleSendTask()

◆ SetSerialBlock()

◆ SetSerialNonBlock()

◆ SetTelnetBlock()

◆ SetTelnetNonBlock()

◆ system_console_deinit()

◆ system_console_init()