dxd::multichannel::stream< channel_t >::umap< stream_t > Class Template Reference

stream user mapping More...

#include <dxd_stream.h>

Inheritance diagram for dxd::multichannel::stream< channel_t >::umap< stream_t >:

Collaboration diagram for dxd::multichannel::stream< channel_t >::umap< stream_t >:

Classes
class	channel
	one channel's double buffer, mapped into the kernel and into the client - the planar buffers a kernel streaming client exchanges instead of the ring More...

Public Member Functions
void	free ()
os_result	initialize (client &, const dx::os_event &os_event)
os_result	initialize (::IOMemoryDescriptor *io_memory_descriptor, size_t offset=0, size_t size=0, uint64_t alignment=0, void *address=nullptr)
	DriverKit map initializer.
template<typename bus_t>
os_result	initialize (unsigned int iosize, unsigned int channels, dx::stream::channel::opened< channel_t > &opened, const dx::stream::channel::open< bus_t > &open)
	kernel streaming channel buffer creator
	operator const dx::circular * () const
	operator const::IOMemoryMap * () const
	operator dx::circular * () const
const dx::circular *	operator-> () const
	operator to use mapping like pointer
	operator::IOMemoryMap * ()
template<typename reference_t>
int	release (reference_t &reference)
os_result	reset ()
void	retain ()
os_result	signal () override
size_t	size () const
	DriverKit mapping size.
os_result	start ()
os_result	stop (bool force=false)
void	trace_outs () const
	umap (client &client, const dx::os_event &os_event, stream_t *&stream)
	~umap ()

Public Attributes
struct {
uint64_t *   channel_map
channel_t **   out [2]
}	cache
dxd::multichannel::stream::umap::channel *	channel [2]
	kernel out streaming channel double buffers
dxd::map< dx::user, dx::stream::channel::control >	control
atomic< int >	references {}
os_result	status {not_initialized}
os_result	status
	status of mapping object

Protected Attributes
dx::circular *	_vm
	DriverKit virtual address mapping.
::IOMemoryMap *	io_memory_map
stream *&	stream
	auto nulling reference

Detailed Description

template<typename channel_t = int>
template<typename stream_t = stream>
class dxd::multichannel::stream< channel_t >::umap< stream_t >

stream user mapping

Constructor & Destructor Documentation

umap()

template<typename channel_t = int>

template<typename stream_t = stream>

dxd::multichannel::stream< channel_t >::umap< stream_t >::umap ( client & client, const dx::os_event & os_event, stream_t *& stream )

inline

~umap()

template<typename channel_t = int>

template<typename stream_t = stream>

dxd::multichannel::stream< channel_t >::umap< stream_t >::~umap ( )

inline

Here is the call graph for this function:

Member Function Documentation

free()

template<typename channel_t = int>

template<typename stream_t = stream>

void dxd::multichannel::stream< channel_t >::umap< stream_t >::free ( )

inline

detach from stream out channel array

remove channel array: in: removes user mapping from stream owned channel in buffers out: remove channel array: removes channel buffer and mappings

detach from stream owned channel in buffers

de-allocate channel map;

clear channel traces

Here is the caller graph for this function:

initialize() [1/3]

os_result dxd::event< dx::user >::initialize ( client & , const dx::os_event< dx::user > & os_event )

inlineinherited

initialize() [2/3]

os_result dxd::map< scope_t, dx::circular >::initialize ( ::IOMemoryDescriptor * io_memory_descriptor, size_t offset = 0, size_t size = 0, uint64_t alignment = 0, void * address = nullptr )

inlineinherited

DriverKit map initializer.

map<kernel> maps an IOMemoryDescriptor (typically cast of a dxd::memory or buffer class) into the DriverKit address space.

            kIOMemoryMapFixedAddress map at the address requested
            kIOMemoryMapReadOnly create a read only mapping
            kIOMemoryMapCacheModeDefault default cache mode
            kIOMemoryMapCacheModeInhibit inhibited cache mode
            kIOMemoryMapCacheModeCopyback copyback cache mode
            kIOMemoryMapCacheModeWriteThrough write through cache mode

