Gitiles
Code Review Sign In
192.168.1.100 / R306 / 2dbc1526a2b84342aa5d5d2a0b7c25c960d13710 / . / cp / ps / modem / tools / inc / commgt_api.h
blob: e00aa75ad01872586d32b9289de0314d8da306d7 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -0700[diff] [blame]1/**
2 *
3 * @file commgt_api.h
4 * @brief
5 * This file is part of tools.
6 * ¹¤¾ßCommAgt½Ó¿Ú¹«¹²ÉùÃ÷
7 *
8 * @details
9 * @author Tools Team.
10 * @email
11 * @copyright Copyright (C) 2013 Sanechips Technology Co., Ltd.
12 * @warning
13 * @date 2019/02/02
14 * @version 1.4
15 * @pre
16 * @post
17 *
18 * @par
19 * Change History :
20 * ---------------------------------------------------------------------------
21 * date version author description
22 * ---------------------------------------------------------------------------
23 * 2013/01/14 1.0 lu.xieji Create file
24 * 2018/09/24 1.1 jiang.fenglin ºË¼äͨÐŹ²ÏíÄÚ´æÓÉ1Mµ÷ÕûΪ512K
25 * 2018/09/25 1.2 dai.kang »·Ðλº³åÇøÄÚ´æÓÉ3.5Mµ÷ÕûΪ2M
26 * 2018/12/25 1.3 dai.kang »·Ðλº³åÇøÄÚ´æÓɾ²Ì¬·ÖÅäµ÷ÕûΪzOss_GetUB¶¯Ì¬·Ö±ð
27 * 2019/02/02 1.4 jiang.fenglin ÐÞ¸Ä×¢ÊÍ·½Ê½Îªdoxygen
28 * 2019/03/11 1.5 dai.kang Ö§³ÖÎïÀí²ãlog + ap<->cp logÇø¼ä¶¯Ì¬·ÖÅä
29 * 2019/05/13 1.6 dai.kang psÓëphy¼äµÄ»·ÐÎbufferÉÏÏÂÐзֿªÉêÇ룻ap²àbuffer¿Õ¼äλÖõ÷Õû
30 * ---------------------------------------------------------------------------
31 *
32 *
33 */
34
35#ifndef COMM_AGT_H_
36#define COMM_AGT_H_
37
38#include "ram_config.h"
39#include "ZspTrace.h"
40
41#define MAX_PACKET_LEN (0x10000)
42#define MAX_ENCODE_PACKET_LEN (MAX_PACKET_LEN * 2)
43
44// Buffer »ùµØÖ·
45extern UINT32 g_zToolAgtBaseDDR;
46
47#define COMM_SEND_BUFFER_BASE_ADDR (g_zToolAgtBaseDDR)
48#define COMM_SEND_BUFFER_SIZE (0x77000)
49
50#define COMM_RECV_BUFFER_BASE_ADDR (COMM_SEND_BUFFER_BASE_ADDR + COMM_SEND_BUFFER_SIZE)
51#define COMM_RECV_BUFFER_SIZE (0x0)
52
53#define COMM_READ_BUFFER_BASE_ADDR (COMM_RECV_BUFFER_BASE_ADDR + COMM_RECV_BUFFER_SIZE)
54#define COMM_READ_BUFFER_SIZE (0x0)
55
56#define COMM_ENCODE_BUFFER_BASE_ADDR (COMM_READ_BUFFER_BASE_ADDR + COMM_READ_BUFFER_SIZE)
57#define COMM_ENCODE_BUFFER_SIZE (0x0)
58
59#define COMM_DECODE_BUFFER_BASE_ADDR (COMM_ENCODE_BUFFER_BASE_ADDR + COMM_ENCODE_BUFFER_SIZE)
60#define COMM_DECODE_BUFFER_SIZE (0x0)
61
62// GSM buff
63#define ZCAT_GSM_BUFFER_BASE_ADDR (COMM_DECODE_BUFFER_BASE_ADDR + COMM_DECODE_BUFFER_SIZE)
64#define ZCAT_GSM_BUFFER_SIZE (0x8000)
65
66
67#define COMM_ARM1_ALL_ADDR (ZCAT_GSM_BUFFER_BASE_ADDR + ZCAT_GSM_BUFFER_SIZE)
68#define COMM_ARM1_ALL_SIZE (0x100)
69#define COMM_ARM1_TICK_ADDR (COMM_ARM1_ALL_ADDR)
70#define COMM_ARM1_TICK_SIZE (0x4)
71#define COMM_ARM1_ORITIME_ADDR (COMM_ARM1_TICK_ADDR + COMM_ARM1_TICK_SIZE)
72#define COMM_ARM1_ORITIME_SIZE (0x4)
73#define COMM_ARM1_ORITICK_ADDR (COMM_ARM1_ORITIME_ADDR + COMM_ARM1_ORITIME_SIZE)
74#define COMM_ARM1_ORITICK_SIZE (0x4)
75
76#if ((COMM_ARM1_TICK_SIZE + COMM_ARM1_ORITIME_SIZE + COMM_ARM1_ORITICK_SIZE) > COMM_ARM1_ALL_SIZE)
77#error "tool ram overflow!"
78#endif
79
80// PS CPU <-->PHY CPU
81#define COMM_PS_TO_PHY_BASE_ADDR (COMM_ARM1_ALL_ADDR + COMM_ARM1_ALL_SIZE)
82#define COMM_PS_TO_PHY_SIZE (0x100)
83
84#define COMM_PHY_TO_PS_BASE_ADDR (COMM_PS_TO_PHY_BASE_ADDR + COMM_PS_TO_PHY_SIZE)
85#define COMM_PHY_TO_PS_SIZE (0x100)
86
87#define ZCAT_KERNEL_TO_CP_BASE_ADDR (COMM_PHY_TO_PS_BASE_ADDR + COMM_PHY_TO_PS_SIZE)
88#define ZCAT_KERNEL_TO_CP_BUFFER_SIZE (0x4000)
89
90#define ZCAT_APP_TO_CP_BASE_ADDR (ZCAT_KERNEL_TO_CP_BASE_ADDR + ZCAT_KERNEL_TO_CP_BUFFER_SIZE)
91#define ZCAT_APP_TO_CP_BUFFER_SIZE (0x4000)
92
93#define COMM_CP_TO_AP_BASE_ADDR (ZCAT_APP_TO_CP_BASE_ADDR + ZCAT_APP_TO_CP_BUFFER_SIZE)
94#ifdef CONFIG_SINGLECORE
95#define COMM_CP_TO_AP_SIZE (0)
96#else
97#define COMM_CP_TO_AP_SIZE (0x20000)
98#endif
99
100#define COMM_AP_TO_CP_BASE_ADDR (COMM_CP_TO_AP_BASE_ADDR + COMM_CP_TO_AP_SIZE)
101#ifdef CONFIG_SINGLECORE
102#define COMM_AP_TO_CP_SIZE (0)
103#else
104#define COMM_AP_TO_CP_SIZE (0x8000)
105#endif
106
107#define TOOL_AGENT_RAM_SIZE (COMM_SEND_BUFFER_SIZE + COMM_RECV_BUFFER_SIZE + COMM_READ_BUFFER_SIZE + COMM_ENCODE_BUFFER_SIZE + \
108 COMM_DECODE_BUFFER_SIZE + ZCAT_GSM_BUFFER_SIZE + COMM_ARM1_ALL_SIZE + COMM_PS_TO_PHY_SIZE + \
109 COMM_PHY_TO_PS_SIZE + ZCAT_KERNEL_TO_CP_BUFFER_SIZE + ZCAT_APP_TO_CP_BUFFER_SIZE + COMM_CP_TO_AP_SIZE + \
110 COMM_AP_TO_CP_SIZE)
111
112/* MODEM PRINT Ä£¿é±àºÅ */
113#define SUBMDL_TOOLAGENT_SET (85)
114#define SUBMDL_ZCATAGT (SUBMDL_TOOLAGENT_SET + 0) /* ZCAT¹¤¾ß´úÀí */
115#define SUBMDL_TOOLCOMMON (SUBMDL_TOOLAGENT_SET + 1) /* TOOL COMMON */
116#define SUBMDL_COMM (SUBMDL_TOOLAGENT_SET + 2) /* ¹¤¾ßͨѶ¹ÜÀí */
117#define SUBMDL_NVAGT (SUBMDL_TOOLAGENT_SET + 3) /* NV¹¤¾ß´úÀí */
118
119/* ͨѶģ¿éºÅ */
120#define MDL_TOOLS_BASE (100)
121#define MDL_WINTRACE (MDL_TOOLS_BASE + 1) /* WinTrace */
122#define MDL_NVEDIT (MDL_TOOLS_BASE + 3) /* NvTool */
123#define MDL_VUART1 (MDL_TOOLS_BASE + 4) /* Virtual of Serial Comm1,used in SimEnv */
124#define MDL_EFSTOOL (MDL_TOOLS_BASE + 7) /* EfsTool */
125#define MDL_PTET (MDL_TOOLS_BASE + 10) /* ЭÒéÕ»²âÊÔ¹¤¾ß */
126#define MDL_ZCAT (MDL_TOOLS_BASE + 15) /* ZCAT¹¤¾ß */
127#define MDL_NVTOOL (MDL_TOOLS_BASE + 16) /* NvTool */
128#define MDL_AUDIO (MDL_TOOLS_BASE + 17) /* audio */
129
130#define MDL_SIMTH (MDL_TOOLS_BASE + 18) /* TH */
131
132
133
134#ifdef _OS_WIN
135#define MDL_PHONE (MDL_VUART1) /* windows ·ÂÕæ»·¾³ */
136#else
137#define MDL_PHONE (1) /* ÊÖ»ú */
138#endif
139
140#define ZCAT_MODE_INVALID (UINT32)0
141
142typedef enum
143{
144 ZCAT_MODE_AP_USB = 0xC1,
145 ZCAT_MODE_AP_NET,
146 ZCAT_MODE_AP_TF,
147 ZCAT_MODE_AP_FS,
148 ZCAT_MODE_CP_USB,
149 ZCAT_MODE_CP_TF,
150 ZCAT_MODE_CP_NET,
151 ZCAT_MODE_CP_FS
152} E_ZCAT_MODE;
153
154typedef enum
155{
156 ZCAT_IPC_SYN = 0xA0,
157 ZCAT_IPC_ACK,
158 ZCAT_IPC_ESTABLISHED,
159 ZCAT_IPC_SET_TTY,
160 ZCAT_IPC_SET_PERIPHERAL_MODE,
161 ZCAT_IPC_STOP,
162 ZCAT_IPC_START,
163 ZCAT_IPC_EXIT
164} E_ZCAT_IPC_HANDSHAKE;
165
166
167#define COMM_AP_FD 1001
168#define COMM_SINGLE_CORE_FD 1002
169#define COMM_CP_TF_FD 1234
170
171#define ZCAT_MEM_TYPE_KERNEL 0
172#define ZCAT_MEM_TYPE_USER 1
173
174#define HDLC_DECODE_CONTINUE (0x00)
175#define HDLC_DECODE_OK (0x01)
176#define HDLC_DECODE_FIRST_ESCAPE (0x02)
177#define HDLC_DECODE_DROP (0x03)
178
179
180/* zcatÈ«¾ÖÐÅÏ¢ */
181typedef struct
182{
183 int status;
184 int peripheral_mode;
185 char usblog_path[8];
186} T_ZCAT_CONFIG_INFO;
187
188
189// Ä£¿é»Øµ÷º¯Êý
190typedef VOID (*ModuleFunc)(UINT32 msgID/*ÎÞÓÃ*/, const UINT8 *buf, UINT32 msgLen);
191
192typedef enum
193{
194 LINK_CONNECT, /* Á´Â·½¨Á¢ÏûÏ¢ */
195 LINK_BREAK, /* Á´Â·¶Ï¿ªÏûÏ¢ */
196
197 MAX_LINK_INFO
198} LINK_INFO;
199
200typedef enum
201{
202 COMM_RET_SUCCESS, /* Êý¾Ý³É¹¦¼ÓÈë¶ÓÁÐ,µÈ´ý·¢ËÍ */
203 COMM_ERR_NOTINIT, /* ·¢ËÍʧ°Ü,ͨѶ´úÀíûÓгõʼ»¯ */
204 COMM_ERR_LINKBREAK, /* ·¢ËÍʧ°Ü,Á´Â·ÒѾ­¶Ï¿ª */
205 COMM_ERR_DATALEN, /* ·¢ËÍʧ°Ü,ÏûÏ¢ÄÚÈݳ¤¶È³¬¹ý×î´ó³¤¶È */
206 COMM_ERR_MEM, /* ·¢ËÍʧ°Ü,ÄÚ´æ²Ù×÷ʧ°Ü */
207 COMM_ERR_MUTEX, /* ·¢ËÍʧ°Ü,»¥³âÌå³öÏÖ´íÎó */
208
209 MAX_COMM_ERR
210} COMM_RET;
211
212typedef enum
213{
214 FUNC_RET_FAILURE,
215 FUNC_RET_SUCCESS,
216
217 MAX_FUNC_RET
218} FUNC_RET;
219
220// Comm½á¹¹¶¨Òå
221typedef struct
222{
223 UINT8 msg_type; /* ÏûÏ¢ÀàÐÍ */
224 UINT8 pad; /* Ìî³äλ */
225 UINT16 reserved; /* ±£Áô×ֶΣ¬ÌîΪ0xAAAA */
226 UINT8 tgt_mdl_no; /* Ä¿±ê(½ÓÊÕÏûÏ¢)Ä£¿éÄ£¿éºÅ */
227 UINT8 tgt_submdl_no; /* Ä¿±ê(½ÓÊÕÏûÏ¢)Ä£¿é×ÓÄ£¿éºÅ */
228 UINT8 src_mdl_no; /* Ô´(·¢ËÍÏûÏ¢)Ä£¿éÄ£¿éºÅ */
229 UINT8 src_submdl_no; /* Ô´(·¢ËÍÏûÏ¢)Ä£¿é×ÓÄ£¿éºÅ */
230 UINT32 buf_len; /* ÏûÏ¢Êý¾Ý³¤¶È(²»º¬ÏûϢͷ) */
231} T_COMM_TYPE;
232
233/* ´òÓ¡»º³åÇø */
234typedef struct
235{
236 UINT32 capacity; /* »º³åÇøÈÝÁ¿*/
237 volatile UINT32 readPoint; /* ¶ÁÖ¸Õë */
238 volatile UINT32 writePoint; /* дָÕë */
239 UINT32 symbol; /* ¿ØÖÆ¿é±êʶ·û */
240 UINT8 buf[1]; /* ´òÓ¡»º³åÇø */
241} T_RINGBUFFER;
242
243typedef struct
244{
245 UINT8 *buf;
246 UINT32 bufIndex; // Ö¸ÕëÆ«ÒÆ
247 UINT32 bufSize;
248} T_HDLC_BUFFER_TYPE;
249
250
251/**
252 * @brief ´Ócomm»·Ðλº³åÖÐÉêÇëÒ»¿éÄÚ´æ
253 * @param[in] size ÉêÇëµÄʵ¼ÊÓÐÓÃÊý¾ÝµÄ¿Õ¼ä´óС
254 * @return Èç¹û³É¹¦£¬·µ»ØÄÚ´æÖ¸Õ룬·ñÔò·µ»ØNULL
255 * @note ÉêÇëµÄÄÚ´æÖ»ÓÃÓÚcommµÄÊý¾Ý·¢ËÍ£¬É÷ÓÃ!!! \n
256 Èç¹û·¢Ëͳɹ¦Ôò²»ÐèÊÍ·Å£»\n
257 δ·¢ËÍ»ò·¢ËͲ»³É¹¦Ôò±ØÐëµ÷ÓÃComm_Free½øÐÐÊÍ·Å£¬·ñÔòËÀÇÌÇÌ
258 * @see
259 */
260VOID* Comm_Malloc(UINT32 size);
261
262/**
263 * @brief ÊÍ·ÅÓÉComm_MallocÉêÇëµÄÄÚ´æ
264 * @param[in] mem_ptr ´ýÊͷŵÄcomm»º³åÇøÖÐÄÚ´æ¿éµÄÖ¸Õë
265 * @return void
266 * @note
267 * @see
268 */
269VOID Comm_Free(VOID *mem_ptr);
270
271/**
272 * @brief ZCATͨѶ¹ÜÀíÄ£¿é³õʼ»¯
273 * @param[in] void
274 * @return ³É¹¦·µ»ØZOSS_SUCCESS£»Ê§°Ü·µ»ØZOSS_ERROR
275 * @note
276 * @see
277 */
278UINT32 Comm_Init(VOID);
279
280/**
281 * @brief ZCATͨѶ¹ÜÀíÄ£¿é×¢Ïú½Ó¿Ú,
282 * @param[in] void
283 * @return void
284 * @note
285 * @see
286 */
287void Comm_Release(void);
288
289
290/**
291 * @brief ZCAT×ÓÄ£¿é×¢²á½Ó¿Ú \n
292 * Ìṩ¸ø¸÷¸ö×ÓÄ£¿éµ÷Óã¬×¢²á×ÓÄ£¿éÐÅÏ¢
293 * @param[in] submdl_no ×¢²áµÄ×ÓÄ£¿éºÅ£¬ÒѾ­ÔÚpub_mdldef.hÖж¨ÒåºÃ
294 * @param[in] uart_name ÕâÀïÒòΪÐèÇó±ä¸ü£¬µ¼Ö²ÎÊýuart_nameÎÞЧ,ÇëÒ»ÂÉÌîuart/0
295 * @param[in] moduleFunc ¸÷¸ö×ÓÄ£¿é»Øµ÷º¯Êý
296 * @return ³É¹¦·µ»ØZOSS_SUCCESS, ʧ°Ü·µ»ØZOSS_ERROR
297 * @note
298 * @see
299 */
300UINT32 zTools_CommReg(UINT8 submdl_no, const CHAR *uart_name, ModuleFunc moduleFunc);
301
302/**
303 * @brief ZCAT×ÓÄ£¿é×¢Ïú½Ó¿Ú \n
304 * Ìṩ¸ø¸÷¸ö×ÓÄ£¿éµ÷Óã¬×¢Ïú×ÓÄ£¿éÐÅÏ¢
305 * @param[in] submdl_no ½«Òª×¢ÏúµÄ×ÓÄ£¿éºÅ
306 * @return ³É¹¦·µ»ØZOSS_SUCCESS, ʧ°Ü·µ»ØZOSS_ERROR
307 * @note
308 * @see
309 */
310UINT32 zTools_CommUnReg(UINT8 submdl_no);
311
312/**
313 * @brief Ìṩ¸ø²»Í¬×ÓÄ£¿éÏò"ÍâÉè"·¢ËÍÊý¾ÝµÄ¹¦ÄÜ \n
314 * ¸øTraceAgtÄ£¿éʹÓÃ,Õâ¸öÊÇÒì²½½Ó¿Ú£¬Ö»¹Ü·¢ËͶø²»¹ÜÊÇ·ñÄܹ»ÊÕµ½
315 * ·¢ËÍÊý¾ÝÒ»°ãÏȵ½"ͳһ»º´æ"ÖУ¬È»ºó֪ͨ·¢ËÍÏß³ÌÓÐÊý¾Ý´ý·¢ËÍ
316 * @param[in] buf ·¢ËÍÊý¾Ý(±ØÐëÊÇÓÉComm_MallocÉêÇëµÄÄÚ´æ!!!)
317 * @param[in] buf_len ·¢ËÍÊý¾ÝµÄ³¤¶È
318 * @param[in] tgt_mdl_no Ä¿±êÄ£¿éºÅ£¬ÊÖ»ú»òPCµÈ
319 * @param[in] tgt_submdl_no Ä¿±ê×ÓÄ£¿éºÅ
320 * @param[in] src_submdl_no Ô´×ÓÄ£¿éºÅ
321 * @return ³É¹¦·µ»ØZOSS_SUCCESS, ·ñÔò·µ»ØZOSS_ERROR
322 * @note
323 * @see
324 */
325UINT32 zTools_SendData(UINT8 *buf, UINT32 buf_len,
326 UINT8 tgt_mdl_no, UINT8 tgt_submdl_no, UINT8 src_submdl_no);
327
328/**
329 * @brief ´´½¨ÐèÒªµÄ»º³åÇø
330 * Èç¹ûbuf²»ÎªNULL£¬ÔòÔÚÖ¸¶¨µØÖ·´´½¨»º³åÇø£»·ñÔò£¬ÉêÇëÒ»¿éÄÚ´æ×÷Ϊ»º³åÇø
331 * @param[in] buf »º³åÇøµØÖ·
332 * @param[in] bufSize »º³åÇø´óС
333 * @return ³É¹¦·µ»ØÖ¸Ïò»º³åÇø½á¹¹ÌåµÄÖ¸Õ룬·ñÔò·µ»ØNULL
334 * @note
335 * @see
336 */
337T_RINGBUFFER* CreateRingBuffer(UINT8 *buf, UINT32 bufSize);
338
339/**
340 * @brief ´´½¨ÐèÒªµÄ»º³åÇø,²¢ÇÒÖ¸¶¨±ê¼ÇλµÄÖµ
341 * Èç¹ûbuf²»ÎªNULL£¬ÔòÔÚÖ¸¶¨µØÖ·´´½¨»º³åÇø£»·ñÔò£¬ÉêÇëÒ»¿éÄÚ´æ×÷Ϊ»º³åÇø
342 * @param[in] buf »º³åÇøµØÖ·
343 * @param[in] bufSize »º³åÇø´óС
344 * @param[in] bufSize ±ê¼Çλ
345 * @return ³É¹¦·µ»ØÖ¸Ïò»º³åÇø½á¹¹ÌåµÄÖ¸Õ룬·ñÔò·µ»ØNULL
346 * @note
347 * @see
348 */
349T_RINGBUFFER* CreateRingBufferWithSymbol(UINT8 *buf, UINT32 bufSize, UINT32 symbol);
350
351/**
352 * @brief Åжϻº³åÇøÊÇ·ñÓÐЧ
353 * @param[in] ringBuf »·Ðλº³å
354 * @return ÊÇ·µ»ØTRUE,·ñ·µ»ØFALSE
355 * @note
356 * @see
357 */
358BOOL IsRingBufferValid(T_RINGBUFFER *ringBuf);
359
360/**
361 * @brief ½«»º³åÇøÖÿÕ
362 * @param[in] ringBuf »·Ðλº³åÇøÖ¸Õë
363 * @return void
364 * @note
365 * @see
366 */
367VOID EmptyRingBuffer(T_RINGBUFFER *ringBuf);
368
369/**
370 * @brief ½«Êý¾ÝдÈë»·Ðλº³å
371 * @param[in] ringBuf »·Ðλº³åÖ¸Õë
372 * @param[in] buf Êý¾Ý»º´æÖ¸Õë
373 * @param[in] len Êý¾Ý³¤¶È
374 * @param[in] flags Êý¾Ý»º´æÄÚ´æÀàÐÍ£º0:ÄÚºË̬,1:Óû§Ì¬
375 * @return ·µ»ØдÈëµÄʵ¼Ê³¤¶È
376 * @note
377 * @see
378 */
379UINT32 WriteRingBuffer(T_RINGBUFFER *ringBuf, UINT8 *buf, UINT32 len, UINT32 flags);
380
381/**
382 * @brief ¶ÁÈ¡Ò»¶Î»·Ðλº³åÇøµÄÊý¾Ýµ½Ä¿±ê»º´æ
383 * @param[in] ringBuf »·Ðλº³åÇøÖ¸Õë
384 * @param[in] buf Ä¿±ê»º´æÖ¸Õë
385 * @param[in] len Ä¿±ê»º´æ³¤¶È
386 * @param[in] flags Ä¿±ê»º´æÄÚ´æÀàÐÍ£º0:ÄÚºË̬,1:Óû§Ì¬
387 * @return ·µ»Ø¶ÁÈ¡³¤¶È
388 * @note
389 * @see
390 */
391UINT32 ReadRingBuffer(T_RINGBUFFER *ringBuf, UINT8 *buf, UINT32 len, UINT32 flags);
392
393/**
394 * @brief »ñÈ¡µ±Ç°Ring BufferÖпÕÏÐÇøµÄ´óС
395 * @param[in] ringBuf »·Ðλº³åÇøÖ¸Õë
396 * @return ·µ»Ø×Ö½ÚÊý
397 * @note
398 * @see
399 */
400UINT32 GetRingBufferSize(T_RINGBUFFER *ringBuf);
401
402/**
403 * @brief HDLC±àÂë
404 * @param[out] dest Ä¿±êT_HDLC_BUFFER_TYPEÖ¸Õë
405 * @param[in] src Ô´T_HDLC_BUFFER_TYPEÖ¸Õë
406 * @return ³É¹¦·µ»ØTRUE£»Ê§°Ü·µ»ØFALSE
407 * @note
408 * @see
409 */
410BOOL hdlc_encode(T_HDLC_BUFFER_TYPE *dest, const T_HDLC_BUFFER_TYPE *src);
411
412/**
413 * @brief ½«Êý¾Ý½øÐÐHDLC½âÂëÖÁÖ¸¶¨µÄµ¥ÏòFIFOÖÐ
414 * FIFOÖ»ÄÜ´ÓÍ·(0λÖÃ)°´Õû°ü¶Á³öÊý¾Ý»ò¶ªÆú£¬½âÂëʱ°´Ë³ÐòдÈëµ½FIFO£¬
415 * ÿÕÒµ½Ò»´ÎÕû°ü£¬Í£Ö¹Ð´È룬Ȼºó¶Á³öÊý¾Ý»òÕ߶ªÆú
416 * ¹ý³ÌÖÐÓò»µ½readPoint£¬Ê¼ÖÕΪ0
417 * @param[out] dest ½âÂëºó´æ´¢µÄFIFOÖ¸Õë
418 * @param[in] src ´ý½âÂëµÄ»º´æÖ¸Õë
419 * @param[in] len ´ý½âÂëµÄ»º´æ³¤¶È
420 * @return ·µ»Ø½âÂëµÄʵ¼Ê³¤¶È
421 * @note
422 * @see
423 */
424UINT32 hdlc_decode(T_RINGBUFFER *dest, unsigned char *src, unsigned int len);
425
426/**************************************************************************
427 CommAgt¹«¹²½Ó¿ÚÉùÃ÷
428**************************************************************************/
429
430/**************************************************************************
431*Ä£¿é½ÓÊÕÏûÏ¢»Øµ÷º¯Êý
432*²ÎÊý˵Ã÷:
433* (IN)
434* ucLinkMsg Á´Â·×´Ì¬
435* LINK_CONNECT Á´Â·½¨Á¢
436* LINK_BREAK Á´Â·¶Ï¿ª
437**************************************************************************/
438typedef void (* LINKRPTFUNC)(LINK_INFO ucLinkMsg);
439
440/**************************************************************************
441*ÆÕͨ×ÓÄ£¿é(²»ÓùØÐÄÏûÏ¢ID)½ÓÊÕÊý¾Ý»Øµ÷º¯Êý
442*²ÎÊý˵Ã÷:
443* (IN)
444* ucSrcModNo Ô´Ä£¿éºÅ
445* ucSrcSubModNo Ô´×ÓÄ£¿éºÅ
446* pBuf ÏûÏ¢Êý¾ÝÖ¸Õë
447* wLen ÏûÏ¢Êý¾Ý³¤¶È
448**************************************************************************/
449typedef void (* RECVFUNC)(unsigned char ucSrcModNo, unsigned char ucSrcSubModNo, const char *pBuf, unsigned short wLen);
450
451/**************************************************************************
452*À©Õ¹×ÓÄ£¿é(ʹÓÃÏûÏ¢ID)½ÓÊÕÊý¾Ý»Øµ÷º¯Êý
453*²ÎÊý˵Ã÷:
454* (IN)
455* ucSrcModNo Ô´Ä£¿éºÅ
456* ucSrcSubModNo Ô´×ÓÄ£¿éºÅ
457* dwMsgID ÏûÏ¢±àºÅ
458* pBuf ÏûÏ¢Êý¾ÝÖ¸Õë
459* wLen ÏûÏ¢Êý¾Ý³¤¶È
460**************************************************************************/
461typedef void (* RECVFUNCEX)(unsigned char ucSrcModNo, unsigned char ucSrcSubModNo, unsigned int dwMsgID, const char *pBuf, unsigned short wLen);
462
463/**************************************************************************
464*ÐéÄâ´®¿ÚÄ£¿é½ÓÊÕÊý¾Ý»Øµ÷º¯Êý,ʹÓÃÏûÏ¢ID
465*²ÎÊý˵Ã÷:
466* (IN)
467* ucSrcModNo Ô´Ä£¿éºÅ
468* ucSrcSubModNo Ô´×ÓÄ£¿éºÅ
469* ucTarSubModNo Ä¿±ê×ÓÄ£¿éºÅ
470* dwMsgID ÏûÏ¢±àºÅ
471* pBuf ÏûÏ¢Êý¾ÝÖ¸Õë
472* wLen ÏûÏ¢Êý¾Ý³¤¶È
473**************************************************************************/
474typedef void (* RECVFUNCUART)(unsigned char ucSrcModNo, unsigned char ucSrcSubModNo, unsigned char ucTarModNo, unsigned char ucTarSubModNo, unsigned int dwMsgID, const char *pBuf, unsigned short wLen);
475
476/**************************************************************************
477* º¯ÊýÃû³Æ£º Comm_Register
478* ¹¦ÄÜÃèÊö£º ÆÕͨģ¿é(²»ÓùØÐÄÏûÏ¢ID)×¢²á½Ó¿Ú(97ÓÃ)
479* ²ÎÊý˵Ã÷£º (IN)
480* ucModNo Ä£¿éºÅ
481* linkRptFunc Ä£¿é½ÓÊÕÏûÏ¢»Øµ÷º¯Êý
482* (OUT)
483* ·µ »Ø Öµ£º VOID
484* ÆäËü˵Ã÷£º ûÓзµ»ØÖµ
485**************************************************************************/
486FUNC_RET Comm_Register(unsigned char ucModNo, LINKRPTFUNC linkRptFunc);
487
488/**************************************************************************
489* º¯ÊýÃû³Æ£º Comm_RegisterSub
490* ¹¦ÄÜÃèÊö£º ÆÕͨģ¿é(²»ÓùØÐÄÏûÏ¢ID)×ÓÄ£¿é×¢²á½Ó¿Ú(97ÓÃ)
491* ²ÎÊý˵Ã÷£º (IN)
492* ucModNo Ä£¿éºÅ
493* ucSubModNo ×ÓÄ£¿éºÅ
494* recvFunc ×ÓÄ£¿é½ÓÊÕÊý¾Ý»Øµ÷º¯Êý
495* (OUT)
496* ·µ »Ø Öµ£º
497* FUNC_RET_SUCCESS ×¢²á³É¹¦
498* FUNC_RET_FAILURE ×¢²áʧ°Ü,Á½ÖÖ¿ÉÄÜÇé¿ö,Ò»ÊÇ×ÓÄ£¿éºÅÖظ´ÁË,¶þÊÇ×¢²áµÄ×ÓÄ£¿éÊýÒѾ­µ½×î´óÏÞ¶È
499* ÆäËü˵Ã÷£º Ö»ÊÇ×¢²áÔÚͨѶ´úÀíÖÐ
500**************************************************************************/
501FUNC_RET Comm_RegisterSub(unsigned char ucModNo, unsigned char ucSubModNo, RECVFUNC recvFunc);
502
503/**************************************************************************
504* º¯ÊýÃû³Æ£º Comm_SendMsg
505* ¹¦ÄÜÃèÊö£º ÆÕͨģ¿é(²»ÓùØÐÄÏûÏ¢ID)·¢ËÍÏûÏ¢½Ó¿Ú(97ÓÃ)
506* ²ÎÊý˵Ã÷£º (IN)
507* ucTarModNo Ä¿±êÄ£¿éºÅ
508* ucTarSubModNo Ä¿±ê×ÓÄ£¿éºÅ
509* ucSrcModNo Ô´Ä£¿éºÅ
510* ucSrcSubModNo Ô´×ÓÄ£¿éºÅ
511* pBuf ÏûÏ¢Êý¾ÝÖ¸Õë
512* wLen ÏûÏ¢Êý¾Ý³¤¶È,²»ÄÜ´óÓÚMAX_COMM_LEN
513* (OUT)
514* ·µ »Ø Öµ£º
515* COMM_RET_SUCCESS ·¢Ëͳɹ¦
516* COMM_ERR_NOTINIT ·¢ËÍʧ°Ü,ͨѶ´úÀíÉÐδ³õʼ»¯
517* COMM_ERR_LINKBREAK ·¢ËÍʧ°Ü,ÒòΪÁ´Â·Î´Á¬½Ó(ÓÃÓÚPC²à)»ò¶Ë¿Úδ´ò¿ª(ÓÃÓÚÊÖ»ú²à)
518* COMM_ERR_DATALEN ·¢ËÍʧ°Ü,ÏûÏ¢ÄÚÈݳ¬¹ý×î´ó³¤¶È
519* COMM_ERR_MEM ·¢ËÍʧ°Ü,ÄÚ´æ²Ù×÷ʧ°Ü
520* COMM_ERR_MUTEX ·¢ËÍʧ°Ü,»¥³âÌå³öÏÖ´íÎó
521* ÆäËü˵Ã÷£º
522**************************************************************************/
523COMM_RET Comm_SendMsg(unsigned char ucTarModNo, unsigned char ucTarSubModNo, \
524 unsigned char ucSrcModNo, unsigned char ucSrcSubModNo, \
525 const char * pBuf, unsigned short wLen);
526
527/**************************************************************************
528* º¯ÊýÃû³Æ£º Comm_GetStatus
529* ¹¦ÄÜÃèÊö£º »ñȡͨѶ´úÀíÓëͨѶ¹¤¾ßµÄÁ´Â·×´Ì¬
530* ²ÎÊý˵Ã÷£º (IN)
531* ucModNo Ä£¿éºÅ
532* (OUT)
533* ·µ »Ø Öµ£º
534* FUNC_RET_SUCCESS Á´Â·ÒÑÁ¬½Ó
535* FUNC_RET_FAILURE Á´Â·Î´Á¬½Ó
536* ÆäËü˵Ã÷£º
537**************************************************************************/
538FUNC_RET Comm_GetStatus(unsigned char ucModNo);
539
540/**************************************************************************
541* º¯ÊýÃû³Æ£º Comm_UnRegister
542* ¹¦ÄÜÃèÊö£º Ä£¿é×¢Ïú½Ó¿Ú
543* ²ÎÊý˵Ã÷£º (IN)
544* ucModNo Ä£¿éºÅ
545* (OUT)
546* ·µ »Ø Öµ£º
547* FUNC_RET_SUCCESS ×¢Ïú³É¹¦
548* FUNC_RET_FAILURE ×¢Ïúʧ°Ü
549* ÆäËü˵Ã÷£º
550**************************************************************************/
551FUNC_RET Comm_UnRegister(unsigned char ucModNo);
552
553/**************************************************************************
554* º¯ÊýÃû³Æ£º Comm_UnRegisterSub
555* ¹¦ÄÜÃèÊö£º ÆÕͨģ¿é(²»ÓùØÐÄÏûÏ¢ID)×ÓÄ£¿é×¢Ïú½Ó¿Ú
556* ²ÎÊý˵Ã÷£º (IN)
557* ucModNo Ä£¿éºÅ
558* ucSubModNo ×ÓÄ£¿éºÅ
559* (OUT)
560* ·µ »Ø Öµ£º
561* FUNC_RET_SUCCESS ×¢Ïú³É¹¦
562* FUNC_RET_FAILURE ×¢Ïúʧ°Ü
563* ÆäËü˵Ã÷£º
564**************************************************************************/
565FUNC_RET Comm_UnRegisterSub(unsigned char ucModNo, unsigned char ucSubModNo);
566
567/**************************************************************************
568* º¯ÊýÃû³Æ£º Comm_RegisterEx
569* ¹¦ÄÜÃèÊö£º À©Õ¹Ä£¿é(ʹÓÃÏûÏ¢ID)×¢²á½Ó¿Ú
570* ²ÎÊý˵Ã÷£º (IN)
571* ucModNo Ä£¿éºÅ
572* linkRptFunc Ä£¿é½ÓÊÕÏûÏ¢»Øµ÷º¯Êý
573* (OUT)
574* ·µ »Ø Öµ£º VOID
575* ÆäËü˵Ã÷£º ûÓзµ»ØÖµ
576**************************************************************************/
577FUNC_RET Comm_RegisterEx(unsigned char ucModNo, LINKRPTFUNC linkRptFunc);
578
579/**************************************************************************
580* º¯ÊýÃû³Æ£º Comm_RegisterSubEx
581* ¹¦ÄÜÃèÊö£º À©Õ¹Ä£¿é(ʹÓÃÏûÏ¢ID)×ÓÄ£¿é×¢²á½Ó¿Ú
582* ²ÎÊý˵Ã÷£º (IN)
583* ucModNo Ä£¿éºÅ
584* ucSubModNo ×ÓÄ£¿éºÅ
585* recvFunc ×ÓÄ£¿é½ÓÊÕÊý¾Ý»Øµ÷º¯Êý
586* (OUT)
587* ·µ »Ø Öµ£º
588* FUNC_RET_SUCCESS ×¢²á³É¹¦
589* FUNC_RET_FAILURE ×¢²áʧ°Ü,Á½ÖÖ¿ÉÄÜÇé¿ö,Ò»ÊÇ×ÓÄ£¿éºÅÖظ´ÁË,¶þÊÇ×¢²áµÄ×ÓÄ£¿éÊýÒѾ­µ½×î´óÏÞ¶È
590* ÆäËü˵Ã÷£º Ö»ÊÇ×¢²áÔÚͨѶ´úÀíÖÐ
591**************************************************************************/
592FUNC_RET Comm_RegisterSubEx(unsigned char ucModNo, unsigned char ucSubModNo, RECVFUNCEX recvFunc);
593
594/**************************************************************************
595* º¯ÊýÃû³Æ£º Comm_SendMsgEx
596* ¹¦ÄÜÃèÊö£º À©Õ¹Ä£¿é(ʹÓÃÏûÏ¢ID)·¢ËÍÏûÏ¢½Ó¿Ú
597* ²ÎÊý˵Ã÷£º (IN)
598* ucTarModNo Ä¿±êÄ£¿éºÅ
599* ucTarSubModNo Ä¿±ê×ÓÄ£¿éºÅ
600* ucSrcModNo Ô´Ä£¿éºÅ
601* ucSrcSubModNo Ô´×ÓÄ£¿éºÅ
602* dwMsgID ÏûÏ¢±àºÅ
603* pBuf ÏûÏ¢ÄÚÈÝÖ¸Õë
604* wLen ÏûÏ¢ÄÚÈݳ¤¶È,²»ÄÜ´óÓÚMAX_COMM_LEN - MSG_HEADER_LEN
605* (OUT)
606* ·µ »Ø Öµ£º
607* COMM_RET_SUCCESS ·¢Ëͳɹ¦
608* COMM_ERR_NOTINIT ·¢ËÍʧ°Ü,ͨѶ´úÀíÉÐδ³õʼ»¯
609* COMM_ERR_LINKBREAK ·¢ËÍʧ°Ü,ÒòΪÁ´Â·Î´Á¬½Ó(ÓÃÓÚPC²à)»ò¶Ë¿Úδ´ò¿ª(ÓÃÓÚÊÖ»ú²à)
610* COMM_ERR_DATALEN ·¢ËÍʧ°Ü,ÏûÏ¢ÄÚÈݳ¬¹ý×î´ó³¤¶È
611* COMM_ERR_MEM ·¢ËÍʧ°Ü,ÄÚ´æ²Ù×÷ʧ°Ü
612* COMM_ERR_MUTEX ·¢ËÍʧ°Ü,»¥³âÌå³öÏÖ´íÎó
613* ÆäËü˵Ã÷£º
614**************************************************************************/
615COMM_RET Comm_SendMsgEx(unsigned char ucTarModNo, unsigned char ucTarSubModNo, \
616 unsigned char ucSrcModNo, unsigned char ucSrcSubModNo, \
617 unsigned int dwMsgID, const char * pBuf, unsigned short wLen);
618
619/**************************************************************************
620* º¯ÊýÃû³Æ£º Comm_RegisterUart
621* ¹¦ÄÜÃèÊö£º ÐéÄâ´®¿ÚÄ£¿é×¢²á½Ó¿Ú,Ö§³ÖÏûÏ¢ID,ÕâÖ־Ͳ»ÓÃ×¢²á×ÓÄ£¿éÁË
622* ²ÎÊý˵Ã÷£º (IN)
623* ucModNo Ä£¿éºÅ
624* linkRptFunc Ä£¿é½ÓÊÕÏûÏ¢»Øµ÷º¯Êý
625* recvFunc Ä£¿é½ÓÊÕÊý¾Ý»Øµ÷º¯Êý
626* (OUT)
627* ·µ »Ø Öµ£º VOID
628* ÆäËü˵Ã÷£º ûÓзµ»ØÖµ
629**************************************************************************/
630FUNC_RET Comm_RegisterUart(unsigned char ucModNo, LINKRPTFUNC linkRptFunc, RECVFUNCUART recvFunc);
631
632/**************************************************************************
633* º¯ÊýÃû³Æ£º Comm_TaskSendToPhone
634* ¹¦ÄÜÃèÊö£º ±¾½Ó¿ÚÌṩ¸øЭÒéÕ»µÄ²âÊÔ¹¤¾ßʹÓÃ,Ä£ÄâÈÎÎñ¸ø·¢Ë͵ÄÈÎÎñ»Ø¸´ÏûÏ¢µÄ½Ó¿Ú
635* ²ÎÊý˵Ã÷£º(IN)
636* msg_id ·¢ËÍÏûÏ¢±àºÅ£¬Õâ¸ö¿ÉÒÔÓÉÓû§×Ô¼º¶¨Òå
637* buf ÏûÏ¢Êý¾ÝÖ¸Õë
638* buf_len ÏûÏ¢Êý¾Ý³¤¶È
639* tgtMdlNo Ä¿±êÄ£¿éºÅ£¬ÊÖ»ú»òPCµÈ
640* tgtSubMdlNo Ä¿±ê×ÓÄ£¿éºÅ
641* srcSubMdlNo Ô´×ÓÄ£¿éºÅ
642* srcTask Ô´ÈÎÎñID
643* tgtTask Ä¿±êÈÎÎñID
644* (OUT)
645* ·µ »Ø Öµ£º Èç¹û·¢Ëͳɹ¦£¬·µ»ØZOSS_SUCCESS,·ñÔò·µ»ØZOSS_ERROR
646* ÆäËü˵Ã÷£º ÎÞ
647**************************************************************************/
648unsigned int Comm_TaskSendToPhone(unsigned int msg_id, const unsigned char *buf, unsigned short bufLen, \
649 unsigned char tgtMdlNo, unsigned char tgtSubMdlNo, unsigned char srcSubMdlNo, void * srcTask, void * tgtTask);
650
651
652/**
653 * @brief ·¢ËÍÊý¾Ýµ½"ͳһ»º´æ"ÖÐ
654 * @param[in] buf ·¢ËÍÊý¾Ý(±ØÐëÊÇÓÉComm_MallocÉêÇëµÄÄÚ´æ!!!)
655 * @param[in] buf_len ·¢ËÍÊý¾ÝµÄ³¤¶È
656 * @param[in] tgt_mdl_no Ä¿±êÄ£¿éºÅ£¬ÊÖ»ú»òPCµÈ
657 * @param[in] tgt_submdl_no Ä¿±ê×ÓÄ£¿éºÅ
658 * @param[in] src_submdl_no Ô´×ÓÄ£¿éºÅ
659 * @return ³É¹¦·µ»ØZOSS_SUCCESS, ·ñÔò·µ»ØZOSS_ERROR
660 * @note
661 * @see
662 */
663VOID Comm_HeaderInit(T_COMM_TYPE *commHeader, UINT32 buf_len,
664 UINT8 tgt_mdl_no, UINT8 tgt_submdl_no, UINT8 src_submdl_no);
665#endif /*COMM_PUB_H_*/
666