trace.h
上传用户:jnhtjd
上传日期:2022-07-16
资源大小:403k
文件大小:9k
源码类别:

微处理器开发

开发平台:

C/C++

  1. /* ----------------------------------------------------------------------------
  2.  *         ATMEL Microcontroller Software Support 
  3.  * ----------------------------------------------------------------------------
  4.  * Copyright (c) 2008, Atmel Corporation
  5.  *
  6.  * All rights reserved.
  7.  *
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions are met:
  10.  *
  11.  * - Redistributions of source code must retain the above copyright notice,
  12.  * this list of conditions and the disclaimer below.
  13.  *
  14.  * Atmel's name may not be used to endorse or promote products derived from
  15.  * this software without specific prior written permission.
  16.  *
  17.  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19.  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  20.  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  23.  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  24.  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  25.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26.  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  * ----------------------------------------------------------------------------
  28.  */
  29. //------------------------------------------------------------------------------
  30. /// unit
  31. ///
  32. /// !Purpose
  33. ///
  34. /// Standard output methods for reporting debug information, warnings and
  35. /// errors, which can be easily be turned on/off.
  36. ///
  37. /// !Usage
  38. /// -# Initialize the DBGU using TRACE_CONFIGURE() if you intend to eventually
  39. ///    disable ALL traces; otherwise use DBGU_Configure().
  40. /// -# Uses the TRACE_DEBUG(), TRACE_INFO(), TRACE_WARNING(), TRACE_ERROR()
  41. ///    TRACE_FATAL() macros to output traces throughout the program.
  42. /// -# Each type of trace has a level : Debug 5, Info 4, Warning 3, Error 2
  43. ///    and Fatal 1. Disable a group of traces by changing the value of 
  44. ///    TRACE_LEVEL during compilation; traces with a level bigger than TRACE_LEVEL 
  45. ///    are not generated. To generate no trace, use the reserved value 0.
  46. /// -# Trace disabling can be static or dynamic. If dynamic disabling is selected
  47. ///    the trace level can be modified in runtime. If static disabling is selected
  48. ///    the disabled traces are not compiled.
  49. ///
  50. /// !Trace level description
  51. /// -# TRACE_DEBUG (5): Traces whose only purpose is for debugging the program, 
  52. ///    and which do not produce meaningful information otherwise.
  53. /// -# TRACE_INFO (4): Informational trace about the program execution. Should  
  54. ///    enable the user to see the execution flow.
  55. /// -# TRACE_WARNING (3): Indicates that a minor error has happened. In most case
  56. ///    it can be discarded safely; it may even be expected.
  57. /// -# TRACE_ERROR (2): Indicates an error which may not stop the program execution, 
  58. ///    but which indicates there is a problem with the code.
  59. /// -# TRACE_FATAL (1): Indicates a major error which prevents the program from going
  60. ///    any further.
  61. //------------------------------------------------------------------------------
  62. #ifndef TRACE_H
  63. #define TRACE_H
  64. //------------------------------------------------------------------------------
  65. //         Headers
  66. //------------------------------------------------------------------------------
  67. #include <board.h>
  68. #include <dbgu/dbgu.h>
  69. #include <pio/pio.h>
  70. #include <stdio.h>
  71. //------------------------------------------------------------------------------
  72. //         Global Definitions
  73. //------------------------------------------------------------------------------
  74. /// Softpack Version
  75. #define SOFTPACK_VERSION "1.5"
  76. #define TRACE_LEVEL_DEBUG      5
  77. #define TRACE_LEVEL_INFO       4
  78. #define TRACE_LEVEL_WARNING    3
  79. #define TRACE_LEVEL_ERROR      2
  80. #define TRACE_LEVEL_FATAL      1
  81. #define TRACE_LEVEL_NO_TRACE   0
  82. // By default, all traces are output except the debug one.
  83. #if !defined(TRACE_LEVEL)    
  84. #define TRACE_LEVEL TRACE_LEVEL_INFO
  85. #endif
  86. // By default, trace level is static (not dynamic)
  87. #if !defined(DYN_TRACES)
  88. #define DYN_TRACES 0
  89. #endif
  90. #if defined(NOTRACE)
  91. #error "Error: NOTRACE has to be not defined !"
  92. #endif
  93. #undef NOTRACE
  94. #if (TRACE_LEVEL == TRACE_LEVEL_NO_TRACE)
  95. #define NOTRACE
  96. #endif
  97. //------------------------------------------------------------------------------
  98. //         Global Macros
  99. //------------------------------------------------------------------------------
  100. //------------------------------------------------------------------------------
  101. /// Initializes the DBGU
  102. /// param mode  DBGU mode.
  103. /// param baudrate  DBGU baudrate.
  104. /// param mck  Master clock frequency.
  105. //------------------------------------------------------------------------------
  106. #define TRACE_CONFIGURE(mode, baudrate, mck) { 
  107.     const Pin pinsDbgu[] = {PINS_DBGU}; 
  108.     PIO_Configure(pinsDbgu, PIO_LISTSIZE(pinsDbgu)); 
  109.     DBGU_Configure(mode, baudrate, mck); 
  110.     }
  111. //------------------------------------------------------------------------------
  112. /// Initializes the DBGU for ISP project
  113. /// param mode  DBGU mode.
  114. /// param baudrate  DBGU baudrate.
  115. /// param mck  Master clock frequency.
  116. //------------------------------------------------------------------------------
  117. #if (TRACE_LEVEL==0) && (DYNTRACE==0)
  118. #define TRACE_CONFIGURE_ISP(mode, baudrate, mck) {}
  119. #else
  120. #define TRACE_CONFIGURE_ISP(mode, baudrate, mck) { 
  121.     const Pin pinsDbgu[] = {PINS_DBGU}; 
  122.     PIO_Configure(pinsDbgu, PIO_LISTSIZE(pinsDbgu)); 
  123.     DBGU_Configure(mode, baudrate, mck); 
  124.     }
  125. #endif
  126. //------------------------------------------------------------------------------
  127. /// Outputs a formatted string using <printf> if the log level is high
  128. /// enough. Can be disabled by defining TRACE_LEVEL=0 during compilation.
  129. /// param format  Formatted string to output.
  130. /// param ...  Additional parameters depending on formatted string.
  131. //------------------------------------------------------------------------------
  132. #if defined(NOTRACE)
  133. // Empty macro
  134. #define TRACE_DEBUG(...)      { }
  135. #define TRACE_INFO(...)       { }
  136. #define TRACE_WARNING(...)    { }               
  137. #define TRACE_ERROR(...)      { }
  138. #define TRACE_FATAL(...)      { while(1); }
  139. #define TRACE_DEBUG_WP(...)   { }
  140. #define TRACE_INFO_WP(...)    { }
  141. #define TRACE_WARNING_WP(...) { }
  142. #define TRACE_ERROR_WP(...)   { }
  143. #define TRACE_FATAL_WP(...)   { while(1); }
  144. #elif (DYN_TRACES == 1)
  145. // Trace output depends on traceLevel value
  146. #define TRACE_DEBUG(...)      { if (traceLevel >= TRACE_LEVEL_DEBUG)   { printf("-D- " __VA_ARGS__); } }
  147. #define TRACE_INFO(...)       { if (traceLevel >= TRACE_LEVEL_INFO)    { printf("-I- " __VA_ARGS__); } }
  148. #define TRACE_WARNING(...)    { if (traceLevel >= TRACE_LEVEL_WARNING) { printf("-W- " __VA_ARGS__); } }
  149. #define TRACE_ERROR(...)      { if (traceLevel >= TRACE_LEVEL_ERROR)   { printf("-E- " __VA_ARGS__); } }
  150. #define TRACE_FATAL(...)      { if (traceLevel >= TRACE_LEVEL_FATAL)   { printf("-F- " __VA_ARGS__); while(1); } }
  151. #define TRACE_DEBUG_WP(...)   { if (traceLevel >= TRACE_LEVEL_DEBUG)   { printf(__VA_ARGS__); } }
  152. #define TRACE_INFO_WP(...)    { if (traceLevel >= TRACE_LEVEL_INFO)    { printf(__VA_ARGS__); } }
  153. #define TRACE_WARNING_WP(...) { if (traceLevel >= TRACE_LEVEL_WARNING) { printf(__VA_ARGS__); } }
  154. #define TRACE_ERROR_WP(...)   { if (traceLevel >= TRACE_LEVEL_ERROR)   { printf(__VA_ARGS__); } }
  155. #define TRACE_FATAL_WP(...)   { if (traceLevel >= TRACE_LEVEL_FATAL)   { printf(__VA_ARGS__); while(1); } }
  156. #else
  157. // Trace compilation depends on TRACE_LEVEL value
  158. #if (TRACE_LEVEL >= TRACE_LEVEL_DEBUG)
  159. #define TRACE_DEBUG(...)      { printf("-D- " __VA_ARGS__); }
  160. #define TRACE_DEBUG_WP(...)   { printf(__VA_ARGS__); }
  161. #else
  162. #define TRACE_DEBUG(...)      { }
  163. #define TRACE_DEBUG_WP(...)   { }
  164. #endif
  165. #if (TRACE_LEVEL >= TRACE_LEVEL_INFO)
  166. #define TRACE_INFO(...)       { printf("-I- " __VA_ARGS__); }
  167. #define TRACE_INFO_WP(...)    { printf(__VA_ARGS__); }
  168. #else
  169. #define TRACE_INFO(...)       { }
  170. #define TRACE_INFO_WP(...)    { }
  171. #endif
  172. #if (TRACE_LEVEL >= TRACE_LEVEL_WARNING)
  173. #define TRACE_WARNING(...)    { printf("-W- " __VA_ARGS__); }
  174. #define TRACE_WARNING_WP(...) { printf(__VA_ARGS__); }
  175. #else
  176. #define TRACE_WARNING(...)    { }
  177. #define TRACE_WARNING_WP(...) { }
  178. #endif
  179. #if (TRACE_LEVEL >= TRACE_LEVEL_ERROR)
  180. #define TRACE_ERROR(...)      { printf("-E- " __VA_ARGS__); }
  181. #define TRACE_ERROR_WP(...)   { printf(__VA_ARGS__); }
  182. #else
  183. #define TRACE_ERROR(...)      { }
  184. #define TRACE_ERROR_WP(...)   { }
  185. #endif
  186. #if (TRACE_LEVEL >= TRACE_LEVEL_FATAL)
  187. #define TRACE_FATAL(...)      { printf("-F- " __VA_ARGS__); while(1); }
  188. #define TRACE_FATAL_WP(...)   { printf(__VA_ARGS__); while(1); }
  189. #else
  190. #define TRACE_FATAL(...)      { while(1); }
  191. #define TRACE_FATAL_WP(...)   { while(1); }
  192. #endif
  193. #endif
  194. //------------------------------------------------------------------------------
  195. //         Exported variables
  196. //------------------------------------------------------------------------------
  197. // Depending on DYN_TRACES, traceLevel is a modifable runtime variable
  198. // or a define
  199. #if !defined(NOTRACE) && (DYN_TRACES == 1)
  200.     extern unsigned int traceLevel;
  201. #endif
  202. #endif //#ifndef TRACE_H