X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fprotocol.h;h=995ae64bfd80f063626e01f0399f9c7c04ad7d62;hp=9eb483ce62650c84c899cc39090eb8c3e43a5ca8;hb=90ed86aa1737fd30bac4cbbeaae91d87b4c22682;hpb=ea436ba7c5dc89e87c24200850fe458d6e6576d1 diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h index 9eb483ce..995ae64b 100644 --- a/src/hardware/kingst-la2016/protocol.h +++ b/src/hardware/kingst-la2016/protocol.h @@ -1,6 +1,7 @@ /* * This file is part of the libsigrok project. * + * Copyright (C) 2022 Gerhard Sittig * Copyright (C) 2020 Florian Schmidt * Copyright (C) 2013 Marcus Comstedt * Copyright (C) 2013 Bert Vermeulen @@ -44,10 +45,12 @@ * but libusb does not expose this function. Typically, max size is 2MB. */ #define LA2016_EP6_PKTSZ 512 /* Max packet size of USB endpoint 6. */ -#define LA2016_USB_BUFSZ (256 * 2 * LA2016_EP6_PKTSZ) /* 256KiB buffer. */ +#define LA2016_USB_BUFSZ (512 * 1024) /* 512KiB buffer. */ +#define LA2016_USB_XFER_COUNT 8 /* Size of USB bulk transfers pool. */ /* USB communication timeout during regular operation. */ #define DEFAULT_TIMEOUT_MS 200 +#define CAPTURE_TIMEOUT_MS 500 /* * Check for MCU firmware to take effect after upload. Check the device @@ -64,77 +67,88 @@ * The device expects some zero padding to follow the content of the * file which contains the FPGA bitstream. Specify the chunk size here. */ -#define LA2016_EP2_PADDING 2048 +#define LA2016_EP2_PADDING 4096 + +/* + * Whether the logic input threshold voltage is a config item of the + * "Logic" channel group or a global config item of the device. Ideally + * it would be the former (being strictly related to the Logic channels) + * but mainline applications work better with the latter, and many other + * device drivers implement it that way, too. + */ +#define WITH_THRESHOLD_DEVCFG 1 #define LA2016_THR_VOLTAGE_MIN 0.40 #define LA2016_THR_VOLTAGE_MAX 4.00 -#define LA2016_NUM_SAMPLES_MIN (UINT64_C(256)) +/* Properties related to the layout of capture data downloads. */ +#define TRANSFER_PACKET_LENGTH 16 #define LA2016_NUM_SAMPLES_MAX (UINT64_C(10 * 1000 * 1000 * 1000)) /* Maximum device capabilities. May differ between models. */ -#define MAX_SAMPLE_RATE_LA2016 SR_MHZ(200) -#define MAX_SAMPLE_RATE_LA1016 SR_MHZ(100) -#define MIN_SAMPLE_RATE_LA2016 SR_KHZ(10) #define MAX_PWM_FREQ SR_MHZ(20) #define PWM_CLOCK SR_MHZ(200) /* 200MHz for both LA2016 and LA1016 */ -/* TODO - * What is the origin and motivation of that 128Mi literal? What is its - * unit? How does it relate to a device's hardware capabilities? How to - * map the 1GiB of RAM of an LA2016 (at 16 channels) to the 128Mi value? - * It cannot be sample count. Is it memory size in bytes perhaps? - */ -#define LA2016_PRE_MEM_LIMIT_BASE (128 * 1024 * 1024) - #define LA2016_NUM_PWMCH_MAX 2 -#define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024) - -struct pwm_setting_dev { - uint32_t period; - uint32_t duty; -}; - -struct trigger_cfg { - uint32_t channels; - uint32_t enabled; - uint32_t level; - uint32_t high_or_falling; -}; +/* Streaming mode related thresholds. Not enforced, used for warnings. */ +#define LA2016_STREAM_MBPS_MAX 200 /* In units of Mbps. */ +#define LA2016_STREAM_PUSH_THR 16 /* In units of Mbps. */ +#define LA2016_STREAM_PUSH_IVAL 250 /* In units of ms. */ -struct capture_info { - uint32_t n_rep_packets; - uint32_t n_rep_packets_before_trigger; - uint32_t write_pos; -}; +/* + * Whether to de-initialize the device hardware in the driver's close + * callback. It is desirable to e.g. configure PWM channels and leave + * the generator running after the application shuts down. Users can + * always disable channels on their way out if they want to. + */ +#define WITH_DEINIT_IN_CLOSE 0 -#define NUM_PACKETS_IN_CHUNK 5 -#define TRANSFER_PACKET_LENGTH 16 +#define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024) -struct pwm_setting { - gboolean enabled; - float freq; - float duty; +struct kingst_model { + uint8_t magic, magic2; /* EEPROM magic byte values. */ + const char *name; /* User perceived model name. */ + const char *fpga_stem; /* Bitstream filename stem. */ + uint64_t samplerate; /* Max samplerate in Hz. */ + size_t channel_count; /* Max channel count (16, 32). */ + uint64_t memory_bits; /* RAM capacity in Gbit (1, 2, 4). */ + uint64_t baseclock; /* Base clock to derive samplerate from. */ }; struct dev_context { + uint16_t usb_pid; + char *mcu_firmware; + char *fpga_bitstream; uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */ + uint8_t identify_magic, identify_magic2; + const struct kingst_model *model; + char **channel_names_logic; + struct sr_channel_group *cg_logic, *cg_pwm; /* User specified parameters. */ - struct pwm_setting pwm_setting[LA2016_NUM_PWMCH_MAX]; + struct pwm_setting { + gboolean enabled; + float freq; + float duty; + } pwm_setting[LA2016_NUM_PWMCH_MAX]; size_t threshold_voltage_idx; - float threshold_voltage; - uint64_t max_samplerate; - uint64_t cur_samplerate; - uint64_t limit_samples; + uint64_t samplerate; + struct sr_sw_limits sw_limits; uint64_t capture_ratio; + gboolean continuous; /* Internal acquisition and download state. */ gboolean trigger_involved; + gboolean frame_begin_sent; gboolean completion_seen; gboolean download_finished; - struct capture_info info; + uint32_t packets_per_chunk; + struct capture_info { + uint32_t n_rep_packets; + uint32_t n_rep_packets_before_trigger; + uint32_t write_pos; + } info; uint32_t n_transfer_packets_to_read; /* each with 5 acq packets */ uint32_t n_bytes_to_read; uint32_t n_reps_until_trigger; @@ -142,18 +156,32 @@ struct dev_context { uint64_t total_samples; uint32_t read_pos; - size_t convbuffer_size; - uint8_t *convbuffer; - struct libusb_transfer *transfer; + struct feed_queue_logic *feed_queue; + GSList *transfers; + size_t transfer_bufsize; + struct stream_state_t { + size_t enabled_count; + uint32_t enabled_mask; + uint32_t channel_masks[32]; + size_t channel_index; + uint32_t sample_data[32]; + uint64_t flush_period_ms; + uint64_t last_flushed; + } stream; }; -SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, - libusb_device *dev, uint16_t product_id); -SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi); +SR_PRIV int la2016_upload_firmware(const struct sr_dev_inst *sdi, + struct sr_context *sr_ctx, libusb_device *dev, gboolean skip_upload); +SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi, + gboolean show_message); +SR_PRIV int la2016_init_hardware(const struct sr_dev_inst *sdi); +SR_PRIV int la2016_deinit_hardware(const struct sr_dev_inst *sdi); +SR_PRIV int la2016_write_pwm_config(const struct sr_dev_inst *sdi, size_t idx); +SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi, + double voltage); SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi); SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi); SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data); -SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi); -SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi); +SR_PRIV void la2016_release_resources(const struct sr_dev_inst *sdi); #endif