test.sv File Reference

Test - brief comment. More...

#include "myfile.sv"
#include "myotherfile.sv"
#include "test_incl.sv"

Include dependency graph for test.sv:

Go to the source code of this file.

Classes

class inclpack::incl_test_class

Test Class Incl 1 Just a basic class declaration in a class. More...

class inclpack::incl_test_class2

Test Class Incl 2 in foo package. More...

class foopack::foo_test_class

Test Class in foo package. More...

class foopack::foo_test_class2

Test Class2 in foo package. More...

class goopack::goo_test_class

Test Class in a Package. More...

class moopack::moo_test_class

Test Class in a Package. More...

class doopack::doo_test_class

Test Class in a Package. More...

class test_class_basic

Test Class - Basic. More...

class myderivedclass

My Derived Class. More...

class myderivedclass_package

My Derived Class Package. More...

class mytemplateclass< T >

My Template Class. More...

class mytemplateclass2< T >

My Template Class2. More...

class mytemplateclass3< T, B >

My Template Class3. More...

class mytemplateclass4< T >

My Template Class4. More...

class mytemplateclass5< B >

My Template Class5. More...

class mytemplateclass6< T, B >

My Template Class6. More...

class mytemplateclass7< T, B >

My Template Class7. More...

class mytemplateclass8< T, B, C >

My Template Class8. More...

class mytemplateclass9< T, B, C >

My Template Class9. More...

class mytemplateclass10< T, B, C >

My Template Class10. More...

class myclass11

My Class11. More...

class mytemplateclass12< T, B, C >

My Template Class12. More...

class mytemplateselectclass< ABC, DEF >

My Template Select Class. More...

class myselectclass

My Select Class. More...

class abc< f, g, h >

abc Class. More...

Namespaces

namespace inclpack

Include Package - collection of classes.

namespace foopack

Foo Package - collection of classes.

namespace goopack

Goo Package - collection of classes.

namespace moopack

Moo Package - collection of classes.

namespace doopack

Doo Package - collection of classes.

Defines

#define PUTINQUOTES(x)   #x

Put in Quotes Macro.

#define MYOTHERFILE   myotherfile.sv

My Other File Define.

#define MYDEFINE   mydefine

My Define.

#define MYDEFINE2   mydefine2

My Define2.

#define foo(f)   f##_suffix

foo define.

#define msg(x, y)   "x: \"y\""

msg define.

#define __FILE__   ""

FILE define.

#define __LINE__   -1

Line define.

#define vmm_warning(log, msg)

Parameterized Macro VMM Warning.

#define vmm_error(log, msg)

Parameterized Macro VMM Error.

#define vmm_fatal(log, msg)

Parameterized Macro VMM Fatal.

#define vmm_channel(T)

Parameterized Macro VMM Channel.

#define TLM_FIFO_TASK_ERROR   "fifo channel task not implemented"

Define TLM FIFO Task Error Message.

#define TLM_FIFO_FUNCTION_ERROR   "fifo channel function not implemented"

Define TLM FIFO Function Error Message.

#define TLM_FIFO_FUNCTION_ERROR2   "fifo channel \ function not implemented \ yes we have no bananas \ today function" things

Define TLM FIFO Function Error2 Message.

#define TLM_FIFO_FUNCTION_ERROR3   "fifo channel \\ function not implemented \ yes we have no bananas \ today function" things

Define TLM FIFO Function Error3 Message.

Functions

int dpi_method1 (input string str1, input string regex)

DPI Method1.

string dpi_method2 ()

DPI Method2.

string dpi_method3 ()

DPI Method3.

string dpi_method4 (int n)

DPI Method4.

void myInit ()

DPI My Init.

real sin (real n)

DPI Sin.

chandle malloc (int size)

DPI malloc.

void free (chandle ptr)

DPI free.

chandle newQueue (input string name_of_queue)

DPI New Queue.

chandle newAnonQueue (input string s=null)

DPI New (Anon) Queue.

chandle newElem (bit< 15:0 > mybitvector)

DPI New Element.

void enqueue (chandle queue, chandle elem)

DPI Enqueue.

chandle dequeue (chandle queue)

DPI Dequeue.

bit< 15:0 > getStimulus ()

DPI Get Stimulus.

void processTransaction (chandle elem, output logic< 64:1 > arr[0:63])

DPI Process Transaction.

task checkResults (input string s, bit< 511:0 > packet)

DPI Check Results.

program myprogram1 ()

MyProgram1 Program Block.

program myprogram2 (int myint, bit mybit)

MyProgram2 Program Block.

module mymodule1 ()

MyModule1 Module Block.

module mymodule2 (int myint, bit mybit)

MyModule2 Module Block.

module mymodule3 (int myint, bit mybit)

