InterfacePP::ringout Class Reference

Public Member Functions
	ringout (uintptr_t address, uint32_t size, uint32_t status)
virtual	~ringout ()=default
	standard deconstructor
uintptr_t	get_addr ()
uint32_t	get_size ()
uint32_t	get_status ()
void	set_addr (uintptr_t address)
void	set_size (uint32_t size)
void	set_status (uint32_t status)

Constructor & Destructor Documentation

ringout()

InterfacePP::ringout::ringout ( uintptr_t  address, uint32_t  size, uint32_t  status  )

inline

Constructor for output ring object

Parameters

address	- address of output
size	- size of output
status	- status of the output

Sits in the output ring as

---

| address (8-byte output address)|

| size (4-byte output size) |

| status (4-byte value) |

Member Function Documentation

get_addr()

uintptr_t InterfacePP::ringout::get_addr ( )

inline

return address

Returns

- address

get_size()

uint32_t InterfacePP::ringout::get_size ( )

inline

return size

Returns

- size

get_status()

uint32_t InterfacePP::ringout::get_status ( )

inline

retrieve the status of the output

Returns

- 32-bit status word

set_addr()

void InterfacePP::ringout::set_addr ( uintptr_t  address )

inline

set the address

Parameters

address

- address of the input

set_size()

void InterfacePP::ringout::set_size ( uint32_t  size )

inline

set the size of the input

Parameters

size	- size of the input

set_status()

void InterfacePP::ringout::set_status ( uint32_t  status )

inline

set the status word

Parameters

status

- status value to set

---

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

• jtestbench/include/ringobj.h