/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __ALPHA_MCPCIA__H__
#define __ALPHA_MCPCIA__H__

/* Define to experiment with fitting everything into one 128MB HAE window.
   One window per bus, that is.  */
#define MCPCIA_ONE_HAE_WINDOW 1

#include <linux/types.h>
#include <asm/compiler.h>
#include <asm/mce.h>

/*
 * MCPCIA is the internal name for a core logic chipset which provides
 * PCI access for the RAWHIDE family of systems.
 *
 * This file is based on:
 *
 * RAWHIDE System Programmer's Manual
 * 16-May-96
 * Rev. 1.4
 *
 */

/*------------------------------------------------------------------------**
**                                                                        **
**  I/O procedures                                                        **
**                                                                        **
**      inport[b|w|t|l], outport[b|w|t|l] 8:16:24:32 IO xfers             **
**      inportbxt: 8 bits only                                            **
**      inport:    alias of inportw                                       **
**      outport:   alias of outportw                                      **
**                                                                        **
**      inmem[b|w|t|l], outmem[b|w|t|l] 8:16:24:32 ISA memory xfers       **
**      inmembxt: 8 bits only                                             **
**      inmem:    alias of inmemw                                         **
**      outmem:   alias of outmemw                                        **
**                                                                        **
**------------------------------------------------------------------------*/


/* MCPCIA ADDRESS BIT DEFINITIONS
 *
 *  3333 3333 3322 2222 2222 1111 1111 11
 *  9876 5432 1098 7654 3210 9876 5432 1098 7654 3210
 *  ---- ---- ---- ---- ---- ---- ---- ---- ---- ----
 *  1                                             000
 *  ---- ---- ---- ---- ---- ---- ---- ---- ---- ----
 *  |                                             |\|
 *  |                               Byte Enable --+ |
 *  |                             Transfer Length --+
 *  +-- IO space, not cached
 *
 *   Byte      Transfer
 *   Enable    Length    Transfer  Byte    Address
 *   adr<6:5>  adr<4:3>  Length    Enable  Adder
 *   ---------------------------------------------
 *      00        00      Byte      1110   0x000
 *      01        00      Byte      1101   0x020
 *      10        00      Byte      1011   0x040
 *      11        00      Byte      0111   0x060
 *
 *      00        01      Word      1100   0x008
 *      01        01      Word      1001   0x028 <= Not supported in this code.
 *      10        01      Word      0011   0x048
 *
 *      00        10      Tribyte   1000   0x010
 *      01        10      Tribyte   0001   0x030
 *
 *      10        11      Longword  0000   0x058
 *
 *      Note that byte enables are asserted low.
 *
 */

#define MCPCIA_MAX_HOSES 4

#define MCPCIA_MID(m)           ((unsigned long)(m) << 33)

/* Dodge has PCI0 and PCI1 at MID 4 and 5 respectively. 
   Durango adds PCI2 and PCI3 at MID 6 and 7 respectively.  */
#define MCPCIA_HOSE2MID(h)      ((h) + 4)

#define MCPCIA_MEM_MASK 0x07ffffff /* SPARSE Mem region mask is 27 bits */

/*
 * Memory spaces:
 */
#define MCPCIA_SPARSE(m)        (IDENT_ADDR + 0xf000000000UL + MCPCIA_MID(m))
#define MCPCIA_DENSE(m)         (IDENT_ADDR + 0xf100000000UL + MCPCIA_MID(m))
#define MCPCIA_IO(m)            (IDENT_ADDR + 0xf180000000UL + MCPCIA_MID(m))
#define MCPCIA_CONF(m)          (IDENT_ADDR + 0xf1c0000000UL + MCPCIA_MID(m))
#define MCPCIA_CSR(m)           (IDENT_ADDR + 0xf1e0000000UL + MCPCIA_MID(m))
#define MCPCIA_IO_IACK(m)       (IDENT_ADDR + 0xf1f0000000UL + MCPCIA_MID(m))
#define MCPCIA_DENSE_IO(m)      (IDENT_ADDR + 0xe1fc000000UL + MCPCIA_MID(m))
#define MCPCIA_DENSE_CONF(m)    (IDENT_ADDR + 0xe1fe000000UL + MCPCIA_MID(m))

