src/hardware/hung-chang-dso-2100/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Daniel Glöckner <daniel-gl@gmx.net>
   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 <ieee1284.h>
  22 #include <string.h>
  23 #include "protocol.h"
  24
  25 static const uint32_t scanopts[] = {
  26         SR_CONF_CONN,
  27 };
  28
  29 static const uint32_t drvopts[] = {
  30         SR_CONF_OSCILLOSCOPE,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_CONN | SR_CONF_GET,
  35         SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  37         SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  38         SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  39         SR_CONF_BUFFERSIZE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  40 };
  41
  42 static const uint32_t devopts_cg[] = {
  43         SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  44         SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  45         SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET,
  46 };
  47
  48 static const uint64_t samplerates[] = {
  49         SR_MHZ(100), SR_MHZ(50),  SR_MHZ(25),   SR_MHZ(20),
  50         SR_MHZ(10),  SR_MHZ(5),   SR_KHZ(2500), SR_MHZ(2),
  51         SR_MHZ(1),   SR_KHZ(500), SR_KHZ(250),  SR_KHZ(200),
  52         SR_KHZ(100), SR_KHZ(50),  SR_KHZ(25),   SR_KHZ(20),
  53         SR_KHZ(10),  SR_KHZ(5),   SR_HZ(2500),  SR_KHZ(2),
  54         SR_KHZ(1),   SR_HZ(500),  SR_HZ(250),   SR_HZ(200),
  55         SR_HZ(100),  SR_HZ(50),   SR_HZ(25),    SR_HZ(20)
  56 };
  57
  58 /* must be in sync with readout_steps[] in protocol.c */
  59 static const uint64_t buffersizes[] = {
  60         2 * 500, 3 * 500, 4 * 500, 5 * 500,
  61         6 * 500, 7 * 500, 8 * 500, 9 * 500, 10 * 500,
  62         12 * 500 - 2, 14 * 500 - 2, 16 * 500 - 2,
  63         18 * 500 - 2, 20 * 500 - 2, 10240 - 2
  64 };
  65
  66 static const uint64_t vdivs[][2] = {
  67         { 10, 1000 },
  68         { 20, 1000 },
  69         { 50, 1000 },
  70         { 100, 1000 },
  71         { 200, 1000 },
  72         { 500, 1000 },
  73         { 1, 1 },
  74         { 2, 1 },
  75         { 5, 1 },
  76 };
  77
  78 /* Bits 4 and 5 enable relays that add /10 filters to the chain
  79  * Bits 0 and 1 select an output from a resistor array */
  80 static const uint8_t vdivs_map[] = {
  81         0x01, 0x02, 0x03, 0x21, 0x22, 0x23, 0x31, 0x32, 0x33
  82 };
  83
  84
  85 static const char *trigger_sources[] = {
  86         "A", "B", "EXT"
  87 };
  88
  89 static const uint8_t trigger_sources_map[] = {
  90         0x00, 0x80, 0x40
  91 };
  92
  93 static const char *trigger_slopes[] = {
  94         "f", "r"
  95 };
  96
  97 static const char *coupling[] = {
  98         "DC", "AC", "GND"
  99 };
 100
 101 static const uint8_t coupling_map[] = {
 102         0x00, 0x08, 0x04
 103 };
 104
 105 static GSList *scan_port(GSList *devices, struct parport *port)
 106 {
 107         struct sr_dev_inst *sdi;
 108         struct sr_channel *ch;
 109         struct sr_channel_group *cg;
 110         struct dev_context *devc;
 111         int i;
 112
 113         if (ieee1284_open(port, 0, &i) != E1284_OK) {
 114                 sr_err("Can't open parallel port %s", port->name);
 115                 goto fail1;
 116         }
 117
 118         if ((i & (CAP1284_RAW | CAP1284_BYTE)) != (CAP1284_RAW | CAP1284_BYTE)) {
 119                 sr_err("Parallel port %s does not provide low-level bidirection access",
 120                        port->name);
 121                 goto fail2;
 122         }
 123
 124         if (ieee1284_claim(port) != E1284_OK) {
 125                 sr_err("Parallel port %s already in use", port->name);
 126                 goto fail2;
 127         }
 128
 129         if (!hung_chang_dso_2100_check_id(port))
 130                 goto fail3;
 131
 132         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 133         sdi->status = SR_ST_INACTIVE;
 134         sdi->vendor = g_strdup("Hung-Chang");
 135         sdi->model = g_strdup("DSO-2100");
 136         sdi->inst_type = 0; /* FIXME */
 137         sdi->conn = port;
 138         ieee1284_ref(port);
 139
 140         for (i = 0; i < NUM_CHANNELS; i++) {
 141                 cg = g_malloc0(sizeof(struct sr_channel_group));
 142                 cg->name = g_strdup(trigger_sources[i]);
 143                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, FALSE, trigger_sources[i]);
 144                 cg->channels = g_slist_append(cg->channels, ch);
 145                 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 146         }
 147
 148         devc = g_malloc0(sizeof(struct dev_context));
 149         devc->enabled_channel = g_slist_append(NULL, NULL);
 150         devc->channel = 0;
 151         devc->rate = 0;
 152         devc->probe[0] = 10;
 153         devc->probe[1] = 10;
 154         devc->cctl[0] = 0x31; /* 1V/div, DC coupling, trigger on channel A*/
 155         devc->cctl[1] = 0x31; /* 1V/div, DC coupling, no tv sync trigger */
 156         devc->edge = 0;
 157         devc->tlevel = 0x80;
 158         devc->pos[0] = 0x80;
 159         devc->pos[1] = 0x80;
 160         devc->offset[0] = 0x80;
 161         devc->offset[1] = 0x80;
 162         devc->gain[0] = 0x80;
 163         devc->gain[1] = 0x80;
 164         devc->frame_limit = 0;
 165         devc->last_step = 0; /* buffersize = 1000 */
 166         sdi->priv = devc;
 167
 168         devices = g_slist_append(devices, sdi);
 169
 170 fail3:
 171         ieee1284_release(port);
 172 fail2:
 173         ieee1284_close(port);
 174 fail1:
 175         return devices;
 176 }
 177
 178 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 179 {
 180         struct parport_list ports;
 181         struct sr_config *src;
 182         const char *conn = NULL;
 183         GSList *devices, *option;
 184         gboolean port_found;
 185         int i;
 186
 187
 188         for (option = options; option; option = option->next) {
 189                 src = option->data;
 190                 if (src->key == SR_CONF_CONN) {
 191                         conn = g_variant_get_string(src->data, NULL);
 192                         break;
 193                 }
 194         }
 195
 196         if (!conn)
 197                 return NULL;
 198
 199         if (ieee1284_find_ports(&ports, 0) != E1284_OK)
 200                 return NULL;
 201
 202         devices = NULL;
 203         port_found = FALSE;
 204         for (i = 0; i < ports.portc; i++)
 205                 if (!strcmp(ports.portv[i]->name, conn)) {
 206                         port_found = TRUE;
 207                         devices = scan_port(devices, ports.portv[i]);
 208                 }
 209
 210         if (!port_found) {
 211                 sr_err("Parallel port %s not found. Valid names are:", conn);
 212                 for (i = 0; i < ports.portc; i++)
 213                         sr_err("\t%s", ports.portv[i]->name);
 214         }
 215
 216         ieee1284_free_ports(&ports);
 217
 218         return std_scan_complete(di, devices);
 219 }
 220
 221 static void clear_helper(struct dev_context *devc)
 222 {
 223         g_slist_free(devc->enabled_channel);
 224 }
 225
 226 static int dev_clear(const struct sr_dev_driver *di)
 227 {
 228         struct drv_context *drvc = di->context;
 229         struct sr_dev_inst *sdi;
 230         GSList *l;
 231
 232         if (drvc) {
 233                 for (l = drvc->instances; l; l = l->next) {
 234                         sdi = l->data;
 235                         ieee1284_unref(sdi->conn);
 236                 }
 237         }
 238
 239         return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 240 }
 241
 242 static int dev_open(struct sr_dev_inst *sdi)
 243 {
 244         struct dev_context *devc = sdi->priv;
 245         int i;
 246
 247         if (ieee1284_open(sdi->conn, 0, &i) != E1284_OK)
 248                 goto fail1;
 249
 250         if (ieee1284_claim(sdi->conn) != E1284_OK)
 251                 goto fail2;
 252
 253         if (ieee1284_data_dir(sdi->conn, 1) != E1284_OK)
 254                 goto fail3;
 255
 256         if (hung_chang_dso_2100_move_to(sdi, 1))
 257                 goto fail3;
 258
 259         devc->samples = g_try_malloc(1000 * sizeof(*devc->samples));
 260         if (!devc->samples)
 261                 goto fail3;
 262
 263         return SR_OK;
 264
 265 fail3:
 266         hung_chang_dso_2100_reset_port(sdi->conn);
 267         ieee1284_release(sdi->conn);
 268 fail2:
 269         ieee1284_close(sdi->conn);
 270 fail1:
 271         return SR_ERR;
 272 }
 273
 274 static int dev_close(struct sr_dev_inst *sdi)
 275 {
 276         struct dev_context *devc = sdi->priv;
 277
 278         g_free(devc->samples);
 279         hung_chang_dso_2100_reset_port(sdi->conn);
 280         ieee1284_release(sdi->conn);
 281         ieee1284_close(sdi->conn);
 282
 283         return SR_OK;
 284 }
 285
 286 static int config_get(uint32_t key, GVariant **data,
 287         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 288 {
 289         struct dev_context *devc = sdi->priv;
 290         struct parport *port;
 291         int idx, ch = -1;
 292
 293         if (cg) /* sr_config_get will validate cg using config_list */
 294                 ch = ((struct sr_channel *)cg->channels->data)->index;
 295
 296         switch (key) {
 297         case SR_CONF_CONN:
 298                 port = sdi->conn;
 299                 *data = g_variant_new_string(port->name);
 300                 break;
 301         case SR_CONF_LIMIT_FRAMES:
 302                 *data = g_variant_new_uint64(devc->frame_limit);
 303                 break;
 304         case SR_CONF_SAMPLERATE:
 305                 *data = g_variant_new_uint64(samplerates[devc->rate]);
 306                 break;
 307         case SR_CONF_TRIGGER_SOURCE:
 308                 if ((idx = std_u8_idx_s(devc->cctl[0] & 0xC0, ARRAY_AND_SIZE(trigger_sources_map))) < 0)
 309                         return SR_ERR_BUG;
 310                 *data = g_variant_new_string(trigger_sources[idx]);
 311                 break;
 312         case SR_CONF_TRIGGER_SLOPE:
 313                 if (devc->edge >= ARRAY_SIZE(trigger_slopes))
 314                         return SR_ERR;
 315                 else
 316                         *data = g_variant_new_string(trigger_slopes[devc->edge]);
 317                 break;
 318         case SR_CONF_BUFFERSIZE:
 319                 *data = g_variant_new_uint64(buffersizes[devc->last_step]);
 320                 break;
 321         case SR_CONF_VDIV:
 322                 if (ch == -1) {
 323                         return SR_ERR_CHANNEL_GROUP;
 324                 } else {
 325                         if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x33, ARRAY_AND_SIZE(vdivs_map))) < 0)
 326                                 return SR_ERR_BUG;
 327                         *data = g_variant_new("(tt)", vdivs[idx][0], vdivs[idx][1]);
 328                 }
 329                 break;
 330         case SR_CONF_COUPLING:
 331                 if (ch == -1) {
 332                         return SR_ERR_CHANNEL_GROUP;
 333                 } else {
 334                         if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x0C, ARRAY_AND_SIZE(coupling_map))) < 0)
 335                                 return SR_ERR_BUG;
 336                         *data = g_variant_new_string(coupling[idx]);
 337                 }
 338                 break;
 339         case SR_CONF_PROBE_FACTOR:
 340                 if (ch == -1)
 341                         return SR_ERR_CHANNEL_GROUP;
 342                 else
 343                         *data = g_variant_new_uint64(devc->probe[ch]);
 344                 break;
 345         default:
 346                 return SR_ERR_NA;
 347         }
 348
 349         return SR_OK;
 350 }
 351
 352 static int config_set(uint32_t key, GVariant *data,
 353         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 354 {
 355         struct dev_context *devc = sdi->priv;
 356         int idx, ch = -1;
 357         uint64_t u;
 358
 359         if (cg) /* sr_config_set will validate cg using config_list */
 360                 ch = ((struct sr_channel *)cg->channels->data)->index;
 361
 362         switch (key) {
 363         case SR_CONF_LIMIT_FRAMES:
 364                 devc->frame_limit = g_variant_get_uint64(data);
 365                 break;
 366         case SR_CONF_SAMPLERATE:
 367                 if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(samplerates))) < 0)
 368                         return SR_ERR_ARG;
 369                 devc->rate = idx;
 370                 break;
 371         case SR_CONF_TRIGGER_SOURCE:
 372                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_sources))) < 0)
 373                         return SR_ERR_ARG;
 374                 devc->cctl[0] = (devc->cctl[0] & 0x3F) | trigger_sources_map[idx];
 375                 break;
 376         case SR_CONF_TRIGGER_SLOPE:
 377                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_slopes))) < 0)
 378                         return SR_ERR_ARG;
 379                 devc->edge = idx;
 380                 break;
 381         case SR_CONF_BUFFERSIZE:
 382                 if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(buffersizes))) < 0)
 383                         return SR_ERR_ARG;
 384                 devc->last_step = idx;
 385                 break;
 386         case SR_CONF_VDIV:
 387                 if (ch == -1) {
 388                         return SR_ERR_CHANNEL_GROUP;
 389                 } else if (!g_variant_is_of_type(data, G_VARIANT_TYPE("(tt)"))) {
 390                         return SR_ERR_ARG;
 391                 } else {
 392                         if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
 393                                 return SR_ERR_ARG;
 394                         devc->cctl[ch] = (devc->cctl[ch] & 0xCC) | vdivs_map[idx];
 395                 }
 396                 break;
 397         case SR_CONF_COUPLING:
 398                 if (ch == -1) {
 399                         return SR_ERR_CHANNEL_GROUP;
 400                 } else {
 401                         if ((idx = std_str_idx(data, ARRAY_AND_SIZE(coupling))) < 0)
 402                                 return SR_ERR_ARG;
 403                         devc->cctl[ch] = (devc->cctl[ch] & 0xF3) | coupling_map[idx];
 404                 }
 405                 break;
 406         case SR_CONF_PROBE_FACTOR:
 407                 if (ch == -1) {
 408                         return SR_ERR_CHANNEL_GROUP;
 409                 } else {
 410                         u = g_variant_get_uint64(data);
 411                         if (!u)
 412                                 return SR_ERR_ARG;
 413                         else
 414                                 devc->probe[ch] = u;
 415                 }
 416                 break;
 417         default:
 418                 return SR_ERR_NA;
 419         }
 420
 421         return SR_OK;
 422 }
 423
 424 static int config_channel_set(const struct sr_dev_inst *sdi,
 425         struct sr_channel *ch, unsigned int changes)
 426 {
 427         struct dev_context *devc = sdi->priv;
 428         uint8_t v;
 429
 430         if (changes & SR_CHANNEL_SET_ENABLED) {
 431                 if (ch->enabled) {
 432                         v = devc->channel | (1 << ch->index);
 433                         if (v & (v - 1))
 434                                 return SR_ERR;
 435                         devc->channel = v;
 436                         devc->enabled_channel->data = ch;
 437                 } else {
 438                         devc->channel &= ~(1 << ch->index);
 439                 }
 440         }
 441         return SR_OK;
 442 }
 443
 444 static int config_commit(const struct sr_dev_inst *sdi)
 445 {
 446         uint8_t state = hung_chang_dso_2100_read_mbox(sdi->conn, 0.02);
 447         int ret;
 448
 449         switch (state) {
 450         case 0x03:
 451         case 0x14:
 452         case 0x21:
 453                 /* we will travel the complete config path on our way to state 1 */
 454                 break;
 455         case 0x00:
 456                 state = 0x01;
 457                 /* Fallthrough */
 458         default:
 459                 ret = hung_chang_dso_2100_move_to(sdi, 1);
 460                 if (ret != SR_OK)
 461                         return ret;
 462                 /* Fallthrough */
 463         case 0x01:
 464                 hung_chang_dso_2100_write_mbox(sdi->conn, 4);
 465         }
 466         ret = hung_chang_dso_2100_move_to(sdi, 1);
 467         if (ret != SR_OK)
 468                 return ret;
 469         return hung_chang_dso_2100_move_to(sdi, state);
 470 }
 471
 472 static int config_list(uint32_t key, GVariant **data,
 473         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 474 {
 475         GSList *l;
 476
 477         switch (key) {
 478         case SR_CONF_SCAN_OPTIONS:
 479         case SR_CONF_DEVICE_OPTIONS:
 480                 break;
 481         case SR_CONF_SAMPLERATE:
 482         case SR_CONF_TRIGGER_SOURCE:
 483         case SR_CONF_TRIGGER_SLOPE:
 484         case SR_CONF_BUFFERSIZE:
 485                 if (!sdi || cg)
 486                         return SR_ERR_NA;
 487                 break;
 488         case SR_CONF_VDIV:
 489         case SR_CONF_COUPLING:
 490                 if (!sdi)
 491                         return SR_ERR_NA;
 492                 if (!cg)
 493                         return SR_ERR_CHANNEL_GROUP;
 494                 l = g_slist_find(sdi->channel_groups, cg);
 495                 if (!l)
 496                         return SR_ERR_ARG;
 497                 break;
 498         default:
 499                 return SR_ERR_NA;
 500         }
 501
 502         switch (key) {
 503         case SR_CONF_SCAN_OPTIONS:
 504                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
 505         case SR_CONF_DEVICE_OPTIONS:
 506                 if (!cg)
 507                         return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
 508                 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
 509                 break;
 510         case SR_CONF_SAMPLERATE:
 511                 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
 512                 break;
 513         case SR_CONF_TRIGGER_SOURCE:
 514                 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_sources));
 515                 break;
 516         case SR_CONF_TRIGGER_SLOPE:
 517                 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
 518                 break;
 519         case SR_CONF_BUFFERSIZE:
 520                 *data = std_gvar_array_u64(ARRAY_AND_SIZE(buffersizes));
 521                 break;
 522         case SR_CONF_VDIV:
 523                 *data = std_gvar_tuple_array(ARRAY_AND_SIZE(vdivs));
 524                 break;
 525         case SR_CONF_COUPLING:
 526                 *data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
 527                 break;
 528         }
 529
 530         return SR_OK;
 531 }
 532
 533 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 534 {
 535         struct dev_context *devc = sdi->priv;
 536         int ret;
 537
 538         if (devc->channel) {
 539                 static const float res_array[] = {0.5, 1, 2, 5};
 540                 static const uint8_t relays[] = {100, 10, 10, 1};
 541                 devc->factor = devc->probe[devc->channel - 1] / 32.0;
 542                 devc->factor *= res_array[devc->cctl[devc->channel - 1] & 0x03];
 543                 devc->factor /= relays[(devc->cctl[devc->channel - 1] >> 4) & 0x03];
 544         }
 545         devc->frame = 0;
 546         devc->state_known = TRUE;
 547         devc->step = 0;
 548         devc->adc2 = FALSE;
 549         devc->retries = MAX_RETRIES;
 550
 551         ret = hung_chang_dso_2100_move_to(sdi, 0x21);
 552         if (ret != SR_OK)
 553                 return ret;
 554
 555         std_session_send_df_header(sdi);
 556
 557         sr_session_source_add(sdi->session, -1, 0, 8,
 558                               hung_chang_dso_2100_poll, (void *)sdi);
 559
 560         return SR_OK;
 561 }
 562
 563 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 564 {
 565         std_session_send_df_end(sdi);
 566         sr_session_source_remove(sdi->session, -1);
 567         hung_chang_dso_2100_move_to(sdi, 1);
 568
 569         return SR_OK;
 570 }
 571
 572 static struct sr_dev_driver hung_chang_dso_2100_driver_info = {
 573         .name = "hung-chang-dso-2100",
 574         .longname = "Hung-Chang DSO-2100",
 575         .api_version = 1,
 576         .init = std_init,
 577         .cleanup = std_cleanup,
 578         .scan = scan,
 579         .dev_list = std_dev_list,
 580         .dev_clear = dev_clear,
 581         .config_get = config_get,
 582         .config_set = config_set,
 583         .config_channel_set = config_channel_set,
 584         .config_commit = config_commit,
 585         .config_list = config_list,
 586         .dev_open = dev_open,
 587         .dev_close = dev_close,
 588         .dev_acquisition_start = dev_acquisition_start,
 589         .dev_acquisition_stop = dev_acquisition_stop,
 590         .context = NULL,
 591 };
 592 SR_REGISTER_DEV_DRIVER(hung_chang_dso_2100_driver_info);