Madhura Tapse / Mbed OS mbed-os-example-blinky

fdf

README.md@0:7ae7e0d50b5e, 2020-05-21 (annotated)

Committer:
MadhuraT
Date:
Thu May 21 17:19:42 2020 +0000
Revision:
0:7ae7e0d50b5e
adf

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MadhuraT 0:7ae7e0d50b5e 1 # Getting started example for Mbed OS
MadhuraT 0:7ae7e0d50b5e 2
MadhuraT 0:7ae7e0d50b5e 3 This guide reviews the steps required to get Blinky with the addition of dynamic OS statistics working on an Mbed OS platform.
MadhuraT 0:7ae7e0d50b5e 4
MadhuraT 0:7ae7e0d50b5e 5 Please install [mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
MadhuraT 0:7ae7e0d50b5e 6
MadhuraT 0:7ae7e0d50b5e 7 ## Import the example application
MadhuraT 0:7ae7e0d50b5e 8
MadhuraT 0:7ae7e0d50b5e 9 From the command-line, import the example:
MadhuraT 0:7ae7e0d50b5e 10
MadhuraT 0:7ae7e0d50b5e 11 ```
MadhuraT 0:7ae7e0d50b5e 12 mbed import mbed-os-example-blinky
MadhuraT 0:7ae7e0d50b5e 13 cd mbed-os-example-blinky
MadhuraT 0:7ae7e0d50b5e 14 ```
MadhuraT 0:7ae7e0d50b5e 15
MadhuraT 0:7ae7e0d50b5e 16 ### Now compile
MadhuraT 0:7ae7e0d50b5e 17
MadhuraT 0:7ae7e0d50b5e 18 Invoke `mbed compile`, and specify the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
MadhuraT 0:7ae7e0d50b5e 19
MadhuraT 0:7ae7e0d50b5e 20 ```
MadhuraT 0:7ae7e0d50b5e 21 mbed compile -m K64F -t ARM
MadhuraT 0:7ae7e0d50b5e 22 ```
MadhuraT 0:7ae7e0d50b5e 23
MadhuraT 0:7ae7e0d50b5e 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
MadhuraT 0:7ae7e0d50b5e 25
MadhuraT 0:7ae7e0d50b5e 26 ```
MadhuraT 0:7ae7e0d50b5e 27 [snip]
MadhuraT 0:7ae7e0d50b5e 28 +----------------------------+-------+-------+------+
MadhuraT 0:7ae7e0d50b5e 29 | Module | .text | .data | .bss |
MadhuraT 0:7ae7e0d50b5e 30 |--------------------|-----------|----------|----------|
MadhuraT 0:7ae7e0d50b5e 31 | [fill] | 98(+0) | 0(+0) | 2211(+0) |
MadhuraT 0:7ae7e0d50b5e 32 | [lib]/c.a | 27835(+0) | 2472(+0) | 89(+0) |
MadhuraT 0:7ae7e0d50b5e 33 | [lib]/gcc.a | 3168(+0) | 0(+0) | 0(+0) |
MadhuraT 0:7ae7e0d50b5e 34 | [lib]/misc | 248(+0) | 8(+0) | 28(+0) |
MadhuraT 0:7ae7e0d50b5e 35 | [lib]/nosys.a | 32(+0) | 0(+0) | 0(+0) |
MadhuraT 0:7ae7e0d50b5e 36 | main.o | 924(+0) | 0(+0) | 12(+0) |
MadhuraT 0:7ae7e0d50b5e 37 | mbed-os/components | 134(+0) | 0(+0) | 0(+0) |
MadhuraT 0:7ae7e0d50b5e 38 | mbed-os/drivers | 56(+0) | 0(+0) | 0(+0) |
MadhuraT 0:7ae7e0d50b5e 39 | mbed-os/features | 42(+0) | 0(+0) | 184(+0) |
MadhuraT 0:7ae7e0d50b5e 40 | mbed-os/hal | 2087(+0) | 8(+0) | 152(+0) |
MadhuraT 0:7ae7e0d50b5e 41 | mbed-os/platform | 3633(+0) | 260(+0) | 209(+0) |
MadhuraT 0:7ae7e0d50b5e 42 | mbed-os/rtos | 9370(+0) | 168(+0) | 6053(+0) |
MadhuraT 0:7ae7e0d50b5e 43 | mbed-os/targets | 9536(+0) | 12(+0) | 382(+0) |
MadhuraT 0:7ae7e0d50b5e 44 | Subtotals | 57163(+0) | 2928(+0) | 9320(+0) |
MadhuraT 0:7ae7e0d50b5e 45 Total Static RAM memory (data + bss): 12248(+0) bytes
MadhuraT 0:7ae7e0d50b5e 46 Total Flash memory (text + data): 60091(+0) bytes
MadhuraT 0:7ae7e0d50b5e 47
MadhuraT 0:7ae7e0d50b5e 48 Image: ./BUILD/K64F/GCC_ARM/mbed-os-example-blinky.bin
MadhuraT 0:7ae7e0d50b5e 49 ```
MadhuraT 0:7ae7e0d50b5e 50
MadhuraT 0:7ae7e0d50b5e 51 ### Program your board
MadhuraT 0:7ae7e0d50b5e 52
MadhuraT 0:7ae7e0d50b5e 53 1. Connect your mbed device to the computer over USB.
MadhuraT 0:7ae7e0d50b5e 54 1. Copy the binary file to the mbed device.
MadhuraT 0:7ae7e0d50b5e 55 1. Press the reset button to start the program.
MadhuraT 0:7ae7e0d50b5e 56
MadhuraT 0:7ae7e0d50b5e 57 The LED on your platform turns on and off. The main thread will additionally take a snapshot of the device's runtime statistics and display it over serial to your PC. The snapshot includes:
MadhuraT 0:7ae7e0d50b5e 58
MadhuraT 0:7ae7e0d50b5e 59 * System Information:
MadhuraT 0:7ae7e0d50b5e 60 * Mbed OS Version: Will currently default to 999999
MadhuraT 0:7ae7e0d50b5e 61 * Compiler ID
MadhuraT 0:7ae7e0d50b5e 62 * ARM = 1
MadhuraT 0:7ae7e0d50b5e 63 * GCC_ARM = 2
MadhuraT 0:7ae7e0d50b5e 64 * IAR = 3
MadhuraT 0:7ae7e0d50b5e 65 * [CPUID Register Information](#cpuid-register-information)
MadhuraT 0:7ae7e0d50b5e 66 * [Compiler Version](#compiler-version)
MadhuraT 0:7ae7e0d50b5e 67 * CPU Statistics
MadhuraT 0:7ae7e0d50b5e 68 * Percentage of runtime that the device has spent awake versus in sleep
MadhuraT 0:7ae7e0d50b5e 69 * Heap Statistics
MadhuraT 0:7ae7e0d50b5e 70 * Current heap size
MadhuraT 0:7ae7e0d50b5e 71 * Max heap size which refers to the largest the heap has grown to
MadhuraT 0:7ae7e0d50b5e 72 * Thread Statistics
MadhuraT 0:7ae7e0d50b5e 73 * Provides information on all running threads in the OS including
MadhuraT 0:7ae7e0d50b5e 74 * Thread ID
MadhuraT 0:7ae7e0d50b5e 75 * Thread Name
MadhuraT 0:7ae7e0d50b5e 76 * Thread State
MadhuraT 0:7ae7e0d50b5e 77 * Thread Priority
MadhuraT 0:7ae7e0d50b5e 78 * Thread Stack Size
MadhuraT 0:7ae7e0d50b5e 79 * Thread Stack Space
MadhuraT 0:7ae7e0d50b5e 80
MadhuraT 0:7ae7e0d50b5e 81 #### Compiler Version
MadhuraT 0:7ae7e0d50b5e 82
MadhuraT 0:7ae7e0d50b5e 83 | Compiler | Version Layout |
MadhuraT 0:7ae7e0d50b5e 84 | -------- | -------------- |
MadhuraT 0:7ae7e0d50b5e 85 | ARM | PVVbbbb (P = Major; VV = Minor; bbbb = build number) |
MadhuraT 0:7ae7e0d50b5e 86 | GCC | VVRRPP (VV = Version; RR = Revision; PP = Patch) |
MadhuraT 0:7ae7e0d50b5e 87 | IAR | VRRRPPP (V = Version; RRR = Revision; PPP = Patch) |
MadhuraT 0:7ae7e0d50b5e 88
MadhuraT 0:7ae7e0d50b5e 89 #### CPUID Register Information
MadhuraT 0:7ae7e0d50b5e 90
MadhuraT 0:7ae7e0d50b5e 91 | Bit Field | Field Description | Values |
MadhuraT 0:7ae7e0d50b5e 92 | --------- | ----------------- | ------ |
MadhuraT 0:7ae7e0d50b5e 93 |[31:24] | Implementer | 0x41 = ARM |
MadhuraT 0:7ae7e0d50b5e 94 |[23:20] | Variant | Major revision 0x0 = Revision 0 |
MadhuraT 0:7ae7e0d50b5e 95 |[19:16] | Architecture | 0xC = Baseline Architecture |
MadhuraT 0:7ae7e0d50b5e 96 | | | 0xF = Constant (Mainline Architecture) |
MadhuraT 0:7ae7e0d50b5e 97 |[15:4] | Part Number | 0xC20 = Cortex-M0 |
MadhuraT 0:7ae7e0d50b5e 98 | | | 0xC60 = Cortex-M0+ |
MadhuraT 0:7ae7e0d50b5e 99 | | | 0xC23 = Cortex-M3 |
MadhuraT 0:7ae7e0d50b5e 100 | | | 0xC24 = Cortex-M4 |
MadhuraT 0:7ae7e0d50b5e 101 | | | 0xC27 = Cortex-M7 |
MadhuraT 0:7ae7e0d50b5e 102 | | | 0xD20 = Cortex-M23 |
MadhuraT 0:7ae7e0d50b5e 103 | | | 0xD21 = Cortex-M33 |
MadhuraT 0:7ae7e0d50b5e 104 |[3:0] | Revision | Minor revision: 0x1 = Patch 1 |
MadhuraT 0:7ae7e0d50b5e 105
MadhuraT 0:7ae7e0d50b5e 106
MadhuraT 0:7ae7e0d50b5e 107
MadhuraT 0:7ae7e0d50b5e 108 You can view individual examples and additional API information of the statistics collection tools at the bottom of the page in the [related links section](#related-links).
MadhuraT 0:7ae7e0d50b5e 109
MadhuraT 0:7ae7e0d50b5e 110
MadhuraT 0:7ae7e0d50b5e 111 ### Output
MadhuraT 0:7ae7e0d50b5e 112
MadhuraT 0:7ae7e0d50b5e 113 To view the serial output you can use any terminal client of your choosing such as [PuTTY](http://www.putty.org/) or [CoolTerm](http://freeware.the-meiers.org/). Unless otherwise specified, printf defaults to a baud rate of 9600 on Mbed OS.
MadhuraT 0:7ae7e0d50b5e 114
MadhuraT 0:7ae7e0d50b5e 115 You can find more information on the Mbed OS configuration tools and serial communication in Mbed OS in the related [related links section](#related-links).
MadhuraT 0:7ae7e0d50b5e 116
MadhuraT 0:7ae7e0d50b5e 117 The output should contain the following block transmitted at the blinking LED frequency (actual values may vary depending on your target, build profile, and toolchain):
MadhuraT 0:7ae7e0d50b5e 118
MadhuraT 0:7ae7e0d50b5e 119 ```
MadhuraT 0:7ae7e0d50b5e 120 =============================== SYSTEM INFO ================================
MadhuraT 0:7ae7e0d50b5e 121 Mbed OS Version: 999999
MadhuraT 0:7ae7e0d50b5e 122 CPU ID: 0x410fc241
MadhuraT 0:7ae7e0d50b5e 123 Compiler ID: 2
MadhuraT 0:7ae7e0d50b5e 124 Compiler Version: 60300
MadhuraT 0:7ae7e0d50b5e 125 RAM0: Start 0x20000000 Size: 0x30000
MadhuraT 0:7ae7e0d50b5e 126 RAM1: Start 0x1fff0000 Size: 0x10000
MadhuraT 0:7ae7e0d50b5e 127 ROM0: Start 0x0 Size: 0x100000
MadhuraT 0:7ae7e0d50b5e 128 ================= CPU STATS =================
MadhuraT 0:7ae7e0d50b5e 129 Idle: 98% Usage: 2%
MadhuraT 0:7ae7e0d50b5e 130 ================ HEAP STATS =================
MadhuraT 0:7ae7e0d50b5e 131 Current heap: 1096
MadhuraT 0:7ae7e0d50b5e 132 Max heap size: 1096
MadhuraT 0:7ae7e0d50b5e 133 ================ THREAD STATS ===============
MadhuraT 0:7ae7e0d50b5e 134 ID: 0x20001eac
MadhuraT 0:7ae7e0d50b5e 135 Name: main_thread
MadhuraT 0:7ae7e0d50b5e 136 State: 2
MadhuraT 0:7ae7e0d50b5e 137 Priority: 24
MadhuraT 0:7ae7e0d50b5e 138 Stack Size: 4096
MadhuraT 0:7ae7e0d50b5e 139 Stack Space: 3296
MadhuraT 0:7ae7e0d50b5e 140
MadhuraT 0:7ae7e0d50b5e 141 ID: 0x20000f5c
MadhuraT 0:7ae7e0d50b5e 142 Name: idle_thread
MadhuraT 0:7ae7e0d50b5e 143 State: 1
MadhuraT 0:7ae7e0d50b5e 144 Priority: 1
MadhuraT 0:7ae7e0d50b5e 145 Stack Size: 512
MadhuraT 0:7ae7e0d50b5e 146 Stack Space: 352
MadhuraT 0:7ae7e0d50b5e 147
MadhuraT 0:7ae7e0d50b5e 148 ID: 0x20000f18
MadhuraT 0:7ae7e0d50b5e 149 Name: timer_thread
MadhuraT 0:7ae7e0d50b5e 150 State: 3
MadhuraT 0:7ae7e0d50b5e 151 Priority: 40
MadhuraT 0:7ae7e0d50b5e 152 Stack Size: 768
MadhuraT 0:7ae7e0d50b5e 153 Stack Space: 664
MadhuraT 0:7ae7e0d50b5e 154
MadhuraT 0:7ae7e0d50b5e 155 ```
MadhuraT 0:7ae7e0d50b5e 156
MadhuraT 0:7ae7e0d50b5e 157 ## Troubleshooting
MadhuraT 0:7ae7e0d50b5e 158
MadhuraT 0:7ae7e0d50b5e 159 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
MadhuraT 0:7ae7e0d50b5e 160
MadhuraT 0:7ae7e0d50b5e 161 ## Related Links
MadhuraT 0:7ae7e0d50b5e 162
MadhuraT 0:7ae7e0d50b5e 163 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
MadhuraT 0:7ae7e0d50b5e 164 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)
MadhuraT 0:7ae7e0d50b5e 165 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)
MadhuraT 0:7ae7e0d50b5e 166
MadhuraT 0:7ae7e0d50b5e 167 ### License and contributions
MadhuraT 0:7ae7e0d50b5e 168
MadhuraT 0:7ae7e0d50b5e 169 The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
MadhuraT 0:7ae7e0d50b5e 170
MadhuraT 0:7ae7e0d50b5e 171 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.