/*
 *  General Registers
 */
#define MCPCIA_REV(m)           (MCPCIA_CSR(m) + 0x000)
#define MCPCIA_WHOAMI(m)        (MCPCIA_CSR(m) + 0x040)
#define MCPCIA_PCI_LAT(m)       (MCPCIA_CSR(m) + 0x080)
#define MCPCIA_CAP_CTRL(m)      (MCPCIA_CSR(m) + 0x100)
#define MCPCIA_HAE_MEM(m)       (MCPCIA_CSR(m) + 0x400)
#define MCPCIA_HAE_IO(m)        (MCPCIA_CSR(m) + 0x440)
#define _MCPCIA_IACK_SC(m)      (MCPCIA_CSR(m) + 0x480)
#define MCPCIA_HAE_DENSE(m)     (MCPCIA_CSR(m) + 0x4C0)

/*
 * Interrupt Control registers
 */
#define MCPCIA_INT_CTL(m)       (MCPCIA_CSR(m) + 0x500)
#define MCPCIA_INT_REQ(m)       (MCPCIA_CSR(m) + 0x540)
#define MCPCIA_INT_TARG(m)      (MCPCIA_CSR(m) + 0x580)
#define MCPCIA_INT_ADR(m)       (MCPCIA_CSR(m) + 0x5C0)
#define MCPCIA_INT_ADR_EXT(m)   (MCPCIA_CSR(m) + 0x600)
#define MCPCIA_INT_MASK0(m)     (MCPCIA_CSR(m) + 0x640)
#define MCPCIA_INT_MASK1(m)     (MCPCIA_CSR(m) + 0x680)
#define MCPCIA_INT_ACK0(m)      (MCPCIA_CSR(m) + 0x10003f00)
#define MCPCIA_INT_ACK1(m)      (MCPCIA_CSR(m) + 0x10003f40)

/*
 * Performance Monitor registers
 */
#define MCPCIA_PERF_MON(m)      (MCPCIA_CSR(m) + 0x300)
#define MCPCIA_PERF_CONT(m)     (MCPCIA_CSR(m) + 0x340)

/*
 * Diagnostic Registers
 */
#define MCPCIA_CAP_DIAG(m)      (MCPCIA_CSR(m) + 0x700)
#define MCPCIA_TOP_OF_MEM(m)    (MCPCIA_CSR(m) + 0x7C0)

/*
 * Error registers
 */
#define MCPCIA_MC_ERR0(m)       (MCPCIA_CSR(m) + 0x800)
#define MCPCIA_MC_ERR1(m)       (MCPCIA_CSR(m) + 0x840)
#define MCPCIA_CAP_ERR(m)       (MCPCIA_CSR(m) + 0x880)
#define MCPCIA_PCI_ERR1(m)      (MCPCIA_CSR(m) + 0x1040)
#define MCPCIA_MDPA_STAT(m)     (MCPCIA_CSR(m) + 0x4000)
#define MCPCIA_MDPA_SYN(m)      (MCPCIA_CSR(m) + 0x4040)
#define MCPCIA_MDPA_DIAG(m)     (MCPCIA_CSR(m) + 0x4080)
#define MCPCIA_MDPB_STAT(m)     (MCPCIA_CSR(m) + 0x8000)
#define MCPCIA_MDPB_SYN(m)      (MCPCIA_CSR(m) + 0x8040)
#define MCPCIA_MDPB_DIAG(m)     (MCPCIA_CSR(m) + 0x8080)

/*
 * PCI Address Translation Registers.
 */
#define MCPCIA_SG_TBIA(m)       (MCPCIA_CSR(m) + 0x1300)
#define MCPCIA_HBASE(m)         (MCPCIA_CSR(m) + 0x1340)

#define MCPCIA_W0_BASE(m)       (MCPCIA_CSR(m) + 0x1400)
#define MCPCIA_W0_MASK(m)       (MCPCIA_CSR(m) + 0x1440)
#define MCPCIA_T0_BASE(m)       (MCPCIA_CSR(m) + 0x1480)

#define MCPCIA_W1_BASE(m)       (MCPCIA_CSR(m) + 0x1500)
#define MCPCIA_W1_MASK(m)       (MCPCIA_CSR(m) + 0x1540)
#define MCPCIA_T1_BASE(m)       (MCPCIA_CSR(m) + 0x1580)

