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
  30 /**
  31  * @file
  32  *
  33  * libsigrok private header file, only to be used internally.
  34  */
  35
  36 /*--- Macros ----------------------------------------------------------------*/
  37
  38 #ifndef ARRAY_SIZE
  39 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  40 #endif
  41
  42 #ifndef ARRAY_AND_SIZE
  43 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  44 #endif
  45
  46 struct sr_context {
  47 #ifdef HAVE_LIBUSB_1_0
  48         libusb_context *libusb_ctx;
  49 #endif
  50 };
  51
  52 #ifdef HAVE_LIBUSB_1_0
  53 struct sr_usb_dev_inst {
  54         uint8_t bus;
  55         uint8_t address;
  56         struct libusb_device_handle *devhdl;
  57 };
  58 #endif
  59
  60 #define SERIAL_PARITY_NONE 0
  61 #define SERIAL_PARITY_EVEN 1
  62 #define SERIAL_PARITY_ODD  2
  63 struct sr_serial_dev_inst {
  64         char *port;
  65         char *serialcomm;
  66         int fd;
  67 };
  68
  69 /* Private driver context. */
  70 struct drv_context {
  71         struct sr_context *sr_ctx;
  72         GSList *instances;
  73 };
  74
  75 /*--- log.c -----------------------------------------------------------------*/
  76
  77 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  78 SR_PRIV int sr_spew(const char *format, ...);
  79 SR_PRIV int sr_dbg(const char *format, ...);
  80 SR_PRIV int sr_info(const char *format, ...);
  81 SR_PRIV int sr_warn(const char *format, ...);
  82 SR_PRIV int sr_err(const char *format, ...);
  83
  84 /*--- device.c --------------------------------------------------------------*/
  85
  86 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  87                 gboolean enabled, const char *name);
  88
  89 /* Generic device instances */
  90 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  91                 const char *vendor, const char *model, const char *version);
  92 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
  93
  94 #ifdef HAVE_LIBUSB_1_0
  95 /* USB-specific instances */
  96 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
  97                 uint8_t address, struct libusb_device_handle *hdl);
  98 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
  99 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 100 #endif
 101
 102 /* Serial-specific instances */
 103 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 104                 const char *serialcomm);
 105 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 106
 107
 108 /*--- hwdriver.c ------------------------------------------------------------*/
 109
 110 SR_PRIV void sr_hw_cleanup_all(void);
 111 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 112 SR_PRIV void sr_config_free(struct sr_config *src);
 113 SR_PRIV int sr_source_remove(int fd);
 114 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 115                 sr_receive_data_callback_t cb, void *cb_data);
 116
 117 /*--- session.c -------------------------------------------------------------*/
 118
 119 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 120                 const struct sr_datafeed_packet *packet);
 121 SR_PRIV int sr_session_stop_sync(void);
 122 SR_PRIV int sr_sessionfile_check(const char *filename);
 123
 124 /*--- std.c -----------------------------------------------------------------*/
 125
 126 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
 127 typedef void (*std_dev_clear_t)(void *priv);
 128
 129 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 130                 const char *prefix);
 131 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 132                 void *cb_data, dev_close_t dev_close_fn,
 133                 struct sr_serial_dev_inst *serial, const char *prefix);
 134 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 135                 const char *prefix);
 136 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 137                 std_dev_clear_t clear_private);
 138
 139 /*--- hardware/common/serial.c ----------------------------------------------*/
 140
 141 enum {
 142         SERIAL_RDWR = 1,
 143         SERIAL_RDONLY = 2,
 144         SERIAL_NONBLOCK = 4,
 145 };
 146
 147 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
 148
 149 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 150 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 151 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 152 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 153                 const void *buf, size_t count);
 154 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 155                 size_t count);
 156 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 157                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 158 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 159                 const char *paramstr);
 160 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 161                 int *buflen, gint64 timeout_ms);
 162 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 163                                  uint8_t *buf, size_t *buflen,
 164                                  size_t packet_size, packet_valid_t is_valid,
 165                                  uint64_t timeout_ms, int baudrate);
 166
 167 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 168
 169 #ifdef HAVE_LIBUSB_1_0
 170 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 171 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 172                                    const char *filename);
 173 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 174                                   const char *filename);
 175 #endif
 176
 177 /*--- hardware/common/usb.c -------------------------------------------------*/
 178
 179 #ifdef HAVE_LIBUSB_1_0
 180 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 181 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 182 #endif
 183
 184 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
 185
 186 #define ES51922_PACKET_SIZE 14
 187
 188 struct es51922_info {
 189         gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
 190         gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
 191         gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
 192         gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
 193         gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
 194         gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
 195 };
 196
 197 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
 198 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
 199                              struct sr_datafeed_analog *analog, void *info);
 200
 201 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 202
 203 /**
 204  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 205  * so always read 2 blocks at a time.
 206  */
 207 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 208 #define ES519XX_14B_PACKET_SIZE 14
 209
 210 struct es519xx_info {
 211         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 212         gboolean is_milli, is_resistance, is_continuity, is_diode;
 213         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 214         gboolean is_temperature, is_celsius, is_fahrenheit;
 215         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 216         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 217         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 218         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 219         uint32_t baudrate;
 220         int packet_size;
 221         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 222 };
 223
 224 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 225 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 226                 struct sr_datafeed_analog *analog, void *info);
 227 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 228 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 229                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 230 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 231 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 232                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 233 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 234 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 235                 struct sr_datafeed_analog *analog, void *info);
 236 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 237 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 238                 struct sr_datafeed_analog *analog, void *info);
 239 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 240 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 241                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 242
 243 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 244
 245 #define FS9922_PACKET_SIZE 14
 246
 247 struct fs9922_info {
 248         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 249         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 250         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 251         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 252         gboolean is_celsius, is_fahrenheit;
 253         int bargraph_sign, bargraph_value;
 254 };
 255
 256 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 257 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 258                             struct sr_datafeed_analog *analog, void *info);
 259 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 260
 261 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 262
 263 #define FS9721_PACKET_SIZE 14
 264
 265 struct fs9721_info {
 266         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 267         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 268         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 269         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 270 };
 271
 272 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 273 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 274                             struct sr_datafeed_analog *analog, void *info);
 275 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 276 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 277 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 278 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 279
 280 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 281
 282 #define METEX14_PACKET_SIZE 14
 283
 284 struct metex14_info {
 285         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 286         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 287         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 288         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 289         gboolean is_unitless;
 290 };
 291
 292 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 293 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 294 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 295                              struct sr_datafeed_analog *analog, void *info);
 296
 297 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 298
 299 #define RS9LCD_PACKET_SIZE 9
 300
 301 /* Dummy info struct. The parser does not use it. */
 302 struct rs9lcd_info { int dummy; };
 303
 304 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 305 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 306                             struct sr_datafeed_analog *analog, void *info);
 307
 308 #endif