gpu_nomali.hh revision 11349 
1/*
2 * Copyright (c) 2014-2016 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 __DEV_ARM_NOMALI_GPU_HH__
41#define __DEV_ARM_NOMALI_GPU_HH__
42
43#include <map>
44
45#include "dev/io_device.hh"
46#include "libnomali/nomali.h"
47
48class NoMaliGpuParams;
49class RealView;
50
51class NoMaliGpu : public PioDevice
52{
53  public:
54    NoMaliGpu(const NoMaliGpuParams *p);
55    virtual ~NoMaliGpu();
56
57  public: /* Checkpointing */
58    void serialize(CheckpointOut &cp) const override;
59    void unserialize(CheckpointIn &cp) override;
60
61  public: /* IO device interfaces */
62    Tick read(PacketPtr pkt) override;
63    Tick write(PacketPtr pkt) override;
64    AddrRangeList getAddrRanges() const override;
65
66  protected: /* API wrappers/helpers */
67    /**
68     * @{
69     * @name API wrappers
70     */
71
72    /** Wrapper around nomali_reset(). */
73    void reset();
74
75    /** Wrapper around nomali_reg_read(). */
76    uint32_t readReg(nomali_addr_t reg);
77    /** Wrapper around nomali_reg_write(). */
78    void writeReg(nomali_addr_t reg, uint32_t value);
79
80    /** Wrapper around nomali_reg_read_raw(). */
81    uint32_t readRegRaw(nomali_addr_t reg) const;
82    /** Wrapper around nomali_reg_write_raw(). */
83    void writeRegRaw(nomali_addr_t reg, uint32_t value);
84
85    /**
86     * Wrapper around nomali_int_state()
87     *
88     * @param intno Interrupt number
89     * @return True if asserted, false otherwise.
90     */
91    bool intState(nomali_int_t intno);
92
93    /** @} */
94
95    /**
96     * Format a NoMali error into an error message and panic.
97     *
98     * @param err Error code from the NoMali library.
99     * @param msg Message to print.
100     */
101    static void gpuPanic(nomali_error_t err, const char *msg) M5_ATTR_NORETURN;
102    /**
103     * Panic if the NoMali returned an error, do nothing otherwise.
104     *
105     * @param err Error code from the NoMali library.
106     * @param msg Message to print when panicking.
107     */
108    static void panicOnErr(nomali_error_t err, const char *msg) {
109        if (err != NOMALI_E_OK)
110            gpuPanic(err, msg);
111    }
112
113  protected: /* Callbacks */
114    /**
115     * @{
116     * @name Callbacks
117     */
118
119    /**
120     * Interrupt callback from the NoMali library
121     *
122     * This method is called whenever there is an interrupt state change.
123     *
124     * @param intno Interrupt number
125     * @param set True is the interrupt is being asserted, false otherwise.
126     */
127    virtual void onInterrupt(nomali_int_t intno, bool set);
128
129    /** @} */
130
131  private: /* Callback helpers */
132    /** Wrapper around nomali_set_callback() */
133    void setCallback(const nomali_callback_t &callback);
134
135    /**
136     * Interrupt callback from the NoMali library.
137     *
138     * This method calls onInterrupt() on the NoMaliGpu owning this
139     * device.
140     *
141     * @param h NoMali library handle.
142     * @param usr Pointer to an instance of the NoMaliGpu
143     * @param intno GPU interrupt type
144     * @param set Was the interrupt raised (1) or lowered (0)?
145     */
146    static void _interrupt(nomali_handle_t h, void *usr,
147                           nomali_int_t intno, int set);
148  protected:
149    /** Device base address */
150    const Addr pioAddr;
151
152    /** Platform, used to discover GIC */
153    RealView *const platform;
154
155    /** Map between NoMali interrupt types and actual GIC
156     * interrupts */
157    const std::map<nomali_int_t, uint32_t> interruptMap;
158
159    /** Cached information struct from the NoMali library */
160    nomali_info_t nomaliInfo;
161
162    /** Handle of a NoMali library instance */
163    nomali_handle_t nomali;
164};
165
166
167#endif // __DEV_ARM_NOMALI_GPU_HH__
168