root/sys/arch/powerpc/include/oea/hid.h
/*      $NetBSD: hid.h,v 1.16 2026/01/09 22:54:33 jmcneill Exp $        */

/*-
 * Copyright (c) 2000 Tsubai Masanari.  All rights reserved.
 *
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 _POWERPC_OEA_HID_H_
#define _POWERPC_OEA_HID_H_

#ifdef _KERNEL_OPT
#include "opt_ppcarch.h"
#endif

/* Hardware Implementation Dependent registers for the PowerPC */

#if defined(_ARCH_PPC64) || defined (PPC_OEA64_BRIDGE)
/* this way we can use the same bit numbers as IBM's PowerPC manuals */
#define HIDBIT(x) (0x8000000000000000LL >> x)
#define HID0_64_ONE_PPC HIDBIT(0)   /* one instruction per dispatch group */
#define HID0_64_DO_SNGL HIDBIT(1)   /* single group completion mode */
#define HID0_64_ISYNCSC HIDBIT(2)   /* Disable isync scoreboard optimization */
#define HID0_64_SER_GP  HIDBIT(3)   /* Serialize group dispatch */
#define HID0_64_DEEPNAP HIDBIT(7)   /* Enable deep nap mode (970) */
#define HID0_64_DOZE    HIDBIT(8)   /* Enable doze mode */
#define HID0_64_NAP     HIDBIT(9)   /* Enable nap mode */
#define HID0_64_DPM     HIDBIT(11)  /* Enable Dynamic power management */
#define HID0_64_TG      HIDBIT(13)  /* Perfmon threshold granularity control */
#define HID0_64_HNG_DIS HIDBIT(14)  /* Disable processor hang-detection */
#define HID0_64_NHR     HIDBIT(15)  /* No Hard Reset */
#define HID0_64_INORDER HIDBIT(16)  /* Serialized group issue mode */
#define HID0_64_TB_CTRL HIDBIT(18)  /* TB keeps running if CPU stopped */
#define HID0_64_EX_TBEN HIDBIT(19)  /* timebase runs at external clock */
#define HID0_64_CIABREN HIDBIT(22)  /* enable CIABR register */
#define HID0_64_HDICEEN HIDBIT(23)  /* hypervisor decrementer enable */
#define HID0_64_EN_ATTN HIDBIT(31)  /* support processor attention inst. */
#define HID0_64_EN_MCHK HIDBIT(32)  /* ext. mchk interrupts */
#endif
#define HID0_EMCP       0x80000000  /* Enable MCP */
#define HID0_DBP        0x40000000  /* Disable 60x bus parity generation */
#define HID0_EBA        0x20000000  /* Enable 60x bus address parity checking */
#define HID0_EBD        0x10000000  /* Enable 60x bus data parity checking */
#define HID0_BCLK       0x08000000  /* CLK_OUT clock type selection */
#define HID0_EICE       0x04000000  /* Enable ICE output */
#define HID0_TBEN       0x04000000  /* Time base enable (7450) */
#define HID0_ECLK       0x02000000  /* CLK_OUT clock type selection */
#define HID0_PAR        0x01000000  /* Disable precharge of ARTRY */
#define HID0_STEN       0x01000000  /* Software table search enable (7450) */
#define HID0_DOZE       0x00800000  /* Enable doze mode */
#define HID0_HIGH_BAT_EN 0x00800000  /* Enable additional BATs (74[45][578]) */
#define HID0_NAP        0x00400000  /* Enable nap mode */
#define HID0_SLEEP      0x00200000  /* Enable sleep mode */
#define HID0_DPM        0x00100000  /* Enable Dynamic power management */
#define HID0_RISEG      0x00080000  /* Read I-SEG */
#define HID0_BHTCLR     0x00040000  /* Clear branch history table (7450) */
#define HID0_EIEC       0x00040000  /* Enable internal error checking */
#define HID0_XAEN       0x00020000  /* Enable eXtended Addressing (7450) */
#define HID0_NHR        0x00010000  /* Not hard reset */
#define HID0_ICE        0x00008000  /* Enable i-cache */
#define HID0_DCE        0x00004000  /* Enable d-cache */
#define HID0_ILOCK      0x00002000  /* i-cache lock */
#define HID0_DLOCK      0x00001000  /* d-cache lock */
#define HID0_ICFI       0x00000800  /* i-cache flash invalidate */
#define HID0_DCFI       0x00000400  /* d-cache flash invalidate */
#define HID0_SPD        0x00000200  /* Disable speculative cache access */
#define HID0_IFEM       0x00000100  /* Enable M-bit for I-fetch */
#define HID0_XBSEN      0x00000100  /* Extended BAT block size enable (7455+) */
#define HID0_SGE        0x00000080  /* Enable store gathering */
#define HID0_DCFA       0x00000040  /* Data cache flush assist */
#define HID0_BTIC       0x00000020  /* Enable BTIC */
#define HID0_LRSTK      0x00000010  /* Link register stack enable (7450) */
#define HID0_ABE        0x00000008  /* Enable address broadcast */
#define HID0_FOLD       0x00000008  /* Branch folding enable (7450) */
#define HID0_BHT        0x00000004  /* Enable branch history table */
#define HID0_BTCD       0x00000002  /* Branch target addr cache disable (604) */
#define HID0_NOPTI      0x00000001  /* No-op the dcbt(st) */

