/*
 * PowerPC memory management structures
 */

#ifdef __KERNEL__
#ifndef _PPC_MMU_H_
#define _PPC_MMU_H_


#ifndef __ASSEMBLY__

/*
 * Define physical address type.  Machines using split size
 * virtual/physical addressing like 32-bit virtual / 36-bit
 * physical need a larger than native word size type. -Matt
 */
#ifndef CONFIG_PHYS_64BIT
typedef unsigned long phys_addr_t;
#define PHYS_FMT        "%.8lx"
#else
typedef unsigned long long phys_addr_t;
extern phys_addr_t fixup_bigphys_addr(phys_addr_t, phys_addr_t);
#define PHYS_FMT        "%16Lx"
#endif

typedef struct {
        unsigned long id;
        unsigned long vdso_base;
} mm_context_t;

/* Hardware Page Table Entry */
typedef struct _PTE {
        unsigned long v:1;      /* Entry is valid */
        unsigned long vsid:24;  /* Virtual segment identifier */
        unsigned long h:1;      /* Hash algorithm indicator */
        unsigned long api:6;    /* Abbreviated page index */
        unsigned long rpn:20;   /* Real (physical) page number */
        unsigned long    :3;    /* Unused */
        unsigned long r:1;      /* Referenced */
        unsigned long c:1;      /* Changed */
        unsigned long w:1;      /* Write-thru cache mode */
        unsigned long i:1;      /* Cache inhibited */
        unsigned long m:1;      /* Memory coherence */
        unsigned long g:1;      /* Guarded */
        unsigned long  :1;      /* Unused */
        unsigned long pp:2;     /* Page protection */
} PTE;

/* Values for PP (assumes Ks=0, Kp=1) */
#define PP_RWXX 0       /* Supervisor read/write, User none */
#define PP_RWRX 1       /* Supervisor read/write, User read */
#define PP_RWRW 2       /* Supervisor read/write, User read/write */
#define PP_RXRX 3       /* Supervisor read,       User read */

/* Segment Register */
typedef struct _SEGREG {
        unsigned long t:1;      /* Normal or I/O  type */
        unsigned long ks:1;     /* Supervisor 'key' (normally 0) */
        unsigned long kp:1;     /* User 'key' (normally 1) */
        unsigned long n:1;      /* No-execute */
        unsigned long :4;       /* Unused */
        unsigned long vsid:24;  /* Virtual Segment Identifier */
} SEGREG;

/* Block Address Translation (BAT) Registers */
typedef struct _P601_BATU {     /* Upper part of BAT for 601 processor */
        unsigned long bepi:15;  /* Effective page index (virtual address) */
        unsigned long :8;       /* unused */
        unsigned long w:1;
        unsigned long i:1;      /* Cache inhibit */
        unsigned long m:1;      /* Memory coherence */
        unsigned long ks:1;     /* Supervisor key (normally 0) */
        unsigned long kp:1;     /* User key (normally 1) */
        unsigned long pp:2;     /* Page access protections */
} P601_BATU;

typedef struct _BATU {          /* Upper part of BAT (all except 601) */
        unsigned long bepi:15;  /* Effective page index (virtual address) */
        unsigned long :4;       /* Unused */
        unsigned long bl:11;    /* Block size mask */
        unsigned long vs:1;     /* Supervisor valid */
        unsigned long vp:1;     /* User valid */
} BATU;

typedef struct _P601_BATL {     /* Lower part of BAT for 601 processor */
        unsigned long brpn:15;  /* Real page index (physical address) */
        unsigned long :10;      /* Unused */
        unsigned long v:1;      /* Valid bit */
        unsigned long bl:6;     /* Block size mask */
} P601_BATL;

typedef struct _BATL {          /* Lower part of BAT (all except 601) */
        unsigned long brpn:15;  /* Real page index (physical address) */
        unsigned long :10;      /* Unused */
        unsigned long w:1;      /* Write-thru cache */
        unsigned long i:1;      /* Cache inhibit */
        unsigned long m:1;      /* Memory coherence */
        unsigned long g:1;      /* Guarded (MBZ in IBAT) */
        unsigned long :1;       /* Unused */
        unsigned long pp:2;     /* Page access protections */
} BATL;

typedef struct _BAT {
        BATU batu;              /* Upper register */
        BATL batl;              /* Lower register */
} BAT;

typedef struct _P601_BAT {
        P601_BATU batu;         /* Upper register */
        P601_BATL batl;         /* Lower register */
} P601_BAT;

#endif /* __ASSEMBLY__ */

/* Block size masks */
#define BL_128K 0x000
#define BL_256K 0x001
#define BL_512K 0x003
#define BL_1M   0x007
#define BL_2M   0x00F
#define BL_4M   0x01F
#define BL_8M   0x03F
#define BL_16M  0x07F
#define BL_32M  0x0FF
#define BL_64M  0x1FF
#define BL_128M 0x3FF
#define BL_256M 0x7FF

