SURF  1.0
AxiStreamPkg Package Reference
Package Body >> AxiStreamPkg

Functions

AxiStreamMasterType   axiStreamMasterInit ( constant config: in AxiStreamConfigType )
integer   getSlvSize ( c: in AxiStreamConfigType )
slv   toSlv ( din: in AxiStreamMasterType , c: in AxiStreamConfigType )
AxiStreamMasterType   toAxiStreamMaster (
din: in slv
valid: in sl
c: in AxiStreamConfigType
)
boolean   axiStreamPacked ( constant CONFIG_C: in AxiStreamConfigType , axisMaster: in AxiStreamMasterType )
integer   axiStreamGetUserPos (
axisConfig: in AxiStreamConfigType
axisMaster: in AxiStreamMasterType
bytePos: in integer - 1
)
slv   axiStreamGetUserField (
axisConfig: in AxiStreamConfigType
axisMaster: in AxiStreamMasterType
bytePos: in integer - 1
)
sl   axiStreamGetUserBit (
axisConfig: in AxiStreamConfigType
axisMaster: in AxiStreamMasterType
bitPos: in integer
bytePos: in integer - 1
)
AxiStreamConfigType   ite (
i: in boolean
t: in AxiStreamConfigType
e: in AxiStreamConfigType
)
AxiStreamMasterType   ite (
i: in boolean
t: in AxiStreamMasterType
e: in AxiStreamMasterType
)
AxiStreamSlaveType   ite (
i: in boolean
t: in AxiStreamSlaveType
e: in AxiStreamSlaveType
)
AxiStreamCtrlType   ite (
i: in boolean
t: in AxiStreamCtrlType
e: in AxiStreamCtrlType
)
TUserModeType   ite (
i: in boolean
t: in TUserModeType
e: in TUserModeType
)
TKeepModeType   ite (
i: in boolean
t: in TKeepModeType
e: in TKeepModeType
)
slv   genTKeep ( bytes: in integer range 0 to 16 )
slv   genTKeep ( constant config: in AxiStreamConfigType )
natural   getTKeep ( tKeep: in slv )

Procedures

  axiStreamSetUserField(
axisConfig: in AxiStreamConfigType
axisMaster: inout AxiStreamMasterType
fieldValue: in slv
bytePos: in integer - 1
)
  axiStreamSetUserBit(
axisConfig: in AxiStreamConfigType
axisMaster: inout AxiStreamMasterType
bitPos: in integer
bitValue: in sl
bytePos: in integer - 1
)

Libraries

ieee 

Use Clauses

std_logic_1164 
std_logic_unsigned 
std_logic_arith 
StdRtlPkg  Package <StdRtlPkg>

Constants

AXI_STREAM_MASTER_INIT_C  AxiStreamMasterType := ( tValid = > ' 0 ' , tData = > ( others = > ' 0 ' ) , tStrb = > ( others = > ' 1 ' ) , tKeep = > ( others = > ' 1 ' ) , tLast = > ' 0 ' , tDest = > ( others = > ' 0 ' ) , tId = > ( others = > ' 0 ' ) , tUser = > ( others = > ' 0 ' ) )
AXI_STREAM_SLAVE_INIT_C  AxiStreamSlaveType := ( tReady = > ' 0 ' )
AXI_STREAM_SLAVE_FORCE_C  AxiStreamSlaveType := ( tReady = > ' 1 ' )
AXI_STREAM_CONFIG_INIT_C  AxiStreamConfigType := ( TSTRB_EN_C = > false , TDATA_BYTES_C = > 16 , TDEST_BITS_C = > 4 , TID_BITS_C = > 0 , TKEEP_MODE_C = > TKEEP_NORMAL_C , TUSER_BITS_C = > 4 , TUSER_MODE_C = > TUSER_NORMAL_C )
AXI_STREAM_CTRL_INIT_C  AxiStreamCtrlType := ( pause = > ' 1 ' , overflow = > ' 0 ' , idle = > ' 0 ' )
AXI_STREAM_CTRL_UNUSED_C  AxiStreamCtrlType := ( pause = > ' 0 ' , overflow = > ' 0 ' , idle = > ' 1 ' )

