[PATCH]: libpayload: Document the architecture specific routines
[coreboot.git] / payloads / libpayload / i386 / timer.c
1 /*
2  * This file is part of the libpayload project.
3  *
4  * Copyright (C) 2008 Advanced Micro Devices, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. 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 distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 /** @file i386/timer.c
31  * @brief i386 specific timer routines
32  */
33
34 #include <libpayload.h>
35 #include <arch/rdtsc.h>
36
37 /**
38  * @ingroup arch
39  * Global variable containing the speed of the processor in KHz
40  */
41 u32 cpu_khz;
42
43 /**
44  * Calculate the speed of the processor for use in delays.
45  *
46  * @return The CPU speed in kHz.
47  */
48 unsigned int get_cpu_speed(void)
49 {
50         unsigned long long start, end;
51
52         /* Set up the PPC port - disable the speaker, enable the T2 gate. */
53         outb((inb(0x61) & ~0x02) | 0x01, 0x61);
54
55         /* Set the PIT to Mode 0, counter 2, word access. */
56         outb(0xB0, 0x43);
57
58         /* Load the counter with 0xffff. */
59         outb(0xff, 0x42);
60         outb(0xff, 0x42);
61
62         /* Read the number of ticks during the period. */
63         start = rdtsc();
64         while (!(inb(0x61) & 0x20)) ;
65         end = rdtsc();
66
67         /*
68          * The clock rate is 1193180 Hz, the number of milliseconds for a
69          * period of 0xffff is 1193180 / (0xFFFF * 1000) or .0182.
70          * Multiply that by the number of measured clocks to get the kHz value.
71          */
72         cpu_khz = (unsigned int)((end - start) * 1193180U / (1000 * 0xffff));
73
74         return cpu_khz;
75 }
76
77 static inline void _delay(unsigned int delta)
78 {
79         unsigned long long timeout = rdtsc() + delta;
80         while (rdtsc() < timeout) ;
81 }
82
83 /**
84  * Delay for a specified number of nanoseconds
85  * @param n Number of nanoseconds to delay for
86  */
87 void ndelay(unsigned int n)
88 {
89         _delay(n * cpu_khz / 1000000);
90 }
91
92 /**
93  * Delay for a specified number of microseconds
94  * @param n Number of microseconds to delay for
95  */
96 void udelay(unsigned int n)
97 {
98         _delay(n * cpu_khz / 1000);
99 }
100
101 /**
102  * Delay for a specified number of milliseconds
103  * @param n Number of milliseconds to delay for
104  */
105
106 void mdelay(unsigned int m)
107 {
108         _delay(m * cpu_khz);
109 }
110
111 /**
112  * Delay for a specified number of seconds
113  * @param n Number of seconds to delay for
114  */
115
116 void delay(unsigned int s)
117 {
118         _delay(s * cpu_khz * 1000);
119 }