gem5  v22.1.0.0
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 "dev/virtio/base.hh"
44 
45 namespace gem5
46 {
47 
48 struct VirtIORngParams;
49 
56 class VirtIORng : public VirtIODeviceBase
57 {
58  public:
59  typedef VirtIORngParams Params;
61  virtual ~VirtIORng();
62 
63  void readConfig(PacketPtr pkt, Addr cfgOffset);
64 
65  protected:
67  static const DeviceId ID_RNG = 0x04;
68 
69  protected:
73  class RngQueue
74  : 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  RngQueue qReq;
93 };
94 
95 } // namespace gem5
96 
97 #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:294
This object is a proxy for a port or other object which implements the functional response protocol,...
Definition: port_proxy.hh:87
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 2.hh:75
std::string name() const
Definition: rng.hh:86
void onNotify()
Notify queue of pending events.
Definition: rng.hh:81
RngQueue(PortProxy &proxy, ByteOrder bo, uint16_t size, VirtIORng &_parent)
void trySend()
Try to send data pending data from the terminal.
Definition: rng 2.cc:74
VirtIORng & parent
Definition: rng 2.hh:89
virtual ~RngQueue()
Definition: rng.hh:79
VirtIO Rng.
Definition: rng 2.hh:57
VirtIORngParams Params
Definition: rng.hh:59
RngQueue qReq
Receive queue for port 0.
Definition: rng 2.hh:92
virtual ~VirtIORng()
static const DeviceId ID_RNG
VirtIO device ID.
Definition: rng 2.hh:67
VirtIORng(const Params &params)
void readConfig(PacketPtr pkt, Addr cfgOffset)
Read from the configuration space of a device.
Base wrapper around a virtqueue.
Definition: base.hh:303
const Params & params() const
Definition: sim_object.hh:176
Bitfield< 25, 21 > bo
Definition: types.hh:82
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147

Generated on Wed Dec 21 2022 10:22:35 for gem5 by doxygen 1.9.1