src/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/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "lascar-el-usb"
  28
  29 #define LASCAR_INTERFACE 0
  30 #define LASCAR_EP_IN 0x82
  31 #define LASCAR_EP_OUT 2
  32 #define MAX_CONFIGBLOCK_SIZE 256
  33
  34 /* Max 100ms for a device to positively identify. */
  35 #define SCAN_TIMEOUT (100 * 1000)
  36 #define BULK_XFER_TIMEOUT (10 * 1000)
  37 #define EVENTS_TIMEOUT (10 * 1000)
  38 #define SLEEP_US_LONG (5 * 1000)
  39 #define SLEEP_US_SHORT (1 * 1000)
  40
  41 struct dev_context {
  42         const struct elusb_profile *profile;
  43
  44         /* Generic EL-USB */
  45         unsigned char config[MAX_CONFIGBLOCK_SIZE];
  46         unsigned int log_size;
  47         unsigned int rcvd_bytes;
  48         unsigned int sample_size;
  49         unsigned int logged_samples;
  50         unsigned int rcvd_samples;
  51         uint64_t limit_samples;
  52
  53         /* Model-specific */
  54         /* EL-USB-CO: these are something like scaling and calibration values
  55          * fixed per device, used to convert the sample values to CO ppm. */
  56         float co_high;
  57         float co_low;
  58         /* Temperature units as stored in the device config. */
  59         int temp_unit;
  60 };
  61
  62 enum {
  63         LOG_UNSUPPORTED,
  64         LOG_TEMP_RH,
  65         LOG_CO,
  66 };
  67
  68 struct elusb_profile {
  69         int modelid;
  70         const char *modelname;
  71         int logformat;
  72 };
  73
  74 SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
  75                 unsigned char *configblock, int *configlen);
  76 SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
  77 SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data);
  78 SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer);
  79 SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi);
  80 SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi);
  81 SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi);
  82
  83 #endif