{"id":6397,"date":"2020-07-01T17:55:36","date_gmt":"2020-07-02T00:55:36","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=6397"},"modified":"2022-03-14T08:20:03","modified_gmt":"2022-03-14T15:20:03","slug":"observing-itm-trace-output-from-arm-targets-with-segger-j-link","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/arm\/itm\/","title":{"rendered":"Observing ITM Trace Output from ARM Targets with Segger J-Link"},"content":{"rendered":"

This tutorial shows how to configure VisualGDB to view the debug output produced by ARM targets via the ITM_SendChar<\/span>()<\/strong> function. We will create a basic project for the nRF52840 device using Segger J-Link and will show how to configure VisualGDB to view the ITM output.<\/p>\n

ITM is a mechanism that allows sending arbitrary text directly to the debugger, reusing the regular JTAG\/SWD interface. It is supported by most ARM targets and works reliably with Segger J-Link probes when using the J-Link software. It is also theoretically supported by OpenOCD, however works less reliable.<\/p>\n

Note that for most scenarios, we recommend using our Fast Semihosting<\/a> mechanism instead. It relies on background memory reads and works much faster than ITM, or any other tracing mechanisms.<\/p>\n

    \n
  1. Start Visual Studio and select the VisualGDB Embedded Project Wizard. Then pick the name and location of the project:\"\"<\/a><\/li>\n
  2. Proceed with creating a new embedded binary using MSBuild:\"\"<\/a><\/li>\n
  3. On the next page select your toolchain and device. ITM tracing will work with most ARM-based targets. In this tutorial we will use the Nordic nRF52840 device, as its evaluation board includes an on-board J-Link debug probe:\"\"<\/a><\/li>\n
  4. Pick a sample project to clone. In this tutorial we will use the basic “LEDBlink (BSP)<\/strong>” sample: \"\"<\/a><\/li>\n
  5. Finally, choose the debug settings that work with your board. The ITM only works reliably with Segger J-Link, so make sure you are using the J-Link software:\"\"<\/a>For other debug methods, consider using the Fast Semihosting<\/a> instead.<\/li>\n
  6. Press “Finish” to generate a project based on the sample. Then add the following function to the main file and call it from main()<\/strong>:\n
    static void ITMPrint(const char *pString)\r\n{\r\n    for (const char *p = pString; *p; p++)\r\n        ITM_SendChar(*p);\r\n}<\/pre>\n
    \"\"<\/a><\/li>\n
  7. If you just start debugging the project, the ITMPrint()<\/strong> function will work, however the output it produces will not be shown anywhere:\"\"<\/a><\/li>\n
  8. To enable reading of the ITM messages, run the SWO EnableTarget<\/a> command in the GDB session window:\n
    monitor SWO EnableTarget 0 0 1 0<\/pre>\n
    \"\"<\/a><\/li>\n
  9. Now you can connect to the port 2332<\/strong> on localhost using telnet to see the output from printf. You can find out the exact port number (normally, 2332<\/strong>) in the J-Link window:\"\"<\/a>Note that if you are using VisualGDB 5.5 or later, the output from JLinkGDBServerCL<\/strong> will be shown as one of the tabs inside the generic VisualGDB Output<\/strong> window that can be opened via a command under Debug->Windows<\/strong>.<\/li>\n
  10. To make the ITM output appear in VisualGDB GUI, add the “monitor SWO EnableTarget 0 0 1 0” command to the post-target GDB commands: \"\"<\/a><\/li>\n
  11. Then enable the raw terminal (Custom edition and higher) to connect to that port: \"\"<\/a><\/li>\n
  12. Now you will see the output from ITM_SendChar()\u00a0<\/strong>directly in Visual Studio: \u00a0 \"\"<\/a><\/li>\n
  13. If the output from the Segger J-Link does not match the characters passed to ITM_SendChar()<\/strong>, the automatic detection of the CPU and SWO frequencies may not be working (or the CPU frequency could be changed after it was detected). In this case you may need to specify the CPU and SWO frequency explicitly in the “monitor SWO EnableTarget” command as shown on this page<\/a>.<\/li>\n
  14. You can also use the regular printf() <\/strong>call as long as you define a _write()<\/strong> function somewhere in your code:\n
    extern \"C\" int _write(int fd, char *pBuffer, int size)\r\n{\r\n    for (int i = 0; i < size; i++)\r\n        ITM_SendChar(pBuffer[i]);\r\n    return size;\r\n}<\/pre>\n
    \"\"<\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to configure VisualGDB to view the debug output produced by ARM targets via the ITM_SendChar() function.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[27],"tags":[],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6397"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=6397"}],"version-history":[{"count":5,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6397\/revisions"}],"predecessor-version":[{"id":7806,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6397\/revisions\/7806"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=6397"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=6397"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=6397"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}