hardware/mic-985xx/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H
  23
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include <ctype.h>
  27 #include <glib.h>
  28 #include "libsigrok.h"
  29 #include "libsigrok-internal.h"
  30
  31 /* Message logging helpers with subsystem-specific prefix string. */
  32 #define LOG_PREFIX "mic-985xx: "
  33 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  34 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  35 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  36 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  37 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  38 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  39
  40 /* Note: When adding entries here, don't forget to update MIC_DEV_COUNT. */
  41 enum {
  42         MIC_98581,
  43         MIC_98583,
  44 };
  45
  46 #define MIC_DEV_COUNT 2
  47
  48 struct mic_dev_info {
  49         char *vendor;
  50         char *device;
  51         char *conn;
  52         uint32_t max_sample_points;
  53         gboolean has_temperature;
  54         gboolean has_humidity;
  55         uint8_t packet_size;
  56         gboolean (*packet_valid)(const uint8_t *);
  57         struct sr_dev_driver *di;
  58         int (*receive_data)(int, int, void *);
  59 };
  60
  61 extern SR_PRIV const struct mic_dev_info mic_devs[MIC_DEV_COUNT];
  62
  63 #define SERIAL_BUFSIZE 256
  64
  65 /** Private, per-device-instance driver context. */
  66 struct dev_context {
  67         /** The current sampling limit (in number of samples). */
  68         uint64_t limit_samples;
  69
  70         /** The current sampling limit (in ms). */
  71         uint64_t limit_msec;
  72
  73         /** Opaque pointer passed in by the frontend. */
  74         void *cb_data;
  75
  76         /** The current number of already received samples. */
  77         uint64_t num_samples;
  78
  79         int64_t starttime;
  80
  81         uint8_t buf[SERIAL_BUFSIZE];
  82         int bufoffset;
  83         int buflen;
  84 };
  85
  86 SR_PRIV gboolean packet_valid_temp(const uint8_t *buf);
  87 SR_PRIV gboolean packet_valid_temp_hum(const uint8_t *buf);
  88
  89 SR_PRIV int receive_data_MIC_98581(int fd, int revents, void *cb_data);
  90 SR_PRIV int receive_data_MIC_98583(int fd, int revents, void *cb_data);
  91
  92 SR_PRIV int mic_cmd_get_device_info(struct sr_serial_dev_inst *serial);
  93
  94 #endif