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 /* live endianness conversion */
 141 #ifdef ROCKBOX_LITTLE_ENDIAN
 142 #define letoh16(x) (x)
 143 #define letoh32(x) (x)
 144 #define htole16(x) (x)
 145 #define htole32(x) (x)
 146 #define betoh16(x) swap16(x)
 147 #define betoh32(x) swap32(x)
 148 #define htobe16(x) swap16(x)
 149 #define htobe32(x) swap32(x)
 150 #define swap_odd_even_be32(x) (x)
 151 #define swap_odd_even_le32(x) swap_odd_even32(x)
 152 #else
 153 #define letoh16(x) swap16(x)
 154 #define letoh32(x) swap32(x)
 155 #define htole16(x) swap16(x)
 156 #define htole32(x) swap32(x)
 157 #define betoh16(x) (x)
 158 #define betoh32(x) (x)
 159 #define htobe16(x) (x)
 160 #define htobe32(x) (x)
 161 #define swap_odd_even_be32(x) swap_odd_even32(x)
 162 #define swap_odd_even_le32(x) (x)
 163 #endif
 164
 165
 166 /* static endianness conversion */
 167 #define SWAP_16(x) ((typeof(x))(unsigned short)(((unsigned short)(x) >> 8) | \
 168                                                 ((unsigned short)(x) << 8)))
 169
 170 #define SWAP_32(x) ((typeof(x))(unsigned long)( ((unsigned long)(x) >> 24) | \
 171                                                (((unsigned long)(x) & 0xff0000ul) >> 8) | \
 172                                                (((unsigned long)(x) & 0xff00ul) << 8) | \
 173                                                 ((unsigned long)(x) << 24)))
 174
 175 #ifdef ROCKBOX_LITTLE_ENDIAN
 176 #define LE_TO_H16(x) (x)
 177 #define LE_TO_H32(x) (x)
 178 #define H_TO_LE16(x) (x)
 179 #define H_TO_LE32(x) (x)
 180 #define BE_TO_H16(x) SWAP_16(x)
 181 #define BE_TO_H32(x) SWAP_32(x)
 182 #define H_TO_BE16(x) SWAP_16(x)
 183 #define H_TO_BE32(x) SWAP_32(x)
 184 #else
 185 #define LE_TO_H16(x) SWAP_16(x)
 186 #define LE_TO_H32(x) SWAP_32(x)
 187 #define H_TO_LE16(x) SWAP_16(x)
 188 #define H_TO_LE32(x) SWAP_32(x)
 189 #define BE_TO_H16(x) (x)
 190 #define BE_TO_H32(x) (x)
 191 #define H_TO_BE16(x) (x)
 192 #define H_TO_BE32(x) (x)
 193 #endif
 194
 195 /* Get the byte offset of a type's member */
 196 #define OFFSETOF(type, membername) ((off_t)&((type *)0)->membername)
 197
 198 /* Get the type pointer from one of its members */
 199 #define TYPE_FROM_MEMBER(type, memberptr, membername) \
 200     ((type *)((intptr_t)(memberptr) - OFFSETOF(type, membername)))
 201
 202 /* returns index of first set bit or 32 if no bits are set */
 203 int find_first_set_bit(uint32_t val);
 204
 205 static inline __attribute__((always_inline))
 206 uint32_t isolate_first_bit(uint32_t val)
 207     { return val & -val; }
 208
 209 /* Functions to set and clear register or variable bits atomically */
 210 void bitmod32(volatile uint32_t *addr, uint32_t bits, uint32_t mask);
 211 void bitset32(volatile uint32_t *addr, uint32_t mask);
 212 void bitclr32(volatile uint32_t *addr, uint32_t mask);
 213
 214 /* gcc 3.4 changed the format of the constraints */
 215 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ > 3) || (__GNUC__ >= 4)
 216 #define I_CONSTRAINT "I08"
 217 #else
 218 #define I_CONSTRAINT "I"
 219 #endif
 220
 221 /* Utilize the user break controller to catch invalid memory accesses. */
 222 int system_memory_guard(int newmode);
 223
 224 enum {
 225     MEMGUARD_KEEP = -1,    /* don't change the mode; for reading */
 226     MEMGUARD_NONE = 0,     /* catch nothing */
 227     MEMGUARD_FLASH_WRITES, /* catch writes to area 02 (flash ROM) */
 228     MEMGUARD_ZERO_AREA,    /* catch all accesses to areas 00 and 01 */
 229     MAXMEMGUARD
 230 };
 231
 232 #if !defined(SIMULATOR) && !defined(__PCTOOL__)
 233 #include "system-target.h"
 234 #elif defined(HAVE_SDL) /* SDL build */
 235 #include "system-sdl.h"
 236 #define NEED_GENERIC_BYTESWAPS
 237 #endif
 238
 239 #ifdef NEED_GENERIC_BYTESWAPS
 240 static inline uint16_t swap16(uint16_t value)
 241     /*
 242       result[15..8] = value[ 7..0];
 243       result[ 7..0] = value[15..8];
 244     */
 245 {
 246     return (value >> 8) | (value << 8);
 247 }
 248
 249 static inline uint32_t swap32(uint32_t value)
 250     /*
 251       result[31..24] = value[ 7.. 0];
 252       result[23..16] = value[15.. 8];
 253       result[15.. 8] = value[23..16];
 254       result[ 7.. 0] = value[31..24];
 255     */
 256 {
 257     uint32_t hi = swap16(value >> 16);
 258     uint32_t lo = swap16(value & 0xffff);
 259     return (lo << 16) | hi;
 260 }
 261
 262 static inline uint32_t swap_odd_even32(uint32_t value)
 263 {
 264     /*
 265       result[31..24],[15.. 8] = value[23..16],[ 7.. 0]
 266       result[23..16],[ 7.. 0] = value[31..24],[15.. 8]
 267     */
 268     uint32_t t = value & 0xff00ff00;
 269     return (t >> 8) | ((t ^ value) << 8);
 270 }
 271
 272 #endif /* NEED_GENERIC_BYTESWAPS */
 273
 274 #ifndef BIT_N
 275 #define BIT_N(n) (1U << (n))
 276 #endif
 277
 278 /* Declare this as HIGHEST_IRQ_LEVEL if they don't differ */
 279 #ifndef DISABLE_INTERRUPTS
 280 #define DISABLE_INTERRUPTS  HIGHEST_IRQ_LEVEL
 281 #endif
 282
 283 /* Just define these as empty if not declared */
 284 #ifdef HAVE_CPUCACHE_INVALIDATE
 285 void cpucache_commit_discard(void);
 286 /* deprecated alias */
 287 void cpucache_invalidate(void);
 288 #else
 289 static inline void cpucache_commit_discard(void)
 290 {
 291 }
 292 /* deprecated alias */
 293 static inline void cpucache_invalidate(void)
 294 {
 295 }
 296 #endif
 297
 298 #ifdef HAVE_CPUCACHE_FLUSH
 299 void cpucache_commit(void);
 300 /* deprecated alias */
 301 void cpucache_flush(void);
 302 #else
 303 static inline void cpucache_commit(void)
 304 {
 305 }
 306 /* deprecated alias */
 307 static inline void cpucache_flush(void)
 308 {
 309 }
 310 #endif
 311
 312 #ifndef CACHEALIGN_SIZE /* could be elsewhere for a particular reason */
 313 #ifdef CACHEALIGN_BITS
 314 /* 2^CACHEALIGN_BITS = the byte size */
 315 #define CACHEALIGN_SIZE (1u << CACHEALIGN_BITS)
 316 #else
 317 #define CACHEALIGN_SIZE 16  /* FIXME */
 318 #endif
 319 #endif /* CACHEALIGN_SIZE */
 320
 321 #ifdef PROC_NEEDS_CACHEALIGN
 322 /* Cache alignment attributes and sizes are enabled */
 323
 324 #define CACHEALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
 325 /* Aligns x up to a CACHEALIGN_SIZE boundary */
 326 #define CACHEALIGN_UP(x) \
 327     ((typeof (x))ALIGN_UP_P2((uintptr_t)(x), CACHEALIGN_BITS))
 328 /* Aligns x down to a CACHEALIGN_SIZE boundary */
 329 #define CACHEALIGN_DOWN(x) \
 330     ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
 331 /* Aligns at least to the greater of size x or CACHEALIGN_SIZE */
 332 #define CACHEALIGN_AT_LEAST_ATTR(x) \
 333     __attribute__((aligned(CACHEALIGN_UP(x))))
 334 /* Aligns a buffer pointer and size to proper boundaries */
 335 #define CACHEALIGN_BUFFER(start, size) \
 336     ALIGN_BUFFER((start), (size), CACHEALIGN_SIZE)
 337
 338 #else /* ndef PROC_NEEDS_CACHEALIGN */
 339
 340 /* Cache alignment attributes and sizes are not enabled */
 341 #define CACHEALIGN_ATTR
 342 #define CACHEALIGN_AT_LEAST_ATTR(x) \
 343     __attribute__((aligned(x)))
 344 #define CACHEALIGN_UP(x) (x)
 345 #define CACHEALIGN_DOWN(x) (x)
 346 /* Make no adjustments */
 347 #define CACHEALIGN_BUFFER(start, size)
 348
 349 #endif /* PROC_NEEDS_CACHEALIGN */
 350
 351 #ifdef STORAGE_WANTS_ALIGN
 352 #define STORAGE_ALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
 353 #define STORAGE_ALIGN_DOWN(x) \
 354     ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
 355 /* Pad a size so the buffer can be aligned later */
 356 #define STORAGE_PAD(x) ((x) + CACHEALIGN_SIZE - 1)
 357 /* Number of bytes in the last cacheline assuming buffer of size x is aligned */
 358 #define STORAGE_OVERLAP(x) ((x) & (CACHEALIGN_SIZE - 1))
 359 #else
 360 #define STORAGE_ALIGN_ATTR
 361 #define STORAGE_ALIGN_DOWN(x) (x)
 362 #define STORAGE_PAD(x) (x)
 363 #define STORAGE_OVERLAP(x) 0
 364 #endif
 365
 366 /* Double-cast to avoid 'dereferencing type-punned pointer will
 367  * break strict aliasing rules' B.S. */
 368 #define PUN_PTR(type, p) ((type)(intptr_t)(p))
 369
 370 #endif /* __SYSTEM_H__ */