1 /*
2  * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3  * Copyright (c) 2020-2022 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 #ifdef LOSCFG_ENABLE_MAGICKEY
38 
39 #define MAGIC_KEY_NUM 5
40 STATIC VOID OsMagicHelp(VOID);
41 STATIC VOID OsMagicTaskShow(VOID);
42 STATIC VOID OsMagicPanic(VOID);
43 STATIC VOID OsMagicMemCheck(VOID);
44 
45 STATIC MagicKeyOp g_magicMemCheckOp = {
46     .opHandler = OsMagicMemCheck,
47     .helpMsg = "Check system memory(ctrl+e) ",
48     .magicKey = 0x05 /* ctrl + e */
49 };
50 
51 STATIC MagicKeyOp g_magicPanicOp = {
52     .opHandler = OsMagicPanic,
53     .helpMsg = "System panic(ctrl+p) ",
54     .magicKey = 0x10 /* ctrl + p */
55 };
56 
57 STATIC MagicKeyOp g_magicTaskShowOp = {
58     .opHandler = OsMagicTaskShow,
59     .helpMsg = "Show task information(ctrl+t) ",
60     .magicKey = 0x14 /* ctrl + t */
61 };
62 
63 STATIC MagicKeyOp g_magicHelpOp = {
64     .opHandler = OsMagicHelp,
65     .helpMsg = "Show all magic op key(ctrl+z) ",
66     .magicKey = 0x1a /* ctrl + z */
67 };
68 
69 /*
70  * NOTICE:Suggest don't use
71  * ctrl+h/backspace=0x8,
72  * ctrl+i/tab=0x9,
73  * ctrl+m/enter=0xd,
74  * ctrl+n/shift out=0xe,
75  * ctrl+o/shift in=0xf,
76  * ctrl+[/esc=0x1b,
77  * ctrl+] used for telnet command mode;
78  */
79 STATIC MagicKeyOp *g_magicOpTable[MAGIC_KEY_NUM] = {
80     &g_magicMemCheckOp, /* ctrl + e */
81     &g_magicPanicOp,    /* ctrl + p */
82     &g_magicTaskShowOp, /* ctrl + t */
83     &g_magicHelpOp,     /* ctrl + z */
84     NULL
85 };
86 
OsMagicHelpnull87 STATIC VOID OsMagicHelp(VOID)
88 {
89     INT32 i;
90     PRINTK("HELP: ");
91     for (i = 0; g_magicOpTable[i] != NULL; ++i) {
92         PRINTK("%s ", g_magicOpTable[i]->helpMsg);
93     }
94     PRINTK("\n");
95     return;
96 }
97 
OsMagicTaskShownull98 STATIC VOID OsMagicTaskShow(VOID)
99 {
100     (VOID)OsShellCmdTskInfoGet(OS_ALL_TASK_MASK, NULL, OS_PROCESS_INFO_ALL);
101     return;
102 }
103 
OsMagicPanicnull104 STATIC VOID OsMagicPanic(VOID)
105 {
106     LOS_Panic("Magic key :\n");
107     return;
108 }
109 
OsMagicMemChecknull110 STATIC VOID OsMagicMemCheck(VOID)
111 {
112     if (LOS_MemIntegrityCheck(m_aucSysMem1) == LOS_OK) {
113         PrintExcInfo("system memcheck over, all passed!\n");
114     }
115     return;
116 }
117 #endif
118 
CheckMagicKey(CHAR key, UINT16 consoleId)119 INT32 CheckMagicKey(CHAR key, UINT16 consoleId)
120 {
121 #ifdef LOSCFG_ENABLE_MAGICKEY
122     INT32 i;
123     STATIC UINT32 magicKeySwitch = 0;
124 
125     if (key == 0x03) { /* ctrl + c */
126         KillPgrp(consoleId);
127         return 0;
128     } else if (key == 0x12) { /* ctrl + r */
129         magicKeySwitch = ~magicKeySwitch;
130         if (magicKeySwitch != 0) {
131             PrintExcInfo("Magic key on\n");
132         } else {
133             PrintExcInfo("Magic key off\n");
134         }
135         return 1;
136     }
137     if (magicKeySwitch != 0) {
138         for (i = 0; i < MAGIC_KEY_NUM; i++) {
139             if (g_magicOpTable[i] != NULL && key == g_magicOpTable[i]->magicKey) {
140                 (g_magicOpTable[i])->opHandler();
141                 return 1;
142             }
143         }
144     }
145 #endif
146     return 0;
147 }
148