• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 _TELNET_DEV_H
33 #define _TELNET_DEV_H
34 
35 #include "los_config.h"
36 #include "linux/wait.h"
37 
38 #ifdef __cplusplus
39 #if __cplusplus
40 extern "C" {
41 #endif /* __cplusplus */
42 #endif /* __cplusplus */
43 
44 #ifdef LOSCFG_NET_TELNET
45 
46 #define TELNET                 "/dev/telnet"
47 
48 #define FIFO_MAX               1024
49 #define TELNET_IOC_MAGIC       't'
50 #define CFG_TELNET_SET_FD      _IO(TELNET_IOC_MAGIC, 1)
51 #define CFG_TELNET_EVENT_PEND  CONSOLE_CMD_RD_BLOCK_TELNET
52 #define BLOCK_DISABLE          0
53 #define BLOCK_ENABLE           1
54 
55 typedef struct {
56     UINT32 rxIndex;         /* index for receiving user's commands */
57     UINT32 rxOutIndex;      /* index for taking out commands by a shell task to run */
58     UINT32 fifoNum;         /* unused size of the cmdBuf */
59     UINT32 lock;
60     CHAR rxBuf[FIFO_MAX];   /* the real buffer to store user's commands */
61 } TELNTE_FIFO_S;
62 
63 typedef struct {
64     INT32 clientFd;
65     UINT32 id;
66     BOOL eventPend;
67     EVENT_CB_S eventTelnet;
68     wait_queue_head_t wait;
69     TELNTE_FIFO_S *cmdFifo;  /* use a FIFO to store user's commands */
70 } TELNET_DEV_S;
71 
72 extern INT32 TelnetTx(const CHAR *buf, UINT32 len);
73 extern INT32 TelnetDevInit(INT32 fd);
74 extern INT32 TelnetDevDeinit(VOID);
75 extern INT32 TelnetedRegister(VOID);
76 extern INT32 TelnetedUnregister(VOID);
77 #endif
78 
79 #ifdef __cplusplus
80 #if __cplusplus
81 }
82 #endif /* __cplusplus */
83 #endif /* __cplusplus */
84 
85 #endif
86