hardware/genericdmm/genericdmm.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 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_GENERICDMM_H
  21 #define LIBSIGROK_GENERICDMM_H
  22
  23 /* Message logging helpers with driver-specific prefix string. */
  24 #define DRIVER_LOG_DOMAIN "genericdmm: "
  25 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  26 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  27 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  28 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  29 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  30 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  31
  32 /* SR_HWCAP_CONN takes one of these: */
  33 #define DMM_CONN_USB_VIDPID    "^([0-9a-z]{1,4})\\.([0-9a-z]{1,4})$"
  34 #define DMM_CONN_USB_BUSADDR   "^(\\d+)\\.(\\d+)$"
  35 #define DMM_CONN_SERIALPORT    "^([a-z0-9/\\-_]+)$"
  36
  37 /* SR_HWCAP_SERIALCOMM like 2400/8n1 */
  38 #define DMM_CONN_SERIALCOMM    "^(\\d+)/(\\d)([neo])(\\d)$"
  39
  40 enum {
  41         DMM_TRANSPORT_SERIAL,
  42         DMM_TRANSPORT_USBHID,
  43 };
  44
  45
  46 struct dev_profile {
  47         char *modelid;
  48         char *vendor;
  49         char *model;
  50         struct dmmchip *chip;
  51         int transport;
  52         int poll_timeout;
  53         struct sr_hwopt *defaults_opts;
  54 };
  55
  56 /* Private, per-device-instance driver context. */
  57 struct dev_context {
  58         struct dev_profile *profile;
  59         uint64_t limit_samples;
  60         uint64_t limit_msec;
  61
  62         /* Opaque pointer passed in by the frontend. */
  63         void *cb_data;
  64
  65         /* Only used for USB-connected devices. */
  66         struct sr_usb_dev_inst *usb;
  67
  68         /* Only used for serial-connected devices. */
  69         struct sr_serial_dev_inst *serial;
  70         int serial_speed;
  71         int serial_databits;
  72         int serial_parity;
  73         int serial_stopbits;
  74
  75         /* Runtime. */
  76         uint64_t num_samples;
  77
  78         /* DMM chip-specific data, if needed. */
  79         void *priv;
  80 };
  81
  82 struct dmmchip {
  83         /* Optional, called once before measurement starts. */
  84         int (*init) (void);
  85
  86         /* Scan for devices with the given options. */
  87         GSList *(*scan) (GSList *options);
  88
  89         /* Called whenever a chunk of data arrives. */
  90         int (*data) (struct sr_dev_inst *sdi);
  91 };
  92
  93
  94 #endif /* LIBSIGROK_GENERICDMM_H */