libsigrok/sigrok.h.in

376 lines
9.8 KiB
C
Raw Normal View History

/*
* This file is part of the sigrok project.
*
* Copyright (C) 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
* 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 LIBSIGROK_SIGROK_H
#define LIBSIGROK_SIGROK_H
#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Status/error codes returned by libsigrok functions.
*
* All possible return codes of libsigrok functions must be listed here.
* Functions should never return hardcoded numbers as status, but rather
* use these #defines instead. All error codes are negative numbers.
*
* The error codes are globally unique in libsigrok, i.e. if one of the
* libsigrok functions returns a "malloc error" it must be exactly the same
* return value as used by all other functions to indicate "malloc error".
* There must be no functions which indicate two different errors via the
* same return code.
*
* Also, for compatibility reasons, no defined return codes are ever removed
* or reused for different #defines later. You can only add new #defines and
* return codes, but never remove or redefine existing ones.
*/
2011-01-29 15:23:12 +00:00
#define SR_OK 0 /* No error */
#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_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
/* Handy little macros */
2011-02-22 17:05:16 +00:00
#define SR_HZ(n) (n)
#define SR_KHZ(n) ((n) * 1000)
#define SR_MHZ(n) ((n) * 1000000)
#define SR_GHZ(n) ((n) * 1000000000)
#define SR_HZ_TO_NS(n) (1000000000 / (n))
2011-01-10 17:14:26 +00:00
/* libsigrok loglevels. */
2011-06-12 16:07:15 +00:00
#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
/*
* 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);
2011-01-10 12:47:24 +00:00
/* Data types used by hardware plugins for set_configuration() */
enum {
2011-01-30 16:58:41 +00:00
SR_T_UINT64,
SR_T_CHAR,
SR_T_BOOL,
};
2011-01-29 16:03:26 +00:00
/* sr_datafeed_packet.type values */
enum {
2011-01-30 16:58:41 +00:00
SR_DF_HEADER,
SR_DF_END,
SR_DF_TRIGGER,
SR_DF_LOGIC,
SR_DF_PD,
};
2011-01-29 16:03:26 +00:00
struct sr_datafeed_packet {
uint16_t type;
void *payload;
};
2011-01-29 16:03:26 +00:00
struct sr_datafeed_header {
int feed_version;
struct timeval starttime;
uint64_t samplerate;
int num_logic_probes;
};
struct sr_datafeed_logic {
uint64_t length;
uint16_t unitsize;
2011-06-19 12:28:50 +00:00
void *data;
};
struct sr_input {
struct sr_input_format *format;
2011-01-11 22:58:41 +00:00
char *param;
2011-01-30 15:19:42 +00:00
struct sr_device *vdevice;
};
struct sr_input_format {
char *id;
char *description;
int (*format_match) (const char *filename);
int (*init) (struct sr_input *in);
int (*loadfile) (struct sr_input *in, const char *filename);
};
struct sr_output {
struct sr_output_format *format;
2011-01-30 15:19:42 +00:00
struct sr_device *device;
char *param;
void *internal;
};
struct sr_output_format {
char *id;
char *description;
int df_type;
int (*init) (struct sr_output *o);
int (*data) (struct sr_output *o, const char *data_in,
uint64_t length_in, char **data_out, uint64_t *length_out);
int (*event) (struct sr_output *o, int event_type, char **data_out,
uint64_t *length_out);
};
struct sr_datastore {
/* Size in bytes of the number of units stored in this datastore */
int ds_unitsize;
2010-05-09 11:25:03 +00:00
unsigned int num_units; /* TODO: uint64_t */
GSList *chunklist;
};
/*
* This represents a generic device connected to the system.
* For device-specific information, ask the plugin. The plugin_index refers
* to the device index within that plugin; it may be handling more than one
* device. All relevant plugin calls take a device_index parameter for this.
*/
2011-01-30 15:19:42 +00:00
struct sr_device {
/* Which plugin handles this device */
2011-01-30 15:19:42 +00:00
struct sr_device_plugin *plugin;
/* A plugin may handle multiple devices of the same type */
int plugin_index;
2011-02-08 16:47:38 +00:00
/* List of struct sr_probe* */
GSList *probes;
/* Data acquired by this device, if any */
struct sr_datastore *datastore;
};
enum {
2011-01-30 16:58:41 +00:00
SR_PROBE_TYPE_LOGIC,
};
2011-02-08 16:47:38 +00:00
struct sr_probe {
int index;
int type;
gboolean enabled;
char *name;
char *trigger;
};
/* Hardware plugin capabilities */
enum {
SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
/*--- Device classes ------------------------------------------------*/
/** The device can act as logic analyzer. */
2011-01-30 16:58:41 +00:00
SR_HWCAP_LOGIC_ANALYZER,
2011-01-15 04:11:40 +00:00
/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
2012-01-21 14:34:11 +00:00
/*--- Device types --------------------------------------------------*/
/** The device is demo device. */
SR_HWCAP_DEMO_DEVICE,
/*--- Device options ------------------------------------------------*/
/** The device supports setting/changing its samplerate. */
SR_HWCAP_SAMPLERATE,
/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
/** The device supports setting a probe mask. */
SR_HWCAP_PROBECONFIG,
/** The device supports setting a pre/post-trigger capture ratio. */
SR_HWCAP_CAPTURE_RATIO,
/* TODO? */
/** The device supports setting a pattern (pattern generator mode). */
SR_HWCAP_PATTERN_MODE,
/** The device supports Run Length Encoding. */
SR_HWCAP_RLE,
/*--- Special stuff -------------------------------------------------*/
/* TODO: Better description. */
/** The device supports specifying a capturefile to inject. */
SR_HWCAP_CAPTUREFILE,
2011-01-15 04:11:40 +00:00
/* TODO: Better description. */
/** The device supports specifying the capturefile unit size. */
SR_HWCAP_CAPTURE_UNITSIZE,
/* TODO: Better description. */
/** The device supports setting the number of probes. */
SR_HWCAP_CAPTURE_NUM_PROBES,
/*--- Acquisition modes ---------------------------------------------*/
/**
* The device supports setting a sample time limit, i.e. how long the
* sample acquisition should run (in ms).
*/
SR_HWCAP_LIMIT_MSEC,
/**
* The device supports setting a sample number limit, i.e. how many
* samples should be acquired.
*/
SR_HWCAP_LIMIT_SAMPLES,
/**
* The device supports continuous sampling, i.e. neither a time limit
* nor a sample number limit has to be supplied, it will just acquire
* samples continuously, until explicitly stopped by a certain command.
*/
2011-01-30 16:58:41 +00:00
SR_HWCAP_CONTINUOUS,
/* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
};
struct sr_hwcap_option {
int capability;
int type;
char *description;
char *shortname;
};
2011-01-29 15:43:45 +00:00
struct sr_device_instance {
int index;
int status;
int instance_type;
char *vendor;
char *model;
char *version;
void *priv;
};
2011-01-29 15:43:45 +00:00
/* sr_device_instance types */
enum {
2011-01-30 16:58:41 +00:00
SR_USB_INSTANCE,
SR_SERIAL_INSTANCE,
};
/* Device instance status */
enum {
2011-01-30 16:58:41 +00:00
SR_ST_NOT_FOUND,
/* Found, but still booting */
2011-01-30 16:58:41 +00:00
SR_ST_INITIALIZING,
/* Live, but not in use */
2011-01-30 16:58:41 +00:00
SR_ST_INACTIVE,
/* Actively in use in a session */
2011-01-30 16:58:41 +00:00
SR_ST_ACTIVE,
};
/*
* TODO: This sucks, you just kinda have to "know" the returned type.
* TODO: Need a DI to return the number of trigger stages supported.
*/
/* Device info IDs */
enum {
2011-01-29 15:43:45 +00:00
/* struct sr_device_instance for this specific device */
2011-01-30 16:58:41 +00:00
SR_DI_INSTANCE,
/* The number of probes connected to this device */
2011-01-30 16:58:41 +00:00
SR_DI_NUM_PROBES,
/* The probe names on this device */
SR_DI_PROBE_NAMES,
/* Samplerates supported by this device, (struct sr_samplerates) */
2011-01-30 16:58:41 +00:00
SR_DI_SAMPLERATES,
/* Types of trigger supported, out of "01crf" (char *) */
2011-01-30 16:58:41 +00:00
SR_DI_TRIGGER_TYPES,
/* The currently set samplerate in Hz (uint64_t) */
2011-01-30 16:58:41 +00:00
SR_DI_CUR_SAMPLERATE,
2011-01-15 04:11:40 +00:00
/* Supported pattern generator modes */
2011-01-30 16:58:41 +00:00
SR_DI_PATTERNMODES,
};
2010-04-15 18:07:16 +00:00
/*
* A device supports either a range of samplerates with steps of a given
* granularity, or is limited to a set of defined samplerates. Use either
* step or list, but not both.
*/
struct sr_samplerates {
uint64_t low;
uint64_t high;
uint64_t step;
uint64_t *list;
};
2011-01-30 15:19:42 +00:00
struct sr_device_plugin {
2010-04-15 18:07:16 +00:00
/* Plugin-specific */
char *name;
char *longname;
int api_version;
int (*init) (const char *deviceinfo);
void (*cleanup) (void);
2010-04-15 18:07:16 +00:00
/* Device-specific */
int (*opendev) (int device_index);
int (*closedev) (int device_index);
void *(*get_device_info) (int device_index, int device_info_id);
int (*get_status) (int device_index);
int *(*get_capabilities) (void);
int (*set_configuration) (int device_index, int capability, void *value);
int (*start_acquisition) (int device_index, gpointer session_device_id);
void (*stop_acquisition) (int device_index, gpointer session_device_id);
};
2011-02-08 16:50:29 +00:00
struct sr_session {
2011-01-30 15:19:42 +00:00
/* List of struct sr_device* */
GSList *devices;
/* list of sr_receive_data_callback */
GSList *datafeed_callbacks;
GTimeVal starttime;
gboolean running;
};
2011-01-10 12:47:24 +00:00
#include "sigrok-proto.h"
#ifdef __cplusplus
}
#endif
#endif