aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/lm4f/rcc.h
blob: 1c15f4b2f6326f9fe18bce414cac1cce9f4ad0f8 (plain)
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
117
118
119
120
121
122
123
124
125
126
/*
 * This file is part of the libopencm3 project.
 *
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * @defgroup rcc_defines RCC Defines
 *
 * @ingroup LM4F_defines
 *
 * \brief <b>Defined Constants and Types for the LM4F Clock control API</b>
 * @{
 */

#ifndef LM4F_RCC_H
#define LM4F_RCC_H

#include <libopencm3/lm4f/systemcontrol.h>

/**
 * \brief Oscillator source values
 *
 * Possible values of the oscillator source.
 */
typedef enum {
	OSCSRC_MOSC		= SYSCTL_RCC2_OSCSRC2_MOSC,
	OSCSRC_PIOSC		= SYSCTL_RCC2_OSCSRC2_PIOSC,
	OSCSRC_PIOSC_D4		= SYSCTL_RCC2_OSCSRC2_PIOSC_D4,
	OSCSRC_30K_INT		= SYSCTL_RCC2_OSCSRC2_30K,
	OSCSRC_32K_EXT		= SYSCTL_RCC2_OSCSRC2_32K768,
} osc_src_t;

/**
 * \brief PWM clock divisor values
 *
 * Possible values of the binary divisor used to predivide the system clock down
 * for use as the timing reference for the PWM module.
 */
typedef enum {
	PWMDIV_2		= SYSCTL_RCC_PWMDIV_2,
	PWMDIV_4		= SYSCTL_RCC_PWMDIV_4,
	PWMDIV_8		= SYSCTL_RCC_PWMDIV_8,
	PWMDIV_16		= SYSCTL_RCC_PWMDIV_16,
	PWMDIV_32		= SYSCTL_RCC_PWMDIV_32,
	PWMDIV_64		= SYSCTL_RCC_PWMDIV_64,
} pwm_clkdiv_t;

/**
 * \brief Predefined crystal values
 *
 * Predefined crystal values for the XTAL field in SYSCTL_RCC.
 * Using these predefined values in the XTAL field, the SYSCTL_PLLFREQ0 and
 * SYSCTL_PLLFREQ1 are automatically adjusted in hardware to provide a PLL clock
 * of 400MHz.
 */
typedef enum {
	XTAL_4M			= SYSCTL_RCC_XTAL_4M,
	XTAL_4M_096		= SYSCTL_RCC_XTAL_4M_096,
	XTAL_4M_9152		= SYSCTL_RCC_XTAL_4M_9152,
	XTAL_5M			= SYSCTL_RCC_XTAL_5M,
	XTAL_5M_12		= SYSCTL_RCC_XTAL_5M_12,
	XTAL_6M			= SYSCTL_RCC_XTAL_6M,
	XTAL_6M_144		= SYSCTL_RCC_XTAL_6M_144,
	XTAL_7M_3728		= SYSCTL_RCC_XTAL_7M_3728,
	XTAL_8M			= SYSCTL_RCC_XTAL_8M,
	XTAL_8M_192		= SYSCTL_RCC_XTAL_8M_192,
	XTAL_10M		= SYSCTL_RCC_XTAL_10M,
	XTAL_12M		= SYSCTL_RCC_XTAL_12M,
	XTAL_12M_288		= SYSCTL_RCC_XTAL_12M_288,
	XTAL_13M_56		= SYSCTL_RCC_XTAL_13M_56,
	XTAL_14M_31818		= SYSCTL_RCC_XTAL_14M_31818,
	XTAL_16M		= SYSCTL_RCC_XTAL_16M,
	XTAL_16M_384		= SYSCTL_RCC_XTAL_16M_384,
	XTAL_18M		= SYSCTL_RCC_XTAL_18M,
	XTAL_20M		= SYSCTL_RCC_XTAL_20M,
	XTAL_24M		= SYSCTL_RCC_XTAL_24M,
	XTAL_25M		= SYSCTL_RCC_XTAL_25M,
} xtal_t;

/**
 * @}
 */
/* =============================================================================
 * Function prototypes
 * ---------------------------------------------------------------------------*/
BEGIN_DECLS
/* Low-level clock API */
void rcc_configure_xtal(xtal_t xtal);
void rcc_disable_main_osc(void);
void rcc_disable_interal_osc(void);
void rcc_enable_main_osc(void);
void rcc_enable_interal_osc(void);
void rcc_enable_rcc2(void);
void rcc_pll_off(void);
void rcc_pll_on(void);
void rcc_set_osc_source(osc_src_t src);
void rcc_pll_bypass_disable(void);
void rcc_pll_bypass_enable(void);
void rcc_set_pll_divisor(u8 div400);
void rcc_set_pwm_divisor(pwm_clkdiv_t div);
void rcc_usb_pll_off(void);
void rcc_usb_pll_on(void);
void rcc_wait_for_pll_ready(void);
/* High-level clock API */
void rcc_change_pll_divisor(u8 plldiv400);
u32 rcc_get_system_clock_frequency(void);
void rcc_sysclk_config(osc_src_t src, xtal_t xtal, u8 pll_div400);

END_DECLS


#endif /* LM4F_RCC_H */