1 /* =============================================================================
2 * Copyright (c) Texas Instruments Incorporated 2014-2017
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
34 /**
35 * \defgroup PM_HAL PMHAL
36 *
37 * PMHAL provides low level APIs which allow:
38 * - Programming PRCM registers
39 * - Power Domain Manager (PDM)
40 * - Clock Domain Manager (CM)
41 * - Reset Manager (RM)
42 * - Module Manager (MM)
43 * - Programming Temperature Sensor Registers (Temp)
44 * - Programming Voltage Domain AVS and ABB (VM)
45 * - Programming board specific PMIC
46 *
47 */
49 /**
50 * \file pmhal.h
51 *
52 * \brief This file contains all includes related to PM Hardware
53 * abstraction layer.
54 *
55 */
57 #ifndef PMHAL_TOP_H_
58 #define PMHAL_TOP_H_
60 /* ========================================================================== */
61 /* Include Files */
62 /* ========================================================================== */
64 #if defined (SOC_TDA2XX) || defined (SOC_TDA2PX) || defined (SOC_AM572x) || defined (SOC_AM574x) || defined (SOC_DRA75x) || defined (SOC_TDA2EX) || defined (SOC_DRA72x) || defined (SOC_AM571x) || defined (SOC_TDA3XX) || defined (SOC_DRA78x)
65 #include <ti/drv/pm/include/pm_types.h>
66 #include <ti/drv/pm/include/pm_utils.h>
67 #include <ti/drv/pm/include/prcm/hw_pmhal_data_names.h>
68 #include <ti/drv/pm/include/prcm/pmhal_bgap.h>
69 #include <ti/drv/pm/include/prcm/pmhal_clocktree.h>
70 #include <ti/drv/pm/include/prcm/pmhal_cm.h>
71 #include <ti/drv/pm/include/prcm/pmhal_i2cComm.h>
72 #include <ti/drv/pm/include/prcm/pmhal_ina226.h>
73 #include <ti/drv/pm/include/prcm/pmhal_mm.h>
74 #include <ti/drv/pm/include/prcm/pmhal_mpu_lprm.h>
75 #include <ti/drv/pm/include/prcm/pmhal_pdm.h>
76 #include <ti/drv/pm/include/prcm/pmhal_pmic.h>
77 #include <ti/drv/pm/include/prcm/pmhal_pmicComm.h>
78 #include <ti/drv/pm/include/prcm/pmhal_prcm.h>
79 #include <ti/drv/pm/include/prcm/pmhal_prcm_includes.h>
80 #include <ti/drv/pm/include/prcm/pmhal_prcm_modinc.h>
81 #include <ti/drv/pm/include/prcm/pmhal_prcm_stats.h>
82 #include <ti/drv/pm/include/prcm/pmhal_prm_int.h>
83 #include <ti/drv/pm/include/prcm/pmhal_rm.h>
84 #include <ti/drv/pm/include/prcm/pmhal_sd.h>
85 #include <ti/drv/pm/include/prcm/pmhal_vm.h>
86 #endif
88 #if defined (SOC_TDA2XX) || defined (SOC_TDA2PX) || defined (SOC_AM572x) || defined (SOC_DRA75x) || defined (SOC_TDA2EX) || defined (SOC_DRA72x) || defined (SOC_AM571x) || defined (SOC_AM574x)
89 #include <ti/drv/pm/include/prcm/pmhal_videopll.h>
90 #endif
92 #ifdef __cplusplus
93 extern "C" {
94 #endif
96 /* ========================================================================== */
97 /* Macros and Typedefs */
98 /* ========================================================================== */
100 /* None */
102 /* ========================================================================== */
103 /* Structures and Enums */
104 /* ========================================================================== */
106 /* None */
108 /* ========================================================================== */
109 /* Global Variables */
110 /* ========================================================================== */
112 /* None */
114 /* ========================================================================== */
115 /* Function Declarations */
116 /* ========================================================================== */
118 /* None */
120 #ifdef __cplusplus
121 }
122 #endif
124 #endif /* PMHAL_TOP_H_ */