/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef SIGROK_SIGROK_H
-#define SIGROK_SIGROK_H
+#ifndef LIBSIGROK_SIGROK_H
+#define LIBSIGROK_SIGROK_H
#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
-#ifdef HAVE_LIBUSB_1_0
-#include <libusb.h>
-#endif
#ifdef __cplusplus
extern "C" {
#define SR_ERR -1 /* Generic/unspecified error */
#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
#define SR_ERR_ARG -3 /* Function argument error */
-#define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */
+#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
+#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
-#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
-#define SR_MAX_PROBENAME_LEN 32
+#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
+#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
#define SR_HZ(n) (n)
#define SR_HZ_TO_NS(n) (1000000000 / (n))
/* libsigrok loglevels. */
-#define SR_LOG_NONE 0
-#define SR_LOG_ERR 1
-#define SR_LOG_WARN 2
-#define SR_LOG_INFO 3
-#define SR_LOG_DBG 4
-#define SR_LOG_SPEW 5
+#define SR_LOG_NONE 0 /**< Output no messages at all. */
+#define SR_LOG_ERR 1 /**< Output error messages. */
+#define SR_LOG_WARN 2 /**< Output warnings. */
+#define SR_LOG_INFO 3 /**< Output informational messages. */
+#define SR_LOG_DBG 4 /**< Output debug messages. */
+#define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */
+
+/*
+ * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
+ *
+ * Variables and functions marked 'static' are private already and don't
+ * need SR_PRIV. However, functions which are not static (because they need
+ * to be used in other libsigrok-internal files) but are also not meant to
+ * be part of the public libsigrok API, must use SR_PRIV.
+ *
+ * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
+ *
+ * Details: http://gcc.gnu.org/wiki/Visibility
+ */
+
+/* Marks public libsigrok API symbols. */
+#define SR_API __attribute__((visibility("default")))
+
+/* Marks private, non-public libsigrok symbols (not part of the API). */
+#define SR_PRIV __attribute__((visibility("hidden")))
typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
enum {
SR_T_UINT64,
SR_T_CHAR,
- SR_T_NULL,
+ SR_T_BOOL,
};
-#if 0
-/* (Unused) protocol decoder stack entry */
-struct sr_protocol {
- char *name;
- int id;
- int stackindex;
-};
-#endif
-
/* sr_datafeed_packet.type values */
enum {
SR_DF_HEADER,
SR_DF_END,
SR_DF_TRIGGER,
SR_DF_LOGIC,
- SR_DF_ANALOG,
SR_DF_PD,
};
struct sr_datafeed_packet {
uint16_t type;
- /* timeoffset since start, in picoseconds */
- uint64_t timeoffset;
- /* duration of data in this packet, in picoseconds */
- uint64_t duration;
void *payload;
};
int feed_version;
struct timeval starttime;
uint64_t samplerate;
- int num_analog_probes;
int num_logic_probes;
};
void *data;
};
-struct sr_datafeed_pd {
- char *protocol;
- char *annotation;
- unsigned char *data;
-};
-
-#if defined(HAVE_LA_ALSA)
-struct sr_analog_probe {
- uint8_t att;
- uint8_t res; /* Needs to be a power of 2, FIXME */
- uint16_t val; /* Max hardware ADC width is 16bits */
-};
-
-struct sr_analog_sample {
- uint8_t num_probes; /* Max hardware probes is 256 */
- struct sr_analog_probe probes[];
-};
-#endif
-
struct sr_input {
struct sr_input_format *format;
char *param;
uint64_t *length_out);
};
-#if 0
-struct sr_analyzer {
- char *name;
- char *filename;
- /*
- * TODO: Parameters? If so, configured plugins need another struct.
- * TODO: Input and output format?
- */
-};
-#endif
-
struct sr_datastore {
/* Size in bytes of the number of units stored in this datastore */
int ds_unitsize;
enum {
SR_PROBE_TYPE_LOGIC,
- SR_PROBE_TYPE_ANALOG,
};
struct sr_probe {
char *trigger;
};
-/* TODO: Get rid of this global variable. */
-extern GSList *devices;
-
/* Hardware plugin capabilities */
enum {
- SR_HWCAP_DUMMY, /* Used to terminate lists */
+ SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
/*--- Device classes ------------------------------------------------*/
/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
+ /*--- Device types --------------------------------------------------*/
+
+ /** The device is demo device. */
+ SR_HWCAP_DEMO_DEVICE,
+
/*--- Device options ------------------------------------------------*/
/** The device supports setting/changing its samplerate. */
char *model;
char *version;
void *priv;
- union {
- struct sr_usb_device_instance *usb;
- struct sr_serial_device_instance *serial;
- };
};
/* sr_device_instance types */
SR_SERIAL_INSTANCE,
};
-#ifdef HAVE_LIBUSB_1_0
-struct sr_usb_device_instance {
- uint8_t bus;
- uint8_t address;
- struct libusb_device_handle *devhdl;
-};
-#endif
-
-struct sr_serial_device_instance {
- char *port;
- int fd;
-};
-
/* Device instance status */
enum {
SR_ST_NOT_FOUND,
SR_DI_INSTANCE,
/* The number of probes connected to this device */
SR_DI_NUM_PROBES,
+ /* The probe names on this device */
+ SR_DI_PROBE_NAMES,
/* Samplerates supported by this device, (struct sr_samplerates) */
SR_DI_SAMPLERATES,
/* Types of trigger supported, out of "01crf" (char *) */
struct sr_session {
/* List of struct sr_device* */
GSList *devices;
- /* List of struct analyzer* */
- GSList *analyzers;
/* list of sr_receive_data_callback */
GSList *datafeed_callbacks;
GTimeVal starttime;
projects / libsigrok.git / blobdiff