1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 by Alan Korr
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
28 #include "gcc_extensions.h" /* for LIKELY/UNLIKELY */
30 extern void system_reboot (void);
31 /* Called from any UIE handler and panicf - wait for a key and return
32 * to reboot system. */
33 extern void system_exception_wait(void);
34 extern void system_init(void);
36 extern long cpu_frequency
;
44 bool detect_flashed_romimage(void);
45 bool detect_flashed_ramimage(void);
46 bool detect_original_firmware(void);
48 #if defined(HAVE_ADJUSTABLE_CPU_FREQ) \
49 && defined(ROCKBOX_HAS_LOGF) && (NUM_CORES == 1)
50 #define CPU_BOOST_LOGGING
53 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
55 extern struct spinlock boostctrl_spin
;
57 void cpu_boost_init(void);
58 #define FREQ cpu_frequency
59 void set_cpu_frequency(long frequency
);
60 #ifdef CPU_BOOST_LOGGING
61 char * cpu_boost_log_getlog_first(void);
62 char * cpu_boost_log_getlog_next(void);
63 int cpu_boost_log_getcount(void);
64 void cpu_boost_(bool on_off
, char* location
, int line
);
66 void cpu_boost(bool on_off
);
68 void cpu_idle_mode(bool on_off
);
69 int get_cpu_boost_counter(void);
70 #else /* ndef HAVE_ADJUSTABLE_CPU_FREQ */
74 #define set_cpu_frequency(frequency)
75 #define cpu_boost(on_off)
76 #define cpu_boost_id(on_off, id)
77 #define cpu_idle_mode(on_off)
78 #define get_cpu_boost_counter()
79 #define get_cpu_boost_tracker()
80 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
82 #ifdef CPU_BOOST_LOGGING
83 #define cpu_boost(on_off) cpu_boost_(on_off,__FILE__, __LINE__)
89 #define NULL ((void*)0)
93 #define MIN(a, b) (((a)<(b))?(a):(b))
97 #define MAX(a, b) (((a)>(b))?(a):(b))
100 /* return number of elements in array a */
101 #define ARRAYLEN(a) (sizeof(a)/sizeof((a)[0]))
103 /* return p incremented by specified number of bytes */
104 #define SKIPBYTES(p, count) ((typeof (p))((char *)(p) + (count)))
106 #define P2_M1(p2) ((1 << (p2))-1)
108 /* align up or down to nearest 2^p2 */
109 #define ALIGN_DOWN_P2(n, p2) ((n) & ~P2_M1(p2))
110 #define ALIGN_UP_P2(n, p2) ALIGN_DOWN_P2((n) + P2_M1(p2),p2)
112 /* align up or down to nearest integer multiple of a */
113 #define ALIGN_DOWN(n, a) ((n)/(a)*(a))
114 #define ALIGN_UP(n, a) ALIGN_DOWN((n)+((a)-1),a)
116 /* align start and end of buffer to nearest integer multiple of a */
117 #define ALIGN_BUFFER(ptr,len,align) \
119 uintptr_t tmp_ptr1 = (uintptr_t)ptr; \
120 uintptr_t tmp_ptr2 = tmp_ptr1 + len;\
121 tmp_ptr1 = ALIGN_UP(tmp_ptr1,align); \
122 tmp_ptr2 = ALIGN_DOWN(tmp_ptr2,align); \
123 len = tmp_ptr2 - tmp_ptr1; \
124 ptr = (typeof(ptr))tmp_ptr1; \
128 /* newer? SDL includes endian.h, So we ignore it */
129 #if (CONFIG_PLATFORM & PLATFORM_HOSTED) || defined(__PCTOOL__)
140 /* Get the byte offset of a type's member */
141 #define OFFSETOF(type, membername) ((off_t)&((type *)0)->membername)
143 /* Get the type pointer from one of its members */
144 #define TYPE_FROM_MEMBER(type, memberptr, membername) \
145 ((type *)((intptr_t)(memberptr) - OFFSETOF(type, membername)))
147 /* returns index of first set bit or 32 if no bits are set */
148 int find_first_set_bit(uint32_t val
);
150 static inline __attribute__((always_inline
))
151 uint32_t isolate_first_bit(uint32_t val
)
152 { return val
& -val
; }
154 /* Functions to set and clear register or variable bits atomically */
155 void bitmod32(volatile uint32_t *addr
, uint32_t bits
, uint32_t mask
);
156 void bitset32(volatile uint32_t *addr
, uint32_t mask
);
157 void bitclr32(volatile uint32_t *addr
, uint32_t mask
);
159 /* gcc 3.4 changed the format of the constraints */
160 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ > 3) || (__GNUC__ >= 4)
161 #define I_CONSTRAINT "I08"
163 #define I_CONSTRAINT "I"
166 /* Utilize the user break controller to catch invalid memory accesses. */
167 int system_memory_guard(int newmode
);
170 MEMGUARD_KEEP
= -1, /* don't change the mode; for reading */
171 MEMGUARD_NONE
= 0, /* catch nothing */
172 MEMGUARD_FLASH_WRITES
, /* catch writes to area 02 (flash ROM) */
173 MEMGUARD_ZERO_AREA
, /* catch all accesses to areas 00 and 01 */
177 #if !defined(SIMULATOR) && !defined(__PCTOOL__)
178 #include "system-target.h"
179 #elif defined(HAVE_SDL) /* SDL build */
180 #include "system-sdl.h"
181 #define NEED_GENERIC_BYTESWAPS
184 #ifdef NEED_GENERIC_BYTESWAPS
185 static inline uint16_t swap16_hw(uint16_t value
)
187 result[15..8] = value[ 7..0];
188 result[ 7..0] = value[15..8];
191 return (value
>> 8) | (value
<< 8);
194 static inline uint32_t swap32_hw(uint32_t value
)
196 result[31..24] = value[ 7.. 0];
197 result[23..16] = value[15.. 8];
198 result[15.. 8] = value[23..16];
199 result[ 7.. 0] = value[31..24];
202 uint32_t hi
= swap16_hw(value
>> 16);
203 uint32_t lo
= swap16_hw(value
& 0xffff);
204 return (lo
<< 16) | hi
;
207 static inline uint32_t swap_odd_even32_hw(uint32_t value
)
210 result[31..24],[15.. 8] = value[23..16],[ 7.. 0]
211 result[23..16],[ 7.. 0] = value[31..24],[15.. 8]
213 uint32_t t
= value
& 0xff00ff00;
214 return (t
>> 8) | ((t
^ value
) << 8);
217 static inline uint32_t swaw32_hw(uint32_t value
)
220 result[31..16] = value[15.. 0];
221 result[15.. 0] = value[31..16];
223 return (value
>> 16) | (value
<< 16);
226 #endif /* NEED_GENERIC_BYTESWAPS */
228 /* static endianness conversion */
229 #define SWAP16_CONST(x) \
230 ((typeof(x))( ((uint16_t)(x) >> 8) | ((uint16_t)(x) << 8) ))
232 #define SWAP32_CONST(x) \
233 ((typeof(x))( ((uint32_t)(x) >> 24) | \
234 (((uint32_t)(x) & 0xff0000) >> 8) | \
235 (((uint32_t)(x) & 0xff00) << 8) | \
236 ((uint32_t)(x) << 24) ))
238 #define SWAP_ODD_EVEN32_CONST(x) \
239 ((typeof(x))( ((uint32_t)SWAP16_CONST((uint32_t)(x) >> 16) << 16) | \
240 SWAP16_CONST((uint32_t)(x))) )
242 #define SWAW32_CONST(x) \
243 ((typeof(x))( ((uint32_t)(x) << 16) | ((uint32_t)(x) >> 16) ))
245 /* Select best method based upon whether x is a constant expression */
247 ( __builtin_constant_p(x) ? SWAP16_CONST(x) : (typeof(x))swap16_hw(x) )
250 ( __builtin_constant_p(x) ? SWAP32_CONST(x) : (typeof(x))swap32_hw(x) )
252 #define swap_odd_even32(x) \
253 ( __builtin_constant_p(x) ? SWAP_ODD_EVEN32_CONST(x) : (typeof(x))swap_odd_even32_hw(x) )
256 ( __builtin_constant_p(x) ? SWAW32_CONST(x) : (typeof(x))swaw32_hw(x) )
259 #ifdef ROCKBOX_LITTLE_ENDIAN
260 #define letoh16(x) (x)
261 #define letoh32(x) (x)
262 #define htole16(x) (x)
263 #define htole32(x) (x)
264 #define betoh16(x) swap16(x)
265 #define betoh32(x) swap32(x)
266 #define htobe16(x) swap16(x)
267 #define htobe32(x) swap32(x)
268 #define swap_odd_even_be32(x) (x)
269 #define swap_odd_even_le32(x) swap_odd_even32(x)
271 #define letoh16(x) swap16(x)
272 #define letoh32(x) swap32(x)
273 #define htole16(x) swap16(x)
274 #define htole32(x) swap32(x)
275 #define betoh16(x) (x)
276 #define betoh32(x) (x)
277 #define htobe16(x) (x)
278 #define htobe32(x) (x)
279 #define swap_odd_even_be32(x) swap_odd_even32(x)
280 #define swap_odd_even_le32(x) (x)
284 #define BIT_N(n) (1U << (n))
287 /* Declare this as HIGHEST_IRQ_LEVEL if they don't differ */
288 #ifndef DISABLE_INTERRUPTS
289 #define DISABLE_INTERRUPTS HIGHEST_IRQ_LEVEL
292 /* Just define these as empty if not declared */
293 #ifdef HAVE_CPUCACHE_INVALIDATE
294 void cpucache_commit_discard(void);
295 /* deprecated alias */
296 void cpucache_invalidate(void);
298 static inline void cpucache_commit_discard(void)
301 /* deprecated alias */
302 static inline void cpucache_invalidate(void)
307 #ifdef HAVE_CPUCACHE_FLUSH
308 void cpucache_commit(void);
309 /* deprecated alias */
310 void cpucache_flush(void);
312 static inline void cpucache_commit(void)
315 /* deprecated alias */
316 static inline void cpucache_flush(void)
321 /* Define this, if the CPU may take advantage of cache aligment. Is enabled
322 * for all ARM CPUs. */
324 #define HAVE_CPU_CACHE_ALIGN
327 /* Calculate CACHEALIGN_SIZE from CACHEALIGN_BITS */
328 #ifdef CACHEALIGN_SIZE
329 /* undefine, if defined. always calculate from CACHEALIGN_BITS */
330 #undef CACHEALIGN_SIZE
332 #ifdef CACHEALIGN_BITS
333 /* CACHEALIGN_SIZE = 2 ^ CACHEALIGN_BITS */
334 #define CACHEALIGN_SIZE (1u << CACHEALIGN_BITS)
336 /* FIXME: set to maximum known cache alignment of supported CPUs */
337 #define CACHEALIGN_BITS 5
338 #define CACHEALIGN_SIZE 32
341 #ifdef HAVE_CPU_CACHE_ALIGN
342 /* Cache alignment attributes and sizes are enabled */
343 #define CACHEALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
344 /* Aligns x up to a CACHEALIGN_SIZE boundary */
345 #define CACHEALIGN_UP(x) \
346 ((typeof (x))ALIGN_UP_P2((uintptr_t)(x), CACHEALIGN_BITS))
347 /* Aligns x down to a CACHEALIGN_SIZE boundary */
348 #define CACHEALIGN_DOWN(x) \
349 ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
350 /* Aligns at least to the greater of size x or CACHEALIGN_SIZE */
351 #define CACHEALIGN_AT_LEAST_ATTR(x) \
352 __attribute__((aligned(CACHEALIGN_UP(x))))
353 /* Aligns a buffer pointer and size to proper boundaries */
354 #define CACHEALIGN_BUFFER(start, size) \
355 ALIGN_BUFFER((start), (size), CACHEALIGN_SIZE)
357 /* Cache alignment attributes and sizes are not enabled */
358 #define CACHEALIGN_ATTR
359 #define CACHEALIGN_AT_LEAST_ATTR(x) __attribute__((aligned(x)))
360 #define CACHEALIGN_UP(x) (x)
361 #define CACHEALIGN_DOWN(x) (x)
362 /* Make no adjustments */
363 #define CACHEALIGN_BUFFER(start, size)
366 /* Define MEM_ALIGN_ATTR which may be used to align e.g. buffers for faster
369 /* Use ARMs cache alignment. */
370 #define MEM_ALIGN_ATTR CACHEALIGN_ATTR
371 #elif defined(CPU_COLDFIRE)
372 /* Use fixed alignment of 16 bytes. Speed up only for 'movem' in DRAM. */
373 #define MEM_ALIGN_ATTR __attribute__((aligned(16)))
376 #define MEM_ALIGN_ATTR
379 #ifdef STORAGE_WANTS_ALIGN
380 #define STORAGE_ALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
381 #define STORAGE_ALIGN_DOWN(x) \
382 ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
383 /* Pad a size so the buffer can be aligned later */
384 #define STORAGE_PAD(x) ((x) + CACHEALIGN_SIZE - 1)
385 /* Number of bytes in the last cacheline assuming buffer of size x is aligned */
386 #define STORAGE_OVERLAP(x) ((x) & (CACHEALIGN_SIZE - 1))
388 #define STORAGE_ALIGN_ATTR
389 #define STORAGE_ALIGN_DOWN(x) (x)
390 #define STORAGE_PAD(x) (x)
391 #define STORAGE_OVERLAP(x) 0
394 /* Double-cast to avoid 'dereferencing type-punned pointer will
395 * break strict aliasing rules' B.S. */
396 #define PUN_PTR(type, p) ((type)(intptr_t)(p))
398 #endif /* __SYSTEM_H__ */