]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/sysclk-sla5032/protocol.c
sysclk-sla5032: Merge sla5032.[ch] into protocol.[ch].
[libsigrok.git] / src / hardware / sysclk-sla5032 / protocol.c
index c4011da1df517a16b2b0d9af0198cafbedd856b1..b4a4e4d69d8e7141d2a630713341ca1fd3f072e7 100644 (file)
 #include <config.h>
 #include <string.h>
 #include "protocol.h"
-#include "sla5032.h"
+
+/*
+ * Register description (all registers are 32bit):
+ *
+ * Rx - means register with index x (register address is x*4)
+ *
+ * R0(wr): trigger sel0 (low/high)
+ * R0(rd): n*256 samples (post trigger) captured
+ *
+ * R1(wr): trigger sel1 (level/edge)
+ * R1(rd): current sampled value
+ *
+ * R2(wr): trigger enable mask
+ *
+ * R2(rd): (status register)
+ * b0: 1 - keys entered
+ * b1: 1 - triggered
+ * b3: 1 - capture done
+ *
+ * not configured: B6FF9C97, 12FF9C97, 92FF9C97, 16FF9C97, ...
+ * configured: A5A5A5A0, after enter keys A5A5A5A1
+ *
+ * sel1 (one bit per channel):
+ *  0 - level triggered
+ *  1 - edge triggered
+ *
+ * sel0 (one bit per channel):
+ *  0 - (low level trigger, sel1=0), (falling edge, sel1=1)
+ *  1 - (high level trigger, sel1=0), (raising edge, sel1=1)
+ *
+ * mask (one bit per channel):
+ *  0 - disable trigger on channel n
+ *  1 - enable trigger on channel n
+ *
+ * R3: upload base address or num samples (0x300000)
+ *
+ * R4: pll divisor - 1
+ *  0 - div 1 (no division)
+ *  1 - div 2
+ *  2 - div 3
+ *  ...
+ *  n-1 - div n
+ *
+ * R5(rd/wr):
+ * b0: 1 - enable pll mul 2, 0 - disable pll mul 2
+ * b1: ??
+ * b2: ??
+ * b3: ??
+ * b4:
+ * b5: ->0->1 upload next data chunk (to pc)
+ * b6: ??
+ * b7: 0 - enable pll mul 1.25, 1 - disable pll mul 1.25
+ * b8: ??
+ *
+ * R6: post trigger depth, value x means (x+1)*256 (samples), min value is 1
+ * R7: pre trigger depth, value y means (y+1)*256 (samples), min value is 1
+ * (x+1)*256 + (y+1)*256 <= 64M
+ *
+ * R9:  PWM1 HI (1 width-1)
+ * R10: PWM1 LO (0 width-1)
+ *
+ * R11: PWM2 HI (1 width-1)
+ * R12: PWM2 LO (0 width-1)
+ *
+ * R14:
+ * 1 - start sample?
+ * 0 - upload done?
+ *
+ * R16: rom key 0
+ * R17: rom key 1
+ *
+ * key0 is F6 81 13 64
+ * key1 is 00 00 00 00
+ *
+ * start sample:
+ * r5 <= b2 <= 0
+ * r5 <= b3 <= 0
+ * r5 <= b5 <= 0
+ *
+ * r5 <= b6 <= 1
+ * r5 <= b1 <= 1
+ * r5 <= b1 <= 0
+ *
+ * r5 <= b8 <= 1
+ * r5 <= b8 <= 0
+ *
+ * r5 <= b6 <= 1
+ * r5 <= b2 <= 1
+ *
+ * read back:
+ * r5 <= 0x08  (b3)
+ * r5 <= 0x28  (b5,b3)
+ */
+
+#define BITSTREAM_NAME "sysclk-sla5032.bit"
+#define BITSTREAM_MAX_SIZE (512 * 1024) /* Bitstream size limit for safety */
+#define BITSTREAM_HEADER_SIZE 0x69
+#define FW_CHUNK_SIZE 250
+#define XILINX_SYNC_WORD 0xAA995566
+
+static int la_write_cmd_buf(const struct sr_usb_dev_inst *usb, uint8_t cmd,
+               unsigned int addr, unsigned int len, const void *data)
+{
+       uint8_t *cmd_pkt;
+       int ret, xfer_len;
+       int cmd_len;
+
+       cmd_pkt = g_try_malloc(len + 10);
+       if (!cmd_pkt) {
+               ret = SR_ERR_MALLOC;
+               goto exit;
+       }
+
+       cmd_pkt[0] = cmd;
+       cmd_len = 1;
+       xfer_len = 0;
+
+       switch(cmd) {
+       case CMD_INIT_FW_UPLOAD: /* init firmware upload */
+               break;
+       case CMD_UPLOAD_FW_CHUNK:
+               cmd_pkt[1] = len;
+               cmd_len += 1 + len;
+               memcpy(&cmd_pkt[2], data, len);
+               break;
+       case CMD_READ_REG: /* read register */
+               cmd_pkt[1] = addr;
+               cmd_pkt[2] = len;
+               cmd_len += 2;
+               break;
+       case CMD_WRITE_REG: /* write register */
+               cmd_pkt[1] = addr;
+               cmd_pkt[2] = len;
+               cmd_len += 2 + len;
+               memcpy(&cmd_pkt[3], data, len);
+               break;
+       case CMD_READ_MEM: /* read mem */
+               cmd_pkt[1] = (addr >> 8) & 0xFF;
+               cmd_pkt[2] = addr & 0xFF;
+               cmd_pkt[3] = len;
+               cmd_len += 3;
+               break;
+       case CMD_READ_DATA: /* read samples */
+               cmd_pkt[1] = addr;
+               cmd_len += 1;
+               break;
+       }
+
+       ret = libusb_bulk_transfer(usb->devhdl, EP_COMMAND, cmd_pkt, cmd_len,
+                       &xfer_len, USB_CMD_TIMEOUT_MS);
+       if (ret != 0) {
+               sr_dbg("Failed to send command %d: %s.",
+                          cmd, libusb_error_name(ret));
+               return SR_ERR;
+       }
+
+       if (xfer_len != cmd_len) {
+               sr_dbg("Invalid send command response of length %d.", xfer_len);
+               return SR_ERR;
+       }
+
+exit:
+       g_free(cmd_pkt);
+       return ret;
+}
+
+static int la_read_reg(const struct sr_usb_dev_inst *usb, unsigned int reg, uint32_t *val)
+{
+       int ret, xfer_len;
+       uint32_t reply;
+
+       ret = la_write_cmd_buf(usb, CMD_READ_REG, reg * sizeof(uint32_t),
+                       sizeof(reply), NULL); /* rd reg */
+       if (ret != SR_OK)
+               return ret;
+
+       ret = libusb_bulk_transfer(usb->devhdl, EP_REPLY, (uint8_t *)&reply,
+                       sizeof(reply), &xfer_len, USB_REPLY_TIMEOUT_MS);
+       if (ret != SR_OK)
+               return ret;
+
+       if (xfer_len != sizeof(uint32_t)) {
+               sr_dbg("Invalid register read response of length %d.", xfer_len);
+               return SR_ERR;
+       }
+
+       *val = GUINT32_FROM_BE(reply);
+
+       return ret;
+}
+
+static int la_write_reg(const struct sr_usb_dev_inst *usb, unsigned int reg, uint32_t val)
+{
+       uint32_t val_be;
+
+       val_be = GUINT32_TO_BE(val);
+
+       return la_write_cmd_buf(usb, CMD_WRITE_REG, reg * sizeof(uint32_t),
+                       sizeof(val_be), &val_be); /* wr reg */
+}
+
+static int la_read_mem(const struct sr_usb_dev_inst *usb, unsigned int addr, unsigned int len, void *data)
+{
+       int ret, xfer_len;
+
+       ret = la_write_cmd_buf(usb, CMD_READ_MEM, addr, len, NULL); /* rd mem */
+       if (ret != SR_OK)
+               return ret;
+
+       xfer_len = 0;
+       ret = libusb_bulk_transfer(usb->devhdl, EP_REPLY, (uint8_t *)data,
+                       len, &xfer_len, USB_REPLY_TIMEOUT_MS);
+       if (xfer_len != (int)len) {
+               sr_dbg("Invalid memory read response of length %d.", xfer_len);
+               return SR_ERR;
+       }
+
+       return ret;
+}
+
+static int la_read_samples(const struct sr_usb_dev_inst *usb, unsigned int addr)
+{
+       return la_write_cmd_buf(usb, CMD_READ_DATA, addr, 0, NULL); /* rd samples */
+}
+
+SR_PRIV int sla5032_set_depth(const struct sr_usb_dev_inst *usb, uint32_t pre, uint32_t post)
+{
+       int ret;
+
+       /* (pre + 1)*256 + (post + 1)*256 <= 64*1024*1024 */
+       ret = la_write_reg(usb, 7, pre);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_write_reg(usb, 6, post);
+}
+
+SR_PRIV int sla5032_set_triggers(const struct sr_usb_dev_inst *usb,
+               uint32_t trg_value, uint32_t trg_edge_mask, uint32_t trg_mask)
+{
+       int ret;
+
+       sr_dbg("set trigger: val: %08X, e_mask: %08X, mask: %08X.", trg_value,
+               trg_edge_mask, trg_mask);
+
+       ret = la_write_reg(usb, 0, trg_value);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_write_reg(usb, 1, trg_edge_mask);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_write_reg(usb, 2, trg_mask);
+}
+
+static int la_set_res_reg_bit(const struct sr_usb_dev_inst *usb,
+               unsigned int reg, unsigned int bit, unsigned int set_bit)
+{
+       int ret;
+       uint32_t v;
+
+       v = 0;
+       ret = la_read_reg(usb, reg, &v);
+       if (ret != SR_OK)
+               return ret;
+
+       if (set_bit)
+               v |= (1u << bit);
+       else
+               v &= ~(1u << bit);
+
+       return la_write_reg(usb, reg, v);
+}
+
+struct pll_tbl_entry_t
+{
+       unsigned int sr;
+       uint32_t pll_div_minus_1;
+       unsigned int pll_mul_flags;
+};
+
+enum {
+       PLL_MUL2 = 1, /* x2 */
+       PLL_MUL1_25 = 2, /* x1.25 */
+};
+
+static const struct pll_tbl_entry_t pll_tbl[] = {
+       { 500000000,     0, PLL_MUL2 | PLL_MUL1_25 }, /* 500M = f*2*1.25/1 */
+       { 400000000,     0, PLL_MUL2               }, /* 400M = f*2/1      */
+       { 250000000,     0, PLL_MUL1_25            }, /* 250M = f*1.25/1   */
+       { 200000000,     0, 0                      }, /* 200M = f/1        */
+       { 100000000,     1, 0                      }, /* 100M = f/2        */
+       {  50000000,     3, 0                      }, /*  50M = f/4        */
+       {  25000000,     7, 0                      }, /*  25M = f/8        */
+       {  20000000,     9, 0                      }, /*  20M = f/10       */
+       {  10000000,    19, 0                      }, /*  10M = f/20       */
+       {   5000000,    39, 0                      }, /*   5M = f/40       */
+       {   2000000,    99, 0                      }, /*   2M = f/100      */
+       {   1000000,   199, 0                      }, /*   1M = f/200      */
+       {    500000,   399, 0                      }, /* 500k = f/400      */
+       {    200000,   999, 0                      }, /* 200k = f/1000     */
+       {    100000,  1999, 0                      }, /* 100k = f/2000     */
+       {     50000,  3999, 0                      }, /*  50k = f/4000     */
+       {     20000,  9999, 0                      }, /*  20k = f/10000    */
+       {     10000, 19999, 0                      }, /*  10k = f/20000    */
+       {      5000, 39999, 0                      }, /*   5k = f/40000    */
+       {      2000, 99999, 0                      }, /*   2k = f/100000   */
+};
+
+SR_PRIV int sla5032_set_samplerate(const struct sr_usb_dev_inst *usb, unsigned int sr)
+{
+       int i, ret;
+       const struct pll_tbl_entry_t *e;
+
+       e = NULL;
+       for (i = 0; i < (int)ARRAY_SIZE(pll_tbl); i++) {
+               if (sr == pll_tbl[i].sr) {
+                       e = &pll_tbl[i];
+                       break;
+               }
+       }
+
+       if (!e)
+               return SR_ERR_SAMPLERATE;
+
+       sr_dbg("set sample rate: %u.", e->sr);
+
+       ret = la_write_reg(usb, 4, e->pll_div_minus_1);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_set_res_reg_bit(usb, 5, 0,
+               (e->pll_mul_flags & PLL_MUL2) ? 1 : 0); /* bit0 (1=en_mul2) */
+       if (ret != SR_OK)
+               return ret;
+
+       return la_set_res_reg_bit(usb, 5, 7,
+               (e->pll_mul_flags & PLL_MUL1_25) ? 0 : 1); /* bit7 (0=en_mul_1.25) */
+}
+
+SR_PRIV int sla5032_start_sample(const struct sr_usb_dev_inst *usb)
+{
+       int ret;
+       const unsigned int bits[10][2] = {
+               {2, 0}, {3, 0}, {5, 0}, {6, 1}, {1, 1},
+               {1, 0}, {8, 1}, {8, 0}, {6, 1}, {2, 1},
+       };
+
+       ret = la_write_reg(usb, 14, 1);
+       if (ret != SR_OK)
+               return ret;
+
+       for (size_t i = 0; i < ARRAY_SIZE(bits); i++) {
+               ret = la_set_res_reg_bit(usb, 5, bits[i][0], bits[i][1]);
+               if (ret != SR_OK)
+                       return ret;
+       }
+
+       return ret;
+}
+
+SR_PRIV int sla5032_get_status(const struct sr_usb_dev_inst *usb, uint32_t status[3])
+{
+       int ret;
+       uint32_t v;
+
+       ret = la_read_reg(usb, 1, &status[0]);
+       if (ret != SR_OK)
+               return ret;
+
+       status[1] = 1; /* wait trigger */
+
+       ret = la_read_reg(usb, 0, &status[2]);
+       if (ret != SR_OK)
+               return ret;
+
+       v = 0;
+       ret = la_read_reg(usb, 2, &v);
+       if (ret != SR_OK)
+               return ret;
+
+       if (v & 8) {
+               status[1] = 3; /* sample done */
+               sr_dbg("get status, reg2: %08X.", v);
+       } else if (v & 2) {
+               status[1] = 2; /* triggered */
+       }
+
+       return ret;
+}
+
+static int la_read_samples_data(const struct sr_usb_dev_inst *usb, void *buf,
+               unsigned int len, int *xfer_len)
+{
+       return libusb_bulk_transfer(usb->devhdl, EP_DATA, (uint8_t *)buf, len,
+                       xfer_len, USB_DATA_TIMEOUT_MS);
+}
+
+SR_PRIV int sla5032_read_data_chunk(const struct sr_usb_dev_inst *usb,
+               void *buf, unsigned int len, int *xfer_len)
+{
+       int ret;
+
+       ret = la_read_samples(usb, 3);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_write_reg(usb, 3, 0x300000);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_set_res_reg_bit(usb, 5, 4, 0);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_set_res_reg_bit(usb, 5, 4, 1);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_read_samples_data(usb, buf, len, xfer_len);
+}
+
+SR_PRIV int sla5032_set_read_back(const struct sr_usb_dev_inst *usb)
+{
+       int ret;
+
+       ret = la_write_reg(usb, 5, 0x08);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_write_reg(usb, 5, 0x28);
+}
+
+SR_PRIV int sla5032_set_pwm1(const struct sr_usb_dev_inst* usb, uint32_t hi, uint32_t lo)
+{
+       int ret;
+
+       ret = la_write_reg(usb, 9, hi);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_write_reg(usb, 10, lo);
+}
+
+SR_PRIV int sla5032_set_pwm2(const struct sr_usb_dev_inst* usb, uint32_t hi, uint32_t lo)
+{
+       int ret;
+
+       ret = la_write_reg(usb, 11, hi);
+       if (ret != SR_OK)
+               return ret;
+
+       return la_write_reg(usb, 12, lo);
+}
+
+SR_PRIV int sla5032_write_reg14_zero(const struct sr_usb_dev_inst* usb)
+{
+       return la_write_reg(usb, 14, 0);
+}
+
+static int la_cfg_fpga_done(const struct sr_usb_dev_inst *usb, unsigned int addr)
+{
+       uint8_t done_key[8];
+       uint32_t k0, k1;
+       unsigned int reg2;
+       int ret;
+
+       memset(done_key, 0, sizeof(done_key));
+
+       ret = la_read_mem(usb, addr, sizeof(done_key), done_key); /* read key from eeprom */
+       if (ret != SR_OK)
+               return ret;
+
+       k0 = RL32(done_key);     /* 0x641381F6 */
+       k1 = RL32(done_key + 4); /* 0x00000000 */
+
+       sr_dbg("cfg fpga done, k0: %08X, k1: %08X.", k0, k1);
+
+       ret = la_write_reg(usb, 16, k0);
+       if (ret != SR_OK)
+               return ret;
+
+       ret = la_write_reg(usb, 17, k1);
+       if (ret != SR_OK)
+               return ret;
+
+       reg2 = 0;
+       ret = la_read_reg(usb, 2, &reg2);
+
+       sr_dbg("cfg fpga done, reg2: %08X.", reg2);
+
+       return ret;
+}
+
+/*
+ * Load a bitstream file into memory. Returns a newly allocated array
+ * consisting of a 32-bit length field followed by the bitstream data.
+ */
+static unsigned char *load_bitstream(struct sr_context *ctx,
+                                       const char *name, int *length_p)
+{
+       struct sr_resource fw;
+       unsigned char *stream, *fw_data;
+       ssize_t length, count;
+
+       if (sr_resource_open(ctx, &fw, SR_RESOURCE_FIRMWARE, name) != SR_OK)
+               return NULL;
+
+       if (fw.size <= BITSTREAM_HEADER_SIZE || fw.size > BITSTREAM_MAX_SIZE) {
+               sr_err("Refusing to load bitstream of unreasonable size "
+                          "(%" PRIu64 " bytes).", fw.size);
+               sr_resource_close(ctx, &fw);
+               return NULL;
+       }
+
+       stream = g_try_malloc(fw.size);
+       if (!stream) {
+               sr_err("Failed to allocate bitstream buffer.");
+               sr_resource_close(ctx, &fw);
+               return NULL;
+       }
+
+       count = sr_resource_read(ctx, &fw, stream, fw.size);
+       sr_resource_close(ctx, &fw);
+
+       if (count != (ssize_t)fw.size) {
+               sr_err("Failed to read bitstream '%s'.", name);
+               g_free(stream);
+               return NULL;
+       }
+
+       if (RB32(stream + BITSTREAM_HEADER_SIZE) != XILINX_SYNC_WORD) {
+               sr_err("Invalid bitstream signature.");
+               g_free(stream);
+               return NULL;
+       }
+
+       length = fw.size - BITSTREAM_HEADER_SIZE + 0x100;
+       fw_data = g_try_malloc(length);
+       if (!fw_data) {
+               sr_err("Failed to allocate bitstream aligned buffer.");
+               return NULL;
+       }
+
+       memset(fw_data, 0xFF, 0x100);
+       memcpy(fw_data + 0x100, stream + BITSTREAM_HEADER_SIZE,
+                       fw.size - BITSTREAM_HEADER_SIZE);
+       g_free(stream);
+
+       *length_p = length;
+
+       return fw_data;
+}
+
+static int sla5032_is_configured(const struct sr_usb_dev_inst* usb, gboolean *is_configured)
+{
+       int ret;
+       uint32_t reg2;
+
+       reg2 = 0;
+       ret = la_read_reg(usb, 2, &reg2);
+       if (ret == SR_OK)
+               *is_configured = (reg2 & 0xFFFFFFF1) == 0xA5A5A5A1 ? TRUE : FALSE;
+
+       return ret;
+}
+
+/* Load a Binary File from the firmware directory, transfer it to the device. */
+static int sla5032_send_bitstream(struct sr_context *ctx,
+               const struct sr_usb_dev_inst *usb, const char *name)
+{
+       unsigned char *stream;
+       int ret, length, i, n, m;
+       uint32_t reg2;
+
+       if (!ctx || !usb || !name)
+               return SR_ERR_BUG;
+
+       stream = load_bitstream(ctx, name, &length);
+       if (!stream)
+               return SR_ERR;
+
+       sr_dbg("Downloading FPGA bitstream '%s'.", name);
+
+       reg2 = 0;
+       ret = la_read_reg(usb, 2, &reg2);
+       sr_dbg("send bitstream, reg2: %08X.", reg2);
+
+       /* Transfer the entire bitstream in one URB. */
+       ret = la_write_cmd_buf(usb, CMD_INIT_FW_UPLOAD, 0, 0, NULL); /* init firmware upload */
+       if (ret != SR_OK) {
+               g_free(stream);
+               return ret;
+       }
+
+       n = length / FW_CHUNK_SIZE;
+       m = length % FW_CHUNK_SIZE;
+
+       for (i = 0; i < n; i++) {
+               /* upload firmware chunk */
+               ret = la_write_cmd_buf(usb, CMD_UPLOAD_FW_CHUNK, 0,
+                               FW_CHUNK_SIZE, &stream[i * FW_CHUNK_SIZE]);
+
+               if (ret != SR_OK) {
+                       g_free(stream);
+                       return ret;
+               }
+       }
+
+       if (m != 0) {
+               /* upload firmware last chunk */
+               ret = la_write_cmd_buf(usb, CMD_UPLOAD_FW_CHUNK, 0, m,
+                               &stream[n * FW_CHUNK_SIZE]);
+
+               if (ret != SR_OK) {
+                       g_free(stream);
+                       return ret;
+               }
+       }
+
+       g_free(stream);
+
+       la_cfg_fpga_done(usb, 4000);
+
+       sla5032_write_reg14_zero(usb);
+
+       sr_dbg("FPGA bitstream download of %d bytes done.", length);
+
+       return SR_OK;
+}
+
+/* Select and transfer FPGA bitstream for the current configuration. */
+SR_PRIV int sla5032_apply_fpga_config(const struct sr_dev_inst *sdi)
+{
+       struct dev_context *devc;
+       struct drv_context *drvc;
+       int ret;
+       gboolean is_configured;
+
+       devc = sdi->priv;
+       drvc = sdi->driver->context;
+
+       if (FPGA_NOCONF != devc->active_fpga_config)
+               return SR_OK; /* No change. */
+
+       is_configured = FALSE;
+       ret = sla5032_is_configured(sdi->conn, &is_configured);
+       if (ret != SR_OK)
+               return ret;
+
+       if (is_configured) {
+               devc->active_fpga_config = FPGA_CONF;
+               return ret;
+       }
+
+       sr_dbg("FPGA not configured, send bitstream.");
+       ret = sla5032_send_bitstream(drvc->sr_ctx, sdi->conn, BITSTREAM_NAME);
+       devc->active_fpga_config = (ret == SR_OK) ? FPGA_CONF : FPGA_NOCONF;
+
+       return ret;
+}
 
 /* Callback handling data */
 static int la_prepare_data(int fd, int revents, void *cb_data)