Types

AxiStreamMasterArray array ( natural range <> ) of AxiStreamMasterType
AxiStreamMasterVectorArray array ( natural range <> , natural range <> ) of AxiStreamMasterType
AxiStreamQuadMasterArray array ( natural range <> ) of AxiStreamMasterArray ( 3 downto 0 )
AxiStreamSlaveArray array ( natural range <> ) of AxiStreamSlaveType
AxiStreamSlaveVectorArray array ( natural range <> , natural range <> ) of AxiStreamSlaveType
AxiStreamQuadSlaveArray array ( natural range <> ) of AxiStreamSlaveArray ( 3 downto 0 )
TUserModeType ( TUSER_NORMAL_C , TUSER_FIRST_LAST_C , TUSER_LAST_C , TUSER_NONE_C )
TKeepModeType ( TKEEP_NORMAL_C , TKEEP_COMP_C , TKEEP_FIXED_C )
AxiStreamConfigArray array ( natural range <> ) of AxiStreamConfigType
AxiStreamConfigVectorArray array ( natural range <> , natural range <> ) of AxiStreamConfigType
AxiStreamCtrlArray array ( natural range <> ) of AxiStreamCtrlType
AxiStreamCtrlVectorArray array ( natural range <> , natural range <> ) of AxiStreamCtrlType
AxiStreamQuadCtrlArray array ( natural range <> ) of AxiStreamCtrlArray ( 3 downto 0 )

Subtypes

AxiStreamQuadMasterType  AxiStreamMasterArray ( 3 downto 0 )
AxiStreamQuadSlaveType  AxiStreamSlaveArray ( 3 downto 0 )
AxiStreamQuadCtrlType  AxiStreamCtrlArray ( 3 downto 0 )

Records

AxiStreamMasterType  
tValid  sl
tData  slv ( 127 downto 0 )
tStrb  slv ( 15 downto 0 )
tKeep  slv ( 15 downto 0 )
tLast  sl
tDest  slv ( 7 downto 0 )
tId  slv ( 7 downto 0 )
tUser  slv ( 127 downto 0 )
AxiStreamSlaveType  
tReady  sl
AxiStreamConfigType  
TSTRB_EN_C  boolean
TDATA_BYTES_C  natural range 1 to 16
TDEST_BITS_C  natural range 0 to 8
TID_BITS_C  natural range 0 to 8
TKEEP_MODE_C  TkeepModeType
TUSER_BITS_C  natural range 0 to 8
TUSER_MODE_C  TUserModeType
AxiStreamCtrlType  
pause  sl
overflow  sl
idle  sl

Detailed Description

Definition at line 25 of file AxiStreamPkg.vhd.

Member Function Documentation

◆ axiStreamMasterInit()

AxiStreamMasterType axiStreamMasterInit (   config in AxiStreamConfigType  
)
Function

Definition at line 95 of file AxiStreamPkg.vhd.

◆ getSlvSize()

integer getSlvSize (   c in AxiStreamConfigType  
)
Function

Definition at line 97 of file AxiStreamPkg.vhd.

◆ toSlv()

slv toSlv (   din in AxiStreamMasterType ,
  c in AxiStreamConfigType  
)
Function

Definition at line 98 of file AxiStreamPkg.vhd.

◆ toAxiStreamMaster()

AxiStreamMasterType toAxiStreamMaster (   din in slv ,
  valid in sl ,
  c in AxiStreamConfigType  
)
Function

Definition at line 99 of file AxiStreamPkg.vhd.

◆ axiStreamPacked()