Allows re-initialization.

Checks buffer object,

maps the buffer into the DriverKit (will fail if offset is given)

and obtains a DriverKit virtual address (apply offset here instead).

Parameters

io_memory_descriptor	IOMemoryDescriptor to be mapped into the DriverKit address space
offset	offset into memory descriptor to create mapping
size	size of mapping

initialize() [3/3]

template<typename channel_t = int>

template<typename stream_t = stream>

template<typename bus_t>

os_result dxd::multichannel::stream< channel_t >::umap< stream_t >::initialize ( unsigned int iosize, unsigned int channels, dx::stream::channel::opened< channel_t > & opened, const dx::stream::channel::open< bus_t > & open )

inline

kernel streaming channel buffer creator

Parameters

channels

stream channels

Here is the call graph for this function:

operator const dx::circular *()

dxd::map< scope_t, dx::circular >::operator const dx::circular * ( ) const

inlineinherited

operator const::IOMemoryMap *()

dxd::map< scope_t, dx::circular >::operator const::IOMemoryMap * ( ) const

inlineinherited

operator dx::circular *()

dxd::map< scope_t, dx::circular >::operator dx::circular * ( ) const

inlineinherited

operator->()

const dx::circular * dxd::map< scope_t, dx::circular >::operator-> ( ) const

inlineinherited

operator to use mapping like pointer

operator::IOMemoryMap *()

dxd::map< scope_t, dx::circular >::operator::IOMemoryMap * ( )

inlineinherited

release()

template<typename reference_t>

int dxd::referenced::release ( reference_t & reference )

inlineinherited

reset()

os_result dxd::event< dx::user >::reset ( )

inlineinherited

retain()

void dxd::referenced::retain ( )

inlineinherited

signal()

os_result dxd::event< dx::user >::signal ( )

inlineoverridevirtualinherited

Implements dxd::abstract::event.

Here is the caller graph for this function:

size()

size_t dxd::map< scope_t, dx::circular >::size ( ) const

inlineinherited

DriverKit mapping size.

start()

os_result dxd::stream::umap< stream >::start ( )

inlineinherited

stop()

os_result dxd::stream::umap< stream >::stop ( bool force = false )

inlineinherited

Here is the caller graph for this function:

trace_outs()

template<typename channel_t = int>

template<typename stream_t = stream>

void dxd::multichannel::stream< channel_t >::umap< stream_t >::trace_outs ( ) const

inline

Member Data Documentation

_vm

dx::circular* dxd::map< scope_t, dx::circular >::_vm

protectedinherited

DriverKit virtual address mapping.

[struct]

struct { ... } dxd::multichannel::stream< channel_t >::umap< stream_t >::cache

channel

template<typename channel_t = int>

template<typename stream_t = stream>

dxd::multichannel::stream::umap::channel* dxd::multichannel::stream< channel_t >::umap< stream_t >::channel[2]

kernel out streaming channel double buffers

channel_map

template<typename channel_t = int>

template<typename stream_t = stream>

uint64_t* dxd::multichannel::stream< channel_t >::umap< stream_t >::channel_map

control

template<typename channel_t = int>

template<typename stream_t = stream>

dxd::map<dx::user, dx::stream::channel::control> dxd::multichannel::stream< channel_t >::umap< stream_t >::control

io_memory_map

::IOMemoryMap* dxd::map< scope_t, dx::circular >::io_memory_map

protectedinherited

out

template<typename channel_t = int>

template<typename stream_t = stream>

channel_t** dxd::multichannel::stream< channel_t >::umap< stream_t >::out[2]

references

atomic<int> dxd::referenced::references {}

inherited

status [1/2]

os_result dxd::event< dx::user >::status {not_initialized}

inherited

status [2/2]

os_result dxd::map< scope_t, dx::circular >::status

inherited

status of mapping object

stream

stream*& dxd::stream::umap< stream >::stream

protectedinherited

auto nulling reference

---

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

• dxd_stream.h