src/dev/arm/gic_v3.cc - public/gem5 - Git at Google

 /*
  * Copyright (c) 2019 ARM Limited
  * All rights reserved
  *
  * The license below extends only to copyright in the software and shall
  * not be construed as granting a license to any other intellectual
  * property including but not limited to intellectual property relating
  * to a hardware implementation of the functionality of the software
  * licensed hereunder.  You may use the software subject to the license
  * terms below provided that you ensure that this notice is replicated
  * unmodified and in its entirety in all distributions of the software,
  * modified or unmodified, in source code or in binary form.
  *
  * Copyright (c) 2018 Metempsy Technology Consulting
  * 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: Jairo Balart
  */

 #include "dev/arm/gic_v3.hh"

 #include "cpu/intr_control.hh"
 #include "debug/GIC.hh"
 #include "debug/Interrupt.hh"
 #include "dev/arm/gic_v3_cpu_interface.hh"
 #include "dev/arm/gic_v3_distributor.hh"
 #include "dev/arm/gic_v3_its.hh"
 #include "dev/arm/gic_v3_redistributor.hh"
 #include "dev/platform.hh"
 #include "mem/packet.hh"
 #include "mem/packet_access.hh"

 Gicv3::Gicv3(const Params * p)
     : BaseGic(p)
 {
 }

 void
 Gicv3::init()
 {
     distributor = new Gicv3Distributor(this, params()->it_lines);
     redistributors.resize(sys->numContexts(), nullptr);
     cpuInterfaces.resize(sys->numContexts(), nullptr);

     panic_if(sys->numContexts() > params()->cpu_max,
         "Exceeding maximum number of PEs supported by GICv3: "
         "using %u while maximum is %u\n", sys->numContexts(),
         params()->cpu_max);

     for (int i = 0; i < sys->numContexts(); i++) {
         redistributors[i] = new Gicv3Redistributor(this, i);
         cpuInterfaces[i] = new Gicv3CPUInterface(this, i);
     }

     distRange = RangeSize(params()->dist_addr,
         Gicv3Distributor::ADDR_RANGE_SIZE - 1);

     redistSize = redistributors[0]->addrRangeSize;
     redistRange = RangeSize(params()->redist_addr,
          redistSize * sys->numContexts() - 1);

     addrRanges = {distRange, redistRange};

     distributor->init();

     for (int i = 0; i < sys->numContexts(); i++) {
         redistributors[i]->init();
         cpuInterfaces[i]->init();
     }

     Gicv3Its *its = params()->its;
     if (its)
         its->setGIC(this);

     BaseGic::init();
 }

 Tick
 Gicv3::read(PacketPtr pkt)
 {
     const Addr addr = pkt->getAddr();
     const size_t size = pkt->getSize();
     bool is_secure_access = pkt->isSecure();
     uint64_t resp = 0;
     Tick delay = 0;

     if (distRange.contains(addr)) {
         const Addr daddr = addr - distRange.start();
         panic_if(!distributor, "Distributor is null!");
         resp = distributor->read(daddr, size, is_secure_access);
         delay = params()->dist_pio_delay;
         DPRINTF(GIC, "Gicv3::read(): (distributor) context_id %d register %#x "
                 "size %d is_secure_access %d (value %#x)\n",
                 pkt->req->contextId(), daddr, size, is_secure_access, resp);
     } else if (redistRange.contains(addr)) {
         Addr daddr = (addr - redistRange.start()) % redistSize;

         Gicv3Redistributor *redist = getRedistributorByAddr(addr);
         resp = redist->read(daddr, size, is_secure_access);

         delay = params()->redist_pio_delay;
         DPRINTF(GIC, "Gicv3::read(): (redistributor %d) context_id %d "
                 "register %#x size %d is_secure_access %d (value %#x)\n",
                 redist->processorNumber(), pkt->req->contextId(), daddr, size,
                 is_secure_access, resp);
     } else {
         panic("Gicv3::read(): unknown address %#x\n", addr);
     }

     pkt->setUintX(resp, LittleEndianByteOrder);
     pkt->makeAtomicResponse();
     return delay;
 }

 Tick
 Gicv3::write(PacketPtr pkt)
 {
     const size_t size = pkt->getSize();
     uint64_t data = pkt->getUintX(LittleEndianByteOrder);
     const Addr addr = pkt->getAddr();
     bool is_secure_access = pkt->isSecure();
     Tick delay = 0;

     if (distRange.contains(addr)) {
         const Addr daddr = addr - distRange.start();
         panic_if(!distributor, "Distributor is null!");
         DPRINTF(GIC, "Gicv3::write(): (distributor) context_id %d "
                 "register %#x size %d is_secure_access %d value %#x\n",
                 pkt->req->contextId(), daddr, size, is_secure_access, data);
         distributor->write(daddr, data, size, is_secure_access);
         delay = params()->dist_pio_delay;
     } else if (redistRange.contains(addr)) {
         Addr daddr = (addr - redistRange.start()) % redistSize;

         Gicv3Redistributor *redist = getRedistributorByAddr(addr);
         DPRINTF(GIC, "Gicv3::write(): (redistributor %d) context_id %d "
                 "register %#x size %d is_secure_access %d value %#x\n",
                 redist->processorNumber(), pkt->req->contextId(), daddr, size,
                 is_secure_access, data);

         redist->write(daddr, data, size, is_secure_access);

         delay = params()->redist_pio_delay;
     } else {
         panic("Gicv3::write(): unknown address %#x\n", addr);
     }

     pkt->makeAtomicResponse();
     return delay;
 }

 void
 Gicv3::sendInt(uint32_t int_id)
 {
     panic_if(int_id < Gicv3::SGI_MAX + Gicv3::PPI_MAX, "Invalid SPI!");
     panic_if(int_id >= Gicv3::INTID_SECURE, "Invalid SPI!");
     DPRINTF(Interrupt, "Gicv3::sendInt(): received SPI %d\n", int_id);
     distributor->sendInt(int_id);
 }

 void
 Gicv3::clearInt(uint32_t number)
 {
     distributor->deassertSPI(number);
 }

 void
 Gicv3::sendPPInt(uint32_t int_id, uint32_t cpu)
 {
     panic_if(cpu >= redistributors.size(), "Invalid cpuID sending PPI!");
     panic_if(int_id < Gicv3::SGI_MAX, "Invalid PPI!");
     panic_if(int_id >= Gicv3::SGI_MAX + Gicv3::PPI_MAX, "Invalid PPI!");
     DPRINTF(Interrupt, "Gicv3::sendPPInt(): received PPI %d cpuTarget %#x\n",
             int_id, cpu);
     redistributors[cpu]->sendPPInt(int_id);
 }

 void
 Gicv3::clearPPInt(uint32_t num, uint32_t cpu)
 {
 }

 void
 Gicv3::postInt(uint32_t cpu, ArmISA::InterruptTypes int_type)
 {
     platform->intrctrl->post(cpu, int_type, 0);
 }

 void
 Gicv3::deassertInt(uint32_t cpu, ArmISA::InterruptTypes int_type)
 {
     platform->intrctrl->clear(cpu, int_type, 0);
 }

 Gicv3Redistributor *
 Gicv3::getRedistributorByAffinity(uint32_t affinity) const
 {
     for (auto & redistributor : redistributors) {
         if (redistributor->getAffinity() == affinity) {
             return redistributor;
         }
     }

     return nullptr;
 }

 Gicv3Redistributor *
 Gicv3::getRedistributorByAddr(Addr addr) const
 {
     panic_if(!redistRange.contains(addr),
         "Address not pointing to a valid redistributor\n");

     const Addr daddr = addr - redistRange.start();
     const uint32_t redistributor_id = daddr / redistSize;

     panic_if(redistributor_id >= redistributors.size(),
              "Invalid redistributor_id!");
     panic_if(!redistributors[redistributor_id], "Redistributor is null!");

     return redistributors[redistributor_id];
 }

 void
 Gicv3::serialize(CheckpointOut & cp) const
 {
     distributor->serializeSection(cp, "distributor");

     for (uint32_t redistributor_id = 0;
          redistributor_id < redistributors.size(); redistributor_id++)
         redistributors[redistributor_id]->serializeSection(cp,
             csprintf("redistributors.%i", redistributor_id));

     for (uint32_t cpu_interface_id = 0;
          cpu_interface_id < cpuInterfaces.size(); cpu_interface_id++)
         cpuInterfaces[cpu_interface_id]->serializeSection(cp,
             csprintf("cpuInterface.%i", cpu_interface_id));
 }

 void
 Gicv3::unserialize(CheckpointIn & cp)
 {
     getSystem()->setGIC(this);

     distributor->unserializeSection(cp, "distributor");

     for (uint32_t redistributor_id = 0;
          redistributor_id < redistributors.size(); redistributor_id++)
         redistributors[redistributor_id]->unserializeSection(cp,
             csprintf("redistributors.%i", redistributor_id));

     for (uint32_t cpu_interface_id = 0;
          cpu_interface_id < cpuInterfaces.size(); cpu_interface_id++)
         cpuInterfaces[cpu_interface_id]->unserializeSection(cp,
             csprintf("cpuInterface.%i", cpu_interface_id));
 }

 Gicv3 *
 Gicv3Params::create()
 {
     return new Gicv3(this);
 }
	/*
	* Copyright (c) 2019 ARM Limited
	* All rights reserved
	*
	* The license below extends only to copyright in the software and shall
	* not be construed as granting a license to any other intellectual
	* property including but not limited to intellectual property relating
	* to a hardware implementation of the functionality of the software
	* licensed hereunder. You may use the software subject to the license
	* terms below provided that you ensure that this notice is replicated
	* unmodified and in its entirety in all distributions of the software,
	* modified or unmodified, in source code or in binary form.
	*
	* Copyright (c) 2018 Metempsy Technology Consulting
	* 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: Jairo Balart
	*/

	#include "dev/arm/gic_v3.hh"

	#include "cpu/intr_control.hh"
	#include "debug/GIC.hh"
	#include "debug/Interrupt.hh"
	#include "dev/arm/gic_v3_cpu_interface.hh"
	#include "dev/arm/gic_v3_distributor.hh"
	#include "dev/arm/gic_v3_its.hh"
	#include "dev/arm/gic_v3_redistributor.hh"
	#include "dev/platform.hh"
	#include "mem/packet.hh"
	#include "mem/packet_access.hh"

	Gicv3::Gicv3(const Params * p)
	: BaseGic(p)
	{
	}

	void
	Gicv3::init()
	{
	distributor = new Gicv3Distributor(this, params()->it_lines);
	redistributors.resize(sys->numContexts(), nullptr);
	cpuInterfaces.resize(sys->numContexts(), nullptr);

	panic_if(sys->numContexts() > params()->cpu_max,
	"Exceeding maximum number of PEs supported by GICv3: "
	"using %u while maximum is %u\n", sys->numContexts(),
	params()->cpu_max);

	for (int i = 0; i < sys->numContexts(); i++) {
	redistributors[i] = new Gicv3Redistributor(this, i);
	cpuInterfaces[i] = new Gicv3CPUInterface(this, i);
	}

	distRange = RangeSize(params()->dist_addr,
	Gicv3Distributor::ADDR_RANGE_SIZE - 1);

	redistSize = redistributors[0]->addrRangeSize;
	redistRange = RangeSize(params()->redist_addr,
	redistSize * sys->numContexts() - 1);

	addrRanges = {distRange, redistRange};

	distributor->init();

	for (int i = 0; i < sys->numContexts(); i++) {
	redistributors[i]->init();
	cpuInterfaces[i]->init();
	}

	Gicv3Its *its = params()->its;
	if (its)
	its->setGIC(this);

	BaseGic::init();
	}

	Tick
	Gicv3::read(PacketPtr pkt)
	{
	const Addr addr = pkt->getAddr();
	const size_t size = pkt->getSize();
	bool is_secure_access = pkt->isSecure();
	uint64_t resp = 0;
	Tick delay = 0;

	if (distRange.contains(addr)) {
	const Addr daddr = addr - distRange.start();
	panic_if(!distributor, "Distributor is null!");
	resp = distributor->read(daddr, size, is_secure_access);
	delay = params()->dist_pio_delay;
	DPRINTF(GIC, "Gicv3::read(): (distributor) context_id %d register %#x "
	"size %d is_secure_access %d (value %#x)\n",
	pkt->req->contextId(), daddr, size, is_secure_access, resp);
	} else if (redistRange.contains(addr)) {
	Addr daddr = (addr - redistRange.start()) % redistSize;

	Gicv3Redistributor *redist = getRedistributorByAddr(addr);
	resp = redist->read(daddr, size, is_secure_access);

	delay = params()->redist_pio_delay;
	DPRINTF(GIC, "Gicv3::read(): (redistributor %d) context_id %d "
	"register %#x size %d is_secure_access %d (value %#x)\n",
	redist->processorNumber(), pkt->req->contextId(), daddr, size,
	is_secure_access, resp);
	} else {
	panic("Gicv3::read(): unknown address %#x\n", addr);
	}

	pkt->setUintX(resp, LittleEndianByteOrder);
	pkt->makeAtomicResponse();
	return delay;
	}

	Tick
	Gicv3::write(PacketPtr pkt)
	{
	const size_t size = pkt->getSize();
	uint64_t data = pkt->getUintX(LittleEndianByteOrder);
	const Addr addr = pkt->getAddr();
	bool is_secure_access = pkt->isSecure();
	Tick delay = 0;

	if (distRange.contains(addr)) {
	const Addr daddr = addr - distRange.start();
	panic_if(!distributor, "Distributor is null!");
	DPRINTF(GIC, "Gicv3::write(): (distributor) context_id %d "
	"register %#x size %d is_secure_access %d value %#x\n",
	pkt->req->contextId(), daddr, size, is_secure_access, data);
	distributor->write(daddr, data, size, is_secure_access);
	delay = params()->dist_pio_delay;
	} else if (redistRange.contains(addr)) {
	Addr daddr = (addr - redistRange.start()) % redistSize;

	Gicv3Redistributor *redist = getRedistributorByAddr(addr);
	DPRINTF(GIC, "Gicv3::write(): (redistributor %d) context_id %d "
	"register %#x size %d is_secure_access %d value %#x\n",
	redist->processorNumber(), pkt->req->contextId(), daddr, size,
	is_secure_access, data);

	redist->write(daddr, data, size, is_secure_access);

	delay = params()->redist_pio_delay;
	} else {
	panic("Gicv3::write(): unknown address %#x\n", addr);
	}

	pkt->makeAtomicResponse();
	return delay;
	}

	void
	Gicv3::sendInt(uint32_t int_id)
	{
	panic_if(int_id < Gicv3::SGI_MAX + Gicv3::PPI_MAX, "Invalid SPI!");
	panic_if(int_id >= Gicv3::INTID_SECURE, "Invalid SPI!");
	DPRINTF(Interrupt, "Gicv3::sendInt(): received SPI %d\n", int_id);
	distributor->sendInt(int_id);
	}

	void
	Gicv3::clearInt(uint32_t number)
	{
	distributor->deassertSPI(number);
	}

	void
	Gicv3::sendPPInt(uint32_t int_id, uint32_t cpu)
	{
	panic_if(cpu >= redistributors.size(), "Invalid cpuID sending PPI!");
	panic_if(int_id < Gicv3::SGI_MAX, "Invalid PPI!");
	panic_if(int_id >= Gicv3::SGI_MAX + Gicv3::PPI_MAX, "Invalid PPI!");
	DPRINTF(Interrupt, "Gicv3::sendPPInt(): received PPI %d cpuTarget %#x\n",
	int_id, cpu);
	redistributors[cpu]->sendPPInt(int_id);
	}

	void
	Gicv3::clearPPInt(uint32_t num, uint32_t cpu)
	{
	}

	void
	Gicv3::postInt(uint32_t cpu, ArmISA::InterruptTypes int_type)
	{
	platform->intrctrl->post(cpu, int_type, 0);
	}

	void
	Gicv3::deassertInt(uint32_t cpu, ArmISA::InterruptTypes int_type)
	{
	platform->intrctrl->clear(cpu, int_type, 0);
	}

	Gicv3Redistributor *
	Gicv3::getRedistributorByAffinity(uint32_t affinity) const
	{
	for (auto & redistributor : redistributors) {
	if (redistributor->getAffinity() == affinity) {
	return redistributor;
	}
	}

	return nullptr;
	}

	Gicv3Redistributor *
	Gicv3::getRedistributorByAddr(Addr addr) const
	{
	panic_if(!redistRange.contains(addr),
	"Address not pointing to a valid redistributor\n");

	const Addr daddr = addr - redistRange.start();
	const uint32_t redistributor_id = daddr / redistSize;

	panic_if(redistributor_id >= redistributors.size(),
	"Invalid redistributor_id!");
	panic_if(!redistributors[redistributor_id], "Redistributor is null!");

	return redistributors[redistributor_id];
	}

	void
	Gicv3::serialize(CheckpointOut & cp) const
	{
	distributor->serializeSection(cp, "distributor");

	for (uint32_t redistributor_id = 0;
	redistributor_id < redistributors.size(); redistributor_id++)
	redistributors[redistributor_id]->serializeSection(cp,
	csprintf("redistributors.%i", redistributor_id));

	for (uint32_t cpu_interface_id = 0;
	cpu_interface_id < cpuInterfaces.size(); cpu_interface_id++)
	cpuInterfaces[cpu_interface_id]->serializeSection(cp,
	csprintf("cpuInterface.%i", cpu_interface_id));
	}

	void
	Gicv3::unserialize(CheckpointIn & cp)
	{
	getSystem()->setGIC(this);

	distributor->unserializeSection(cp, "distributor");

	for (uint32_t redistributor_id = 0;
	redistributor_id < redistributors.size(); redistributor_id++)
	redistributors[redistributor_id]->unserializeSection(cp,
	csprintf("redistributors.%i", redistributor_id));

	for (uint32_t cpu_interface_id = 0;
	cpu_interface_id < cpuInterfaces.size(); cpu_interface_id++)
	cpuInterfaces[cpu_interface_id]->unserializeSection(cp,
	csprintf("cpuInterface.%i", cpu_interface_id));
	}

	Gicv3 *
	Gicv3Params::create()
	{
	return new Gicv3(this);
	}