* 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 function returns a "malloc error" it must be exactly the same
- * return value as used for all other functions to indicate "malloc error".
+ * 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.
*
* or reused for different #defines later. You can only add new #defines and
* return codes, but never remove or redefine existing ones.
*/
-#define SIGROK_OK 0 /* No error */
+#define SIGROK_OK 0 /* No error */
#define SIGROK_ERR -1 /* Generic/unspecified error */
#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
+/* limited by uint64_t */
+#define MAX_NUM_PROBES 64
+#define MAX_PROBENAME_LEN 32
+
+
/* Handy little macros */
-#define KHZ(n) (n * 1000)
-#define MHZ(n) (n * 1000000)
-#define GHZ(n) (n * 1000000000)
+#define KHZ(n) ((n) * 1000)
+#define MHZ(n) ((n) * 1000000)
+#define GHZ(n) ((n) * 1000000000)
+
+#ifndef ARRAY_SIZE
+#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
+#endif
+
+#ifndef ARRAY_AND_SIZE
+#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
+#endif
/* Data types, used by hardware plugins for set_configuration() */
enum {
};
/*
- * datafeed
+ * Datafeed
*/
/* datafeed_packet.type values */
DF_HEADER,
DF_END,
DF_TRIGGER,
- DF_LOGIC8,
- DF_LOGIC16,
- DF_LOGIC24,
- DF_LOGIC32,
- DF_LOGIC48,
- DF_LOGIC64,
+ DF_LOGIC,
+ DF_ANALOG,
+ DF_PD,
};
struct datafeed_packet {
uint16_t type;
- uint16_t length;
+ uint64_t length;
+ uint16_t unitsize;
void *payload;
};
};
/*
- * output
+ * Input
+ */
+struct input {
+ struct input_format *format;
+ void *param;
+ void *internal;
+};
+
+struct input_format {
+ char *extension;
+ char *description;
+ int (*format_match) (const char *filename);
+ int (*in_loadfile) (const char *filename);
+};
+
+struct input_format **input_list(void);
+
+
+/*
+ * Output
*/
struct output {
struct output_format *format;
struct output_format {
char *extension;
char *description;
+ int df_type;
int (*init) (struct output *o);
int (*data) (struct output *o, char *data_in, uint64_t length_in,
char **data_out, uint64_t *length_out);
};
struct output_format **output_list(void);
+
+
int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
char *data_in, uint64_t length_in, char **data_out,
uint64_t *length_out);
+char *sigrok_samplerate_string(uint64_t samplerate);
+char *sigrok_period_string(uint64_t frequency);
+
/*--- analyzer.c ------------------------------------------------------------*/
struct analyzer {
struct datastore {
/* Size in bytes of the number of units stored in this datastore */
int ds_unitsize;
- unsigned int num_units;
+ unsigned int num_units; /* TODO: uint64_t */
GSList *chunklist;
};
-struct datastore *datastore_new(int unitsize);
-void datastore_destroy(struct datastore *ds);
+int datastore_new(int unitsize, struct datastore **ds);
+int datastore_destroy(struct datastore *ds);
void datastore_put(struct datastore *ds, void *data, unsigned int length,
int in_unitsize, int *probelist);
void device_scan(void);
void device_close_all(void);
GSList *device_list(void);
-struct device *device_new(struct device_plugin *plugin, int plugin_index);
+struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
void device_clear(struct device *device);
void device_destroy(struct device *dev);
/* Hardware plugin capabilities */
enum {
- HWCAP_DUMMY, // used to terminate lists
+ HWCAP_DUMMY, /* Used to terminate lists */
HWCAP_LOGIC_ANALYZER,
- HWCAP_SAMPLERATE, // change samplerate
- HWCAP_PROBECONFIG, // configure probe mask
- HWCAP_CAPTURE_RATIO, // set pre-trigger / post-trigger ratio
- HWCAP_LIMIT_MSEC, // set a time limit for sample acquisition
- HWCAP_LIMIT_SAMPLES, // set a limit on number of samples
+ HWCAP_SAMPLERATE, /* Change samplerate */
+ HWCAP_PROBECONFIG, /* Configure probe mask */
+ HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
+ HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
+ HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
};
struct hwcap_option {
char *vendor;
char *model;
char *version;
+ void *priv;
union {
struct usb_device_instance *usb;
struct serial_device_instance *serial;
DI_CUR_SAMPLERATE,
};
-/* 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
+/*
+ * 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 samplerates {
};
struct device_plugin {
- /* plugin-specific */
+ /* Plugin-specific */
char *name;
int api_version;
int (*init) (char *deviceinfo);
void (*cleanup) (void);
- /* device-specific */
+ /* Device-specific */
int (*open) (int device_index);
void (*close) (int device_index);
void *(*get_device_info) (int device_index, int device_info_id);
/* Generic device instances */
struct sigrok_device_instance *sigrok_device_instance_new(int index,
- int status, char *vendor, char *model, char *version);
-struct sigrok_device_instance *get_sigrok_device_instance(GSList *device_instances, int device_index);
+ int status, const char *vendor, const char *model, const char *version);
+struct sigrok_device_instance *get_sigrok_device_instance(
+ GSList *device_instances, int device_index);
void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
/* USB-specific instances */
void usb_device_instance_free(struct usb_device_instance *usb);
/* Serial-specific instances */
-struct serial_device_instance *serial_device_instance_new(char *port, int fd);
+struct serial_device_instance *serial_device_instance_new(
+ const char *port, int fd);
void serial_device_instance_free(struct serial_device_instance *serial);
int find_hwcap(int *capabilities, int hwcap);
struct hwcap_option *find_hwcap_option(int hwcap);
void source_remove(int fd);
-void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, void *user_data);
+void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
+ void *user_data);
/*--- session.c -------------------------------------------------------------*/
GSList *devices;
/* List of struct analyzer* */
GSList *analyzers;
- /* datafeed callbacks */
+ /* Datafeed callbacks */
GSList *datafeed_callbacks;
GTimeVal starttime;
};
/* Session setup */
-struct session *session_load(char *filename);
+struct session *session_load(const char *filename);
struct session *session_new(void);
void session_destroy(void);
void session_device_clear(void);
int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
+int ezusb_upload_firmware(libusb_device *dev, int configuration,
+ const char *filename);
GSList *list_serial_ports(void);
+int serial_open(const char *pathname, int flags);
+int serial_close(int fd);
+int serial_flush(int fd);
+void *serial_backup_params(int fd);
+void serial_restore_params(int fd, void *backup);
+int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
+ int flowcontrol);
+
+/* libsigrok/hardware/common/misc.c */
+/* TODO: Should not be public. */
+int opendev2(int device_index, struct sigrok_device_instance **sdi,
+ libusb_device *dev, struct libusb_device_descriptor *des,
+ int *skip, uint16_t vid, uint16_t pid, int interface);
+int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
+ struct libusb_device_descriptor *des,
+ uint16_t vid, uint16_t pid, int interface);
#endif
projects / libsigrok.git / blobdiff