gem5  v21.1.0.2
dma_virt_device.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021 Advanced Micro Devices, Inc.
3  * All rights reserved.
4  *
5  * For use for simulation and test purposes only
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from this
19  * software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef __DEV_DMA_VIRT_DEVICE_HH__
35 #define __DEV_DMA_VIRT_DEVICE_HH__
36 
37 #include "dev/dma_device.hh"
38 
39 namespace gem5
40 {
41 
42 class DmaVirtDevice : public DmaDevice
43 {
44  private:
46 
47  protected:
54  template <class T>
56  {
57  std::function<void(const T &)> _function;
58 
59  virtual void
60  process() override
61  {
63  }
64 
65  public:
67 
68  DmaVirtCallback(const std::function<void(const T &)> &function,
69  T dma_buffer_value = 0)
70  : DmaCallback(), _function(function), dmaBuffer(dma_buffer_value)
71  { }
72  };
73 
74  public:
75  DmaVirtDevice(const Params& p);
76  virtual ~DmaVirtDevice() { }
77 
88  void dmaReadVirt(Addr host_addr, unsigned size, DmaCallback *cb,
89  void *data, Tick delay = 0);
100  void dmaWriteVirt(Addr host_addr, unsigned size, DmaCallback *b,
101  void *data, Tick delay = 0);
102 
103  // Typedefing dmaRead and dmaWrite function pointer
104  typedef void (DmaDevice::*DmaFnPtr)(Addr, int, Event*, uint8_t*, Tick);
105 
118  void dmaVirt(DmaFnPtr dmaFn, Addr host_addr, unsigned size,
119  DmaCallback *cb, void *data, Tick delay = 0);
120 
128  virtual void translateOrDie(Addr vaddr, Addr &paddr) = 0;
129 };
130 
131 } // namespace gem5
132 
133 #endif // __DEV_DMA_VIRT_DEVICE_HH__
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::DmaVirtDevice::DmaVirtCallback
Wraps a std::function object in a DmaCallback.
Definition: dma_virt_device.hh:55
gem5::DmaVirtDevice::DmaVirtCallback::process
virtual void process() override
Callback function invoked on completion of all chunks.
Definition: dma_virt_device.hh:60
gem5::DmaVirtDevice::dmaReadVirt
void dmaReadVirt(Addr host_addr, unsigned size, DmaCallback *cb, void *data, Tick delay=0)
Initiate a DMA read from virtual address host_addr.
Definition: dma_virt_device.cc:45
gem5::DmaVirtDevice::dmaVirt
void dmaVirt(DmaFnPtr dmaFn, Addr host_addr, unsigned size, DmaCallback *cb, void *data, Tick delay=0)
Initiate a call to DmaDevice using DmaFnPtr do a DMA starting from virtual address host_addr for size...
Definition: dma_virt_device.cc:59
gem5::DmaVirtDevice::DmaVirtCallback::_function
std::function< void(const T &)> _function
Definition: dma_virt_device.hh:57
gem5::DmaVirtDevice::translateOrDie
virtual void translateOrDie(Addr vaddr, Addr &paddr)=0
Function used to translate from virtual to physical addresses.
gem5::DmaVirtDevice::DmaVirtCallback::DmaVirtCallback
DmaVirtCallback(const std::function< void(const T &)> &function, T dma_buffer_value=0)
Definition: dma_virt_device.hh:68
gem5::DmaVirtDevice::pageBytes
Addr pageBytes
Definition: dma_virt_device.hh:45
gem5::DmaVirtDevice::DmaVirtCallback::dmaBuffer
T dmaBuffer
Definition: dma_virt_device.hh:66
gem5::DmaVirtDevice::~DmaVirtDevice
virtual ~DmaVirtDevice()
Definition: dma_virt_device.hh:76
dma_device.hh
gem5::ArmISA::b
Bitfield< 7 > b
Definition: misc_types.hh:381
gem5::Event
Definition: eventq.hh:251
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::DmaDevice
Definition: dma_device.hh:203
gem5::DmaDevice::Params
DmaDeviceParams Params
Definition: dma_device.hh:209
gem5::DmaVirtDevice::dmaWriteVirt
void dmaWriteVirt(Addr host_addr, unsigned size, DmaCallback *b, void *data, Tick delay=0)
Initiate a DMA write from virtual address host_addr.
Definition: dma_virt_device.cc:52
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::DmaVirtDevice::DmaFnPtr
void(DmaDevice::* DmaFnPtr)(Addr, int, Event *, uint8_t *, Tick)
Definition: dma_virt_device.hh:104
gem5::DmaVirtDevice::DmaVirtDevice
DmaVirtDevice(const Params &p)
Definition: dma_virt_device.cc:39
gem5::DmaCallback
DMA callback class.
Definition: dma_device.hh:260
gem5::DmaVirtDevice
Definition: dma_virt_device.hh:42
gem5::MipsISA::vaddr
vaddr
Definition: pra_constants.hh:278
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

Generated on Tue Sep 21 2021 12:25:15 for gem5 by doxygen 1.8.17