firmware/export/system.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Alan Korr
  11  *
  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.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef __SYSTEM_H__
  23 #define __SYSTEM_H__
  24
  25 #include "cpu.h"
  26 #include "stdbool.h"
  27 #include "kernel.h"
  28 #include "gcc_extensions.h" /* for LIKELY/UNLIKELY */
  29
  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);
  35
  36 extern long cpu_frequency;
  37
  38 struct flash_header {
  39     unsigned long magic;
  40     unsigned long length;
  41     char version[32];
  42 };
  43
  44 bool detect_flashed_romimage(void);
  45 bool detect_flashed_ramimage(void);
  46 bool detect_original_firmware(void);
  47
  48 #if defined(HAVE_ADJUSTABLE_CPU_FREQ) \
  49         && defined(ROCKBOX_HAS_LOGF) && (NUM_CORES == 1)
  50 #define CPU_BOOST_LOGGING
  51 #endif
  52
  53 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
  54 #if NUM_CORES > 1
  55 extern struct spinlock boostctrl_spin;
  56 #endif
  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);
  65 #else
  66 void cpu_boost(bool on_off);
  67 #endif
  68 void cpu_idle_mode(bool on_off);
  69 int get_cpu_boost_counter(void);
  70 #else /* ndef HAVE_ADJUSTABLE_CPU_FREQ */
  71 #ifndef FREQ
  72 #define FREQ CPU_FREQ
  73 #endif
  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 */
  81
  82 #ifdef CPU_BOOST_LOGGING
  83 #define cpu_boost(on_off) cpu_boost_(on_off,__FILE__,  __LINE__)
  84 #endif
  85
  86 #define BAUDRATE 9600
  87
  88 #ifndef NULL
  89 #define NULL ((void*)0)
  90 #endif
  91
  92 #ifndef MIN
  93 #define MIN(a, b) (((a)<(b))?(a):(b))
  94 #endif
  95
  96 #ifndef MAX
  97 #define MAX(a, b) (((a)>(b))?(a):(b))
  98 #endif
  99
 100 /* return number of elements in array a */
 101 #define ARRAYLEN(a) (sizeof(a)/sizeof((a)[0]))
 102
 103 /* return p incremented by specified number of bytes */
 104 #define SKIPBYTES(p, count) ((typeof (p))((char *)(p) + (count)))
 105
 106 #define P2_M1(p2)  ((1 << (p2))-1)
 107
 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)
 111
 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)
 115
 116 /* align start and end of buffer to nearest integer multiple of a */
 117 #define ALIGN_BUFFER(ptr,len,align) \
 118 {\
 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; \
 125 }
 126
 127
 128 /* newer? SDL includes endian.h, So we ignore it */
 129 #if (CONFIG_PLATFORM & PLATFORM_HOSTED) || defined(__PCTOOL__)
 130 #undef letoh16
 131 #undef letoh32
 132 #undef htole16
 133 #undef htole32
 134 #undef betoh16
 135 #undef betoh32
 136 #undef htobe16
 137 #undef htobe32
 138 #endif
 139
 140 /* Get the byte offset of a type's member */
 141 #define OFFSETOF(type, membername) ((off_t)&((type *)0)->membername)
 142
 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)))
 146
 147 /* returns index of first set bit or 32 if no bits are set */
 148 int find_first_set_bit(uint32_t val);
 149
 150 static inline __attribute__((always_inline))
 151 uint32_t isolate_first_bit(uint32_t val)
 152     { return val & -val; }
 153
 154 /* Functions to set and clear register or variable bits atomically */
 155 void bitmod16(volatile uint16_t *addr, uint16_t bits, uint16_t mask);
 156 void bitset16(volatile uint16_t *addr, uint16_t mask);
 157 void bitclr16(volatile uint16_t *addr, uint16_t mask);
 158
 159 void bitmod32(volatile uint32_t *addr, uint32_t bits, uint32_t mask);
 160 void bitset32(volatile uint32_t *addr, uint32_t mask);
 161 void bitclr32(volatile uint32_t *addr, uint32_t mask);
 162
 163 /* gcc 3.4 changed the format of the constraints */
 164 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ > 3) || (__GNUC__ >= 4)
 165 #define I_CONSTRAINT "I08"
 166 #else
 167 #define I_CONSTRAINT "I"
 168 #endif
 169
 170 /* Utilize the user break controller to catch invalid memory accesses. */
 171 int system_memory_guard(int newmode);
 172
 173 enum {
 174     MEMGUARD_KEEP = -1,    /* don't change the mode; for reading */
 175     MEMGUARD_NONE = 0,     /* catch nothing */
 176     MEMGUARD_FLASH_WRITES, /* catch writes to area 02 (flash ROM) */
 177     MEMGUARD_ZERO_AREA,    /* catch all accesses to areas 00 and 01 */
 178     MAXMEMGUARD
 179 };
 180
 181 #if !defined(SIMULATOR) && !defined(__PCTOOL__)
 182 #include "system-target.h"
 183 #elif defined(HAVE_SDL) /* SDL build */
 184 #include "system-sdl.h"
 185 #define NEED_GENERIC_BYTESWAPS
 186 #endif
 187
 188 #ifdef NEED_GENERIC_BYTESWAPS
 189 static inline uint16_t swap16_hw(uint16_t value)
 190     /*
 191       result[15..8] = value[ 7..0];
 192       result[ 7..0] = value[15..8];
 193     */
 194 {
 195     return (value >> 8) | (value << 8);
 196 }
 197
 198 static inline uint32_t swap32_hw(uint32_t value)
 199     /*
 200       result[31..24] = value[ 7.. 0];
 201       result[23..16] = value[15.. 8];
 202       result[15.. 8] = value[23..16];
 203       result[ 7.. 0] = value[31..24];
 204     */
 205 {
 206     uint32_t hi = swap16_hw(value >> 16);
 207     uint32_t lo = swap16_hw(value & 0xffff);
 208     return (lo << 16) | hi;
 209 }
 210
 211 static inline uint32_t swap_odd_even32_hw(uint32_t value)
 212 {
 213     /*
 214       result[31..24],[15.. 8] = value[23..16],[ 7.. 0]
 215       result[23..16],[ 7.. 0] = value[31..24],[15.. 8]
 216     */
 217     uint32_t t = value & 0xff00ff00;
 218     return (t >> 8) | ((t ^ value) << 8);
 219 }
 220
 221 static inline uint32_t swaw32_hw(uint32_t value)
 222 {
 223     /*
 224       result[31..16] = value[15.. 0];
 225       result[15.. 0] = value[31..16];
 226     */
 227     return (value >> 16) | (value << 16);
 228 }
 229
 230 #endif /* NEED_GENERIC_BYTESWAPS */
 231
 232 /* static endianness conversion */
 233 #define SWAP16_CONST(x) \
 234     ((typeof(x))( ((uint16_t)(x) >> 8) | ((uint16_t)(x) << 8) ))
 235
 236 #define SWAP32_CONST(x) \
 237     ((typeof(x))( ((uint32_t)(x) >> 24) | \
 238                  (((uint32_t)(x) & 0xff0000) >> 8) | \
 239                  (((uint32_t)(x) & 0xff00) << 8) | \
 240                   ((uint32_t)(x) << 24) ))
 241
 242 #define SWAP_ODD_EVEN32_CONST(x) \
 243     ((typeof(x))( ((uint32_t)SWAP16_CONST((uint32_t)(x) >> 16) << 16) | \
 244                              SWAP16_CONST((uint32_t)(x))) )
 245
 246 #define SWAW32_CONST(x) \
 247     ((typeof(x))( ((uint32_t)(x) << 16) | ((uint32_t)(x) >> 16) ))
 248
 249 /* Select best method based upon whether x is a constant expression */
 250 #define swap16(x) \
 251     ( __builtin_constant_p(x) ? SWAP16_CONST(x) : (typeof(x))swap16_hw(x) )
 252
 253 #define swap32(x) \
 254     ( __builtin_constant_p(x) ? SWAP32_CONST(x) : (typeof(x))swap32_hw(x) )
 255
 256 #define swap_odd_even32(x) \
 257     ( __builtin_constant_p(x) ? SWAP_ODD_EVEN32_CONST(x) : (typeof(x))swap_odd_even32_hw(x) )
 258
 259 #define swaw32(x) \
 260     ( __builtin_constant_p(x) ? SWAW32_CONST(x) : (typeof(x))swaw32_hw(x) )
 261
 262
 263 #ifdef ROCKBOX_LITTLE_ENDIAN
 264 #define letoh16(x) (x)
 265 #define letoh32(x) (x)
 266 #define htole16(x) (x)
 267 #define htole32(x) (x)
 268 #define betoh16(x) swap16(x)
 269 #define betoh32(x) swap32(x)
 270 #define htobe16(x) swap16(x)
 271 #define htobe32(x) swap32(x)
 272 #define swap_odd_even_be32(x) (x)
 273 #define swap_odd_even_le32(x) swap_odd_even32(x)
 274 #else
 275 #define letoh16(x) swap16(x)
 276 #define letoh32(x) swap32(x)
 277 #define htole16(x) swap16(x)
 278 #define htole32(x) swap32(x)
 279 #define betoh16(x) (x)
 280 #define betoh32(x) (x)
 281 #define htobe16(x) (x)
 282 #define htobe32(x) (x)
 283 #define swap_odd_even_be32(x) swap_odd_even32(x)
 284 #define swap_odd_even_le32(x) (x)
 285 #endif
 286
 287 #ifndef BIT_N
 288 #define BIT_N(n) (1U << (n))
 289 #endif
 290
 291 /* Declare this as HIGHEST_IRQ_LEVEL if they don't differ */
 292 #ifndef DISABLE_INTERRUPTS
 293 #define DISABLE_INTERRUPTS  HIGHEST_IRQ_LEVEL
 294 #endif
 295
 296 /* Just define these as empty if not declared */
 297 #ifdef HAVE_CPUCACHE_INVALIDATE
 298 void cpucache_commit_discard(void);
 299 /* deprecated alias */
 300 void cpucache_invalidate(void);
 301 #else
 302 static inline void cpucache_commit_discard(void)
 303 {
 304 }
 305 /* deprecated alias */
 306 static inline void cpucache_invalidate(void)
 307 {
 308 }
 309 #endif
 310
 311 #ifdef HAVE_CPUCACHE_FLUSH
 312 void cpucache_commit(void);
 313 /* deprecated alias */
 314 void cpucache_flush(void);
 315 #else
 316 static inline void cpucache_commit(void)
 317 {
 318 }
 319 /* deprecated alias */
 320 static inline void cpucache_flush(void)
 321 {
 322 }
 323 #endif
 324
 325 /* Define this, if the CPU may take advantage of cache aligment. Is enabled
 326  * for all ARM CPUs. */
 327 #ifdef CPU_ARM
 328     #define HAVE_CPU_CACHE_ALIGN
 329 #endif
 330
 331 /* Calculate CACHEALIGN_SIZE from CACHEALIGN_BITS */
 332 #ifdef CACHEALIGN_SIZE
 333     /* undefine, if defined. always calculate from CACHEALIGN_BITS */
 334     #undef CACHEALIGN_SIZE
 335 #endif
 336 #ifdef CACHEALIGN_BITS
 337     /* CACHEALIGN_SIZE = 2 ^ CACHEALIGN_BITS */
 338     #define CACHEALIGN_SIZE (1u << CACHEALIGN_BITS)
 339 #else
 340     /* FIXME: set to maximum known cache alignment of supported CPUs */
 341     #define CACHEALIGN_BITS  5
 342     #define CACHEALIGN_SIZE 32
 343 #endif
 344
 345 #ifdef HAVE_CPU_CACHE_ALIGN
 346     /* Cache alignment attributes and sizes are enabled */
 347     #define CACHEALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
 348     /* Aligns x up to a CACHEALIGN_SIZE boundary */
 349     #define CACHEALIGN_UP(x) \
 350         ((typeof (x))ALIGN_UP_P2((uintptr_t)(x), CACHEALIGN_BITS))
 351     /* Aligns x down to a CACHEALIGN_SIZE boundary */
 352     #define CACHEALIGN_DOWN(x) \
 353         ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
 354     /* Aligns at least to the greater of size x or CACHEALIGN_SIZE */
 355     #define CACHEALIGN_AT_LEAST_ATTR(x) \
 356         __attribute__((aligned(CACHEALIGN_UP(x))))
 357     /* Aligns a buffer pointer and size to proper boundaries */
 358     #define CACHEALIGN_BUFFER(start, size) \
 359         ALIGN_BUFFER((start), (size), CACHEALIGN_SIZE)
 360 #else
 361     /* Cache alignment attributes and sizes are not enabled */
 362     #define CACHEALIGN_ATTR
 363     #define CACHEALIGN_AT_LEAST_ATTR(x) __attribute__((aligned(x)))
 364     #define CACHEALIGN_UP(x) (x)
 365     #define CACHEALIGN_DOWN(x) (x)
 366     /* Make no adjustments */
 367     #define CACHEALIGN_BUFFER(start, size)
 368 #endif
 369
 370 /* Define MEM_ALIGN_ATTR which may be used to align e.g. buffers for faster
 371  * access. */
 372 #if   defined(CPU_ARM)
 373     /* Use ARMs cache alignment. */
 374     #define MEM_ALIGN_ATTR CACHEALIGN_ATTR
 375 #elif defined(CPU_COLDFIRE)
 376     /* Use fixed alignment of 16 bytes. Speed up only for 'movem' in DRAM. */
 377     #define MEM_ALIGN_ATTR __attribute__((aligned(16)))
 378 #else
 379     /* Do nothing. */
 380     #define MEM_ALIGN_ATTR
 381 #endif
 382
 383 #ifdef STORAGE_WANTS_ALIGN
 384     #define STORAGE_ALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
 385     #define STORAGE_ALIGN_DOWN(x) \
 386         ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
 387     /* Pad a size so the buffer can be aligned later */
 388     #define STORAGE_PAD(x) ((x) + CACHEALIGN_SIZE - 1)
 389     /* Number of bytes in the last cacheline assuming buffer of size x is aligned */
 390     #define STORAGE_OVERLAP(x) ((x) & (CACHEALIGN_SIZE - 1))
 391     #define STORAGE_ALIGN_BUFFER(start, size) \
 392         ALIGN_BUFFER((start), (size), CACHEALIGN_SIZE)
 393 #else
 394     #define STORAGE_ALIGN_ATTR
 395     #define STORAGE_ALIGN_DOWN(x) (x)
 396     #define STORAGE_PAD(x) (x)
 397     #define STORAGE_OVERLAP(x) 0
 398     #define STORAGE_ALIGN_BUFFER(start, size)
 399 #endif
 400
 401 /* Double-cast to avoid 'dereferencing type-punned pointer will
 402  * break strict aliasing rules' B.S. */
 403 #define PUN_PTR(type, p) ((type)(intptr_t)(p))
 404
 405 #endif /* __SYSTEM_H__ */