nirio_driver_iface Namespace Reference

Classes
struct	rio_mmap_t

Typedefs
typedef io_connect_t	rio_dev_handle_t

Functions
nirio_status	rio_open (const std::string &device_path, rio_dev_handle_t &device_handle)
void	rio_close (rio_dev_handle_t &device_handle)
bool	rio_isopen (rio_dev_handle_t device_handle)
nirio_status	rio_ioctl (rio_dev_handle_t device_handle, uint32_t ioctl_code, const void *write_buf, size_t write_buf_len, void *read_buf, size_t read_buf_len)
nirio_status	rio_mmap (rio_dev_handle_t device_handle, uint16_t memory_type, size_t size, bool writable, rio_mmap_t &map)
nirio_status	rio_munmap (rio_mmap_t &map)

Variables
const uint32_t	NIRIO_IOCTL_BASE = 0x800
const uint32_t	NIRIO_IOCTL_SYNCOP
const uint32_t	NIRIO_IOCTL_GET_IFACE_NUM
	Get the interface number for a device. More...
const uint32_t	NIRIO_IOCTL_GET_SESSION
	Gets a previously opened session to a device. More...
const uint32_t	NIRIO_IOCTL_POST_OPEN
	Called after opening a session. More...
const uint32_t	NIRIO_IOCTL_PRE_CLOSE
	Called before closing a session. More...

Typedef Documentation

rio_dev_handle_t

typedef io_connect_t nirio_driver_iface::rio_dev_handle_t

Function Documentation

rio_close()

void nirio_driver_iface::rio_close

(

rio_dev_handle_t &

device_handle

)

rio_ioctl()

nirio_status nirio_driver_iface::rio_ioctl	(	rio_dev_handle_t	device_handle,
		uint32_t	ioctl_code,
		const void *	write_buf,
		size_t	write_buf_len,
		void *	read_buf,
		size_t	read_buf_len
	)

rio_isopen()

bool nirio_driver_iface::rio_isopen

(

rio_dev_handle_t

device_handle

)

rio_mmap()

nirio_status nirio_driver_iface::rio_mmap	(	rio_dev_handle_t	device_handle,
		uint16_t	memory_type,
		size_t	size,
		bool	writable,
		rio_mmap_t &	map
	)

rio_munmap()

nirio_status nirio_driver_iface::rio_munmap

(

rio_mmap_t &

map

)

rio_open()

nirio_status nirio_driver_iface::rio_open	(	const std::string &	device_path,
		rio_dev_handle_t &	device_handle
	)

Variable Documentation

NIRIO_IOCTL_BASE

const uint32_t nirio_driver_iface::NIRIO_IOCTL_BASE = 0x800

NIRIO_IOCTL_GET_IFACE_NUM

const uint32_t nirio_driver_iface::NIRIO_IOCTL_GET_IFACE_NUM

Initial value:

=
   


( NIRIO_IOCTL_BASE + 6 )

Get the interface number for a device.

NIRIO_IOCTL_GET_SESSION

const uint32_t nirio_driver_iface::NIRIO_IOCTL_GET_SESSION

Initial value:

=
   


( NIRIO_IOCTL_BASE + 8 )

Gets a previously opened session to a device.

NIRIO_IOCTL_POST_OPEN

const uint32_t nirio_driver_iface::NIRIO_IOCTL_POST_OPEN

Initial value:

=
   


( NIRIO_IOCTL_BASE + 9 )

Called after opening a session.

NIRIO_IOCTL_PRE_CLOSE

const uint32_t nirio_driver_iface::NIRIO_IOCTL_PRE_CLOSE

Initial value:

=
   


( NIRIO_IOCTL_BASE + 10 )

Called before closing a session.

NIRIO_IOCTL_SYNCOP

const uint32_t nirio_driver_iface::NIRIO_IOCTL_SYNCOP

Initial value:

=
   


( NIRIO_IOCTL_BASE + 4 )

The synchronous operation code. Note: We must use METHOD_OUT_DIRECT on the syncOp() IOCTL to ensure the contents of the output block are available in the kernel.