mmapped_ipr.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Andreas Sandberg
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Andreas Sandberg
 */

#ifndef __ARCH_GENERIC_MMAPPED_IPR_HH__
#define __ARCH_GENERIC_MMAPPED_IPR_HH__

#include "base/types.hh"
#include "mem/packet.hh"

class ThreadContext;

namespace GenericISA
{
    const int IPR_CLASS_SHIFT = 48;

    const Addr IPR_IN_CLASS_MASK = ULL(0x0000FFFFFFFFFFFF);

    const Addr IPR_CLASS_PSEUDO_INST = 0x0;

    inline Addr
    iprAddressPseudoInst(uint8_t func, uint8_t subfunc)
    {
        return (IPR_CLASS_PSEUDO_INST << IPR_CLASS_SHIFT)  |
            (func << 8) | subfunc;
    }

    inline bool
    isGenericIprAccess(const Packet *pkt)
    {
        Request::Flags flags(pkt->req->getFlags());
        return (flags & Request::MMAPPED_IPR) &&
            (flags & Request::GENERIC_IPR);
    }

    Cycles handleGenericIprRead(ThreadContext *xc, Packet *pkt);
    Cycles handleGenericIprWrite(ThreadContext *xc, Packet *pkt);

    inline Cycles
    handleIprRead(ThreadContext *xc, Packet *pkt)
    {
        if (!isGenericIprAccess(pkt))
            panic("Unhandled IPR access\n");

        return handleGenericIprRead(xc, pkt);
    }


    inline Cycles
    handleIprWrite(ThreadContext *xc, Packet *pkt)
    {
        if (!isGenericIprAccess(pkt))
            panic("Unhandled IPR access\n");

        return handleGenericIprWrite(xc, pkt);
    }

} // namespace GenericISA



#endif