src/hardware/teleinfo/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   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 <stdlib.h>
  21 #include <glib.h>
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24 #include "protocol.h"
  25
  26 static const uint32_t scanopts[] = {
  27         SR_CONF_CONN,
  28         SR_CONF_SERIALCOMM,
  29 };
  30
  31 static const uint32_t devopts[] = {
  32         SR_CONF_ENERGYMETER,
  33         SR_CONF_CONTINUOUS,
  34         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  35         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  36 };
  37
  38 SR_PRIV struct sr_dev_driver teleinfo_driver_info;
  39 static struct sr_dev_driver *di = &teleinfo_driver_info;
  40
  41 static int init(struct sr_context *sr_ctx)
  42 {
  43         return std_init(sr_ctx, di, LOG_PREFIX);
  44 }
  45
  46 static GSList *scan(GSList *options)
  47 {
  48         struct drv_context *drvc;
  49         struct dev_context *devc;
  50         struct sr_serial_dev_inst *serial;
  51         struct sr_dev_inst *sdi;
  52         struct sr_channel *ch;
  53         GSList *devices = NULL, *l;
  54         const char *conn = NULL, *serialcomm = NULL;
  55         uint8_t buf[292];
  56         size_t len;
  57         struct sr_config *src;
  58
  59         len = sizeof(buf);
  60
  61         for (l = options; l; l = l->next) {
  62                 src = l->data;
  63                 switch (src->key) {
  64                 case SR_CONF_CONN:
  65                         conn = g_variant_get_string(src->data, NULL);
  66                         break;
  67                 case SR_CONF_SERIALCOMM:
  68                         serialcomm = g_variant_get_string(src->data, NULL);
  69                         break;
  70                 }
  71         }
  72         if (!conn)
  73                 return NULL;
  74         if (!serialcomm)
  75                 serialcomm = "1200/7e1";
  76
  77         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  78                 return NULL;
  79         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  80                 return NULL;
  81
  82         sr_info("Probing serial port %s.", conn);
  83
  84         drvc = di->priv;
  85         drvc->instances = NULL;
  86         serial_flush(serial);
  87
  88         /* Let's get a bit of data and see if we can find a packet. */
  89         if (serial_stream_detect(serial, buf, &len, len,
  90                                  teleinfo_packet_valid, 3000, 1200) != SR_OK)
  91                 goto scan_cleanup;
  92
  93         sr_info("Found device on port %s.", conn);
  94
  95         sdi = sr_dev_inst_new();
  96         sdi->status = SR_ST_INACTIVE;
  97         sdi->vendor = g_strdup("EDF");
  98         sdi->model = g_strdup("Teleinfo");
  99
 100         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 101                 sr_err("Device context malloc failed.");
 102                 goto scan_cleanup;
 103         }
 104
 105         devc->optarif = teleinfo_get_optarif(buf);
 106
 107         sdi->inst_type = SR_INST_SERIAL;
 108         sdi->conn = serial;
 109         sdi->priv = devc;
 110         sdi->driver = di;
 111
 112         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P")))
 113                 goto scan_cleanup;
 114         sdi->channels = g_slist_append(sdi->channels, ch);
 115
 116         if (devc->optarif == OPTARIF_BASE) {
 117                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "BASE")))
 118                         goto scan_cleanup;
 119                 sdi->channels = g_slist_append(sdi->channels, ch);
 120         } else if (devc->optarif == OPTARIF_HC) {
 121                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HP")))
 122                         goto scan_cleanup;
 123                 sdi->channels = g_slist_append(sdi->channels, ch);
 124                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HC")))
 125                         goto scan_cleanup;
 126                 sdi->channels = g_slist_append(sdi->channels, ch);
 127         } else if (devc->optarif == OPTARIF_EJP) {
 128                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HN")))
 129                         goto scan_cleanup;
 130                 sdi->channels = g_slist_append(sdi->channels, ch);
 131                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPM")))
 132                         goto scan_cleanup;
 133                 sdi->channels = g_slist_append(sdi->channels, ch);
 134         } else if (devc->optarif == OPTARIF_BBR) {
 135                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJB")))
 136                         goto scan_cleanup;
 137                 sdi->channels = g_slist_append(sdi->channels, ch);
 138                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJW")))
 139                         goto scan_cleanup;
 140                 sdi->channels = g_slist_append(sdi->channels, ch);
 141                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJR")))
 142                         goto scan_cleanup;
 143                 sdi->channels = g_slist_append(sdi->channels, ch);
 144                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJB")))
 145                         goto scan_cleanup;
 146                 sdi->channels = g_slist_append(sdi->channels, ch);
 147                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJW")))
 148                         goto scan_cleanup;
 149                 sdi->channels = g_slist_append(sdi->channels, ch);
 150                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJR")))
 151                         goto scan_cleanup;
 152                 sdi->channels = g_slist_append(sdi->channels, ch);
 153         }
 154
 155         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "IINST")))
 156                 goto scan_cleanup;
 157         sdi->channels = g_slist_append(sdi->channels, ch);
 158
 159         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "PAPP")))
 160                 goto scan_cleanup;
 161         sdi->channels = g_slist_append(sdi->channels, ch);
 162
 163         drvc->instances = g_slist_append(drvc->instances, sdi);
 164         devices = g_slist_append(devices, sdi);
 165
 166 scan_cleanup:
 167         serial_close(serial);
 168
 169         return devices;
 170 }
 171
 172 static GSList *dev_list(void)
 173 {
 174         return ((struct drv_context *)(di->priv))->instances;
 175 }
 176
 177 static int cleanup(void)
 178 {
 179         return std_dev_clear(di, NULL);
 180 }
 181
 182 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 183                 const struct sr_channel_group *cg)
 184 {
 185         struct dev_context *devc;
 186
 187         (void)cg;
 188
 189         if (sdi->status != SR_ST_ACTIVE)
 190                 return SR_ERR_DEV_CLOSED;
 191
 192         if (!(devc = sdi->priv)) {
 193                 sr_err("sdi->priv was NULL.");
 194                 return SR_ERR_BUG;
 195         }
 196
 197         switch (key) {
 198         case SR_CONF_LIMIT_SAMPLES:
 199                 devc->limit_samples = g_variant_get_uint64(data);
 200                 sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
 201                 break;
 202         case SR_CONF_LIMIT_MSEC:
 203                 devc->limit_msec = g_variant_get_uint64(data);
 204                 sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
 205                 break;
 206         default:
 207                 return SR_ERR_NA;
 208         }
 209
 210         return SR_OK;
 211 }
 212
 213 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 214                 const struct sr_channel_group *cg)
 215 {
 216         (void)sdi;
 217         (void)cg;
 218
 219         switch (key) {
 220         case SR_CONF_SCAN_OPTIONS:
 221                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 222                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 223                 break;
 224         case SR_CONF_DEVICE_OPTIONS:
 225                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 226                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 227                 break;
 228         default:
 229                 return SR_ERR_NA;
 230         }
 231
 232         return SR_OK;
 233 }
 234
 235 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 236 {
 237         struct sr_serial_dev_inst *serial = sdi->conn;
 238         struct dev_context *devc;
 239
 240         if (sdi->status != SR_ST_ACTIVE)
 241                 return SR_ERR_DEV_CLOSED;
 242
 243         if (!(devc = sdi->priv)) {
 244                 sr_err("sdi->priv was NULL.");
 245                 return SR_ERR_BUG;
 246         }
 247
 248         devc->session_cb_data = cb_data;
 249
 250         /*
 251          * Reset the number of samples to take. If we've already collected our
 252          * quota, but we start a new session, and don't reset this, we'll just
 253          * quit without acquiring any new samples.
 254          */
 255         devc->num_samples = 0;
 256         devc->start_time = g_get_monotonic_time();
 257
 258         /* Send header packet to the session bus. */
 259         std_session_send_df_header(cb_data, LOG_PREFIX);
 260
 261         /* Poll every 50ms, or whenever some data comes in. */
 262         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 263                         teleinfo_receive_data, (void *)sdi);
 264
 265         return SR_OK;
 266 }
 267
 268 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 269 {
 270         return std_serial_dev_acquisition_stop(sdi, cb_data,
 271                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 272 }
 273
 274 SR_PRIV struct sr_dev_driver teleinfo_driver_info = {
 275         .name = "teleinfo",
 276         .longname = "Teleinfo",
 277         .api_version = 1,
 278         .init = init,
 279         .cleanup = cleanup,
 280         .scan = scan,
 281         .dev_list = dev_list,
 282         .dev_clear = NULL,
 283         .config_get = NULL,
 284         .config_set = config_set,
 285         .config_list = config_list,
 286         .dev_open = std_serial_dev_open,
 287         .dev_close = std_serial_dev_close,
 288         .dev_acquisition_start = dev_acquisition_start,
 289         .dev_acquisition_stop = dev_acquisition_stop,
 290         .priv = NULL,
 291 };