MyModule3 Module Block.

interface bus ()

Bus interface Block.

interface bus_A (input bit clk)

BusA interface Block.

interface bus_B (input bit clk, output logic foo)

BusB interface Block.

template<WIDTH = 8>

interface bus_C (input bit clk, output logic foo)

BusC interface Block.

template<WIDTH = 8>

interface bus_D (input bit clk, output logic foo)

BusD interface Block.

template<WIDTH = 8, DEPTH = 20>

interface bus_E (input bit clk, output logic foo)

BusE interface Block.

template<WIDTH = 8, DEPTH = 20>

interface bus_F (input bit clk, output logic foo)

BusF interface Block.

Detailed Description

Test - brief comment.

This file is a test of the doxygen filter script.
This contains a semi-complete set of the SystemVerilog constructs that the filter script can handle

Download the most recent version here:: http://intelligentdv.com/downloads/

File Bugs Here:: http://bugs.intelligentdv.com/
Project: DoxygenFilter

Author:: Author O'Author

Contact:: http://intelligentdv.com/contact/

Company:: Intelligent Design Verification

Version:: $LastChangedRevision_deleteme$

Last Change Date:: $LastChangedDate_deleteme$

Last Change By:: $LastChangedBy_deleteme$

Definition in file test.sv.

Define Documentation

#define __FILE__ ""

FILE define.

define with doublequotes

Definition at line 245 of file test.sv.

#define __LINE__ -1

Line define.

incase __LINE__ isn't defined

Definition at line 252 of file test.sv.

#define foo ( f ) f##_suffix

foo define.

define with concatenation

Definition at line 232 of file test.sv.

#define msg	(	x,
		y		)	"x: \"y\""

msg define.

define with concatenation

Definition at line 237 of file test.sv.

#define MYDEFINE mydefine

My Define.

A define for fun

Definition at line 216 of file test.sv.

#define MYDEFINE2 mydefine2

My Define2.

Another define and also fun

Definition at line 222 of file test.sv.

#define MYOTHERFILE myotherfile.sv

My Other File Define.

My other file is C++!

Definition at line 65 of file test.sv.

#define PUTINQUOTES ( x ) #x

Put in Quotes Macro.

A paremeterized macro that puts X in quotes

Definition at line 58 of file test.sv.

#define TLM_FIFO_FUNCTION_ERROR "fifo channel function not implemented"

Define TLM FIFO Function Error Message.

A macro - with a SV keyword embedded

Definition at line 383 of file test.sv.

#define TLM_FIFO_FUNCTION_ERROR2 "fifo channel \ function not implemented \ yes we have no bananas \ today function" things

Define TLM FIFO Function Error2 Message.

A multiline macro - with a SV keyword embedded

Definition at line 388 of file test.sv.

#define TLM_FIFO_FUNCTION_ERROR3 "fifo channel \\ function not implemented \ yes we have no bananas \ today function" things

Define TLM FIFO Function Error3 Message.

A multiline macro - with a SV keyword embedded and an empty line with a trailing word

Definition at line 397 of file test.sv.

#define TLM_FIFO_TASK_ERROR "fifo channel task not implemented"

Define TLM FIFO Task Error Message.

A macro - with a SV keyword embedded

Definition at line 378 of file test.sv.

#define vmm_channel ( T )

Parameterized Macro VMM Channel.

A parameterized macro - taken from VMM

Note:: there's an inline comment in this one

Definition at line 303 of file test.sv.

#define vmm_error	(	log,
		msg		)

Value:

do \
   /* synopsys translate_off */ \
   if (log.start_msg(vmm_log::FAILURE_TYP, vmm_log::ERROR_SEV, __FILE__, __LINE__)) { \
      void(log.text(msg)); \
      log.end_msg(); \
   } \
   /* synopsys translate_on */ \
while (0)

Parameterized Macro VMM Error.

A parameterized macro - taken from VMM

Definition at line 274 of file test.sv.

#define vmm_fatal	(	log,
		msg		)

Value:

do \
   /* synopsys translate_off */ \
   if (log.start_msg(vmm_log::FAILURE_TYP, vmm_log::FATAL_SEV, __FILE__, __LINE__)) { \
      void(log.text(msg)); \
      log.end_msg(); \
   } \
   /* synopsys translate_on */ \
while (0)

Parameterized Macro VMM Fatal.

A parameterized macro - taken from VMM

Definition at line 288 of file test.sv.

#define vmm_warning	(	log,
		msg		)

Value:

do \
   /* synopsys translate_off */ \
   if (log.start_msg(vmm_log::FAILURE_TYP, vmm_log::WARNING_SEV, __FILE__, __LINE__)) { \
      void(log.text(msg)); \
      log.end_msg(); /* a comment in a macro */ \
      something("with some quotes and a keyword end") \
   } \
   /* synopsys translate_on */ \
