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