#define MCPCIA_W2_BASE(m)       (MCPCIA_CSR(m) + 0x1600)
#define MCPCIA_W2_MASK(m)       (MCPCIA_CSR(m) + 0x1640)
#define MCPCIA_T2_BASE(m)       (MCPCIA_CSR(m) + 0x1680)

#define MCPCIA_W3_BASE(m)       (MCPCIA_CSR(m) + 0x1700)
#define MCPCIA_W3_MASK(m)       (MCPCIA_CSR(m) + 0x1740)
#define MCPCIA_T3_BASE(m)       (MCPCIA_CSR(m) + 0x1780)

/* Hack!  Only words for bus 0.  */

#ifndef MCPCIA_ONE_HAE_WINDOW
#define MCPCIA_HAE_ADDRESS      MCPCIA_HAE_MEM(4)
#endif
#define MCPCIA_IACK_SC          _MCPCIA_IACK_SC(4)

/* 
 * The canonical non-remaped I/O and MEM addresses have these values
 * subtracted out.  This is arranged so that folks manipulating ISA
 * devices can use their familiar numbers and have them map to bus 0.
 */

#define MCPCIA_IO_BIAS          MCPCIA_IO(4)
#define MCPCIA_MEM_BIAS         MCPCIA_DENSE(4)

/* Offset between ram physical addresses and pci64 DAC bus addresses.  */
#define MCPCIA_DAC_OFFSET       (1UL << 40)

/*
 * Data structure for handling MCPCIA machine checks:
 */
struct el_MCPCIA_uncorrected_frame_mcheck {
        struct el_common header;
        struct el_common_EV5_uncorrectable_mcheck procdata;
};


#ifdef __KERNEL__

#ifndef __EXTERN_INLINE
#define __EXTERN_INLINE extern inline
#define __IO_EXTERN_INLINE
#endif

/*
 * I/O functions:
 *
 * MCPCIA, the RAWHIDE family PCI/memory support chipset for the EV5 (21164)
 * and EV56 (21164a) processors, can use either a sparse address mapping
 * scheme, or the so-called byte-word PCI address space, to get at PCI memory
 * and I/O.
 *
 * Unfortunately, we can't use BWIO with EV5, so for now, we always use SPARSE.
 */

/*
 * Memory functions.  64-bit and 32-bit accesses are done through
 * dense memory space, everything else through sparse space.
 *
 * For reading and writing 8 and 16 bit quantities we need to
 * go through one of the three sparse address mapping regions
 * and use the HAE_MEM CSR to provide some bits of the address.
 * The following few routines use only sparse address region 1
 * which gives 1Gbyte of accessible space which relates exactly
 * to the amount of PCI memory mapping *into* system address space.
 * See p 6-17 of the specification but it looks something like this:
 *
 * 21164 Address:
 *
 *          3         2         1
 * 9876543210987654321098765432109876543210
 * 1ZZZZ0.PCI.QW.Address............BBLL
 *
 * ZZ = SBZ
 * BB = Byte offset
 * LL = Transfer length
 *
 * PCI Address:
 *
 * 3         2         1
 * 10987654321098765432109876543210
 * HHH....PCI.QW.Address........ 00
 *
 * HHH = 31:29 HAE_MEM CSR
 *
 */

#define vip     volatile int __force *
#define vuip    volatile unsigned int __force *
#define vulp    volatile unsigned long __force *

#ifndef MCPCIA_ONE_HAE_WINDOW
#define MCPCIA_FROB_MMIO                                                \
        if (__mcpcia_is_mmio(hose)) {                                   \
                set_hae(hose & 0xffffffff);                             \
                hose = hose - MCPCIA_DENSE(4) + MCPCIA_SPARSE(4);       \
        }
#else
#define MCPCIA_FROB_MMIO                                                \
        if (__mcpcia_is_mmio(hose)) {                                   \
                hose = hose - MCPCIA_DENSE(4) + MCPCIA_SPARSE(4);       \
        }
#endif

extern inline int __mcpcia_is_mmio(unsigned long addr)
{
        return (addr & 0x80000000UL) == 0;
}

