gem5  v22.0.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  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its
16  * contributors may be used to endorse or promote products derived from this
17  * software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef __DEV_DMA_VIRT_DEVICE_HH__
33 #define __DEV_DMA_VIRT_DEVICE_HH__
34 
35 #include "dev/dma_device.hh"
36 #include "mem/translation_gen.hh"
37 
38 namespace gem5
39 {
40 
41 class DmaVirtDevice : public DmaDevice
42 {
43  protected:
50  template <class T>
52  {
53  std::function<void(const T &)> _function;
54 
55  virtual void
56  process() override
57  {
59  }
60 
61  public:
63 
64  DmaVirtCallback(const std::function<void(const T &)> &function,
65  T dma_buffer_value = 0)
66  : DmaCallback(), _function(function), dmaBuffer(dma_buffer_value)
67  { }
68  };
69 
70  public:
71  DmaVirtDevice(const Params& p) : DmaDevice(p) { }
72  virtual ~DmaVirtDevice() { }
73 
84  void dmaReadVirt(Addr host_addr, unsigned size, DmaCallback *cb,
85  void *data, Tick delay = 0);
96  void dmaWriteVirt(Addr host_addr, unsigned size, DmaCallback *b,
97  void *data, Tick delay = 0);
98 
99  // Typedefing dmaRead and dmaWrite function pointer
100  typedef void (DmaDevice::*DmaFnPtr)(Addr, int, Event*, uint8_t*, Tick);
101 
114  void dmaVirt(DmaFnPtr dmaFn, Addr host_addr, unsigned size,
115  DmaCallback *cb, void *data, Tick delay = 0);
116 
126  virtual TranslationGenPtr translate(Addr vaddr, Addr size) = 0;
127 };
128 
129 } // namespace gem5
130 
131 #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:51
gem5::DmaVirtDevice::DmaVirtCallback::process
virtual void process() override
Callback function invoked on completion of all chunks.
Definition: dma_virt_device.hh:56
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:38
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:52
gem5::DmaVirtDevice::DmaVirtCallback::_function
std::function< void(const T &)> _function
Definition: dma_virt_device.hh:53
gem5::DmaVirtDevice::DmaVirtCallback::DmaVirtCallback
DmaVirtCallback(const std::function< void(const T &)> &function, T dma_buffer_value=0)
Definition: dma_virt_device.hh:64
gem5::DmaVirtDevice::DmaVirtCallback::dmaBuffer
T dmaBuffer
Definition: dma_virt_device.hh:62
gem5::DmaVirtDevice::translate
virtual TranslationGenPtr translate(Addr vaddr, Addr size)=0
Function used to translate a range of addresses from virtual to physical addresses.
gem5::DmaVirtDevice::~DmaVirtDevice
virtual ~DmaVirtDevice()
Definition: dma_virt_device.hh:72
dma_device.hh
gem5::ArmISA::b
Bitfield< 7 > b
Definition: misc_types.hh:382
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
gem5::Event
Definition: eventq.hh:251
translation_gen.hh
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:45
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:100
gem5::DmaVirtDevice::DmaVirtDevice
DmaVirtDevice(const Params &p)
Definition: dma_virt_device.hh:71
gem5::DmaCallback
DMA callback class.
Definition: dma_device.hh:260
gem5::DmaVirtDevice
Definition: dma_virt_device.hh:41
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: gpu_translation_state.hh:37
gem5::TranslationGenPtr
std::unique_ptr< TranslationGen > TranslationGenPtr
Definition: translation_gen.hh:128

Generated on Thu Jul 28 2022 13:32:31 for gem5 by doxygen 1.8.17