 |
USRP Hardware Driver and USRP Manual
Version: 4.6.0.0
UHD and USRP Manual
|
|
|
USRP Hardware Driver and USRP Manual
Version: 4.6.0.0
UHD and USRP Manual
|
|
#include <uhd/config.h>#include <uhd/error.h>#include <stdbool.h>#include <stdint.h>#include <stdlib.h>#include <time.h>Go to the source code of this file.
Typedefs | |
| typedef struct uhd_rx_metadata_t * | uhd_rx_metadata_handle |
| RX metadata interface for describing sent IF data. More... | |
| typedef struct uhd_tx_metadata_t * | uhd_tx_metadata_handle |
| TX metadata interface for describing received IF data. More... | |
| typedef struct uhd_async_metadata_t * | uhd_async_metadata_handle |
| Interface for describing transmit-related events. More... | |
Enumerations | |
| enum | uhd_rx_metadata_error_code_t { UHD_RX_METADATA_ERROR_CODE_NONE = 0x0, UHD_RX_METADATA_ERROR_CODE_TIMEOUT = 0x1, UHD_RX_METADATA_ERROR_CODE_LATE_COMMAND = 0x2, UHD_RX_METADATA_ERROR_CODE_BROKEN_CHAIN = 0x4, UHD_RX_METADATA_ERROR_CODE_OVERFLOW = 0x8, UHD_RX_METADATA_ERROR_CODE_ALIGNMENT = 0xC, UHD_RX_METADATA_ERROR_CODE_BAD_PACKET = 0xF } |
| Error condition on a receive call. More... | |
| enum | uhd_async_metadata_event_code_t { UHD_ASYNC_METADATA_EVENT_CODE_BURST_ACK = 0x1, UHD_ASYNC_METADATA_EVENT_CODE_UNDERFLOW = 0x2, UHD_ASYNC_METADATA_EVENT_CODE_SEQ_ERROR = 0x4, UHD_ASYNC_METADATA_EVENT_CODE_TIME_ERROR = 0x8, UHD_ASYNC_METADATA_EVENT_CODE_UNDERFLOW_IN_PACKET = 0x10, UHD_ASYNC_METADATA_EVENT_CODE_SEQ_ERROR_IN_BURST = 0x20, UHD_ASYNC_METADATA_EVENT_CODE_USER_PAYLOAD = 0x40 } |
| The type of event for a receive async message call. More... | |
| typedef struct uhd_async_metadata_t* uhd_async_metadata_handle |
Interface for describing transmit-related events.
See uhd::async_metadata_t for details.
NOTE: Using this handle before calling uhd_async_metadata_make() will result in undefined behavior.
| typedef struct uhd_rx_metadata_t* uhd_rx_metadata_handle |
RX metadata interface for describing sent IF data.
See uhd::rx_metadata_t for details.
NOTE: Using this handle before calling uhd_rx_metadata_make() will result in undefined behavior.
| typedef struct uhd_tx_metadata_t* uhd_tx_metadata_handle |
TX metadata interface for describing received IF data.
See uhd::tx_metadata_t for details.
NOTE: Using this handle before calling uhd_tx_metadata_make() will result in undefined behavior.
The type of event for a receive async message call.
See uhd::async_metadata_t::event_code_t for more details.
Error condition on a receive call.
See uhd::rx_metadata_t::error_code_t for more details.
| UHD_API uhd_error uhd_async_metadata_channel | ( | uhd_async_metadata_handle | h, |
| size_t * | channel_out | ||
| ) |
Channel number in a MIMO configuration.
| UHD_API uhd_error uhd_async_metadata_event_code | ( | uhd_async_metadata_handle | h, |
| uhd_async_metadata_event_code_t * | event_code_out | ||
| ) |
Get last event code.
| UHD_API uhd_error uhd_async_metadata_free | ( | uhd_async_metadata_handle * | handle | ) |
Free an async metadata handle.
Using a handle after freeing it will result in a segmentation fault.
| UHD_API uhd_error uhd_async_metadata_has_time_spec | ( | uhd_async_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Has time specification?
| UHD_API uhd_error uhd_async_metadata_last_error | ( | uhd_async_metadata_handle | h, |
| char * | error_out, | ||
| size_t | strbuffer_len | ||
| ) |
Get the last error logged by the async metadata object.
NOTE: This function will overwrite any string in the given buffer before inserting the error string.
| h | metadata handle |
| error_out | string buffer for error |
| strbuffer_len | buffer length |
| UHD_API uhd_error uhd_async_metadata_make | ( | uhd_async_metadata_handle * | handle | ) |
Create a new async metadata handle.
| UHD_API uhd_error uhd_async_metadata_time_spec | ( | uhd_async_metadata_handle | h, |
| int64_t * | full_secs_out, | ||
| double * | frac_secs_out | ||
| ) |
Get time specification.
| UHD_API uhd_error uhd_async_metadata_user_payload | ( | uhd_async_metadata_handle | h, |
| uint32_t | user_payload_out[4] | ||
| ) |
Get payload from custom FPGA fabric.
| UHD_API uhd_error uhd_rx_metadata_end_of_burst | ( | uhd_rx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
End of burst?
| UHD_API uhd_error uhd_rx_metadata_error_code | ( | uhd_rx_metadata_handle | h, |
| uhd_rx_metadata_error_code_t * | error_code_out | ||
| ) |
Get the last error state of the RX metadata object.
| UHD_API uhd_error uhd_rx_metadata_fragment_offset | ( | uhd_rx_metadata_handle | h, |
| size_t * | fragment_offset_out | ||
| ) |
Fragmentation offset.
| UHD_API uhd_error uhd_rx_metadata_free | ( | uhd_rx_metadata_handle * | handle | ) |
Free an RX metadata handle.
Using a handle after freeing it here will result in a segmentation fault.
| UHD_API uhd_error uhd_rx_metadata_has_time_spec | ( | uhd_rx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Has time specification?
| UHD_API uhd_error uhd_rx_metadata_last_error | ( | uhd_rx_metadata_handle | h, |
| char * | error_out, | ||
| size_t | strbuffer_len | ||
| ) |
Get the last error logged by the RX metadata object.
NOTES:
| h | metadata handle |
| error_out | string buffer for error |
| strbuffer_len | buffer length |
| UHD_API uhd_error uhd_rx_metadata_make | ( | uhd_rx_metadata_handle * | handle | ) |
Create a new RX metadata handle.
| UHD_API uhd_error uhd_rx_metadata_more_fragments | ( | uhd_rx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Fragmentation flag.
| UHD_API uhd_error uhd_rx_metadata_out_of_sequence | ( | uhd_rx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Result out of sequence?
| UHD_API uhd_error uhd_rx_metadata_start_of_burst | ( | uhd_rx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Start of burst?
| UHD_API uhd_error uhd_rx_metadata_strerror | ( | uhd_rx_metadata_handle | h, |
| char * | strerror_out, | ||
| size_t | strbuffer_len | ||
| ) |
Get a string representation of the last error state of the RX metadata object.
NOTES:
| h | metadata handle |
| strerror_out | string buffer for strerror |
| strbuffer_len | buffer length |
| UHD_API uhd_error uhd_rx_metadata_time_spec | ( | uhd_rx_metadata_handle | h, |
| int64_t * | full_secs_out, | ||
| double * | frac_secs_out | ||
| ) |
Time of first sample.
| UHD_API uhd_error uhd_rx_metadata_to_pp_string | ( | uhd_rx_metadata_handle | h, |
| char * | pp_string_out, | ||
| size_t | strbuffer_len | ||
| ) |
Return a pretty-print representation of this metadata.
NOTE: This function will overwrite any string in the given buffer before inserting the pp_string.
| h | metadata handle |
| pp_string_out | string buffer for pp_string |
| strbuffer_len | buffer length |
| UHD_API uhd_error uhd_tx_metadata_end_of_burst | ( | uhd_tx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
End of burst?
| UHD_API uhd_error uhd_tx_metadata_free | ( | uhd_tx_metadata_handle * | handle | ) |
Free an TX metadata handle.
Using a handle after freeing it here will result in a segmentation fault.
| UHD_API uhd_error uhd_tx_metadata_has_time_spec | ( | uhd_tx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Has time specification?
| UHD_API uhd_error uhd_tx_metadata_last_error | ( | uhd_tx_metadata_handle | h, |
| char * | error_out, | ||
| size_t | strbuffer_len | ||
| ) |
Get the last error logged by the TX metadata object.
NOTE: This function will overwrite any string in the given buffer before inserting the error string.
| h | metadata handle |
| error_out | string buffer for error |
| strbuffer_len | buffer length |
| UHD_API uhd_error uhd_tx_metadata_make | ( | uhd_tx_metadata_handle * | handle, |
| bool | has_time_spec, | ||
| int64_t | full_secs, | ||
| double | frac_secs, | ||
| bool | start_of_burst, | ||
| bool | end_of_burst | ||
| ) |
Create a new TX metadata handle.
| UHD_API uhd_error uhd_tx_metadata_start_of_burst | ( | uhd_tx_metadata_handle | h, |
| bool * | result_out | ||
| ) |
Start of burst?
| UHD_API uhd_error uhd_tx_metadata_time_spec | ( | uhd_tx_metadata_handle | h, |
| int64_t * | full_secs_out, | ||
| double * | frac_secs_out | ||
| ) |
Get time specification.
1.8.13