boolean axiStreamPacked (   CONFIG_C in AxiStreamConfigType ,
  axisMaster in AxiStreamMasterType  
)
Function

Definition at line 128 of file AxiStreamPkg.vhd.

◆ axiStreamGetUserPos()

integer axiStreamGetUserPos (   axisConfig in AxiStreamConfigType ,
  axisMaster in AxiStreamMasterType ,
  bytePos in integer - 1  
)
Function

Definition at line 133 of file AxiStreamPkg.vhd.

◆ axiStreamGetUserField()

slv axiStreamGetUserField (   axisConfig in AxiStreamConfigType ,
  axisMaster in AxiStreamMasterType ,
  bytePos in integer - 1  
)
Function

Definition at line 139 of file AxiStreamPkg.vhd.

◆ axiStreamGetUserBit()

sl axiStreamGetUserBit (   axisConfig in AxiStreamConfigType ,
  axisMaster in AxiStreamMasterType ,
  bitPos in integer ,
  bytePos in integer - 1  
)
Function

Definition at line 145 of file AxiStreamPkg.vhd.

◆ axiStreamSetUserField()

axiStreamSetUserField (   axisConfig in AxiStreamConfigType ,
  axisMaster inout AxiStreamMasterType ,
  fieldValue in slv ,
  bytePos in integer - 1  
)
Procedure

Definition at line 152 of file AxiStreamPkg.vhd.

◆ axiStreamSetUserBit()

axiStreamSetUserBit (   axisConfig in AxiStreamConfigType ,
  axisMaster inout AxiStreamMasterType ,
  bitPos in integer ,
  bitValue in sl ,
  bytePos in integer - 1  
)
Procedure

Definition at line 158 of file AxiStreamPkg.vhd.

◆ ite() [1/6]

AxiStreamConfigType ite (   i in boolean ,
  t in AxiStreamConfigType ,
  e in AxiStreamConfigType  
)
Function

Definition at line 165 of file AxiStreamPkg.vhd.

◆ ite() [2/6]

AxiStreamMasterType ite (   i in boolean ,
  t in AxiStreamMasterType ,
  e in AxiStreamMasterType  
)
Function

Definition at line 166 of file AxiStreamPkg.vhd.

◆ ite() [3/6]

AxiStreamSlaveType ite (   i in boolean ,
  t in AxiStreamSlaveType ,
  e in AxiStreamSlaveType  
)
Function

Definition at line 167 of file AxiStreamPkg.vhd.

◆ ite() [4/6]

AxiStreamCtrlType ite (   i in boolean ,
  t in AxiStreamCtrlType ,
  e in AxiStreamCtrlType  
)
Function

Definition at line 168 of file AxiStreamPkg.vhd.

◆ ite() [5/6]

TUserModeType ite (   i in boolean ,
  t in TUserModeType ,
  e in TUserModeType  
)
Function

Definition at line 169 of file AxiStreamPkg.vhd.

◆ ite() [6/6]

TKeepModeType ite (   i in boolean ,
  t in TKeepModeType ,
  e in TKeepModeType  
)
Function

Definition at line 170 of file AxiStreamPkg.vhd.

◆ genTKeep() [1/2]

slv genTKeep (   bytes in integer range 0 to 16  
)
Function

Definition at line 172 of file AxiStreamPkg.vhd.

◆ genTKeep() [2/2]

slv genTKeep (   config in AxiStreamConfigType  
)
Function

Definition at line 173 of file AxiStreamPkg.vhd.

◆ getTKeep()

natural getTKeep (   tKeep in slv  
)
Function

Definition at line 175 of file AxiStreamPkg.vhd.

Member Data Documentation

◆ ieee

ieee
Library

Definition at line 18 of file AxiStreamPkg.vhd.

◆ std_logic_1164

std_logic_1164
Package

Definition at line 19 of file AxiStreamPkg.vhd.

◆ std_logic_unsigned

