src/arch/arm/fastmodel/GIC/commands.hh

/*
 * Copyright 2019 Google, Inc.
 *
 * 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: Gabe Black
 */

#ifndef __ARCH_ARM_FASTMODEL_GIC_COMMANDS_HH__
#define __ARCH_ARM_FASTMODEL_GIC_COMMANDS_HH__

#include <cstdint>

#include "base/logging.hh"
#include "sg/SGSignal.h"

namespace FastModel
{

class PPICommand
{
  private:
    uint8_t _cpu;
    uint32_t _num;
    sg::Signal::State _state;

  public:
    PPICommand(uint8_t c, uint32_t n, bool set) :
        _cpu(c), _num(n), _state(set ? sg::Signal::Set : sg::Signal::Clear)
    {
        panic_if(_cpu > 255, "PPICommand CPU out of bounds");
        panic_if(_num > 15, "PPICommand number out of bounds");
    }

    PPICommand() : PPICommand(0, 0, false) {}

    uint8_t cpu() const { return _cpu; }
    uint32_t num() const { return _num; }
    sg::Signal::State state() const { return _state; }
};

class SPICommand
{
  private:
    uint32_t _num;
    sg::Signal::State _state;

  public:
    SPICommand(uint32_t n, bool set) :
        _num(n), _state(set ? sg::Signal::Set : sg::Signal::Clear)
    {
        panic_if(_num > 987, "SPICommand number out of bounds");
    }

    SPICommand() : SPICommand(0, false) {}

    uint32_t num() const { return _num; }
    sg::Signal::State state() const { return _state; }
};

} // namespace FastModel

#endif // __ARCH_ARM_FASTMODEL_GIC_COMMANDS_HH__