Software APIs
dif_pwm_autogen.h
Go to the documentation of this file.
1 // Copyright lowRISC contributors (OpenTitan project).
2 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
3 // SPDX-License-Identifier: Apache-2.0
4 
5 #ifndef OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_
6 #define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_
7 
8 // THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
9 // util/make_new_dif.py --mode=regen --only=autogen
10 
11 /**
12  * @file
13  * @brief <a href="/book/hw/ip/pwm/">PWM</a> Device Interface Functions
14  */
15 
16 #include <stdbool.h>
17 #include <stdint.h>
18 
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif // __cplusplus
26 
27 /**
28  * A handle to pwm.
29  *
30  * This type should be treated as opaque by users.
31  */
32 typedef struct dif_pwm {
33  /**
34  * The base address for the pwm hardware registers.
35  */
37 } dif_pwm_t;
38 
39 /**
40  * Creates a new handle for a(n) pwm peripheral.
41  *
42  * This function does not actuate the hardware.
43  *
44  * @param base_addr The MMIO base address of the pwm peripheral.
45  * @param[out] pwm Out param for the initialized handle.
46  * @return The result of the operation.
47  */
50 
51 /**
52  * A pwm alert type.
53  */
54 typedef enum dif_pwm_alert {
55  /**
56  * This fatal alert is triggered when a fatal TL-UL bus integrity fault is
57  * detected.
58  */
61 
62 /**
63  * Forces a particular alert, causing it to be escalated as if the hardware
64  * had raised it.
65  *
66  * @param pwm A pwm handle.
67  * @param alert The alert to force.
68  * @return The result of the operation.
69  */
72 
73 #ifdef __cplusplus
74 } // extern "C"
75 #endif // __cplusplus
76 
77 #endif // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_