ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>
#include "esp_err.h"
#include "driver/mcpwm_types.h"
mcpwm_gpio_fault_config_t
mcpwm_new_gpio_fault(const mcpwm_gpio_fault_config_t *, mcpwm_fault_handle_t *);
mcpwm_soft_fault_config_t
mcpwm_new_soft_fault(const mcpwm_soft_fault_config_t *, mcpwm_fault_handle_t *);
mcpwm_del_fault(mcpwm_fault_handle_t);
mcpwm_soft_fault_activate(mcpwm_fault_handle_t);
mcpwm_fault_event_callbacks_t
mcpwm_fault_register_event_callbacks(mcpwm_fault_handle_t, const mcpwm_fault_event_callbacks_t *, void *);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_driver_mcpwm/include/driver/mcpwm_fault.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include <stdint.h> #include <stdbool.h> #include <stdarg.h> #include "esp_err.h" #include "driver/mcpwm_types.h"5 includes #ifdef __cplusplus extern "C" { #endif /** * @brief MCPWM GPIO fault configuration structure *//* ... */ typedef struct { int group_id; /*!< In which MCPWM group that the GPIO fault belongs to */ int intr_priority; /*!< MCPWM GPIO fault interrupt priority, if set to 0, the driver will try to allocate an interrupt with a relative low priority (1,2,3) *//* ... */ int gpio_num; /*!< GPIO used by the fault signal */ struct { uint32_t active_level: 1; /*!< On which level the fault signal is treated as active */ uint32_t io_loop_back: 1; /*!< For debug/test, the signal output from the GPIO will be fed to the input path as well */ uint32_t pull_up: 1; /*!< Whether to pull up internally */ uint32_t pull_down: 1; /*!< Whether to pull down internally */ }{ ... } flags; /*!< Extra configuration flags for GPIO fault */ }{ ... } mcpwm_gpio_fault_config_t; /** * @brief Create MCPWM GPIO fault * * @param[in] config MCPWM GPIO fault configuration * @param[out] ret_fault Returned GPIO fault handle * @return * - ESP_OK: Create MCPWM GPIO fault successfully * - ESP_ERR_INVALID_ARG: Create MCPWM GPIO fault failed because of invalid argument * - ESP_ERR_NO_MEM: Create MCPWM GPIO fault failed because out of memory * - ESP_ERR_NOT_FOUND: Create MCPWM GPIO fault failed because can't find free resource * - ESP_FAIL: Create MCPWM GPIO fault failed because of other error *//* ... */ esp_err_t mcpwm_new_gpio_fault(const mcpwm_gpio_fault_config_t *config, mcpwm_fault_handle_t *ret_fault); /** * @brief MCPWM software fault configuration structure *//* ... */ typedef struct { }{ ... } mcpwm_soft_fault_config_t; /** * @brief Create MCPWM software fault * * @param[in] config MCPWM software fault configuration * @param[out] ret_fault Returned software fault handle * @return * - ESP_OK: Create MCPWM software fault successfully * - ESP_ERR_INVALID_ARG: Create MCPWM software fault failed because of invalid argument * - ESP_ERR_NO_MEM: Create MCPWM software fault failed because out of memory * - ESP_FAIL: Create MCPWM software fault failed because of other error *//* ... */ esp_err_t mcpwm_new_soft_fault(const mcpwm_soft_fault_config_t *config, mcpwm_fault_handle_t *ret_fault); /** * @brief Delete MCPWM fault * * @param[in] fault MCPWM fault handle allocated by `mcpwm_new_gpio_fault()` or `mcpwm_new_soft_fault()` * @return * - ESP_OK: Delete MCPWM fault successfully * - ESP_ERR_INVALID_ARG: Delete MCPWM fault failed because of invalid argument * - ESP_FAIL: Delete MCPWM fault failed because of other error *//* ... */ esp_err_t mcpwm_del_fault(mcpwm_fault_handle_t fault); /** * @brief Activate the software fault, trigger the fault event for once * * @param[in] fault MCPWM soft fault, allocated by `mcpwm_new_soft_fault()` * @return * - ESP_OK: Trigger MCPWM software fault event successfully * - ESP_ERR_INVALID_ARG: Trigger MCPWM software fault event failed because of invalid argument * - ESP_FAIL: Trigger MCPWM software fault event failed because of other error *//* ... */ esp_err_t mcpwm_soft_fault_activate(mcpwm_fault_handle_t fault); /** * @brief Group of supported MCPWM fault event callbacks * @note The callbacks are all running under ISR environment *//* ... */ typedef struct { mcpwm_fault_event_cb_t on_fault_enter; /*!< ISR callback function that would be invoked when fault signal becomes active */ mcpwm_fault_event_cb_t on_fault_exit; /*!< ISR callback function that would be invoked when fault signal becomes inactive */ }{ ... } mcpwm_fault_event_callbacks_t; /** * @brief Set event callbacks for MCPWM fault * * @note User can deregister a previously registered callback by calling this function and setting the callback member in the `cbs` structure to NULL. * * @param[in] fault MCPWM GPIO fault handle, allocated by `mcpwm_new_gpio_fault()` * @param[in] cbs Group of callback functions * @param[in] user_data User data, which will be passed to callback functions directly * @return * - ESP_OK: Set event callbacks successfully * - ESP_ERR_INVALID_ARG: Set event callbacks failed because of invalid argument * - ESP_FAIL: Set event callbacks failed because of other error *//* ... */ esp_err_t mcpwm_fault_register_event_callbacks(mcpwm_fault_handle_t fault, const mcpwm_fault_event_callbacks_t *cbs, void *user_data); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: