mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/itm_api.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 165:d1b4690b3f8b 1 /** \addtogroup hal */
AnnaBridge 165:d1b4690b3f8b 2 /** @{*/
AnnaBridge 165:d1b4690b3f8b 3 /* mbed Microcontroller Library
AnnaBridge 165:d1b4690b3f8b 4 * Copyright (c) 2017 ARM Limited
AnnaBridge 165:d1b4690b3f8b 5 *
AnnaBridge 165:d1b4690b3f8b 6 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 165:d1b4690b3f8b 7 * you may not use this file except in compliance with the License.
AnnaBridge 165:d1b4690b3f8b 8 * You may obtain a copy of the License at
AnnaBridge 165:d1b4690b3f8b 9 *
AnnaBridge 165:d1b4690b3f8b 10 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 165:d1b4690b3f8b 11 *
AnnaBridge 165:d1b4690b3f8b 12 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 165:d1b4690b3f8b 13 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 165:d1b4690b3f8b 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 165:d1b4690b3f8b 15 * See the License for the specific language governing permissions and
AnnaBridge 165:d1b4690b3f8b 16 * limitations under the License.
AnnaBridge 165:d1b4690b3f8b 17 */
AnnaBridge 165:d1b4690b3f8b 18
AnnaBridge 165:d1b4690b3f8b 19 #ifndef MBED_ITM_API_H
AnnaBridge 165:d1b4690b3f8b 20 #define MBED_ITM_API_H
AnnaBridge 165:d1b4690b3f8b 21
AnnaBridge 165:d1b4690b3f8b 22 #if defined(DEVICE_ITM)
AnnaBridge 165:d1b4690b3f8b 23
AnnaBridge 165:d1b4690b3f8b 24 #include <stdint.h>
AnnaBridge 170:e95d10626187 25 #include <stddef.h>
AnnaBridge 165:d1b4690b3f8b 26
AnnaBridge 165:d1b4690b3f8b 27 #ifdef __cplusplus
AnnaBridge 165:d1b4690b3f8b 28 extern "C" {
AnnaBridge 165:d1b4690b3f8b 29 #endif
AnnaBridge 165:d1b4690b3f8b 30
AnnaBridge 165:d1b4690b3f8b 31 /**
AnnaBridge 165:d1b4690b3f8b 32 * \defgroup itm_hal Instrumented Trace Macrocell HAL API
AnnaBridge 165:d1b4690b3f8b 33 * @{
AnnaBridge 165:d1b4690b3f8b 34 */
AnnaBridge 165:d1b4690b3f8b 35
AnnaBridge 165:d1b4690b3f8b 36 enum {
AnnaBridge 165:d1b4690b3f8b 37 ITM_PORT_SWO = 0
AnnaBridge 165:d1b4690b3f8b 38 };
AnnaBridge 165:d1b4690b3f8b 39
AnnaBridge 165:d1b4690b3f8b 40 /**
AnnaBridge 165:d1b4690b3f8b 41 * @brief Target specific initialization function.
AnnaBridge 170:e95d10626187 42 * This function is responsible for initializing and configuring
AnnaBridge 170:e95d10626187 43 * the debug clock for the ITM and setting up the SWO pin for
AnnaBridge 165:d1b4690b3f8b 44 * debug output.
AnnaBridge 170:e95d10626187 45 *
AnnaBridge 165:d1b4690b3f8b 46 * The only Cortex-M register that should be modified is the clock
AnnaBridge 165:d1b4690b3f8b 47 * prescaler in TPI->ACPR.
AnnaBridge 170:e95d10626187 48 *
AnnaBridge 170:e95d10626187 49 * The generic mbed_itm_init initialization function will setup:
AnnaBridge 170:e95d10626187 50 *
AnnaBridge 165:d1b4690b3f8b 51 * ITM->LAR
AnnaBridge 165:d1b4690b3f8b 52 * ITM->TPR
AnnaBridge 165:d1b4690b3f8b 53 * ITM->TCR
AnnaBridge 165:d1b4690b3f8b 54 * ITM->TER
AnnaBridge 165:d1b4690b3f8b 55 * TPI->SPPR
AnnaBridge 165:d1b4690b3f8b 56 * TPI->FFCR
AnnaBridge 165:d1b4690b3f8b 57 * DWT->CTRL
AnnaBridge 170:e95d10626187 58 *
AnnaBridge 165:d1b4690b3f8b 59 * for SWO output on stimulus port 0.
AnnaBridge 165:d1b4690b3f8b 60 */
AnnaBridge 165:d1b4690b3f8b 61 void itm_init(void);
AnnaBridge 165:d1b4690b3f8b 62
AnnaBridge 165:d1b4690b3f8b 63 /**
AnnaBridge 165:d1b4690b3f8b 64 * @brief Initialization function for both generic registers and target specific clock and pin.
AnnaBridge 165:d1b4690b3f8b 65 */
AnnaBridge 165:d1b4690b3f8b 66 void mbed_itm_init(void);
AnnaBridge 165:d1b4690b3f8b 67
AnnaBridge 165:d1b4690b3f8b 68 /**
AnnaBridge 165:d1b4690b3f8b 69 * @brief Send data over ITM stimulus port.
AnnaBridge 165:d1b4690b3f8b 70 *
AnnaBridge 165:d1b4690b3f8b 71 * @param[in] port The stimulus port to send data over.
AnnaBridge 170:e95d10626187 72 * @param[in] data The 32-bit data to send.
AnnaBridge 170:e95d10626187 73 *
AnnaBridge 170:e95d10626187 74 * The data is written as a single 32-bit write to the port.
AnnaBridge 165:d1b4690b3f8b 75 *
AnnaBridge 165:d1b4690b3f8b 76 * @return value of data sent.
AnnaBridge 165:d1b4690b3f8b 77 */
AnnaBridge 165:d1b4690b3f8b 78 uint32_t mbed_itm_send(uint32_t port, uint32_t data);
AnnaBridge 165:d1b4690b3f8b 79
AnnaBridge 170:e95d10626187 80 /**
AnnaBridge 170:e95d10626187 81 * @brief Send a block of data over ITM stimulus port.
AnnaBridge 170:e95d10626187 82 *
AnnaBridge 170:e95d10626187 83 * @param[in] port The stimulus port to send data over.
AnnaBridge 170:e95d10626187 84 * @param[in] data The block of data to send.
AnnaBridge 170:e95d10626187 85 * @param[in] len The number of bytes of data to send.
AnnaBridge 170:e95d10626187 86 *
AnnaBridge 170:e95d10626187 87 * The data is written using multiple appropriately-sized port accesses for
AnnaBridge 170:e95d10626187 88 * efficient transfer.
AnnaBridge 170:e95d10626187 89 */
AnnaBridge 170:e95d10626187 90 void mbed_itm_send_block(uint32_t port, const void *data, size_t len);
AnnaBridge 170:e95d10626187 91
AnnaBridge 165:d1b4690b3f8b 92 /**@}*/
AnnaBridge 165:d1b4690b3f8b 93
AnnaBridge 165:d1b4690b3f8b 94 #ifdef __cplusplus
AnnaBridge 165:d1b4690b3f8b 95 }
AnnaBridge 165:d1b4690b3f8b 96 #endif
AnnaBridge 165:d1b4690b3f8b 97
AnnaBridge 165:d1b4690b3f8b 98 #endif
AnnaBridge 165:d1b4690b3f8b 99
AnnaBridge 165:d1b4690b3f8b 100 #endif /* MBED_ITM_API_H */
AnnaBridge 165:d1b4690b3f8b 101
AnnaBridge 165:d1b4690b3f8b 102 /**@}*/