Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / sam / cpus / vonk / ss / lib / cpu / src / SS_Access.h

/*
* ========== Copyright Header Begin ==========================================
* 
* OpenSPARC T2 Processor File: SS_Access.h
* Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.
* 
* The above named program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License version 2 as published by the Free Software Foundation.
* 
* The above named program 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
* General Public License for more details.
* 
* You should have received a copy of the GNU General Public
* License along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
* 
* ========== Copyright Header End ============================================
*/

#ifndef __SS_Access_h__
#define __SS_Access_h__

#include "SS_Types.h"
#include "BL_Utils.h"

// SS_Access describes the Sun Sparc memory accesses with a single
// function. They are used in the I/O devices to handle access.

class SS_Access
{
  public:
    enum Type
    {
      LOAD,
      STORE,
      STP,	// data[0] = store, data[1] = byte mask
      SWAP,     // call: data[0] = rd, return: data[0] = new rd
      CAS,	// call: data[0] = rd, data[1] = rs2, return: data[0] = new rd
      LDST	// call: data[0] ignored, return: data[0] = rd
    };	
      
    typedef void (*Func) ( void* obj, uint_t sid, Type, SS_Paddr, uint_t size, uint64_t* data );

    // ok() returns true when the access is valid and supported
    // in terms of available SunSparc memory operations.
    
    static bool ok( Type type, SS_Paddr pa, uint_t size )
    {
      if (!is_power_of_two(size))
	return false;
      if ((pa & (size - 1)) != 0)
	return false;
      switch (type)
      {
	case LOAD:  return (size != 32) && (size <= 64);
	case STORE: return (size != 32) && (size <= 64);
	case STP:   return (size == 8);
	case SWAP:  return (size == 4);
	case CAS:   return (size == 4) || (size == 8);
	case LDST:  return (size == 1);
	default:    return false;
      }
    }
};

#endif