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
  29 extern void system_reboot (void);
  30 /* Called from any UIE handler and panicf - wait for a key and return
  31  * to reboot system. */
  32 extern void system_exception_wait(void);
  33 extern void system_init(void);
  34
  35 extern long cpu_frequency;
  36
  37 struct flash_header {
  38     unsigned long magic;
  39     unsigned long length;
  40     char version[32];
  41 };
  42
  43 bool detect_flashed_romimage(void);
  44 bool detect_flashed_ramimage(void);
  45 bool detect_original_firmware(void);
  46
  47 #if defined(HAVE_ADJUSTABLE_CPU_FREQ) \
  48         && defined(ROCKBOX_HAS_LOGF) && (NUM_CORES == 1)
  49 #define CPU_BOOST_LOGGING
  50 #endif
  51
  52 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
  53 #if NUM_CORES > 1
  54 extern struct spinlock boostctrl_spin;
  55 #endif
  56 void cpu_boost_init(void);
  57 #define FREQ cpu_frequency
  58 void set_cpu_frequency(long frequency);
  59 #ifdef CPU_BOOST_LOGGING
  60 char * cpu_boost_log_getlog_first(void);
  61 char * cpu_boost_log_getlog_next(void);
  62 int cpu_boost_log_getcount(void);
  63 void cpu_boost_(bool on_off, char* location, int line);
  64 #else
  65 void cpu_boost(bool on_off);
  66 #endif
  67 void cpu_idle_mode(bool on_off);
  68 int get_cpu_boost_counter(void);
  69 #else
  70 #define FREQ CPU_FREQ
  71 #define set_cpu_frequency(frequency)
  72 #define cpu_boost(on_off)
  73 #define cpu_boost_id(on_off, id)
  74 #define cpu_idle_mode(on_off)
  75 #define get_cpu_boost_counter()
  76 #define get_cpu_boost_tracker()
  77 #endif
  78
  79 #ifdef CPU_BOOST_LOGGING
  80 #define cpu_boost(on_off) cpu_boost_(on_off,__FILE__,  __LINE__)
  81 #endif
  82
  83 #define BAUDRATE 9600
  84
  85 #ifndef NULL
  86 #define NULL ((void*)0)
  87 #endif
  88
  89 #ifndef MIN
  90 #define MIN(a, b) (((a)<(b))?(a):(b))
  91 #endif
  92
  93 #ifndef MAX
  94 #define MAX(a, b) (((a)>(b))?(a):(b))
  95 #endif
  96
  97 /* return number of elements in array a */
  98 #define ARRAYLEN(a) (sizeof(a)/sizeof((a)[0]))
  99
 100 /* return p incremented by specified number of bytes */
 101 #define SKIPBYTES(p, count) ((typeof (p))((char *)(p) + (count)))
 102
 103 #define P2_M1(p2)  ((1 << (p2))-1)
 104
 105 /* align up or down to nearest 2^p2 */
 106 #define ALIGN_DOWN_P2(n, p2) ((n) & ~P2_M1(p2))
 107 #define ALIGN_UP_P2(n, p2)   ALIGN_DOWN_P2((n) + P2_M1(p2),p2)
 108
 109 /* align up or down to nearest integer multiple of a */
 110 #define ALIGN_DOWN(n, a)     ((n)/(a)*(a))
 111 #define ALIGN_UP(n, a)       ALIGN_DOWN((n)+((a)-1),a)
 112
 113 /* align start and end of buffer to nearest integer multiple of a */
 114 #define ALIGN_BUFFER(ptr,len,align) \
 115 {\
 116     uintptr_t tmp_ptr1 = (uintptr_t)ptr; \
 117     uintptr_t tmp_ptr2 = tmp_ptr1 + len;\
 118     tmp_ptr1 = ALIGN_UP(tmp_ptr1,align); \
 119     tmp_ptr2 = ALIGN_DOWN(tmp_ptr2,align); \
 120     len = tmp_ptr2 - tmp_ptr1; \
 121     ptr = (typeof(ptr))tmp_ptr1; \
 122 }
 123
 124 /* newer? SDL includes endian.h, So we ignore it */
 125 #ifdef SIMULATOR
 126 #undef letoh16
 127 #undef letoh32
 128 #undef htole16
 129 #undef htole32
 130 #undef betoh16
 131 #undef betoh32
 132 #undef htobe16
 133 #undef htobe32
 134 #endif
 135
 136 /* live endianness conversion */
 137 #ifdef ROCKBOX_LITTLE_ENDIAN
 138 #define letoh16(x) (x)
 139 #define letoh32(x) (x)
 140 #define htole16(x) (x)
 141 #define htole32(x) (x)
 142 #define betoh16(x) swap16(x)
 143 #define betoh32(x) swap32(x)
 144 #define htobe16(x) swap16(x)
 145 #define htobe32(x) swap32(x)
 146 #define swap_odd_even_be32(x) (x)
 147 #define swap_odd_even_le32(x) swap_odd_even32(x)
 148 #else
 149 #define letoh16(x) swap16(x)
 150 #define letoh32(x) swap32(x)
 151 #define htole16(x) swap16(x)
 152 #define htole32(x) swap32(x)
 153 #define betoh16(x) (x)
 154 #define betoh32(x) (x)
 155 #define htobe16(x) (x)
 156 #define htobe32(x) (x)
 157 #define swap_odd_even_be32(x) swap_odd_even32(x)
 158 #define swap_odd_even_le32(x) (x)
 159 #endif
 160
 161 /* static endianness conversion */
 162 #define SWAP_16(x) ((typeof(x))(unsigned short)(((unsigned short)(x) >> 8) | \
 163                                                 ((unsigned short)(x) << 8)))
 164
 165 #define SWAP_32(x) ((typeof(x))(unsigned long)( ((unsigned long)(x) >> 24) | \
 166                                                (((unsigned long)(x) & 0xff0000ul) >> 8) | \
 167                                                (((unsigned long)(x) & 0xff00ul) << 8) | \
 168                                                 ((unsigned long)(x) << 24)))
 169
 170 #ifdef ROCKBOX_LITTLE_ENDIAN
 171 #define LE_TO_H16(x) (x)
 172 #define LE_TO_H32(x) (x)
 173 #define H_TO_LE16(x) (x)
 174 #define H_TO_LE32(x) (x)
 175 #define BE_TO_H16(x) SWAP_16(x)
 176 #define BE_TO_H32(x) SWAP_32(x)
 177 #define H_TO_BE16(x) SWAP_16(x)
 178 #define H_TO_BE32(x) SWAP_32(x)
 179 #else
 180 #define LE_TO_H16(x) SWAP_16(x)
 181 #define LE_TO_H32(x) SWAP_32(x)
 182 #define H_TO_LE16(x) SWAP_16(x)
 183 #define H_TO_LE32(x) SWAP_32(x)
 184 #define BE_TO_H16(x) (x)
 185 #define BE_TO_H32(x) (x)
 186 #define H_TO_BE16(x) (x)
 187 #define H_TO_BE32(x) (x)
 188 #endif
 189
 190 /* Get the byte offset of a type's member */
 191 #define OFFSETOF(type, membername) ((off_t)&((type *)0)->membername)
 192
 193 /* Get the type pointer from one of its members */
 194 #define TYPE_FROM_MEMBER(type, memberptr, membername) \
 195     ((type *)((intptr_t)(memberptr) - OFFSETOF(type, membername)))
 196
 197 /* Use to give gcc hints on which branch is most likely taken */
 198 #if defined(__GNUC__) && __GNUC__ >= 3
 199 #define LIKELY(x)   __builtin_expect(!!(x), 1)
 200 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
 201 #else
 202 #define LIKELY(x)   (x)
 203 #define UNLIKELY(x) (x)
 204 #endif
 205
 206 /* returns index of first set bit + 1 or 0 if no bits are set */
 207 int find_first_set_bit(uint32_t val);
 208
 209 static inline __attribute__((always_inline))
 210 uint32_t isolate_first_bit(uint32_t val)
 211     { return val & -val; }
 212
 213 /* gcc 3.4 changed the format of the constraints */
 214 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ > 3) || (__GNUC__ >= 4)
 215 #define I_CONSTRAINT "I08"
 216 #else
 217 #define I_CONSTRAINT "I"
 218 #endif
 219
 220 /* Utilize the user break controller to catch invalid memory accesses. */
 221 int system_memory_guard(int newmode);
 222
 223 enum {
 224     MEMGUARD_KEEP = -1,    /* don't change the mode; for reading */
 225     MEMGUARD_NONE = 0,     /* catch nothing */
 226     MEMGUARD_FLASH_WRITES, /* catch writes to area 02 (flash ROM) */
 227     MEMGUARD_ZERO_AREA,    /* catch all accesses to areas 00 and 01 */
 228     MAXMEMGUARD
 229 };
 230
 231 #ifndef SIMULATOR
 232 #include "system-target.h"
 233 #else /* SIMULATOR */
 234
 235 static inline uint16_t swap16(uint16_t value)
 236     /*
 237       result[15..8] = value[ 7..0];
 238       result[ 7..0] = value[15..8];
 239     */
 240 {
 241     return (value >> 8) | (value << 8);
 242 }
 243
 244 static inline uint32_t swap32(uint32_t value)
 245     /*
 246       result[31..24] = value[ 7.. 0];
 247       result[23..16] = value[15.. 8];
 248       result[15.. 8] = value[23..16];
 249       result[ 7.. 0] = value[31..24];
 250     */
 251 {
 252     uint32_t hi = swap16(value >> 16);
 253     uint32_t lo = swap16(value & 0xffff);
 254     return (lo << 16) | hi;
 255 }
 256
 257 static inline uint32_t swap_odd_even32(uint32_t value)
 258 {
 259     /*
 260       result[31..24],[15.. 8] = value[23..16],[ 7.. 0]
 261       result[23..16],[ 7.. 0] = value[31..24],[15.. 8]
 262     */
 263     uint32_t t = value & 0xff00ff00;
 264     return (t >> 8) | ((t ^ value) << 8);
 265 }
 266
 267 #endif /* !SIMULATOR */
 268
 269 #ifndef BIT_N
 270 #define BIT_N(n) (1U << (n))
 271 #endif
 272
 273 /* Declare this as HIGHEST_IRQ_LEVEL if they don't differ */
 274 #ifndef DISABLE_INTERRUPTS
 275 #define DISABLE_INTERRUPTS  HIGHEST_IRQ_LEVEL
 276 #endif
 277
 278 /* Just define these as empty if not declared */
 279 #ifdef HAVE_CPUCACHE_INVALIDATE
 280 void cpucache_invalidate(void);
 281 #else
 282 static inline void cpucache_invalidate(void)
 283 {
 284 }
 285 #endif
 286
 287 #ifdef HAVE_CPUCACHE_FLUSH
 288 void cpucache_flush(void);
 289 #else
 290 static inline void cpucache_flush(void)
 291 {
 292 }
 293 #endif
 294
 295 #ifdef PROC_NEEDS_CACHEALIGN
 296 /* Cache alignment attributes and sizes are enabled */
 297
 298 /* 2^CACHEALIGN_BITS = the byte size */
 299 #define CACHEALIGN_SIZE (1u << CACHEALIGN_BITS)
 300
 301 #define CACHEALIGN_ATTR __attribute__((aligned(CACHEALIGN_SIZE)))
 302 /* Aligns x up to a CACHEALIGN_SIZE boundary */
 303 #define CACHEALIGN_UP(x) \
 304     ((typeof (x))ALIGN_UP_P2((uintptr_t)(x), CACHEALIGN_BITS))
 305 /* Aligns x down to a CACHEALIGN_SIZE boundary */
 306 #define CACHEALIGN_DOWN(x) \
 307     ((typeof (x))ALIGN_DOWN_P2((uintptr_t)(x), CACHEALIGN_BITS))
 308 /* Aligns at least to the greater of size x or CACHEALIGN_SIZE */
 309 #define CACHEALIGN_AT_LEAST_ATTR(x) \
 310     __attribute__((aligned(CACHEALIGN_UP(x))))
 311 /* Aligns a buffer pointer and size to proper boundaries */
 312 #define CACHEALIGN_BUFFER(start, size) \
 313     ALIGN_BUFFER((start), (size), CACHEALIGN_SIZE)
 314
 315 #else /* ndef PROC_NEEDS_CACHEALIGN */
 316
 317 /* Cache alignment attributes and sizes are not enabled */
 318 #define CACHEALIGN_ATTR
 319 #define CACHEALIGN_AT_LEAST_ATTR(x) \
 320     __attribute__((aligned(x)))
 321 #define CACHEALIGN_UP(x) (x)
 322 #define CACHEALIGN_DOWN(x) (x)
 323 /* Make no adjustments */
 324 #define CACHEALIGN_BUFFER(start, size)
 325
 326 #endif /* PROC_NEEDS_CACHEALIGN */
 327
 328 /* Double-cast to avoid 'dereferencing type-punned pointer will
 329  * break strict aliasing rules' B.S. */
 330 #define PUN_PTR(type, p) ((type)(intptr_t)(p))
 331
 332 #endif /* __SYSTEM_H__ */