Subversion Repositories openrisc

//////////////////////////////////////////////////////////////////////

////                                                              ////

////                                                              ////

//// OR1200 MMU test                                              ////

////                                                              ////

////                                                              ////

//////////////////////////////////////////////////////////////////////

////                                                              ////

//// Copyright (C) 2010 Authors and OPENCORES.ORG                 ////

////                                                              ////

//// This source file may be used and distributed without         ////

//// restriction provided that this copyright statement is not    ////

//// removed from the file and that any derivative work contains  ////

//// the original copyright notice and the associated disclaimer. ////

////                                                              ////

//// This source file is free software; you can redistribute it   ////

//// and/or modify it under the terms of the GNU Lesser General   ////

//// Public License as published by the Free Software Foundation; ////

//// either version 2.1 of the License, or (at your option) any   ////

//// later version.                                               ////

////                                                              ////

//// This source is distributed in the hope that it will be       ////

//// useful, but WITHOUT ANY WARRANTY; without even the implied   ////

//// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      ////

//// PURPOSE.  See the GNU Lesser General Public License for more ////

//// details.                                                     ////

////                                                              ////

//// You should have received a copy of the GNU Lesser General    ////

//// Public License along with this source; if not, download it   ////

//// from http://www.opencores.org/lgpl.shtml                     ////

////                                                              ////

//////////////////////////////////////////////////////////////////////

// Tests most functions of the MMUs.

// The tests attempt to keep the areas of instruction and data memory working 

// as they should, while testing around them, higher in memory. Some linker 

// variables are relied upon by the interrupt routines for checking if areas 

// are within the expected text areas of memory, but usually we just keep 

// above the stack (also set in the linker script) and things go OK.

// The tests for translation setup address translation in the MMU from areas 

// in the 512kB - 1024kB region (64 sets in OR1200, 8kByte per set) to halfway

// through RAM. Usually the sets taht would encompass the actual program are 

// skipped (TLB_TEXT_SET_NB) ie, we say how many sets encompass the program 

// text for itlb tests and only do tests above it (so, on sets 8-64, meaning 

// when we enable the iMMU and say have the execution bits disabled to force a

// page fault the program gets to continue and is translated 1-1 while 

// accesses to the areas we are testing will cause a page fault) but it should

//  still work to test all sets.

// In essense, the tests are aware that they could be operating out of the 

// same memory the tests are being performed in and takes care of this.

// The use of the "match_space" variable is for the addresses we'll access 

// when a non-1-1 translation will occur, otherwise usually the 

// "translate_space" variable by itself is used (it's first setup to the 

// desired address, and either data or the return instructions are placed 

// where we expect the MMU to translate to)

#include "cpu-utils.h"

#include "spr-defs.h"

#include "board.h"

// Uncomment uart.h include for UART output

//#include "uart.h"

//#include "printf.h"

// Uncomment the following to completely remove all printfs, or comment them

// out to enable printf()s, but slows down RTL simulation a lot.

#undef printf

#define printf(a, ...)

#include "or1200-defines.h"

#ifdef OR1200_NO_IMMU

# error

# error Processor has no instruction MMU. Cannot run this test without it.

# error

#endif

#ifdef OR1200_NO_DMMU

# error

# error Processor has no data MMU. Cannot run this test without it.

# error

#endif

// Define to run only tests on SHORT_TEST_NUM TLB sets

#define SHORT_TEST

#define SHORT_TEST_NUM 4

// Defines useful when wishing to skip instruction or data MMU tests when doing

// development on one or the other.

// Set this to 1 to enable the IMMU tests

#define DO_IMMU_TESTS 1

// Set this to 1 to enable the DMMU tests

#define DO_DMMU_TESTS 0

// Symbols defined in linker script

extern unsigned long _endtext;

extern unsigned long _stext;

extern unsigned long _edata;

extern unsigned long _stack;

unsigned long start_text_addr;

unsigned long end_text_addr;

unsigned long end_data_addr;

/* For shorter simulation run */

#define RTL_SIM 1

/* Define RAM physical location and size

Bottom half will be used for this program, the rest

will be used for testing */

#define RAM_START   0x00000000

// Assume only 2MB memory

#ifndef RAM_SIZE

# define RAM_SIZE    0x00200000

#endif

#define VM_BASE 0xc0000000

/* What is the last address in ram that is used by this program */

#define TEXT_START_ADD start_text_addr

#define TEXT_END_ADD end_text_addr

#define DATA_END_ADD end_data_addr

