Graphics framework for GR-PEACH. When you use this program, we judge you have agreed to the following contents. https://developer.mbed.org/teams/Renesas/wiki/About-LICENSE

Dependents:   ImageZoomInout_Sample ImageRotaion_Sample ImageScroll_Sample GR-PEACH_LCD_4_3inch_Save_to_USB ... more

Embed: (wiki syntax)

« Back to documentation index

r_ospl_debug.h File Reference

r_ospl_debug.h File Reference

Debug tools provided by OSPL. More...

Go to the source code of this file.

Functions

void R_D_Add (int_fast32_t IndexNum, volatile const void *Address, uint32_t BreakValue, bool_t IsPrintf)
 Registers watching integer variable or pointer variable.
void R_D_Watch (int_fast32_t IndexNum)
 Show and Check watching variable's value.
void R_D_AddToIntLog (int_fast32_t Value)
 Records to the log fast.
bool_t R_D_Counter (int_fast32_t *in_out_Counter, int_fast32_t TargetCount, char_t *Label)
 Count the through count.

Variables

volatile int_fast32_t g_IntLog [g_IntLogCount]
 Memory area of int log.
volatile int_fast32_t g_IntLogLength
 Length of recorded in <g_IntLog>
volatile uint_fast32_t g_DebugVar [g_DebugVarCount]
 Debug variables.

Detailed Description

Debug tools provided by OSPL.

Module:
OSPL
PublicVersion:
0.90

(=R_OSPL_VERSION)

Rev:
35
Date:
2014-04-15 21:38:18 +0900#

Definition in file r_ospl_debug.h.


Function Documentation

void R_D_Add ( int_fast32_t  IndexNum,
volatile const void *  Address,
uint32_t  BreakValue,
bool_t  IsPrintf 
)

Registers watching integer variable or pointer variable.

Parameters:
IndexNumWatch Number, 0 or more
AddressAddress of watching integer variable or pointer variable
BreakValueBreaking value of variable when "R_D_Watch" was called
IsPrintfWhether "printf" is called, when "R_D_Watch" was called
Returns:
None
Description
R_D_Add and R_D_Watch are APIs related to watch function. This debug tool is available, if R_OSPL_DEBUG_TOOL was set to 1.

There is not this function, if R_OSPL_DEBUG_TOOL macro was defined to be 0. This function is available, if R_OSPL_DEBUG_TOOL macro was defined to be 1.

Example
    R_D_Add( 0, &var, 0xB0, true );  // 0xB0 may be not hit

Definition at line 85 of file r_ospl_debug.c.

void R_D_AddToIntLog ( int_fast32_t  Value )

Records to the log fast.

Parameters:
ValueRecording value
Returns:
None
Description
R_D_AddToIntLog, g_IntLog and g_IntLogLength are APIs related to Int Log function. This debug tool is available, if R_OSPL_DEBUG_TOOL was set to 1. This function overwrites from the first of the log, if max element value of "g_IntLog" was over. It is recommended to record not only the showing value of variable, but also the value of the identifier of the place and the value of current time.

There is not this function, if R_OSPL_DEBUG_TOOL macro was defined to be 0. This function is available, if R_OSPL_DEBUG_TOOL macro was defined to be 1.

If internal data of the debug tool was broken, the global variable in "r_ospl_debug.o" file should be move to safe address (memory map).

Definition at line 148 of file r_ospl_debug.c.

bool_t R_D_Counter ( int_fast32_t *  in_out_Counter,
int_fast32_t  TargetCount,
char_t *  Label 
)

Count the through count.

Parameters:
in_out_CounterInput/Output: The through counter
TargetCountThe value comparing with the through counter
LabelThe label for "printf", NULL=printf : no output
Returns:
None
Description
This debug tool is available, if R_OSPL_DEBUG_TOOL was set to 1. If this function was called with "TargetCount = 0", the count of through is output by "printf" for each calling. If "TargetCount" argument was set to the through count and restart the program, when the counter was counted up to "TargetCount", this function returns "true". If there were many "printf" output, set "Label = NULL". At first calling, the address of the counter is output by "printf". The counter can be look by the debugger.
Example
    { static int tc;  if ( R_D_Counter( &tc, 0, "A" ) ) {
    R_DEBUG_BREAK(); }}

Definition at line 163 of file r_ospl_debug.c.

void R_D_Watch ( int_fast32_t  IndexNum )

Show and Check watching variable's value.

Parameters:
IndexNumWatch Number, 0 or more
Returns:
None
Description
R_D_Add and R_D_Watch are APIs related to watch function. This debug tool is available, if "R_OSPL_DEBUG_TOOL" was set to 1. This function calls "printf" with the value of variable registered by "R_D_Add" and breaks when watching variable becomes registered value. This function can be called from out of scope of registered variable. Then this function can be written at many places without care of the scope.

There is not this function, if R_OSPL_DEBUG_TOOL macro was defined to be 0. This function is available, if R_OSPL_DEBUG_TOOL macro was defined to be 1.

If internal data of the debug tool was broken, the global variable in "r_ospl_debug.o" file should be move to safe address (memory map).

Example
    printf( 41 );  // Show the value indicated this place
    R_D_Watch( 0 );

Definition at line 112 of file r_ospl_debug.c.


Variable Documentation

volatile uint_fast32_t g_DebugVar[g_DebugVarCount]

Debug variables.

Definition at line 144 of file r_ospl_debug.c.

volatile int_fast32_t g_IntLog[g_IntLogCount]

Memory area of int log.

Definition at line 145 of file r_ospl_debug.c.

volatile int_fast32_t g_IntLogLength

Length of recorded in <g_IntLog>

Definition at line 146 of file r_ospl_debug.c.