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