2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com>
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.
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.
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/>.
25 /* Submit an already filled-in USB transfer.
27 static int submit_transfer(struct dev_context *devc,
28 struct libusb_transfer *xfer)
32 ret = libusb_submit_transfer(xfer);
35 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
36 devc->transfer_error = TRUE;
43 /* Set up transfer for the next register in a write sequence.
45 static void next_reg_write(struct acquisition_state *acq)
47 struct regval *regval;
49 regval = &acq->reg_sequence[acq->reg_seq_pos];
51 acq->xfer_buf_out[0] = LWLA_WORD(CMD_WRITE_REG);
52 acq->xfer_buf_out[1] = LWLA_WORD(regval->reg);
53 acq->xfer_buf_out[2] = LWLA_WORD_0(regval->val);
54 acq->xfer_buf_out[3] = LWLA_WORD_1(regval->val);
56 acq->xfer_out->length = 4 * sizeof(acq->xfer_buf_out[0]);
59 /* Set up transfer for the next register in a read sequence.
61 static void next_reg_read(struct acquisition_state *acq)
65 addr = acq->reg_sequence[acq->reg_seq_pos].reg;
67 acq->xfer_buf_out[0] = LWLA_WORD(CMD_READ_REG);
68 acq->xfer_buf_out[1] = LWLA_WORD(addr);
70 acq->xfer_out->length = 2 * sizeof(acq->xfer_buf_out[0]);
73 /* Decode the response to a register read request.
75 static int read_reg_response(struct acquisition_state *acq)
79 if (acq->xfer_in->actual_length != 4) {
80 sr_err("Received size %d doesn't match expected size 4.",
81 acq->xfer_in->actual_length);
84 value = LWLA_TO_UINT32(acq->xfer_buf_in[0]);
85 acq->reg_sequence[acq->reg_seq_pos].val = value;
90 /* Enter a new state and submit the corresponding request to the device.
92 static int submit_request(const struct sr_dev_inst *sdi,
93 enum protocol_state state)
95 struct dev_context *devc;
96 struct acquisition_state *acq;
100 acq = devc->acquisition;
104 acq->xfer_out->length = 0;
105 acq->reg_seq_pos = 0;
106 acq->reg_seq_len = 0;
108 /* Perform the model-specific action for the new state. */
109 ret = (*devc->model->prepare_request)(sdi);
112 devc->transfer_error = TRUE;
116 if (acq->reg_seq_pos < acq->reg_seq_len) {
117 if ((state & STATE_EXPECT_RESPONSE) != 0)
123 return submit_transfer(devc, acq->xfer_out);
126 /* Evaluate and act on the response to a capture status request.
128 static void handle_status_response(const struct sr_dev_inst *sdi)
130 struct dev_context *devc;
131 struct acquisition_state *acq;
132 unsigned int old_status;
135 acq = devc->acquisition;
136 old_status = acq->status;
138 if ((*devc->model->handle_response)(sdi) != SR_OK) {
139 devc->transfer_error = TRUE;
142 devc->state = STATE_STATUS_WAIT;
144 sr_spew("Captured %u words, %" PRIu64 " ms, status 0x%02X.",
145 acq->mem_addr_fill, acq->duration_now, acq->status);
147 if ((~old_status & acq->status & STATUS_TRIGGERED) != 0)
148 sr_info("Capture triggered.");
150 if (acq->duration_now >= acq->duration_max) {
151 sr_dbg("Time limit reached, stopping capture.");
152 submit_request(sdi, STATE_STOP_CAPTURE);
153 } else if ((acq->status & STATUS_TRIGGERED) == 0) {
154 sr_spew("Waiting for trigger.");
155 } else if ((acq->status & STATUS_MEM_AVAIL) == 0) {
156 sr_dbg("Capture memory filled.");
157 submit_request(sdi, STATE_LENGTH_REQUEST);
158 } else if ((acq->status & STATUS_CAPTURING) != 0) {
159 sr_spew("Sampling in progress.");
163 /* Evaluate and act on the response to a capture length request.
165 static void handle_length_response(const struct sr_dev_inst *sdi)
167 struct dev_context *devc;
168 struct acquisition_state *acq;
171 acq = devc->acquisition;
173 if ((*devc->model->handle_response)(sdi) != SR_OK) {
174 devc->transfer_error = TRUE;
177 acq->rle = RLE_STATE_DATA;
180 acq->samples_done = 0;
181 acq->mem_addr_done = acq->mem_addr_next;
184 if (acq->mem_addr_next >= acq->mem_addr_stop) {
185 submit_request(sdi, STATE_READ_FINISH);
188 sr_dbg("%u words in capture buffer.",
189 acq->mem_addr_stop - acq->mem_addr_next);
191 submit_request(sdi, STATE_READ_PREPARE);
194 /* Evaluate and act on the response to a capture memory read request.
196 static void handle_read_response(const struct sr_dev_inst *sdi)
198 struct dev_context *devc;
199 struct acquisition_state *acq;
200 struct sr_datafeed_packet packet;
201 struct sr_datafeed_logic logic;
202 unsigned int end_addr;
205 acq = devc->acquisition;
207 /* Prepare session packet. */
208 packet.type = SR_DF_LOGIC;
209 packet.payload = &logic;
210 logic.unitsize = (devc->model->num_channels + 7) / 8;
211 logic.data = acq->out_packet;
213 end_addr = MIN(acq->mem_addr_next, acq->mem_addr_stop);
217 * Repeatedly call the model-specific read response handler until
218 * all data received in the transfer has been accounted for.
220 while (!devc->cancel_requested
221 && (acq->run_len > 0 || acq->mem_addr_done < end_addr)
222 && acq->samples_done < acq->samples_max) {
224 if ((*devc->model->handle_response)(sdi) != SR_OK) {
225 devc->transfer_error = TRUE;
228 if (acq->out_index * logic.unitsize >= PACKET_SIZE) {
229 /* Send off full logic packet. */
230 logic.length = acq->out_index * logic.unitsize;
231 sr_session_send(sdi, &packet);
236 if (!devc->cancel_requested
237 && acq->samples_done < acq->samples_max
238 && acq->mem_addr_next < acq->mem_addr_stop) {
239 /* Request the next block. */
240 submit_request(sdi, STATE_READ_REQUEST);
244 /* Send partially filled packet as it is the last one. */
245 if (!devc->cancel_requested && acq->out_index > 0) {
246 logic.length = acq->out_index * logic.unitsize;
247 sr_session_send(sdi, &packet);
250 submit_request(sdi, STATE_READ_FINISH);
253 /* Destroy and unset the acquisition state record.
255 static void clear_acquisition_state(const struct sr_dev_inst *sdi)
257 struct dev_context *devc;
258 struct acquisition_state *acq;
261 acq = devc->acquisition;
263 devc->acquisition = NULL;
266 libusb_free_transfer(acq->xfer_out);
267 libusb_free_transfer(acq->xfer_in);
272 /* USB I/O source callback.
274 static int transfer_event(int fd, int revents, void *cb_data)
276 const struct sr_dev_inst *sdi;
277 struct dev_context *devc;
278 struct drv_context *drvc;
280 struct sr_datafeed_packet packet;
287 drvc = sdi->driver->context;
290 return G_SOURCE_REMOVE;
292 /* Handle pending USB events without blocking. */
295 ret = libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx,
298 sr_err("Event handling failed: %s.", libusb_error_name(ret));
299 devc->transfer_error = TRUE;
302 if (!devc->transfer_error && devc->state == STATE_STATUS_WAIT) {
303 if (devc->cancel_requested)
304 submit_request(sdi, STATE_STOP_CAPTURE);
305 else if (revents == 0) /* status poll timeout */
306 submit_request(sdi, STATE_STATUS_REQUEST);
309 /* Stop processing events if an error occurred on a transfer. */
310 if (devc->transfer_error)
311 devc->state = STATE_IDLE;
313 if (devc->state != STATE_IDLE)
314 return G_SOURCE_CONTINUE;
316 sr_info("Acquisition stopped.");
318 /* We are done, clean up and send end packet to session bus. */
319 clear_acquisition_state(sdi);
321 packet.type = SR_DF_END;
322 packet.payload = NULL;
323 sr_session_send(sdi, &packet);
325 return G_SOURCE_REMOVE;
328 /* USB output transfer completion callback.
330 static void LIBUSB_CALL transfer_out_completed(struct libusb_transfer *transfer)
332 const struct sr_dev_inst *sdi;
333 struct dev_context *devc;
334 struct acquisition_state *acq;
336 sdi = transfer->user_data;
338 acq = devc->acquisition;
340 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
341 sr_err("Transfer to device failed (state %d): %s.",
342 devc->state, libusb_error_name(transfer->status));
343 devc->transfer_error = TRUE;
347 /* If this was a read request, wait for the response. */
348 if ((devc->state & STATE_EXPECT_RESPONSE) != 0) {
349 submit_transfer(devc, acq->xfer_in);
352 if (acq->reg_seq_pos < acq->reg_seq_len)
353 acq->reg_seq_pos++; /* register write completed */
355 /* Repeat until all queued registers have been written. */
356 if (acq->reg_seq_pos < acq->reg_seq_len && !devc->cancel_requested) {
358 submit_transfer(devc, acq->xfer_out);
362 switch (devc->state) {
363 case STATE_START_CAPTURE:
364 sr_info("Acquisition started.");
366 if (!devc->cancel_requested)
367 devc->state = STATE_STATUS_WAIT;
369 submit_request(sdi, STATE_STOP_CAPTURE);
371 case STATE_STOP_CAPTURE:
372 if (!devc->cancel_requested)
373 submit_request(sdi, STATE_LENGTH_REQUEST);
375 devc->state = STATE_IDLE;
377 case STATE_READ_PREPARE:
378 if (acq->mem_addr_next < acq->mem_addr_stop && !devc->cancel_requested)
379 submit_request(sdi, STATE_READ_REQUEST);
381 submit_request(sdi, STATE_READ_FINISH);
383 case STATE_READ_FINISH:
384 devc->state = STATE_IDLE;
387 sr_err("Unexpected device state %d.", devc->state);
388 devc->transfer_error = TRUE;
393 /* USB input transfer completion callback.
395 static void LIBUSB_CALL transfer_in_completed(struct libusb_transfer *transfer)
397 const struct sr_dev_inst *sdi;
398 struct dev_context *devc;
399 struct acquisition_state *acq;
401 sdi = transfer->user_data;
403 acq = devc->acquisition;
405 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
406 sr_err("Transfer from device failed (state %d): %s.",
407 devc->state, libusb_error_name(transfer->status));
408 devc->transfer_error = TRUE;
411 if ((devc->state & STATE_EXPECT_RESPONSE) == 0) {
412 sr_err("Unexpected completion of input transfer (state %d).",
414 devc->transfer_error = TRUE;
418 if (acq->reg_seq_pos < acq->reg_seq_len && !devc->cancel_requested) {
419 /* Complete register read sequence. */
420 if (read_reg_response(acq) != SR_OK) {
421 devc->transfer_error = TRUE;
424 /* Repeat until all queued registers have been read. */
425 if (++acq->reg_seq_pos < acq->reg_seq_len) {
427 submit_transfer(devc, acq->xfer_out);
432 switch (devc->state) {
433 case STATE_STATUS_REQUEST:
434 if (devc->cancel_requested)
435 submit_request(sdi, STATE_STOP_CAPTURE);
437 handle_status_response(sdi);
439 case STATE_LENGTH_REQUEST:
440 if (devc->cancel_requested)
441 submit_request(sdi, STATE_READ_FINISH);
443 handle_length_response(sdi);
445 case STATE_READ_REQUEST:
446 handle_read_response(sdi);
449 sr_err("Unexpected device state %d.", devc->state);
450 devc->transfer_error = TRUE;
455 /* Set up the acquisition state record.
457 static int init_acquisition_state(const struct sr_dev_inst *sdi)
459 struct dev_context *devc;
460 struct sr_usb_dev_inst *usb;
461 struct acquisition_state *acq;
466 if (devc->acquisition) {
467 sr_err("Acquisition still in progress?");
470 if (devc->cfg_clock_source == CLOCK_INTERNAL && devc->samplerate == 0) {
471 sr_err("Samplerate not set.");
475 acq = g_try_malloc0(sizeof(struct acquisition_state));
477 return SR_ERR_MALLOC;
479 acq->xfer_in = libusb_alloc_transfer(0);
482 return SR_ERR_MALLOC;
484 acq->xfer_out = libusb_alloc_transfer(0);
485 if (!acq->xfer_out) {
486 libusb_free_transfer(acq->xfer_in);
488 return SR_ERR_MALLOC;
491 libusb_fill_bulk_transfer(acq->xfer_out, usb->devhdl, EP_COMMAND,
492 (unsigned char *)acq->xfer_buf_out, 0,
493 &transfer_out_completed,
494 (struct sr_dev_inst *)sdi, USB_TIMEOUT_MS);
496 libusb_fill_bulk_transfer(acq->xfer_in, usb->devhdl, EP_REPLY,
497 (unsigned char *)acq->xfer_buf_in,
498 sizeof(acq->xfer_buf_in),
499 &transfer_in_completed,
500 (struct sr_dev_inst *)sdi, USB_TIMEOUT_MS);
502 if (devc->limit_msec > 0) {
503 acq->duration_max = devc->limit_msec;
504 sr_info("Acquisition time limit %" PRIu64 " ms.",
507 acq->duration_max = MAX_LIMIT_MSEC;
509 if (devc->limit_samples > 0) {
510 acq->samples_max = devc->limit_samples;
511 sr_info("Acquisition sample count limit %" PRIu64 ".",
512 devc->limit_samples);
514 acq->samples_max = MAX_LIMIT_SAMPLES;
516 if (devc->cfg_clock_source == CLOCK_INTERNAL) {
517 sr_info("Internal clock, samplerate %" PRIu64 ".",
519 /* Ramp up clock speed to enable samplerates above 100 MS/s. */
520 acq->clock_boost = (devc->samplerate > SR_MHZ(100));
522 /* If only one of the limits is set, derive the other one. */
523 if (devc->limit_msec == 0 && devc->limit_samples > 0)
524 acq->duration_max = devc->limit_samples
525 * 1000 / devc->samplerate + 1;
526 else if (devc->limit_samples == 0 && devc->limit_msec > 0)
527 acq->samples_max = devc->limit_msec
528 * devc->samplerate / 1000;
530 acq->clock_boost = TRUE;
532 if (devc->cfg_clock_edge == EDGE_POSITIVE)
533 sr_info("External clock, rising edge.");
535 sr_info("External clock, falling edge.");
538 acq->rle_enabled = devc->cfg_rle;
539 devc->acquisition = acq;
544 SR_PRIV int lwla_start_acquisition(const struct sr_dev_inst *sdi)
546 struct drv_context *drvc;
547 struct dev_context *devc;
549 const int poll_interval_ms = 100;
551 drvc = sdi->driver->context;
554 if (devc->state != STATE_IDLE) {
555 sr_err("Not in idle state, cannot start acquisition.");
558 devc->cancel_requested = FALSE;
559 devc->transfer_error = FALSE;
561 ret = init_acquisition_state(sdi);
565 ret = (*devc->model->setup_acquisition)(sdi);
567 sr_err("Failed to set up device for acquisition.");
568 clear_acquisition_state(sdi);
571 /* Register event source for asynchronous USB I/O. */
572 ret = usb_source_add(sdi->session, drvc->sr_ctx, poll_interval_ms,
573 &transfer_event, (struct sr_dev_inst *)sdi);
575 clear_acquisition_state(sdi);
578 ret = submit_request(sdi, STATE_START_CAPTURE);
581 /* Send header packet to the session bus. */
582 ret = std_session_send_df_header(sdi, LOG_PREFIX);
585 usb_source_remove(sdi->session, drvc->sr_ctx);
586 clear_acquisition_state(sdi);