source/drv-api.c

   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 #include <config.h>
  21 #include "protocol.h"
  22
  23 SR_PRIV struct sr_dev_driver {lib}_driver_info;
  24
  25 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  26 {{
  27         struct drv_context *drvc;
  28         GSList *devices;
  29
  30         (void)options;
  31
  32         devices = NULL;
  33         drvc = di->context;
  34         drvc->instances = NULL;
  35
  36         /* TODO: scan for devices, either based on a SR_CONF_CONN option
  37          * or on a USB scan. */
  38
  39         return devices;
  40 }}
  41
  42 static int dev_clear(const struct sr_dev_driver *di)
  43 {{
  44         return std_dev_clear(di, NULL);
  45 }}
  46
  47 static int dev_open(struct sr_dev_inst *sdi)
  48 {{
  49         (void)sdi;
  50
  51         /* TODO: get handle from sdi->conn and open it. */
  52
  53         return SR_OK;
  54 }}
  55
  56 static int dev_close(struct sr_dev_inst *sdi)
  57 {{
  58         (void)sdi;
  59
  60         /* TODO: get handle from sdi->conn and close it. */
  61
  62         return SR_OK;
  63 }}
  64
  65 static int config_get(uint32_t key, GVariant **data,
  66         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
  67 {{
  68         int ret;
  69
  70         (void)sdi;
  71         (void)data;
  72         (void)cg;
  73
  74         ret = SR_OK;
  75         switch (key) {{
  76         /* TODO */
  77         default:
  78                 return SR_ERR_NA;
  79         }}
  80
  81         return ret;
  82 }}
  83
  84 static int config_set(uint32_t key, GVariant *data,
  85         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
  86 {{
  87         int ret;
  88
  89         (void)data;
  90         (void)cg;
  91
  92         ret = SR_OK;
  93         switch (key) {{
  94         /* TODO */
  95         default:
  96                 ret = SR_ERR_NA;
  97         }}
  98
  99         return ret;
 100 }}
 101
 102 static int config_list(uint32_t key, GVariant **data,
 103         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 104 {{
 105         int ret;
 106
 107         (void)sdi;
 108         (void)data;
 109         (void)cg;
 110
 111         ret = SR_OK;
 112         switch (key) {{
 113         /* TODO */
 114         default:
 115                 return SR_ERR_NA;
 116         }}
 117
 118         return ret;
 119 }}
 120
 121 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 122 {{
 123         /* TODO: configure hardware, reset acquisition state, set up
 124          * callbacks and send header packet. */
 125
 126         return SR_OK;
 127 }}
 128
 129 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 130 {{
 131         /* TODO: stop acquisition. */
 132
 133         return SR_OK;
 134 }}
 135
 136 SR_PRIV struct sr_dev_driver {lib}_driver_info = {{
 137         .name = "{short}",
 138         .longname = "{name}",
 139         .api_version = 1,
 140         .init = std_init,
 141         .cleanup = std_cleanup,
 142         .scan = scan,
 143         .dev_list = std_dev_list,
 144         .dev_clear = dev_clear,
 145         .config_get = config_get,
 146         .config_set = config_set,
 147         .config_list = config_list,
 148         .dev_open = dev_open,
 149         .dev_close = dev_close,
 150         .dev_acquisition_start = dev_acquisition_start,
 151         .dev_acquisition_stop = dev_acquisition_stop,
 152         .context = NULL,
 153 }};
 154
 155 SR_REGISTER_DEV_DRIVER({lib}_driver_info);