while(0)

Parameterized Macro VMM Warning.

A parameterized macro - taken from VMM

Definition at line 259 of file test.sv.

Function Documentation

task checkResults	(	input string	s,
		bit< 511:0 >	packet
	)

DPI Check Results.

A DPI-C import of method checkResults

Parameters:

	s	string - description of parameter s
	packet	bit [511:0] - description of parameter packet

Definition at line 206 of file test.sv.

chandle dequeue ( chandle queue )

DPI Dequeue.

A DPI-C import of method dequeue

Parameters:

queue

chandle - description of parameter queue

Returns:: chandle

Definition at line 181 of file test.sv.

int dpi_method1	(	input string	str1,
		input string	regex
	)

DPI Method1.

A DPI-C import of method dpi_method1

Parameters:

	str1	string - description of parameter str1
	regex	string - description of parameter regex

Returns:: int

Definition at line 78 of file test.sv.

string dpi_method2 ( )

DPI Method2.

A DPI-C import of method dpi_method2

Returns:: string

Definition at line 85 of file test.sv.

string dpi_method3 ( )

DPI Method3.

A DPI-C import of method dpi_method3

Returns:: string

Definition at line 92 of file test.sv.

string dpi_method4 ( int n )

DPI Method4.

A DPI-C import of method dpi_method4

Parameters:

n

int - description of parameter n

Returns:: string

Definition at line 100 of file test.sv.

void enqueue	(	chandle	queue,
		chandle	elem
	)

DPI Enqueue.

A DPI-C import of method enqueue

Parameters:

	queue	chandle - description of parameter queue
	elem	chandle - description of parameter elem

Returns:: void

Definition at line 173 of file test.sv.

void free ( chandle ptr )

DPI free.

A DPI-C import of method free
From standard C library: memory management

Parameters:

ptr

chandle - description of parameter ptr

Returns:: void

bit<15:0> getStimulus ( )

DPI Get Stimulus.

A DPI-C import of method getStimulus

Returns:: bit [15:0]

Definition at line 188 of file test.sv.

chandle malloc ( int size )

DPI malloc.

A DPI-C import of method malloc
From standard C library: memory management

Parameters:

size

chandle - description of parameter size

Returns:: chandle

void myInit ( )

DPI My Init.

A DPI-C import of method myInit

Returns:: void

Definition at line 107 of file test.sv.

chandle newAnonQueue ( input string s = null )

DPI New (Anon) Queue.

A DPI-C import of method newAnonQueue - renamed to newQueue2
abstract data structure: queue

Note:: Note the following import uses the same foreign function for implementation as the prior import, but has different SystemVerilog name and provides a default value for the argument.

Parameters:

s

string - description of parameter s (defaults to null)

Returns:: chandle

Definition at line 156 of file test.sv.

chandle newElem ( bit< 15:0 > mybitvector )

DPI New Element.

A DPI-C import of method newElem

Parameters:

mybitvector

bit[15:0] - description of parameter s (defaults to null)

Returns:: chandle

Definition at line 164 of file test.sv.

chandle newQueue ( input string name_of_queue )

DPI New Queue.

A DPI-C import of method newQueue
abstract data structure: queue

Parameters:

name_of_queue

chandle - description of parameter name_of_queue

Returns:: chandle

Definition at line 143 of file test.sv.

void processTransaction	(	chandle	elem,
		output logic< 64:1 >	arr[0:63]
	)

DPI Process Transaction.

A DPI-C import of method processTransaction

Parameters:

	elem	chandle - description of parameter elem
	arr	[64:1] logic [0:63] - description of parameter arr

Returns:: void

Definition at line 197 of file test.sv.

real sin ( real n )

DPI Sin.

A DPI-C import of method sin
From standard math library

Parameters:

n

real - description of parameter n

Returns:: real

Definition at line 116 of file test.sv.


Classes
class	inclpack::incl_test_class
	Test Class Incl 1 Just a basic class declaration in a class. More...
class	inclpack::incl_test_class2
	Test Class Incl 2 in foo package. More...
class	foopack::foo_test_class
	Test Class in foo package. More...
class	foopack::foo_test_class2
	Test Class2 in foo package. More...
class	goopack::goo_test_class
	Test Class in a Package. More...
class	moopack::moo_test_class
	Test Class in a Package. More...
class	doopack::doo_test_class
	Test Class in a Package. More...
class	test_class_basic
	Test Class - Basic. More...
class	myderivedclass
	My Derived Class. More...
class	myderivedclass_package
	My Derived Class Package. More...
class	mytemplateclass< T >
	My Template Class. More...
class	mytemplateclass2< T >
	My Template Class2. More...
