hardware/lascar-el-usb/protocol.h

   1 /*
   2  * This file is part of the libsigrok 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_HARDWARE_LASCAR_EL_USB_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_LASCAR_EL_USB_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26
  27 /* Message logging helpers with subsystem-specific prefix string. */
  28 #define LOG_PREFIX "lascar-el-usb: "
  29 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  30 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  31 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  32 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  33 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  34 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  35
  36 #define LASCAR_VENDOR "Lascar"
  37 #define LASCAR_INTERFACE 0
  38 #define LASCAR_EP_IN 0x82
  39 #define LASCAR_EP_OUT 2
  40 /* Max 100ms for a device to positively identify. */
  41 #define SCAN_TIMEOUT 100000
  42 #define MAX_CONFIGBLOCK_SIZE 256
  43
  44 /** Private, per-device-instance driver context. */
  45 struct dev_context {
  46         void *cb_data;
  47         const struct elusb_profile *profile;
  48         /* Generic EL-USB */
  49         unsigned char config[MAX_CONFIGBLOCK_SIZE];
  50         unsigned int log_size;
  51         unsigned int rcvd_bytes;
  52         unsigned int sample_size;
  53         unsigned int logged_samples;
  54         unsigned int rcvd_samples;
  55         uint64_t limit_samples;
  56         /* Model-specific */
  57         /* EL-USB-CO: these are something like scaling and calibration values
  58          * fixed per device, used to convert the sample values to CO ppm. */
  59         float co_high;
  60         float co_low;
  61         /* Temperature units as stored in the device config. */
  62         int temp_unit;
  63 };
  64
  65 enum {
  66         LOG_UNSUPPORTED,
  67         LOG_TEMP_RH,
  68         LOG_CO,
  69 };
  70
  71 struct elusb_profile {
  72         int modelid;
  73         char *modelname;
  74         int logformat;
  75 };
  76
  77 SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
  78                 unsigned char *configblock, int *configlen);
  79 SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data);
  80 SR_PRIV void lascar_el_usb_receive_transfer(struct libusb_transfer *transfer);
  81 SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi);
  82 SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi);
  83 SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi);
  84 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  85
  86 #endif