platforms/os/common/inc/tracebuf_api.h
changeset 0 10c42ec6c05f
equal deleted inserted replaced
-1:000000000000 0:10c42ec6c05f
       
     1 /*
       
     2  * tracebuf_api.h
       
     3  *
       
     4  * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.      
       
     5  * All rights reserved.      
       
     6  * 
       
     7  * This program and the accompanying materials are made available under the 
       
     8  * terms of the Eclipse Public License v1.0 or BSD License which accompanies
       
     9  * this distribution. The Eclipse Public License is available at
       
    10  * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.                                   
       
    11  *                                                                       
       
    12  * Redistribution and use in source and binary forms, with or without    
       
    13  * modification, are permitted provided that the following conditions    
       
    14  * are met:                                                              
       
    15  *                                                                       
       
    16  *  * Redistributions of source code must retain the above copyright     
       
    17  *    notice, this list of conditions and the following disclaimer.      
       
    18  *  * Redistributions in binary form must reproduce the above copyright  
       
    19  *    notice, this list of conditions and the following disclaimer in    
       
    20  *    the documentation and/or other materials provided with the         
       
    21  *    distribution.                                                      
       
    22  *  * Neither the name Texas Instruments nor the names of its            
       
    23  *    contributors may be used to endorse or promote products derived    
       
    24  *    from this software without specific prior written permission.      
       
    25  *                                                                       
       
    26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   
       
    27  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     
       
    28  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
       
    29  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  
       
    30  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
       
    31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      
       
    32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
       
    33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
       
    34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   
       
    35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
       
    36  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    37  */
       
    38 
       
    39 /*
       
    40  * Benchmark tracing utility
       
    41  */
       
    42 
       
    43 #ifndef TB_TRACE_API_H
       
    44 
       
    45 #define TB_TRACE_API_H
       
    46 
       
    47 #ifdef TI_TRACE_BUF
       
    48 
       
    49 #define TB_NUM_ENTRIES 256
       
    50 #define MAX_TB_MSG 128
       
    51 
       
    52 #define TB_OPTION_NONE      0x00000000
       
    53 #define TB_OPTION_AUTOPRINT 0x00000001
       
    54 #define TB_OPTION_PRINTONCE 0x00000002
       
    55 #define TB_OPTION_STOP      0x80000000
       
    56 
       
    57 /* Initialization */
       
    58 int  tb_init(unsigned long options);
       
    59 int  tb_sprintf(const char *format ,...);
       
    60 int  tb_trace(int loc, unsigned long p1, unsigned long p2);
       
    61 void tb_destroy(void);
       
    62 void tb_scan(void);
       
    63 void tb_dump(void);
       
    64 void tb_printf(void);
       
    65 void tb_set_option(unsigned long option);
       
    66 void tb_reset_option(unsigned long option);
       
    67 
       
    68 #define tb_min(x,y) (((x)<(y)) ? (x) : (y)) 
       
    69 
       
    70 #else  /* #ifdef TI_TRACE_BUF */
       
    71 
       
    72 #define tb_init(options)
       
    73 
       
    74 /*#define tb_sprintf(format ,...)*/
       
    75 #define tb_trace(loc, p1, p2)
       
    76 #define tb_destroy()
       
    77 #define tb_scan()
       
    78 #define tb_dump()
       
    79 #define tb_printf()
       
    80 #define tb_set_option(option)
       
    81 #define tb_reset_option(option)
       
    82 
       
    83 #endif /* #ifdef TI_TRACE_BUF */
       
    84 
       
    85 #endif