[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_1_eng / packages / ti / csl / csl_pllc.h
1 /**
2 * @file csl_pllc.h
3 *
4 * @brief
5 * This is the main Header File for the PLLC Module which defines all
6 * the data structures and exported API.
7 *
8 * \par
9 * ============================================================================
10 * @n (C) Copyright 2010 Texas Instruments, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 * Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the
22 * distribution.
23 *
24 * Neither the name of Texas Instruments Incorporated nor the names of
25 * its contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 */
41 /** @defgroup CSL_PLLC_API PLLC
42 *
43 * @section Introduction
44 *
45 * @subsection xxx Overview
46 *
47 * The Phase-Locked Loop (PLL) controller offers flexibility and
48 * convenience by way of software configurable multipliers and
49 * dividers to modify the clock input signal internally. The
50 * resulting clock outputs are passed to the DSP core, peripherals
51 * and other modules in the DSP.
52 *
53 * @subsection References
54 * -# PLLC User Guide.
55 *
56 * @subsection Assumptions
57 * The abbreviations PLLC, pllc and Pllc have been used throughout this
58 * document to refer to PLL Controller.
59 */
60 #ifndef CSL_PLLC_H
61 #define CSL_PLLC_H
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
67 #include <ti/csl/soc.h>
68 #include <ti/csl/csl.h>
69 #include <ti/csl/cslr_pllc.h>
71 /**
72 @defgroup CSL_PLLC_SYMBOL PLLC Symbols Defined
73 @ingroup CSL_PLLC_API
74 */
75 /**
76 @defgroup CSL_PLLC_DATASTRUCT PLLC Data Structures
77 @ingroup CSL_PLLC_API
78 */
79 /**
80 @defgroup CSL_PLLC_FUNCTION PLLC Functions
81 @ingroup CSL_PLLC_API
82 */
83 /**
84 @defgroup CSL_PLLC_ENUM PLLC Enumerated Data Types
85 @ingroup CSL_PLLC_API
86 */
88 /**
89 *
90 * @brief PLL controller type
91 *
92 * This enumeration defines PLL controller types for K2 devices
93 * */
94 typedef enum
95 {
96 CSL_PLL_SYS, /* System main PLL */
97 CSL_PLL_PA, /* PASS PLL */
98 CSL_PLL_ARM, /* ARM PLL */
99 CSL_PLL_DDR3, /* DDR3 PLL */
100 CSL_PLL_DDR3B, /* DDR3B PLL */
101 CSL_PLL_NSS, /* NSS PLL */
102 CSL_PLL_UART, /* UART PLL */
103 CSL_PLL_DSS, /* DSS PLL */
104 CSL_PLL_ICSS, /* ICSS PLL */
105 CSL_PLL_MAX /* Max num of PLL types */
107 } CSL_PllcType;
109 /**
110 @addtogroup CSL_PLLC_SYMBOL
111 @{
112 */
114 /**
115 @}
116 */
118 /** @addtogroup CSL_PLLC_DATASTRUCT
119 @{ */
121 /** @brief This is the handle to the PLLC instance */
122 typedef volatile CSL_PllcRegs* CSL_PllcHandle;
124 /** @brief PLLC Valid Key for configure Reset Control and Reset Cfg registers */
125 #define CSL_PLLC_RSTCTRL_VALID_KEY 0x5A69
128 /**
129 @}
130 */
132 /* Device specific API which opens the PLLC instance and returns a handle used in all subsequent calls */
133 extern CSL_PllcHandle CSL_PLLC_open (Int32 instNum);
136 #ifdef __cplusplus
137 }
138 #endif
140 #endif /* CSL_PLLC_H */