cpuIdent.h

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 1999 Eric Valette (eric.valette@free.fr)
 * Copyright (C) 2000 Andy Dachs <a.dachs@sstl.co.uk>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _LIBCPU_CPUIDENT_H
#define _LIBCPU_CPUIDENT_H
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef ASM
typedef enum
{
  PPC_601 = 0x1,
  PPC_5XX = 0x2,
  PPC_603 = 0x3,
  PPC_604 = 0x4,
  PPC_603e = 0x6,
  PPC_603ev = 0x7,
  PPC_750 = 0x8,
  PPC_750_IBM = 0x7000,
  PPC_604e = 0x9,
  PPC_604r = 0xA,
  PPC_7400 = 0xC,
  PPC_405  = 0x2001,  /* Xilinx Virtex-II Pro or -4 */
  PPC_405EX = 0x1291,   /* + 405EXr */
  PPC_405GP = 0x4011,   /* + 405CR */
  PPC_405GPr = 0x5091,
  PPC_405EZ = 0x4151,
  PPC_405EP = 0x5121,
  PPC_440 = 0x7ff2,  /* Xilinx Virtex-5*/
  PPC_7455 = 0x8001, /* Kate Feng */
  PPC_7457 = 0x8002,
  PPC_620 = 0x16,
  PPC_860 = 0x50,
  PPC_821 = PPC_860,
  PPC_823 = PPC_860,
  PPC_8260 = 0x81,
  PPC_8240 = PPC_8260,
  PPC_8245 = 0x8081,
  PPC_8540 = 0x8020,
  PPC_e500v2 = 0x8021,
  PPC_e6500 = 0x8040,
  PPC_603le = 0x8082, /* 603le core, in MGT5100 and MPC5200 */
  PPC_e300c1  = 0x8083, /* e300c1  core, in MPC83xx*/
  PPC_e300c2  = 0x8084, /* e300c2  core */
  PPC_e300c3  = 0x8085, /* e300c3  core */
  PPC_e200z0  = 0x8170,
  PPC_e200z1  = 0x8140,
  PPC_e200z4  = 0x8150,
  PPC_e200z6  = 0x8110,
  PPC_e200z7  = 0x8160,
  PPC_PSIM    = 0xfffe,  /* GDB PowerPC simulator -- fake version */
  PPC_UNKNOWN = 0xffff
} ppc_cpu_id_t;
 
/* Bitfield of for identifying features or groups of cpu flavors.
 * DO NOT USE DIRECTLY (as implementation may change)
 * only use the 'ppc_is_xxx() / ppc_has_xxx()' macros/inlines
 * below.
 */
 
typedef struct {
    unsigned has_altivec        : 1;
    unsigned has_fpu            : 1;
    unsigned has_hw_ptbl_lkup   : 1;
#define PPC_BOOKE_405   1   /* almost like booke but with some significant differences */
#define PPC_BOOKE_STD   2
#define PPC_BOOKE_E500  3   /* bookE with extensions */
    unsigned is_bookE           : 2;
    unsigned has_16byte_clne    : 1;
    unsigned is_60x             : 1;
    unsigned has_8_bats         : 1;
    unsigned has_epic           : 1;
    unsigned has_shadowed_gprs  : 1;
} ppc_feature_t;
 
extern ppc_feature_t   current_ppc_features;
extern ppc_cpu_id_t current_ppc_cpu;
 
typedef unsigned short ppc_cpu_revision_t;
 
extern ppc_cpu_id_t get_ppc_cpu_type (void);
extern const char *get_ppc_cpu_type_name(ppc_cpu_id_t cpu);
extern ppc_cpu_revision_t get_ppc_cpu_revision (void);
extern ppc_cpu_revision_t current_ppc_revision;
 
/* PUBLIC ACCESS ROUTINES */
#define _PPC_FEAT_DECL(x) \
static inline unsigned ppc_cpu_##x(void) { \
  if ( PPC_UNKNOWN == current_ppc_cpu ) \
    get_ppc_cpu_type(); \
  return current_ppc_features.x; \
}
 
_PPC_FEAT_DECL(has_altivec)
/* has_fpu not implemented yet */
_PPC_FEAT_DECL(has_hw_ptbl_lkup)
_PPC_FEAT_DECL(is_bookE)
_PPC_FEAT_DECL(is_60x)
_PPC_FEAT_DECL(has_8_bats)
_PPC_FEAT_DECL(has_epic)
_PPC_FEAT_DECL(has_shadowed_gprs)
 
#undef _PPC_FEAT_DECL
 
static inline ppc_cpu_id_t ppc_cpu_current(void)
{
    return current_ppc_cpu;
}
 
static inline bool ppc_cpu_is_e200(void)
{
    return (ppc_cpu_current() & 0xff80) == 0x8100;
}
 
static inline bool ppc_cpu_is_specific_e200(ppc_cpu_id_t id)
{
    return (ppc_cpu_current() & 0xfff0) == id;
}
 
static inline bool ppc_cpu_is_e300(void)
{
    return ppc_cpu_current() == PPC_e300c1
        || ppc_cpu_current() == PPC_e300c2
        || ppc_cpu_current() == PPC_e300c3;
}
 
static inline bool ppc_cpu_is_e500(void)
{
    return ppc_cpu_current() == PPC_8540
        || ppc_cpu_current() == PPC_e500v2;
}
 
static inline bool ppc_cpu_is(ppc_cpu_id_t cpu)
{
    return ppc_cpu_current() == cpu;
}
 
#endif /* ASM */
 
#ifdef __cplusplus
}
#endif
 
#endif