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