Detect CPUID instruction before using it.
[seabios.git] / src / util.c
1 // Misc utility functions.
2 //
3 // Copyright (C) 2008,2009  Kevin O'Connor <kevin@koconnor.net>
4 //
5 // This file may be distributed under the terms of the GNU LGPLv3 license.
6
7 #include "util.h" // call16
8 #include "bregs.h" // struct bregs
9 #include "config.h" // BUILD_STACK_ADDR
10
11 void
12 cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
13 {
14     // Check for cpu id
15     u32 origflags = save_flags();
16     restore_flags(origflags ^ F_ID);
17     u32 newflags = save_flags();
18     restore_flags(origflags);
19
20     if (((origflags ^ newflags) & F_ID) != F_ID)
21         // no cpuid
22         *eax = *ebx = *ecx = *edx = 0;
23     else
24         __cpuid(index, eax, ebx, ecx, edx);
25 }
26
27
28 /****************************************************************
29  * 16bit calls
30  ****************************************************************/
31
32 // Call a function with a specified register state.  Note that on
33 // return, the interrupt enable/disable flag may be altered.
34 inline void
35 call16(struct bregs *callregs)
36 {
37     if (!MODESEGMENT && getesp() > BUILD_STACK_ADDR)
38         panic("call16 with invalid stack\n");
39     asm volatile(
40 #if MODE16 == 1
41         "calll __call16\n"
42         "cli\n"
43         "cld"
44 #else
45         "calll __call16_from32"
46 #endif
47         : "+a" (callregs), "+m" (*callregs)
48         :
49         : "ebx", "ecx", "edx", "esi", "edi", "cc", "memory");
50 }
51
52 inline void
53 call16big(struct bregs *callregs)
54 {
55     ASSERT32FLAT();
56     if (getesp() > BUILD_STACK_ADDR)
57         panic("call16 with invalid stack\n");
58     asm volatile(
59         "calll __call16big_from32"
60         : "+a" (callregs), "+m" (*callregs)
61         :
62         : "ebx", "ecx", "edx", "esi", "edi", "cc", "memory");
63 }
64
65 inline void
66 __call16_int(struct bregs *callregs, u16 offset)
67 {
68     if (MODESEGMENT)
69         callregs->code.seg = GET_SEG(CS);
70     else
71         callregs->code.seg = SEG_BIOS;
72     callregs->code.offset = offset;
73     call16(callregs);
74 }
75
76
77 /****************************************************************
78  * String ops
79  ****************************************************************/
80
81 // Sum the bytes in the specified area.
82 u8
83 checksum_far(u16 buf_seg, void *buf_far, u32 len)
84 {
85     SET_SEG(ES, buf_seg);
86     u32 i;
87     u8 sum = 0;
88     for (i=0; i<len; i++)
89         sum += GET_VAR(ES, ((u8*)buf_far)[i]);
90     return sum;
91 }
92
93 u8
94 checksum(void *buf, u32 len)
95 {
96     return checksum_far(GET_SEG(SS), buf, len);
97 }
98
99 size_t
100 strlen(const char *s)
101 {
102     if (__builtin_constant_p(s))
103         return __builtin_strlen(s);
104     const char *p = s;
105     while (*p)
106         p++;
107     return p-s;
108 }
109
110 // Compare two areas of memory.
111 int
112 memcmp(const void *s1, const void *s2, size_t n)
113 {
114     while (n) {
115         if (*(u8*)s1 != *(u8*)s2)
116             return *(u8*)s1 < *(u8*)s2 ? -1 : 1;
117         s1++;
118         s2++;
119         n--;
120     }
121     return 0;
122 }
123
124 // Compare two strings.
125 int
126 strcmp(const char *s1, const char *s2)
127 {
128     for (;;) {
129         if (*s1 != *s2)
130             return *s1 < *s2 ? -1 : 1;
131         if (! *s1)
132             return 0;
133         s1++;
134         s2++;
135     }
136 }
137
138 inline void
139 memset_far(u16 d_seg, void *d_far, u8 c, size_t len)
140 {
141     SET_SEG(ES, d_seg);
142     asm volatile(
143         "rep stosb %%es:(%%di)"
144         : "+c"(len), "+D"(d_far)
145         : "a"(c)
146         : "cc", "memory");
147 }
148
149 inline void
150 memset16_far(u16 d_seg, void *d_far, u16 c, size_t len)
151 {
152     len /= 2;
153     SET_SEG(ES, d_seg);
154     asm volatile(
155         "rep stosw %%es:(%%di)"
156         : "+c"(len), "+D"(d_far)
157         : "a"(c)
158         : "cc", "memory");
159 }
160
161 void *
162 memset(void *s, int c, size_t n)
163 {
164     while (n)
165         ((char *)s)[--n] = c;
166     return s;
167 }
168
169 void memset_fl(void *ptr, u8 val, size_t size)
170 {
171     if (MODESEGMENT)
172         memset_far(FLATPTR_TO_SEG(ptr), (void*)(FLATPTR_TO_OFFSET(ptr)),
173                    val, size);
174     else
175         memset(ptr, val, size);
176 }
177
178 inline void
179 memcpy_far(u16 d_seg, void *d_far, u16 s_seg, const void *s_far, size_t len)
180 {
181     SET_SEG(ES, d_seg);
182     u16 bkup_ds;
183     asm volatile(
184         "movw %%ds, %w0\n"
185         "movw %w4, %%ds\n"
186         "rep movsb (%%si),%%es:(%%di)\n"
187         "movw %w0, %%ds"
188         : "=&r"(bkup_ds), "+c"(len), "+S"(s_far), "+D"(d_far)
189         : "r"(s_seg)
190         : "cc", "memory");
191 }
192
193 inline void
194 memcpy_fl(void *d_fl, const void *s_fl, size_t len)
195 {
196     if (MODESEGMENT)
197         memcpy_far(FLATPTR_TO_SEG(d_fl), (void*)FLATPTR_TO_OFFSET(d_fl)
198                    , FLATPTR_TO_SEG(s_fl), (void*)FLATPTR_TO_OFFSET(s_fl)
199                    , len);
200     else
201         memcpy(d_fl, s_fl, len);
202 }
203
204 void *
205 #undef memcpy
206 memcpy(void *d1, const void *s1, size_t len)
207 #if MODESEGMENT == 0
208 #define memcpy __builtin_memcpy
209 #endif
210 {
211     SET_SEG(ES, GET_SEG(SS));
212     void *d = d1;
213     if (((u32)d1 | (u32)s1 | len) & 3) {
214         // non-aligned memcpy
215         asm volatile(
216             "rep movsb (%%esi),%%es:(%%edi)"
217             : "+c"(len), "+S"(s1), "+D"(d)
218             : : "cc", "memory");
219         return d1;
220     }
221     // Common case - use 4-byte copy
222     len /= 4;
223     asm volatile(
224         "rep movsl (%%esi),%%es:(%%edi)"
225         : "+c"(len), "+S"(s1), "+D"(d)
226         : : "cc", "memory");
227     return d1;
228 }
229
230 // Copy to/from memory mapped IO.  IO mem is very slow, so yield
231 // periodically.
232 void
233 iomemcpy(void *d, const void *s, u32 len)
234 {
235     yield();
236     while (len > 3) {
237         u32 copylen = len;
238         if (copylen > 2048)
239             copylen = 2048;
240         copylen /= 4;
241         len -= copylen * 4;
242         asm volatile(
243             "rep movsl (%%esi),%%es:(%%edi)"
244             : "+c"(copylen), "+S"(s), "+D"(d)
245             : : "cc", "memory");
246         yield();
247     }
248     if (len)
249         // Copy any remaining bytes.
250         memcpy(d, s, len);
251 }
252
253 void *
254 memmove(void *d, const void *s, size_t len)
255 {
256     if (s >= d)
257         return memcpy(d, s, len);
258
259     d += len-1;
260     s += len-1;
261     while (len--) {
262         *(char*)d = *(char*)s;
263         d--;
264         s--;
265     }
266
267     return d;
268 }
269
270 // Copy a string - truncating it if necessary.
271 char *
272 strtcpy(char *dest, const char *src, size_t len)
273 {
274     char *d = dest;
275     while (--len && *src != '\0')
276         *d++ = *src++;
277     *d = '\0';
278     return dest;
279 }
280
281 // locate first occurance of character c in the string s
282 char *
283 strchr(const char *s, int c)
284 {
285     for (; *s; s++)
286         if (*s == c)
287             return (char*)s;
288     return NULL;
289 }
290
291 // Remove any trailing blank characters (spaces, new lines, carriage returns)
292 void
293 nullTrailingSpace(char *buf)
294 {
295     int len = strlen(buf);
296     char *end = &buf[len-1];
297     while (end >= buf && *end <= ' ')
298         *(end--) = '\0';
299 }
300
301 /****************************************************************
302  * Keyboard calls
303  ****************************************************************/
304
305 // See if a keystroke is pending in the keyboard buffer.
306 static int
307 check_for_keystroke(void)
308 {
309     struct bregs br;
310     memset(&br, 0, sizeof(br));
311     br.flags = F_IF;
312     br.ah = 1;
313     call16_int(0x16, &br);
314     return !(br.flags & F_ZF);
315 }
316
317 // Return a keystroke - waiting forever if necessary.
318 static int
319 get_raw_keystroke(void)
320 {
321     struct bregs br;
322     memset(&br, 0, sizeof(br));
323     br.flags = F_IF;
324     call16_int(0x16, &br);
325     return br.ah;
326 }
327
328 // Read a keystroke - waiting up to 'msec' milliseconds.
329 int
330 get_keystroke(int msec)
331 {
332     u32 end = calc_future_timer(msec);
333     for (;;) {
334         if (check_for_keystroke())
335             return get_raw_keystroke();
336         if (check_timer(end))
337             return -1;
338         wait_irq();
339     }
340 }