• 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 _LITEIPC_H
33 #define _LITEIPC_H
34 
35 #include <stdint.h>
36 
37 #define LITEIPC_DRIVER "/dev/lite_ipc"
38 
39 typedef enum { OBJ_FD, OBJ_PTR, OBJ_SVC } ObjType;
40 
41 typedef struct {
42     uint32_t buffSz;
43     void *buff;
44 } BuffPtr;
45 
46 typedef struct {
47     uint32_t handle;
48     uint32_t token;
49     uint32_t cookie;
50 } SvcIdentity;
51 
52 typedef union {
53     uint32_t fd;
54     BuffPtr ptr;
55     SvcIdentity svc;
56 } ObjContent;
57 
58 typedef struct {
59     ObjType type;
60     ObjContent content;
61 } SpecialObj;
62 
63 typedef enum { MT_REQUEST, MT_REPLY, MT_FAILED_REPLY, MT_DEATH_NOTIFY } MsgType;
64 typedef enum { CMS_GEN_HANDLE, CMS_REMOVE_HANDLE, CMS_ADD_ACCESS } CmsCmd;
65 
66 /* lite ipc ioctl */
67 #define IPC_IOC_MAGIC   'i'
68 #define IPC_SET_CMS         _IO(IPC_IOC_MAGIC, 1)
69 #define IPC_CMS_CMD         _IOWR(IPC_IOC_MAGIC, 2, CmsCmdContent)
70 #define IPC_SET_IPC_THREAD  _IO(IPC_IOC_MAGIC, 3)
71 #define IPC_SEND_RECV_MSG   _IOWR(IPC_IOC_MAGIC, 4, IpcContent)
72 
73 typedef struct {
74     CmsCmd cmd;
75     uint32_t taskID;
76     uint32_t serviceHandle;
77 } CmsCmdContent;
78 
79 typedef struct {
80     MsgType type;       /**< cmd type, decide the data structure below */
81     SvcIdentity target; /**< serviceHandle or targetTaskId, depending on type */
82     uint32_t code;
83     uint32_t flag;
84 #if (USE_TIMESTAMP == 1)
85     uint64_t timestamp;
86 #endif
87     uint32_t dataSz;    /**< size of data */
88     void* data;
89     uint32_t spObjNum;
90     void* offsets;
91     uint32_t processID; /**< filled by kernel, processId of sender/receiver */
92     uint32_t taskID;    /**< filled by kernel, taskId of sender/receiver */
93 #ifdef LOSCFG_SECURITY_CAPABILITY
94     uint32_t userID;
95     uint32_t gid;
96 #endif
97 } IpcMsg;
98 
99 #define SEND (1 << 0)
100 #define RECV (1 << 1)
101 #define BUFF_FREE (1 << 2)
102 
103 typedef struct {
104     uint32_t flag;
105     IpcMsg *outMsg; /**< data to send to target */
106     IpcMsg *inMsg;  /**< data reply by target */
107     void *buffToFree;
108 } IpcContent;
109 
110 #endif //_LITEIPC_H