device.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   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 <stdio.h>
  21 #include <glib.h>
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24
  25 /**
  26  * @defgroup grp_devices Devices
  27  *
  28  * Device handling in libsigrok.
  29  *
  30  * @{
  31  */
  32
  33 /** @private */
  34 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  35                 gboolean enabled, const char *name)
  36 {
  37         struct sr_probe *probe;
  38
  39         if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
  40                 sr_err("hwdriver: probe malloc failed");
  41                 return NULL;
  42         }
  43
  44         probe->index = index;
  45         probe->type = type;
  46         probe->enabled = enabled;
  47         if (name)
  48                 probe->name = g_strdup(name);
  49
  50         return probe;
  51 }
  52
  53 /**
  54  * Set the name of the specified probe in the specified device.
  55  *
  56  * If the probe already has a different name assigned to it, it will be
  57  * removed, and the new name will be saved instead.
  58  *
  59  * @param sdi The device instance the probe is connected to.
  60  * @param probenum The number of the probe whose name to set.
  61  *                 Note that the probe numbers start at 0.
  62  * @param name The new name that the specified probe should get. A copy
  63  *             of the string is made.
  64  *
  65  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  66  */
  67 SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
  68                 int probenum, const char *name)
  69 {
  70         GSList *l;
  71         struct sr_probe *probe;
  72         int ret;
  73
  74         if (!sdi) {
  75                 sr_err("%s: sdi was NULL", __func__);
  76                 return SR_ERR_ARG;
  77         }
  78
  79         ret = SR_ERR_ARG;
  80         for (l = sdi->probes; l; l = l->next) {
  81                 probe = l->data;
  82                 if (probe->index == probenum) {
  83                         g_free(probe->name);
  84                         probe->name = g_strdup(name);
  85                         ret = SR_OK;
  86                         break;
  87                 }
  88         }
  89
  90         return ret;
  91 }
  92
  93 /**
  94  * Enable or disable a probe on the specified device.
  95  *
  96  * @param sdi The device instance the probe is connected to.
  97  * @param probenum The probe number, starting from 0.
  98  * @param state TRUE to enable the probe, FALSE to disable.
  99  *
 100  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 101  */
 102 SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
 103                 gboolean state)
 104 {
 105         GSList *l;
 106         struct sr_probe *probe;
 107         int ret;
 108
 109         if (!sdi)
 110                 return SR_ERR_ARG;
 111
 112         ret = SR_ERR_ARG;
 113         for (l = sdi->probes; l; l = l->next) {
 114                 probe = l->data;
 115                 if (probe->index == probenum) {
 116                         probe->enabled = state;
 117                         ret = SR_OK;
 118                         break;
 119                 }
 120         }
 121
 122         return ret;
 123 }
 124
 125 /**
 126  * Add a trigger to the specified device (and the specified probe).
 127  *
 128  * If the specified probe of this device already has a trigger, it will
 129  * be silently replaced.
 130  *
 131  * @param sdi Must not be NULL.
 132  * @param probenum The probe number, starting from 0.
 133  * @param trigger Trigger string, in the format used by sigrok-cli
 134  *
 135  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 136  */
 137 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
 138                 const char *trigger)
 139 {
 140         GSList *l;
 141         struct sr_probe *probe;
 142         int ret;
 143
 144         if (!sdi)
 145                 return SR_ERR_ARG;
 146
 147         ret = SR_ERR_ARG;
 148         for (l = sdi->probes; l; l = l->next) {
 149                 probe = l->data;
 150                 if (probe->index == probenum) {
 151                         /* If the probe already has a trigger, kill it first. */
 152                         g_free(probe->trigger);
 153                         probe->trigger = g_strdup(trigger);
 154                         ret = SR_OK;
 155                         break;
 156                 }
 157         }
 158
 159         return ret;
 160 }
 161
 162 /**
 163  * Determine whether the specified device has the specified capability.
 164  *
 165  * @param dev Pointer to the device instance to be checked. Must not be NULL.
 166  *            If the device's 'driver' field is NULL (virtual device), this
 167  *            function will always return FALSE (virtual devices don't have
 168  *            a hardware capabilities list).
 169  * @param hwcap The capability that should be checked (whether it's supported
 170  *              by the specified device).
 171  *
 172  * @return TRUE if the device has the specified capability, FALSE otherwise.
 173  *         FALSE is also returned upon invalid input parameters or other
 174  *         error conditions.
 175  */
 176 SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap)
 177 {
 178         const int *hwcaps;
 179         int i;
 180
 181         if (!sdi || !sdi->driver)
 182                 return FALSE;
 183
 184         if (sdi->driver->info_get(SR_DI_HWCAPS,
 185                         (const void **)&hwcaps, NULL) != SR_OK)
 186                 return FALSE;
 187
 188         for (i = 0; hwcaps[i]; i++) {
 189                 if (hwcaps[i] == hwcap)
 190                         return TRUE;
 191         }
 192
 193         return FALSE;
 194 }
 195
 196 /** @private */
 197 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 198                 const char *vendor, const char *model, const char *version)
 199 {
 200         struct sr_dev_inst *sdi;
 201
 202         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 203                 sr_err("hwdriver: %s: sdi malloc failed", __func__);
 204                 return NULL;
 205         }
 206
 207         sdi->driver = NULL;
 208         sdi->index = index;
 209         sdi->status = status;
 210         sdi->inst_type = -1;
 211         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 212         sdi->model = model ? g_strdup(model) : NULL;
 213         sdi->version = version ? g_strdup(version) : NULL;
 214         sdi->probes = NULL;
 215         sdi->priv = NULL;
 216
 217         return sdi;
 218 }
 219
 220 /** @private */
 221 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 222 {
 223         struct sr_probe *probe;
 224         GSList *l;
 225
 226         for (l = sdi->probes; l; l = l->next) {
 227                 probe = l->data;
 228                 g_free(probe->name);
 229                 g_free(probe);
 230         }
 231
 232         g_free(sdi->priv);
 233         g_free(sdi->vendor);
 234         g_free(sdi->model);
 235         g_free(sdi->version);
 236         g_free(sdi);
 237
 238 }
 239
 240 #ifdef HAVE_LIBUSB_1_0
 241
 242 /** @private */
 243 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 244                         uint8_t address, struct libusb_device_handle *hdl)
 245 {
 246         struct sr_usb_dev_inst *udi;
 247
 248         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 249                 sr_err("hwdriver: %s: udi malloc failed", __func__);
 250                 return NULL;
 251         }
 252
 253         udi->bus = bus;
 254         udi->address = address;
 255         udi->devhdl = hdl;
 256
 257         return udi;
 258 }
 259
 260 /** @private */
 261 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 262 {
 263         /* Avoid compiler warnings. */
 264         (void)usb;
 265
 266         /* Nothing to do for this device instance type. */
 267 }
 268
 269 #endif
 270
 271 /** @private */
 272 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 273                                                           int fd)
 274 {
 275         struct sr_serial_dev_inst *serial;
 276
 277         if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
 278                 sr_err("hwdriver: %s: serial malloc failed", __func__);
 279                 return NULL;
 280         }
 281
 282         serial->port = g_strdup(port);
 283         serial->fd = fd;
 284
 285         return serial;
 286 }
 287
 288 /** @private */
 289 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 290 {
 291         g_free(serial->port);
 292 }
 293
 294 SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 295                 const void *value)
 296 {
 297         int ret;
 298
 299         if (!sdi || !sdi->driver || !sdi->driver->dev_config_set) {
 300                 sr_err("hwdriver: unable to set config option");
 301                 return SR_ERR;
 302         }
 303
 304         ret = sdi->driver->dev_config_set(sdi, hwcap, value);
 305
 306         return ret;
 307 }
 308
 309 SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver)
 310 {
 311
 312         if (driver && driver->dev_list)
 313                 return driver->dev_list();
 314         else
 315                 return NULL;
 316 }
 317
 318 SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver)
 319 {
 320
 321         if (driver && driver->dev_clear)
 322                 return driver->dev_clear();
 323         else
 324                 return SR_OK;
 325 }
 326
 327 /** @} */