add DF_ANALOG, and an analog output module

[libsigrok.git] / sigrok.h

diff --git a/sigrok.h b/sigrok.h
index a8703a38a2f23919cc789cb4f8dcacab2b98f3c1..5e6f2314c86874538feb79cd64c0c87016bc99dd 100644 (file)
--- a/sigrok.h
+++ b/sigrok.h
@@ -49,6 +49,11 @@
 #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)
@@ -58,6 +63,10 @@
 #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 {
        T_UINT64,
@@ -84,17 +93,15 @@ enum {
        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;
 };
 
@@ -118,8 +125,8 @@ struct input {
 struct input_format {
        char *extension;
        char *description;
-       int (*format_match) (char *filename);
-       int (*in_loadfile) (char *filename);
+       int (*format_match) (const char *filename);
+       int (*in_loadfile) (const char *filename);
 };
 
 struct input_format **input_list(void);
@@ -138,6 +145,7 @@ struct output {
 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);
@@ -153,6 +161,7 @@ int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
                  uint64_t *length_out);
 
 char *sigrok_samplerate_string(uint64_t samplerate);
+char *sigrok_period_string(uint64_t frequency);
 
 /*--- analyzer.c ------------------------------------------------------------*/
 
@@ -178,12 +187,12 @@ void sigrok_cleanup(void);
 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);
 
@@ -222,7 +231,7 @@ extern GSList *devices;
 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);
 
@@ -242,7 +251,7 @@ enum {
        HWCAP_LOGIC_ANALYZER,
        HWCAP_SAMPLERATE,       /* Change samplerate */
        HWCAP_PROBECONFIG,      /* Configure probe mask */
-       HWCAP_CAPTURE_RATIO,    /* Set pre-trigger / post-trigger ratio */
+       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 */
 };
@@ -261,6 +270,7 @@ struct sigrok_device_instance {
        char *vendor;
        char *model;
        char *version;
+       void *priv;
        union {
                struct usb_device_instance *usb;
                struct serial_device_instance *serial;
@@ -358,7 +368,7 @@ GSList *list_hwplugins(void);
 
 /* Generic device instances */
 struct sigrok_device_instance *sigrok_device_instance_new(int index,
-       int status, char *vendor, char *model, char *version);
+       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);
@@ -369,7 +379,8 @@ struct usb_device_instance *usb_device_instance_new(uint8_t bus,
 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);
@@ -428,9 +439,19 @@ int ezusb_upload_firmware(libusb_device *dev, int configuration,
 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