/usr/include/uhd/usrp/usrp.h is in libuhd-dev 3.10.3.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 | //
// Copyright 2015-2016 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_UHD_USRP_H
#define INCLUDED_UHD_USRP_H
#include <uhd/config.h>
#include <uhd/error.h>
#include <uhd/types/metadata.h>
#include <uhd/types/ranges.h>
#include <uhd/types/sensors.h>
#include <uhd/types/string_vector.h>
#include <uhd/types/tune_request.h>
#include <uhd/types/tune_result.h>
#include <uhd/types/usrp_info.h>
#include <uhd/usrp/mboard_eeprom.h>
#include <uhd/usrp/dboard_eeprom.h>
#include <uhd/usrp/subdev_spec.h>
/* version.hpp is safe to include in C: */
#include <uhd/version.hpp> /* Provides UHD_VERSION */
#include <stdbool.h>
#include <stdlib.h>
#include <stdint.h>
#include <time.h>
//! Register info
typedef struct {
size_t bitwidth;
bool readable;
bool writable;
} uhd_usrp_register_info_t;
/*
* Streamers
*/
//! A struct of parameters to construct a stream.
/*!
* See uhd::stream_args_t for more details.
*/
typedef struct {
//! Format of host memory
char* cpu_format;
//! Over-the-wire format
char* otw_format;
//! Other stream args
char* args;
//! Array that lists channels
size_t* channel_list;
//! Number of channels
int n_channels;
} uhd_stream_args_t;
//! How streaming is issued to the device
/*!
* See uhd::stream_cmd_t for more details.
*/
typedef enum {
//! Stream samples indefinitely
UHD_STREAM_MODE_START_CONTINUOUS = 97,
//! End continuous streaming
UHD_STREAM_MODE_STOP_CONTINUOUS = 111,
//! Stream some number of samples and finish
UHD_STREAM_MODE_NUM_SAMPS_AND_DONE = 100,
//! Stream some number of samples but expect more
UHD_STREAM_MODE_NUM_SAMPS_AND_MORE = 109
} uhd_stream_mode_t;
//! Define how device streams to host
/*!
* See uhd::stream_cmd_t for more details.
*/
typedef struct {
//! How streaming is issued to the device
uhd_stream_mode_t stream_mode;
//! Number of samples
size_t num_samps;
//! Stream now?
bool stream_now;
//! If not now, then full seconds into future to stream
time_t time_spec_full_secs;
//! If not now, then fractional seconds into future to stream
double time_spec_frac_secs;
} uhd_stream_cmd_t;
struct uhd_rx_streamer;
struct uhd_tx_streamer;
//! C-level interface for working with an RX streamer
/*!
* See uhd::rx_streamer for more details.
*/
typedef struct uhd_rx_streamer* uhd_rx_streamer_handle;
//! C-level interface for working with a TX streamer
/*!
* See uhd::tx_streamer for more details.
*/
typedef struct uhd_tx_streamer* uhd_tx_streamer_handle;
#ifdef __cplusplus
extern "C" {
#endif
/*
* RX Streamer
*/
//! Create an RX streamer handle.
/*!
* NOTE: Using this streamer before passing it into uhd_usrp_get_rx_stream()
* will result in undefined behavior.
*/
UHD_API uhd_error uhd_rx_streamer_make(
uhd_rx_streamer_handle *h
);
//! Free an RX streamer handle.
/*!
* NOTE: Using a streamer after passing it into this function will result
* in a segmentation fault.
*/
UHD_API uhd_error uhd_rx_streamer_free(
uhd_rx_streamer_handle *h
);
//! Get the number of channels associated with this streamer
UHD_API uhd_error uhd_rx_streamer_num_channels(
uhd_rx_streamer_handle h,
size_t *num_channels_out
);
//! Get the max number of samples per buffer per packet
UHD_API uhd_error uhd_rx_streamer_max_num_samps(
uhd_rx_streamer_handle h,
size_t *max_num_samps_out
);
//! Receive buffers containing samples into the given RX streamer
/*!
* See uhd::rx_streamer::recv() for more details.
*
* \param h RX streamer handle
* \param buffs pointer to buffers in which to receive samples
* \param samps_per_buff max number of samples per buffer
* \param md handle to RX metadata in which to receive results
* \param timeout timeout in seconds to wait for a packet
* \param one_packet send a single packet
* \param items_recvd pointer to output variable for number of samples received
*/
UHD_API uhd_error uhd_rx_streamer_recv(
uhd_rx_streamer_handle h,
void** buffs,
size_t samps_per_buff,
uhd_rx_metadata_handle *md,
double timeout,
bool one_packet,
size_t *items_recvd
);
//! Issue the given stream command
/*!
* See uhd::rx_streamer::issue_stream_cmd() for more details.
*/
UHD_API uhd_error uhd_rx_streamer_issue_stream_cmd(
uhd_rx_streamer_handle h,
const uhd_stream_cmd_t *stream_cmd
);
//! Get the last error reported by the RX streamer
/*!
* NOTE: This will overwrite the string currently in error_out before
* using it to return its error.
*
* \param h RX streamer handle
* \param error_out string buffer in which to place error
* \param strbuffer_len buffer size
*/
UHD_API uhd_error uhd_rx_streamer_last_error(
uhd_rx_streamer_handle h,
char* error_out,
size_t strbuffer_len
);
/*
* TX Streamer
*/
//! Create an TX streamer handle.
/*!
* NOTE: Using this streamer before passing it into uhd_usrp_get_tx_stream()
* will result in undefined behavior.
*/
UHD_API uhd_error uhd_tx_streamer_make(
uhd_tx_streamer_handle *h
);
//! Free an TX streamer handle.
/*!
* NOTE: Using a streamer after passing it into this function will result
* in a segmentation fault.
*/
UHD_API uhd_error uhd_tx_streamer_free(
uhd_tx_streamer_handle *h
);
//! Get the number of channels associated with this streamer
UHD_API uhd_error uhd_tx_streamer_num_channels(
uhd_tx_streamer_handle h,
size_t *num_channels_out
);
//! Get the max number of samples per buffer per packet
UHD_API uhd_error uhd_tx_streamer_max_num_samps(
uhd_tx_streamer_handle h,
size_t *max_num_samps_out
);
//! Send buffers containing samples described by the metadata
/*!
* See uhd::tx_streamer::send() for more details.
*
* \param h TX streamer handle
* \param buffs pointer to buffers containing samples to send
* \param samps_per_buff max number of samples per buffer
* \param md handle to TX metadata
* \param timeout timeout in seconds to wait for a packet
* \param items_sent pointer to output variable for number of samples send
*/
UHD_API uhd_error uhd_tx_streamer_send(
uhd_tx_streamer_handle h,
const void **buffs,
size_t samps_per_buff,
uhd_tx_metadata_handle *md,
double timeout,
size_t *items_sent
);
//! Receive an asynchronous message from this streamer
/*!
* See uhd::tx_streamer::recv_async_msg() for more details.
*/
UHD_API uhd_error uhd_tx_streamer_recv_async_msg(
uhd_tx_streamer_handle h,
uhd_async_metadata_handle *md,
double timeout,
bool *valid
);
//! Get the last error reported by the TX streamer
/*!
* NOTE: This will overwrite the string currently in error_out before
* using it to return its error.
*
* \param h TX streamer handle
* \param error_out string buffer in which to place error
* \param strbuffer_len buffer size
*/
UHD_API uhd_error uhd_tx_streamer_last_error(
uhd_tx_streamer_handle h,
char* error_out,
size_t strbuffer_len
);
#ifdef __cplusplus
}
#endif
/****************************************************************************
* Public Datatypes for USRP / streamer handling.
***************************************************************************/
struct uhd_usrp;
//! C-level interface for working with a USRP device
/*
* See uhd::usrp::multi_usrp for more details.
*
* NOTE: You must pass this handle into uhd_usrp_make before using it.
*/
typedef struct uhd_usrp* uhd_usrp_handle;
/****************************************************************************
* USRP Make / Free API calls
***************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif
//! Find all connected USRP devices.
/*!
* See uhd::device::find() for more details.
*/
UHD_API uhd_error uhd_usrp_find(
const char* args,
uhd_string_vector_handle *strings_out
);
//! Create a USRP handle.
/*!
* \param h the handle
* \param args device args (e.g. "type=x300")
*/
UHD_API uhd_error uhd_usrp_make(
uhd_usrp_handle *h,
const char *args
);
//! Safely destroy the USRP object underlying the handle.
/*!
* NOTE: Attempting to use a USRP handle after passing it into this function
* will result in a segmentation fault.
*/
UHD_API uhd_error uhd_usrp_free(
uhd_usrp_handle *h
);
//! Get the last error reported by the USRP handle
UHD_API uhd_error uhd_usrp_last_error(
uhd_usrp_handle h,
char* error_out,
size_t strbuffer_len
);
//! Create RX streamer from a USRP handle and given stream args
UHD_API uhd_error uhd_usrp_get_rx_stream(
uhd_usrp_handle h,
uhd_stream_args_t *stream_args,
uhd_rx_streamer_handle h_out
);
//! Create TX streamer from a USRP handle and given stream args
UHD_API uhd_error uhd_usrp_get_tx_stream(
uhd_usrp_handle h,
uhd_stream_args_t *stream_args,
uhd_tx_streamer_handle h_out
);
/****************************************************************************
* multi_usrp API calls
***************************************************************************/
//! Get RX info from the USRP device
/*!
* NOTE: After calling this function, uhd_usrp_rx_info_free() must be called on info_out.
*/
UHD_API uhd_error uhd_usrp_get_rx_info(
uhd_usrp_handle h,
size_t chan,
uhd_usrp_rx_info_t *info_out
);
//! Get TX info from the USRP device
/*!
* NOTE: After calling this function, uhd_usrp_tx_info_free() must be called on info_out.
*/
UHD_API uhd_error uhd_usrp_get_tx_info(
uhd_usrp_handle h,
size_t chan,
uhd_usrp_tx_info_t *info_out
);
/****************************************************************************
* Motherboard methods
***************************************************************************/
//! Set the master clock rate.
/*!
* See uhd::usrp::multi_usrp::set_master_clock_rate() for more details.
*/
UHD_API uhd_error uhd_usrp_set_master_clock_rate(
uhd_usrp_handle h,
double rate,
size_t mboard
);
//! Get the master clock rate.
/*!
* See uhd::usrp::multi_usrp::get_master_clock_rate() for more details.
*/
UHD_API uhd_error uhd_usrp_get_master_clock_rate(
uhd_usrp_handle h,
size_t mboard,
double *clock_rate_out
);
//! Get a pretty-print representation of the USRP device.
/*!
* See uhd::usrp::multi_usrp::get_pp_string() for more details.
*/
UHD_API uhd_error uhd_usrp_get_pp_string(
uhd_usrp_handle h,
char* pp_string_out,
size_t strbuffer_len
);
//! Get the motherboard name for the given device
/*!
* See uhd::usrp::multi_usrp::get_mboard_name() for more details.
*/
UHD_API uhd_error uhd_usrp_get_mboard_name(
uhd_usrp_handle h,
size_t mboard,
char* mboard_name_out,
size_t strbuffer_len
);
//! Get the USRP device's current internal time
/*!
* See uhd::usrp::multi_usrp::get_time_now() for more details.
*/
UHD_API uhd_error uhd_usrp_get_time_now(
uhd_usrp_handle h,
size_t mboard,
time_t *full_secs_out,
double *frac_secs_out
);
//! Get the time when this device's last PPS pulse occurred
/*!
* See uhd::usrp::multi_usrp::get_time_last_pps() for more details.
*/
UHD_API uhd_error uhd_usrp_get_time_last_pps(
uhd_usrp_handle h,
size_t mboard,
time_t *full_secs_out,
double *frac_secs_out
);
//! Set the USRP device's time
/*!
* See uhd::usrp::multi_usrp::set_time_now() for more details.
*/
UHD_API uhd_error uhd_usrp_set_time_now(
uhd_usrp_handle h,
time_t full_secs,
double frac_secs,
size_t mboard
);
//! Set the USRP device's time to the given value upon the next PPS detection
/*!
* See uhd::usrp::multi_usrp::set_time_next_pps() for more details.
*/
UHD_API uhd_error uhd_usrp_set_time_next_pps(
uhd_usrp_handle h,
time_t full_secs,
double frac_secs,
size_t mboard
);
//! Synchronize the time across all motherboards
/*!
* See uhd::usrp::multi_usrp::set_time_unknown_pps() for more details.
*/
UHD_API uhd_error uhd_usrp_set_time_unknown_pps(
uhd_usrp_handle h,
time_t full_secs,
double frac_secs
);
//! Are all motherboard times synchronized?
UHD_API uhd_error uhd_usrp_get_time_synchronized(
uhd_usrp_handle h,
bool *result_out
);
//! Set the time at which timed commands will take place
/*!
* See uhd::usrp::multi_usrp::set_command_time() for more details.
*/
UHD_API uhd_error uhd_usrp_set_command_time(
uhd_usrp_handle h,
time_t full_secs,
double frac_secs,
size_t mboard
);
//! Clear the command time so that commands are sent ASAP
UHD_API uhd_error uhd_usrp_clear_command_time(
uhd_usrp_handle h,
size_t mboard
);
//! Set the time source for the given device
/*!
* See uhd::usrp::multi_usrp::set_time_source() for more details.
*/
UHD_API uhd_error uhd_usrp_set_time_source(
uhd_usrp_handle h,
const char* time_source,
size_t mboard
);
//! Get the time source for the given device
/*!
* See uhd::usrp::multi_usrp::get_time_source() for more details.
*/
UHD_API uhd_error uhd_usrp_get_time_source(
uhd_usrp_handle h,
size_t mboard,
char* time_source_out,
size_t strbuffer_len
);
//! Get a list of time sources for the given device
UHD_API uhd_error uhd_usrp_get_time_sources(
uhd_usrp_handle h,
size_t mboard,
uhd_string_vector_handle *time_sources_out
);
//! Set the given device's clock source
/*!
* See uhd::usrp::multi_usrp::set_clock_source() for more details.
*/
UHD_API uhd_error uhd_usrp_set_clock_source(
uhd_usrp_handle h,
const char* clock_source,
size_t mboard
);
//! Get the given device's clock source
/*!
* See uhd::usrp::multi_usrp::get_clock_source() for more details.
*/
UHD_API uhd_error uhd_usrp_get_clock_source(
uhd_usrp_handle h,
size_t mboard,
char* clock_source_out,
size_t strbuffer_len
);
//! Get a list of clock sources for the given device
UHD_API uhd_error uhd_usrp_get_clock_sources(
uhd_usrp_handle h,
size_t mboard,
uhd_string_vector_handle *clock_sources_out
);
//! Enable or disable sending the clock source to an output connector
/*!
* See uhd::usrp::set_clock_source_out() for more details.
*/
UHD_API uhd_error uhd_usrp_set_clock_source_out(
uhd_usrp_handle h,
bool enb,
size_t mboard
);
//! Enable or disable sending the time source to an output connector
/*!
* See uhd::usrp::set_time_source_out() for more details.
*/
UHD_API uhd_error uhd_usrp_set_time_source_out(
uhd_usrp_handle h,
bool enb,
size_t mboard
);
//! Get the number of devices associated with the given USRP handle
UHD_API uhd_error uhd_usrp_get_num_mboards(
uhd_usrp_handle h,
size_t *num_mboards_out
);
//! Get the value associated with the given sensor name
UHD_API uhd_error uhd_usrp_get_mboard_sensor(
uhd_usrp_handle h,
const char* name,
size_t mboard,
uhd_sensor_value_handle *sensor_value_out
);
//! Get a list of motherboard sensors for the given device
UHD_API uhd_error uhd_usrp_get_mboard_sensor_names(
uhd_usrp_handle h,
size_t mboard,
uhd_string_vector_handle *mboard_sensor_names_out
);
//! Perform a write on a user configuration register bus
/*!
* See uhd::usrp::multi_usrp::set_user_register() for more details.
*/
UHD_API uhd_error uhd_usrp_set_user_register(
uhd_usrp_handle h,
uint8_t addr,
uint32_t data,
size_t mboard
);
/****************************************************************************
* EEPROM access methods
***************************************************************************/
//! Get a handle for the given motherboard's EEPROM
UHD_API uhd_error uhd_usrp_get_mboard_eeprom(
uhd_usrp_handle h,
uhd_mboard_eeprom_handle mb_eeprom,
size_t mboard
);
//! Set values in the given motherboard's EEPROM
UHD_API uhd_error uhd_usrp_set_mboard_eeprom(
uhd_usrp_handle h,
uhd_mboard_eeprom_handle mb_eeprom,
size_t mboard
);
//! Get a handle for the given device's daughterboard EEPROM
UHD_API uhd_error uhd_usrp_get_dboard_eeprom(
uhd_usrp_handle h,
uhd_dboard_eeprom_handle db_eeprom,
const char* unit,
const char* slot,
size_t mboard
);
//! Set values in the given daughterboard's EEPROM
UHD_API uhd_error uhd_usrp_set_dboard_eeprom(
uhd_usrp_handle h,
uhd_dboard_eeprom_handle db_eeprom,
const char* unit,
const char* slot,
size_t mboard
);
/****************************************************************************
* RX methods
***************************************************************************/
//! Map the given device's RX frontend to a channel
/*!
* See uhd::usrp::multi_usrp::set_rx_subdev_spec() for more details.
*/
UHD_API uhd_error uhd_usrp_set_rx_subdev_spec(
uhd_usrp_handle h,
uhd_subdev_spec_handle subdev_spec,
size_t mboard
);
//! Get the RX frontend specification for the given device
UHD_API uhd_error uhd_usrp_get_rx_subdev_spec(
uhd_usrp_handle h,
size_t mboard,
uhd_subdev_spec_handle subdev_spec_out
);
//! Get the number of RX channels for the given handle
UHD_API uhd_error uhd_usrp_get_rx_num_channels(
uhd_usrp_handle h,
size_t *num_channels_out
);
//! Get the name for the RX frontend
UHD_API uhd_error uhd_usrp_get_rx_subdev_name(
uhd_usrp_handle h,
size_t chan,
char* rx_subdev_name_out,
size_t strbuffer_len
);
//! Set the given RX channel's sample rate (in Sps)
UHD_API uhd_error uhd_usrp_set_rx_rate(
uhd_usrp_handle h,
double rate,
size_t chan
);
//! Get the given RX channel's sample rate (in Sps)
UHD_API uhd_error uhd_usrp_get_rx_rate(
uhd_usrp_handle h,
size_t chan,
double *rate_out
);
//! Get a range of possible RX rates for the given channel
UHD_API uhd_error uhd_usrp_get_rx_rates(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle rates_out
);
//! Set the given channel's center RX frequency
UHD_API uhd_error uhd_usrp_set_rx_freq(
uhd_usrp_handle h,
uhd_tune_request_t *tune_request,
size_t chan,
uhd_tune_result_t *tune_result
);
//! Get the given channel's center RX frequency
UHD_API uhd_error uhd_usrp_get_rx_freq(
uhd_usrp_handle h,
size_t chan,
double *freq_out
);
//! Get all possible center frequency ranges for the given channel
/*!
* See uhd::usrp::multi_usrp::get_rx_freq_range() for more details.
*/
UHD_API uhd_error uhd_usrp_get_rx_freq_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle freq_range_out
);
//! Get all possible RF frequency ranges for the given channel's RX RF frontend
UHD_API uhd_error uhd_usrp_get_fe_rx_freq_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle freq_range_out
);
//! A wildcard for all LO names
UHD_UNUSED(static const char* UHD_USRP_ALL_LOS) = "all";
//! Get a list of possible LO stage names
/*
* See uhd::usrp::multi_usrp::get_rx_lo_names() for more details.
*/
UHD_API uhd_error uhd_usrp_get_rx_lo_names(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *rx_lo_names_out
);
//! Set the LO source for the USRP device
/*
* See uhd::usrp::multi_usrp::set_rx_lo_source() for more details.
*/
UHD_API uhd_error uhd_usrp_set_rx_lo_source(
uhd_usrp_handle h,
const char* src,
const char* name,
size_t chan
);
//! Get the currently set LO source
UHD_API uhd_error uhd_usrp_get_rx_lo_source(
uhd_usrp_handle h,
const char* name,
size_t chan,
char* rx_lo_source_out,
size_t strbuffer_len
);
//! Get a list of possible LO sources
UHD_API uhd_error uhd_usrp_get_rx_lo_sources(
uhd_usrp_handle h,
const char* name,
size_t chan,
uhd_string_vector_handle *rx_lo_sources_out
);
//! Set whether the LO used by the USRP device is exported
/*
* See uhd::usrp::multi_usrp::set_rx_lo_enabled() for more details.
*/
UHD_API uhd_error uhd_usrp_set_rx_lo_export_enabled(
uhd_usrp_handle h,
bool enabled,
const char* name,
size_t chan
);
//! Returns true if the currently selected LO is being exported.
UHD_API uhd_error uhd_usrp_get_rx_lo_export_enabled(
uhd_usrp_handle h,
const char* name,
size_t chan,
bool* result_out
);
//! Set the RX LO frequency.
UHD_API uhd_error uhd_usrp_set_rx_lo_freq(
uhd_usrp_handle h,
double freq,
const char* name,
size_t chan,
double* coerced_freq_out
);
//! Get the current RX LO frequency.
UHD_API uhd_error uhd_usrp_get_rx_lo_freq(
uhd_usrp_handle h,
const char* name,
size_t chan,
double* rx_lo_freq_out
);
//! Set the RX gain for the given channel and name
UHD_API uhd_error uhd_usrp_set_rx_gain(
uhd_usrp_handle h,
double gain,
size_t chan,
const char *gain_name
);
//! Set the normalized RX gain [0.0, 1.0] for the given channel
/*!
* See uhd::usrp::multi_usrp::set_normalized_rx_gain() for more details.
*/
UHD_API uhd_error uhd_usrp_set_normalized_rx_gain(
uhd_usrp_handle h,
double gain,
size_t chan
);
//! Enable or disable the given channel's RX AGC module
/*!
* See uhd::usrp::multi_usrp::set_rx_agc() for more details.
*/
UHD_API uhd_error uhd_usrp_set_rx_agc(
uhd_usrp_handle h,
bool enable,
size_t chan
);
//! Get the given channel's RX gain
UHD_API uhd_error uhd_usrp_get_rx_gain(
uhd_usrp_handle h,
size_t chan,
const char *gain_name,
double *gain_out
);
//! Get the given channel's normalized RX gain [0.0, 1.0]
/*!
* See uhd::usrp::multi_usrp::get_normalized_rx_gain() for more details.
*/
UHD_API uhd_error uhd_usrp_get_normalized_rx_gain(
uhd_usrp_handle h,
size_t chan,
double *gain_out
);
//! Get all possible gain ranges for the given channel and name
UHD_API uhd_error uhd_usrp_get_rx_gain_range(
uhd_usrp_handle h,
const char* name,
size_t chan,
uhd_meta_range_handle gain_range_out
);
//! Get a list of RX gain names for the given channel
UHD_API uhd_error uhd_usrp_get_rx_gain_names(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *gain_names_out
);
//! Set the RX antenna for the given channel
UHD_API uhd_error uhd_usrp_set_rx_antenna(
uhd_usrp_handle h,
const char* ant,
size_t chan
);
//! Get the RX antenna for the given channel
UHD_API uhd_error uhd_usrp_get_rx_antenna(
uhd_usrp_handle h,
size_t chan,
char* ant_out,
size_t strbuffer_len
);
//! Get a list of RX antennas associated with the given channels
UHD_API uhd_error uhd_usrp_get_rx_antennas(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *antennas_out
);
//! Get a list of RX sensors associated with the given channels
UHD_API uhd_error uhd_usrp_get_rx_sensor_names(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *sensor_names_out
);
//! Set the bandwidth for the given channel's RX frontend
UHD_API uhd_error uhd_usrp_set_rx_bandwidth(
uhd_usrp_handle h,
double bandwidth,
size_t chan
);
//! Get the bandwidth for the given channel's RX frontend
UHD_API uhd_error uhd_usrp_get_rx_bandwidth(
uhd_usrp_handle h,
size_t chan,
double *bandwidth_out
);
//! Get all possible bandwidth ranges for the given channel's RX frontend
UHD_API uhd_error uhd_usrp_get_rx_bandwidth_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle bandwidth_range_out
);
//! Get the value for the given RX sensor
UHD_API uhd_error uhd_usrp_get_rx_sensor(
uhd_usrp_handle h,
const char* name,
size_t chan,
uhd_sensor_value_handle *sensor_value_out
);
//! Enable or disable RX DC offset correction for the given channel
/*!
* See uhd::usrp::multi_usrp::set_rx_dc_offset() for more details.
*/
UHD_API uhd_error uhd_usrp_set_rx_dc_offset_enabled(
uhd_usrp_handle h,
bool enb,
size_t chan
);
//! Enable or disable RX IQ imbalance correction for the given channel
UHD_API uhd_error uhd_usrp_set_rx_iq_balance_enabled(
uhd_usrp_handle h,
bool enb,
size_t chan
);
/****************************************************************************
* TX methods
***************************************************************************/
//! Map the given device's TX frontend to a channel
/*!
* See uhd::usrp::multi_usrp::set_tx_subdev_spec() for more details.
*/
UHD_API uhd_error uhd_usrp_set_tx_subdev_spec(
uhd_usrp_handle h,
uhd_subdev_spec_handle subdev_spec,
size_t mboard
);
//! Get the TX frontend specification for the given device
UHD_API uhd_error uhd_usrp_get_tx_subdev_spec(
uhd_usrp_handle h,
size_t mboard,
uhd_subdev_spec_handle subdev_spec_out
);
//! Get the number of TX channels for the given handle
UHD_API uhd_error uhd_usrp_get_tx_num_channels(
uhd_usrp_handle h,
size_t *num_channels_out
);
//! Get the name for the RX frontend
UHD_API uhd_error uhd_usrp_get_tx_subdev_name(
uhd_usrp_handle h,
size_t chan,
char* tx_subdev_name_out,
size_t strbuffer_len
);
//! Set the given RX channel's sample rate (in Sps)
UHD_API uhd_error uhd_usrp_set_tx_rate(
uhd_usrp_handle h,
double rate,
size_t chan
);
//! Get the given RX channel's sample rate (in Sps)
UHD_API uhd_error uhd_usrp_get_tx_rate(
uhd_usrp_handle h,
size_t chan,
double *rate_out
);
//! Get a range of possible RX rates for the given channel
UHD_API uhd_error uhd_usrp_get_tx_rates(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle rates_out
);
//! Set the given channel's center TX frequency
UHD_API uhd_error uhd_usrp_set_tx_freq(
uhd_usrp_handle h,
uhd_tune_request_t *tune_request,
size_t chan,
uhd_tune_result_t *tune_result
);
//! Get the given channel's center TX frequency
UHD_API uhd_error uhd_usrp_get_tx_freq(
uhd_usrp_handle h,
size_t chan,
double *freq_out
);
//! Get all possible center frequency ranges for the given channel
/*!
* See uhd::usrp::multi_usrp::get_rx_freq_range() for more details.
*/
UHD_API uhd_error uhd_usrp_get_tx_freq_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle freq_range_out
);
//! Get all possible RF frequency ranges for the given channel's TX RF frontend
UHD_API uhd_error uhd_usrp_get_fe_tx_freq_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle freq_range_out
);
//! Set the TX gain for the given channel and name
UHD_API uhd_error uhd_usrp_set_tx_gain(
uhd_usrp_handle h,
double gain,
size_t chan,
const char *gain_name
);
//! Set the normalized TX gain [0.0, 1.0] for the given channel
/*!
* See uhd::usrp::multi_usrp::set_normalized_tx_gain() for more details.
*/
UHD_API uhd_error uhd_usrp_set_normalized_tx_gain(
uhd_usrp_handle h,
double gain,
size_t chan
);
//! Get all possible gain ranges for the given channel and name
UHD_API uhd_error uhd_usrp_get_tx_gain_range(
uhd_usrp_handle h,
const char* name,
size_t chan,
uhd_meta_range_handle gain_range_out
);
//! Get the given channel's RX gain
UHD_API uhd_error uhd_usrp_get_tx_gain(
uhd_usrp_handle h,
size_t chan,
const char *gain_name,
double *gain_out
);
//! Get the given channel's normalized TX gain [0.0, 1.0]
/*!
* See uhd::usrp::multi_usrp::get_normalized_tx_gain() for more details.
*/
UHD_API uhd_error uhd_usrp_get_normalized_tx_gain(
uhd_usrp_handle h,
size_t chan,
double *gain_out
);
//! Get a list of TX gain names for the given channel
UHD_API uhd_error uhd_usrp_get_tx_gain_names(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *gain_names_out
);
//! Set the TX antenna for the given channel
UHD_API uhd_error uhd_usrp_set_tx_antenna(
uhd_usrp_handle h,
const char* ant,
size_t chan
);
//! Get the TX antenna for the given channel
UHD_API uhd_error uhd_usrp_get_tx_antenna(
uhd_usrp_handle h,
size_t chan,
char* ant_out,
size_t strbuffer_len
);
//! Get a list of tx antennas associated with the given channels
UHD_API uhd_error uhd_usrp_get_tx_antennas(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *antennas_out
);
//! Set the bandwidth for the given channel's TX frontend
UHD_API uhd_error uhd_usrp_set_tx_bandwidth(
uhd_usrp_handle h,
double bandwidth,
size_t chan
);
//! Get the bandwidth for the given channel's TX frontend
UHD_API uhd_error uhd_usrp_get_tx_bandwidth(
uhd_usrp_handle h,
size_t chan,
double *bandwidth_out
);
//! Get all possible bandwidth ranges for the given channel's TX frontend
UHD_API uhd_error uhd_usrp_get_tx_bandwidth_range(
uhd_usrp_handle h,
size_t chan,
uhd_meta_range_handle bandwidth_range_out
);
//! Get the value for the given TX sensor
UHD_API uhd_error uhd_usrp_get_tx_sensor(
uhd_usrp_handle h,
const char* name,
size_t chan,
uhd_sensor_value_handle *sensor_value_out
);
//! Get a list of TX sensors associated with the given channels
UHD_API uhd_error uhd_usrp_get_tx_sensor_names(
uhd_usrp_handle h,
size_t chan,
uhd_string_vector_handle *sensor_names_out
);
//! Enable or disable TX DC offset correction for the given channel
/*!
* See uhd::usrp::multi_usrp::set_tx_dc_offset() for more details.
*/
UHD_API uhd_error uhd_usrp_set_tx_dc_offset_enabled(
uhd_usrp_handle h,
bool enb,
size_t chan
);
//! Enable or disable TX IQ imbalance correction for the given channel
UHD_API uhd_error uhd_usrp_set_tx_iq_balance_enabled(
uhd_usrp_handle h,
bool enb,
size_t chan
);
/****************************************************************************
* GPIO methods
***************************************************************************/
//! Get a list of GPIO banks associated with the given channels
UHD_API uhd_error uhd_usrp_get_gpio_banks(
uhd_usrp_handle h,
size_t mboard,
uhd_string_vector_handle *gpio_banks_out
);
//! Set a GPIO attribute for a given GPIO bank
/*!
* See uhd::usrp::multi_usrp::set_gpio_attr() for more details.
*/
UHD_API uhd_error uhd_usrp_set_gpio_attr(
uhd_usrp_handle h,
const char* bank,
const char* attr,
uint32_t value,
uint32_t mask,
size_t mboard
);
//! Get a GPIO attribute on a particular GPIO bank
/*!
* See uhd::usrp::multi_usrp::get_gpio_attr() for more details.
*/
UHD_API uhd_error uhd_usrp_get_gpio_attr(
uhd_usrp_handle h,
const char* bank,
const char* attr,
size_t mboard,
uint32_t *attr_out
);
//! Enumerate the full paths of USRP registers available for read/write
UHD_API uhd_error uhd_usrp_enumerate_registers(
uhd_usrp_handle h,
size_t mboard,
uhd_string_vector_handle *registers_out
);
//! Get more information about a low-level device register
UHD_API uhd_error uhd_usrp_get_register_info(
uhd_usrp_handle h,
const char* path,
size_t mboard,
uhd_usrp_register_info_t *register_info_out
);
//! Write a low-level register field for a device register in the USRP hardware
UHD_API uhd_error uhd_usrp_write_register(
uhd_usrp_handle h,
const char* path,
uint32_t field,
uint64_t value,
size_t mboard
);
//! Read a low-level register field from a device register in the USRP hardware
UHD_API uhd_error uhd_usrp_read_register(
uhd_usrp_handle h,
const char* path,
uint32_t field,
size_t mboard,
uint64_t *value_out
);
#ifdef __cplusplus
}
#endif
#endif /* INCLUDED_UHD_USRP_H */
|