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 int32_t hwopts[] = {
  27         SR_CONF_CONN,
  28         SR_CONF_SERIALCOMM,
  29 };
  30
  31 static const int32_t hwcaps[] = {
  32         SR_CONF_ENERGYMETER,
  33         SR_CONF_LIMIT_SAMPLES,
  34         SR_CONF_LIMIT_MSEC,
  35         SR_CONF_CONTINUOUS,
  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 | SERIAL_NONBLOCK) != 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         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "EDF", "Teleinfo", NULL)))
  96                 goto scan_cleanup;
  97
  98         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
  99                 sr_err("Device context malloc failed.");
 100                 goto scan_cleanup;
 101         }
 102
 103         devc->optarif = teleinfo_get_optarif(buf);
 104
 105         sdi->inst_type = SR_INST_SERIAL;
 106         sdi->conn = serial;
 107         sdi->priv = devc;
 108         sdi->driver = di;
 109
 110         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P")))
 111                 goto scan_cleanup;
 112         sdi->channels = g_slist_append(sdi->channels, ch);
 113
 114         if (devc->optarif == OPTARIF_BASE) {
 115                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "BASE")))
 116                         goto scan_cleanup;
 117                 sdi->channels = g_slist_append(sdi->channels, ch);
 118         } else if (devc->optarif == OPTARIF_HC) {
 119                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HP")))
 120                         goto scan_cleanup;
 121                 sdi->channels = g_slist_append(sdi->channels, ch);
 122                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HC")))
 123                         goto scan_cleanup;
 124                 sdi->channels = g_slist_append(sdi->channels, ch);
 125         } else if (devc->optarif == OPTARIF_EJP) {
 126                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HN")))
 127                         goto scan_cleanup;
 128                 sdi->channels = g_slist_append(sdi->channels, ch);
 129                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPM")))
 130                         goto scan_cleanup;
 131                 sdi->channels = g_slist_append(sdi->channels, ch);
 132         } else if (devc->optarif == OPTARIF_BBR) {
 133                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJB")))
 134                         goto scan_cleanup;
 135                 sdi->channels = g_slist_append(sdi->channels, ch);
 136                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJW")))
 137                         goto scan_cleanup;
 138                 sdi->channels = g_slist_append(sdi->channels, ch);
 139                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HPJR")))
 140                         goto scan_cleanup;
 141                 sdi->channels = g_slist_append(sdi->channels, ch);
 142                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJB")))
 143                         goto scan_cleanup;
 144                 sdi->channels = g_slist_append(sdi->channels, ch);
 145                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJW")))
 146                         goto scan_cleanup;
 147                 sdi->channels = g_slist_append(sdi->channels, ch);
 148                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "HCJR")))
 149                         goto scan_cleanup;
 150                 sdi->channels = g_slist_append(sdi->channels, ch);
 151         }
 152
 153         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "IINST")))
 154                 goto scan_cleanup;
 155         sdi->channels = g_slist_append(sdi->channels, ch);
 156
 157         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "PAPP")))
 158                 goto scan_cleanup;
 159         sdi->channels = g_slist_append(sdi->channels, ch);
 160
 161         drvc->instances = g_slist_append(drvc->instances, sdi);
 162         devices = g_slist_append(devices, sdi);
 163
 164 scan_cleanup:
 165         serial_close(serial);
 166
 167         return devices;
 168 }
 169
 170 static GSList *dev_list(void)
 171 {
 172         return ((struct drv_context *)(di->priv))->instances;
 173 }
 174
 175 static int cleanup(void)
 176 {
 177         return std_dev_clear(di, NULL);
 178 }
 179
 180 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 181                 const struct sr_channel_group *cg)
 182 {
 183         struct dev_context *devc;
 184
 185         (void)cg;
 186
 187         if (sdi->status != SR_ST_ACTIVE)
 188                 return SR_ERR_DEV_CLOSED;
 189
 190         if (!(devc = sdi->priv)) {
 191                 sr_err("sdi->priv was NULL.");
 192                 return SR_ERR_BUG;
 193         }
 194
 195         switch (key) {
 196         case SR_CONF_LIMIT_SAMPLES:
 197                 devc->limit_samples = g_variant_get_uint64(data);
 198                 sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
 199                 break;
 200         case SR_CONF_LIMIT_MSEC:
 201                 devc->limit_msec = g_variant_get_uint64(data);
 202                 sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
 203                 break;
 204         default:
 205                 return SR_ERR_NA;
 206         }
 207
 208         return SR_OK;
 209 }
 210
 211 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 212                 const struct sr_channel_group *cg)
 213 {
 214         (void)sdi;
 215         (void)cg;
 216
 217         switch (key) {
 218         case SR_CONF_SCAN_OPTIONS:
 219                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 220                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 221                 break;
 222         case SR_CONF_DEVICE_OPTIONS:
 223                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 224                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 225                 break;
 226         default:
 227                 return SR_ERR_NA;
 228         }
 229
 230         return SR_OK;
 231 }
 232
 233 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 234 {
 235         struct sr_serial_dev_inst *serial = sdi->conn;
 236         struct dev_context *devc;
 237
 238         if (sdi->status != SR_ST_ACTIVE)
 239                 return SR_ERR_DEV_CLOSED;
 240
 241         if (!(devc = sdi->priv)) {
 242                 sr_err("sdi->priv was NULL.");
 243                 return SR_ERR_BUG;
 244         }
 245
 246         devc->session_cb_data = cb_data;
 247
 248         /*
 249          * Reset the number of samples to take. If we've already collected our
 250          * quota, but we start a new session, and don't reset this, we'll just
 251          * quit without acquiring any new samples.
 252          */
 253         devc->num_samples = 0;
 254         devc->start_time = g_get_monotonic_time();
 255
 256         /* Send header packet to the session bus. */
 257         std_session_send_df_header(cb_data, LOG_PREFIX);
 258
 259         /* Poll every 50ms, or whenever some data comes in. */
 260         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 261                         teleinfo_receive_data, (void *)sdi);
 262
 263         return SR_OK;
 264 }
 265
 266 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 267 {
 268         return std_serial_dev_acquisition_stop(sdi, cb_data,
 269                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 270 }
 271
 272 SR_PRIV struct sr_dev_driver teleinfo_driver_info = {
 273         .name = "teleinfo",
 274         .longname = "Teleinfo",
 275         .api_version = 1,
 276         .init = init,
 277         .cleanup = cleanup,
 278         .scan = scan,
 279         .dev_list = dev_list,
 280         .dev_clear = NULL,
 281         .config_get = NULL,
 282         .config_set = config_set,
 283         .config_list = config_list,
 284         .dev_open = std_serial_dev_open,
 285         .dev_close = std_serial_dev_close,
 286         .dev_acquisition_start = dev_acquisition_start,
 287         .dev_acquisition_stop = dev_acquisition_stop,
 288         .priv = NULL,
 289 };