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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

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