$DBG - Revision history

Admin: Created page with "
= Action
= Enables debugging output to the hardware UART.
2013-01-31T20:25:26Z

Created page with "<div id="idcontent"><div id="innerdiv"> = <span class="f_Header">Action</span><br/> = Enables debugging output to the hardware UART. <span style="font-family: 'Arial'; colo..."

New page
<div id="idcontent"><div id="innerdiv">
= <span class="f_Header">Action</span><br/> =

Enables debugging output to the hardware UART.

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

= <span class="f_Header">Syntax</span><br/> =

<span class="f_Syntax">$DBG</span>

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

= <span class="f_Header">Remarks</span><br/> =

Calculating the hardware, software and frame space can be a difficult task.

With $DBG the compiler will insert characters for the various spaces.

<span style="font-family: 'Arial'; color: #000000"> </span>

To the Frame space 'F' will be written. When you have a frame size of 4, FFFF will be written.

To the Hardware space 'H' will be written. If you have a hardware stack space of 8, HHHHHHHH will be written to this space.

To the software space 'S' will be written. If you have a software stack space of 6, SSSSSS will be written.

The idea is that when a character is overwritten, it is being used. So by watching these spaces you can determine if the space is used or not.

With the DBG statement a record is written to the HW UART. The record must be logged to a file so it can be analyzed by the stack analyzer.

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

Make the following steps to determine the proper values:

<span style="font-family: 'Arial'; color: #000000"> </span>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Make the frame space 40, the soft stack 20 and the HW stack 50
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Add $DBG to the top of your program
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Add a DBG statement to every Subroutine or Function
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Open the terminal emulator and open a new log file. By default it will have the name of your current program with the .log extension
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Run your program and notice that it will dump information to the terminal emulator
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| When your program has executed all sub modules or options you have build in, turn off the file logging and turn off the program
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Choose the Tools Stack analyzer option
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| A window will be shown with the data from the log file
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Press the Advise button that will determine the needed space. Make sure that there is at least one H, S and F in the data. Otherwise it means that all the data is overwritten and that you need to increase the size.
|}
</div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 11px">
{| style="line-height: normal" border="0" cellpadding="0" cellspacing="0"
|- style="vertical-align:baseline" valign="baseline"
| width="13" | <span style="font-size: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000">•</span>
| Press the Use button to use the advised settings.
|}
</div>
<span style="font-family: 'Arial'; color: #000000"> </span>

As an alternative you can watch the space in the simulator and determine if the characters are overwritten or not.

<span style="font-family: 'Arial'; color: #000000"> </span>

The DBG statement will assign an internal variable named _SUBROUTINE

Because the name of a SUB or Function may be 32 long, this variable uses 33 bytes!

<span style="font-family: 'Arial'; color: #000000"> </span>

_SUBROUTINE will be assigned with the name of the current SUB or FUNCTION.

<span style="font-family: 'Arial'; color: #000000"> </span>

When you first run a SUB named Test1234 it will be assigned with Test1234

When the next DBG statement is in a SUB named Test, it will be assigned with Test.

The 234 will still be there so it will be shown in the log file.

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

[[File:Tool stack.gif|center|Tool stack.gif]]

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

Every DBG record will be shown as a row.

The columns are:

<span style="font-family: 'Arial'; color: #000000"> </span>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 4px">
{| style="border: solid 2px #000000; border-spacing:0px; border-collapse: collapse" border="1" cellpadding="1" cellspacing="0" width="634"
|- style="text-align:left; vertical-align:top"
| style="width:33%; background-color:#ffff99; border: solid 1px #000000" valign="top" bgcolor="#ffff99" width="33%" |
<span style="font-weight: bold">Column</span>

| style="width:67%; background-color:#ffff99; border: solid 1px #000000" valign="top" bgcolor="#ffff99" width="67%" |
<span style="font-weight: bold">Description</span>

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
Sub

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Name of the sub or function from where the DBG was used

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
FS

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Used frame space

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
SS

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Used software stack space

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
HS

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Used hardware stack space

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
Frame space

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Frame space

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
Soft stack

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Soft stack space

|- style="text-align:left; vertical-align:top"
| style="width:33%; border: solid 1px #000000" valign="top" width="33%" |
HW stack

| style="width:67%; border: solid 1px #000000" valign="top" width="67%" |
Hardware stack space

|}
</div>
<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

The Frame space is used to store temp and local variables.

It also stores the variables that are passed to subs/functions by value.

Because PRINT , INPUT and the FP num<>String conversion routines require a buffer, the compiler always is using 24 bytes of frame space.

<span style="font-family: 'Arial'; color: #000000"> </span>

When the advise is to use 2 bytes of frame space, the setting will be 24+2=26.

<span style="font-family: 'Arial'; color: #000000"> </span>

For example when you use : print var, var need to be converted into a string before it can be printed or shown with LCD.

<span style="font-family: 'Arial'; color: #000000"> </span>

An alternative for the buffer would be to setup a temp buffer and free it once finished. This gives more code overhead.

In older version of BASCOM the start of the frame was used for the buffer but that gave conflicts when variables were printed from an ISR.

<span style="font-family: 'Arial'; color: #000000"> </span>

<span style="font-family: 'Arial'; color: #000000"> </span>

= <span class="f_Header">See also</span><br/> =

[[DBG]]

{{Languages}}

[[Category:BASCOM_Language_Reference]]
</div></div>