kal_trace.h 25.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   kal_trace.h
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   This file provides typedefs and definiton for PS index trace.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

#ifndef _KAL_TRACE_H
#define _KAL_TRACE_H

#include <stdarg.h>
#ifndef GEN_FOR_PC
#include <stdio.h>
#endif
#include "kal_general_types.h"
#include "stack_config.h"               /* module_type & task_indx_type */

#ifdef __MTK_TARGET__
  #pragma diag_suppress 870
#endif  //#ifdef __MTK_TARGET__

#ifdef __cplusplus
extern "C" {
#endif

#if defined(__TST_MODULE__) && defined(__EM_MODE__) /* for ilm_struct type definition */
#ifndef GEN_FOR_PC
struct ilm_struct;
extern void tst_EM_logger(struct ilm_struct *ilm_ptr);
#endif
#endif	//#if defined(__TST_MODULE__) && defined(__EM_MODE__)

#define MAX_MSG_NBR_IN_MODULE       20
#define ADDITIONAL_BUFFER_FOR_MUX   45
#define DEFAULT_RS232_FRAME_SIZE    5                 /* STX, LenHi, LenLo, Type, Checksum*/
#define SAP_LOCAL_PARA_FILTER       0x02
#define SAP_PEER_BUFF_FILTER        0x04

#define STX_OCTET                   0x55
#define LOGGED_PRIMITIVE_TYPE       0x60
#define PS_TRACE_INDEX_TRACE_TYPE   0x61
#define PS_PROMPT_TRACE_TYPE        0x62
#define CONTROL_COMMAND_TYPE        0x63
#define INJECT_PRIMITIVE_TYPE       0x64
#define SYS_TRACE_TYPE              0x65

//Define Trace Macro for PS trace
#ifdef GEN_FOR_PC
  #ifndef GEN_FOR_CPARSER
    #define BEGIN_TRACE_MAP(MOD)     START_MODULE_MSG MOD MAX_MSG_NBR_IN_MODULE
    #define TRC_MSG(MSG,STR)         MSG STR
    #define TRC_MSG_NEWLINE(MSG,STR,NUM)         MSG STR NUM
    #define END_TRACE_MAP(MOD)       END_MODULE_MSG
  #else
    #define BEGIN_TRACE_MAP(MOD)     enum MOD##_MSG_ENUM{\
                                        MOD##_empty_string=MOD<<MAX_MSG_NBR_IN_MODULE,
    #define TRC_MSG(MSG,STR)         MSG##__enum,
    #define TRC_MSG_NEWLINE(MSG,STR,NUM)         MSG##__enum, MSG##_NEWLINE_EXPAND__enum = MSG##__enum+NUM,
    #define  END_TRACE_MAP(MOD)      MOD##__end};
  #endif
#else /* GEN_FOR_PC */
  #define BEGIN_TRACE_MAP(MOD)     enum MOD##_MSG_ENUM{\
                                      MOD##_empty_string=MOD<<MAX_MSG_NBR_IN_MODULE,
  #define TRC_MSG(MSG,STR)         MSG##__enum,
  #define TRC_MSG_NEWLINE(MSG,STR,NUM)         MSG##__enum, MSG##_NEWLINE_EXPAND__enum = MSG##__enum+NUM,
  #define  END_TRACE_MAP(MOD)      MOD##__end};
#endif /* GEN_FOR_PC */


//Decide which path should enter
#ifdef __TST_MODULE__
  #if !defined(__FUE__) && !defined(__UBL__)
    #if !defined(MODULE_TRACE_OFF)
      #define __TST_TRACE_ENABLED__  
    #elif defined(__TST_CRITICAL_TRACE_LEVEL__) //__PRIORITY_TRACING_ENABLED__ should be disabled in MoDIS      
      #define __TST_CRITICAL_TRACE_ENABLED__
    #endif  //!defined(MODULE_TRACE_OFF) && 
  #endif  
#endif  //#ifdef __TST_MODULE__

#ifndef __TST_TRACE_ENABLED__
  #if defined(KAL_ON_OSCAR) || defined(MCD_DLL_EXPORT) || defined(L1_SIM)
    #define __TST_TRACE_EMPTY_FUNCTION__
    
    #if defined(__TST_CRITICAL_TRACE_ENABLED__)
      #undef __TST_CRITICAL_TRACE_ENABLED__
    #endif  //__TST_CRITICAL_TRACE_ENABLED__
  #endif  //#if defined(KAL_ON_OSCAR) || defined(MCD_DLL_EXPORT) || defined(L1_SIM)
#endif


#if !defined(__TST_CRITICAL_TRACE_ENABLED__) || defined(GEN_FOR_PC)
typedef enum
{
   TRACE_FUNC,
   TRACE_STATE,
   TRACE_INFO,
   TRACE_WARNING,
   TRACE_ERROR,
   TRACE_GROUP_1,
   TRACE_GROUP_2,
   TRACE_GROUP_3,
   TRACE_GROUP_4,
   TRACE_GROUP_5,
   TRACE_GROUP_6,
   TRACE_GROUP_7,
   TRACE_GROUP_8,
   TRACE_GROUP_9,
   TRACE_GROUP_10,
   TRACE_PEER
}trace_class_enum;
#else   //__TST_CRITICAL_TRACE_ENABLED__
  typedef unsigned char trace_class_enum;
#endif  //__TST_CRITICAL_TRACE_ENABLED__


#if defined(__TST_TRACE_ENABLED__)
  #define kal_print_string_trace kal_wap_trace  //alias kal_print_string_trace as kal_wap_trace
  //#define kal_critical_trace kal_trace
  //#define kal_critical_brief_trace kal_brief_trace
  //#define kal_critical_assert_trace kal_assert_trace
  extern void kal_critical_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_critical_brief_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_critical_assert_trace( trace_class_enum, kal_uint32, const kal_char* , ...);    
  
 /*******************************************************************************
 * <GROUP Functions>
 * 
 * FUNCTION
 *  kal_trace
 * DESCRIPTION
 *  This function is used to output the pre-defined trace to PC. 
 *  The engineers SHOULD define their own traces before using this function. 
 *  If a trace is defined as ¡§Today is %d-$d-%d¡¨, kal_trace simply sends the trace ID and the content of %d to PC. 
 *  That will reduce the communication traffic. In the chapter 2, we will introduce how to ass a new trace.
 *
 *
 * Property:
 *ƒÜ	¡§Message Compression¡¨ type API
 *Ć	Cannot be invoked in LISR/HISR context.
 *Ć	Can send up to 128 bytes parameters
 *Ć	Suggested to use this API for most of the scenario.
 *
 * PARAMETERS
 *  trc_class: [IN] The trace class of this trace. Each module has 15 classes to category.
 *  msg_index: [IN] Message index. This part will be handled by tool.
 *  arg_type:  [IN] This part will be handled by tool.
 *  ...: [IN] Parameters to log
 * RETURNS
 *  NONE
 * NOTE
 *
 ******************************************************************************/
  extern void kal_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_brief_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_trace_for_3rd_party( trace_class_enum, kal_uint32, const kal_char* , va_list);
  extern void kal_lib_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_assert_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
  extern void kal_wap_trace(module_type mod_id, trace_class_enum trc_class, const char *fmt,...);
  extern void kal_buffer_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* fmt, kal_uint32 buf_len, const kal_uint8* pData);
  extern void kal_dev_trace(trace_class_enum trc_class, kal_uint32 msg_index, const char *arg_type,...);
  extern void kal_bootup_trace( trace_class_enum, kal_uint32, const kal_char* , ...);