// Pages to start tests at. This should correspond to where the stack is set. 

// We can set this by hand or figure it out at runtime.

// Uncomment the following 3 lines to hard-set the bottom page to test at:

//#define TLB_BOTTOM_TEST_PAGE_HARDSET

//#define TLB_TEXT_SET_NB 16

//#define TLB_DATA_SET_NB 16

// Uncomment the following to determine the page to test from at run-time

unsigned long TLB_TEXT_SET_NB;

unsigned long TLB_DATA_SET_NB;

/* MMU page size */

#define PAGE_SIZE 8192

/* Number of DTLB sets used (power of 2, max is 256) */

#define DTLB_SETS 64

/* Number of DTLB ways (1, 2, 3 etc., max is 4). */

#define DTLB_WAYS 1

/* Number of ITLB sets used (power of 2, max is 256) */

#define ITLB_SETS 64

/* Number of ITLB ways (1, 2, 3 etc., max is 4). */

#define ITLB_WAYS 1

/* TLB mode codes */

#define TLB_CODE_ONE_TO_ONE     0x00000000

#define TLB_CODE_PLUS_ONE_PAGE  0x10000000

#define TLB_CODE_MINUS_ONE_PAGE 0x20000000

#define TLB_CODE_MASK   0xfffff000

#define TLB_PR_MASK     0x00000fff

/* fails if x is false */

#define ASSERT(x) ((x)?1: fail (__FUNCTION__, __LINE__))

// iMMU and dMMU enable functions

extern void lo_dmmu_en (void);

extern void lo_immu_en (void);

/* Local functions prototypes */

void dmmu_disable (void);

void immu_disable (void);

// Machine code for l.jr r9 and then l.nop

#define OR32_L_JR_R9 0x44004800

#define OR32_L_NOP 0x15000000

/* Global variables */

extern unsigned long ram_end;

/* DTLB mode status */

volatile unsigned long dtlb_val;

/* ITLB mode status */

volatile unsigned long itlb_val;

/* DTLB miss counter */

volatile int dtlb_miss_count;

/* Data page fault counter */

volatile int dpage_fault_count;

/* ITLB miss counter */

volatile int itlb_miss_count;

/* Instruction page fault counter */

volatile int ipage_fault_count;

/* EA of last DTLB miss exception */

unsigned long dtlb_miss_ea;

/* EA of last data page fault exception */

unsigned long dpage_fault_ea;

/* EA of last ITLB miss exception */

unsigned long itlb_miss_ea;

/* EA of last insn page fault exception */

unsigned long ipage_fault_ea;

#define sys_call() __asm__ __volatile__("l.sys\t0");

/*

void sys_call (void)

{

  asm("l.sys\t0");

}

*/

void fail (char *func, int line)

{

#ifndef __FUNCTION__

#define __FUNCTION__ "?"

#endif

  /* Trigger sys call exception to enable supervisor mode again */

  sys_call ();

  immu_disable ();

  dmmu_disable ();

  report(line);

  report (0xeeeeeeee);

  exit (1);

}

void call(unsigned long add)

{

  asm("l.jalr\t\t%0" : : "r" (add) : "r9", "r11");

  asm("l.nop" : :);

}

void jump(void)

{

  return;

  /*asm("_jr:");

  asm("l.jr\t\tr9") ;

  asm("l.nop" : :);*/

}

void copy_jump(unsigned long phy_add)

{

  memcpy((void *)phy_add, (void *)&jump, (8*4));

}

/* Bus error exception handler */

void bus_err_handler (void)

{

  /* This shouldn't happend */

  printf("Test failed: Bus error\n");

  report (0xeeeeeeee);

  exit (1);

}

/* Illegal insn exception handler */

void ill_insn_handler (void)

{

  /* This shouldn't happend */

  printf("Test failed: Illegal insn\n");

  report (0xeeeeeeee);

  exit (1);

}

/* Sys call exception handler */

void sys_call_handler (void)

{

  /* Set supervisor mode */

  mtspr (SPR_ESR_BASE, mfspr (SPR_ESR_BASE) | SPR_SR_SM);

}

/* DTLB miss exception handler */

void dtlb_miss_handler (void)

