]> sigrok.org Git - libsigrok.git/blobdiff - src/libsigrok-internal.h
Build: Include <config.h> first in all source files
[libsigrok.git] / src / libsigrok-internal.h
index 9060e2a77b707a913363aa4ea1662b317b6699a0..624a141c7e34fb39ad9662c5a9eae361d0ab825e 100644 (file)
@@ -26,7 +26,6 @@
 
 #include <stdarg.h>
 #include <glib.h>
-#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
 #ifdef HAVE_LIBUSB_1_0
 #include <libusb.h>
 #endif
                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
                    (unsigned)((const uint8_t*)(x))[0]))
 
+/**
+ * Read a 32 bits big endian float out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding float
+ */
+#define RBFL(x)  ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
+
+/**
+ * Read a 32 bits little endian float out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding float
+ */
+#define RLFL(x)  ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
+
 /**
  * Write a 8 bits unsigned integer to memory.
  * @param p a pointer to the output memory
                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
 
-#define PI 3.1415926535897932384626433832795
+/**
+ * Write a 32 bits float to memory stored as big endian.
+ * @param p a pointer to the output memory
+ * @param x the input float
+ */
+#define WBFL(p, x)  WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
+
+/**
+ * Write a 32 bits float to memory stored as little endian.
+ * @param p a pointer to the output memory
+ * @param x the input float
+ */
+#define WLFL(p, x)  WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
 
 /* Portability fixes for FreeBSD. */
 #ifdef __FreeBSD__
@@ -179,16 +204,6 @@ 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;
-       HANDLE usb_wait_request_event;
-       HANDLE usb_wait_complete_event;
-       GPollFD usb_pollfd;
-       sr_receive_data_callback usb_cb;
-       void *usb_cb_data;
-#endif
 #endif
 };
 
