libsigrok-internal.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSIGROK_SIGROK_INTERNAL_H
  21 #define LIBSIGROK_SIGROK_INTERNAL_H
  22
  23 #include <stdarg.h>
  24 #include <glib.h>
  25 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  26 #ifdef HAVE_LIBUSB_1_0
  27 #include <libusb.h>
  28 #endif
  29 #ifdef HAVE_LIBSERIALPORT
  30 #include <libserialport.h>
  31 #endif
  32
  33 /**
  34  * @file
  35  *
  36  * libsigrok private header file, only to be used internally.
  37  */
  38
  39 /*--- Macros ----------------------------------------------------------------*/
  40
  41 #ifndef ARRAY_SIZE
  42 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  43 #endif
  44
  45 #ifndef ARRAY_AND_SIZE
  46 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  47 #endif
  48
  49 /* Portability fixes for FreeBSD. */
  50 #ifdef __FreeBSD__
  51 #define LIBUSB_CLASS_APPLICATION 0xfe
  52 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
  53         libusb_handle_events_timeout(ctx, tv)
  54 #endif
  55
  56 struct sr_context {
  57 #ifdef HAVE_LIBUSB_1_0
  58         libusb_context *libusb_ctx;
  59 #endif
  60 };
  61
  62 #ifdef HAVE_LIBUSB_1_0
  63 struct sr_usb_dev_inst {
  64         uint8_t bus;
  65         uint8_t address;
  66         struct libusb_device_handle *devhdl;
  67 };
  68 #endif
  69
  70 #ifdef HAVE_LIBSERIALPORT
  71 #define SERIAL_PARITY_NONE SP_PARITY_NONE
  72 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
  73 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
  74 struct sr_serial_dev_inst {
  75         char *port;
  76         char *serialcomm;
  77         int fd;
  78         struct sp_port *data;
  79 };
  80 #endif
  81
  82 /* Private driver context. */
  83 struct drv_context {
  84         struct sr_context *sr_ctx;
  85         GSList *instances;
  86 };
  87
  88 /*--- log.c -----------------------------------------------------------------*/
  89
  90 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  91 SR_PRIV int sr_spew(const char *format, ...);
  92 SR_PRIV int sr_dbg(const char *format, ...);
  93 SR_PRIV int sr_info(const char *format, ...);
  94 SR_PRIV int sr_warn(const char *format, ...);
  95 SR_PRIV int sr_err(const char *format, ...);
  96
  97 /*--- device.c --------------------------------------------------------------*/
  98
  99 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
 100                 gboolean enabled, const char *name);
 101
 102 /* Generic device instances */
 103 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 104                 const char *vendor, const char *model, const char *version);
 105 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 106
 107 #ifdef HAVE_LIBUSB_1_0
 108 /* USB-specific instances */
 109 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 110                 uint8_t address, struct libusb_device_handle *hdl);
 111 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
 112 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 113 #endif
 114
 115 #ifdef HAVE_LIBSERIALPORT
 116 /* Serial-specific instances */
 117 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 118                 const char *serialcomm);
 119 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 120 #endif
 121
 122
 123 /*--- hwdriver.c ------------------------------------------------------------*/
 124
 125 SR_PRIV void sr_hw_cleanup_all(void);
 126 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 127 SR_PRIV void sr_config_free(struct sr_config *src);
 128 SR_PRIV int sr_source_remove(int fd);
 129 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 130                 sr_receive_data_callback_t cb, void *cb_data);
 131
 132 /*--- session.c -------------------------------------------------------------*/
 133
 134 struct sr_session {
 135         /** List of struct sr_dev pointers. */
 136         GSList *devs;
 137         /** List of struct datafeed_callback pointers. */
 138         GSList *datafeed_callbacks;
 139         GTimeVal starttime;
 140         gboolean running;
 141
 142         unsigned int num_sources;
 143
 144         /*
 145          * Both "sources" and "pollfds" are of the same size and contain pairs
 146          * of descriptor and callback function. We can not embed the GPollFD
 147          * into the source struct since we want to be able to pass the array
 148          * of all poll descriptors to g_poll().
 149          */
 150         struct source *sources;
 151         GPollFD *pollfds;
 152         int source_timeout;
 153
 154         /*
 155          * These are our synchronization primitives for stopping the session in
 156          * an async fashion. We need to make sure the session is stopped from
 157          * within the session thread itself.
 158          */
 159         GMutex stop_mutex;
 160         gboolean abort_session;
 161 };
 162
 163 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 164                 const struct sr_datafeed_packet *packet);
 165 SR_PRIV int sr_session_stop_sync(void);
 166 SR_PRIV int sr_sessionfile_check(const char *filename);
 167
 168 /*--- std.c -----------------------------------------------------------------*/
 169
 170 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
 171 typedef void (*std_dev_clear_t)(void *priv);
 172
 173 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 174                 const char *prefix);
 175 #ifdef HAVE_LIBSERIALPORT
 176 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 177                 void *cb_data, dev_close_t dev_close_fn,
 178                 struct sr_serial_dev_inst *serial, const char *prefix);
 179 #endif
 180 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 181                 const char *prefix);
 182 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 183                 std_dev_clear_t clear_private);
 184
 185 /*--- hardware/common/serial.c ----------------------------------------------*/
 186
 187 #ifdef HAVE_LIBSERIALPORT
 188 enum {
 189         SERIAL_RDWR = 1,
 190         SERIAL_RDONLY = 2,
 191         SERIAL_NONBLOCK = 4,
 192 };
 193
 194 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
 195
 196 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 197 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 198 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 199 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 200                 const void *buf, size_t count);
 201 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 202                 size_t count);
 203 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 204                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 205 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 206                 const char *paramstr);
 207 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 208                 int *buflen, gint64 timeout_ms);
 209 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 210                                  uint8_t *buf, size_t *buflen,
 211                                  size_t packet_size, packet_valid_t is_valid,
 212                                  uint64_t timeout_ms, int baudrate);
 213 #endif
 214
 215 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 216
 217 #ifdef HAVE_LIBUSB_1_0
 218 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 219 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 220                                    const char *filename);
 221 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 222                                   const char *filename);
 223 #endif
 224
 225 /*--- hardware/common/usb.c -------------------------------------------------*/
 226
 227 #ifdef HAVE_LIBUSB_1_0
 228 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 229 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 230 #endif
 231
 232 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
 233
 234 #define ES51922_PACKET_SIZE 14
 235
 236 struct es51922_info {
 237         gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
 238         gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
 239         gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
 240         gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
 241         gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
 242         gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
 243 };
 244
 245 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
 246 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
 247                              struct sr_datafeed_analog *analog, void *info);
 248
 249 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 250
 251 /**
 252  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 253  * so always read 2 blocks at a time.
 254  */
 255 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 256 #define ES519XX_14B_PACKET_SIZE 14
 257
 258 struct es519xx_info {
 259         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 260         gboolean is_milli, is_resistance, is_continuity, is_diode;
 261         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 262         gboolean is_temperature, is_celsius, is_fahrenheit;
 263         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 264         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 265         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 266         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 267         uint32_t baudrate;
 268         int packet_size;
 269         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 270 };
 271
 272 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 273 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 274                 struct sr_datafeed_analog *analog, void *info);
 275 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 276 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 277                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 278 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 279 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 280                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 281 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 282 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 283                 struct sr_datafeed_analog *analog, void *info);
 284 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 285 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 286                 struct sr_datafeed_analog *analog, void *info);
 287 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 288 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 289                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 290
 291 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 292
 293 #define FS9922_PACKET_SIZE 14
 294
 295 struct fs9922_info {
 296         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 297         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 298         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 299         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 300         gboolean is_celsius, is_fahrenheit;
 301         int bargraph_sign, bargraph_value;
 302 };
 303
 304 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 305 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 306                             struct sr_datafeed_analog *analog, void *info);
 307 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 308
 309 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 310
 311 #define FS9721_PACKET_SIZE 14
 312
 313 struct fs9721_info {
 314         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 315         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 316         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 317         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 318 };
 319
 320 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 321 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 322                             struct sr_datafeed_analog *analog, void *info);
 323 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 324 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 325 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 326 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 327
 328 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 329
 330 #define METEX14_PACKET_SIZE 14
 331
 332 struct metex14_info {
 333         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 334         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 335         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 336         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 337         gboolean is_unitless;
 338 };
 339
 340 #ifdef HAVE_LIBSERIALPORT
 341 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 342 #endif
 343 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 344 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 345                              struct sr_datafeed_analog *analog, void *info);
 346
 347 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 348
 349 #define RS9LCD_PACKET_SIZE 9
 350
 351 /* Dummy info struct. The parser does not use it. */
 352 struct rs9lcd_info { int dummy; };
 353
 354 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 355 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 356                             struct sr_datafeed_analog *analog, void *info);
 357
 358 #endif