]> sigrok.org Git - libsigrok.git/blobdiff - src/libsigrok-internal.h
sr_driver_list() now takes a context pointer.
[libsigrok.git] / src / libsigrok-internal.h
index b2564ecae3a7f4d9671efdb323c367cf13e1ae36..b4b32f23ac2a6df21edd845dabe9dc8a3b2e3efe 100644 (file)
  * @param p a pointer to the output memory
  * @param x the input unsigned integer
  */
-#define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while(0)
+#define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while (0)
 
 /**
  * Write a 16 bits unsigned integer to memory stored as big endian.
  * @param x the input unsigned integer
  */
 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
-                         ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while(0)
+                         ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while (0)
 
 /**
  * Write a 16 bits unsigned integer to memory stored as little endian.
  * @param x the input unsigned integer
  */
 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
-                         ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while(0)
+                         ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while (0)
 
 /**
  * Write a 32 bits unsigned integer to memory stored as big endian.
 #define WB32(p, x)  do { ((uint8_t*)(p))[3] = (uint8_t) (x);      \
                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>8);  \
                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
-                         ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while(0)
+                         ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
 
 /**
  * Write a 32 bits unsigned integer to memory stored as little endian.
 #define WL32(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  \
                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
-                         ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while(0)
+                         ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
 
 /* Portability fixes for FreeBSD. */
 #ifdef __FreeBSD__
 #define LIBUSB_CLASS_APPLICATION 0xfe
+#define libusb_has_capability(x) 0
 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
        libusb_handle_events_timeout(ctx, tv)
 #endif
 #endif
 
 struct sr_context {
+       struct sr_dev_driver **driver_list;
 #ifdef HAVE_LIBUSB_1_0
        libusb_context *libusb_ctx;
        gboolean usb_source_present;
 #ifdef _WIN32
        GThread *usb_thread;
        gboolean usb_thread_running;
-       GMutex usb_mutex;
-       HANDLE usb_event;
+       HANDLE usb_wait_request_event;
+       HANDLE usb_wait_complete_event;
        GPollFD usb_pollfd;
        sr_receive_data_callback usb_cb;
        void *usb_cb_data;
@@ -237,6 +239,13 @@ struct sr_input_module {
         */
        const char *desc;
 
+       /**
+        * A NULL terminated array of strings containing a list of file name
+        * extensions typical for the input file format, or NULL if there is
+        * no typical extension for this file format.
+        */
+       const char *const *exts;
+
        /**
         * Zero-terminated list of metadata items the module needs to be able
         * to identify an input stream. Can be all-zero, if the module cannot
@@ -363,6 +372,13 @@ struct sr_output_module {
         */
        char *desc;
 
+       /**
+        * A NULL terminated array of strings containing a list of file name
+        * extensions typical for the input file format, or NULL if there is
+        * no typical extension for this file format.
+        */
+       const char *const *exts;
+
        /**
         * Returns a NULL-terminated list of options this module can take.
         * Can be NULL, if the module has no options.
@@ -387,7 +403,7 @@ struct sr_output_module {
        int (*init) (struct sr_output *o, GHashTable *options);
 
        /**
-        * This function is passed a copy of every packed in the data feed.
+        * This function is passed a copy of every packet in the data feed.
         * Any output generated by the output module in response to the
         * packet should be returned in a newly allocated GString
         * <code>out</code>, which will be freed by the caller.
@@ -418,6 +434,93 @@ struct sr_output_module {
        int (*cleanup) (struct sr_output *o);
 };
 
+/** Transform module instance. */
+struct sr_transform {
+       /** A pointer to this transform's module.  */
+       const struct sr_transform_module *module;
+
+       /**
+        * The device for which this transform module is used. This
+        * can be used by the module to find out channel names and numbers.
+        */
+       const struct sr_dev_inst *sdi;
+
+       /**
+        * A generic pointer which can be used by the module to keep internal
+        * state between calls into its callback functions.
+        */
+       void *priv;
+};
+
+struct sr_transform_module {
+       /**
+        * A unique ID for this transform module, suitable for use in
+        * command-line clients, [a-z0-9-]. Must not be NULL.
+        */
+       char *id;
+
+       /**
+        * A unique name for this transform module, suitable for use in GUI
+        * clients, can contain UTF-8. Must not be NULL.
+        */
+       const char *name;
+
+       /**
+        * A short description of the transform module. Must not be NULL.
+        *
+        * This can be displayed by frontends, e.g. when selecting
+        * which transform module(s) to add.
+        */
+       char *desc;
+
+       /**
+        * Returns a NULL-terminated list of options this transform module
+        * can take. Can be NULL, if the transform module has no options.
+        */
+       const struct sr_option *(*options) (void);
+
+       /**
+        * This function is called once, at the beginning of a stream.
+        *
+        * @param t Pointer to the respective 'struct sr_transform'.
+        * @param options Hash table of options for this transform module.
+        *                Can be NULL if no options are to be used.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*init) (struct sr_transform *t, GHashTable *options);
+
+       /**
+        * This function is passed a pointer to every packet in the data feed.
+        *
+        * It can either return (in packet_out) a pointer to another packet
+        * (possibly the exact same packet it got as input), or NULL.
+        *
+        * @param t Pointer to the respective 'struct sr_transform'.
+        * @param packet_in Pointer to a datafeed packet.
+        * @param packet_out Pointer to the resulting datafeed packet after
+        *                   this function was run. If NULL, the transform
+        *                   module intentionally didn't output a new packet.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*receive) (const struct sr_transform *t,
+                       struct sr_datafeed_packet *packet_in,
+                       struct sr_datafeed_packet **packet_out);
+
+       /**
+        * This function is called after the caller is finished using
+        * the transform module, and can be used to free any internal
+        * resources the module may keep.
+        *
+        * @retval SR_OK Success
+        * @retval other Negative error code.
+        */
+       int (*cleanup) (struct sr_transform *t);
+};
+
 #ifdef HAVE_LIBUSB_1_0
 /** USB device instance */
 struct sr_usb_dev_inst {
@@ -487,12 +590,40 @@ enum {
        SR_CHANNEL_SET_ENABLED = 1 << 0,
 };
 
-SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
-               gboolean enabled, const char *name);
+SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
+               int index, int type, gboolean enabled, const char *name);
+
+/** Device instance data */
+struct sr_dev_inst {
+       /** Device driver. */
+       struct sr_dev_driver *driver;
+       /** Device instance status. SR_ST_NOT_FOUND, etc. */
+       int status;
+       /** Device instance type. SR_INST_USB, etc. */
+       int inst_type;
+       /** Device vendor. */
+       char *vendor;
+       /** Device model. */
+       char *model;
+       /** Device version. */
+       char *version;
+       /** Serial number. */
+       char *serial_num;
+       /** Connection string to uniquely identify devices. */
+       char *connection_id;
+       /** List of channels. */
+       GSList *channels;
+       /** List of sr_channel_group structs */
+       GSList *channel_groups;
+       /** Device instance connection data (used?) */
+       void *conn;
+       /** Device instance private data (used?) */
+       void *priv;
+       /** Session to which this device is currently assigned. */
+       struct sr_session *session;
+};
 
 /* Generic device instances */
-SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
-               const char *vendor, const char *model, const char *version);
 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 
 #ifdef HAVE_LIBUSB_1_0
