Solving the Kinetis Debug Clock problem for Serial and CAN development

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Solving the Kinetis Debug Clock problem for Serial and CAN development

andrewmeyerbti
Contributor III
0 0 1,388

The internal clock frequency of Kinetis chips varies due to manufacturing tolerances. A trim value is programmed into the chips to compensate for this variance and make the slow bus frequency uniform between chips.

 

For some inexplicable reason, this trim value is not active during debug mode. This makes developing serial and CAN applications very difficult, as the baud rates which are set are not the baud rates which are achieved. To make matters worse, if I understand the documentation correctly, the baud rate in debug mode is different from the baud rate in normal mode.

 

I am working with KDS and USBDM which makes a beautiful IDE and works with processor expert. Unfortunately KDS is no longer under development and S32 does not support processor expert for my chips. Porting over to a newer development environment might help with the clock frequency issues, but with existing projects and code bases that is not an attractive solution. Perhaps some of these problems do not occur with commercial software or have been resolved in MCU Expresso and S32 design studio.

 

So, to fix this clock issue with KDS perform the following.

Load the trim value from memory you can control

ICS_Clock_Trim_html_2020a16211954dbd.png

Figure 1: The processor expert tab with the processor selected

 

Go to the processor expert tab and click on your processor. In my case the processor is a SKEAZN64MLC2.

 

ICS_Clock_Trim_html_f8bc5d1c7d00b470.png

Figure 2: Adding code to initialize trim values from known memory locations

Maximize the component inspector so that you can see all the settings. Click on the Advanced tab, and put a check mark in the “Initialize slow trim value” box.

 

Clicking the “Initialize slow trim value” box writes the following code in the generated file CPU.c in order to load the trim value from addresses 0x3FE and 0x3FF.

 

if ( *((uint8_t*) 0x03FFU) != 0xFFU) {

ICS_C3 = *((uint8_t*) 0x03FFU);

ICS_C4 = (ICS_C4 & 0xFEU) | ((*((uint8_t*) 0x03FEU)) & 0x01U);

}

 

That part was easy.

 

Create linker memory description for locations 03FE and 03FF.

ICS_Clock_Trim_html_4888c69c58ea6fc2.png

Figure 3: Adding a memory section for the values to be initialized.

Still in processor expert with your processor selected, go to the build options tab and select Generate linker file. If the check box for "Generate linker file" is not checked check it (after saving your linker file by checking it into git so that you can compare changes and restore any prior modifications). Add a Rom/Ram area by clicking on the “+” button—my new section is called “m_init_clks_debug”. Set the qualifier to RX so the linker knows it is for flash memory. Since memory is in 4 byte units on this chip, set it at address 0x3FC and make it 4 bytes long.

 

Adding the line to the ROM/RAM areas in the CPU component declares a memory location for a new section by adding the line

m_init_clks_debug (RX) : ORIGIN = 0x000003FC, LENGTH = 0x00000004

to the linker file ProcessorExpert.ld,

Initialize the memory locations.

ICS_Clock_Trim_html_1313ab15d7d9da81.png

Figure 4: Initializing the memory location values.

 

Go to the Build-options tab and select the filter User initialization. Click the three dots next to User data declarations to brings up a dialog where data declaration code can be written. Fill in the dialog with

 

const __attribute__ ((section (".init_clks_debug"))) uint8_t dbg_clk_init[4] =

{

0x00,

0x00,

0x00,

0x9A

};

 

to create an array "dbg_clck_init[4]" in section ".init_clks_debug" and initialize its values in memory. The value 0x9A is the trim value, which will be unique for each chip.

 

Code written in the “User data declarations” dialog box is written in the beginning of the CPU.c file every time the component is regenerated. If you add the code manually to the CPU.c file, the code will be erased each time the file is regenerated.

 

Make the ".init_clks_debug" section in the linker file.

ICS_Clock_Trim_html_b2fe6c302b695d0c.png

Figure 5: Editing the processor expert linker file

 

I have found no way to do this through processor expert, so generate your processor expert code to add all the changes made in the earlier steps into your generated c code. Then go back to the <Processor Expert> <Build Options><Generate linker file> tab (Figure 3) and un-check the “Generate linker file” check box. This will prevent further modification of your linker file, and allow you to create the necessary section manually.

 

Open the linker file and add the following code to create the necessary section to put your initialized dbg_clk_init array into.

.init_clks_debug :

{

dbg_clk_init = .;

. = ALIGN(4);

KEEP(*(.init_clks_debug )) /* Startup code */

. = ALIGN(4);

} > m_init_clks_debug

 

Determine the proper trim value for your unique chip.

ICS_Clock_Trim_html_a18b28b179184efe.png

Figure 6: Finding the trim value

 

So far, it has worked for me to set a break point at the beginning of the code that was added to the Cpu.c file,

 if ( *((uint8_t*) 0x03FFU) != 0xFFU) {

ICS_C3 = *((uint8_t*) 0x03FFU);

ICS_C4 = (ICS_C4 & 0xFEU) | ((*((uint8_t*) 0x03FEU)) & 0x01U);

}

and to inspect the ICS.C3 and ICS.C4 registers in the EmbSys Registers tab of the debug perspective as in figure 6.

 

This begs the question—why was all this necessary? Before doing this work the value showing in ICS.C3 was 0x80, which may be some default? This caused to set baud rate of 36000 to give an actual baud rate of 38400 on one chip, something different on another chip. Worse yet, according to the documentation the baud rate is not the same in debug mode and normal operating mode. After making these modifications and programming the proper trim value, the set baud rate matches actual baud rate that the serial or CAN bus uses.

 

A further benefit is that you can program a non-standard value to set a non-standard baud rate if there is a need. From the data sheet:

 

ICS_C3 is automatically loaded during reset from a factory programmed location when not in a debug

mode. The factory programmed trim value adjusts the internal oscillator frequency to fint_ft as specified in

the datasheet. The user can provide a custom trim value to attain other internal reference clock

frequencies within the fint_t range. The custom trim value must be programmed into reserved flash

location 0x0000_03FF and copied to ICS_C3 during code initialization.

 

Each increase in the ICS.C3 setting lowers the frequency of the intermediate clock bus by approximately 100 cycles per second.