hardware/brymen-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_BRYMEN_DMM_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_BRYMEN_DMM_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include <stdlib.h>
  26 #include <math.h>
  27 #include <glib.h>
  28 #include "libsigrok.h"
  29 #include "libsigrok-internal.h"
  30
  31 /* Message logging helpers with driver-specific prefix string. */
  32 #define DRIVER_LOG_DOMAIN "brymen-dmm: "
  33 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  37 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  38 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  39
  40 #define DMM_BUFSIZE 256
  41
  42 enum packet_len_status {
  43         PACKET_HEADER_OK,
  44         PACKET_NEED_MORE_DATA,
  45         PACKET_INVALID_HEADER,
  46 };
  47
  48 /** Private, per-device-instance driver context. */
  49 struct dev_context {
  50         /** The current sampling limit (in number of samples). */
  51         uint64_t limit_samples;
  52
  53         /** The current sampling limit (in ms). */
  54         uint64_t limit_msec;
  55
  56         /** Opaque pointer passed in by the frontend. */
  57         void *cb_data;
  58
  59         /** The current number of already received samples. */
  60         uint64_t num_samples;
  61
  62         /** Start time of acquisition session */
  63         int64_t starttime;
  64
  65         struct sr_serial_dev_inst *serial;
  66
  67         uint8_t buf[DMM_BUFSIZE];
  68         int bufoffset;
  69         int buflen;
  70         int next_packet_len;
  71 };
  72
  73 /**
  74  * Callback that assesses the size and status of the incoming packet.
  75  *
  76  * @return PACKET_HEADER_OK - This is a proper packet header.
  77  *         PACKET_NEED_MORE_DATA The buffer does not contain the entire header.
  78  *         PACKET_INVALID_HEADER Not a valid start of packet.
  79  */
  80 typedef int (*packet_length_t)(const uint8_t *buf, int *len);
  81
  82 SR_PRIV int brymen_dmm_receive_data(int fd, int revents, void *cb_data);
  83 SR_PRIV int brymen_packet_request(struct sr_serial_dev_inst *serial);
  84
  85 SR_PRIV int brymen_packet_length(const uint8_t *buf, int *len);
  86 SR_PRIV gboolean brymen_packet_is_valid(const uint8_t *buf);
  87
  88 SR_PRIV int brymen_stream_detect(struct sr_serial_dev_inst *serial,
  89                                  uint8_t *buf, size_t *buflen,
  90                                  packet_length_t get_packet_size,
  91                                  packet_valid_t is_valid,
  92                                  uint64_t timeout_ms, int baudrate);
  93
  94 #endif