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