1/*
2 * Copyright (c) 2012, 2015 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andreas Sandberg
38 */
39
40#ifndef __ARCH_ARM_KVM_BASE_CPU_HH__
41#define __ARCH_ARM_KVM_BASE_CPU_HH__
42
43#include <vector>
44
45#include "cpu/kvm/base.hh"
46
47struct BaseArmKvmCPUParams;
48
49class BaseArmKvmCPU : public BaseKvmCPU
50{
51  public:
52    BaseArmKvmCPU(BaseArmKvmCPUParams *params);
53    virtual ~BaseArmKvmCPU();
54
55    void startup() override;
56
57  protected:
58    Tick kvmRun(Tick ticks) override;
59
60
61    /** Cached state of the IRQ line */
62    bool irqAsserted;
63    /** Cached state of the FIQ line */
64    bool fiqAsserted;
65
66  protected:
67    typedef std::vector<uint64_t> RegIndexVector;
68
69    /**
70     * Get a list of registers supported by getOneReg() and setOneReg().
71     *
72     * This method returns a list of all registers supported by
73     * kvm. The actual list is only requested the first time this
74     * method is called. Subsequent calls return a cached copy of the
75     * register list.
76     *
77     * @return Vector of register indexes.
78     */
79    const RegIndexVector &getRegList() const;
80
81    /**
82     * Tell the kernel to initialize this CPU
83     *
84     * The kernel needs to know what type of the CPU that we want to
85     * emulate. The specified CPU type has to be compatible with the
86     * host CPU. In practice, we usually call
87     * KvmVM::kvmArmPreferredTarget() to discover the host CPU.
88     *
89     * @param target CPU type to emulate
90     */
91    void kvmArmVCpuInit(const struct kvm_vcpu_init &init);
92
93  private:
94    std::unique_ptr<struct kvm_reg_list> tryGetRegList(uint64_t nelem) const;
95
96    /**
97     * Get a list of registers supported by getOneReg() and setOneReg().
98     *
99     * @return False if the number of elements allocated in the list
100     * is too small to hold the complete register list (the required
101     * size is written to regs.n in this case). True on success.
102     */
103    bool getRegList(struct kvm_reg_list &regs) const;
104
105    /**
106     * Cached copy of the list of registers supported by KVM
107     */
108    mutable RegIndexVector _regIndexList;
109};
110
111#endif // __ARCH_ARM_KVM_BASE_CPU_HH__
112