更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
shmsg.h
浏览该文件的文档.
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#ifndef _SHMSG_H
33#define _SHMSG_H
34
35#include "shell_list.h"
36#include "shell.h"
37
38#ifdef __cplusplus
39#if __cplusplus
40extern "C" {
41#endif /* __cplusplus */
42#endif /* __cplusplus */
43
44#define SHELL_ENTRY_STACKSIZE 0x1000 ///< shell客户端栈大小 4K
45#define SHELL_TASK_STACKSIZE 0x3000 ///< shell服务端栈大小 12K
46
47#define SHELL_EXEC_COMMAND "exec" ///< 运行 elf 命令 例如: exec bin/hello
48#define SHELL_EXEC_COMMAND_BYTES 4
49#define CMD_EXEC_COMMAND SHELL_EXEC_COMMAND" "
50#define CMD_EXEC_COMMAND_BYTES (SHELL_EXEC_COMMAND_BYTES+1)
51#define CMD_EXIT_COMMAND "exit" ///< 退出命令
52#define CMD_EXIT_COMMAND_BYTES 4
53#define CMD_EXIT_CODE_BASE_DEC 10
54
55#define CONSOLE_IOC_MAGIC 'c'
56#define CONSOLE_CONTROL_REG_USERTASK _IO(CONSOLE_IOC_MAGIC, 7) ///< 注册用户任务 shell 客户端
57
58#define COLOR_NONE "\e[0m"
59#define COLOR_RED "\e[0;31m"
60#define COLOR_L_RED "\e[1;31m"
61#define SHELL_PROMPT COLOR_L_RED"OHOS # "COLOR_NONE ///< shell 红色提示 OHOS #
62
63typedef void (* OutputFunc)(const char *fmt, ...);
64extern int ShellTaskInit(ShellCB *shellCB);
65extern void ChildExec(const char *cmdName, char *const paramArray[], bool foreground);
66extern void ShellCmdLineParse(char c, OutputFunc outputFunc, ShellCB *shellCB);
67extern int ShellNotify(ShellCB *shellCB);
68
69#ifdef __cplusplus
70#if __cplusplus
71}
72#endif /* __cplusplus */
73#endif /* __cplusplus */
74
75#endif /* _SHMSG_H */
void ChildExec(const char *cmdName, char *const paramArray[], bool foreground)
Definition: shmsg.c:354
void(* OutputFunc)(const char *fmt,...)
Definition: shmsg.h:63
int ShellTaskInit(ShellCB *shellCB)
给控制台注册一个shell客户端任务
Definition: shmsg.c:628
void ShellCmdLineParse(char c, OutputFunc outputFunc, ShellCB *shellCB)
Definition: shmsg.c:271
int ShellNotify(ShellCB *shellCB)
发送解析事件
Definition: shmsg.c:126
Definition: shell.h:71
ARG_NUM_3 ARG_NUM_1 ARG_NUM_2 ARG_NUM_2 ARG_NUM_3 ARG_NUM_1 ARG_NUM_4 ARG_NUM_2 ARG_NUM_2 ARG_NUM_5 ARG_NUM_2 void