Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Configuration Operation Legacy Functions
NAI Board Library - Module Functions » SER Module Functions » Serial Module Legacy Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetProtocol (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_protocol_t protocol)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetProtocol (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_protocol_t *p_outprotocol)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterfaceLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_interface_t level)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterfaceLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_interface_t *p_outlevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetParity (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_parity_t parity)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetParity (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_parity_t *p_outparity)
 

Detailed Description

Function Documentation

◆ naibrd_SER_GetInterfaceLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterfaceLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_interface_t * p_outlevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetInterface().

Retrieves interfaceLevel level for the specified Serial channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outlevel: (Output) Interface level: refer to nai_ser_interface_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetParity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetParity ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_parity_t * p_outparity )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetParityType().

Retrieves the Parity in the Data Configuration for the specified Serial channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outparity: (Output) Parity (0=none, 1=space, 3=odd, 5=even, 7=mark).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetProtocol()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetProtocol ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_protocol_t * p_outprotocol )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetCommProtocol().

Retrieves the protocol for the specified Serial channel specified as follows:

  0   -  ASYNC
  1   -  MONO-SYNC
  2   -  BI-SYNC
  3   -  HDLC
  4   -  PPP-ASYNC
  5   -  EXT_TRANSPARENT
  6   -  RAWSHIFT
  0x4000 -  REVERSED_BIT_ORDER
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outprotocol: (Output) Serial Protocol.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetInterfaceLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterfaceLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_interface_t level )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetInterface().

Sets interfaceLevel level for the specified Serial channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
level: (Input) Interface level: refer to nai_ser_interface_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetParity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetParity ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_parity_t parity )
Warning
This function is deprecated and has been replaced by naibrd_SetParityType().

Sets the Parity in the Data Configuration for the specified Serial channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
parity: (Input) Parity (0=none, 1=space, 3=odd, 5=even, 7=mark).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetProtocol()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetProtocol ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_protocol_t protocol )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetCommProtocol().

Sets the protocol for the specified Serial channel specified as follows:

  0   -  ASYNC
  1   -  MONO-SYNC
  2   -  BI-SYNC
  3   -  HDLC
  4   -  PPP-ASYNC
  5   -  EXT_TRANSPARENT
  6   -  RAWSHIFT
  0x4000 -  REVERSED_BIT_ORDER
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
protocol: (Input) Serial Protocol.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.