dxd - dynax driver framework 3.0.2
cross platform open source driver development framework
Loading...
Searching...
No Matches
dxd::map< dx::user, vm_t > Class Template Reference

a buffer as its client sees it: a dext cannot map into its client, so the address stays empty More...

#include <dxd_memory.h>

Inheritance diagram for dxd::map< dx::user, vm_t >:
Collaboration diagram for dxd::map< dx::user, vm_t >:

Public Member Functions

::IOMemoryDescriptor* copy() const
 the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on
void free()
void free()
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0)
os_result initialize(::MDL* mdl, size_t offset= 0)
 map()= default
 map()= default
 map(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0)
 map(::MDL* mdl, size_t offset= 0)
 operator const ::IOMemoryMap*() const
 operator const vm_t*() const
 operator vm_t*() const
const vm_t* operator ->() const
 operator to use mapping like pointer
 operator ::IOMemoryMap*()
size_t size() const
 DriverKit mapping size.
 ~map()
 ~map()

Public Attributes

os_result status{not_initialized}

Protected Attributes

vm_t* _vm
 DriverKit virtual address mapping.
::IOMemoryMap* io_memory_map

Detailed Description

template<typename vm_t>
class dxd::map< dx::user, vm_t >

a buffer as its client sees it: a dext cannot map into its client, so the address stays empty

WDK: user space memory mapping.

The client maps the descriptor itself - its memory type names it, IOUserClient::CopyClientMemoryForType hands it out - which is why an opened answer from a dext carries no address and the client maps by type.

Constructor & Destructor Documentation

◆ map() [1/4]

template<typename vm_t>
dxd::map<dx::user, vm_t>::map()
default

◆ map() [2/4]

template<typename vm_t>
dxd::map<dx::user, vm_t>::map(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0)
inline
Here is the call graph for this function:

◆ ~map() [1/2]

template<typename vm_t>
dxd::map<dx::user, vm_t>::~map()
inline
Here is the call graph for this function:

◆ map() [3/4]

template<typename vm_t>
dxd::map<dx::user, vm_t>::map()
default

◆ map() [4/4]

template<typename vm_t>
dxd::map<dx::user, vm_t>::map(::MDL* mdl, size_t offset= 0)
inline
Parameters
offsetMDL describing user space mapping to be createdoffset into memory descriptor to create mapping
Here is the call graph for this function:

◆ ~map() [2/2]

template<typename vm_t>
dxd::map<dx::user, vm_t>::~map()
inline
Here is the call graph for this function:

Member Function Documentation

◆ copy()

template<typename vm_t>
::IOMemoryDescriptor* dxd::map<dx::user, vm_t>::copy() const
inline

the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on

◆ free() [1/2]

template<typename vm_t>
void dxd::map<dx::user, vm_t>::free()
inline
Here is the caller graph for this function:

◆ free() [2/2]

template<typename vm_t>
void dxd::map<dx::user, vm_t>::free()
inline

◆ initialize() [1/2]

template<typename vm_t>
os_result dxd::map<dx::user, vm_t>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0)
inline
Here is the call graph for this function:
Here is the caller graph for this function:

◆ initialize() [2/2]

template<typename vm_t>
os_result dxd::map<dx::user, vm_t>::initialize(::MDL* mdl, size_t offset= 0)
inline
Parameters
offsetMDL describing user space mapping to be createdoffset into memory descriptor to create mapping
Here is the call graph for this function:

◆ operator const ::IOMemoryMap *()

dxd::map<scope_t, vm_t>::operator const ::IOMemoryMap*() const
inline

◆ operator const vm_t *()

dxd::map<scope_t, vm_t>::operator const vm_t*() const
inline

◆ operator vm_t *()

template<typename vm_t>
dxd::map<dx::user, vm_t>::operator vm_t*() const
inline

◆ operator ->()

const vm_t* dxd::map<scope_t, vm_t>::operator ->() const
inline

operator to use mapping like pointer

◆ operator ::IOMemoryMap *()

dxd::map<scope_t, vm_t>::operator ::IOMemoryMap*()
inline

◆ size()

size_t dxd::map<scope_t, vm_t>::size() const
inline

DriverKit mapping size.

Member Data Documentation

◆ _vm

vm_t* dxd::map<scope_t, vm_t>::_vm
protected

DriverKit virtual address mapping.

◆ io_memory_map

::IOMemoryMap* dxd::map<scope_t, vm_t>::io_memory_map
protected

◆ status

template<typename vm_t>
os_result dxd::map<dx::user, vm_t>::status{not_initialized}

The documentation for this class was generated from the following files: