X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fprotocol.h;h=4e16b37227736110cc6b76467c19060d5d6147f1;hb=9270f8f437581605ab4e3e808e2bd62f41ab7d35;hp=7518cb759f9a768cb373a78ca885fdfaa0f6d652;hpb=c3d4003710edfe193de072f6032401bcba098672;p=libsigrok.git diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h index 7518cb75..4e16b372 100644 --- a/src/hardware/kingst-la2016/protocol.h +++ b/src/hardware/kingst-la2016/protocol.h @@ -23,99 +23,142 @@ #ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H #define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H -#include -#include #include -#include "libsigrok-internal.h" +#include -#define LOG_PREFIX "kingst-la2016" +#define LOG_PREFIX "kingst-la2016" #define LA2016_VID 0x77a1 #define LA2016_PID 0x01a2 +#define LA2016_IPRODUCT_INDEX 2 #define USB_INTERFACE 0 #define USB_CONFIGURATION 1 +#define USB_EP_FPGA_BITSTREAM 2 +#define USB_EP_CAPTURE_DATA 6 -#define LA2016_BULK_MAX 8388608 +/* + * On Windows sigrok uses WinUSB RAW_IO policy which requires the + * USB transfer buffer size to be a multiple of the endpoint max packet + * size, which is 512 bytes in this case. Also, the maximum allowed size + * of the transfer buffer is normally read from WinUSB_GetPipePolicy API + * 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 MAX_RENUM_DELAY_MS 3000 -#define DEFAULT_TIMEOUT_MS 200 +/* USB communication timeout during regular operation. */ +#define DEFAULT_TIMEOUT_MS 200 -#define LA2016_THR_VOLTAGE_MIN 0.40 -#define LA2016_THR_VOLTAGE_MAX 4.00 +/* + * Check for MCU firmware to take effect after upload. Check the device + * presence for a maximum period of time, delay between checks in that + * phase. Allow for the device to vanish after upload and before checks, + * to not mistake its earlier incarnation for the successful operation + * of the most recently loaded firmware. + */ +#define RENUM_CHECK_PERIOD_MS 3000 +#define RENUM_GONE_DELAY_MS 1800 +#define RENUM_POLL_INTERVAL_MS 200 -#define LA2016_NUM_SAMPLES_MIN 256 -#define LA2016_NUM_SAMPLES_MAX (10UL * 1000 * 1000 * 1000) +/* + * 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 -typedef struct pwm_setting_dev { - uint32_t period; - uint32_t duty; -} pwm_setting_dev_t; +/* + * The complex logic input threshold voltage support with a custom level + * is not operational yet. Ideally we could support the set of pre-made + * voltages with their pretty text labels, and one of them referencing + * a voltage which is user specified. But not all applications support + * this setup equally well, or present it most appropriately to users. + * So let's implement something simpler for the moment until the more + * complex approach becomes accessible in all applications. + * + * Strictly speaking the logic input threshold voltage is a property of + * the "Logic" channel group. Again not all applications support such + * an approach, and like to see them as global device properties. + */ +#define WITH_THRESHOLD_DEVCFG 1 +#define WITH_THRESHOLD_SIMPLE 1 +#if !WITH_THRESHOLD_DEVCFG && !WITH_THRESHOLD_SIMPLE +# error "Custom threshold in Logic group is not implemented." +#endif -typedef struct trigger_cfg { - uint32_t channels; - uint32_t enabled; - uint32_t level; - uint32_t high_or_falling; -} trigger_cfg_t; +#define LA2016_THR_VOLTAGE_MIN 0.40 +#define LA2016_THR_VOLTAGE_MAX 4.00 -typedef struct capture_info { - uint32_t n_rep_packets; - uint32_t n_rep_packets_before_trigger; - uint32_t write_pos; -} capture_info_t; +#define LA2016_NUM_SAMPLES_MAX (UINT64_C(10 * 1000 * 1000 * 1000)) -#define NUM_PACKETS_IN_CHUNK 5 -#define TRANSFER_PACKET_LENGTH 16 +/* Maximum device capabilities. May differ between models. */ +#define MAX_PWM_FREQ SR_MHZ(20) +#define PWM_CLOCK SR_MHZ(200) /* 200MHz for both LA2016 and LA1016 */ -typedef struct pwm_setting { - uint8_t enabled; - float freq; - float duty; -} pwm_setting_t; +#define LA2016_NUM_PWMCH_MAX 2 -struct dev_context { - struct sr_context *ctx; +#define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024) - int64_t fw_updated; - pwm_setting_t pwm_setting[2]; - unsigned int threshold_voltage_idx; +struct kingst_model { + uint8_t magic; /* EEPROM magic byte value. */ + 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). */ +}; + +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; + const struct kingst_model *model; + struct sr_channel_group *cg_logic, *cg_pwm; + + /* User specified parameters. */ + 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 cur_samplerate; - uint64_t limit_samples; + struct sr_sw_limits sw_limits; uint64_t capture_ratio; - uint16_t cur_channels; - int num_channels; - - uint32_t bitstream_size; - - /* derived stuff */ - uint64_t pre_trigger_size; - - /* state after sampling */ - int had_triggers_configured; - int have_trigger; - int transfer_finished; - capture_info_t info; - unsigned int n_transfer_packets_to_read; /* each with 5 acq packets */ - unsigned int n_bytes_to_read; - unsigned int n_reps_until_trigger; - unsigned int reading_behind_trigger; + + /* Internal acquisition and download state. */ + gboolean trigger_involved; + gboolean completion_seen; + gboolean download_finished; + 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; + gboolean trigger_marked; uint64_t total_samples; uint32_t read_pos; - unsigned int convbuffer_size; - uint8_t *convbuffer; + struct feed_queue_logic *feed_queue; struct libusb_transfer *transfer; }; -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, uint16_t product_id); +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_stop_acquisition(const struct sr_dev_inst *sdi); SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi); -SR_PRIV int la2016_has_triggered(const struct sr_dev_inst *sdi); -SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfer_cb_fn cb); -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 int la2016_receive_data(int fd, int revents, void *cb_data); #endif