{

  unsigned long ea, ta, tlbtr;

  int set, way = 0;

  int i;

  /* Get EA that cause the exception */

  ea = mfspr (SPR_EEAR_BASE);

  /* Find TLB set and LRU way */

  set = (ea / PAGE_SIZE) % DTLB_SETS;

  for (i = 0; i < DTLB_WAYS; i++) {

    if ((mfspr (SPR_DTLBMR_BASE(i) + set) & SPR_DTLBMR_LRU) == 0) {

      way = i;

      break;

    }

  }

  printf("dtlb miss ea = %.8lx set = %d way = %d\n", ea, set, way);

  // Anything under the stack belongs to the program, direct tranlsate it

  if (ea < (unsigned long)&_stack){

    /* If this is acces to data of this program set one to one translation */

    mtspr (SPR_DTLBMR_BASE(way) + set, (ea & SPR_DTLBMR_VPN) | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(way) + set, (ea & SPR_DTLBTR_PPN) | DTLB_PR_NOLIMIT);

    return;

  }

  /* Update DTLB miss counter and EA */

  dtlb_miss_count++;

  dtlb_miss_ea = ea;

  // Everything gets translated back to the space halfway through RAM

  ta = (set*PAGE_SIZE) + RAM_START + (RAM_SIZE/2);

  tlbtr = (ta & SPR_DTLBTR_PPN) | (dtlb_val & TLB_PR_MASK);

  printf("ta = %.8lx tlbtr = %.8lx dtlb_val = %.8lx\n",ta, tlbtr, dtlb_val);

  /* Set DTLB entry */

  mtspr (SPR_DTLBMR_BASE(way) + set, (ea & SPR_DTLBMR_VPN) | SPR_DTLBMR_V);

  mtspr (SPR_DTLBTR_BASE(way) + set, tlbtr);

}

/* Data page fault exception handler */

void dpage_fault_handler (void)

{

  unsigned long ea;

  int set, way = 0;

  int i;

  /* Get EA that cause the exception */

  ea = mfspr (SPR_EEAR_BASE);

  /* Find TLB set and way */

  set = (ea / PAGE_SIZE) % DTLB_SETS;

  for (i = 0; i < DTLB_WAYS; i++) {

    if ((mfspr (SPR_DTLBMR_BASE(i) + set) & SPR_DTLBMR_VPN) ==

        (ea & SPR_DTLBMR_VPN)) {

      way = i;

      break;

    }

  }

  printf("ea = %.8lx set = %d way = %d\n", ea, set, way);

  if (((RAM_START <= ea) & (ea < DATA_END_ADD) ) |

      ((TEXT_START_ADD <= ea) & (ea < TEXT_END_ADD))) {

    /* If this is acces to data of this program set one to one translation */

    mtspr (SPR_DTLBTR_BASE(way) + set, (ea & SPR_DTLBTR_PPN) | DTLB_PR_NOLIMIT);

    return;

  }

  /* Update data page fault counter and EA */

  dpage_fault_count++;

  dpage_fault_ea = ea;

  /* Give permission */

  mtspr (SPR_DTLBTR_BASE(way) + set,

         (mfspr (SPR_DTLBTR_BASE(way) + set) & ~DTLB_PR_NOLIMIT) | dtlb_val);

}

/* ITLB miss exception handler */

void itlb_miss_handler (void)

{

  unsigned long ea, ta, tlbtr;

  int set, way = 0;

  int i;

  /* Get EA that cause the exception */

  ea = mfspr (SPR_EEAR_BASE);

  /* Find TLB set and LRU way */

  set = (ea / PAGE_SIZE) % ITLB_SETS;

  for (i = 0; i < ITLB_WAYS; i++) {

    if ((mfspr (SPR_ITLBMR_BASE(i) + set) & SPR_ITLBMR_LRU) == 0) {

      way = i;

      break;

    }

  }

  printf("itlb miss ea = %.8lx set = %d way = %d\n", ea, set, way);

  if ((TEXT_START_ADD <= ea) && (ea < TEXT_END_ADD)) {

    /* If this is acces to data of this program set one to one translation */

    mtspr (SPR_ITLBMR_BASE(way) + set, (ea & SPR_ITLBMR_VPN) | SPR_ITLBMR_V);

    mtspr (SPR_ITLBTR_BASE(way) + set, (ea & SPR_ITLBTR_PPN) | ITLB_PR_NOLIMIT);

    return;

  }

  /* Update ITLB miss counter and EA */

  itlb_miss_count++;

  itlb_miss_ea = ea;

  /* Whatever access is in progress, translated address have to point to

     physical RAM */

  ta = RAM_START + (RAM_SIZE/2) + (set*PAGE_SIZE);

  tlbtr = (ta & SPR_ITLBTR_PPN) | (itlb_val & TLB_PR_MASK);

  printf("ta = %.8lx\n", ta);

  /* Set ITLB entry */

  mtspr (SPR_ITLBMR_BASE(way) + set, (ea & SPR_ITLBMR_VPN) | SPR_ITLBMR_V);

  mtspr (SPR_ITLBTR_BASE(way) + set, tlbtr);

}

