110916Sandreas.sandberg@arm.com/* 211349Sandreas.sandberg@arm.com * Copyright (c) 2014-2016 ARM Limited 310916Sandreas.sandberg@arm.com * All rights reserved 410916Sandreas.sandberg@arm.com * 510916Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 610916Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 710916Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 810916Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 910916Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1010916Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1110916Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1210916Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1310916Sandreas.sandberg@arm.com * 1410916Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 1510916Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 1610916Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 1710916Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 1810916Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 1910916Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 2010916Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 2110916Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 2210916Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 2310916Sandreas.sandberg@arm.com * this software without specific prior written permission. 2410916Sandreas.sandberg@arm.com * 2510916Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2610916Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2710916Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2810916Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2910916Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3010916Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3110916Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3210916Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3310916Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3410916Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3510916Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3610916Sandreas.sandberg@arm.com * 3710916Sandreas.sandberg@arm.com * Authors: Andreas Sandberg 3810916Sandreas.sandberg@arm.com */ 3910916Sandreas.sandberg@arm.com 4010916Sandreas.sandberg@arm.com#ifndef __DEV_ARM_NOMALI_GPU_HH__ 4110916Sandreas.sandberg@arm.com#define __DEV_ARM_NOMALI_GPU_HH__ 4210916Sandreas.sandberg@arm.com 4310916Sandreas.sandberg@arm.com#include <map> 4410916Sandreas.sandberg@arm.com 4510916Sandreas.sandberg@arm.com#include "dev/io_device.hh" 4610916Sandreas.sandberg@arm.com#include "libnomali/nomali.h" 4710916Sandreas.sandberg@arm.com 4810916Sandreas.sandberg@arm.comclass NoMaliGpuParams; 4911619Sandreas.sandberg@arm.comclass CustomNoMaliGpuParams; 5010916Sandreas.sandberg@arm.comclass RealView; 5110916Sandreas.sandberg@arm.com 5210916Sandreas.sandberg@arm.comclass NoMaliGpu : public PioDevice 5310916Sandreas.sandberg@arm.com{ 5410916Sandreas.sandberg@arm.com public: 5510916Sandreas.sandberg@arm.com NoMaliGpu(const NoMaliGpuParams *p); 5610916Sandreas.sandberg@arm.com virtual ~NoMaliGpu(); 5710916Sandreas.sandberg@arm.com 5811350Sandreas.sandberg@arm.com void init() override; 5911350Sandreas.sandberg@arm.com 6010916Sandreas.sandberg@arm.com public: /* Checkpointing */ 6111168Sandreas.hansson@arm.com void serialize(CheckpointOut &cp) const override; 6211168Sandreas.hansson@arm.com void unserialize(CheckpointIn &cp) override; 6310916Sandreas.sandberg@arm.com 6410916Sandreas.sandberg@arm.com public: /* IO device interfaces */ 6511168Sandreas.hansson@arm.com Tick read(PacketPtr pkt) override; 6611168Sandreas.hansson@arm.com Tick write(PacketPtr pkt) override; 6711168Sandreas.hansson@arm.com AddrRangeList getAddrRanges() const override; 6810916Sandreas.sandberg@arm.com 6911349Sandreas.sandberg@arm.com protected: /* API wrappers/helpers */ 7010916Sandreas.sandberg@arm.com /** 7111349Sandreas.sandberg@arm.com * @{ 7211349Sandreas.sandberg@arm.com * @name API wrappers 7310916Sandreas.sandberg@arm.com */ 7410916Sandreas.sandberg@arm.com 7511349Sandreas.sandberg@arm.com /** Wrapper around nomali_reset(). */ 7611349Sandreas.sandberg@arm.com void reset(); 7710916Sandreas.sandberg@arm.com 7810916Sandreas.sandberg@arm.com /** Wrapper around nomali_reg_read(). */ 7910916Sandreas.sandberg@arm.com uint32_t readReg(nomali_addr_t reg); 8010916Sandreas.sandberg@arm.com /** Wrapper around nomali_reg_write(). */ 8110916Sandreas.sandberg@arm.com void writeReg(nomali_addr_t reg, uint32_t value); 8210916Sandreas.sandberg@arm.com 8310916Sandreas.sandberg@arm.com /** Wrapper around nomali_reg_read_raw(). */ 8410916Sandreas.sandberg@arm.com uint32_t readRegRaw(nomali_addr_t reg) const; 8510916Sandreas.sandberg@arm.com /** Wrapper around nomali_reg_write_raw(). */ 8610916Sandreas.sandberg@arm.com void writeRegRaw(nomali_addr_t reg, uint32_t value); 8710916Sandreas.sandberg@arm.com 8810916Sandreas.sandberg@arm.com /** 8911349Sandreas.sandberg@arm.com * Wrapper around nomali_int_state() 9011349Sandreas.sandberg@arm.com * 9111349Sandreas.sandberg@arm.com * @param intno Interrupt number 9211349Sandreas.sandberg@arm.com * @return True if asserted, false otherwise. 9311349Sandreas.sandberg@arm.com */ 9411349Sandreas.sandberg@arm.com bool intState(nomali_int_t intno); 9511349Sandreas.sandberg@arm.com 9611349Sandreas.sandberg@arm.com /** @} */ 9711349Sandreas.sandberg@arm.com 9811349Sandreas.sandberg@arm.com /** 9910916Sandreas.sandberg@arm.com * Format a NoMali error into an error message and panic. 10010916Sandreas.sandberg@arm.com * 10110916Sandreas.sandberg@arm.com * @param err Error code from the NoMali library. 10210916Sandreas.sandberg@arm.com * @param msg Message to print. 10310916Sandreas.sandberg@arm.com */ 10410916Sandreas.sandberg@arm.com static void gpuPanic(nomali_error_t err, const char *msg) M5_ATTR_NORETURN; 10510916Sandreas.sandberg@arm.com /** 10610916Sandreas.sandberg@arm.com * Panic if the NoMali returned an error, do nothing otherwise. 10710916Sandreas.sandberg@arm.com * 10810916Sandreas.sandberg@arm.com * @param err Error code from the NoMali library. 10910916Sandreas.sandberg@arm.com * @param msg Message to print when panicking. 11010916Sandreas.sandberg@arm.com */ 11110916Sandreas.sandberg@arm.com static void panicOnErr(nomali_error_t err, const char *msg) { 11210916Sandreas.sandberg@arm.com if (err != NOMALI_E_OK) 11310916Sandreas.sandberg@arm.com gpuPanic(err, msg); 11410916Sandreas.sandberg@arm.com } 11510916Sandreas.sandberg@arm.com 11611349Sandreas.sandberg@arm.com protected: /* Callbacks */ 11711349Sandreas.sandberg@arm.com /** 11811349Sandreas.sandberg@arm.com * @{ 11911349Sandreas.sandberg@arm.com * @name Callbacks 12011349Sandreas.sandberg@arm.com */ 12111349Sandreas.sandberg@arm.com 12211349Sandreas.sandberg@arm.com /** 12311349Sandreas.sandberg@arm.com * Interrupt callback from the NoMali library 12411349Sandreas.sandberg@arm.com * 12511349Sandreas.sandberg@arm.com * This method is called whenever there is an interrupt state change. 12611349Sandreas.sandberg@arm.com * 12711349Sandreas.sandberg@arm.com * @param intno Interrupt number 12811349Sandreas.sandberg@arm.com * @param set True is the interrupt is being asserted, false otherwise. 12911349Sandreas.sandberg@arm.com */ 13011349Sandreas.sandberg@arm.com virtual void onInterrupt(nomali_int_t intno, bool set); 13111349Sandreas.sandberg@arm.com 13211350Sandreas.sandberg@arm.com /** 13311350Sandreas.sandberg@arm.com * Reset callback from the NoMali library 13411350Sandreas.sandberg@arm.com * 13511350Sandreas.sandberg@arm.com * This method is called whenever the GPU is reset through the 13611350Sandreas.sandberg@arm.com * register interface or the API (reset() or nomali_reset()). 13711350Sandreas.sandberg@arm.com */ 13811350Sandreas.sandberg@arm.com virtual void onReset(); 13911350Sandreas.sandberg@arm.com 14011349Sandreas.sandberg@arm.com /** @} */ 14111349Sandreas.sandberg@arm.com 14211349Sandreas.sandberg@arm.com private: /* Callback helpers */ 14311349Sandreas.sandberg@arm.com /** Wrapper around nomali_set_callback() */ 14411349Sandreas.sandberg@arm.com void setCallback(const nomali_callback_t &callback); 14511349Sandreas.sandberg@arm.com 14611349Sandreas.sandberg@arm.com /** 14711349Sandreas.sandberg@arm.com * Interrupt callback from the NoMali library. 14811349Sandreas.sandberg@arm.com * 14911349Sandreas.sandberg@arm.com * This method calls onInterrupt() on the NoMaliGpu owning this 15011349Sandreas.sandberg@arm.com * device. 15111349Sandreas.sandberg@arm.com * 15211349Sandreas.sandberg@arm.com * @param h NoMali library handle. 15311349Sandreas.sandberg@arm.com * @param usr Pointer to an instance of the NoMaliGpu 15411349Sandreas.sandberg@arm.com * @param intno GPU interrupt type 15511349Sandreas.sandberg@arm.com * @param set Was the interrupt raised (1) or lowered (0)? 15611349Sandreas.sandberg@arm.com */ 15711349Sandreas.sandberg@arm.com static void _interrupt(nomali_handle_t h, void *usr, 15811349Sandreas.sandberg@arm.com nomali_int_t intno, int set); 15911350Sandreas.sandberg@arm.com 16011350Sandreas.sandberg@arm.com /** 16111350Sandreas.sandberg@arm.com * Reset callback from the NoMali library. 16211350Sandreas.sandberg@arm.com * 16311350Sandreas.sandberg@arm.com * This method calls onReset() on the NoMaliGpu owning this 16411350Sandreas.sandberg@arm.com * device. 16511350Sandreas.sandberg@arm.com * 16611350Sandreas.sandberg@arm.com * @param h NoMali library handle. 16711350Sandreas.sandberg@arm.com * @param usr Pointer to an instance of the NoMaliGpu 16811350Sandreas.sandberg@arm.com */ 16911350Sandreas.sandberg@arm.com static void _reset(nomali_handle_t h, void *usr); 17011350Sandreas.sandberg@arm.com 17111349Sandreas.sandberg@arm.com protected: 17210916Sandreas.sandberg@arm.com /** Device base address */ 17310916Sandreas.sandberg@arm.com const Addr pioAddr; 17410916Sandreas.sandberg@arm.com 17510916Sandreas.sandberg@arm.com /** Platform, used to discover GIC */ 17610916Sandreas.sandberg@arm.com RealView *const platform; 17710916Sandreas.sandberg@arm.com 17810916Sandreas.sandberg@arm.com /** Map between NoMali interrupt types and actual GIC 17910916Sandreas.sandberg@arm.com * interrupts */ 18010916Sandreas.sandberg@arm.com const std::map<nomali_int_t, uint32_t> interruptMap; 18110916Sandreas.sandberg@arm.com 18210916Sandreas.sandberg@arm.com /** Cached information struct from the NoMali library */ 18310916Sandreas.sandberg@arm.com nomali_info_t nomaliInfo; 18410916Sandreas.sandberg@arm.com 18510916Sandreas.sandberg@arm.com /** Handle of a NoMali library instance */ 18610916Sandreas.sandberg@arm.com nomali_handle_t nomali; 18710916Sandreas.sandberg@arm.com}; 18810916Sandreas.sandberg@arm.com 18910916Sandreas.sandberg@arm.com 19011619Sandreas.sandberg@arm.comclass CustomNoMaliGpu : public NoMaliGpu 19111619Sandreas.sandberg@arm.com{ 19211619Sandreas.sandberg@arm.com public: 19311619Sandreas.sandberg@arm.com CustomNoMaliGpu(const CustomNoMaliGpuParams *p); 19411619Sandreas.sandberg@arm.com virtual ~CustomNoMaliGpu(); 19511619Sandreas.sandberg@arm.com 19611619Sandreas.sandberg@arm.com protected: 19711619Sandreas.sandberg@arm.com void onReset() override; 19811619Sandreas.sandberg@arm.com 19911619Sandreas.sandberg@arm.com private: 20011619Sandreas.sandberg@arm.com /** Map between GPU registers and their custom reset values */ 20111619Sandreas.sandberg@arm.com std::map<nomali_addr_t, uint32_t> idRegs; 20211619Sandreas.sandberg@arm.com}; 20311619Sandreas.sandberg@arm.com 20410916Sandreas.sandberg@arm.com#endif // __DEV_ARM_NOMALI_GPU_HH__ 205