source/drv-protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) ${year} ${author} <${email}>
   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_${upper}_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_${upper}_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26
  27 /* Message logging helpers with driver-specific prefix string. */
  28 #define DRIVER_LOG_DOMAIN "${short}: "
  29 #define SR_LOG(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  30 #define SR_SPEW(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  31 #define SR_DBG(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  32 #define SR_INFO(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  33 #define SR_WARN(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  34 #define SR_ERR(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  35
  36 /** Private, per-device-instance driver context. */
  37 struct dev_context {
  38         /** The current sampling limit (in number of samples). */
  39         uint64_t limit_samples;
  40
  41         /** The current sampling limit (in ms). */
  42         uint64_t limit_msec;
  43
  44         /** Opaque pointer passed in by the frontend. */
  45         void *cb_data;
  46
  47         /** The current number of already received samples. */
  48         uint64_t num_samples;
  49 };
  50
  51 SR_PRIV int ${lib}_receive_data(int fd, int revents, void *cb_data);
  52
  53 #endif