jim hamblen / Mbed OS LED_RTOS_VER5

LED effects demo for LPC1768 using version 5 RTOS Details at https://os.mbed.com/users/4180_1/notebook/led-lighting-effects-for-modelers/ - NOTE: Requires firmware update for proper wait times

stats_report.h@0:4087d19c8e7b, 2019-09-06 (annotated)

Committer:
4180_1
Date:
Fri Sep 06 12:42:09 2019 +0000
Revision:
0:4087d19c8e7b
ver 1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
4180_1 0:4087d19c8e7b 1 /* mbed Microcontroller Library
4180_1 0:4087d19c8e7b 2 * Copyright (c) 2018 ARM Limited
4180_1 0:4087d19c8e7b 3 * SPDX-License-Identifier: Apache-2.0
4180_1 0:4087d19c8e7b 4 */
4180_1 0:4087d19c8e7b 5
4180_1 0:4087d19c8e7b 6 #ifndef STATS_REPORT_H
4180_1 0:4087d19c8e7b 7 #define STATS_REPORT_H
4180_1 0:4087d19c8e7b 8
4180_1 0:4087d19c8e7b 9 #include <inttypes.h>
4180_1 0:4087d19c8e7b 10 #include "mbed.h"
4180_1 0:4087d19c8e7b 11
4180_1 0:4087d19c8e7b 12 /**
4180_1 0:4087d19c8e7b 13 * System Reporting library. Provides runtime information on device:
4180_1 0:4087d19c8e7b 14 * - CPU sleep, idle, and wake times
4180_1 0:4087d19c8e7b 15 * - Heap and stack usage
4180_1 0:4087d19c8e7b 16 * - Thread information
4180_1 0:4087d19c8e7b 17 * - Static system information
4180_1 0:4087d19c8e7b 18 */
4180_1 0:4087d19c8e7b 19 class SystemReport {
4180_1 0:4087d19c8e7b 20 mbed_stats_heap_t heap_stats;
4180_1 0:4087d19c8e7b 21 mbed_stats_cpu_t cpu_stats;
4180_1 0:4087d19c8e7b 22 mbed_stats_sys_t sys_stats;
4180_1 0:4087d19c8e7b 23
4180_1 0:4087d19c8e7b 24 mbed_stats_thread_t *thread_stats;
4180_1 0:4087d19c8e7b 25 uint8_t thread_count;
4180_1 0:4087d19c8e7b 26 uint8_t max_thread_count;
4180_1 0:4087d19c8e7b 27 uint32_t sample_time_ms;
4180_1 0:4087d19c8e7b 28
4180_1 0:4087d19c8e7b 29 public:
4180_1 0:4087d19c8e7b 30 /**
4180_1 0:4087d19c8e7b 31 * SystemReport - Sample rate in ms is required to handle the CPU percent awake logic
4180_1 0:4087d19c8e7b 32 */
4180_1 0:4087d19c8e7b 33 SystemReport(uint32_t sample_rate) : max_thread_count(8), sample_time_ms(sample_rate)
4180_1 0:4087d19c8e7b 34 {
4180_1 0:4087d19c8e7b 35 thread_stats = new mbed_stats_thread_t[max_thread_count];
4180_1 0:4087d19c8e7b 36
4180_1 0:4087d19c8e7b 37 // Collect the static system information
4180_1 0:4087d19c8e7b 38 mbed_stats_sys_get(&sys_stats);
4180_1 0:4087d19c8e7b 39
4180_1 0:4087d19c8e7b 40 printf("=============================== SYSTEM INFO ================================\r\n");
4180_1 0:4087d19c8e7b 41 printf("Mbed OS Version: %" PRIu32 " \r\n", sys_stats.os_version);
4180_1 0:4087d19c8e7b 42 printf("CPU ID: 0x%" PRIx32 " \r\n", sys_stats.cpu_id);
4180_1 0:4087d19c8e7b 43 printf("Compiler ID: %d \r\n", sys_stats.compiler_id);
4180_1 0:4087d19c8e7b 44 printf("Compiler Version: %" PRIu32 " \r\n", sys_stats.compiler_version);
4180_1 0:4087d19c8e7b 45
4180_1 0:4087d19c8e7b 46 for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) {
4180_1 0:4087d19c8e7b 47 if (sys_stats.ram_size[i] != 0) {
4180_1 0:4087d19c8e7b 48 printf("RAM%d: Start 0x%" PRIx32 " Size: 0x%" PRIx32 " \r\n", i, sys_stats.ram_start[i], sys_stats.ram_size[i]);
4180_1 0:4087d19c8e7b 49 }
4180_1 0:4087d19c8e7b 50 }
4180_1 0:4087d19c8e7b 51 for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) {
4180_1 0:4087d19c8e7b 52 if (sys_stats.rom_size[i] != 0) {
4180_1 0:4087d19c8e7b 53 printf("ROM%d: Start 0x%" PRIx32 " Size: 0x%" PRIx32 " \r\n", i, sys_stats.rom_start[i], sys_stats.rom_size[i]);
4180_1 0:4087d19c8e7b 54 }
4180_1 0:4087d19c8e7b 55 }
4180_1 0:4087d19c8e7b 56 }
4180_1 0:4087d19c8e7b 57
4180_1 0:4087d19c8e7b 58 ~SystemReport(void)
4180_1 0:4087d19c8e7b 59 {
4180_1 0:4087d19c8e7b 60 free(thread_stats);
4180_1 0:4087d19c8e7b 61 }
4180_1 0:4087d19c8e7b 62
4180_1 0:4087d19c8e7b 63 /**
4180_1 0:4087d19c8e7b 64 * Report on each Mbed OS Platform stats API
4180_1 0:4087d19c8e7b 65 */
4180_1 0:4087d19c8e7b 66 void report_state(void)
4180_1 0:4087d19c8e7b 67 {
4180_1 0:4087d19c8e7b 68 report_cpu_stats();
4180_1 0:4087d19c8e7b 69 report_heap_stats();
4180_1 0:4087d19c8e7b 70 report_thread_stats();
4180_1 0:4087d19c8e7b 71
4180_1 0:4087d19c8e7b 72 // Clear next line to separate subsequent report logs
4180_1 0:4087d19c8e7b 73 printf("\r\n");
4180_1 0:4087d19c8e7b 74 }
4180_1 0:4087d19c8e7b 75
4180_1 0:4087d19c8e7b 76 /**
4180_1 0:4087d19c8e7b 77 * Report CPU idle and awake time in terms of percentage
4180_1 0:4087d19c8e7b 78 */
4180_1 0:4087d19c8e7b 79 void report_cpu_stats(void)
4180_1 0:4087d19c8e7b 80 {
4180_1 0:4087d19c8e7b 81 static uint64_t prev_idle_time = 0;
4180_1 0:4087d19c8e7b 82
4180_1 0:4087d19c8e7b 83 printf("================= CPU STATS =================\r\n");
4180_1 0:4087d19c8e7b 84
4180_1 0:4087d19c8e7b 85 // Collect and print cpu stats
4180_1 0:4087d19c8e7b 86 mbed_stats_cpu_get(&cpu_stats);
4180_1 0:4087d19c8e7b 87
4180_1 0:4087d19c8e7b 88 uint64_t diff = (cpu_stats.idle_time - prev_idle_time);
4180_1 0:4087d19c8e7b 89 uint8_t idle = (diff * 100) / (sample_time_ms * 1000); // usec;
4180_1 0:4087d19c8e7b 90 uint8_t usage = 100 - ((diff * 100) / (sample_time_ms * 1000)); // usec;;
4180_1 0:4087d19c8e7b 91 prev_idle_time = cpu_stats.idle_time;
4180_1 0:4087d19c8e7b 92
4180_1 0:4087d19c8e7b 93 printf("Idle: %d%% Usage: %d%% \r\n", idle, usage);
4180_1 0:4087d19c8e7b 94 }
4180_1 0:4087d19c8e7b 95
4180_1 0:4087d19c8e7b 96 /**
4180_1 0:4087d19c8e7b 97 * Report current heap stats. Current heap refers to the current amount of
4180_1 0:4087d19c8e7b 98 * allocated heap. Max heap refers to the highest amount of heap allocated
4180_1 0:4087d19c8e7b 99 * since reset.
4180_1 0:4087d19c8e7b 100 */
4180_1 0:4087d19c8e7b 101 void report_heap_stats(void)
4180_1 0:4087d19c8e7b 102 {
4180_1 0:4087d19c8e7b 103 printf("================ HEAP STATS =================\r\n");
4180_1 0:4087d19c8e7b 104
4180_1 0:4087d19c8e7b 105 // Collect and print heap stats
4180_1 0:4087d19c8e7b 106 mbed_stats_heap_get(&heap_stats);
4180_1 0:4087d19c8e7b 107
4180_1 0:4087d19c8e7b 108 printf("Current heap: %" PRIu32 "\r\n", heap_stats.current_size);
4180_1 0:4087d19c8e7b 109 printf("Max heap size: %" PRIu32 "\r\n", heap_stats.max_size);
4180_1 0:4087d19c8e7b 110 }
4180_1 0:4087d19c8e7b 111
4180_1 0:4087d19c8e7b 112 /**
4180_1 0:4087d19c8e7b 113 * Report active thread stats
4180_1 0:4087d19c8e7b 114 */
4180_1 0:4087d19c8e7b 115 void report_thread_stats(void)
4180_1 0:4087d19c8e7b 116 {
4180_1 0:4087d19c8e7b 117 printf("================ THREAD STATS ===============\r\n");
4180_1 0:4087d19c8e7b 118
4180_1 0:4087d19c8e7b 119 // Collect and print running thread stats
4180_1 0:4087d19c8e7b 120 int count = mbed_stats_thread_get_each(thread_stats, max_thread_count);
4180_1 0:4087d19c8e7b 121
4180_1 0:4087d19c8e7b 122 for (int i = 0; i < count; i++) {
4180_1 0:4087d19c8e7b 123 printf("ID: 0x%" PRIx32 " \r\n", thread_stats[i].id);
4180_1 0:4087d19c8e7b 124 printf("Name: %s \r\n", thread_stats[i].name);
4180_1 0:4087d19c8e7b 125 printf("State: %" PRIu32 " \r\n", thread_stats[i].state);
4180_1 0:4087d19c8e7b 126 printf("Priority: %" PRIu32 " \r\n", thread_stats[i].priority);
4180_1 0:4087d19c8e7b 127 printf("Stack Size: %" PRIu32 " \r\n", thread_stats[i].stack_size);
4180_1 0:4087d19c8e7b 128 printf("Stack Space: %" PRIu32 " \r\n", thread_stats[i].stack_space);
4180_1 0:4087d19c8e7b 129 }
4180_1 0:4087d19c8e7b 130 }
4180_1 0:4087d19c8e7b 131 };
4180_1 0:4087d19c8e7b 132
4180_1 0:4087d19c8e7b 133 #endif // STATS_REPORT_H