class	mytemplateclass3< T, B >
	My Template Class3. More...
class	mytemplateclass4< T >
	My Template Class4. More...
class	mytemplateclass5< B >
	My Template Class5. More...
class	mytemplateclass6< T, B >
	My Template Class6. More...
class	mytemplateclass7< T, B >
	My Template Class7. More...
class	mytemplateclass8< T, B, C >
	My Template Class8. More...
class	mytemplateclass9< T, B, C >
	My Template Class9. More...
class	mytemplateclass10< T, B, C >
	My Template Class10. More...
class	myclass11
	My Class11. More...
class	mytemplateclass12< T, B, C >
	My Template Class12. More...
class	mytemplateselectclass< ABC, DEF >
	My Template Select Class. More...
class	myselectclass
	My Select Class. More...
class	abc< f, g, h >
	abc Class. More...
Namespaces
namespace	inclpack
	Include Package - collection of classes.
namespace	foopack
	Foo Package - collection of classes.
namespace	goopack
	Goo Package - collection of classes.
namespace	moopack
	Moo Package - collection of classes.
namespace	doopack
	Doo Package - collection of classes.
Defines
#define	PUTINQUOTES(x) #x
	Put in Quotes Macro.
#define	MYOTHERFILE myotherfile.sv
	My Other File Define.
#define	MYDEFINE mydefine
	My Define.
#define	MYDEFINE2 mydefine2
	My Define2.
#define	foo(f) f##_suffix
	foo define.
#define	msg(x, y) "x: \"y\""
	msg define.
#define	__FILE__ ""
	FILE define.
#define	__LINE__ -1
	Line define.
#define	vmm_warning(log, msg)
	Parameterized Macro VMM Warning.
#define	vmm_error(log, msg)
	Parameterized Macro VMM Error.
#define	vmm_fatal(log, msg)
	Parameterized Macro VMM Fatal.
#define	vmm_channel(T)
	Parameterized Macro VMM Channel.
#define	TLM_FIFO_TASK_ERROR "fifo channel task not implemented"
	Define TLM FIFO Task Error Message.
#define	TLM_FIFO_FUNCTION_ERROR "fifo channel function not implemented"
	Define TLM FIFO Function Error Message.
#define	TLM_FIFO_FUNCTION_ERROR2 "fifo channel \ function not implemented \ yes we have no bananas \ today function" things
	Define TLM FIFO Function Error2 Message.
#define	TLM_FIFO_FUNCTION_ERROR3 "fifo channel \\ function not implemented \ yes we have no bananas \ today function" things
	Define TLM FIFO Function Error3 Message.
Functions
int	dpi_method1 (input string str1, input string regex)
	DPI Method1.
string	dpi_method2 ()
	DPI Method2.
string	dpi_method3 ()
	DPI Method3.
string	dpi_method4 (int n)
	DPI Method4.
void	myInit ()
	DPI My Init.
real	sin (real n)
	DPI Sin.
chandle	malloc (int size)
	DPI malloc.
void	free (chandle ptr)
	DPI free.
chandle	newQueue (input string name_of_queue)
	DPI New Queue.
chandle	newAnonQueue (input string s=null)
	DPI New (Anon) Queue.
chandle	newElem (bit< 15:0 > mybitvector)
	DPI New Element.
void	enqueue (chandle queue, chandle elem)
	DPI Enqueue.
chandle	dequeue (chandle queue)
	DPI Dequeue.
bit< 15:0 >	getStimulus ()
	DPI Get Stimulus.
void	processTransaction (chandle elem, output logic< 64:1 > arr[0:63])
	DPI Process Transaction.
task	checkResults (input string s, bit< 511:0 > packet)
	DPI Check Results.
program	myprogram1 ()
	MyProgram1 Program Block.
program	myprogram2 (int myint, bit mybit)
	MyProgram2 Program Block.
module	mymodule1 ()
	MyModule1 Module Block.
module	mymodule2 (int myint, bit mybit)
	MyModule2 Module Block.
module	mymodule3 (int myint, bit mybit)
	MyModule3 Module Block.
interface	bus ()
	Bus interface Block.
interface	bus_A (input bit clk)
	BusA interface Block.
interface	bus_B (input bit clk, output logic foo)
	BusB interface Block.
template<WIDTH = 8>
interface	bus_C (input bit clk, output logic foo)
	BusC interface Block.
template<WIDTH = 8>
interface	bus_D (input bit clk, output logic foo)
	BusD interface Block.
template<WIDTH = 8, DEPTH = 20>
interface	bus_E (input bit clk, output logic foo)
	BusE interface Block.
template<WIDTH = 8, DEPTH = 20>
interface	bus_F (input bit clk, output logic foo)
	BusF interface Block.