mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/itm_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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