#include <NSUKit.h>

类 nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t > 继承关系图:

Public 成员函数
	NSUSoc ()

	~NSUSoc ()

nsukitStatus_t	link_cmd (nsuInitParam_t *param) override

nsukitStatus_t	unlink_cmd () override

nsukitStatus_t	link_stream (nsuInitParam_t *param) override

nsukitStatus_t	unlink_stream () override

nsukitStatus_t	write (nsuRegAddr_t addr, nsuRegValue_t value) override

nsukitStatus_t	read (nsuRegAddr_t addr, nsuRegValue_t *buf) override

nsukitStatus_t	bulk_write (nsuRegAddr_t base, nsuCharBuf_p values, nsuSize_t length, nsuBulkMode mode=nsuBulkMode::INCREMENT) override

nsukitStatus_t	bulk_read (nsuRegAddr_t base, nsuSize_t length, nsuVoidBuf_p buf=nullptr, nsuBulkMode mode=nsuBulkMode::INCREMENT) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint8_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int8_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint16_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int16_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint32_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int32_t &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const double &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const float &value) override

nsukitStatus_t	set_param (nsuCSParam_t &param_name, const std::string &value) override

uint8_t	get_param (nsuCSParam_t &param_name, uint8_t _default=0) override

int8_t	get_param (nsuCSParam_t &param_name, int8_t _default=0) override

uint16_t	get_param (nsuCSParam_t &param_name, uint16_t _default=0) override

int16_t	get_param (nsuCSParam_t &param_name, int16_t _default=0) override

uint32_t	get_param (nsuCSParam_t &param_name, uint32_t _default=0) override

int32_t	get_param (nsuCSParam_t &param_name, int32_t _default=0) override

double	get_param (nsuCSParam_t &param_name, double _default=0.) override

float	get_param (nsuCSParam_t &param_name, float _default=0.) override

std::string	get_param (nsuCSParam_t &param_name, std::string _default="") override

nsukitStatus_t	execute (nsuCSParam_t cname) override

nsuMemory_p	alloc_buffer (nsuStreamLen_t length, nsuVoidBuf_p buf=nullptr) override

nsukitStatus_t	free_buffer (nsuMemory_p fd) override

nsuVoidBuf_p	get_buffer (nsuMemory_p fd, nsuStreamLen_t length=0) override

nsukitStatus_t	stream_recv (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0, bool(*stop_event)()=nullptr, int flag=1) override

nsukitStatus_t	stream_send (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0, bool(*stop_event)()=nullptr, int flag=1) override

nsukitStatus_t	open_send (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0) override

nsukitStatus_t	open_recv (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0) override

nsukitStatus_t	wait_stream (nsuMemory_p fd, float timeout=0.) override

nsukitStatus_t	break_stream (nsuMemory_p fd) override

virtual nsukitStatus_t	link_cmd (nsuInitParam_t *param)

virtual nsukitStatus_t	unlink_cmd ()

virtual nsukitStatus_t	link_stream (nsuInitParam_t *param)

virtual nsukitStatus_t	unlink_stream ()

virtual nsukitStatus_t	write (nsuRegAddr_t addr, nsuRegValue_t value)

virtual nsukitStatus_t	read (nsuRegAddr_t addr, nsuRegValue_t *buf)

virtual nsukitStatus_t	bulk_write (nsuRegAddr_t base, nsuCharBuf_p values, nsuSize_t length, nsuBulkMode mode=nsuBulkMode::INCREMENT)

virtual nsukitStatus_t	bulk_read (nsuRegAddr_t base, nsuSize_t length, nsuVoidBuf_p buf=nullptr, nsuBulkMode mode=nsuBulkMode::INCREMENT)

virtual uint8_t	get_param (nsuCSParam_t &param_name, uint8_t _default=0)

virtual int8_t	get_param (nsuCSParam_t &param_name, int8_t _default=0)

virtual uint16_t	get_param (nsuCSParam_t &param_name, uint16_t _default=0)

virtual int16_t	get_param (nsuCSParam_t &param_name, int16_t _default=0)