@@ -342,6 +357,11 @@ struct sr_output {
         */
        const struct sr_dev_inst *sdi;
 
+       /**
+        * The name of the file that the data should be written to.
+        */
+       const char *filename;
+
        /**
         * A generic pointer which can be used by the module to keep internal
         * state between calls into its callback functions.
@@ -381,6 +401,13 @@ struct sr_output_module {
         */
        const char *const *exts;
 
+       /**
+        * Bitfield containing flags that describe certain properties
+        * this output module may or may not have.
+        * @see sr_output_flags
+        */
+       const uint64_t flags;
+
        /**
         * Returns a NULL-terminated list of options this module can take.
         * Can be NULL, if the module has no options.
@@ -536,9 +563,6 @@ struct sr_usb_dev_inst {
 #endif
 
 #ifdef HAVE_LIBSERIALPORT
-#define SERIAL_PARITY_NONE SP_PARITY_NONE
-#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
-#define SERIAL_PARITY_ODD  SP_PARITY_ODD
 struct sr_serial_dev_inst {
        /** Port name, e.g. '/dev/tty42'. */
        char *port;
@@ -546,10 +570,6 @@ struct sr_serial_dev_inst {
        char *serialcomm;
        /** libserialport port handle */
        struct sp_port *data;
-       /** libserialport event set */
-       struct sp_event_set *event_set;
-       /** GPollFDs for event polling */
-       GPollFD *pollfds;
 };
 #endif
 
@@ -567,22 +587,23 @@ struct drv_context {
 
 /*--- log.c -----------------------------------------------------------------*/
 
-SR_PRIV int sr_log(int loglevel, const char *format, ...);
-SR_PRIV int sr_spew(const char *format, ...);
-SR_PRIV int sr_dbg(const char *format, ...);
-SR_PRIV int sr_info(const char *format, ...);
-SR_PRIV int sr_warn(const char *format, ...);
-SR_PRIV int sr_err(const char *format, ...);
+#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
+/*
+ * On MinGW, we need to specify the gnu_printf format flavor or GCC
+ * will assume non-standard Microsoft printf syntax.
+ */
+SR_PRIV int sr_log(int loglevel, const char *format, ...)
+               __attribute__((__format__ (__gnu_printf__, 2, 3)));
+#else
+SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
+#endif
 
 /* Message logging helpers with subsystem-specific prefix string. */
-#ifndef NO_LOG_WRAPPERS
-#define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
-#define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
-#define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
-#define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
-#define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
-#define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
-#endif
+#define sr_spew(...)   sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_dbg(...)    sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
+#define sr_info(...)   sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_warn(...)   sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_err(...)    sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
 
 /*--- device.c --------------------------------------------------------------*/
 
@@ -594,6 +615,8 @@ enum {
 
 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
                int index, int type, gboolean enabled, const char *name);
+SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
+               struct sr_channel *cur_channel);
 
 /** Device instance data */
 struct sr_dev_inst {
@@ -655,15 +678,6 @@ SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 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);
-SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
-SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
-SR_PRIV int sr_source_add(int fd, int events, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
-SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
-SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
 
 /*--- session.c -------------------------------------------------------------*/
 
@@ -678,35 +692,34 @@ struct sr_session {
        GSList *datafeed_callbacks;
        GSList *transforms;
        struct sr_trigger *trigger;
-       GTimeVal starttime;
-       gboolean running;
 
-       unsigned int num_sources;
+       /** Mutex protecting the main context pointer and ownership flag. */
+       GMutex main_mutex;
+       /** Context of the session main loop. */
+       GMainContext *main_context;
+       /** Whether we are using the thread's default context. */
+       gboolean main_context_is_default;
 
-       /*
-        * Both "sources" and "pollfds" are of the same size and contain pairs
-        * of descriptor and callback function. We can not embed the GPollFD
-        * into the source struct since we want to be able to pass the array
-        * of all poll descriptors to g_poll().
-        */
-       struct source *sources;
-       GPollFD *pollfds;
-       int source_timeout;
-
-       /*
-        * These are our synchronization primitives for stopping the session in
-        * an async fashion. We need to make sure the session is stopped from
-        * within the session thread itself.
-        */
-       /** Mutex protecting access to abort_session. */
-       GMutex stop_mutex;
-       /** Abort current session. See sr_session_stop(). */
-       gboolean abort_session;
+       /** Whether the session has been started. */
+       gboolean running;
+
+       /** Registered event sources for this session. */
+       GHashTable *event_sources;
+       /** Session main loop. */
+       GMainLoop *main_loop;
 };
 
+SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
+               void *key, GSource *source);
+SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
+               void *key);
+SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
+               void *key, GSource *source);
+SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
+               void *key, gintptr fd, int events, int timeout,
+               sr_receive_data_callback cb, void *cb_data);
 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
                const struct sr_datafeed_packet *packet);
-SR_PRIV int sr_session_stop_sync(struct sr_session *session);
 SR_PRIV int sr_sessionfile_check(const char *filename);
 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
                struct sr_datafeed_packet **copy);
@@ -828,109 +841,66 @@ SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 #ifdef HAVE_LIBUSB_1_0
 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
+SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
                int timeout, sr_receive_data_callback cb, void *cb_data);
 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
 #endif
 
-/*--- hardware/scpi.c -------------------------------------------------------*/
 
-#define SCPI_CMD_IDN "*IDN?"
-#define SCPI_CMD_OPC "*OPC?"
+/*--- modbus/modbus.c -------------------------------------------------------*/
 
