1 /*
2 * Copyright (C) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #ifndef NSTACKX_DFILE_FRAME_H
17 #define NSTACKX_DFILE_FRAME_H
18
19 #include "nstackx_file_list.h"
20 #include "nstackx_congestion.h"
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 /* RST_CODE */
27 #define NSTACKX_DFILE_NO_ERROR 200
28 #define NSTACKX_DFILE_WITHOUT_SETTING_ERROR 201
29 #define NSTACKX_DFILE_FILE_WRITE_ERROR 202
30 #define NSTACKX_DFILE_FILE_READ_ERROR 203
31 #define NSTACKX_DFILE_NO_ENOUGH_STORAGE_ERROR 204
32 #define NSTACKX_DFILE_INTERNAL_ERROR 209
33 #define NSTACKX_DFILE_CANCEL_ERROR 210
34
35 #define NSTACKX_DFILE_HEADER_FRAME_USER_DATA_FLAG 0x1
36 #define NSTACKX_DFILE_HEADER_FRAME_PATH_TYPE_FLAG 0x2
37 #define NSTACKX_DFILE_HEADER_FRAME_NO_SYNC_FLAG 0x4
38 #define NSTACKX_DFILE_HEADER_FRAME_VTRANS_FLAG 0x8
39
40 #define NSTACKX_DFILE_DATA_FRAME_START_FLAG 0x0
41 #define NSTACKX_DFILE_DATA_FRAME_CONTINUE_FLAG 0x1
42 #define NSTACKX_DFILE_DATA_FRAME_END_FLAG 0x3
43 #define NSTACKX_DFILE_DATA_FRAME_RETRAN_FLAG 0x4
44
45 #define NSTACKX_DFILE_ACK_RETRAN_FILE_FLAG 0x1
46
47 #define NSTACKX_RESERVED_FILE_ID 0
48 #define NSTACKX_FIRST_FILE_ID 1
49
50 #define NSTACKX_MAX_FRAME_SIZE 14720
51 #define NSTACKX_DEFAULT_FRAME_SIZE 1472
52 #define NSTACKX_MAX_USER_DATA_SIZE 1024
53 #define NSTACKX_MAX_FILE_SIZE (0x7FFFFFFFFF) /* Max file size 512GB */
54 #define NSTACKX_MIN_MTU_SIZE 64
55
56 typedef enum {
57 NSTACKX_DFILE_FILE_HEADER_FRAME = 1,
58 NSTACKX_DFILE_FILE_HEADER_CONFIRM_FRAME,
59 NSTACKX_DFILE_FILE_TRANSFER_REQ_FRAME,
60 NSTACKX_DFILE_FILE_DATA_FRAME,
61 NSTACKX_DFILE_FILE_DATA_ACK_FRAME,
62 NSTACKX_DFILE_FILE_TRANSFER_DONE_FRAME,
63 NSTACKX_DFILE_FILE_TRANSFER_DONE_ACK_FRAME,
64 NSTACKX_DFILE_SETTING_FRAME,
65 NSTACKX_DFILE_RST_FRAME,
66 NSTACKX_DFILE_FLOW_CONTROL_FRAME,
67 NSTACKX_DFILE_CONGESTION_CONTROL_FRAME,
68 NSTACKX_DFILE_PEER_DOWN_FRAME,
69 NSTACKX_DFILE_FILE_BACK_PRESSURE_FRAME,
70 NSTACKX_DFILE_TYPE_MAX
71 } DFileFrameType;
72
73 #pragma pack(push, 1)
74 typedef struct {
75 uint8_t type;
76 uint8_t flag;
77 uint16_t sessionId;
78 uint16_t transId;
79 uint16_t length;
80 } DFileFrameHeader;
81
82 #define DFILE_FRAME_HEADER_LEN sizeof(DFileFrameHeader)
83
84 typedef struct {
85 uint16_t fileId;
86 uint64_t fileSize;
87 uint16_t fileNameLength;
88 uint8_t fileName[0];
89 } FileInfoUnit;
90
91 typedef struct {
92 uint16_t fileId;
93 uint64_t fileSize;
94 uint16_t fileNameLength;
95 uint64_t startOffset;
96 uint8_t fileName[0];
97 } FileInfoUnitMp;
98
99 typedef struct {
100 uint16_t pathType;
101 uint8_t userData[0];
102 } UserDataUnit;
103
104 typedef struct {
105 DFileFrameHeader header;
106 uint16_t nodeNumber;
107 uint8_t fileInfoUnit[0];
108 } FileHeaderFrame;
109
110 typedef struct {
111 DFileFrameHeader header;
112 uint16_t fileId[0];
113 } FileHeaderConfirmFrame;
114
115 typedef struct {
116 DFileFrameHeader header;
117 uint16_t fileId[0];
118 } FileTransferReqFrame;
119
120 typedef struct {
121 DFileFrameHeader header;
122 uint16_t fileId;
123 uint32_t blockSequence;
124 uint8_t blockPayload[0];
125 } FileDataFrame;
126
127 typedef struct {
128 DFileFrameHeader header;
129 uint16_t fileId;
130 uint32_t blockSequence;
131 uint32_t linkSequence;
132 uint8_t socketIndex;
133 uint8_t blockPayload[0];
134 } FileDataFrameZS;
135
136 typedef struct {
137 uint8_t recvListOverIo;
138 uint8_t recvBufThreshold; /* for reserved */
139 uint32_t stopSendPeriod;
140 } DataBackPressure;
141
142 typedef struct {
143 DFileFrameHeader header;
144 DataBackPressure backPressure;
145 } BackPressureFrame;
146
147 typedef struct {
148 DFileFrameHeader header;
149 uint16_t fileId[0];
150 } FileTransferDoneFrame;
151
152 typedef struct {
153 DFileFrameHeader header;
154 uint16_t fileId[0];
155 } FileTransferDoneAckFrame;
156
157 #define VERSION_STR_LEN 64
158 typedef struct {
159 DFileFrameHeader header;
160 uint16_t mtu;
161 uint16_t connType;
162 uint32_t dFileVersion;
163 uint32_t abmCapability; /* keep the same format of SettingFrame with Hicomm branch */
164 uint32_t capability;
165 uint32_t dataFrameSize;
166 uint32_t capsCheck;
167 char productVersion[VERSION_STR_LEN]; /* DFX */
168 uint8_t isSupport160M;
169 uint8_t isSupportMtp;
170 uint8_t mtpPort;
171 uint8_t headerEnc;
172 uint32_t mtpCapability;
173 uint32_t cipherCapability;
174 } SettingFrame;
175
176 typedef struct {
177 DFileFrameHeader header;
178 uint16_t code;
179 uint16_t fileId[0];
180 } RstFrame;
181
182 typedef struct {
183 DFileFrameHeader header;
184 WifiStationInfo wifiStationInfo;
185 RamInfo ramInfo;
186 } CongestionControlFrame;
187 #pragma pack(pop)
188
189 typedef struct {
190 uint32_t flowCtrlType;
191 uint32_t kernelRecvQueueDropPacket;
192 uint32_t kernelRecvQueueRate;
193 uint32_t appProcessQueueRatio;
194 uint32_t appProcessQueueRate;
195 uint32_t sysTemperature;
196 } FlowCtrlInfo;
197
198 #pragma pack(push, 1)
199 typedef struct {
200 DFileFrameHeader header;
201 FlowCtrlInfo flowCtrlInfo;
202 } FlowCtrlFrame;
203
204 typedef struct {
205 DFileFrameHeader header;
206 uint8_t payload[0];
207 } DFileFrame;
208 #pragma pack(pop)
209
SetDfileFrameTransID(DFileFrame * dFileFrame,uint16_t value)210 static inline void SetDfileFrameTransID(DFileFrame *dFileFrame, uint16_t value)
211 {
212 (dFileFrame)->header.transId = htons(value);
213 return;
214 }
215
SetDfileFrameUserDataFlag(DFileFrameHeader * header)216 static inline void SetDfileFrameUserDataFlag(DFileFrameHeader *header)
217 {
218 header->flag |= NSTACKX_DFILE_HEADER_FRAME_USER_DATA_FLAG;
219 return;
220 }
221
SetDfileFramePathTypeFlag(DFileFrameHeader * header)222 static inline void SetDfileFramePathTypeFlag(DFileFrameHeader *header)
223 {
224 header->flag |= NSTACKX_DFILE_HEADER_FRAME_PATH_TYPE_FLAG;
225 return;
226 }
227
SetDfileFrameNoSyncFlag(DFileFrameHeader * header)228 static inline void SetDfileFrameNoSyncFlag(DFileFrameHeader *header)
229 {
230 header->flag |= NSTACKX_DFILE_HEADER_FRAME_NO_SYNC_FLAG;
231 }
232
CheckDfileFrameEndFlag(FileDataFrame * fileDataFrame)233 static inline uint8_t CheckDfileFrameEndFlag(FileDataFrame *fileDataFrame)
234 {
235 return (((fileDataFrame)->header.flag & NSTACKX_DFILE_DATA_FRAME_END_FLAG) == NSTACKX_DFILE_DATA_FRAME_END_FLAG);
236 }
237
238 const char *GetFrameName(DFileFrameType frameType);
239 void EncodeFileHeaderFrame(FileList *fileList, int32_t *fileId, uint8_t *buffer, size_t length, size_t *frameLength);
240 void EncodeFileHeaderConfirmFrame(FileList *fileList, uint16_t *fileId, uint8_t *buffer, size_t length,
241 size_t *frameLength);
242 int32_t EncodeFileDataFrame(FileList *fileList, uint16_t fileId, uint8_t *buffer, size_t length, size_t *frameLength);
243 void EncodeFileTransferDoneFrame(uint8_t *buffer, size_t length, uint16_t fileIdList[], uint32_t fileIdNum,
244 size_t *frameLength);
245 void EncodeFileTransferDoneAckFrame(uint8_t *buffer, size_t length, uint16_t transId, size_t *frameLength);
246 void EncodeSettingFrame(uint8_t *buffer, size_t length, size_t *frameLength, const SettingFrame *settingFramePara);
247 void EncodeRstFrame(uint8_t *buffer, size_t length, size_t *frameLength, uint16_t transId, uint16_t errCode);
248 void EncodeBackPressFrame(uint8_t *buffer, size_t length, size_t *frameLength, uint8_t recvListOverIo);
249 int32_t DecodeDFileFrame(const uint8_t *buffer, size_t bufferLength, DFileFrame **frame);
250 int32_t DecodeFileHeaderFrame(FileList *fileList, FileHeaderFrame *headerFrame);
251 int32_t DecodeFileHeaderConfirmFrame(FileList *fileList, FileHeaderConfirmFrame *confirmFrame);
252 int32_t DecodeFileDataFrame(FileList *fileList, FileDataFrame *dataFrame);
253 int16_t GetFileIdFromFileDataFrame(const FileList *fileList, const FileDataFrame *fileDataFrame);
254 int32_t DecodeFileTransferDoneFrame(FileList *fileList, FileTransferDoneFrame *transferDoneFrame);
255 int32_t DecodeSettingFrame(SettingFrame *netSettingFrame, SettingFrame *hostSettingFrame);
256 int32_t DecodeRstFrame(RstFrame *rstFrame, uint16_t *code, uint16_t **fileIdList, uint16_t *listCount);
257 int32_t DecodeBackPressFrame(const BackPressureFrame *backPressFrame, DataBackPressure *backPressInfo);
258
259 #ifdef __cplusplus
260 }
261 #endif
262
263 #endif /* #ifndef NSTACKX_DFILE_FRAME_H */
264