#else //__TST_TRACE_ENABLED__
   #if defined(__TST_TRACE_EMPTY_FUNCTION__)
     /*
     * For non-target platform (PC simulator or MNT),
     * we define trace-related functions as inline function to avoid compile error
     * in VC++.
     */
     
    static __inline void kal_critical_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    
    static __inline void kal_critical_brief_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    static __inline void kal_critical_assert_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
        
        
    static __inline void kal_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    
    static __inline void kal_brief_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    
    static __inline void kal_trace_for_3rd_party(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, va_list argument_info)
    {
        return ;
    }
    
    static __inline void kal_lib_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    static __inline void kal_assert_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
    static __inline void kal_wap_trace(module_type mod_id, trace_class_enum trc_class, const char *fmt,...)
    {
        return ;
    }
    static __inline void kal_print_string_trace(module_type mod_id, trace_class_enum trc_class, const char *fmt,...)
    {
        return ;
    }
    
    static __inline void kal_buffer_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* fmt, kal_uint32 buf_len, const kal_uint8* pData)
    {
        return;
    }
    
    static __inline void kal_dev_trace(trace_class_enum trc_class, kal_uint32 msg_index, const char *arg_type,...)
    {
        return;
    }
    
    static __inline void kal_bootup_trace(trace_class_enum trc_class, kal_uint32 msg_index, const kal_char* arg_type, ...)
    {
        return ;
    }
   #elif defined(__TST_CRITICAL_TRACE_ENABLED__)
    //Support partial tracing API enable
    extern void kal_critical_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
    extern void kal_critical_brief_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
    extern void kal_critical_assert_trace( trace_class_enum, kal_uint32, const kal_char* , ...);
    
    #define kal_trace(...)                  
    #define kal_brief_trace(...)            
    #define kal_trace_for_3rd_party(...)    
    #define kal_lib_trace(...)              
    #define kal_assert_trace(...)           
    #define kal_wap_trace(...)              
    #define kal_print_string_trace(...)     
    #define kal_buffer_trace(...)           
    #define kal_dev_trace(...)              
    #define kal_bootup_trace(...)           
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 0   
      
      #define TRACE_FUNC 0
      #define TRACE_STATE 1
      #define TRACE_INFO 2
      #define TRACE_WARNING 3
      #define TRACE_ERROR 4
      #define TRACE_GROUP_1 5
      #define TRACE_GROUP_2 6
      #define TRACE_GROUP_3 7
      #define TRACE_GROUP_4 8
      #define TRACE_GROUP_5 9
      #define TRACE_GROUP_6 10
      #define TRACE_GROUP_7 11
      #define TRACE_GROUP_8 12
      #define TRACE_GROUP_9 13
      #define TRACE_GROUP_10 14
      #define TRACE_PEER 15
    
      #undef kal_trace
      #undef kal_brief_trace
            
      #define _kal_trace(trace_class_enum, ...) kal_critical_trace_##trace_class_enum(trace_class_enum, __VA_ARGS__)
      #define _kal_brief_trace(trace_class_enum, ...) kal_critical_brief_trace_##trace_class_enum(trace_class_enum, __VA_ARGS__)
      
      #define kal_trace(trace_class_enum, ...) _kal_trace(trace_class_enum, __VA_ARGS__)
      #define kal_brief_trace(trace_class_enum, ...) _kal_brief_trace(trace_class_enum, __VA_ARGS__)
      
      //#define kal_assert_trace_(trace_class_enum, ...) kal_critical_assert_trace_##trace_class_enum(__VA_ARGS__)
      
      //declare the empty defined    
      #define kal_critical_trace_0(...)
      #define kal_critical_trace_1(...)
      #define kal_critical_trace_2(...)
      #define kal_critical_trace_3(...)      
      #define kal_critical_trace_5(...)
      #define kal_critical_trace_6(...)
      #define kal_critical_trace_7(...)
      #define kal_critical_trace_8(...)
      #define kal_critical_trace_9(...)
      #define kal_critical_trace_10(...)
      #define kal_critical_trace_11(...)
      #define kal_critical_trace_12(...)
      #define kal_critical_trace_13(...)
      #define kal_critical_trace_14(...)
      #define kal_critical_trace_15(...)
      
      #define kal_critical_brief_trace_0(...)
      #define kal_critical_brief_trace_1(...)
      #define kal_critical_brief_trace_2(...)
      #define kal_critical_brief_trace_3(...)      
      #define kal_critical_brief_trace_5(...)
      #define kal_critical_brief_trace_6(...)
      #define kal_critical_brief_trace_7(...)
      #define kal_critical_brief_trace_8(...)
      #define kal_critical_brief_trace_9(...)
      #define kal_critical_brief_trace_10(...)
      #define kal_critical_brief_trace_11(...)
      #define kal_critical_brief_trace_12(...)
      #define kal_critical_brief_trace_13(...)
      #define kal_critical_brief_trace_14(...)
      #define kal_critical_brief_trace_15(...)
      
      //ignore the known issues, wrap logging APIs in other APIs
      #define kal_critical_trace_trc_class(...)
      #define kal_critical_brief_trace_trc_class(...)
       
      //define ERROR --> 4
      #define kal_critical_trace_4 kal_critical_trace            
      #define kal_critical_brief_trace_4 kal_critical_brief_trace      
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 1  
      //define WARNING 3
      #undef kal_critical_trace_3      
      #undef kal_critical_brief_trace_3            
      #define kal_critical_trace_3 kal_critical_trace            
      #define kal_critical_brief_trace_3 kal_critical_brief_trace      
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 2
      //define TRACE_STATE 1
      #undef kal_critical_trace_1      
      #undef kal_critical_brief_trace_1
      #define kal_critical_trace_1 kal_critical_trace            
      #define kal_critical_brief_trace_1 kal_critical_brief_trace      
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 3
      //define TRACE_INFO 2
      #undef kal_critical_trace_2      
      #undef kal_critical_brief_trace_2
      #define kal_critical_trace_2 kal_critical_trace            
      #define kal_critical_brief_trace_2 kal_critical_brief_trace      
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 4
      //#define TRACE_PEER 15
      #undef kal_critical_trace_15
      #undef kal_critical_brief_trace_15
      #define kal_critical_trace_15 kal_critical_trace            
      #define kal_critical_brief_trace_15 kal_critical_brief_trace      
    #endif    
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 5
      //#define TRACE_GROUP_1 5    
      #undef kal_critical_trace_5
      #undef kal_critical_brief_trace_5
      #define kal_critical_trace_5 kal_critical_trace            
      #define kal_critical_brief_trace_5 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 6
      //#define TRACE_GROUP_2 6
      #undef kal_critical_trace_6
      #undef kal_critical_brief_trace_6
      #define kal_critical_trace_6 kal_critical_trace            
      #define kal_critical_brief_trace_6 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 7
      //#define TRACE_GROUP_3 7
      #undef kal_critical_trace_7
      #undef kal_critical_brief_trace_7
      #define kal_critical_trace_7 kal_critical_trace            
      #define kal_critical_brief_trace_7 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 8
      //#define TRACE_GROUP_4 8  
      #undef kal_critical_trace_8
      #undef kal_critical_brief_trace_8
      #define kal_critical_trace_8 kal_critical_trace            
      #define kal_critical_brief_trace_8 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 9
      //#define TRACE_GROUP_5 9    
      #undef kal_critical_trace_9
      #undef kal_critical_brief_trace_9
      #define kal_critical_trace_9 kal_critical_trace            
      #define kal_critical_brief_trace_9 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 10
      //#define TRACE_GROUP_6 10  
      #undef kal_critical_trace_10
      #undef kal_critical_brief_trace_10
      #define kal_critical_trace_10 kal_critical_trace            
      #define kal_critical_brief_trace_10 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 11
      //#define TRACE_GROUP_7 11
      #undef kal_critical_trace_11
      #undef kal_critical_brief_trace_11
      #define kal_critical_trace_11 kal_critical_trace            
      #define kal_critical_brief_trace_11 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 12
      //#define TRACE_GROUP_8 12
      #undef kal_critical_trace_12
      #undef kal_critical_brief_trace_12
      #define kal_critical_trace_12 kal_critical_trace            
      #define kal_critical_brief_trace_12 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 13
      //#define TRACE_GROUP_9 13
      #undef kal_critical_trace_13
      #undef kal_critical_brief_trace_13
      #define kal_critical_trace_13 kal_critical_trace            
      #define kal_critical_brief_trace_13 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 14
      //#define TRACE_GROUP_10 14     
      #undef kal_critical_trace_14
      #undef kal_critical_brief_trace_14
      #define kal_critical_trace_14 kal_critical_trace            
      #define kal_critical_brief_trace_14 kal_critical_brief_trace   
    #endif
    
    #if __TST_CRITICAL_TRACE_LEVEL__ > 15
      //#define TRACE_FUNC 0
      #undef kal_critical_trace_0     
      #undef kal_critical_brief_trace_0
      #define kal_critical_trace_0 kal_critical_trace            
      #define kal_critical_brief_trace_0 kal_critical_brief_trace      
    #endif
    
  #else  // #if defined(__TST_TRACE_EMPTY_FUNCTION__)
    //Define empty functions for Target SW
    #define kal_trace(...)
    #define kal_brief_trace(...)
    #define kal_trace_for_3rd_party(...)
    #define kal_lib_trace(...)
    #define kal_assert_trace(...)
    #define kal_wap_trace(...)
    #define kal_print_string_trace(...)
    #define kal_buffer_trace(...)
    #define kal_dev_trace(...)
    #define kal_bootup_trace(...)
    #define kal_critical_trace(...)
    #define kal_critical_brief_trace(...)
    #define kal_critical_assert_trace(...)    
  #endif   // #if defined(__TST_TRACE_EMPTY_FUNCTION__)