__EXTERN_INLINE u8 mcpcia_ioread8(const void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr & MCPCIA_MEM_MASK;
        unsigned long hose = (unsigned long)xaddr & ~MCPCIA_MEM_MASK;
        unsigned long result;

        MCPCIA_FROB_MMIO;

        result = *(vip) ((addr << 5) + hose + 0x00);
        return __kernel_extbl(result, addr & 3);
}

__EXTERN_INLINE void mcpcia_iowrite8(u8 b, void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr & MCPCIA_MEM_MASK;
        unsigned long hose = (unsigned long)xaddr & ~MCPCIA_MEM_MASK;
        unsigned long w;

        MCPCIA_FROB_MMIO;

        w = __kernel_insbl(b, addr & 3);
        *(vuip) ((addr << 5) + hose + 0x00) = w;
}

__EXTERN_INLINE u16 mcpcia_ioread16(const void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr & MCPCIA_MEM_MASK;
        unsigned long hose = (unsigned long)xaddr & ~MCPCIA_MEM_MASK;
        unsigned long result;

        MCPCIA_FROB_MMIO;

        result = *(vip) ((addr << 5) + hose + 0x08);
        return __kernel_extwl(result, addr & 3);
}

__EXTERN_INLINE void mcpcia_iowrite16(u16 b, void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr & MCPCIA_MEM_MASK;
        unsigned long hose = (unsigned long)xaddr & ~MCPCIA_MEM_MASK;
        unsigned long w;

        MCPCIA_FROB_MMIO;

        w = __kernel_inswl(b, addr & 3);
        *(vuip) ((addr << 5) + hose + 0x08) = w;
}

__EXTERN_INLINE u32 mcpcia_ioread32(const void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr;

        if (!__mcpcia_is_mmio(addr))
                addr = ((addr & 0xffff) << 5) + (addr & ~0xfffful) + 0x18;

        return *(vuip)addr;
}

__EXTERN_INLINE void mcpcia_iowrite32(u32 b, void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr;

        if (!__mcpcia_is_mmio(addr))
                addr = ((addr & 0xffff) << 5) + (addr & ~0xfffful) + 0x18;

        *(vuip)addr = b;
}

__EXTERN_INLINE u64 mcpcia_ioread64(const void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr;

        if (!__mcpcia_is_mmio(addr))
                addr = ((addr & 0xffff) << 5) + (addr & ~0xfffful) + 0x18;

        return *(vulp)addr;
}

__EXTERN_INLINE void mcpcia_iowrite64(u64 b, void __iomem *xaddr)
{
        unsigned long addr = (unsigned long)xaddr;

        if (!__mcpcia_is_mmio(addr))
                addr = ((addr & 0xffff) << 5) + (addr & ~0xfffful) + 0x18;

        *(vulp)addr = b;
}


__EXTERN_INLINE void __iomem *mcpcia_ioportmap(unsigned long addr)
{
        return (void __iomem *)(addr + MCPCIA_IO_BIAS);
}

__EXTERN_INLINE void __iomem *mcpcia_ioremap(unsigned long addr,
                                             unsigned long size)
{
        return (void __iomem *)(addr + MCPCIA_MEM_BIAS);
}

__EXTERN_INLINE int mcpcia_is_ioaddr(unsigned long addr)
{
        return addr >= MCPCIA_SPARSE(0);
}

__EXTERN_INLINE int mcpcia_is_mmio(const volatile void __iomem *xaddr)
{
        unsigned long addr = (unsigned long) xaddr;
        return __mcpcia_is_mmio(addr);
}

#undef MCPCIA_FROB_MMIO

#undef vip
#undef vuip
#undef vulp

#undef __IO_PREFIX
#define __IO_PREFIX             mcpcia
#define mcpcia_trivial_rw_bw    2
#define mcpcia_trivial_rw_lq    1
#define mcpcia_trivial_io_bw    0
#define mcpcia_trivial_io_lq    0
#define mcpcia_trivial_iounmap  1
#include <asm/io_trivial.h>

#ifdef __IO_EXTERN_INLINE
#undef __EXTERN_INLINE
#undef __IO_EXTERN_INLINE
#endif

#endif /* __KERNEL__ */

#endif /* __ALPHA_MCPCIA__H__ */