Definition at line 20 of file AxiStreamPkg.vhd.

◆ std_logic_arith

std_logic_arith
Package

Definition at line 21 of file AxiStreamPkg.vhd.

◆ StdRtlPkg

StdRtlPkg
Package

Definition at line 23 of file AxiStreamPkg.vhd.

◆ AxiStreamMasterType

Definition at line 29 of file AxiStreamPkg.vhd.

◆ tValid

tValid sl
Record

Definition at line 30 of file AxiStreamPkg.vhd.

◆ tData

tData slv ( 127 downto 0 )
Record

Definition at line 31 of file AxiStreamPkg.vhd.

◆ tStrb

tStrb slv ( 15 downto 0 )
Record

Definition at line 32 of file AxiStreamPkg.vhd.

◆ tKeep

tKeep slv ( 15 downto 0 )
Record

Definition at line 33 of file AxiStreamPkg.vhd.

◆ tLast

tLast sl
Record

Definition at line 34 of file AxiStreamPkg.vhd.

◆ tDest

tDest slv ( 7 downto 0 )
Record

Definition at line 35 of file AxiStreamPkg.vhd.

◆ tId

tId slv ( 7 downto 0 )
Record

Definition at line 36 of file AxiStreamPkg.vhd.

◆ tUser

tUser slv ( 127 downto 0 )
Record

Definition at line 37 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_MASTER_INIT_C

AXI_STREAM_MASTER_INIT_C AxiStreamMasterType := ( tValid = > ' 0 ' , tData = > ( others = > ' 0 ' ) , tStrb = > ( others = > ' 1 ' ) , tKeep = > ( others = > ' 1 ' ) , tLast = > ' 0 ' , tDest = > ( others = > ' 0 ' ) , tId = > ( others = > ' 0 ' ) , tUser = > ( others = > ' 0 ' ) )
Constant

Definition at line 40 of file AxiStreamPkg.vhd.

◆ AxiStreamMasterArray

AxiStreamMasterArray array ( natural range <> ) of AxiStreamMasterType
Type

Definition at line 49 of file AxiStreamPkg.vhd.

◆ AxiStreamMasterVectorArray

AxiStreamMasterVectorArray array ( natural range <> , natural range <> ) of AxiStreamMasterType
Type

Definition at line 50 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadMasterType

Definition at line 51 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadMasterArray

AxiStreamQuadMasterArray array ( natural range <> ) of AxiStreamMasterArray ( 3 downto 0 )
Type

Definition at line 52 of file AxiStreamPkg.vhd.

◆ AxiStreamSlaveType

Definition at line 54 of file AxiStreamPkg.vhd.

◆ tReady

tReady sl
Record

Definition at line 55 of file AxiStreamPkg.vhd.

◆ AxiStreamSlaveArray

AxiStreamSlaveArray array ( natural range <> ) of AxiStreamSlaveType
Type

Definition at line 58 of file AxiStreamPkg.vhd.

◆ AxiStreamSlaveVectorArray

AxiStreamSlaveVectorArray array ( natural range <> , natural range <> ) of AxiStreamSlaveType
Type

Definition at line 59 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadSlaveType

Definition at line 60 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadSlaveArray

AxiStreamQuadSlaveArray array ( natural range <> ) of AxiStreamSlaveArray ( 3 downto 0 )
Type

Definition at line 61 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_SLAVE_INIT_C

Definition at line 63 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_SLAVE_FORCE_C

Definition at line 66 of file AxiStreamPkg.vhd.

◆ TUserModeType

TUserModeType ( TUSER_NORMAL_C , TUSER_FIRST_LAST_C , TUSER_LAST_C , TUSER_NONE_C )
Type

Definition at line 69 of file AxiStreamPkg.vhd.

◆ TKeepModeType

TKeepModeType ( TKEEP_NORMAL_C , TKEEP_COMP_C , TKEEP_FIXED_C )
Type