-enum {
-       SCPI_CMD_SET_TRIGGER_SOURCE,
-       SCPI_CMD_SET_TIMEBASE,
-       SCPI_CMD_SET_VERTICAL_DIV,
-       SCPI_CMD_SET_TRIGGER_SLOPE,
-       SCPI_CMD_SET_COUPLING,
-       SCPI_CMD_SET_HORIZ_TRIGGERPOS,
-       SCPI_CMD_GET_ANALOG_CHAN_STATE,
-       SCPI_CMD_GET_DIG_CHAN_STATE,
-       SCPI_CMD_GET_TIMEBASE,
-       SCPI_CMD_GET_VERTICAL_DIV,
-       SCPI_CMD_GET_VERTICAL_OFFSET,
-       SCPI_CMD_GET_TRIGGER_SOURCE,
-       SCPI_CMD_GET_HORIZ_TRIGGERPOS,
-       SCPI_CMD_GET_TRIGGER_SLOPE,
-       SCPI_CMD_GET_COUPLING,
-       SCPI_CMD_SET_ANALOG_CHAN_STATE,
-       SCPI_CMD_SET_DIG_CHAN_STATE,
-       SCPI_CMD_GET_DIG_POD_STATE,
-       SCPI_CMD_SET_DIG_POD_STATE,
-       SCPI_CMD_GET_ANALOG_DATA,
-       SCPI_CMD_GET_DIG_DATA,
-       SCPI_CMD_GET_SAMPLE_RATE,
-       SCPI_CMD_GET_SAMPLE_RATE_LIVE,
-};
-
-struct sr_scpi_hw_info {
-       char *manufacturer;
-       char *model;
-       char *serial_number;
-       char *firmware_version;
-};
-
-struct sr_scpi_dev_inst {
+struct sr_modbus_dev_inst {
        const char *name;
        const char *prefix;
        int priv_size;
-       GSList *(*scan)(struct drv_context *drvc);
-       int (*dev_inst_new)(void *priv, struct drv_context *drvc,
-               const char *resource, char **params, const char *serialcomm);
+       GSList *(*scan)(int modbusaddr);
+       int (*dev_inst_new)(void *priv, const char *resource,
+               char **params, const char *serialcomm, int modbusaddr);
        int (*open)(void *priv);
        int (*source_add)(struct sr_session *session, void *priv, int events,
                int timeout, sr_receive_data_callback cb, void *cb_data);
        int (*source_remove)(struct sr_session *session, void *priv);
-       int (*send)(void *priv, const char *command);
-       int (*read_begin)(void *priv);
-       int (*read_data)(void *priv, char *buf, int maxlen);
-       int (*read_complete)(void *priv);
+       int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
+       int (*read_begin)(void *priv, uint8_t *function_code);
+       int (*read_data)(void *priv, uint8_t *buf, int maxlen);
+       int (*read_end)(void *priv);
        int (*close)(void *priv);
        void (*free)(void *priv);
        unsigned int read_timeout_ms;
        void *priv;
 };
 
-SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
-               struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
-SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
-               const char *resource, const char *serialcomm);
-SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
-SR_PRIV int sr_scpi_source_add(struct sr_session *session,
-               struct sr_scpi_dev_inst *scpi, int events, int timeout,
+SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
+               struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
+SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
+               const char *serialcomm, int modbusaddr);
+SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
+SR_PRIV int sr_modbus_source_add(struct sr_session *session,
+               struct sr_modbus_dev_inst *modbus, int events, int timeout,
                sr_receive_data_callback cb, void *cb_data);
-SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
-               struct sr_scpi_dev_inst *scpi);
-SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
-               const char *format, ...);
-SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
-               const char *format, va_list args);
-SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
-SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
-SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
-SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
-SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
-
-SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
-                       const char *command, char **scpi_response);
-SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
-                       const char *command, gboolean *scpi_response);
-SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
-                       const char *command, int *scpi_response);
-SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
-                       const char *command, float *scpi_response);
-SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
-                       const char *command, double *scpi_response);
-SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
-SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
-                       const char *command, GArray **scpi_response);
-SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
-                       const char *command, GArray **scpi_response);
-SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
-                       struct sr_scpi_hw_info **scpi_response);
-SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
+SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
+               struct sr_modbus_dev_inst *modbus);
+SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
+                              uint8_t *request, int request_size);
+SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
+                            uint8_t *reply, int reply_size);
+SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
+                                    uint8_t *request, int request_size,
+                                    uint8_t *reply, int reply_size);
+SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
+                                 int address, int nb_coils, uint8_t *coils);
+SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
+                                             int address, int nb_registers,
+                                             uint16_t *registers);
+SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
+                                 int address, int value);
+SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
+                                               int address, int nb_registers,
+                                               uint16_t *registers);
+SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
+SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
 
 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
 
@@ -1132,4 +1102,17 @@ 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);
 
+/*--- hardware/scale/kern.c -------------------------------------------------*/
+
+struct kern_info {
+       gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
+       gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
+       gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
+       int buflen;
+};
+
+SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
 #endif