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 <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 /* Message logging helpers with subsystem-specific prefix string. */
  29 #define LOG_PREFIX "norma-dmm: "
  30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  36
  37 #define NMADMM_BUFSIZE  256
  38
  39 /** Norma DMM request types (used ones only, the multimeters support about 50).
  40  */
  41 enum nmadmm_req_t {
  42         NMADMM_REQ_IDN = 0,     /**< Request identity */
  43         NMADMM_REQ_STATUS,      /**< Request device status (value + ...) */
  44 };
  45
  46 /** Defines requests used to communicate with device. */
  47 struct nmadmm_req {
  48         enum nmadmm_req_t req_t;        /** Request type. */
  49         const char* reqstr;             /** Request string */
  50 };
  51
  52 /** Strings for requests. */
  53 extern const struct nmadmm_req nmadmm_requests[];
  54
  55 /** Private, per-device-instance driver context. */
  56 struct dev_context {
  57         /* Model-specific information */
  58         char*   version;        /**< Version string */
  59         int     type;           /**< DM9x0, e.g. 5 = DM950 */
  60         /* Acquisition settings */
  61         uint64_t limit_samples; /**< Target number of samples */
  62         uint64_t limit_msec;    /**< Target sampling time */
  63
  64         /* Opaque pointer passed in by frontend. */
  65         void *cb_data;
  66
  67         /* Operational state */
  68         enum nmadmm_req_t last_req;     /**< Last request. */
  69         gboolean last_req_pending;      /**< Last request not answered yet.*/
  70         int     lowbatt;                /**< Low battery. 1=low, 2=critical.*/
  71         /* Temporary state across callbacks */
  72         uint64_t num_samples;           /**< Current #samples. */
  73         GTimer* elapsed_msec;           /**< Used for sampling with limit_msec*/
  74         unsigned char buf[NMADMM_BUFSIZE];      /**< Buffer for read callback */
  75         int buflen;                     /**< Data len in buf */
  76 };
  77
  78 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data);
  79 SR_PRIV int xgittoint(char xgit);
  80
  81 #endif