更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
los_magickey.c
浏览该文件的文档.
1/*
2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 * conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 * of conditions and the following disclaimer in the documentation and/or other materials
13 * provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 * to endorse or promote products derived from this software without specific prior written
17 * permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#include "los_magickey.h"
33#include "console.h"
34#include "los_task_pri.h"
35#include "los_process_pri.h"
36
37/// 魔法键依赖于宏LOSCFG_ENABLE_MAGICKEY,使用时通过menuconfig在配置项中开启“Enable MAGIC KEY”:
38/// Debug ---> Enable MAGIC KEY;若关闭该选项,则魔法键失效。
39#ifdef LOSCFG_ENABLE_MAGICKEY
40
41#define MAGIC_KEY_NUM 5
42
43STATIC VOID OsMagicHelp(VOID);
44STATIC VOID OsMagicTaskShow(VOID);
45STATIC VOID OsMagicPanic(VOID);
46STATIC VOID OsMagicMemCheck(VOID);
47
48STATIC MagicKeyOp g_magicMemCheckOp = {//快捷键内存检查
49 .opHandler = OsMagicMemCheck, //等于执行了一次 shell memcheck
50 .helpMsg = "Check system memory(ctrl+e) ",
51 .magicKey = 0x05 /* ctrl + e */ //系统进行简单完整性内存池检查,检查出错会输出相关错误信息,检查正常会输出“system memcheck over, all passed!”
52};
53
54STATIC MagicKeyOp g_magicPanicOp = {//panic 表示kernel走到了一个不知道该怎么走下一步的状况,
55 .opHandler = OsMagicPanic, //一旦到这个情况,kernel就尽可能把它此时能获取的全部信息都打印出来.
56 .helpMsg = "System panic(ctrl+p) ",
57 .magicKey = 0x10 /* ctrl + p */ //系统主动进入panic,输出panic相关信息后,系统会挂住;
58};
59
60STATIC MagicKeyOp g_magicTaskShowOp = { //快捷键显示任务操作
61 .opHandler = OsMagicTaskShow, //等于执行了一次 shell task -a
62 .helpMsg = "Show task information(ctrl+t) ",
63 .magicKey = 0x14 /* ctrl + t */ //输出任务相关信息;
64};
65
66STATIC MagicKeyOp g_magicHelpOp = { //快捷键帮助操作
68 .helpMsg = "Show all magic op key(ctrl+z) ",
69 .magicKey = 0x1a /* ctrl + z */ //帮助键,输出相关魔法键简单介绍;
70};
71
72/*
73 * NOTICE:Suggest don't use
74 * ctrl+h/backspace=0x8,
75 * ctrl+i/tab=0x9,
76 * ctrl+m/enter=0xd,
77 * ctrl+n/shift out=0xe,
78 * ctrl+o/shift in=0xf,
79 * ctrl+[/esc=0x1b,
80 * ctrl+] used for telnet commond mode;
81 */
82STATIC MagicKeyOp *g_magicOpTable[MAGIC_KEY_NUM] = {
83 &g_magicMemCheckOp, /* ctrl + e */
84 &g_magicPanicOp, /* ctrl + p */
85 &g_magicTaskShowOp, /* ctrl + t */
86 &g_magicHelpOp, /* ctrl + z */
87 NULL
88};
89
90STATIC VOID OsMagicHelp(VOID)//遍历一下 g_magicOpTable
91{
92 INT32 i;
93 PRINTK("HELP: ");
94 for (i = 0; g_magicOpTable[i] != NULL; ++i) {
95 PRINTK("%s ", g_magicOpTable[i]->helpMsg);
96 }
97 PRINTK("\n");
98 return;
99}
100///执行 shell task -a 命令
101STATIC VOID OsMagicTaskShow(VOID)
102{
103 (VOID)OsShellCmdTskInfoGet(OS_ALL_TASK_MASK, NULL, OS_PROCESS_INFO_ALL);
104 return;
105}
106
107STATIC VOID OsMagicPanic(VOID)
108{
109 LOS_Panic("Magic key :\n");
110 return;
111}
112///快捷键触发内存检查
113STATIC VOID OsMagicMemCheck(VOID)
114{
115 if (LOS_MemIntegrityCheck(m_aucSysMem1) == LOS_OK) {
116 PrintExcInfo("system memcheck over, all passed!\n");
117 }
118 return;
119}
120#endif
121///检查魔法键
123{
124#ifdef LOSCFG_ENABLE_MAGICKEY //魔法键开关
125 INT32 i;
126 STATIC UINT32 magicKeySwitch = 0;
127
128 if (key == 0x03) { /* ctrl + c */
129 KillPgrp(consoleId);
130 return 0;
131 } else if (key == 0x12) { /* ctrl + r */
132 // 在连接UART或者USB转虚拟串口的情况下,输入“ctrl + r” 键,打开魔法键检测功能,输出 “Magic key on”;再输入一次后,
133 // 则关闭魔法键检测功能,输出“Magic key off”。
134 magicKeySwitch = ~magicKeySwitch;
135 if (magicKeySwitch != 0) {
136 PrintExcInfo("Magic key on\n");
137 } else {
138 PrintExcInfo("Magic key off\n");
139 }
140 return 1;
141 }
142 if (magicKeySwitch != 0) {//打开情况下,输出魔法键各回调函数
143 for (i = 0; i < MAGIC_KEY_NUM; i++) {
144 if (g_magicOpTable[i] != NULL && key == g_magicOpTable[i]->magicKey) {
145 (g_magicOpTable[i])->opHandler();//执行回调函数 OsMagicHelp ,OsMagicTaskShow ==
146 return 1;
147 }
148 }
149 }
150#endif
151 return 0;
152}
VOID KillPgrp(UINT16 consoleId)
杀死进程组
Definition: console.c:442
NORETURN VOID LOS_Panic(const CHAR *fmt,...)
Kernel panic function.
UINT8 * m_aucSysMem1
系统动态内存池地址的起始地址 @note_thinking 能否不要用 0,1来命名核心变量 ???
Definition: los_memory.c:108
UINT32 LOS_MemIntegrityCheck(const VOID *pool)
对指定内存池做完整性检查
Definition: los_memory.c:1903
STATIC MagicKeyOp * g_magicOpTable[MAGIC_KEY_NUM]
Definition: los_magickey.c:82
STATIC MagicKeyOp g_magicMemCheckOp
Definition: los_magickey.c:48
STATIC MagicKeyOp g_magicPanicOp
Definition: los_magickey.c:54
INT32 CheckMagicKey(CHAR key, UINT16 consoleId)
检查魔法键
Definition: los_magickey.c:122
STATIC VOID OsMagicHelp(VOID)
Definition: los_magickey.c:90
STATIC VOID OsMagicPanic(VOID)
Definition: los_magickey.c:107
STATIC VOID OsMagicTaskShow(VOID)
执行 shell task -a 命令
Definition: los_magickey.c:101
STATIC VOID OsMagicMemCheck(VOID)
快捷键触发内存检查
Definition: los_magickey.c:113
STATIC MagicKeyOp g_magicHelpOp
Definition: los_magickey.c:66
STATIC MagicKeyOp g_magicTaskShowOp
Definition: los_magickey.c:60
VOID PrintExcInfo(const CHAR *fmt,...)
打印异常信息
Definition: los_printf.c:263
UINT32 OsShellCmdTskInfoGet(UINT32 taskID, VOID *seqfile, UINT16 flag)
unsigned short UINT16
Definition: los_typedef.h:56
signed int INT32
Definition: los_typedef.h:60
unsigned int UINT32
Definition: los_typedef.h:57
char CHAR
Definition: los_typedef.h:63
VOID(* opHandler)(VOID)
Definition: los_magickey.h:44