1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
|
// SPDX-License-Identifier: LGPL-2.1-or-later
/*
* libiio - Library for interfacing industrial I/O (IIO) devices
*
* Copyright (C) 2014 Analog Devices, Inc.
* Author: Paul Cercueil <paul.cercueil@analog.com>
*/
#include "debug.h"
#include "iio-config.h"
#include "iio-private.h"
#include "sort.h"
#include <errno.h>
#include <string.h>
static const char xml_header[] = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
"<!DOCTYPE context ["
"<!ELEMENT context (device | context-attribute)*>"
"<!ELEMENT context-attribute EMPTY>"
"<!ELEMENT device (channel | attribute | debug-attribute | buffer-attribute)*>"
"<!ELEMENT channel (scan-element?, attribute*)>"
"<!ELEMENT attribute EMPTY>"
"<!ELEMENT scan-element EMPTY>"
"<!ELEMENT debug-attribute EMPTY>"
"<!ELEMENT buffer-attribute EMPTY>"
"<!ATTLIST context name CDATA #REQUIRED version-major CDATA #REQUIRED "
"version-minor CDATA #REQUIRED version-git CDATA #REQUIRED description CDATA #IMPLIED>"
"<!ATTLIST context-attribute name CDATA #REQUIRED value CDATA #REQUIRED>"
"<!ATTLIST device id CDATA #REQUIRED name CDATA #IMPLIED label CDATA #IMPLIED>"
"<!ATTLIST channel id CDATA #REQUIRED type (input|output) #REQUIRED name CDATA #IMPLIED>"
"<!ATTLIST scan-element index CDATA #REQUIRED format CDATA #REQUIRED scale CDATA #IMPLIED>"
"<!ATTLIST attribute name CDATA #REQUIRED filename CDATA #IMPLIED>"
"<!ATTLIST debug-attribute name CDATA #REQUIRED>"
"<!ATTLIST buffer-attribute name CDATA #REQUIRED>"
"]>";
static ssize_t sanitize_xml(char *ptr, ssize_t len, const char *str)
{
ssize_t count = 0;
ssize_t ret;
for (; *str; str++) {
switch(*str) {
case '&':
ret = iio_snprintf(ptr, len, "%s", "&");
break;
case '<':
ret = iio_snprintf(ptr, len, "%s", "<");
break;
case '>':
ret = iio_snprintf(ptr, len, "%s", ">");
break;
case '\'':
ret = iio_snprintf(ptr, len, "%s", "'");
break;
case '"':
ret = iio_snprintf(ptr, len, "%s", """);
break;
default:
ret = iio_snprintf(ptr, len, "%c", *str);
break;
}
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &count);
}
return count;
}
ssize_t iio_xml_print_and_sanitized_param(char *ptr, ssize_t len,
const char *before, char *param,
const char *after)
{
ssize_t ret, alen = 0;
/* Print before */
ret = iio_snprintf(ptr, len, "%s", before);
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
/* Print param */
ret = sanitize_xml(ptr, len, param);
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
/* Print after */
ret = iio_snprintf(ptr, len, "%s", after);
if (ret < 0)
return ret;
return alen + ret;
}
static ssize_t iio_snprintf_context_xml(char *ptr, ssize_t len,
const struct iio_context *ctx)
{
ssize_t ret, alen = 0;
unsigned int i, major, minor;
char git_tag[64];
ret = iio_context_get_version(ctx, &major, &minor, git_tag);
if (ret < 0)
return ret;
ret = iio_snprintf(ptr, len,
"%s<context name=\"%s\" version-major=\"%u\" "
"version-minor=\"%u\" version-git=\"%s\" ",
xml_header, ctx->name, major, minor, git_tag);
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
if (ctx->description) {
ret = iio_xml_print_and_sanitized_param(ptr, len,
"description=\"",
ctx->description,
"\" >");
} else {
ret = iio_snprintf(ptr, len, ">");
}
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
for (i = 0; i < ctx->nb_attrs; i++) {
ret = iio_snprintf(ptr, len,
"<context-attribute name=\"%s\" ",
ctx->attrs[i]);
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
ret = iio_xml_print_and_sanitized_param(ptr, len,
"value=\"",
ctx->values[i],
"\" />");
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
}
for (i = 0; i < ctx->nb_devices; i++) {
ret = iio_snprintf_device_xml(ptr, len, ctx->devices[i]);
if (ret < 0)
return ret;
iio_update_xml_indexes(ret, &ptr, &len, &alen);
}
ret = iio_snprintf(ptr, len, "</context>");
if (ret < 0)
return ret;
return alen + ret;
}
/* Returns a string containing the XML representation of this context */
static char * iio_context_create_xml(const struct iio_context *ctx)
{
ssize_t len;
char *str;
len = iio_snprintf_context_xml(NULL, 0, ctx);
if (len < 0)
return ERR_PTR((int) len);
len++; /* room for terminating NULL */
str = malloc(len);
if (!str)
return ERR_PTR(-ENOMEM);
len = iio_snprintf_context_xml(str, len, ctx);
if (len < 0) {
free(str);
return ERR_PTR((int) len);
}
return str;
}
struct iio_context * iio_context_create_from_backend(
const struct iio_backend *backend,
const char *description)
{
struct iio_context *ctx;
int ret;
if (!backend) {
errno = EINVAL;
return NULL;
}
ctx = zalloc(sizeof(*ctx));
if (!ctx) {
errno = ENOMEM;
return NULL;
}
ret = -ENOMEM;
if (backend->sizeof_context_pdata) {
ctx->pdata = zalloc(backend->sizeof_context_pdata);
if (!ctx->pdata)
goto err_free_ctx;
}
if (description) {
ctx->description = iio_strdup(description);
if (!ctx->description)
goto err_free_pdata;
}
ctx->name = backend->name;
ctx->ops = backend->ops;
return ctx;
err_free_pdata:
free(ctx->pdata);
err_free_ctx:
free(ctx);
errno = -ret;
return NULL;
}
struct iio_context_pdata * iio_context_get_pdata(const struct iio_context *ctx)
{
return ctx->pdata;
}
const char * iio_context_get_xml(const struct iio_context *ctx)
{
return ctx->xml;
}
const char * iio_context_get_name(const struct iio_context *ctx)
{
return ctx->name;
}
const char * iio_context_get_description(const struct iio_context *ctx)
{
if (ctx->description)
return ctx->description;
else
return "";
}
void iio_context_destroy(struct iio_context *ctx)
{
unsigned int i;
if (ctx->ops->shutdown)
ctx->ops->shutdown(ctx);
for (i = 0; i < ctx->nb_attrs; i++) {
free(ctx->attrs[i]);
free(ctx->values[i]);
}
free(ctx->attrs);
free(ctx->values);
for (i = 0; i < ctx->nb_devices; i++)
free_device(ctx->devices[i]);
free(ctx->devices);
free(ctx->xml);
free(ctx->description);
free(ctx->git_tag);
free(ctx->pdata);
free(ctx);
}
unsigned int iio_context_get_devices_count(const struct iio_context *ctx)
{
return ctx->nb_devices;
}
struct iio_device * iio_context_get_device(const struct iio_context *ctx,
unsigned int index)
{
if (index >= ctx->nb_devices)
return NULL;
else
return ctx->devices[index];
}
struct iio_device * iio_context_find_device(const struct iio_context *ctx,
const char *name)
{
unsigned int i;
for (i = 0; i < ctx->nb_devices; i++) {
struct iio_device *dev = ctx->devices[i];
if (!strcmp(dev->id, name) ||
(dev->label && !strcmp(dev->label, name)) ||
(dev->name && !strcmp(dev->name, name)))
return dev;
}
return NULL;
}
static void reorder_channels(struct iio_device *dev)
{
bool found;
unsigned int i;
/* Reorder channels by index */
do {
found = false;
for (i = 1; i < dev->nb_channels; i++) {
struct iio_channel **channels = dev->channels;
long ch1 = channels[i - 1]->index;
long ch2 = channels[i]->index;
if (ch1 == ch2 && ch1 >= 0) {
ch1 = channels[i - 1]->format.shift;
ch2 = channels[i]->format.shift;
}
if (ch2 >= 0 && ((ch1 > ch2) || ch1 < 0)) {
struct iio_channel *bak = channels[i];
channels[i] = channels[i - 1];
channels[i - 1] = bak;
found = true;
}
}
} while (found);
for (i = 0; i < dev->nb_channels; i++)
dev->channels[i]->number = i;
}
int iio_context_init(struct iio_context *ctx)
{
unsigned int i;
for (i = 0; i < ctx->nb_devices; i++)
reorder_channels(ctx->devices[i]);
if (!ctx->xml) {
ctx->xml = iio_context_create_xml(ctx);
if (IS_ERR(ctx->xml))
return PTR_ERR(ctx->xml);
}
return 0;
}
int iio_context_get_version(const struct iio_context *ctx,
unsigned int *major, unsigned int *minor, char git_tag[8])
{
if (ctx->git_tag) {
if (major)
*major = ctx->major;
if (minor)
*minor = ctx->minor;
if (git_tag)
iio_strlcpy(git_tag, ctx->git_tag, 8);
return 0;
}
if (ctx->ops->get_version)
return ctx->ops->get_version(ctx, major, minor, git_tag);
iio_library_get_version(major, minor, git_tag);
return 0;
}
int iio_context_set_timeout(struct iio_context *ctx, unsigned int timeout)
{
if (ctx->ops->set_timeout)
return ctx->ops->set_timeout(ctx, timeout);
else
return -ENOSYS;
}
struct iio_context * iio_context_clone(const struct iio_context *ctx)
{
if (ctx->ops->clone) {
return ctx->ops->clone(ctx);
} else {
errno = ENOSYS;
return NULL;
}
}
struct iio_context * iio_create_context_from_uri(const char *uri)
{
if (WITH_LOCAL_BACKEND && strcmp(uri, "local:") == 0) /* No address part */
return iio_create_local_context();
if (WITH_XML_BACKEND && strncmp(uri, "xml:", sizeof("xml:") - 1) == 0)
return iio_create_xml_context(uri + sizeof("xml:") - 1);
if (WITH_NETWORK_BACKEND && strncmp(uri, "ip:", sizeof("ip:") - 1) == 0)
return iio_create_network_context(uri+3);
if (WITH_USB_BACKEND && strncmp(uri, "usb:", sizeof("usb:") - 1) == 0)
return usb_create_context_from_uri(uri);
if (WITH_SERIAL_BACKEND && strncmp(uri, "serial:", sizeof("serial:") - 1) == 0)
return serial_create_context_from_uri(uri);
errno = ENOSYS;
return NULL;
}
struct iio_context * iio_create_default_context(void)
{
char *hostname = iio_getenv("IIOD_REMOTE");
struct iio_context * ctx;
if (hostname) {
ctx = iio_create_context_from_uri(hostname);
free(hostname);
return ctx;
}
return iio_create_local_context();
}
struct iio_context * iio_create_local_context(void)
{
if (WITH_LOCAL_BACKEND)
return local_create_context();
errno = ENOSYS;
return NULL;
}
struct iio_context * iio_create_network_context(const char *hostname)
{
if (WITH_NETWORK_BACKEND)
return network_create_context(hostname);
errno = ENOSYS;
return NULL;
}
struct iio_context * iio_create_xml_context_mem(const char *xml, size_t len)
{
if (WITH_XML_BACKEND)
return xml_create_context_mem(xml, len);
errno = ENOSYS;
return NULL;
}
struct iio_context * iio_create_xml_context(const char *xml_file)
{
if (WITH_XML_BACKEND)
return xml_create_context(xml_file);
errno = ENOSYS;
return NULL;
}
unsigned int iio_context_get_attrs_count(const struct iio_context *ctx)
{
return ctx->nb_attrs;
}
int iio_context_get_attr(const struct iio_context *ctx, unsigned int index,
const char **name, const char **value)
{
if (index >= ctx->nb_attrs)
return -EINVAL;
if (name)
*name = ctx->attrs[index];
if (value)
*value = ctx->values[index];
return 0;
}
const char * iio_context_get_attr_value(
const struct iio_context *ctx, const char *name)
{
unsigned int i;
for (i = 0; i < ctx->nb_attrs; i++) {
if (!strcmp(name, ctx->attrs[i]))
return ctx->values[i];
}
return NULL;
}
int iio_context_add_device(struct iio_context *ctx, struct iio_device *dev)
{
struct iio_device **devices = realloc(ctx->devices,
(ctx->nb_devices + 1) * sizeof(struct iio_device *));
if (!devices) {
IIO_ERROR("Unable to allocate memory\n");
return -ENOMEM;
}
devices[ctx->nb_devices++] = dev;
ctx->devices = devices;
IIO_DEBUG("Added device \'%s\' to context \'%s\'\n", dev->id, ctx->name);
return 0;
}
int iio_context_add_attr(struct iio_context *ctx,
const char *key, const char *value)
{
char **attrs, **values, *new_key, *new_val;
unsigned int i;
for (i = 0; i < ctx->nb_attrs; i++) {
if(!strcmp(ctx->attrs[i], key)) {
new_val = iio_strdup(value);
if (!new_val)
return -ENOMEM;
free(ctx->values[i]);
ctx->values[i] = new_val;
return 0;
}
}
attrs = realloc(ctx->attrs,
(ctx->nb_attrs + 1) * sizeof(*ctx->attrs));
if (!attrs)
return -ENOMEM;
ctx->attrs = attrs;
values = realloc(ctx->values,
(ctx->nb_attrs + 1) * sizeof(*ctx->values));
if (!values)
return -ENOMEM;
ctx->values = values;
new_key = iio_strdup(key);
if (!new_key)
return -ENOMEM;
new_val = iio_strdup(value);
if (!new_val) {
free(new_key);
return -ENOMEM;
}
ctx->attrs[ctx->nb_attrs] = new_key;
ctx->values[ctx->nb_attrs] = new_val;
ctx->nb_attrs++;
return 0;
}
|