virtual uint32_t	get_param (nsuCSParam_t &param_name, uint32_t _default=0)

virtual int32_t	get_param (nsuCSParam_t &param_name, int32_t _default=0)

virtual double	get_param (nsuCSParam_t &param_name, double _default=0.)

virtual float	get_param (nsuCSParam_t &param_name, float _default=0.)

virtual std::string	get_param (nsuCSParam_t &param_name, std::string _default="")

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint8_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int8_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint16_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int16_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const uint32_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const int32_t &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const double &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const float &value)

virtual nsukitStatus_t	set_param (nsuCSParam_t &param_name, const std::string &value)

virtual nsukitStatus_t	execute (nsuCSParam_t cname)

virtual nsuMemory_p	alloc_buffer (nsuStreamLen_t length, nsuVoidBuf_p buf=nullptr)

virtual nsukitStatus_t	free_buffer (nsuMemory_p fd)

virtual nsuVoidBuf_p	get_buffer (nsuMemory_p fd, nsuStreamLen_t length=0)

virtual nsukitStatus_t	stream_recv (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0, bool(*stop_event)()=nullptr, int flag=1)

virtual nsukitStatus_t	stream_send (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0, bool(*stop_event)()=nullptr, int flag=1)

virtual nsukitStatus_t	open_send (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0)

virtual nsukitStatus_t	open_recv (nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0)

virtual nsukitStatus_t	wait_stream (nsuMemory_p fd, float timeout=0.)

virtual nsukitStatus_t	break_stream (nsuMemory_p fd)

Protected 成员函数
bool	check_typesafe ()

bool	combined_cmd_itf ()

Protected 属性
CmdMw_t *	mw_cmd

ChnlMw_t *	mw_chnl

CSItf_t *	itf_cs

CRItf_t *	itf_cr

DSItf_t *	itf_ds

详细描述

template<class CSItf_t, class CRItf_t, class DSItf_t, class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>
class nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >

模板参数

CSItf_t	nsukit::I_BaseCmdUItf 的子类
CRItf_t	nsukit::I_BaseCmdUItf 的子类
DSItf_t	nsukit::I_BaseStreamUItf 的子类
CmdMw_t	nsukit::I_BaseRegMw 的子类
ChnlMw_t	nsukit::I_BaseStreamMw 的子类

在文件 NSUKit.h 第 31 行定义.

构造及析构函数说明

◆ NSUSoc()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::NSUSoc

在文件 NSUKit.h 第 296 行定义.

◆ ~NSUSoc()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::~NSUSoc

在文件 NSUKit.h 第 316 行定义.

成员函数说明

◆ alloc_buffer()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsuMemory_p nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::alloc_buffer	(	nsuStreamLen_t	length,
		nsuVoidBuf_p	buf = `nullptr`
	)

overridevirtual

申请一片数据流用的内存

参数

length	要申请的内存长度单位Bytes
buf	外部填入一片申请好的内存首地址指针，可为null，不为null时，代表指定一片内存，作为数据流专用内存

返回: 数据流内存标识

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 575 行定义.

◆ break_stream()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::break_stream ( nsuMemory_p fd )

overridevirtual

终止一次数据流交互

参数

fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 672 行定义.

◆ bulk_read()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::bulk_read	(	nsuRegAddr_t	base,
		nsuSize_t	length,
		nsuVoidBuf_p	buf = `nullptr`,
		nsuBulkMode	mode = `nsuBulkMode::INCREMENT`
	)

overridevirtual

块读取

参数

base	块读取的基地址
length	要读取的数据长度
buf	读取缓存
mode	块读取入模式

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 449 行定义.

◆ bulk_write()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::bulk_write	(	nsuRegAddr_t	base,
		nsuCharBuf_p	values,
		nsuSize_t	length,
		nsuBulkMode	mode = `nsuBulkMode::INCREMENT`
	)

overridevirtual

块写入

参数

base	块写入的基地址
values	要写入的一串值，char*
length	要写入的数据长度
mode	- 块写入模式 nsuBulkMode::INCREMENT 从基地址开始递增写入数据 nsuBulkMode::LOOP 将数据依次写入单个基地址

