src/hardware/serial-dmm/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.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_SERIAL_DMM_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_SERIAL_DMM_PROTOCOL_H
  22
  23 #define LOG_PREFIX "serial-dmm"
  24
  25 struct dmm_info {
  26         /** libsigrok driver info struct. */
  27         struct sr_dev_driver di;
  28         /** Manufacturer/brand. */
  29         const char *vendor;
  30         /** Model. */
  31         const char *device;
  32         /** serialconn string. */
  33         const char *conn;
  34         /** Baud rate. */
  35         uint32_t baudrate;
  36         /** Packet size in bytes. */
  37         int packet_size;
  38         /** Request timeout [ms] before request is considered lost and a new
  39          *  one is sent. Used only if device needs polling. */
  40         int64_t req_timeout_ms;
  41         /** Delay between reception of packet and next request. Some DMMs
  42          *  need this. Used only if device needs polling. */
  43         int64_t req_delay_ms;
  44         /** Packet request function. */
  45         int (*packet_request)(struct sr_serial_dev_inst *);
  46         /** Packet validation function. */
  47         gboolean (*packet_valid)(const uint8_t *);
  48         /** Packet parsing function. */
  49         int (*packet_parse)(const uint8_t *, float *,
  50                             struct sr_datafeed_analog_old *, void *);
  51         /** */
  52         void (*dmm_details)(struct sr_datafeed_analog_old *, void *);
  53         /** Size of chipset info struct. */
  54         gsize info_size;
  55 };
  56
  57 #define DMM_BUFSIZE 256
  58
  59 /** Private, per-device-instance driver context. */
  60 struct dev_context {
  61         /** The current sampling limit (in number of samples). */
  62         uint64_t limit_samples;
  63
  64         /** The time limit (in milliseconds). */
  65         uint64_t limit_msec;
  66
  67         /** The current number of already received samples. */
  68         uint64_t num_samples;
  69
  70         /** The starting time of current sampling run. */
  71         int64_t starttime;
  72
  73         uint8_t buf[DMM_BUFSIZE];
  74         int bufoffset;
  75         int buflen;
  76
  77         /** The timestamp [µs] to send the next request.
  78          *  Used only if device needs polling. */
  79         int64_t req_next_at;
  80 };
  81
  82 SR_PRIV int req_packet(struct sr_dev_inst *sdi);
  83 SR_PRIV int receive_data(int fd, int revents, void *cb_data);
  84
  85 #endif