#define HID0_BITMASK "\020" \
    "\040EMCP\037DBP\036EBA\035EBD\034BCLK\033EICE\032ECLK\031PAR" \
    "\030DOZE\027NAP\026SLEEP\025DPM\024RISEG\023EIEC\022res\021NHR" \
    "\020ICE\017DCE\016ILOCK\015DLOCK\014ICFI\013DCFI\012SPD\011IFEM" \
    "\010SGE\007DCFA\006BTIC\005FBIOB\004ABE\003BHT\002NOPDST\001NOPTI"

#define HID0_7450_BITMASK "\020" \
    "\040EMCP\037b1\036b2\035b3\034b4\033TBEN\032b6\031STEN" \
    "\030HIGH_BAT_EN\027NAP\026SLEEP\025DPM\024b12\023BHTCLR\022XAEN\021NHR" \
    "\020ICE\017DCE\016ILOCK\015DLOCK\014ICFI\013DCFI\012SPD\011XBSEN" \
    "\010SGE\007b25\006BTIC\005LRSTK\004FOLD\003BHT\002NOPDST\001NOPTI"

#define HID0_970_BITMASK "\020" \
    "\040EMCP"

#define HID0_970_BITMASK_U "\020" \
    "\040ONEPPC\037DOSNGL\036ISYNCSC\035SERGP\034res\033res\032res\031DEEPNAP" \
    "\030DOZE\027NAP\026res\025DPM\024res\023TG\022HNGDIS\021NHR" \
    "\020INORDER\017res\016TBCTRL\015EXTBEN\014res\013res\012CIABREN\011HDICEEN" \
    "\001ENATTN"
/*
 *  HID0 bit definitions per CPU model
 *
 * bit  603     604     750     7400    7410    7450
 *   0  EMCP    EMCP    EMCP    EMCP    EMCP    -
 *   1  -       ECP     DBP     -       -       -
 *   2  EBA     EBA     EBA     EBA     EDA     -
 *   3  EBD     EBD     EBD     EBD     EBD     -
 *   4  SBCLK   -       BCLK    BCKL    BCLK    -
 *   5  EICE    -       -       -       -       TBEN
 *   6  ECLK    -       ECLK    ECLK    ECLK    -
 *   7  PAR     PAR     PAR     PAR     PAR     STEN
 *   8  DOZE    -       DOZE    DOZE    DOZE    HIGH_BAT_EN
 *   9  NAP     -       NAP     NAP     NAP     NAP
 *  10  SLEEP   -       SLEEP   SLEEP   SLEEP   SLEEP
 *  11  DPM     -       DPM     DPM     DPM     DPM
 *  12  RISEG   -       -       RISEG   -       -
 *  13  -       -       -       EIEC    EIEC    BHTCLR
 *  14  -       -       -       -       -       XAEN
 *  15  -       NHR     NHR     NHR     NHR     NHR
 *  16  ICE     ICE     ICE     ICE     ICE     ICE
 *  17  DCE     DCE     DCE     DCE     DCE     DCE
 *  18  ILOCK   ILOCK   ILOCK   ILOCK   ILOCK   ILOCK
 *  19  DLOCK   DLOCK   DLOCK   DLOCK   DLOCK   DLOCK
 *  20  ICFI    ICFI    ICFI    ICFI    ICFI    ICFI
 *  21  DCFI    DCFI    DCFI    DCFI    DCFI    DCFI
 *  22  -       -       SPD     SPD     SPG     SPD
 *  23  -       -       IFEM    IFTT    IFTT    XBSEN
 *  24  -       SIE     SGE     SGE     SGE     SGE
 *  25  -       -       DCFA    DCFA    DCFA    -
 *  26  -       -       BTIC    BTIC    BTIC    BTIC
 *  27  FBIOB   -       -       -       -       LRSTK
 *  28  -       -       ABE     -       -       FOLD
 *  29  -       BHT     BHT     BHT     BHT     BHT
 *  30  -       BTCD    -       NOPDST  NOPDST  NOPDST
 *  31  NOOPTI  -       NOOPTI  NOPTI   NOPTI   NOPTI
 *
 *  604: ECP = Enable cache parity checking
 *  604: SIE = Serial instruction execution disable
 *  604: BTCD = Branch target address cache disable
 * 7450: TBEN = Time Base Enable
 * 7450: STEN = Software table lookup enable
 * 7450: BHTCLR = Branch history clear
 * 7450: LRSTK = Link Register Stack Enable
 * 7450: FOLD = Branch folding enable
 */