@@ -515,9 +646,11 @@ SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 
 /*--- hwdriver.c ------------------------------------------------------------*/
 
+extern SR_PRIV struct sr_dev_driver **drivers_lists[];
+
 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
-SR_PRIV void sr_hw_cleanup_all(void);
+SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 SR_PRIV void sr_config_free(struct sr_config *src);
 SR_PRIV int sr_source_remove(int fd);
@@ -533,12 +666,15 @@ SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 /*--- session.c -------------------------------------------------------------*/
 
 struct sr_session {
+       /** Context this session exists in. */
+       struct sr_context *ctx;
        /** List of struct sr_dev_inst pointers. */
        GSList *devs;
        /** List of struct sr_dev_inst pointers owned by this session. */
        GSList *owned_devs;
        /** List of struct datafeed_callback pointers. */
        GSList *datafeed_callbacks;
+       GSList *transforms;
        struct sr_trigger *trigger;
        GTimeVal starttime;
        gboolean running;
@@ -574,6 +710,14 @@ SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
                struct sr_datafeed_packet **copy);
 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
 
+/*--- analog.c --------------------------------------------------------------*/
+
+SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
+                           struct sr_analog_encoding *encoding,
+                           struct sr_analog_meaning *meaning,
+                           struct sr_analog_spec *spec,
+                           int digits);
+
 /*--- std.c -----------------------------------------------------------------*/
 
 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
@@ -610,13 +754,18 @@ struct soft_trigger_logic {
        int unitsize;
        int cur_stage;
        uint8_t *prev_sample;
+       uint8_t *pre_trigger_buffer;
+       uint8_t *pre_trigger_head;
+       int pre_trigger_size;
+       int pre_trigger_fill;
 };
 
 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
-               const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
+               const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
+               int pre_trigger_samples);
 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
-               int len);
+               int len, int *pre_trigger_samples);
 
 /*--- hardware/serial.c -----------------------------------------------------*/
 
@@ -631,6 +780,7 @@ typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
+SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
                const void *buf, size_t count, unsigned int timeout_ms);
 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
@@ -927,6 +1077,27 @@ SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
                struct sr_datafeed_analog *analog, void *info);
 
+/*--- hardware/dmm/vc870.c --------------------------------------------------*/
+
+#define VC870_PACKET_SIZE 23
+
+struct vc870_info {
+       gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
+       gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
+       gboolean is_current, is_micro, is_milli, is_power;
+       gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value;
+       gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
+       gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
+       gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
+       gboolean is_lo, is_hi, is_open2;
+
+       gboolean is_frequency, is_dual_display, is_auto, is_rms;
+};
+
+SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
 
 SR_PRIV void es51919_serial_clean(void *priv);
@@ -947,4 +1118,16 @@ SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
                                            void *cb_data);
 
+/*--- hardware/dmm/ut372.c --------------------------------------------------*/
+
+#define UT372_PACKET_SIZE 27
+
+struct ut372_info {
+       int dummy;
+};
+
+SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
 #endif