libsigrok-internal.h

   1 /*
   2  * This file is part of the sigrok 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 /* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
  47 #if !GLIB_CHECK_VERSION(2,30,0)
  48 #define g_match_info_unref g_match_info_free
  49 #endif
  50
  51 struct sr_context {
  52 #ifdef HAVE_LIBUSB_1_0
  53         libusb_context *libusb_ctx;
  54 #endif
  55 };
  56
  57 #ifdef HAVE_LIBUSB_1_0
  58 struct sr_usb_dev_inst {
  59         uint8_t bus;
  60         uint8_t address;
  61         struct libusb_device_handle *devhdl;
  62 };
  63 #endif
  64
  65 #define SERIAL_PARITY_NONE 0
  66 #define SERIAL_PARITY_EVEN 1
  67 #define SERIAL_PARITY_ODD  2
  68 struct sr_serial_dev_inst {
  69         char *port;
  70         char *serialcomm;
  71         int fd;
  72 };
  73
  74 /* Private driver context. */
  75 struct drv_context {
  76         struct sr_context *sr_ctx;
  77         GSList *instances;
  78 };
  79
  80 /*--- log.c -----------------------------------------------------------------*/
  81
  82 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  83 SR_PRIV int sr_spew(const char *format, ...);
  84 SR_PRIV int sr_dbg(const char *format, ...);
  85 SR_PRIV int sr_info(const char *format, ...);
  86 SR_PRIV int sr_warn(const char *format, ...);
  87 SR_PRIV int sr_err(const char *format, ...);
  88
  89 /*--- device.c --------------------------------------------------------------*/
  90
  91 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  92                 gboolean enabled, const char *name);
  93
  94 /* Generic device instances */
  95 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  96                 const char *vendor, const char *model, const char *version);
  97 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
  98
  99 #ifdef HAVE_LIBUSB_1_0
 100 /* USB-specific instances */
 101 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 102                 uint8_t address, struct libusb_device_handle *hdl);
 103 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
 104 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 105 #endif
 106
 107 /* Serial-specific instances */
 108 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 109                 const char *serialcomm);
 110 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 111
 112
 113 /*--- hwdriver.c ------------------------------------------------------------*/
 114
 115 SR_PRIV void sr_hw_cleanup_all(void);
 116 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 117 SR_PRIV void sr_config_free(struct sr_config *src);
 118 SR_PRIV int sr_source_remove(int fd);
 119 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 120                           sr_receive_data_callback_t cb, void *cb_data);
 121
 122 /*--- session.c -------------------------------------------------------------*/
 123
 124 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 125                             const struct sr_datafeed_packet *packet);
 126
 127 /*--- std.c -----------------------------------------------------------------*/
 128
 129 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
 130
 131 SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 132                         const char *prefix);
 133 SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 134                         void *cb_data, dev_close_t hw_dev_close_fn,
 135                         struct sr_serial_dev_inst *serial, const char *prefix);
 136 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 137                                        const char *prefix);
 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/fs9922.c ------------------------------------------*/
 202
 203 SR_PRIV int sr_dmm_parse_fs9922(const uint8_t *buf, float *floatval,
 204                                 struct sr_datafeed_analog *analog);
 205
 206 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 207
 208 #define FS9721_PACKET_SIZE 14
 209
 210 struct fs9721_info {
 211         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 212         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 213         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 214         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 215 };
 216
 217 SR_PRIV gboolean sr_fs9721_is_packet_start(uint8_t b);
 218 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 219 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 220                             struct sr_datafeed_analog *analog, void *info);
 221
 222 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 223
 224 #define METEX14_PACKET_SIZE 14
 225
 226 struct metex14_info {
 227         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 228         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 229         gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
 230         gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
 231 };
 232
 233 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 234 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 235 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 236                              struct sr_datafeed_analog *analog, void *info);
 237
 238 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 239
 240 #define RS9LCD_PACKET_SIZE 9
 241
 242 /* Dummy info struct. The parser does not use it. */
 243 struct rs9lcd_info { int dummy; };
 244
 245 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 246 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 247                             struct sr_datafeed_analog *analog, void *info);
 248
 249 #endif