lm3s1968: return the correct CPU frequency in clock_get_rate().
[bertos.git] / bertos / cpu / cortex-m3 / drv / clock_lm3s.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief LM3S1968 Clocking driver.
34  *
35  * \author Andrea Righi <arighi@develer.com>
36  */
37
38 #include <cfg/compiler.h>
39 #include <cfg/debug.h>
40 #include "io/lm3s.h"
41 #include "clock_lm3s.h"
42
43 /* The PLL VCO frequency is 400 MHz */
44 #define PLL_VCO 400000000UL
45
46 /* Extract the system clock divisor from the RCC register */
47 #define RCC_TO_DIV(rcc)                                         \
48                 (((rcc & SYSCTL_RCC_SYSDIV_MASK) >>             \
49                                 SYSCTL_RCC_SYSDIV_SHIFT) + 1)
50
51 /*
52  * Very small delay: each loop takes 3 cycles.
53  */
54 INLINE void __delay(unsigned long iterations)
55 {
56         asm volatile (
57                 "1:     subs    %0, #1\n\t"
58                 "       bne 1b\n\t"
59                 : "=r"(iterations) : : "memory", "cc");
60 }
61
62 unsigned long clock_get_rate(void)
63 {
64         reg32_t rcc = HWREG(SYSCTL_RCC);
65
66         return rcc & SYSCTL_RCC_USESYSDIV ?
67                         PLL_VCO / 2 / RCC_TO_DIV(rcc) : PLL_VCO;
68 }
69
70 void clock_set_rate(void)
71 {
72         reg32_t rcc, rcc2;
73         unsigned long clk;
74         int i;
75
76         rcc = HWREG(SYSCTL_RCC);
77         rcc2 = HWREG(SYSCTL_RCC2);
78
79         /*
80          * Step #1: bypass the PLL and system clock divider by setting the
81          * BYPASS bit and clearing the USESYS bit in the RCC register. This
82          * configures the system to run off a “raw” clock source (using the
83          * main oscillator or internal oscillator) and allows for the new PLL
84          * configuration to be validated before switching the system clock to
85          * the PLL.
86          */
87         rcc |= SYSCTL_RCC_BYPASS;
88         rcc &= ~SYSCTL_RCC_USESYSDIV;
89         rcc2 |= SYSCTL_RCC2_BYPASS2;
90
91         /* Write back RCC/RCC2 registers */
92         HWREG(SYSCTL_RCC) = rcc;
93         HWREG(SYSCTL_RCC) = rcc2;
94
95         /*
96          * Step #2: select the crystal value (XTAL) and oscillator source
97          * (OSCSRC), and clear the PWRDN bit in RCC/RCC2. Setting the XTAL
98          * field automatically pulls valid PLL configuration data for the
99          * appropriate crystal, and clearing the PWRDN bit powers and enables
100          * the PLL and its output.
101          */
102
103         /* Enable the main oscillator first. */
104         rcc &= ~(SYSCTL_RCC_IOSCDIS | SYSCTL_RCC_MOSCDIS);
105         rcc |= SYSCTL_RCC_IOSCDIS;
106
107         /* Do not override RCC register fields */
108         rcc2 &= ~SYSCTL_RCC2_USERCC2;
109
110         rcc &= ~(SYSCTL_RCC_XTAL_M | SYSCTL_RCC_OSCSRC_M | SYSCTL_RCC_PWRDN);
111         rcc |= XTAL_FREQ | SYSCTL_RCC_OSCSRC_MAIN;
112
113         /* Clear the PLL lock interrupt. */
114         HWREG(SYSCTL_MISC) = SYSCTL_INT_PLL_LOCK;
115
116         HWREG(SYSCTL_RCC) = rcc;
117         HWREG(SYSCTL_RCC) = rcc2;
118
119         __delay(16);
120
121         /*
122          * Step #3: select the desired system divider (SYSDIV) in RCC/RCC2 and
123          * set the USESYS bit in RCC. The SYSDIV field determines the system
124          * frequency for the microcontroller.
125          */
126         rcc &= ~(SYSCTL_RCC_SYSDIV_M | SYSCTL_RCC_USESYSDIV);
127
128         /*
129          * Try to evaluate the correct SYSDIV value depending on the desired
130          * CPU frequency.
131          *
132          * NOTE: with BYPASS=0, SYSDIV < 3 are reserved values (see LM3S1968
133          * Microcontroller DATASHEET, p.78).
134          */
135         clk = PLL_VCO / 2;
136         for (i = 3; i < 16; i++)
137                 if (CPU_FREQ >= (clk / (i + 1)))
138                         break;
139         if (i)
140                 rcc |= SYSCTL_RCC_USESYSDIV | (i << SYSCTL_RCC_SYSDIV_SHIFT);
141
142         /*
143          * Step #4: wait for the PLL to lock by polling the PLLLRIS bit in the
144          * Raw Interrupt Status (RIS) register.
145          */
146         for (i = 0; i < 32768; i++)
147                 if (HWREG(SYSCTL_RIS) & SYSCTL_INT_PLL_LOCK)
148                         break;
149
150         /*
151          * Step #5: enable use of the PLL by clearing the BYPASS bit in
152          * RCC/RCC2.
153          */
154         rcc &= ~SYSCTL_RCC_BYPASS;
155
156         HWREG(SYSCTL_RCC) = rcc;
157
158         __delay(16);
159 }