USRP Hardware Driver and USRP Manual Version: 4.1.0.1
UHD and USRP Manual
usrp_clock.h
Go to the documentation of this file.
1//
2// Copyright 2015 Ettus Research LLC
3// Copyright 2018 Ettus Research, a National Instruments Company
4//
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
7
8#pragma once
9
10#include <uhd/config.h>
11#include <uhd/error.h>
12#include <uhd/types/sensors.h>
14
15#include <stdlib.h>
16#include <stdint.h>
17#include <time.h>
18
19/****************************************************************************
20 * Public Datatypes for USRP clock
21 ***************************************************************************/
22struct uhd_usrp_clock;
23
25
31typedef struct uhd_usrp_clock* uhd_usrp_clock_handle;
32
33/****************************************************************************
34 * Make / Free API calls
35 ***************************************************************************/
36#ifdef __cplusplus
37extern "C" {
38#endif
39
41
45 const char* args,
46 uhd_string_vector_t *devices_out
47);
48
50
56 const char *args
57);
58
60
66);
67
71 char* error_out,
72 size_t strbuffer_len
73);
74
78 char* pp_string_out,
79 size_t strbuffer_len
80);
81
85 size_t *num_boards_out
86);
87
91 size_t board,
92 uint32_t *clock_time_out
93);
94
98 const char* name,
99 size_t board,
100 uhd_sensor_value_handle *sensor_value_out
101);
102
106 size_t board,
107 uhd_string_vector_handle *sensor_names_out
108);
109
110#ifdef __cplusplus
111}
112#endif
#define UHD_API
Definition: config.h:70
uhd_error
UHD error codes.
Definition: error.h:20
struct uhd_sensor_value_t * uhd_sensor_value_handle
C-level interface for a UHD sensor.
Definition: sensors.h:33
struct uhd_string_vector_t uhd_string_vector_t
Definition: string_vector.h:30
uhd_string_vector_t * uhd_string_vector_handle
Definition: string_vector.h:32
UHD_API uhd_error uhd_usrp_clock_free(uhd_usrp_clock_handle *h)
Safely destroy the clock object underlying the handle.
UHD_API uhd_error uhd_usrp_clock_get_time(uhd_usrp_clock_handle h, size_t board, uint32_t *clock_time_out)
Get time.
UHD_API uhd_error uhd_usrp_clock_find(const char *args, uhd_string_vector_t *devices_out)
Find all connected clock devices.
UHD_API uhd_error uhd_usrp_clock_get_sensor_names(uhd_usrp_clock_handle h, size_t board, uhd_string_vector_handle *sensor_names_out)
Get sensor names.
UHD_API uhd_error uhd_usrp_clock_get_num_boards(uhd_usrp_clock_handle h, size_t *num_boards_out)
Get number of boards.
UHD_API uhd_error uhd_usrp_clock_get_sensor(uhd_usrp_clock_handle h, const char *name, size_t board, uhd_sensor_value_handle *sensor_value_out)
Get sensor.
struct uhd_usrp_clock * uhd_usrp_clock_handle
A C-level interface for interacting with an Ettus Research clock device.
Definition: usrp_clock.h:31
UHD_API uhd_error uhd_usrp_clock_get_pp_string(uhd_usrp_clock_handle h, char *pp_string_out, size_t strbuffer_len)
Get board information in a nice output.
UHD_API uhd_error uhd_usrp_clock_last_error(uhd_usrp_clock_handle h, char *error_out, size_t strbuffer_len)
Get last error.
UHD_API uhd_error uhd_usrp_clock_make(uhd_usrp_clock_handle *h, const char *args)
Create a clock handle.