/* BAT Access Protection */
#define BPP_XX  0x00            /* No access */
#define BPP_RX  0x01            /* Read only */
#define BPP_RW  0x02            /* Read/write */

/* Control/status registers for the MPC8xx.
 * A write operation to these registers causes serialized access.
 * During software tablewalk, the registers used perform mask/shift-add
 * operations when written/read.  A TLB entry is created when the Mx_RPN
 * is written, and the contents of several registers are used to
 * create the entry.
 */
#define SPRN_MI_CTR     784     /* Instruction TLB control register */
#define MI_GPM          0x80000000      /* Set domain manager mode */
#define MI_PPM          0x40000000      /* Set subpage protection */
#define MI_CIDEF        0x20000000      /* Set cache inhibit when MMU dis */
#define MI_RSV4I        0x08000000      /* Reserve 4 TLB entries */
#define MI_PPCS         0x02000000      /* Use MI_RPN prob/priv state */
#define MI_IDXMASK      0x00001f00      /* TLB index to be loaded */
#define MI_RESETVAL     0x00000000      /* Value of register at reset */

/* These are the Ks and Kp from the PowerPC books.  For proper operation,
 * Ks = 0, Kp = 1.
 */
#define SPRN_MI_AP      786
#define MI_Ks           0x80000000      /* Should not be set */
#define MI_Kp           0x40000000      /* Should always be set */

/* The effective page number register.  When read, contains the information
 * about the last instruction TLB miss.  When MI_RPN is written, bits in
 * this register are used to create the TLB entry.
 */
#define SPRN_MI_EPN     787
#define MI_EPNMASK      0xfffff000      /* Effective page number for entry */
#define MI_EVALID       0x00000200      /* Entry is valid */
#define MI_ASIDMASK     0x0000000f      /* ASID match value */
                                        /* Reset value is undefined */

/* A "level 1" or "segment" or whatever you want to call it register.
 * For the instruction TLB, it contains bits that get loaded into the
 * TLB entry when the MI_RPN is written.
 */
#define SPRN_MI_TWC     789
#define MI_APG          0x000001e0      /* Access protection group (0) */
#define MI_GUARDED      0x00000010      /* Guarded storage */
#define MI_PSMASK       0x0000000c      /* Mask of page size bits */
#define MI_PS8MEG       0x0000000c      /* 8M page size */
#define MI_PS512K       0x00000004      /* 512K page size */
#define MI_PS4K_16K     0x00000000      /* 4K or 16K page size */
#define MI_SVALID       0x00000001      /* Segment entry is valid */
                                        /* Reset value is undefined */

/* Real page number.  Defined by the pte.  Writing this register
 * causes a TLB entry to be created for the instruction TLB, using
 * additional information from the MI_EPN, and MI_TWC registers.
 */
#define SPRN_MI_RPN     790

/* Define an RPN value for mapping kernel memory to large virtual
 * pages for boot initialization.  This has real page number of 0,
 * large page size, shared page, cache enabled, and valid.
 * Also mark all subpages valid and write access.
 */
#define MI_BOOTINIT     0x000001fd

#define SPRN_MD_CTR     792     /* Data TLB control register */
#define MD_GPM          0x80000000      /* Set domain manager mode */
#define MD_PPM          0x40000000      /* Set subpage protection */
#define MD_CIDEF        0x20000000      /* Set cache inhibit when MMU dis */
#define MD_WTDEF        0x10000000      /* Set writethrough when MMU dis */
#define MD_RSV4I        0x08000000      /* Reserve 4 TLB entries */
#define MD_TWAM         0x04000000      /* Use 4K page hardware assist */
#define MD_PPCS         0x02000000      /* Use MI_RPN prob/priv state */
#define MD_IDXMASK      0x00001f00      /* TLB index to be loaded */
#define MD_RESETVAL     0x04000000      /* Value of register at reset */

#define SPRN_M_CASID    793     /* Address space ID (context) to match */
#define MC_ASIDMASK     0x0000000f      /* Bits used for ASID value */


/* These are the Ks and Kp from the PowerPC books.  For proper operation,
 * Ks = 0, Kp = 1.
 */
#define SPRN_MD_AP      794
#define MD_Ks           0x80000000      /* Should not be set */
#define MD_Kp           0x40000000      /* Should always be set */

/* The effective page number register.  When read, contains the information
 * about the last instruction TLB miss.  When MD_RPN is written, bits in
 * this register are used to create the TLB entry.
 */
#define SPRN_MD_EPN     795
#define MD_EPNMASK      0xfffff000      /* Effective page number for entry */
#define MD_EVALID       0x00000200      /* Entry is valid */
#define MD_ASIDMASK     0x0000000f      /* ASID match value */
                                        /* Reset value is undefined */

