NI RFSG Peer To Peer Attributes - ni/grpc-device GitHub Wiki

Peer To Peer Attributes

NIRFSG_ATTR_P2P_DATA_TRANSFER_PERMISSION_INITIAL_CREDITS

Specific Attribute

Numeric Value Data Type Access Coercion High-Level Functions
1150135 ViInt64 R/W Yes None

Description

Specifies the initial amount of data that the writer peer can transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If this attribute is not set and the endpoint is empty, credits equal to the full endpoint size are issued to the writer peer. If data is written to the endpoint using the niRFSG_WriteP2PEndpointI16 function prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This attribute is coerced up by NI-RFSG to 8-byte boundaries. This attribute is endpoint-based.

Units: samples per channel

Default Value: 1,024

Supported Devices: PXIe-5673E

Related Topics

Configuring a Peer-to-Peer Endpoint

Configuring Flow Control

NIRFSG_ATTR_P2P_DATA_TRANSFER_PERMISSION_INTERVAL

Specific Attribute

Numeric Value Data Type Access Coercion High-Level Functions
1150134 ViInt64 R/W Yes None

Description

Specifies the interval at which the RF signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. This attribute is coerced up by NI-RFSG to the nearest 128-byte boundary. This attribute is endpoint-based.

Units: samples per channel

Supported Devices: PXIe-5673E

Related Topics

Configuring a Peer-to-Peer Endpoint

Configuring Flow Control

NIRFSG_ATTR_P2P_ENABLED

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150123 ViBoolean R/W Endpoint None None

Description

Specifies whether the RF signal generator reads data from the peer-to-peer endpoint. This attribute is endpoint-based.

Defined Values:

VI_TRUE Peer-to-peer data streaming is enabled.
VI_FALSE Peer-to-peer data streaming is disabled.
Default Value: VI_FALSE

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

NIRFSG_ATTR_P2P_ENDPOINT_COUNT

Specific Attribute

Numeric Value Data Type Access Coercion High-Level Functions
1150127 ViInt32 RO None None

Description

Returns the number of peer-to-peer FIFO endpoints supported by the device.

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

NIRFSG_ATTR_P2P_ENDPOINT_SIZE

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150124 ViInt32 RO Endpoint None None

Description

Returns the size, in samples, of the device endpoint. This attribute is endpoint-based.

Units: samples (s)

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

NIRFSG_ATTR_P2P_GENERATION_FIFO_SAMPLE_QUANTUM

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150219 ViInt64 RO Endpoint None None

Description

Returns how many samples NI-RFSG pulls from the peer-to-peer FIFO per read. You can use this attribute to determine how many samples to send across the peer-to-peer bus to ensure that no samples are ignored. If you send a number of samples that is not a multiple of this value, the remaining samples are not read from the FIFO during generation. This attribute is endpoint-based.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_P2P_IS_FINITE_GENERATION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150217 ViBoolean R/W Endpoint None None

Description

Specifies whether peer-to-peer should continuously generate data from the peer-to-peer stream or from only a finite number of samples, according to the NIRFSG_ATTR_P2P_NUMBER_OF_SAMPLES_TO_GENERATE attribute. To use this attribute, peer-to-peer must be enabled. This attribute is endpoint-based.

Defined Values:

VI_TRUE Data is generated from only a finite number of samples.
VI_FALSE Data is continuously generated from the peer-to-peer stream.
Default Value: VI_FALSE

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_P2P_MOST_SPACE_AVAILABLE_IN_ENDPOINT

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150126 ViInt32 RO Endpoint None None

Description

Returns the largest number of samples per channel available in the endpoint since this attribute was last read. You can use this attribute to determine how much endpoint space to use as a buffer against bus traffic latencies by reading the attribute and keeping track of the largest value returned. This attribute is endpoint-based.

If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the NIRFSG_ATTR_P2P_DATA_TRANSFER_PERMISSION_INITIAL_CREDITS attribute to grant fewer initial credits than the default of the entire endpoint size.

Units: samples per channel

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

NIRFSG_ATTR_P2P_NUMBER_OF_SAMPLES_TO_GENERATE

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150218 ViInt64 R/W Endpoint None None

Description

Specifies how many samples are generated from the peer-to-peer subsystem when it is enabled. To use this attribute, peer-to-peer must be enabled and set to finite generation. This attribute is endpoint-based.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

NIRFSG_ATTR_P2P_SPACE_AVAILABLE_IN_ENDPOINT

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150125 ViInt32 RO Endpoint None None

Description

Returns the current space available in the endpoint. You can use this attribute when priming the endpoint with initial data using the niRFSG_WriteP2PEndpointI16 function to determine how many samples you can write. You also can use this attribute to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This attribute is endpoint-based.

Units: samples per channel

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

Starting Peer-to-Peer Generation

⚠️ **GitHub.com Fallback** ⚠️