src/hardware/link-mso19/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
   5  * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
   6  * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <config.h>
  23 #include "protocol.h"
  24
  25 /* serial protocol */
  26 #define mso_trans(a, v) \
  27         (((v) & 0x3f) | (((v) & 0xc0) << 6) | (((a) & 0xf) << 8) | \
  28         ((~(v) & 0x20) << 1) | ((~(v) & 0x80) << 7))
  29
  30 static const char mso_head[] = { 0x40, 0x4c, 0x44, 0x53, 0x7e };
  31 static const char mso_foot[] = { 0x7e };
  32
  33 SR_PRIV int mso_send_control_message(struct sr_serial_dev_inst *serial,
  34                                      uint16_t payload[], int n)
  35 {
  36         int i, w, ret, s = n * 2 + sizeof(mso_head) + sizeof(mso_foot);
  37         char *p, *buf;
  38
  39         ret = SR_ERR;
  40
  41         if (serial->fd < 0)
  42                 goto ret;
  43
  44         buf = g_malloc(s);
  45
  46         p = buf;
  47         memcpy(p, mso_head, sizeof(mso_head));
  48         p += sizeof(mso_head);
  49
  50         for (i = 0; i < n; i++) {
  51                 WB16(p, payload[i]);
  52                 p += sizeof(uint16_t);
  53         }
  54         memcpy(p, mso_foot, sizeof(mso_foot));
  55
  56         w = 0;
  57         while (w < s) {
  58                 ret = serial_write(serial, buf + w, s - w);
  59                 if (ret < 0) {
  60                         ret = SR_ERR;
  61                         goto free;
  62                 }
  63                 w += ret;
  64         }
  65         ret = SR_OK;
  66 free:
  67         g_free(buf);
  68 ret:
  69         return ret;
  70 }
  71
  72 SR_PRIV int mso_configure_trigger(const struct sr_dev_inst *sdi)
  73 {
  74         struct dev_context *devc = sdi->priv;
  75         uint16_t threshold_value = mso_calc_raw_from_mv(devc);
  76
  77         threshold_value = 0x153C;
  78         uint8_t trigger_config = 0;
  79
  80         if (devc->trigger_slope)
  81                 trigger_config |= 0x04; //Trigger on falling edge
  82
  83         switch (devc->trigger_outsrc) {
  84         case 1:
  85                 trigger_config |= 0x00; //Trigger pulse output
  86                 break;
  87         case 2:
  88                 trigger_config |= 0x08; //PWM DAC from the pattern generator buffer
  89                 break;
  90         case 3:
  91                 trigger_config |= 0x18; //White noise
  92                 break;
  93         }
  94
  95         switch (devc->trigger_chan) {
  96         case 0:
  97                 trigger_config |= 0x00; //DSO level trigger //b00000000
  98                 break;
  99         case 1:
 100                 trigger_config |= 0x20; //DSO level trigger & width < trigger_width
 101                 break;
 102         case 2:
 103                 trigger_config |= 0x40; //DSO level trigger & width >= trigger_width
 104                 break;
 105         case 3:
 106                 trigger_config |= 0x60; //LA combination trigger
 107                 break;
 108         }
 109
 110         //Last bit of trigger config reg 4 needs to be 1 for trigger enable,
 111         //otherwise the trigger is not enabled
 112         if (devc->use_trigger)
 113                 trigger_config |= 0x80;
 114
 115         uint16_t ops[18];
 116         ops[0] = mso_trans(3, threshold_value & 0xff);
 117         //The trigger_config also holds the 2 MSB bits from the threshold value
 118         ops[1] = mso_trans(4, trigger_config | ((threshold_value >> 8) & 0x03));
 119         ops[2] = mso_trans(5, devc->la_trigger);
 120         ops[3] = mso_trans(6, devc->la_trigger_mask);
 121         ops[4] = mso_trans(7, devc->trigger_holdoff[0]);
 122         ops[5] = mso_trans(8, devc->trigger_holdoff[1]);
 123
 124         ops[6] = mso_trans(11,
 125                            devc->dso_trigger_width /
 126                            SR_HZ_TO_NS(devc->cur_rate));
 127
 128         /* Select the SPI/I2C trigger config bank */
 129         ops[7] = mso_trans(REG_CTL2, (devc->ctlbase2 | BITS_CTL2_BANK(2)));
 130         /* Configure the SPI/I2C protocol trigger */
 131         ops[8] = mso_trans(REG_PT_WORD(0), devc->protocol_trigger.word[0]);
 132         ops[9] = mso_trans(REG_PT_WORD(1), devc->protocol_trigger.word[1]);
 133         ops[10] = mso_trans(REG_PT_WORD(2), devc->protocol_trigger.word[2]);
 134         ops[11] = mso_trans(REG_PT_WORD(3), devc->protocol_trigger.word[3]);
 135         ops[12] = mso_trans(REG_PT_MASK(0), devc->protocol_trigger.mask[0]);
 136         ops[13] = mso_trans(REG_PT_MASK(1), devc->protocol_trigger.mask[1]);
 137         ops[14] = mso_trans(REG_PT_MASK(2), devc->protocol_trigger.mask[2]);
 138         ops[15] = mso_trans(REG_PT_MASK(3), devc->protocol_trigger.mask[3]);
 139         ops[16] = mso_trans(REG_PT_SPIMODE, devc->protocol_trigger.spimode);
 140         /* Select the default config bank */
 141         ops[17] = mso_trans(REG_CTL2, devc->ctlbase2);
 142
 143         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 144 }
 145
 146 SR_PRIV int mso_configure_threshold_level(const struct sr_dev_inst *sdi)
 147 {
 148         struct dev_context *devc = sdi->priv;
 149
 150         return mso_dac_out(sdi, la_threshold_map[devc->la_threshold]);
 151 }
 152
 153 SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi)
 154 {
 155         uint16_t ops[] = { mso_trans(REG_BUFFER, 0) };
 156         struct dev_context *devc = sdi->priv;
 157
 158         sr_dbg("Requesting buffer dump.");
 159         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 160 }
 161
 162 SR_PRIV int mso_arm(const struct sr_dev_inst *sdi)
 163 {
 164         struct dev_context *devc = sdi->priv;
 165         uint16_t ops[] = {
 166                 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_RESETFSM),
 167                 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_ARM),
 168                 mso_trans(REG_CTL1, devc->ctlbase1),
 169         };
 170
 171         sr_dbg("Requesting trigger arm.");
 172         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 173 }
 174
 175 SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi)
 176 {
 177         struct dev_context *devc = sdi->priv;
 178         uint16_t ops[] = {
 179                 mso_trans(REG_CTL1, devc->ctlbase1 | 8),
 180                 mso_trans(REG_CTL1, devc->ctlbase1),
 181         };
 182
 183         sr_dbg("Requesting forced capture.");
 184         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 185 }
 186
 187 SR_PRIV int mso_dac_out(const struct sr_dev_inst *sdi, uint16_t val)
 188 {
 189         struct dev_context *devc = sdi->priv;
 190         uint16_t ops[] = {
 191                 mso_trans(REG_DAC1, (val >> 8) & 0xff),
 192                 mso_trans(REG_DAC2, val & 0xff),
 193                 mso_trans(REG_CTL1, devc->ctlbase1 | BIT_CTL1_RESETADC),
 194         };
 195
 196         sr_dbg("Setting dac word to 0x%x.", val);
 197         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 198 }
 199
 200 SR_PRIV uint16_t mso_calc_raw_from_mv(struct dev_context *devc)
 201 {
 202         return (uint16_t) (0x200 -
 203                            ((devc->dso_trigger_voltage / devc->dso_probe_attn) /
 204                             devc->vbit));
 205 }
 206
 207 SR_PRIV int mso_parse_serial(const char *iSerial, const char *iProduct,
 208                              struct dev_context *devc)
 209 {
 210         unsigned int u1, u2, u3, u4, u5, u6;
 211
 212         (void)iProduct;
 213
 214         /* FIXME: This code is in the original app, but I think its
 215          * used only for the GUI */
 216         /*    if (strstr(iProduct, "REV_02") || strstr(iProduct, "REV_03"))
 217            devc->num_sample_rates = 0x16;
 218            else
 219            devc->num_sample_rates = 0x10; */
 220
 221         /* parse iSerial */
 222         if (iSerial[0] != '4' || sscanf(iSerial, "%5u%3u%3u%1u%1u%6u",
 223                                         &u1, &u2, &u3, &u4, &u5, &u6) != 6)
 224                 return SR_ERR;
 225         devc->hwmodel = u4;
 226         devc->hwrev = u5;
 227         devc->vbit = u1 / 10000;
 228         if (devc->vbit == 0)
 229                 devc->vbit = 4.19195;
 230         devc->dac_offset = u2;
 231         if (devc->dac_offset == 0)
 232                 devc->dac_offset = 0x1ff;
 233         devc->offset_range = u3;
 234         if (devc->offset_range == 0)
 235                 devc->offset_range = 0x17d;
 236
 237         /*
 238          * FIXME: There is more code on the original software to handle
 239          * bigger iSerial strings, but as I can't test on my device
 240          * I will not implement it yet
 241          */
 242
 243         return SR_OK;
 244 }
 245
 246 SR_PRIV int mso_reset_adc(struct sr_dev_inst *sdi)
 247 {
 248         struct dev_context *devc = sdi->priv;
 249         uint16_t ops[2];
 250
 251         ops[0] = mso_trans(REG_CTL1, (devc->ctlbase1 | BIT_CTL1_RESETADC));
 252         ops[1] = mso_trans(REG_CTL1, devc->ctlbase1);
 253         devc->ctlbase1 |= BIT_CTL1_ADC_UNKNOWN4;
 254
 255         sr_dbg("Requesting ADC reset.");
 256         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 257 }
 258
 259 SR_PRIV int mso_reset_fsm(struct sr_dev_inst *sdi)
 260 {
 261         struct dev_context *devc = sdi->priv;
 262         uint16_t ops[1];
 263
 264         devc->ctlbase1 |= BIT_CTL1_RESETFSM;
 265         ops[0] = mso_trans(REG_CTL1, devc->ctlbase1);
 266
 267         sr_dbg("Requesting ADC reset.");
 268         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 269 }
 270
 271 SR_PRIV int mso_toggle_led(struct sr_dev_inst *sdi, int state)
 272 {
 273         struct dev_context *devc = sdi->priv;
 274         uint16_t ops[1];
 275
 276         devc->ctlbase1 &= ~BIT_CTL1_LED;
 277         if (state)
 278                 devc->ctlbase1 |= BIT_CTL1_LED;
 279         ops[0] = mso_trans(REG_CTL1, devc->ctlbase1);
 280
 281         sr_dbg("Requesting LED toggle.");
 282         return mso_send_control_message(devc->serial, ARRAY_AND_SIZE(ops));
 283 }
 284
 285 SR_PRIV void stop_acquisition(const struct sr_dev_inst *sdi)
 286 {
 287         struct dev_context *devc;
 288
 289         devc = sdi->priv;
 290         serial_source_remove(sdi->session, devc->serial);
 291
 292         std_session_send_df_end(sdi);
 293 }
 294
 295 SR_PRIV int mso_clkrate_out(struct sr_serial_dev_inst *serial, uint16_t val)
 296 {
 297         uint16_t ops[] = {
 298                 mso_trans(REG_CLKRATE1, (val >> 8) & 0xff),
 299                 mso_trans(REG_CLKRATE2, val & 0xff),
 300         };
 301
 302         sr_dbg("Setting clkrate word to 0x%x.", val);
 303         return mso_send_control_message(serial, ARRAY_AND_SIZE(ops));
 304 }
 305
 306 SR_PRIV int mso_configure_rate(const struct sr_dev_inst *sdi, uint32_t rate)
 307 {
 308         struct dev_context *devc = sdi->priv;
 309         unsigned int i;
 310         int ret = SR_ERR;
 311
 312         for (i = 0; i < ARRAY_SIZE(rate_map); i++) {
 313                 if (rate_map[i].rate == rate) {
 314                         devc->ctlbase2 = rate_map[i].slowmode;
 315                         ret = mso_clkrate_out(devc->serial, rate_map[i].val);
 316                         if (ret == SR_OK)
 317                                 devc->cur_rate = rate;
 318                         return ret;
 319                 }
 320         }
 321
 322         if (ret != SR_OK)
 323                 sr_err("Unsupported rate.");
 324
 325         return ret;
 326 }
 327
 328 SR_PRIV int mso_check_trigger(struct sr_serial_dev_inst *serial, uint8_t *info)
 329 {
 330         uint16_t ops[] = { mso_trans(REG_TRIGGER, 0) };
 331         int ret;
 332
 333         sr_dbg("Requesting trigger state.");
 334         ret = mso_send_control_message(serial, ARRAY_AND_SIZE(ops));
 335         if (!info || ret != SR_OK)
 336                 return ret;
 337
 338         uint8_t buf = 0;
 339         if (serial_read(serial, &buf, 1) != 1)  /* FIXME: Need timeout */
 340                 ret = SR_ERR;
 341         if (!info)
 342                 *info = buf;
 343
 344         sr_dbg("Trigger state is: 0x%x.", *info);
 345         return ret;
 346 }
 347
 348 SR_PRIV int mso_receive_data(int fd, int revents, void *cb_data)
 349 {
 350         struct sr_datafeed_packet packet;
 351         struct sr_datafeed_logic logic;
 352         struct sr_dev_inst *sdi = cb_data;
 353         struct dev_context *devc = sdi->priv;
 354         int i;
 355
 356         (void)revents;
 357
 358         uint8_t in[1024];
 359         size_t s = serial_read(devc->serial, in, sizeof(in));
 360
 361         if (s <= 0)
 362                 return FALSE;
 363
 364         /* Check if we triggered, then send a command that we are ready
 365          * to read the data */
 366         if (devc->trigger_state != MSO_TRIGGER_DATAREADY) {
 367                 devc->trigger_state = in[0];
 368                 if (devc->trigger_state == MSO_TRIGGER_DATAREADY) {
 369                         mso_read_buffer(sdi);
 370                         devc->buffer_n = 0;
 371                 } else {
 372                         mso_check_trigger(devc->serial, NULL);
 373                 }
 374                 return TRUE;
 375         }
 376
 377         /* the hardware always dumps 1024 samples, 24bits each */
 378         if (devc->buffer_n < 3072) {
 379                 memcpy(devc->buffer + devc->buffer_n, in, s);
 380                 devc->buffer_n += s;
 381         }
 382         if (devc->buffer_n < 3072)
 383                 return TRUE;
 384
 385         /* do the conversion */
 386         uint8_t logic_out[1024];
 387         double analog_out[1024];
 388         for (i = 0; i < 1024; i++) {
 389                 /* FIXME: Need to do conversion to mV */
 390                 analog_out[i] = (devc->buffer[i * 3] & 0x3f) |
 391                     ((devc->buffer[i * 3 + 1] & 0xf) << 6);
 392                 (void)analog_out;
 393                 logic_out[i] = ((devc->buffer[i * 3 + 1] & 0x30) >> 4) |
 394                     ((devc->buffer[i * 3 + 2] & 0x3f) << 2);
 395         }
 396
 397         packet.type = SR_DF_LOGIC;
 398         packet.payload = &logic;
 399         logic.length = 1024;
 400         logic.unitsize = 1;
 401         logic.data = logic_out;
 402         sr_session_send(sdi, &packet);
 403
 404         devc->num_samples += 1024;
 405
 406         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 407                 sr_info("Requested number of samples reached.");
 408                 sr_dev_acquisition_stop(sdi);
 409         }
 410
 411         return TRUE;
 412 }
 413
 414 SR_PRIV int mso_configure_channels(const struct sr_dev_inst *sdi)
 415 {
 416         struct dev_context *devc;
 417         struct sr_channel *ch;
 418         GSList *l;
 419         char *tc;
 420
 421         devc = sdi->priv;
 422
 423         devc->la_trigger_mask = 0xFF;   //the mask for the LA_TRIGGER (bits set to 0 matter, those set to 1 are ignored).
 424         devc->la_trigger = 0x00;        //The value of the LA byte that generates a trigger event (in that mode).
 425         devc->dso_trigger_voltage = 3;
 426         devc->dso_probe_attn = 1;
 427         devc->trigger_outsrc = 0;
 428         devc->trigger_chan = 3; //LA combination trigger
 429         devc->use_trigger = FALSE;
 430
 431         for (l = sdi->channels; l; l = l->next) {
 432                 ch = (struct sr_channel *)l->data;
 433                 if (ch->enabled == FALSE)
 434                         continue;
 435
 436                 int channel_bit = 1 << (ch->index);
 437                 if (!(ch->trigger))
 438                         continue;
 439
 440                 devc->use_trigger = TRUE;
 441                 //Configure trigger mask and value.
 442                 for (tc = ch->trigger; *tc; tc++) {
 443                         devc->la_trigger_mask &= ~channel_bit;
 444                         if (*tc == '1')
 445                                 devc->la_trigger |= channel_bit;
 446                 }
 447         }
 448
 449         return SR_OK;
 450 }