Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Module Properties Functions
NAI Board Library - Module Functions » DIF Module Functions

Functions

NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetChannelCount (uint32_t modid)
 Returns the number of channels for the specified DIF Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetGroupCount (uint32_t modid)
 Returns the number of channel groups for the specified DIF Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetGroupSize (uint32_t modid)
 Returns the number of channel in each group for the specified DIF Module ID.
 
NAIBRDFUNC float64_t NAIAPI naibrd_DIF_GetTimebaseLSB (uint32_t modid)
 Returns the LSB for the timer interval for Debounce, Measurement, PWM and Pattern Generator clocks for the specified DIF Module ID.
 
NAIBRDFUNC uint32_t NAIAPI naibrd_DIF_GetValidPatternGenStart (uint32_t modid)
 Returns valid start address for Pattern RAM Generator block for the specified DIF Module ID.
 
NAIBRDFUNC uint32_t NAIAPI naibrd_DIF_GetValidPatternGenEnd (uint32_t modid)
 Returns valid end address for Pattern RAM Generator block for the specified DIF Module ID.
 

Detailed Description

Function Documentation

◆ naibrd_DIF_GetChannelCount()

NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetChannelCount ( uint32_t modid)

Returns the number of channels for the specified DIF Module ID.

Parameters
modid: (Input) DIF Module ID
Returns
  • Number of channels for the Module ID.

◆ naibrd_DIF_GetGroupCount()

NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetGroupCount ( uint32_t modid)

Returns the number of channel groups for the specified DIF Module ID.

Parameters
modid: (Input) DF1 Module ID
Returns
  • Number of channel groups for the Module ID.

◆ naibrd_DIF_GetGroupSize()

NAIBRDFUNC int32_t NAIAPI naibrd_DIF_GetGroupSize ( uint32_t modid)

Returns the number of channel in each group for the specified DIF Module ID.

Parameters
modid: (Input) DF1 Module ID
Returns
  • Number of channel in each group for the Module ID.

◆ naibrd_DIF_GetTimebaseLSB()

NAIBRDFUNC float64_t NAIAPI naibrd_DIF_GetTimebaseLSB ( uint32_t modid)

Returns the LSB for the timer interval for Debounce, Measurement, PWM and Pattern Generator clocks for the specified DIF Module ID.

Parameters
modid: (Input) DIF Module ID
Returns
  • LSB for the module clock interval, millisecond units.

◆ naibrd_DIF_GetValidPatternGenEnd()

NAIBRDFUNC uint32_t NAIAPI naibrd_DIF_GetValidPatternGenEnd ( uint32_t modid)

Returns valid end address for Pattern RAM Generator block for the specified DIF Module ID.

Parameters
modid: (Input) DIF Module ID
Returns
  • Valid end address for Pattern RAM, 0x0u indicates invalid.

◆ naibrd_DIF_GetValidPatternGenStart()

NAIBRDFUNC uint32_t NAIAPI naibrd_DIF_GetValidPatternGenStart ( uint32_t modid)

Returns valid start address for Pattern RAM Generator block for the specified DIF Module ID.

Parameters
modid: (Input) DIF Module ID
Returns
  • Valid start address for Pattern RAM, 0x0u indicates invalid.