/* The pointer to the base address of the first level page table.
 * During a software tablewalk, reading this register provides the address
 * of the entry associated with MD_EPN.
 */
#define SPRN_M_TWB      796
#define M_L1TB          0xfffff000      /* Level 1 table base address */
#define M_L1INDX        0x00000ffc      /* Level 1 index, when read */
                                        /* Reset value is undefined */

/* A "level 1" or "segment" or whatever you want to call it register.
 * For the data TLB, it contains bits that get loaded into the TLB entry
 * when the MD_RPN is written.  It is also provides the hardware assist
 * for finding the PTE address during software tablewalk.
 */
#define SPRN_MD_TWC     797
#define MD_L2TB         0xfffff000      /* Level 2 table base address */
#define MD_L2INDX       0xfffffe00      /* Level 2 index (*pte), when read */
#define MD_APG          0x000001e0      /* Access protection group (0) */
#define MD_GUARDED      0x00000010      /* Guarded storage */
#define MD_PSMASK       0x0000000c      /* Mask of page size bits */
#define MD_PS8MEG       0x0000000c      /* 8M page size */
#define MD_PS512K       0x00000004      /* 512K page size */
#define MD_PS4K_16K     0x00000000      /* 4K or 16K page size */
#define MD_WT           0x00000002      /* Use writethrough page attribute */
#define MD_SVALID       0x00000001      /* Segment entry is valid */
                                        /* Reset value is undefined */


/* Real page number.  Defined by the pte.  Writing this register
 * causes a TLB entry to be created for the data TLB, using
 * additional information from the MD_EPN, and MD_TWC registers.
 */
#define SPRN_MD_RPN     798

/* This is a temporary storage register that could be used to save
 * a processor working register during a tablewalk.
 */
#define SPRN_M_TW       799

/*
 * At present, all PowerPC 400-class processors share a similar TLB
 * architecture. The instruction and data sides share a unified,
 * 64-entry, fully-associative TLB which is maintained totally under
 * software control. In addition, the instruction side has a
 * hardware-managed, 4-entry, fully- associative TLB which serves as a
 * first level to the shared TLB. These two TLBs are known as the UTLB
 * and ITLB, respectively.
 */

#define        PPC4XX_TLB_SIZE 64

/*
 * TLB entries are defined by a "high" tag portion and a "low" data
 * portion.  On all architectures, the data portion is 32-bits.
 *
 * TLB entries are managed entirely under software control by reading,
 * writing, and searchoing using the 4xx-specific tlbre, tlbwr, and tlbsx
 * instructions.
 */

#define TLB_LO          1
#define TLB_HI          0

#define TLB_DATA        TLB_LO
#define TLB_TAG         TLB_HI

/* Tag portion */

#define TLB_EPN_MASK    0xFFFFFC00      /* Effective Page Number */
#define TLB_PAGESZ_MASK 0x00000380
#define TLB_PAGESZ(x)   (((x) & 0x7) << 7)
#define   PAGESZ_1K             0
#define   PAGESZ_4K             1
#define   PAGESZ_16K            2
#define   PAGESZ_64K            3
#define   PAGESZ_256K           4
#define   PAGESZ_1M             5
#define   PAGESZ_4M             6
#define   PAGESZ_16M            7
#define TLB_VALID       0x00000040      /* Entry is valid */

/* Data portion */

#define TLB_RPN_MASK    0xFFFFFC00      /* Real Page Number */
#define TLB_PERM_MASK   0x00000300
#define TLB_EX          0x00000200      /* Instruction execution allowed */
#define TLB_WR          0x00000100      /* Writes permitted */
#define TLB_ZSEL_MASK   0x000000F0
#define TLB_ZSEL(x)     (((x) & 0xF) << 4)
#define TLB_ATTR_MASK   0x0000000F
#define TLB_W           0x00000008      /* Caching is write-through */
#define TLB_I           0x00000004      /* Caching is inhibited */
#define TLB_M           0x00000002      /* Memory is coherent */
#define TLB_G           0x00000001      /* Memory is guarded from prefetch */

/*
 * PPC440 support
 */
#define PPC44x_MMUCR_TID        0x000000ff
#define PPC44x_MMUCR_STS        0x00010000

#define PPC44x_TLB_PAGEID       0
#define PPC44x_TLB_XLAT         1
#define PPC44x_TLB_ATTRIB       2

/* Page identification fields */
#define PPC44x_TLB_EPN_MASK     0xfffffc00      /* Effective Page Number */
#define PPC44x_TLB_VALID        0x00000200      /* Valid flag */
#define PPC44x_TLB_TS           0x00000100      /* Translation address space */
#define PPC44x_TLB_1K           0x00000000      /* Page sizes */
#define PPC44x_TLB_4K           0x00000010
#define PPC44x_TLB_16K          0x00000020
#define PPC44x_TLB_64K          0x00000030
#define PPC44x_TLB_256K         0x00000040
#define PPC44x_TLB_1M           0x00000050
#define PPC44x_TLB_16M          0x00000070
#define PPC44x_TLB_256M         0x00000090

