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 GSList *scan(struct sr_dev_driver *di, GSList *options)
  42 {
  43         struct drv_context *drvc;
  44         struct dev_context *devc;
  45         struct sr_serial_dev_inst *serial;
  46         struct sr_dev_inst *sdi;
  47         GSList *devices = NULL, *l;
  48         const char *conn = NULL, *serialcomm = NULL;
  49         uint8_t buf[292];
  50         size_t len;
  51         struct sr_config *src;
  52
  53         len = sizeof(buf);
  54
  55         for (l = options; l; l = l->next) {
  56                 src = l->data;
  57                 switch (src->key) {
  58                 case SR_CONF_CONN:
  59                         conn = g_variant_get_string(src->data, NULL);
  60                         break;
  61                 case SR_CONF_SERIALCOMM:
  62                         serialcomm = g_variant_get_string(src->data, NULL);
  63                         break;
  64                 }
  65         }
  66         if (!conn)
  67                 return NULL;
  68         if (!serialcomm)
  69                 serialcomm = "1200/7e1";
  70
  71         serial = sr_serial_dev_inst_new(conn, serialcomm);
  72
  73         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  74                 return NULL;
  75
  76         sr_info("Probing serial port %s.", conn);
  77
  78         drvc = di->context;
  79         drvc->instances = NULL;
  80         serial_flush(serial);
  81
  82         /* Let's get a bit of data and see if we can find a packet. */
  83         if (serial_stream_detect(serial, buf, &len, len,
  84                                  teleinfo_packet_valid, 3000, 1200) != SR_OK)
  85                 goto scan_cleanup;
  86
  87         sr_info("Found device on port %s.", conn);
  88
  89         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  90         sdi->status = SR_ST_INACTIVE;
  91         sdi->vendor = g_strdup("EDF");
  92         sdi->model = g_strdup("Teleinfo");
  93         devc = g_malloc0(sizeof(struct dev_context));
  94         devc->optarif = teleinfo_get_optarif(buf);
  95         sdi->inst_type = SR_INST_SERIAL;
  96         sdi->conn = serial;
  97         sdi->priv = devc;
  98         sdi->driver = di;
  99
 100         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P");
 101
 102         if (devc->optarif == OPTARIF_BASE) {
 103                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "BASE");
 104         } else if (devc->optarif == OPTARIF_HC) {
 105                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HP");
 106                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HC");
 107         } else if (devc->optarif == OPTARIF_EJP) {
 108                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HN");
 109                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPM");
 110         } else if (devc->optarif == OPTARIF_BBR) {
 111                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
 112                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
 113                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
 114                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
 115                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
 116                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
 117         }
 118
 119         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "IINST");
 120         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
 121
 122         drvc->instances = g_slist_append(drvc->instances, sdi);
 123         devices = g_slist_append(devices, sdi);
 124
 125 scan_cleanup:
 126         serial_close(serial);
 127
 128         return devices;
 129 }
 130
 131 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 132                 const struct sr_channel_group *cg)
 133 {
 134         struct dev_context *devc;
 135
 136         (void)cg;
 137
 138         if (sdi->status != SR_ST_ACTIVE)
 139                 return SR_ERR_DEV_CLOSED;
 140
 141         if (!(devc = sdi->priv)) {
 142                 sr_err("sdi->priv was NULL.");
 143                 return SR_ERR_BUG;
 144         }
 145
 146         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 147 }
 148
 149 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 150                 const struct sr_channel_group *cg)
 151 {
 152         (void)sdi;
 153         (void)cg;
 154
 155         switch (key) {
 156         case SR_CONF_SCAN_OPTIONS:
 157                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 158                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 159                 break;
 160         case SR_CONF_DEVICE_OPTIONS:
 161                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 162                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 163                 break;
 164         default:
 165                 return SR_ERR_NA;
 166         }
 167
 168         return SR_OK;
 169 }
 170
 171 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 172 {
 173         struct sr_serial_dev_inst *serial = sdi->conn;
 174         struct dev_context *devc;
 175
 176         if (sdi->status != SR_ST_ACTIVE)
 177                 return SR_ERR_DEV_CLOSED;
 178
 179         devc = sdi->priv;
 180
 181         sr_sw_limits_acquisition_start(&devc->sw_limits);
 182
 183         std_session_send_df_header(sdi, LOG_PREFIX);
 184
 185         /* Poll every 50ms, or whenever some data comes in. */
 186         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 187                         teleinfo_receive_data, (void *)sdi);
 188
 189         return SR_OK;
 190 }
 191
 192 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 193 {
 194         return std_serial_dev_acquisition_stop(sdi,
 195                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 196 }
 197
 198 SR_PRIV struct sr_dev_driver teleinfo_driver_info = {
 199         .name = "teleinfo",
 200         .longname = "Teleinfo",
 201         .api_version = 1,
 202         .init = std_init,
 203         .cleanup = std_cleanup,
 204         .scan = scan,
 205         .dev_list = std_dev_list,
 206         .dev_clear = NULL,
 207         .config_get = NULL,
 208         .config_set = config_set,
 209         .config_list = config_list,
 210         .dev_open = std_serial_dev_open,
 211         .dev_close = std_serial_dev_close,
 212         .dev_acquisition_start = dev_acquisition_start,
 213         .dev_acquisition_stop = dev_acquisition_stop,
 214         .context = NULL,
 215 };