gem5 v24.1.0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
rng.hh
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Institute of Computing Technology, Chinese Academy
3 * of Sciences
4 * All rights reserved
5 *
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder. You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions are
17 * met: redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer;
19 * redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution;
22 * neither the name of the copyright holders nor the names of its
23 * contributors may be used to endorse or promote products derived from
24 * this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38
39#ifndef __DEV_VIRTIO_RNG_HH__
40#define __DEV_VIRTIO_RNG_HH__
41
42#include "base/compiler.hh"
43#include "base/random.hh"
44#include "dev/virtio/base.hh"
45
46namespace gem5
47{
48
49struct VirtIORngParams;
50
58{
59 public:
60 typedef VirtIORngParams Params;
61 VirtIORng(const Params &params);
62 virtual ~VirtIORng();
63
64 void readConfig(PacketPtr pkt, Addr cfgOffset);
65
66 protected:
68 static const DeviceId ID_RNG = 0x04;
69
70 protected:
74 class RngQueue : public VirtQueue
75 {
76 public:
77 RngQueue(PortProxy &proxy, ByteOrder bo, uint16_t size,
78 VirtIORng &_parent);
79 virtual ~RngQueue() {}
80
81 void onNotify() { trySend(); }
82
84 void trySend();
85
86 std::string name() const { return parent.name() + ".qRecv"; }
87
88 protected:
90
92 };
95};
96
97} // namespace gem5
98
99#endif // __DEV_VIRTIO_RNG_HH__
virtual std::string name() const
Definition named.hh:47
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition packet.hh:295
This object is a proxy for a port or other object which implements the functional response protocol,...
Definition port_proxy.hh:87
std::shared_ptr< Random > RandomPtr
Definition random.hh:65
static RandomPtr genRandom()
Definition random.hh:68
Base class for all VirtIO-based devices.
Definition base.hh:588
uint16_t DeviceId
Device Type (sometimes known as subsystem ID)
Definition base.hh:599
Virtqueue for data going from the host to the guest.
Definition rng.hh:75
std::string name() const
Definition rng.hh:86
void onNotify()
Notify queue of pending events.
Definition rng.hh:81
void trySend()
Try to send data pending data from the terminal.
Definition rng.cc:73
virtual ~RngQueue()
Definition rng.hh:79
VirtIORng & parent
Definition rng.hh:89
Random::RandomPtr rng
Definition rng.hh:91
VirtIO Rng.
Definition rng.hh:58
virtual ~VirtIORng()
Definition rng.cc:55
VirtIORngParams Params
Definition rng.hh:60
RngQueue qReq
Receive queue for port 0.
Definition rng.hh:94
void readConfig(PacketPtr pkt, Addr cfgOffset)
Read from the configuration space of a device.
Definition rng.cc:66
static const DeviceId ID_RNG
VirtIO device ID.
Definition rng.hh:68
Base wrapper around a virtqueue.
Definition base.hh:303
const Params & params() const
Bitfield< 25, 21 > bo
Definition types.hh:82
Copyright (c) 2024 Arm Limited All rights reserved.
Definition binary32.hh:36
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition types.hh:147

Generated on Mon Jan 13 2025 04:28:36 for gem5 by doxygen 1.9.8