takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/mbed_mem_trace.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1
kadonotakashi 0:8fdf9a60065b 2 /** \addtogroup platform */
kadonotakashi 0:8fdf9a60065b 3 /** @{*/
kadonotakashi 0:8fdf9a60065b 4
kadonotakashi 0:8fdf9a60065b 5 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 6 * Copyright (c) 2006-2016 ARM Limited
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 9 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 10 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 11 *
kadonotakashi 0:8fdf9a60065b 12 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 13 *
kadonotakashi 0:8fdf9a60065b 14 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 15 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 17 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 18 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 19 */
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 #ifndef __MBED_MEM_TRACE_H__
kadonotakashi 0:8fdf9a60065b 22 #define __MBED_MEM_TRACE_H__
kadonotakashi 0:8fdf9a60065b 23
kadonotakashi 0:8fdf9a60065b 24 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 25 extern "C" {
kadonotakashi 0:8fdf9a60065b 26 #endif
kadonotakashi 0:8fdf9a60065b 27
kadonotakashi 0:8fdf9a60065b 28 #include <stdint.h>
kadonotakashi 0:8fdf9a60065b 29 #include <stddef.h>
kadonotakashi 0:8fdf9a60065b 30
kadonotakashi 0:8fdf9a60065b 31 /* Operation types for tracer */
kadonotakashi 0:8fdf9a60065b 32 enum {
kadonotakashi 0:8fdf9a60065b 33 MBED_MEM_TRACE_MALLOC,
kadonotakashi 0:8fdf9a60065b 34 MBED_MEM_TRACE_REALLOC,
kadonotakashi 0:8fdf9a60065b 35 MBED_MEM_TRACE_CALLOC,
kadonotakashi 0:8fdf9a60065b 36 MBED_MEM_TRACE_FREE
kadonotakashi 0:8fdf9a60065b 37 };
kadonotakashi 0:8fdf9a60065b 38
kadonotakashi 0:8fdf9a60065b 39 /**
kadonotakashi 0:8fdf9a60065b 40 * \defgroup platform_mem_trace mem_trace functions
kadonotakashi 0:8fdf9a60065b 41 * @{
kadonotakashi 0:8fdf9a60065b 42 */
kadonotakashi 0:8fdf9a60065b 43
kadonotakashi 0:8fdf9a60065b 44 /* Prefix for the output of the default tracer */
kadonotakashi 0:8fdf9a60065b 45 #define MBED_MEM_DEFAULT_TRACER_PREFIX "#"
kadonotakashi 0:8fdf9a60065b 46
kadonotakashi 0:8fdf9a60065b 47 /**
kadonotakashi 0:8fdf9a60065b 48 * Type of the callback used by the memory tracer. This callback is called when a memory
kadonotakashi 0:8fdf9a60065b 49 * allocation operation (malloc, realloc, calloc, free) is called and tracing is enabled
kadonotakashi 0:8fdf9a60065b 50 * for that memory allocation function.
kadonotakashi 0:8fdf9a60065b 51 *
kadonotakashi 0:8fdf9a60065b 52 * @param op the ID of the operation (MBED_MEM_TRACE_MALLOC, MBED_MEM_TRACE_REALLOC,
kadonotakashi 0:8fdf9a60065b 53 * MBED_MEM_TRACE_CALLOC or MBED_MEM_TRACE_FREE).
kadonotakashi 0:8fdf9a60065b 54 * @param res the result that the memory operation returned (NULL for 'free').
kadonotakashi 0:8fdf9a60065b 55 * @param caller the caller of the memory operation. Note that the value of 'caller' might be
kadonotakashi 0:8fdf9a60065b 56 * unreliable.
kadonotakashi 0:8fdf9a60065b 57 *
kadonotakashi 0:8fdf9a60065b 58 * The rest of the parameters passed 'mbed_mem_trace_cb_t' are the same as the memory operations
kadonotakashi 0:8fdf9a60065b 59 * that triggered its call (see 'man malloc' for details):
kadonotakashi 0:8fdf9a60065b 60 *
kadonotakashi 0:8fdf9a60065b 61 * - for malloc: cb(MBED_MEM_TRACE_MALLOC, res, caller, size).
kadonotakashi 0:8fdf9a60065b 62 * - for realloc: cb(MBED_MEM_TRACE_REALLOC, res, caller, ptr, size).
kadonotakashi 0:8fdf9a60065b 63 * - for calloc: cb(MBED_MEM_TRACE_CALLOC, res, caller, nmemb, size).
kadonotakashi 0:8fdf9a60065b 64 * - for free: cb(MBED_MEM_TRACE_FREE, NULL, caller, ptr).
kadonotakashi 0:8fdf9a60065b 65 */
kadonotakashi 0:8fdf9a60065b 66 typedef void (*mbed_mem_trace_cb_t)(uint8_t op, void *res, void *caller, ...);
kadonotakashi 0:8fdf9a60065b 67
kadonotakashi 0:8fdf9a60065b 68 /**
kadonotakashi 0:8fdf9a60065b 69 * Set the callback used by the memory tracer (use NULL for disable tracing).
kadonotakashi 0:8fdf9a60065b 70 *
kadonotakashi 0:8fdf9a60065b 71 * @param cb the callback to call on each memory operation.
kadonotakashi 0:8fdf9a60065b 72 */
kadonotakashi 0:8fdf9a60065b 73 void mbed_mem_trace_set_callback(mbed_mem_trace_cb_t cb);
kadonotakashi 0:8fdf9a60065b 74
kadonotakashi 0:8fdf9a60065b 75 /**
kadonotakashi 0:8fdf9a60065b 76 * Trace lock.
kadonotakashi 0:8fdf9a60065b 77 * @note Locking prevent recursive tracing of malloc/free inside relloc/calloc
kadonotakashi 0:8fdf9a60065b 78 */
kadonotakashi 0:8fdf9a60065b 79 void mbed_mem_trace_lock();
kadonotakashi 0:8fdf9a60065b 80
kadonotakashi 0:8fdf9a60065b 81 /**
kadonotakashi 0:8fdf9a60065b 82 * Trace unlock.
kadonotakashi 0:8fdf9a60065b 83 */
kadonotakashi 0:8fdf9a60065b 84 void mbed_mem_trace_unlock();
kadonotakashi 0:8fdf9a60065b 85
kadonotakashi 0:8fdf9a60065b 86 /**
kadonotakashi 0:8fdf9a60065b 87 * Trace a call to 'malloc'.
kadonotakashi 0:8fdf9a60065b 88 * @param res the result of running 'malloc'.
kadonotakashi 0:8fdf9a60065b 89 * @param size the 'size' argument given to 'malloc'.
kadonotakashi 0:8fdf9a60065b 90 * @param caller the caller of the memory operation.
kadonotakashi 0:8fdf9a60065b 91 * @return 'res' (the first argument).
kadonotakashi 0:8fdf9a60065b 92 */
kadonotakashi 0:8fdf9a60065b 93 void *mbed_mem_trace_malloc(void *res, size_t size, void *caller);
kadonotakashi 0:8fdf9a60065b 94
kadonotakashi 0:8fdf9a60065b 95 /**
kadonotakashi 0:8fdf9a60065b 96 * Trace a call to 'realloc'.
kadonotakashi 0:8fdf9a60065b 97 * @param res the result of running 'realloc'.
kadonotakashi 0:8fdf9a60065b 98 * @param ptr the 'ptr' argument given to 'realloc'.
kadonotakashi 0:8fdf9a60065b 99 * @param size the 'size' argument given to 'realloc'.
kadonotakashi 0:8fdf9a60065b 100 * @param caller the caller of the memory operation.
kadonotakashi 0:8fdf9a60065b 101 * @return 'res' (the first argument).
kadonotakashi 0:8fdf9a60065b 102 */
kadonotakashi 0:8fdf9a60065b 103 void *mbed_mem_trace_realloc(void *res, void *ptr, size_t size, void *caller);
kadonotakashi 0:8fdf9a60065b 104
kadonotakashi 0:8fdf9a60065b 105 /**
kadonotakashi 0:8fdf9a60065b 106 * Trace a call to 'calloc'.
kadonotakashi 0:8fdf9a60065b 107 * @param res the result of running 'calloc'.
kadonotakashi 0:8fdf9a60065b 108 * @param num the 'nmemb' argument given to 'calloc'.
kadonotakashi 0:8fdf9a60065b 109 * @param size the 'size' argument given to 'calloc'.
kadonotakashi 0:8fdf9a60065b 110 * @param caller the caller of the memory operation.
kadonotakashi 0:8fdf9a60065b 111 * @return 'res' (the first argument).
kadonotakashi 0:8fdf9a60065b 112 */
kadonotakashi 0:8fdf9a60065b 113 void *mbed_mem_trace_calloc(void *res, size_t num, size_t size, void *caller);
kadonotakashi 0:8fdf9a60065b 114
kadonotakashi 0:8fdf9a60065b 115 /**
kadonotakashi 0:8fdf9a60065b 116 * Trace a call to 'free'.
kadonotakashi 0:8fdf9a60065b 117 * @param ptr the 'ptr' argument given to 'free'.
kadonotakashi 0:8fdf9a60065b 118 * @param caller the caller of the memory operation.
kadonotakashi 0:8fdf9a60065b 119 */
kadonotakashi 0:8fdf9a60065b 120 void mbed_mem_trace_free(void *ptr, void *caller);
kadonotakashi 0:8fdf9a60065b 121
kadonotakashi 0:8fdf9a60065b 122 /**
kadonotakashi 0:8fdf9a60065b 123 * Default memory trace callback. DO NOT CALL DIRECTLY. It is meant to be used
kadonotakashi 0:8fdf9a60065b 124 * as the second argument of 'mbed_mem_trace_setup'.
kadonotakashi 0:8fdf9a60065b 125 *
kadonotakashi 0:8fdf9a60065b 126 * The default callback outputs trace data using 'printf', in a format that's
kadonotakashi 0:8fdf9a60065b 127 * easily parsable by an external tool. For each memory operation, the callback
kadonotakashi 0:8fdf9a60065b 128 * outputs a line that begins with "#<op>:<0xresult>;<0xcaller>-":
kadonotakashi 0:8fdf9a60065b 129 *
kadonotakashi 0:8fdf9a60065b 130 * @param op identifies the memory operation ('m' for 'malloc', 'r' for 'realloc',
kadonotakashi 0:8fdf9a60065b 131 * 'c' for 'calloc' and 'f' for 'free').
kadonotakashi 0:8fdf9a60065b 132 * @param res (base 16) is the result of the memor operation. This is always NULL
kadonotakashi 0:8fdf9a60065b 133 * for 'free', since 'free' doesn't return anything.
kadonotakashi 0:8fdf9a60065b 134 * @param caller (base 16) is the caller of the memory operation. Note that the value
kadonotakashi 0:8fdf9a60065b 135 * of 'caller' might be unreliable.
kadonotakashi 0:8fdf9a60065b 136 *
kadonotakashi 0:8fdf9a60065b 137 * The rest of the output depends on the operation being traced:
kadonotakashi 0:8fdf9a60065b 138 *
kadonotakashi 0:8fdf9a60065b 139 * - for 'malloc': 'size', where 'size' is the original argument to 'malloc'.
kadonotakashi 0:8fdf9a60065b 140 * - for 'realloc': '0xptr;size', where 'ptr' (base 16) and 'size' are the original arguments to 'realloc'.
kadonotakashi 0:8fdf9a60065b 141 * - for 'calloc': 'nmemb;size', where 'nmemb' and 'size' are the original arguments to 'calloc'.
kadonotakashi 0:8fdf9a60065b 142 * - for 'free': '0xptr', where 'ptr' (base 16) is the original argument to 'free'.
kadonotakashi 0:8fdf9a60065b 143 *
kadonotakashi 0:8fdf9a60065b 144 * Examples:
kadonotakashi 0:8fdf9a60065b 145 *
kadonotakashi 0:8fdf9a60065b 146 * - "#m:0x20003240;0x600d-50" encodes a 'malloc' that returned 0x20003240, was called
kadonotakashi 0:8fdf9a60065b 147 * by the instruction at 0x600D with a the 'size' argument equal to 50.
kadonotakashi 0:8fdf9a60065b 148 * - "#f:0x0;0x602f-0x20003240" encodes a 'free' that was called by the instruction at
kadonotakashi 0:8fdf9a60065b 149 * 0x602f with the 'ptr' argument equal to 0x20003240.
kadonotakashi 0:8fdf9a60065b 150 */
kadonotakashi 0:8fdf9a60065b 151 void mbed_mem_trace_default_callback(uint8_t op, void *res, void *caller, ...);
kadonotakashi 0:8fdf9a60065b 152
kadonotakashi 0:8fdf9a60065b 153 /** @}*/
kadonotakashi 0:8fdf9a60065b 154
kadonotakashi 0:8fdf9a60065b 155 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 156 }
kadonotakashi 0:8fdf9a60065b 157 #endif
kadonotakashi 0:8fdf9a60065b 158
kadonotakashi 0:8fdf9a60065b 159 #endif// #ifndef __MBED_MEM_TRACE_H__
kadonotakashi 0:8fdf9a60065b 160
kadonotakashi 0:8fdf9a60065b 161
kadonotakashi 0:8fdf9a60065b 162 /** @}*/