#endif  //__TST_TRACE_ENABLED__

#define kal_sys_trace        tst_sys_trace
#define kal_sys_init_trace   tst_sys_init_trace
#define kal_sys_fatal_trace  tst_sysfatal_trace

#ifdef __TST_MODULE__
 /*******************************************************************************
 * <GROUP Functions>
 * 
 * FUNCTION
 *  kal_prompt_trace
 * DESCRIPTION
 *  It's a printf-like function which outputs log to Catcher Tool.
 *  Property:
 *	The message is sent in plaintext
 *Ć	Cannot be invoked in LISR context.
 *Ć	Can send up to 128 bytes logs
 *Ć	This API can only be used in customer side to reduce the impact of ROM size increase.
 *Ć	Heavy resource consumption.
 *ƒÞ	  a.Caller¡¦s RO-DATA
 *ƒÞ	 	b. Logging Bandwidth
 *
 * PARAMETERS
 *  mod_id: [IN] Module id
 *  fmt: [IN] The format string. Please refer to print function of C standard library.
 * RETURNS
 *  NONE
 * NOTE
 *
 ******************************************************************************/
  extern void kal_prompt_trace(module_type mod_id, const kal_char *fmt,...);
  extern void tst_sys_init_trace(const kal_char *info);
  extern void tst_sys_trace(kal_char *info);
  extern void tst_sysfatal_trace(kal_char *info);
  extern kal_int32 tst_trace_check_ps_filter_off(trace_class_enum trc_class, kal_uint32* module_id, kal_uint32 supportOption);
  
  #define kal_bootup_print tst_sys_init_trace
