1 // Copyright 2017 Espressif Systems (Shanghai) PTE LTD 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 #ifndef ESP_DBG_STUBS_H_ 15 #define ESP_DBG_STUBS_H_ 16 17 #include "esp_err.h" 18 19 /** 20 * Debug stubs entries IDs 21 */ 22 typedef enum { 23 ESP_DBG_STUB_CONTROL_DATA, ///< stubs descriptor entry 24 ESP_DBG_STUB_ENTRY_FIRST, 25 ESP_DBG_STUB_ENTRY_GCOV ///< GCOV entry 26 = ESP_DBG_STUB_ENTRY_FIRST, 27 ESP_DBG_STUB_ENTRY_MAX 28 } esp_dbg_stub_id_t; 29 30 /** 31 * @brief Initializes debug stubs. 32 * 33 * @note Must be called after esp_apptrace_init() if app tracing is enabled. 34 */ 35 void esp_dbg_stubs_init(void); 36 37 /** 38 * @brief Initializes application tracing module. 39 * 40 * @note Should be called before any esp_apptrace_xxx call. 41 * 42 * @param id Stub ID. 43 * @param entry Stub entry. Usually it is stub entry function address, 44 * but can be any value meaningfull for OpenOCD command/code. 45 * 46 * @return ESP_OK on success, otherwise see esp_err_t 47 */ 48 esp_err_t esp_dbg_stub_entry_set(esp_dbg_stub_id_t id, uint32_t entry); 49 50 #endif //ESP_DBG_STUBS_H_ 51