Definition at line 71 of file AxiStreamPkg.vhd.

◆ AxiStreamConfigType

Definition at line 73 of file AxiStreamPkg.vhd.

◆ TSTRB_EN_C

TSTRB_EN_C boolean
Record

Definition at line 74 of file AxiStreamPkg.vhd.

◆ TDATA_BYTES_C

TDATA_BYTES_C natural range 1 to 16
Record

Definition at line 75 of file AxiStreamPkg.vhd.

◆ TDEST_BITS_C

TDEST_BITS_C natural range 0 to 8
Record

Definition at line 76 of file AxiStreamPkg.vhd.

◆ TID_BITS_C

TID_BITS_C natural range 0 to 8
Record

Definition at line 77 of file AxiStreamPkg.vhd.

◆ TKEEP_MODE_C

TKEEP_MODE_C TkeepModeType
Record

Definition at line 78 of file AxiStreamPkg.vhd.

◆ TUSER_BITS_C

TUSER_BITS_C natural range 0 to 8
Record

Definition at line 79 of file AxiStreamPkg.vhd.

◆ TUSER_MODE_C

Definition at line 80 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_CONFIG_INIT_C

AXI_STREAM_CONFIG_INIT_C AxiStreamConfigType := ( TSTRB_EN_C = > false , TDATA_BYTES_C = > 16 , TDEST_BITS_C = > 4 , TID_BITS_C = > 0 , TKEEP_MODE_C = > TKEEP_NORMAL_C , TUSER_BITS_C = > 4 , TUSER_MODE_C = > TUSER_NORMAL_C )
Constant

Definition at line 83 of file AxiStreamPkg.vhd.

◆ AxiStreamConfigArray

AxiStreamConfigArray array ( natural range <> ) of AxiStreamConfigType
Type

Definition at line 92 of file AxiStreamPkg.vhd.

◆ AxiStreamConfigVectorArray

AxiStreamConfigVectorArray array ( natural range <> , natural range <> ) of AxiStreamConfigType
Type

Definition at line 93 of file AxiStreamPkg.vhd.

◆ AxiStreamCtrlType

Definition at line 104 of file AxiStreamPkg.vhd.

◆ pause

pause sl
Record

Definition at line 105 of file AxiStreamPkg.vhd.

◆ overflow

overflow sl
Record

Definition at line 106 of file AxiStreamPkg.vhd.

◆ idle

idle sl
Record

Definition at line 107 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_CTRL_INIT_C

AXI_STREAM_CTRL_INIT_C AxiStreamCtrlType := ( pause = > ' 1 ' , overflow = > ' 0 ' , idle = > ' 0 ' )
Constant

Definition at line 110 of file AxiStreamPkg.vhd.

◆ AXI_STREAM_CTRL_UNUSED_C

AXI_STREAM_CTRL_UNUSED_C AxiStreamCtrlType := ( pause = > ' 0 ' , overflow = > ' 0 ' , idle = > ' 1 ' )
Constant

Definition at line 115 of file AxiStreamPkg.vhd.

◆ AxiStreamCtrlArray

AxiStreamCtrlArray array ( natural range <> ) of AxiStreamCtrlType
Type

Definition at line 120 of file AxiStreamPkg.vhd.

◆ AxiStreamCtrlVectorArray

AxiStreamCtrlVectorArray array ( natural range <> , natural range <> ) of AxiStreamCtrlType
Type

Definition at line 121 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadCtrlType

AxiStreamQuadCtrlType AxiStreamCtrlArray ( 3 downto 0 )
Subtype

Definition at line 122 of file AxiStreamPkg.vhd.

◆ AxiStreamQuadCtrlArray

AxiStreamQuadCtrlArray array ( natural range <> ) of AxiStreamCtrlArray ( 3 downto 0 )
Type

Definition at line 123 of file AxiStreamPkg.vhd.


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