src/hardware/norma-dmm/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   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_NORMA_DMM_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_NORMA_DMM_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include <ctype.h>
  26 #include <math.h>
  27 #include <glib.h>
  28 #include "libsigrok.h"
  29 #include "libsigrok-internal.h"
  30
  31 /** @file
  32  *  Norma DM9x0/Siemens B102x DMMs driver.
  33  *  @internal
  34  */
  35
  36 #define LOG_PREFIX "norma-dmm"
  37
  38 #define NMADMM_BUFSIZE  256
  39
  40 #define NMADMM_TIMEOUT_MS 2000 /**< Request timeout. */
  41
  42 /** Norma DMM request types (used ones only, the DMMs support about 50). */
  43 enum {
  44         NMADMM_REQ_IDN = 0,     /**< Request identity */
  45         NMADMM_REQ_STATUS,      /**< Request device status (value + ...) */
  46 };
  47
  48 /** Defines requests used to communicate with device. */
  49 struct nmadmm_req {
  50         int req_type;           /**< Request type. */
  51         const char *req_str;    /**< Request string. */
  52 };
  53
  54 /** Strings for requests. */
  55 extern const struct nmadmm_req nmadmm_requests[];
  56
  57 /** Private, per-device-instance driver context. */
  58 struct dev_context {
  59         /* Model-specific information */
  60         char *version;          /**< Version string */
  61         int type;               /**< DM9x0, e.g. 5 = DM950 */
  62
  63         /* Acquisition settings */
  64         uint64_t limit_samples; /**< Target number of samples */
  65         uint64_t limit_msec;    /**< Target sampling time */
  66
  67         /* Opaque pointer passed in by frontend. */
  68         void *cb_data;
  69
  70         /* Operational state */
  71         int last_req;                   /**< Last request. */
  72         int64_t req_sent_at;            /**< Request sent. */
  73         gboolean last_req_pending;      /**< Last request not answered yet. */
  74         int lowbatt;                    /**< Low battery. 1=low, 2=critical. */
  75
  76         /* Temporary state across callbacks */
  77         uint64_t num_samples;           /**< Current #samples. */
  78         GTimer *elapsed_msec;           /**< Used for limit_msec */
  79         uint8_t buf[NMADMM_BUFSIZE];    /**< Buffer for read callback */
  80         int buflen;                     /**< Data len in buf */
  81 };
  82
  83 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data);
  84 SR_PRIV int xgittoint(char xgit);
  85
  86 #endif