Shivanand Gowda / Mbed OS Doubly_linked_list

Doubly linked list

README.md@0:a76236b7a8e6, 2019-09-16 (annotated)

Committer:
shivanandgowdakr
Date:
Mon Sep 16 13:57:00 2019 +0000
Revision:
0:a76236b7a8e6
Doubly Linked List using STM32

Who changed what in which revision?

UserRevisionLine numberNew contents of line
shivanandgowdakr 0:a76236b7a8e6 1 # Getting started example for Mbed OS
shivanandgowdakr 0:a76236b7a8e6 2
shivanandgowdakr 0:a76236b7a8e6 3 This guide reviews the steps required to get Blinky with the addition of dynamic OS statistics working on an Mbed OS platform. (Note: To see a rendered example you can import into the Arm Online Compiler, please see our [quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
shivanandgowdakr 0:a76236b7a8e6 4
shivanandgowdakr 0:a76236b7a8e6 5 Please install [Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
shivanandgowdakr 0:a76236b7a8e6 6
shivanandgowdakr 0:a76236b7a8e6 7 ## Import the example application
shivanandgowdakr 0:a76236b7a8e6 8
shivanandgowdakr 0:a76236b7a8e6 9 From the command-line, import the example:
shivanandgowdakr 0:a76236b7a8e6 10
shivanandgowdakr 0:a76236b7a8e6 11 ```
shivanandgowdakr 0:a76236b7a8e6 12 mbed import mbed-os-example-blinky
shivanandgowdakr 0:a76236b7a8e6 13 cd mbed-os-example-blinky
shivanandgowdakr 0:a76236b7a8e6 14 ```
shivanandgowdakr 0:a76236b7a8e6 15
shivanandgowdakr 0:a76236b7a8e6 16 ### Now compile
shivanandgowdakr 0:a76236b7a8e6 17
shivanandgowdakr 0:a76236b7a8e6 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:
shivanandgowdakr 0:a76236b7a8e6 19
shivanandgowdakr 0:a76236b7a8e6 20 ```
shivanandgowdakr 0:a76236b7a8e6 21 mbed compile -m K64F -t ARM
shivanandgowdakr 0:a76236b7a8e6 22 ```
shivanandgowdakr 0:a76236b7a8e6 23
shivanandgowdakr 0:a76236b7a8e6 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
shivanandgowdakr 0:a76236b7a8e6 25
shivanandgowdakr 0:a76236b7a8e6 26 ```
shivanandgowdakr 0:a76236b7a8e6 27 [snip]
shivanandgowdakr 0:a76236b7a8e6 28
shivanandgowdakr 0:a76236b7a8e6 29 Image: ./BUILD/K64F/GCC_ARM/mbed-os-example-blinky.bin
shivanandgowdakr 0:a76236b7a8e6 30 ```
shivanandgowdakr 0:a76236b7a8e6 31
shivanandgowdakr 0:a76236b7a8e6 32 ### Program your board
shivanandgowdakr 0:a76236b7a8e6 33
shivanandgowdakr 0:a76236b7a8e6 34 1. Connect your Mbed device to the computer over USB.
shivanandgowdakr 0:a76236b7a8e6 35 1. Copy the binary file to the Mbed device.
shivanandgowdakr 0:a76236b7a8e6 36 1. Press the reset button to start the program.
shivanandgowdakr 0:a76236b7a8e6 37
shivanandgowdakr 0:a76236b7a8e6 38 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:
shivanandgowdakr 0:a76236b7a8e6 39
shivanandgowdakr 0:a76236b7a8e6 40 * System Information:
shivanandgowdakr 0:a76236b7a8e6 41 * Mbed OS Version: Will currently default to 999999
shivanandgowdakr 0:a76236b7a8e6 42 * Compiler ID
shivanandgowdakr 0:a76236b7a8e6 43 * ARM = 1
shivanandgowdakr 0:a76236b7a8e6 44 * GCC_ARM = 2
shivanandgowdakr 0:a76236b7a8e6 45 * IAR = 3
shivanandgowdakr 0:a76236b7a8e6 46 * [CPUID Register Information](#cpuid-register-information)
shivanandgowdakr 0:a76236b7a8e6 47 * [Compiler Version](#compiler-version)
shivanandgowdakr 0:a76236b7a8e6 48 * CPU Statistics
shivanandgowdakr 0:a76236b7a8e6 49 * Percentage of runtime that the device has spent awake versus in sleep
shivanandgowdakr 0:a76236b7a8e6 50 * Heap Statistics
shivanandgowdakr 0:a76236b7a8e6 51 * Current heap size
shivanandgowdakr 0:a76236b7a8e6 52 * Max heap size which refers to the largest the heap has grown to
shivanandgowdakr 0:a76236b7a8e6 53 * Thread Statistics
shivanandgowdakr 0:a76236b7a8e6 54 * Provides information on all running threads in the OS including
shivanandgowdakr 0:a76236b7a8e6 55 * Thread ID
shivanandgowdakr 0:a76236b7a8e6 56 * Thread Name
shivanandgowdakr 0:a76236b7a8e6 57 * Thread State
shivanandgowdakr 0:a76236b7a8e6 58 * Thread Priority
shivanandgowdakr 0:a76236b7a8e6 59 * Thread Stack Size
shivanandgowdakr 0:a76236b7a8e6 60 * Thread Stack Space
shivanandgowdakr 0:a76236b7a8e6 61
shivanandgowdakr 0:a76236b7a8e6 62 #### Compiler Version
shivanandgowdakr 0:a76236b7a8e6 63
shivanandgowdakr 0:a76236b7a8e6 64 | Compiler | Version Layout |
shivanandgowdakr 0:a76236b7a8e6 65 | -------- | -------------- |
shivanandgowdakr 0:a76236b7a8e6 66 | ARM | PVVbbbb (P = Major; VV = Minor; bbbb = build number) |
shivanandgowdakr 0:a76236b7a8e6 67 | GCC | VVRRPP (VV = Version; RR = Revision; PP = Patch) |
shivanandgowdakr 0:a76236b7a8e6 68 | IAR | VRRRPPP (V = Version; RRR = Revision; PPP = Patch) |
shivanandgowdakr 0:a76236b7a8e6 69
shivanandgowdakr 0:a76236b7a8e6 70 #### CPUID Register Information
shivanandgowdakr 0:a76236b7a8e6 71
shivanandgowdakr 0:a76236b7a8e6 72 | Bit Field | Field Description | Values |
shivanandgowdakr 0:a76236b7a8e6 73 | --------- | ----------------- | ------ |
shivanandgowdakr 0:a76236b7a8e6 74 |[31:24] | Implementer | 0x41 = ARM |
shivanandgowdakr 0:a76236b7a8e6 75 |[23:20] | Variant | Major revision 0x0 = Revision 0 |
shivanandgowdakr 0:a76236b7a8e6 76 |[19:16] | Architecture | 0xC = Baseline Architecture |
shivanandgowdakr 0:a76236b7a8e6 77 | | | 0xF = Constant (Mainline Architecture) |
shivanandgowdakr 0:a76236b7a8e6 78 |[15:4] | Part Number | 0xC20 = Cortex-M0 |
shivanandgowdakr 0:a76236b7a8e6 79 | | | 0xC60 = Cortex-M0+ |
shivanandgowdakr 0:a76236b7a8e6 80 | | | 0xC23 = Cortex-M3 |
shivanandgowdakr 0:a76236b7a8e6 81 | | | 0xC24 = Cortex-M4 |
shivanandgowdakr 0:a76236b7a8e6 82 | | | 0xC27 = Cortex-M7 |
shivanandgowdakr 0:a76236b7a8e6 83 | | | 0xD20 = Cortex-M23 |
shivanandgowdakr 0:a76236b7a8e6 84 | | | 0xD21 = Cortex-M33 |
shivanandgowdakr 0:a76236b7a8e6 85 |[3:0] | Revision | Minor revision: 0x1 = Patch 1 |
shivanandgowdakr 0:a76236b7a8e6 86
shivanandgowdakr 0:a76236b7a8e6 87
shivanandgowdakr 0:a76236b7a8e6 88
shivanandgowdakr 0:a76236b7a8e6 89 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).
shivanandgowdakr 0:a76236b7a8e6 90
shivanandgowdakr 0:a76236b7a8e6 91
shivanandgowdakr 0:a76236b7a8e6 92 ### Output
shivanandgowdakr 0:a76236b7a8e6 93
shivanandgowdakr 0:a76236b7a8e6 94 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.
shivanandgowdakr 0:a76236b7a8e6 95
shivanandgowdakr 0:a76236b7a8e6 96 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).
shivanandgowdakr 0:a76236b7a8e6 97
shivanandgowdakr 0:a76236b7a8e6 98 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):
shivanandgowdakr 0:a76236b7a8e6 99
shivanandgowdakr 0:a76236b7a8e6 100 ```
shivanandgowdakr 0:a76236b7a8e6 101 =============================== SYSTEM INFO ================================
shivanandgowdakr 0:a76236b7a8e6 102 Mbed OS Version: 999999
shivanandgowdakr 0:a76236b7a8e6 103 CPU ID: 0x410fc241
shivanandgowdakr 0:a76236b7a8e6 104 Compiler ID: 2
shivanandgowdakr 0:a76236b7a8e6 105 Compiler Version: 60300
shivanandgowdakr 0:a76236b7a8e6 106 RAM0: Start 0x20000000 Size: 0x30000
shivanandgowdakr 0:a76236b7a8e6 107 RAM1: Start 0x1fff0000 Size: 0x10000
shivanandgowdakr 0:a76236b7a8e6 108 ROM0: Start 0x0 Size: 0x100000
shivanandgowdakr 0:a76236b7a8e6 109 ================= CPU STATS =================
shivanandgowdakr 0:a76236b7a8e6 110 Idle: 98% Usage: 2%
shivanandgowdakr 0:a76236b7a8e6 111 ================ HEAP STATS =================
shivanandgowdakr 0:a76236b7a8e6 112 Current heap: 1096
shivanandgowdakr 0:a76236b7a8e6 113 Max heap size: 1096
shivanandgowdakr 0:a76236b7a8e6 114 ================ THREAD STATS ===============
shivanandgowdakr 0:a76236b7a8e6 115 ID: 0x20001eac
shivanandgowdakr 0:a76236b7a8e6 116 Name: main_thread
shivanandgowdakr 0:a76236b7a8e6 117 State: 2
shivanandgowdakr 0:a76236b7a8e6 118 Priority: 24
shivanandgowdakr 0:a76236b7a8e6 119 Stack Size: 4096
shivanandgowdakr 0:a76236b7a8e6 120 Stack Space: 3296
shivanandgowdakr 0:a76236b7a8e6 121
shivanandgowdakr 0:a76236b7a8e6 122 ID: 0x20000f5c
shivanandgowdakr 0:a76236b7a8e6 123 Name: idle_thread
shivanandgowdakr 0:a76236b7a8e6 124 State: 1
shivanandgowdakr 0:a76236b7a8e6 125 Priority: 1
shivanandgowdakr 0:a76236b7a8e6 126 Stack Size: 512
shivanandgowdakr 0:a76236b7a8e6 127 Stack Space: 352
shivanandgowdakr 0:a76236b7a8e6 128
shivanandgowdakr 0:a76236b7a8e6 129 ID: 0x20000f18
shivanandgowdakr 0:a76236b7a8e6 130 Name: timer_thread
shivanandgowdakr 0:a76236b7a8e6 131 State: 3
shivanandgowdakr 0:a76236b7a8e6 132 Priority: 40
shivanandgowdakr 0:a76236b7a8e6 133 Stack Size: 768
shivanandgowdakr 0:a76236b7a8e6 134 Stack Space: 664
shivanandgowdakr 0:a76236b7a8e6 135
shivanandgowdakr 0:a76236b7a8e6 136 ```
shivanandgowdakr 0:a76236b7a8e6 137
shivanandgowdakr 0:a76236b7a8e6 138 ## Troubleshooting
shivanandgowdakr 0:a76236b7a8e6 139
shivanandgowdakr 0:a76236b7a8e6 140 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.
shivanandgowdakr 0:a76236b7a8e6 141
shivanandgowdakr 0:a76236b7a8e6 142 ## Related Links
shivanandgowdakr 0:a76236b7a8e6 143
shivanandgowdakr 0:a76236b7a8e6 144 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
shivanandgowdakr 0:a76236b7a8e6 145 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)
shivanandgowdakr 0:a76236b7a8e6 146 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)
shivanandgowdakr 0:a76236b7a8e6 147
shivanandgowdakr 0:a76236b7a8e6 148 ### License and contributions
shivanandgowdakr 0:a76236b7a8e6 149
shivanandgowdakr 0:a76236b7a8e6 150 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.
shivanandgowdakr 0:a76236b7a8e6 151
shivanandgowdakr 0:a76236b7a8e6 152 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.