#define HID1_EMCP       0x80000000      /* Machine Check Signal Enable */
#define HID1_EBA        0x20000000      /* Enable/Disable 60x/MPX Bus Address
                                           Parity Checking */
#define HID1_EBD        0x10000000      /* Enable/Disable 60x/MPX Bus Data
                                           Parity Checking */
#define HID1_BCLK       0x08000000      /* CLK_OUT */
#define HID1_ECLK       0x02000000      /* CLK_OUT */
#define HID1_PAR        0x01000000      /* Disable Precharge for ... */
#define HID1_DFS4       0x00800000      /* Dynamic Freq Switch / 4 (7448) */
#define HID1_DFS2       0x00400000      /* Dynamic Freq Switch / 2 (7447A) */
#define HID1_SYNCBE     0x00000800      /* Enable sync/eieio broadcast */
#define HID1_ABE        0x00000400      /* Enable address broadcast */

/* PPC970 HID4 */
#define HID4_RMLR0      0x0000000000000020      /* real mode limit bit 0 */
#define HID4_RMLR1      0x4000000000000000      /* real mode limit bit 1 */
#define HID4_RMLR2      0x2000000000000000      /* real mode limit bit 2 */
/*
 * real mode limit bits 012
 * 011 - 64MB
 * 111 - 128MB
 * 100 - 256MB
 * x10 - 1GB
 * x01 - 16GB
 * 000 - 256GB
 */

/* IBM 750CL HID4 */
#define HID4_H4A                  0x80000000 /* Must be written as 1 */
#define HID4_L2FM_64B             0x20000000 /* L2 fetch mode - 64B-fetch */
#define HID4_BPD_4                0x10000000 /* Bus pipeline depth - 4 */
#define HID4_SBE                  0x02000000 /* Secondary BAT enable */
#define HID4_ST0                  0x01000000 /* Store 0 enable */
#define HID4_LPE                  0x00800000 /* Little endian and pair-singles exception mode */
#define HID4_DBP                  0x00400000 /* Data bus parking */
#define HID4_L2MUM                0x00200000 /* L2 MUM enable */
#define HID4_L2_CCFI              0x00100000 /* L2 complete castout prior to L2 flash invalidate */

#define IBM750CL_HID4_BITMASK                                   \
        "\177\020"                                              \
        "b\037" "H4A\0"                                         \
        "f\035\002" "L2FM\0"                                    \
            "=\x00" "32B\0"                                     \
            "=\x01" "64B\0"                                     \
            "=\x02" "128B\0"                                    \
        "f\033\002" "BPD\0"                                     \
            "=\x00" "2\0"                                       \
            "=\x01" "3\0"                                       \
            "=\x02" "4\0"                                       \
        "b\032" "SBE\0"                                         \
        "b\031" "ST0\0"                                         \
        "b\030" "LPE\0"                                         \
        "b\027" "DBP\0"                                         \
        "b\026" "L2MUM\0"                                       \
        "b\025" "L2CFI\0"

/* IBM Espresso HID5 */
#define HID5_H5A                  0x80000000 /* Enable HID5 */
#define HID5_PIRE                 0x40000000 /* Enable PIR */

#define IBMESPRESSO_HID5_BITMASK                                \
        "\177\020"                                              \
        "b\037" "H5A\0"                                         \
        "b\036" "PIRE\0"                                        \
        "b\031" "UDMA\0"                                        \
        "b\030" "L2CR_L2SIZ\0"                                  \
        "b\027" "L2CR\0"                                        \

#endif /* _POWERPC_OEA_HID_H_ */