![]() |
libsigrok
0.2.0
sigrok hardware access and backend library
|
The public libsigrok header file to be used by frontends. More...
#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
#include "proto.h"
#include "version.h"
Go to the source code of this file.
Data Structures | |
struct | sr_datafeed_packet |
struct | sr_datafeed_header |
struct | sr_datafeed_meta |
struct | sr_datafeed_logic |
struct | sr_datafeed_analog |
struct | sr_input |
Input (file) format struct. More... | |
struct | sr_input_format |
struct | sr_output |
Output (file) format struct. More... | |
struct | sr_output_format |
struct | sr_probe |
struct | sr_config |
struct | sr_config_info |
struct | sr_dev_inst |
struct | sr_dev_driver |
struct | sr_session |
Macros | |
#define | SR_MAX_PROBENAME_LEN 32 |
#define | SR_HZ(n) (n) |
#define | SR_KHZ(n) ((n) * (uint64_t)(1000ULL)) |
#define | SR_MHZ(n) ((n) * (uint64_t)(1000000ULL)) |
#define | SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL)) |
#define | SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) |
#define | SR_API __attribute__((visibility("default"))) |
#define | SR_PRIV __attribute__((visibility("hidden"))) |
Typedefs | |
typedef int(* | sr_receive_data_callback_t )(int fd, int revents, void *cb_data) |
The public libsigrok header file to be used by frontends.
This is the only file that libsigrok users (frontends) are supposed to use and #include. There are other header files which get installed with libsigrok, but those are not meant to be used directly by frontends.
The correct way to get/use the libsigrok API functions is:
Definition in file libsigrok.h.
#define SR_API __attribute__((visibility("default"))) |
Definition at line 120 of file libsigrok.h.
#define SR_GHZ | ( | n | ) | ((n) * (uint64_t)(1000000000ULL)) |
Definition at line 88 of file libsigrok.h.
Referenced by sr_parse_sizestring(), sr_period_string(), and sr_si_string_u64().
#define SR_HZ | ( | n | ) | (n) |
Definition at line 85 of file libsigrok.h.
#define SR_HZ_TO_NS | ( | n | ) | ((uint64_t)(1000000000ULL) / (n)) |
Definition at line 90 of file libsigrok.h.
#define SR_KHZ | ( | n | ) | ((n) * (uint64_t)(1000ULL)) |
Definition at line 86 of file libsigrok.h.
Referenced by sr_parse_sizestring(), sr_period_string(), and sr_si_string_u64().
#define SR_MAX_PROBENAME_LEN 32 |
Definition at line 82 of file libsigrok.h.
Referenced by sr_session_load().
#define SR_MHZ | ( | n | ) | ((n) * (uint64_t)(1000000ULL)) |
Definition at line 87 of file libsigrok.h.
Referenced by sr_parse_sizestring(), sr_period_string(), and sr_si_string_u64().
#define SR_PRIV __attribute__((visibility("hidden"))) |
Definition at line 127 of file libsigrok.h.
typedef int(* sr_receive_data_callback_t)(int fd, int revents, void *cb_data) |
Definition at line 132 of file libsigrok.h.
anonymous enum |
Status/error codes returned by libsigrok functions.
Definition at line 66 of file libsigrok.h.
anonymous enum |
libsigrok loglevels.
Definition at line 93 of file libsigrok.h.
anonymous enum |
Device instance status.
Definition at line 741 of file libsigrok.h.
anonymous enum |
Data types used by sr_config_info().
Enumerator | |
---|---|
SR_T_UINT64 | |
SR_T_CHAR | |
SR_T_BOOL | |
SR_T_FLOAT | |
SR_T_RATIONAL_PERIOD | |
SR_T_RATIONAL_VOLT | |
SR_T_KEYVALUE |
Definition at line 135 of file libsigrok.h.
anonymous enum |
Value for sr_datafeed_packet.type.
Enumerator | |
---|---|
SR_DF_HEADER | |
SR_DF_END | |
SR_DF_META | |
SR_DF_TRIGGER | |
SR_DF_LOGIC | |
SR_DF_ANALOG | |
SR_DF_FRAME_BEGIN | |
SR_DF_FRAME_END |
Definition at line 146 of file libsigrok.h.
anonymous enum |
Values for sr_datafeed_analog.mq.
Definition at line 158 of file libsigrok.h.
anonymous enum |
Values for sr_datafeed_analog.unit.
Definition at line 181 of file libsigrok.h.
anonymous enum |
Values for sr_datafeed_analog.flags.
Definition at line 219 of file libsigrok.h.
anonymous enum |
Enumerator | |
---|---|
SR_PROBE_LOGIC | |
SR_PROBE_ANALOG |
Definition at line 531 of file libsigrok.h.
anonymous enum |
Definition at line 558 of file libsigrok.h.
anonymous enum |
Types of device instances (sr_dev_inst).
Enumerator | |
---|---|
SR_INST_USB |
Device instance type for USB devices. |
SR_INST_SERIAL |
Device instance type for serial port devices. |
Definition at line 733 of file libsigrok.h.