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