src/hardware/atorch/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2023 Mathieu Pilato <pilato.mathieu@free.fr>
   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_ATORCH_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_ATORCH_PROTOCOL_H
  22
  23 #include <glib.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include <stdint.h>
  26
  27 #include "libsigrok-internal.h"
  28
  29 #define LOG_PREFIX "atorch"
  30
  31 #define ATORCH_BUFSIZE  128
  32
  33 struct atorch_device_profile {
  34         uint8_t device_type;
  35         const char *device_name;
  36         const struct atorch_channel_desc *channels;
  37         size_t channel_count;
  38 };
  39
  40 struct atorch_channel_desc {
  41         const char *name;
  42         struct binary_value_spec spec;
  43         struct sr_rational scale;
  44         int digits;
  45         enum sr_mq mq;
  46         enum sr_unit unit;
  47         enum sr_mqflag flags;
  48 };
  49
  50 enum atorch_msg_type {
  51         MSG_REPORT = 0x01,
  52         MSG_REPLY = 0x02,
  53         MSG_COMMAND = 0x11,
  54 };
  55
  56 struct dev_context {
  57         const struct atorch_device_profile *profile;
  58         struct sr_sw_limits limits;
  59         struct feed_queue_analog **feeds;
  60         uint8_t buf[ATORCH_BUFSIZE];
  61         size_t wr_idx;
  62         size_t rd_idx;
  63 };
  64
  65 SR_PRIV int atorch_probe(struct sr_serial_dev_inst *serial, struct dev_context *devc);
  66 SR_PRIV int atorch_receive_data_callback(int fd, int revents, void *cb_data);
  67
  68 #endif