/* Translation fields */
#define PPC44x_TLB_RPN_MASK     0xfffffc00      /* Real Page Number */
#define PPC44x_TLB_ERPN_MASK    0x0000000f

/* Storage attribute and access control fields */
#define PPC44x_TLB_ATTR_MASK    0x0000ff80
#define PPC44x_TLB_U0           0x00008000      /* User 0 */
#define PPC44x_TLB_U1           0x00004000      /* User 1 */
#define PPC44x_TLB_U2           0x00002000      /* User 2 */
#define PPC44x_TLB_U3           0x00001000      /* User 3 */
#define PPC44x_TLB_W            0x00000800      /* Caching is write-through */
#define PPC44x_TLB_I            0x00000400      /* Caching is inhibited */
#define PPC44x_TLB_M            0x00000200      /* Memory is coherent */
#define PPC44x_TLB_G            0x00000100      /* Memory is guarded */
#define PPC44x_TLB_E            0x00000080      /* Memory is guarded */

#define PPC44x_TLB_PERM_MASK    0x0000003f
#define PPC44x_TLB_UX           0x00000020      /* User execution */
#define PPC44x_TLB_UW           0x00000010      /* User write */
#define PPC44x_TLB_UR           0x00000008      /* User read */
#define PPC44x_TLB_SX           0x00000004      /* Super execution */
#define PPC44x_TLB_SW           0x00000002      /* Super write */
#define PPC44x_TLB_SR           0x00000001      /* Super read */

/* Book-E defined page sizes */
#define BOOKE_PAGESZ_1K         0
#define BOOKE_PAGESZ_4K         1
#define BOOKE_PAGESZ_16K        2
#define BOOKE_PAGESZ_64K        3
#define BOOKE_PAGESZ_256K       4
#define BOOKE_PAGESZ_1M         5
#define BOOKE_PAGESZ_4M         6
#define BOOKE_PAGESZ_16M        7
#define BOOKE_PAGESZ_64M        8
#define BOOKE_PAGESZ_256M       9
#define BOOKE_PAGESZ_1GB        10
#define BOOKE_PAGESZ_4GB        11
#define BOOKE_PAGESZ_16GB       12
#define BOOKE_PAGESZ_64GB       13
#define BOOKE_PAGESZ_256GB      14
#define BOOKE_PAGESZ_1TB        15

/*
 * Freescale Book-E MMU support
 */

#define MAS0_TLBSEL(x)  ((x << 28) & 0x30000000)
#define MAS0_ESEL(x)    ((x << 16) & 0x0FFF0000)
#define MAS0_NV(x)      ((x) & 0x00000FFF)

#define MAS1_VALID      0x80000000
#define MAS1_IPROT      0x40000000
#define MAS1_TID(x)     ((x << 16) & 0x3FFF0000)
#define MAS1_TS         0x00001000
#define MAS1_TSIZE(x)   ((x << 8) & 0x00000F00)

#define MAS2_EPN        0xFFFFF000
#define MAS2_X0         0x00000040
#define MAS2_X1         0x00000020
#define MAS2_W          0x00000010
#define MAS2_I          0x00000008
#define MAS2_M          0x00000004
#define MAS2_G          0x00000002
#define MAS2_E          0x00000001

#define MAS3_RPN        0xFFFFF000
#define MAS3_U0         0x00000200
#define MAS3_U1         0x00000100
#define MAS3_U2         0x00000080
#define MAS3_U3         0x00000040
#define MAS3_UX         0x00000020
#define MAS3_SX         0x00000010
#define MAS3_UW         0x00000008
#define MAS3_SW         0x00000004
#define MAS3_UR         0x00000002
#define MAS3_SR         0x00000001

#define MAS4_TLBSELD(x) MAS0_TLBSEL(x)
#define MAS4_TIDDSEL    0x000F0000
#define MAS4_TSIZED(x)  MAS1_TSIZE(x)
#define MAS4_X0D        0x00000040
#define MAS4_X1D        0x00000020
#define MAS4_WD         0x00000010
#define MAS4_ID         0x00000008
#define MAS4_MD         0x00000004
#define MAS4_GD         0x00000002
#define MAS4_ED         0x00000001

#define MAS6_SPID0      0x3FFF0000
#define MAS6_SPID1      0x00007FFE
#define MAS6_SAS        0x00000001
#define MAS6_SPID       MAS6_SPID0

#define MAS7_RPN        0xFFFFFFFF

#endif /* _PPC_MMU_H_ */
#endif /* __KERNEL__ */