X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok-internal.h;h=61978c297911b73a91c4f7bce4f98058d06eadf6;hb=3544f848e0d7f67af8e11ce7ec344b34cd797df3;hp=b8a3fde505dbf3cedeb9e8e7d4276644482d6798;hpb=f5922adef5a866bd1c292436f1c4bc6b93103aef;p=libsigrok.git diff --git a/libsigrok-internal.h b/libsigrok-internal.h index b8a3fde5..61978c29 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,42 @@ #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) #endif +/** + * 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) ((((const uint8_t*)(x))[0] << 8) | \ + ((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) ((((const uint8_t*)(x))[1] << 8) | \ + ((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) ((((const uint8_t*)(x))[0] << 24) | \ + (((const uint8_t*)(x))[1] << 16) | \ + (((const uint8_t*)(x))[2] << 8) | \ + ((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) ((((const uint8_t*)(x))[3] << 24) | \ + (((const uint8_t*)(x))[2] << 16) | \ + (((const uint8_t*)(x))[1] << 8) | \ + ((const uint8_t*)(x))[0]) + /* Portability fixes for FreeBSD. */ #ifdef __FreeBSD__ #define LIBUSB_CLASS_APPLICATION 0xfe @@ -56,13 +96,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_t 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,11 +126,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 @@ -87,6 +148,7 @@ struct sr_usbtmc_dev_inst { /* Private driver context. */ struct drv_context { + /** sigrok context */ struct sr_context *sr_ctx; GSList *instances; }; @@ -100,6 +162,16 @@ 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, @@ -165,7 +237,9 @@ 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; }; @@ -182,7 +256,8 @@ typedef void (*std_dev_clear_t)(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, +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_t dev_close_fn, struct sr_serial_dev_inst *serial, const char *prefix); #endif @@ -190,6 +265,14 @@ 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); +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); /*--- hardware/common/serial.c ----------------------------------------------*/ @@ -219,6 +302,11 @@ 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, 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_serial_dev_inst *serial, int events, + int timeout, sr_receive_data_callback_t cb, void *cb_data); +SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial); #endif /*--- hardware/common/ezusb.c -----------------------------------------------*/ @@ -236,12 +324,13 @@ 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_context *ctx, int timeout, + sr_receive_data_callback_t cb, void *cb_data); +SR_PRIV int usb_source_remove(struct sr_context *ctx); #endif /*--- hardware/common/scpi.c ------------------------------------------------*/ -#ifdef HAVE_LIBSERIALPORT - #define SCPI_CMD_IDN "*IDN?" #define SCPI_CMD_OPC "*OPC?" @@ -276,25 +365,68 @@ struct sr_scpi_hw_info { char *firmware_version; }; -SR_PRIV int sr_scpi_send(struct sr_serial_dev_inst *serial, - const char *command); -SR_PRIV int sr_scpi_get_string(struct sr_serial_dev_inst *serial, - const char *command, char **scpi_response); -SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial, - const char *command, gboolean *scpi_response); -SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial, - const char *command, int *scpi_response); -SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial, - const char *command, float *scpi_response); -SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial, - const char *command, double *scpi_response); -SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial); -SR_PRIV int sr_scpi_get_hw_id(struct sr_serial_dev_inst *serial, - struct sr_scpi_hw_info **scpi_reponse); +struct sr_scpi_dev_inst { + int (*open)(void *priv); + int (*source_add)(void *priv, int events, + int timeout, sr_receive_data_callback_t cb, void *cb_data); + int (*source_remove)(void *priv); + int (*send)(void *priv, const char *command); + int (*receive)(void *priv, char **scpi_response); + int (*read)(void *priv, char *buf, int maxlen); + int (*close)(void *priv); + void (*free)(void *priv); + void *priv; +}; + +SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi); +SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events, + int timeout, sr_receive_data_callback_t cb, void *cb_data); +SR_PRIV int sr_scpi_source_remove(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_receive(struct sr_scpi_dev_inst *scpi, + char **scpi_response); +SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen); +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/scpi_serial.c -----------------------------------------*/ + +#ifdef HAVE_LIBSERIALPORT +SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port, + const char *serialcomm); #endif +/*--- hardware/common/scpi_tcp.c --------------------------------------------*/ + +SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address, + const char *port); + +/*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/ + +SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device); + /*--- hardware/common/dmm/es51922.c -----------------------------------------*/ #define ES51922_PACKET_SIZE 14 @@ -391,6 +523,14 @@ 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); +/*--- 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 -----------------------------------------*/ #define METEX14_PACKET_SIZE 14