arch/generic/memhelpers.hh

12391Sjason@lowepower.com/*
12391Sjason@lowepower.com * Copyright (c) 2013 ARM Limited
12391Sjason@lowepower.com * All rights reserved
12391Sjason@lowepower.com *
12391Sjason@lowepower.com * The license below extends only to copyright in the software and shall
12391Sjason@lowepower.com * not be construed as granting a license to any other intellectual
12391Sjason@lowepower.com * property including but not limited to intellectual property relating
12391Sjason@lowepower.com * to a hardware implementation of the functionality of the software
12391Sjason@lowepower.com * licensed hereunder.  You may use the software subject to the license
12391Sjason@lowepower.com * terms below provided that you ensure that this notice is replicated
12391Sjason@lowepower.com * unmodified and in its entirety in all distributions of the software,
12391Sjason@lowepower.com * modified or unmodified, in source code or in binary form.
12391Sjason@lowepower.com *
12391Sjason@lowepower.com * Copyright (c) 2011 Google
12391Sjason@lowepower.com * All rights reserved.
12391Sjason@lowepower.com *
12391Sjason@lowepower.com * Redistribution and use in source and binary forms, with or without
12391Sjason@lowepower.com * modification, are permitted provided that the following conditions are
12391Sjason@lowepower.com * met: redistributions of source code must retain the above copyright
12391Sjason@lowepower.com * notice, this list of conditions and the following disclaimer;
12391Sjason@lowepower.com * redistributions in binary form must reproduce the above copyright
12391Sjason@lowepower.com * notice, this list of conditions and the following disclaimer in the
12391Sjason@lowepower.com * documentation and/or other materials provided with the distribution;
12391Sjason@lowepower.com * neither the name of the copyright holders nor the names of its
12391Sjason@lowepower.com * contributors may be used to endorse or promote products derived from
12391Sjason@lowepower.com * this software without specific prior written permission.
12391Sjason@lowepower.com *
12391Sjason@lowepower.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12391Sjason@lowepower.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
12391Sjason@lowepower.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
12391Sjason@lowepower.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
12391Sjason@lowepower.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
12391Sjason@lowepower.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
12391Sjason@lowepower.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
12391Sjason@lowepower.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12391Sjason@lowepower.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12391Sjason@lowepower.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
12391Sjason@lowepower.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
12391Sjason@lowepower.com *
12391Sjason@lowepower.com * Authors: Gabe Black
12391Sjason@lowepower.com */
12391Sjason@lowepower.com
12391Sjason@lowepower.com#ifndef __ARCH_GENERIC_MEMHELPERS_HH__
12391Sjason@lowepower.com#define __ARCH_GENERIC_MEMHELPERS_HH__
12391Sjason@lowepower.com
12391Sjason@lowepower.com#include "base/types.hh"
12391Sjason@lowepower.com#include "mem/request.hh"
12391Sjason@lowepower.com#include "sim/byteswap.hh"
12391Sjason@lowepower.com#include "sim/insttracer.hh"
12391Sjason@lowepower.com
12391Sjason@lowepower.com/// Initiate a read from memory in timing mode.  Note that the 'mem'
12391Sjason@lowepower.com/// parameter is unused; only the type of that parameter is used
12391Sjason@lowepower.com/// to determine the size of the access.
12391Sjason@lowepower.comtemplate <class XC, class MemT>
12391Sjason@lowepower.comFault
12391Sjason@lowepower.cominitiateMemRead(XC *xc, Trace::InstRecord *traceData, Addr addr,
12391Sjason@lowepower.com                MemT &mem, Request::Flags flags)
12391Sjason@lowepower.com{
12391Sjason@lowepower.com    return xc->initiateMemRead(addr, sizeof(MemT), flags);
12391Sjason@lowepower.com}
12391Sjason@lowepower.com
12391Sjason@lowepower.com/// Extract the data returned from a timing mode read.
12391Sjason@lowepower.comtemplate <class MemT>
12391Sjason@lowepower.comvoid
12391Sjason@lowepower.comgetMem(PacketPtr pkt, MemT &mem, Trace::InstRecord *traceData)
12391Sjason@lowepower.com{
12391Sjason@lowepower.com    mem = pkt->get<MemT>();
12391Sjason@lowepower.com    if (traceData)
12391Sjason@lowepower.com        traceData->setData(mem);
12391Sjason@lowepower.com}
12391Sjason@lowepower.com
12391Sjason@lowepower.com/// Read from memory in atomic mode.
12391Sjason@lowepower.comtemplate <class XC, class MemT>
12391Sjason@lowepower.comFault
12391Sjason@lowepower.comreadMemAtomic(XC *xc, Trace::InstRecord *traceData, Addr addr, MemT &mem,
12391Sjason@lowepower.com              Request::Flags flags)
12391Sjason@lowepower.com{
12391Sjason@lowepower.com    memset(&mem, 0, sizeof(mem));
12391Sjason@lowepower.com    Fault fault = xc->readMem(addr, (uint8_t *)&mem, sizeof(MemT), flags);
12391Sjason@lowepower.com    if (fault == NoFault) {
12391Sjason@lowepower.com        mem = TheISA::gtoh(mem);
12391Sjason@lowepower.com        if (traceData)
12391Sjason@lowepower.com            traceData->setData(mem);
12391Sjason@lowepower.com    }
12391Sjason@lowepower.com    return fault;
12391Sjason@lowepower.com}
12391Sjason@lowepower.com
12391Sjason@lowepower.com/// Write to memory in timing mode.
12391Sjason@lowepower.comtemplate <class XC, class MemT>
12391Sjason@lowepower.comFault
12391Sjason@lowepower.comwriteMemTiming(XC *xc, Trace::InstRecord *traceData, MemT mem, Addr addr,
12391Sjason@lowepower.com               Request::Flags flags, uint64_t *res)
12391Sjason@lowepower.com{
12391Sjason@lowepower.com    if (traceData) {
12391Sjason@lowepower.com        traceData->setData(mem);
12391Sjason@lowepower.com    }
12391Sjason@lowepower.com    mem = TheISA::htog(mem);
12391Sjason@lowepower.com    return xc->writeMem((uint8_t *)&mem, sizeof(MemT), addr, flags, res);
12391Sjason@lowepower.com}
12391Sjason@lowepower.com
12391Sjason@lowepower.com/// Write to memory in atomic mode.
12391Sjason@lowepower.comtemplate <class XC, class MemT>
12391Sjason@lowepower.comFault
12391Sjason@lowepower.comwriteMemAtomic(XC *xc, Trace::InstRecord *traceData, const MemT &mem,
12391Sjason@lowepower.com               Addr addr, Request::Flags flags, uint64_t *res)
12391Sjason@lowepower.com{
12391Sjason@lowepower.com    if (traceData) {
12391Sjason@lowepower.com        traceData->setData(mem);
12391Sjason@lowepower.com    }
12391Sjason@lowepower.com    MemT host_mem = TheISA::htog(mem);
12391Sjason@lowepower.com    Fault fault =
12391Sjason@lowepower.com          xc->writeMem((uint8_t *)&host_mem, sizeof(MemT), addr, flags, res);
    if (fault == NoFault && res != NULL) {
        if (flags & Request::MEM_SWAP || flags & Request::MEM_SWAP_COND)
            *res = TheISA::gtoh((MemT)*res);
        else
            *res = TheISA::gtoh(*res);
    }
    return fault;
}

#endif