X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=libsigrok-internal.h;h=8c58bd9f1e53e61c49985207cca5b2472321f699;hp=376e657e05c59e7d7c6617bb6dffed810bfa5015;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=ae67644fe5340d9c6e450fb0443178af356e0647 diff --git a/libsigrok-internal.h b/libsigrok-internal.h index 376e657e..8c58bd9f 100644 --- a/libsigrok-internal.h +++ b/libsigrok-internal.h @@ -17,8 +17,12 @@ * along with this program. If not, see . */ -#ifndef LIBSIGROK_SIGROK_INTERNAL_H -#define LIBSIGROK_SIGROK_INTERNAL_H +/** @file + * @internal + */ + +#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H +#define LIBSIGROK_LIBSIGROK_INTERNAL_H #include #include @@ -46,6 +50,92 @@ #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) #endif +/** + * Read a 8 bits integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding integer + */ +#define R8(x) ((unsigned)((const uint8_t*)(x))[0]) + +/** + * Read a 16 bits big endian integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding integer + */ +#define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ + (unsigned)((const uint8_t*)(x))[1]) + +/** + * Read a 16 bits little endian integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding integer + */ +#define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \ + (unsigned)((const uint8_t*)(x))[0]) + +/** + * Read a 32 bits big endian integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding integer + */ +#define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \ + ((unsigned)((const uint8_t*)(x))[1] << 16) | \ + ((unsigned)((const uint8_t*)(x))[2] << 8) | \ + (unsigned)((const uint8_t*)(x))[3]) + +/** + * Read a 32 bits little endian integer out of memory. + * @param x a pointer to the input memory + * @return the corresponding integer + */ +#define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \ + ((unsigned)((const uint8_t*)(x))[2] << 16) | \ + ((unsigned)((const uint8_t*)(x))[1] << 8) | \ + (unsigned)((const uint8_t*)(x))[0]) + +/** + * Write a 8 bits integer to memory. + * @param p a pointer to the output memory + * @param x the input integer + */ +#define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while(0) + +/** + * Write a 16 bits integer to memory stored as big endian. + * @param p a pointer to the output memory + * @param x the input integer + */ +#define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \ + ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while(0) + +/** + * Write a 16 bits integer to memory stored as little endian. + * @param p a pointer to the output memory + * @param x the input integer + */ +#define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ + ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while(0) + +/** + * Write a 32 bits integer to memory stored as big endian. + * @param p a pointer to the output memory + * @param x the input integer + */ +#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) + +/** + * Write a 32 bits integer to memory stored as little endian. + * @param p a pointer to the output memory + * @param x the input integer + */ +#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) + /* Portability fixes for FreeBSD. */ #ifdef __FreeBSD__ #define LIBUSB_CLASS_APPLICATION 0xfe @@ -56,13 +146,27 @@ struct sr_context { #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; + GPollFD usb_pollfd; + sr_receive_data_callback usb_cb; + void *usb_cb_data; +#endif #endif }; #ifdef HAVE_LIBUSB_1_0 +/** USB device instance */ struct sr_usb_dev_inst { + /** USB bus */ uint8_t bus; + /** Device address on USB bus */ uint8_t address; + /** libusb device handle */ struct libusb_device_handle *devhdl; }; #endif @@ -72,10 +176,18 @@ struct sr_usb_dev_inst { #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; + /** Comm params for serial_set_paramstr(). */ char *serialcomm; - int fd; + /** Port is non-blocking. */ + int nonblocking; + /** libserialport port handle */ struct sp_port *data; + /** libserialport event set */ + struct sp_event_set *event_set; + /** GPollFDs for event polling */ + GPollFD *pollfds; }; #endif @@ -86,6 +198,7 @@ struct sr_usbtmc_dev_inst { /* Private driver context. */ struct drv_context { + /** sigrok context */ struct sr_context *sr_ctx; GSList *instances; }; @@ -99,9 +212,25 @@ SR_PRIV int sr_info(const char *format, ...); SR_PRIV int sr_warn(const char *format, ...); SR_PRIV int sr_err(const char *format, ...); +/* 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 + /*--- device.c --------------------------------------------------------------*/ -SR_PRIV struct sr_probe *sr_probe_new(int index, int type, +/** Values for the changes argument of sr_dev_driver.config_channel_set. */ +enum { + /** The enabled state of the channel has been changed. */ + SR_CHANNEL_SET_ENABLED = 1 << 0, +}; + +SR_PRIV struct sr_channel *sr_channel_new(int index, int type, gboolean enabled, const char *name); /* Generic device instances */ @@ -113,7 +242,6 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi); /* USB-specific instances */ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, uint8_t address, struct libusb_device_handle *hdl); -SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx); SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb); #endif @@ -134,8 +262,14 @@ SR_PRIV void sr_hw_cleanup_all(void); SR_PRIV struct sr_config *sr_config_new(int 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_t cb, void *cb_data); + 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 -------------------------------------------------------------*/ @@ -144,6 +278,7 @@ struct sr_session { GSList *devs; /** List of struct datafeed_callback pointers. */ GSList *datafeed_callbacks; + struct sr_trigger *trigger; GTimeVal starttime; gboolean running; @@ -164,31 +299,60 @@ struct sr_session { * 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; }; 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(void); +SR_PRIV int sr_session_stop_sync(struct sr_session *session); SR_PRIV int sr_sessionfile_check(const char *filename); /*--- std.c -----------------------------------------------------------------*/ -typedef int (*dev_close_t)(struct sr_dev_inst *sdi); -typedef void (*std_dev_clear_t)(void *priv); +typedef int (*dev_close_callback)(struct sr_dev_inst *sdi); +typedef void (*std_dev_clear_callback)(void *priv); SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, const char *prefix); #ifdef HAVE_LIBSERIALPORT -SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, - void *cb_data, dev_close_t dev_close_fn, +SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi); +SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, + void *cb_data, dev_close_callback dev_close_fn, struct sr_serial_dev_inst *serial, const char *prefix); #endif SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, const char *prefix); SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, - std_dev_clear_t clear_private); + std_dev_clear_callback clear_private); +SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi); + +/*--- strutil.c -------------------------------------------------------------*/ + +SR_PRIV int sr_atol(const char *str, long *ret); +SR_PRIV int sr_atoi(const char *str, int *ret); +SR_PRIV int sr_atod(const char *str, double *ret); +SR_PRIV int sr_atof(const char *str, float *ret); +SR_PRIV int sr_atof_ascii(const char *str, float *ret); + +/*--- soft-trigger.c --------------------------------------------------------*/ + +struct soft_trigger_logic { + const struct sr_dev_inst *sdi; + const struct sr_trigger *trigger; + int count; + int unitsize; + int cur_stage; + uint8_t *prev_sample; +}; + +SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new( + const struct sr_dev_inst *sdi, struct sr_trigger *trigger); +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); /*--- hardware/common/serial.c ----------------------------------------------*/ @@ -199,15 +363,23 @@ enum { SERIAL_NONBLOCK = 4, }; -typedef gboolean (*packet_valid_t)(const uint8_t *buf); +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_write(struct sr_serial_dev_inst *serial, const void *buf, size_t count); +SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, + const void *buf, size_t count); +SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, + const void *buf, size_t count); SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf, size_t count); +SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, + size_t count); +SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, + size_t count); SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr); SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, @@ -216,8 +388,17 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, int *buflen, gint64 timeout_ms); SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, uint8_t *buf, size_t *buflen, - size_t packet_size, packet_valid_t is_valid, + size_t packet_size, + packet_valid_callback is_valid, uint64_t timeout_ms, int baudrate); +SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device, + const char **serial_options); +SR_PRIV int serial_source_add(struct sr_session *session, + struct sr_serial_dev_inst *serial, int events, int timeout, + sr_receive_data_callback cb, void *cb_data); +SR_PRIV int serial_source_remove(struct sr_session *session, + struct sr_serial_dev_inst *serial); +SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id); #endif /*--- hardware/common/ezusb.c -----------------------------------------------*/ @@ -235,24 +416,107 @@ 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 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); #endif -/*--- hardware/common/dmm/es51922.c -----------------------------------------*/ +/*--- hardware/common/scpi.c ------------------------------------------------*/ -#define ES51922_PACKET_SIZE 14 +#define SCPI_CMD_IDN "*IDN?" +#define SCPI_CMD_OPC "*OPC?" -struct es51922_info { - gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current; - gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf; - gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature; - gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol; - gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin; - gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega; +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, }; -SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf); -SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval, - struct sr_datafeed_analog *analog, void *info); +struct sr_scpi_hw_info { + char *manufacturer; + char *model; + char *serial_number; + char *firmware_version; +}; + +struct sr_scpi_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); + 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 (*close)(void *priv); + void (*free)(void *priv); + 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_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); /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/ @@ -280,6 +544,9 @@ struct es519xx_info { SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval, struct sr_datafeed_analog *analog, void *info); +SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf); +SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf, + float *floatval, struct sr_datafeed_analog *analog, void *info); SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf); SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf, float *floatval, struct sr_datafeed_analog *analog, void *info); @@ -332,6 +599,15 @@ SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info); SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info); SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); +SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info); + +/*--- hardware/common/dmm/m2110.c -----------------------------------------*/ + +#define BBCGM_M2110_PACKET_SIZE 9 + +SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf); +SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval, + struct sr_datafeed_analog *analog, void *info); /*--- hardware/common/dmm/metex14.c -----------------------------------------*/ @@ -342,7 +618,7 @@ struct metex14_info { gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad; gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro; gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe; - gboolean is_unitless; + gboolean is_unitless, is_logic; }; #ifdef HAVE_LIBSERIALPORT