返回: nsukitStatus_t

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 435 行定义.

◆ check_typesafe()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

bool nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::check_typesafe ( )

inlineprotected

在文件 NSUKit.h 第 48 行定义.

◆ combined_cmd_itf()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

bool nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::combined_cmd_itf ( )

inlineprotected

在文件 NSUKit.h 第 53 行定义.

◆ execute()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::execute ( nsuCSParam_t cname )

overridevirtual

参数

name
value

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 463 行定义.

◆ free_buffer()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::free_buffer ( nsuMemory_p fd )

overridevirtual

根据内存标识释放对应的内存

参数

fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 585 行定义.

◆ get_buffer()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsuVoidBuf_p nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_buffer	(	nsuMemory_p	fd,
		nsuStreamLen_t	length = `0`
	)

overridevirtual

获取数据流内存标识的真实内存首指针

参数

fd	数据流内存标识，nsukit::NSUSoc::alloc_buffer申请到的内存标识
length	所需数据流内存长度

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 597 行定义.

◆ get_param() [1/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

double nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		double	_default = `0.`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 509 行定义.

◆ get_param() [2/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

float nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		float	_default = `0.`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 515 行定义.

◆ get_param() [3/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

int16_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		int16_t	_default = `0`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 491 行定义.

◆ get_param() [4/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

int32_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		int32_t	_default = `0`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 503 行定义.

◆ get_param() [5/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

int8_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		int8_t	_default = `0`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 479 行定义.

◆ get_param() [6/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

std::string nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		std::string	_default = `""`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 521 行定义.

◆ get_param() [7/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

uint16_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		uint16_t	_default = `0`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 485 行定义.

◆ get_param() [8/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

uint32_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		uint32_t	_default = `0`
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 497 行定义.

◆ get_param() [9/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

uint8_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::get_param	(	nsuCSParam_t &	param_name,
		uint8_t	_default = `0`
	)

overridevirtual

参数

name
value

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 473 行定义.

◆ link_cmd()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::link_cmd ( nsuInitParam_t * param )

overridevirtual

发送指令前准备

根据目标设备类型、参数建立链接

#include "NSUKit.h"
 
auto kit = NSUKit::NSUSoc<PCIECmdUItf, PCIEStreamUItf>();
nsukitStatus_t status;
nsuXDMAParam_t param {};
param.board = 0;
status = kit.link_cmd(&param);
status = kit.write(0x00000035, 15);

参数

param

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 328 行定义.

◆ link_stream()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::link_stream ( nsuInitParam_t * param )

overridevirtual

开启数据流之前准备

根据目标设备类型、参数建立链接

参数

param

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 376 行定义.

◆ open_recv()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::open_recv	(	nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = `0`
	)

overridevirtual

异步开启一次数据流上行

参数

chnl	数据流通道
fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识
length	数据流上行数据量，单位Byte
offset	数据流上行到fd中对应的偏移量

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 648 行定义.

◆ open_send()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::open_send	(	nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = `0`
	)

overridevirtual

异步开启一次数据流下行

参数

chnl	数据流通道
fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识
length	数据流下行数据量，单位Byte
offset	从fd中对应的偏移量下行

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 635 行定义.

◆ read()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::read	(	nsuRegAddr_t	addr,
		nsuRegValue_t *	buf
	)

overridevirtual

读寄存器

参数

addr	读取寄存器地址
buf	要接收读取值的buffer

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 423 行定义.

◆ set_param() [1/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const double &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 557 行定义.

◆ set_param() [2/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const float &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 562 行定义.

◆ set_param() [3/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const int16_t &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 542 行定义.

◆ set_param() [4/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const int32_t &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 552 行定义.

◆ set_param() [5/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const int8_t &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 532 行定义.

◆ set_param() [6/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const std::string &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 567 行定义.

◆ set_param() [7/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const uint16_t &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 537 行定义.

◆ set_param() [8/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const uint32_t &	value
	)

overridevirtual

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 547 行定义.

◆ set_param() [9/9]

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::set_param	(	nsuCSParam_t &	param_name,
		const uint8_t &	value
	)

overridevirtual

参数

name
value

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 527 行定义.

◆ stream_recv()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::stream_recv	(	nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = `0`,
		bool(*)()	stop_event = `nullptr`,
		int	flag = `1`
	)

overridevirtual

阻塞式开启一次数据流上行

参数

chnl	数据流通道号
fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识
length	要上行的数据长度
offset	上行数据到内存的首地址偏移值
stop_event	停止函数
flag	预留

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 607 行定义.

◆ stream_send()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::stream_send	(	nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = `0`,
		bool(*)()	stop_event = `nullptr`,
		int	flag = `1`
	)

overridevirtual

开启一次阻塞式数据流下行

参数

chnl	数据流通道
fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识
length	数据流下行数据量，单位Byte
offset	从fd中对应的偏移量下行
stop_event	函数指针，停止event

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 621 行定义.

◆ unlink_cmd()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::unlink_cmd

overridevirtual

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 358 行定义.

◆ unlink_stream()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::unlink_stream

overridevirtual

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 402 行定义.

◆ wait_stream()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::wait_stream	(	nsuMemory_p	fd,
		float	timeout = `0.`
	)

overridevirtual

等待fd对应的数据流交互完成

参数

fd	nsukit::NSUSoc::alloc_buffer申请到的内存标识
timeout

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 661 行定义.

◆ write()

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t , class ChnlMw_t >

nsukitStatus_t nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::write	(	nsuRegAddr_t	addr,
		nsuRegValue_t	value
	)

overridevirtual

写寄存器

按照输入的地址、值进行写寄存器

参数

addr	写入寄存器地址，u32
value	写入寄存器值，32b

返回

重载 nsukit::BaseKit .

在文件 NSUKit.h 第 414 行定义.

类成员变量说明

◆ itf_cr

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

CRItf_t* nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::itf_cr

protected

在文件 NSUKit.h 第 45 行定义.

◆ itf_cs

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

CSItf_t* nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::itf_cs

protected

在文件 NSUKit.h 第 44 行定义.

◆ itf_ds

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

DSItf_t* nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::itf_ds

protected

在文件 NSUKit.h 第 46 行定义.

◆ mw_chnl

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

ChnlMw_t* nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::mw_chnl

protected

在文件 NSUKit.h 第 43 行定义.

◆ mw_cmd

template<class CSItf_t , class CRItf_t , class DSItf_t , class CmdMw_t = ICDRegMw, class ChnlMw_t = VirtualChnlMw>

CmdMw_t* nsukit::NSUSoc< CSItf_t, CRItf_t, DSItf_t, CmdMw_t, ChnlMw_t >::mw_cmd

protected

在文件 NSUKit.h 第 42 行定义.

该类的文档由以下文件生成:

D:/Work/CppProject/NSUKit/include/NSUKit.h

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ NSUSoc()

◆ ~NSUSoc()

成员函数说明

◆ alloc_buffer()

◆ break_stream()

◆ bulk_read()

◆ bulk_write()

◆ check_typesafe()

◆ combined_cmd_itf()

◆ execute()

◆ free_buffer()

◆ get_buffer()

◆ get_param() [1/9]

◆ get_param() [2/9]

◆ get_param() [3/9]

◆ get_param() [4/9]

◆ get_param() [5/9]

◆ get_param() [6/9]

◆ get_param() [7/9]

◆ get_param() [8/9]

◆ get_param() [9/9]

◆ link_cmd()

◆ link_stream()

◆ open_recv()

◆ open_send()

◆ read()

◆ set_param() [1/9]

◆ set_param() [2/9]

◆ set_param() [3/9]

◆ set_param() [4/9]

◆ set_param() [5/9]

◆ set_param() [6/9]

◆ set_param() [7/9]

◆ set_param() [8/9]

◆ set_param() [9/9]

◆ stream_recv()

◆ stream_send()

◆ unlink_cmd()

◆ unlink_stream()

◆ wait_stream()

◆ write()

类成员变量说明

◆ itf_cr

◆ itf_cs

◆ itf_ds

◆ mw_chnl

◆ mw_cmd