#else
  #ifdef __TST_TRACE_EMPTY_FUNCTION__
    static __inline void kal_prompt_trace(module_type mod_id, const kal_char *fmt,...) {return ;}
    static __inline void tst_sys_init_trace(const kal_char *info) {return ;}
    static __inline void tst_sys_trace(kal_char *info) {return ;}
    static __inline void tst_sysfatal_trace(kal_char *info) {return ;}
    static __inline kal_int32 tst_trace_check_ps_filter_off(trace_class_enum trc_class, kal_uint32* module_id, kal_uint32 supportOption) {return ;}
  #else
    #define kal_prompt_trace(...)
    #define tst_sys_init_trace(...)
    #define tst_sys_trace(...)
    #define tst_sysfatal_trace(...)
    #define tst_trace_check_ps_filter_off(...)
  #endif
#endif  //#ifdef __TST_MODULE__

typedef void (*TST_VC_CallBack)(const kal_uint8* pData, kal_uint32 nLen);
typedef void (*TST_String_Inject_CB)(kal_uint32 index, kal_uint8 *pData);

/*
* tst_virtual_channel_id:
* regiester new virtual channel here and remake tst
*/
typedef enum
{
	TVCI_GPS_LOGGING,
	TVCI_DNT_L2COPRO_LOGGING,
	TVCI_CATCHER_POLLING,
	TVCI_GDB_COMM,
	TVCI_AST_LOGGING,
	TVCI_MINI_LOG,
	TVCI_VM_LOGGING,
	TVCI_LAST_ID
}
tst_virtual_channel_id;

kal_bool tst_vc_register_channel(tst_virtual_channel_id channel_id, TST_VC_CallBack fnCmd);
kal_bool tst_vc_response(tst_virtual_channel_id channel_id, const kal_uint8 *pData, kal_uint16 len);

#define TVCI_CREATE_FILE 0x24540001
#define TVCI_CLOSE_FILE 0x24540002

#ifdef __cplusplus
}
#endif

#endif /* _KAL_TRACE_H */