/* Intstruction page fault exception handler */

void ipage_fault_handler (void)

{

  unsigned long ea;

  int set, way = 0;

  int i;

  /* Get EA that cause the exception */

  ea = mfspr (SPR_EEAR_BASE);

  /* Find TLB set and way */

  set = (ea / PAGE_SIZE) % ITLB_SETS;

  for (i = 0; i < ITLB_WAYS; i++) {

    if ((mfspr (SPR_ITLBMR_BASE(i) + set) & SPR_ITLBMR_VPN) == (ea & SPR_ITLBMR_VPN)) {

      way = i;

      break;

    }

  }

  printf("ipage fault: ea = %.8lx set = %d way = %d\n", ea, set, way);

  if ((TEXT_START_ADD <= ea) && (ea < TEXT_END_ADD)) {

    /* If this is acces to data of this program set one to one translation */

    mtspr (SPR_DTLBTR_BASE(way) + set, (ea & SPR_DTLBTR_PPN) | ITLB_PR_NOLIMIT);

    return;

  }

  printf("ipage fault was outside of code area\n", ea, set, way);

  /* Update instruction page fault counter and EA */

  ipage_fault_count++;

  ipage_fault_ea = ea;

  /* Give permission */

  mtspr (SPR_ITLBTR_BASE(way) + set, (mfspr (SPR_ITLBTR_BASE(way) + set) & ~ITLB_PR_NOLIMIT) | itlb_val);

}

/* Invalidate all entries in DTLB and enable DMMU */

void dmmu_enable (void)

{

  /* Register DTLB miss handler */

  add_handler(0x9, dtlb_miss_handler);

  //excpt_dtlbmiss = (unsigned long)dtlb_miss_handler;

  /* Register data page fault handler */

  add_handler(0x3, dpage_fault_handler);

  //excpt_dpfault = (unsigned long)dpage_fault_handler;

  /* Enable DMMU */

  lo_dmmu_en ();

}

/* Disable DMMU */

void dmmu_disable (void)

{

  mtspr (SPR_SR, mfspr (SPR_SR) & ~SPR_SR_DME);

}

/* Invalidate all entries in ITLB and enable IMMU */

void immu_enable (void)

{

  /* Register ITLB miss handler */

  add_handler(0xa, itlb_miss_handler);

  //excpt_itlbmiss = (unsigned long)itlb_miss_handler;

  /* Register instruction page fault handler */

  add_handler(0x4, ipage_fault_handler);

  //excpt_ipfault = (unsigned long)ipage_fault_handler;

  /* Enable IMMU */

  lo_immu_en ();

}

/* Disable IMMU */

void immu_disable (void)

{

  mtspr (SPR_SR, mfspr (SPR_SR) & ~SPR_SR_IME);

}

void write_pattern(unsigned long start, unsigned long end)

{

  unsigned long add;

  add = start;

  while (add < end) {

    REG32(add) = add;

    add += PAGE_SIZE;

  }

}

/* Translation address register test

Set various translation and check the pattern */

int dtlb_translation_test (void)

{

  int i, j;

  unsigned long ea, ta;

  /* Disable DMMU */

  dmmu_disable();

  printf("dtlb translation test set\n");

  /* Invalidate all entries in DTLB */

  for (i = 0; i < DTLB_WAYS; i++) {

    for (j = 0; j < DTLB_SETS; j++) {

      mtspr (SPR_DTLBMR_BASE(i) + j, 0);

      mtspr (SPR_DTLBTR_BASE(i) + j, 0);

    }

  }

  /* Set one to one translation for program's data space */

  for (i = 0; i < TLB_DATA_SET_NB; i++) {

    ea = RAM_START + (i*PAGE_SIZE);

    ta = RAM_START + (i*PAGE_SIZE);

    mtspr (SPR_DTLBMR_BASE(0) + i, ea | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(0) + i, ta | (DTLB_PR_NOLIMIT));

  }

  /* Set dtlb permisions */

  dtlb_val = DTLB_PR_NOLIMIT;

  /* Write test pattern */

  for (i = 0; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    REG32(ea) = i;

    ea = RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4;

    REG32(ea) = 0xffffffff - i;

  }

  /* Set one to one translation */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    ta = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    mtspr (SPR_DTLBMR_BASE(DTLB_WAYS - 1) + i, ea | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(DTLB_WAYS - 1) + i, ta | DTLB_PR_NOLIMIT);

  }

  /* Enable DMMU */

  dmmu_enable();

  /* Check the pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    ASSERT(REG32(ea) == i);

    ea = RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4;

    ASSERT(REG32(ea) == (0xffffffff - i));

  }

  /* Write new pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    REG32(ea) = 0xffffffff - i;

    ea = RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4;

    REG32(ea) = i;

  }

  /* Set 0 -> RAM_START + (RAM_SIZE/2) translation */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = i*PAGE_SIZE;

    ta = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    mtspr (SPR_DTLBMR_BASE(DTLB_WAYS - 1) + i, ea | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(DTLB_WAYS - 1) + i, ta | DTLB_PR_NOLIMIT);

  }

  /* Check the pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = i*PAGE_SIZE;

    ASSERT(REG32(ea) == (0xffffffff - i));

    ea = ((i + 1)*PAGE_SIZE) - 4;

    ASSERT(REG32(ea) == i);

  }

  /* Write new pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    REG32(i*PAGE_SIZE) = i;

    REG32(((i + 1)*PAGE_SIZE) - 4) = 0xffffffff - i;

  }

  /* Set hi -> lo, lo -> hi translation */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    ta = RAM_START + (RAM_SIZE/2) + ((DTLB_SETS - i - 1 + TLB_DATA_SET_NB)*

                                     PAGE_SIZE);

    mtspr (SPR_DTLBMR_BASE(DTLB_WAYS - 1) + i, ea | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(DTLB_WAYS - 1) + i, ta | DTLB_PR_NOLIMIT);

  }

  /* Check the pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    ASSERT(REG32(ea) == (DTLB_SETS - i - 1 + TLB_DATA_SET_NB));

    ea = RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4;

    ASSERT(REG32(ea) == (0xffffffff - DTLB_SETS + i + 1 - TLB_DATA_SET_NB));

  }

  /* Write new pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    REG32(RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE)) = 0xffffffff - i;

    REG32(RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4) = i;

  }

  /* Disable DMMU */

  dmmu_disable();

  /* Check the pattern */

  for (i = TLB_DATA_SET_NB; i < DTLB_SETS; i++) {

    ea = RAM_START + (RAM_SIZE/2) + (i*PAGE_SIZE);

    ASSERT(REG32(ea) == (0xffffffff - DTLB_SETS + i + 1 - TLB_DATA_SET_NB));

    ea = RAM_START + (RAM_SIZE/2) + ((i + 1)*PAGE_SIZE) - 4;

    ASSERT(REG32(ea) == (DTLB_SETS - i - 1 + TLB_DATA_SET_NB));

  }

  printf("-------------------------------------------\n");

  return 0;

}

/* EA match register test

Shifting one in DTLBMR and performing accesses to boundaries

of the page, checking the triggering of exceptions */

int dtlb_match_test (int way, int set)

{

  int i, j, tmp;

  unsigned long add, t_add;

  unsigned long ea, ta;

  /* Disable DMMU */

  dmmu_disable();

  printf("dtlb_match_test - way %d set %d\n",way, set);

  /* Invalidate all entries in DTLB */

  for (i = 0; i < DTLB_WAYS; i++) {

    for (j = 0; j < DTLB_SETS; j++) {

      mtspr (SPR_DTLBMR_BASE(i) + j, 0);

      mtspr (SPR_DTLBTR_BASE(i) + j, 0);

    }

  }

  // Program text/data pages should be 1-1 translation

  for (i = 0; i < TLB_DATA_SET_NB; i++) {

    ea = RAM_START + (i*PAGE_SIZE);

    ta = RAM_START + (i*PAGE_SIZE);

    mtspr (SPR_DTLBMR_BASE(0) + i, ea | SPR_DTLBMR_V);

    mtspr (SPR_DTLBTR_BASE(0) + i, ta | DTLB_PR_NOLIMIT);

  }

  /* Set dtlb permisions */

  dtlb_val = DTLB_PR_NOLIMIT;

  // Setup match area address - based at halfway through RAM, 

  // and then offset by the area encompassed by the set we wish to test.

  unsigned long translate_space = RAM_START + (RAM_SIZE/2) + (set*PAGE_SIZE);