mediatek-optical 1.0.0

MediaTek MT1959/MT1939 optical drive (BD/DVD) protocol: command encoding, identity and flash sequences over any SCSI transport, chip detection, hardware families, AES-CMAC integrity, family-gated updates and OEM image reconstruction. no_std by default.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
//! [`PreparedUpdate::flash`] against a simulated drive.

use std::cell::RefCell;
use std::rc::Rc;

use super::*;
use crate::drive::Error;
use crate::drive::{Data, Transport};
use crate::update::{FlashError, FlashRuntime, FlashTransport, Stage, Status, Verified};
use core::time::Duration;

/// Which transport a command came through.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Via {
    Reads,
    Writes,
}

/// A drive that programs a streamed image when its last chunk lands.
#[derive(Default)]
struct Drive {
    /// What READ BUFFER returns.
    flash: Vec<u8>,
    /// Streamed bytes.
    pending: Vec<u8>,
    /// Decrypt the streamed transfer before programming (the `enc` route).
    decrypts: bool,
    /// Every command: transport, CDB and data length.
    log: Vec<(Via, Vec<u8>, usize)>,
    /// Refuse this exact CDB.
    refuse: Option<Vec<u8>>,
    /// Multiple independent command failures for recovery boundary tests.
    refuse_commands: Vec<Vec<u8>>,
    /// TEST UNIT READY failures left once COMMIT was sent.
    busy: usize,
    /// Sense replies, in order; afterwards a clean `70 .. 00`.
    sense: Vec<Vec<u8>>,
    /// Flip this byte on read-back.
    corrupt: Option<usize>,
    /// Answer the read of the chunk at this offset short.
    short_at: Option<usize>,
    short_after_commit: bool,
    committed: bool,
    inquiry_revision: Option<[u8; 4]>,
}

impl Drive {
    fn running(image: &[u8]) -> Rc<RefCell<Self>> {
        Rc::new(RefCell::new(Self {
            flash: fixtures::drive_read(image),
            pending: vec![0xFF; layout::IMAGE_SIZE],
            ..Self::default()
        }))
    }

    fn program(&mut self) {
        let mut image = self.pending.clone();
        if self.decrypts {
            #[cfg(feature = "enc")]
            crate::enc::decrypt(&mut image).unwrap();
            #[cfg(not(feature = "enc"))]
            panic!("encrypted test transport requires the enc feature");
        }
        let mirror = image[layout::BOOT_MIRROR.start..layout::BOOT_MIRROR.end()].to_vec();
        image[..layout::BOOT_PAGE.len].copy_from_slice(&mirror);
        // The drive keeps its own per-unit regions.
        for range in layout::DRIVE_WRITTEN {
            image[range.start..range.end()].copy_from_slice(&self.flash[range.start..range.end()]);
        }
        self.flash = image;
    }

    fn exec(&mut self, via: Via, cdb: &[u8], data: Data<'_>) -> Result<usize, &'static str> {
        if [
            crate::cdb::Prepare::ModeOne,
            crate::cdb::Prepare::ModeSix67,
            crate::cdb::Prepare::ModeOnePreserveBoot,
            crate::cdb::Prepare::ModeSix67PreserveBoot,
        ]
        .iter()
        .any(|prepare| cdb == prepare.command())
        {
            assert!(
                matches!(&data, Data::Out(bytes) if bytes.is_empty()),
                "PREPARE must retain zero-length data-out"
            );
        }
        let len = match &data {
            Data::None => 0,
            Data::In(buf) => buf.len(),
            Data::Out(bytes) => bytes.len(),
        };
        self.log.push((via, cdb.to_vec(), len));
        if self.refuse.as_deref() == Some(cdb) || self.refuse_commands.iter().any(|c| c == cdb) {
            return Err("refused");
        }
        match (cdb[0], data) {
            (0x12, Data::In(buf)) => {
                let mut inquiry = [0; crate::INQUIRY_LEN];
                inquiry[0] = 5;
                inquiry[4] = (crate::INQUIRY_LEN - 5) as u8;
                inquiry[8..36].copy_from_slice(
                    &self.flash[layout::DESCRIPTOR.start..layout::DESCRIPTOR.start + 28],
                );
                if let Some(revision) = self.inquiry_revision {
                    inquiry[32..36].copy_from_slice(&revision);
                }
                buf.copy_from_slice(&inquiry[..buf.len()]);
                Ok(buf.len())
            }
            (0x00, _) if self.committed && self.busy > 0 => {
                self.busy -= 1;
                Err("not ready")
            }
            (0x3B, Data::Out(bytes)) if cdb[1] == 0x06 => {
                let off = u32::from_be_bytes([0, cdb[3], cdb[4], cdb[5]]) as usize;
                self.pending[off..off + bytes.len()].copy_from_slice(bytes);
                if off + bytes.len() == layout::IMAGE_SIZE {
                    self.program();
                }
                Ok(bytes.len())
            }
            (0x3B, _) if cdb[1] == 0x07 => {
                self.committed = true;
                Ok(0)
            }
            (0x3C, Data::In(buf)) => {
                let off = u32::from_be_bytes([0, cdb[3], cdb[4], cdb[5]]) as usize;
                let n =
                    if self.short_at == Some(off) && (self.committed || !self.short_after_commit) {
                        buf.len() - 1
                    } else {
                        buf.len()
                    };
                buf[..n].copy_from_slice(&self.flash[off..off + n]);
                if let Some(at) = self.corrupt {
                    if (off..off + n).contains(&at) {
                        buf[at - off] ^= 0x40;
                    }
                }
                Ok(n)
            }
            (0x03, Data::In(buf)) => {
                let reply = if self.sense.is_empty() {
                    let mut clean = vec![0; 18];
                    clean[0] = 0x70;
                    clean
                } else {
                    self.sense.remove(0)
                };
                let n = reply.len().min(buf.len());
                buf[..n].copy_from_slice(&reply[..n]);
                Ok(n)
            }
            (_, Data::Out(bytes)) => Ok(bytes.len()),
            _ => Ok(0),
        }
    }
}

struct Handle(Rc<RefCell<Drive>>, Via);

impl Transport for Handle {
    type Error = &'static str;

    fn exec(&mut self, cdb: &[u8], data: Data<'_>) -> Result<usize, Self::Error> {
        self.0.borrow_mut().exec(self.1, cdb, data)
    }

    fn sense(&self) -> Option<(u8, u8, u8)> {
        None
    }
}

/// A fake clock that records every runtime event.
#[derive(Default)]
struct Clock {
    now: Duration,
    events: Vec<String>,
    progress: Vec<usize>,
}

impl FlashRuntime<&'static str> for Clock {
    fn elapsed(&self) -> Duration {
        self.now
    }
    fn sleep(&mut self, duration: Duration) {
        self.now += duration;
    }
    fn starting(&mut self, bytes: usize) {
        self.events.push(format!("starting {bytes}"));
    }
    fn progress(&mut self, written: usize, total: usize) {
        assert_eq!(total, layout::IMAGE_SIZE);
        self.progress.push(written);
    }
    fn commit_failed(&mut self, error: &Error<&'static str>) {
        self.events.push(format!("commit failed {error}"));
    }
    fn recovery_entry_failed(&mut self, error: &Error<&'static str>) {
        self.events.push(format!("recovery PREPARE failed {error}"));
    }
    fn commit_not_ready(&mut self, error: &Error<&'static str>) {
        self.events.push(format!("commit not ready {error}"));
    }
    fn status(&mut self, stage: Stage, status: Status<'_, &'static str>) {
        let status = match status {
            Status::Sense(t) => format!("sense {:02x}/{:02x}/{:02x}", t.0, t.1, t.2),
            Status::Unparseable(n) => format!("unparseable {n}"),
            Status::Failed(e) => format!("failed {e}"),
        };
        self.events.push(format!("{stage:?} {status}"));
    }
    fn uploaded(&mut self, bytes: usize) {
        self.events.push(format!("uploaded {bytes}"));
    }
    fn poll_failed(&mut self, _elapsed: Duration, _error: &Error<&'static str>) {
        self.events.push("poll failed".into());
    }
    fn verifying(&mut self) {
        self.events.push("verifying".into());
    }
    fn unverified(&mut self, offset: usize, length: usize, error: &Error<&'static str>) {
        self.events
            .push(format!("unverified {offset:#x} {length:#x} {error}"));
    }
}

const PROTECTED: usize = (fixtures::SIGNED.1 - fixtures::SIGNED.0 + 1) as usize;

fn run(
    drive: &Rc<RefCell<Drive>>,
    update: &PreparedUpdate,
    clock: &mut Clock,
) -> Result<Verified, FlashError<&'static str>> {
    let (mut reads, mut writes) = (
        Handle(drive.clone(), Via::Reads),
        Handle(drive.clone(), Via::Writes),
    );
    update.flash(
        FlashTransport {
            reads: &mut reads,
            writes: &mut writes,
        },
        clock,
    )
}

fn setup() -> (Rc<RefCell<Drive>>, PreparedUpdate, Vec<u8>) {
    let running = fixtures::image(&JB7, 1);
    let target = fixtures::image(&JB7, 2);
    let update = prepare(&target, &running).unwrap();
    (Drive::running(&running), update, target)
}

fn sense(key: u8, asc: u8) -> Vec<u8> {
    let mut s = vec![0; 18];
    s[0] = 0x70;
    s[2] = key;
    s[12] = asc;
    s
}

#[test]
fn flash_sends_the_oem_session_then_verifies() {
    let (drive, update, target) = setup();
    let mut clock = Clock::default();
    let verified = run(&drive, &update, &mut clock).unwrap();
    assert_eq!(
        verified,
        Verified {
            checked: PROTECTED,
            ranges: 1
        }
    );
    let log = drive.borrow().log.clone();
    let mut want: Vec<(Via, Vec<u8>, usize)> = vec![
        (Via::Writes, cdb::probe().to_vec(), 0x100),
        (Via::Writes, cdb::test_unit_ready().to_vec(), 0),
        (Via::Writes, cdb::enter_update().to_vec(), 0),
    ];
    for i in 0..128u32 {
        want.push((
            Via::Writes,
            cdb::transfer(i * 0x4000, 0x4000).to_vec(),
            0x4000,
        ));
    }
    want.extend([
        (Via::Writes, cdb::finish().to_vec(), 0),
        (Via::Reads, cdb::test_unit_ready().to_vec(), 0),
        (Via::Reads, cdb::request_sense().to_vec(), 16),
        (Via::Reads, cdb::test_unit_ready().to_vec(), 0),
        (Via::Reads, cdb::request_sense().to_vec(), 16),
    ]);
    for i in 0..128u32 {
        want.push((
            Via::Reads,
            cdb::read_memory(i * 0x4000, 0x4000).to_vec(),
            0x4000,
        ));
    }
    assert_eq!(log, want);
    assert_eq!(
        clock.events,
        [
            "starting 2097152",
            "Commit sense 00/00/00",
            "uploaded 2097152",
            "Settled sense 00/00/00",
            "verifying"
        ]
    );
    assert_eq!(clock.progress.len(), 128);
    assert_eq!(clock.progress[0], 0x4000);
    assert_eq!(*clock.progress.last().unwrap(), layout::IMAGE_SIZE);
    // What the drive stores outside its boot page and per-unit regions.
    assert_eq!(
        drive.borrow().flash[0x1000..0x1D_8000],
        target[0x1000..0x1D_8000]
    );
}

#[test]
fn a_failed_entry_sends_no_firmware() {
    let (drive, update, _) = setup();
    drive.borrow_mut().refuse = Some(cdb::enter_update().to_vec());
    let error = run(&drive, &update, &mut Clock::default()).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Entry(Error::Transport("refused"))
    ));
    assert!(!drive
        .borrow()
        .log
        .iter()
        .any(|(_, c, _)| c[0] == 0x3B && c[1] == 0x06));
}

fn run_recovery_payload(
    drive: &Rc<RefCell<Drive>>,
    update: &PreparedUpdate,
    clock: &mut Clock,
) -> Result<Verified, FlashError<&'static str>> {
    let (mut reads, mut writes) = (
        Handle(drive.clone(), Via::Reads),
        Handle(drive.clone(), Via::Writes),
    );
    crate::update::flash::Payload {
        class: update.class(),
        image: &update.image,
        transfer: update.transfer(),
    }
    .flash(
        FlashTransport {
            reads: &mut reads,
            writes: &mut writes,
        },
        clock,
        crate::update::flash::ExecutionMode::Recovery,
        cdb::Prepare::ModeOne,
    )
}

#[test]
fn recovery_reports_failed_prepare_once_then_streams_and_verifies() {
    let (drive, update, _) = setup();
    drive.borrow_mut().refuse = Some(cdb::enter_update().to_vec());
    let mut clock = Clock::default();
    let verified = run_recovery_payload(&drive, &update, &mut clock).unwrap();
    assert!(verified.checked > 0);
    assert_eq!(
        clock
            .events
            .iter()
            .filter(|e| e.starts_with("recovery PREPARE failed"))
            .count(),
        1
    );
    let d = drive.borrow();
    assert_eq!(d.log[0].1, cdb::enter_update());
    assert_eq!(d.log[1].1, cdb::transfer(0, cdb::CHUNK as u16));
    assert_eq!(
        d.log
            .iter()
            .filter(|(_, c, _)| c == &cdb::enter_update())
            .count(),
        1
    );
    assert!(!d.log.iter().any(|(_, c, _)| c == &cdb::probe()));
}

#[test]
fn prepare_dialects_and_boot_policies_keep_flash_strict_and_recovery_single_attempt() {
    use crate::update::flash::{ExecutionMode, Payload};
    for prepare in [
        cdb::Prepare::ModeOne,
        cdb::Prepare::ModeSix67,
        cdb::Prepare::ModeOnePreserveBoot,
        cdb::Prepare::ModeSix67PreserveBoot,
    ] {
        for recovery in [false, true] {
            for refused in [false, true] {
                let (drive, update, _) = setup();
                if refused {
                    drive.borrow_mut().refuse = Some(prepare.command().to_vec());
                }
                let (mut reads, mut writes) = (
                    Handle(drive.clone(), Via::Reads),
                    Handle(drive.clone(), Via::Writes),
                );
                let mut clock = Clock::default();
                let result = Payload {
                    class: update.class(),
                    image: update.image(),
                    transfer: update.transfer(),
                }
                .flash(
                    FlashTransport {
                        reads: &mut reads,
                        writes: &mut writes,
                    },
                    &mut clock,
                    if recovery {
                        ExecutionMode::Recovery
                    } else {
                        ExecutionMode::Flash
                    },
                    prepare,
                );
                let log = &drive.borrow().log;
                assert_eq!(
                    log.iter()
                        .filter(|(_, cmd, _)| cmd == &prepare.command())
                        .count(),
                    1
                );
                if refused && !recovery {
                    assert!(matches!(result, Err(FlashError::Entry(_))));
                    assert!(!log
                        .iter()
                        .any(|(_, cmd, _)| cmd == &cdb::transfer(0, cdb::CHUNK as u16)));
                } else {
                    assert!(result.unwrap().checked > 0);
                }
                assert_eq!(
                    clock
                        .events
                        .iter()
                        .filter(|e| e.starts_with("recovery PREPARE failed"))
                        .count(),
                    usize::from(refused && recovery)
                );
            }
        }
    }
}

#[test]
fn recovery_prepare_exception_never_ignores_or_retries_a_failed_chunk() {
    let (drive, update, _) = setup();
    let failed_chunk = cdb::transfer(0x4000, 0x4000).to_vec();
    drive.borrow_mut().refuse_commands = vec![cdb::enter_update().to_vec(), failed_chunk.clone()];
    let error = run_recovery_payload(&drive, &update, &mut Clock::default()).unwrap_err();
    assert!(matches!(error, FlashError::Transfer { offset: 0x4000, .. }));
    let d = drive.borrow();
    assert_eq!(
        d.log.iter().filter(|(_, c, _)| c == &failed_chunk).count(),
        1
    );
    assert!(!d.log.iter().any(|(_, c, _)| c == &cdb::finish()));
    assert_eq!(d.log.last().unwrap().1, failed_chunk);
}

#[test]
fn a_failed_chunk_stops_before_commit() {
    let (drive, update, _) = setup();
    drive.borrow_mut().refuse = Some(cdb::transfer(0x8000, 0x4000).to_vec());
    let error = run(&drive, &update, &mut Clock::default()).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Transfer {
            offset: 0x8000,
            length: 0x4000,
            ..
        }
    ));
    let log = &drive.borrow().log;
    assert_eq!(log.last().unwrap().1, cdb::transfer(0x8000, 0x4000));
    assert!(!log.iter().any(|(_, c, _)| *c == cdb::finish()));
}

#[test]
fn a_commit_error_goes_on_to_the_checks() {
    let (drive, update, _) = setup();
    drive.borrow_mut().refuse = Some(cdb::finish().to_vec());
    let mut clock = Clock::default();
    run(&drive, &update, &mut clock).unwrap();
    assert_eq!(
        clock.events[1],
        "commit failed transport error: \"refused\""
    );
}

#[test]
fn a_fault_sense_fails_after_commit_and_after_settling() {
    let (drive, update, _) = setup();
    drive.borrow_mut().sense = vec![sense(0x04, 0x44)];
    let error = run(&drive, &update, &mut Clock::default()).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Fault {
            stage: Stage::Commit,
            sense: (0x04, 0x44, 0)
        }
    ));

    let (drive, update, _) = setup();
    drive.borrow_mut().sense = vec![sense(0x06, 0x29), sense(0x03, 0x0C)];
    let mut clock = Clock::default();
    let error = run(&drive, &update, &mut clock).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Fault {
            stage: Stage::Settled,
            sense: (0x03, 0x0C, 0)
        }
    ));
    assert!(clock.events.contains(&"Commit sense 06/29/00".to_string()));
}

#[test]
fn unreadable_sense_is_reported_and_verification_decides() {
    let (drive, update, _) = setup();
    drive.borrow_mut().sense = vec![vec![0x12; 5]];
    let mut clock = Clock::default();
    run(&drive, &update, &mut clock).unwrap();
    assert!(clock.events.contains(&"Commit unparseable 5".to_string()));

    let (drive, update, _) = setup();
    drive.borrow_mut().refuse = Some(cdb::request_sense().to_vec());
    let mut clock = Clock::default();
    run(&drive, &update, &mut clock).unwrap();
    let failed = "failed transport error: \"refused\"";
    assert!(clock.events.contains(&format!("Commit {failed}")));
    assert!(clock.events.contains(&format!("Settled {failed}")));
}

/// A drive that stays busy for 110 s, longer than the old 45 s bound but
/// within one OEM command window, is not failed.
#[test]
fn readiness_waits_through_an_oem_command_window() {
    let (drive, update, _) = setup();
    // One failure for the post-commit check, then 220 polls of 0.5 s.
    drive.borrow_mut().busy = 221;
    let mut clock = Clock::default();
    run(&drive, &update, &mut clock).unwrap();
    assert_eq!(clock.now, Duration::from_secs(110));
    assert_eq!(
        clock.events[1],
        "commit not ready transport error: \"not ready\""
    );
    assert_eq!(
        clock.events.iter().filter(|e| *e == "poll failed").count(),
        220
    );
}

#[test]
fn readiness_gives_up_after_the_bound() {
    let (drive, update, _) = setup();
    drive.borrow_mut().busy = usize::MAX;
    let mut clock = Clock::default();
    let error = run(&drive, &update, &mut clock).unwrap_err();
    assert!(matches!(
        error,
        FlashError::ReadyTimeout(Error::Transport("not ready"))
    ));
    assert_eq!(clock.now, Duration::from_secs(120));
    assert_eq!(DriveClass::Mt19.ready_timeout(), Duration::from_secs(120));
    assert!(DriveClass::Mt19.ready_timeout() >= Duration::from_secs(100));
    // No read-back of a drive that never settled.
    assert!(!drive
        .borrow()
        .log
        .iter()
        .any(|(_, c, _)| c[..] == cdb::read_memory(0, 0x4000)));
}

#[test]
fn a_protected_difference_fails() {
    let (drive, update, _) = setup();
    drive.borrow_mut().corrupt = Some(0x2_0010);
    let error = run(&drive, &update, &mut Clock::default()).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Mismatch {
            address: 0x2_0010,
            differing: 1,
            checked: PROTECTED,
            ..
        }
    ));
}

#[test]
fn differences_outside_the_protected_ranges_pass() {
    for at in [0x800, 0x5_0000, layout::CALIBRATION.start + 4] {
        let (drive, update, _) = setup();
        drive.borrow_mut().corrupt = Some(at);
        run(&drive, &update, &mut Clock::default()).unwrap();
    }
}

#[test]
fn an_unreadable_protected_chunk_is_incomplete() {
    let (drive, update, _) = setup();
    drive.borrow_mut().short_at = Some(0x1_4000);
    let mut clock = Clock::default();
    let error = run(&drive, &update, &mut clock).unwrap_err();
    assert!(matches!(
        error,
        FlashError::Incomplete {
            unverified: 1,
            checked
        } if checked == PROTECTED - 0x4000
    ));
    assert!(clock.events.contains(
        &"unverified 0x14000 0x4000 short transfer: expected 16384 bytes, got 16383".to_string()
    ));

    let (drive, update, _) = setup();
    drive.borrow_mut().short_at = Some(0x4_0000);
    run(&drive, &update, &mut Clock::default()).unwrap();
}

#[cfg(feature = "enc")]
#[test]
fn an_encrypted_transfer_verifies_the_plaintext() {
    let (drive, update, target) = setup();
    let update = update.encrypted();
    assert_ne!(update.transfer(), &target[..]);
    assert_eq!(update.image(), &target[..]);
    drive.borrow_mut().decrypts = true;
    run(&drive, &update, &mut Clock::default()).unwrap();
    let first = drive.borrow().pending[..16].to_vec();
    assert_eq!(first, update.transfer()[..16]);
}

#[test]
fn unreadable_chunk_before_protected_ranges_does_not_invalidate_later_reads() {
    let (drive, update, _) = setup();
    drive.borrow_mut().short_at = Some(0x4000);
    let mut clock = Clock::default();
    let verified = run(&drive, &update, &mut clock).unwrap();
    assert_eq!(verified.checked, PROTECTED);
    assert!(!clock
        .events
        .iter()
        .any(|event| event.starts_with("unverified")));
}

fn run_completed(
    drive: &Rc<RefCell<Drive>>,
    update: &PreparedUpdate,
    mode: crate::update::flash::ExecutionMode,
) -> Result<crate::update::Completion, FlashError<&'static str>> {
    let mut reads = Handle(drive.clone(), Via::Reads);
    let mut writes = Handle(drive.clone(), Via::Writes);
    crate::update::flash::Payload {
        class: update.class(),
        image: update.image(),
        transfer: update.transfer(),
    }
    .flash_completed(
        FlashTransport {
            reads: &mut reads,
            writes: &mut writes,
        },
        &mut Clock::default(),
        mode,
        cdb::Prepare::ModeOne,
    )
}

#[test]
fn completion_requires_the_target_running_for_flash_and_recovery() {
    use crate::update::{flash::ExecutionMode, ReadbackQuality, StartupError};
    for mode in [ExecutionMode::Flash, ExecutionMode::Recovery] {
        let (drive, update, target) = setup();
        let completed = run_completed(&drive, &update, mode).unwrap();
        assert!(matches!(
            completed.readback,
            ReadbackQuality::Complete(Verified {
                checked: PROTECTED,
                ..
            })
        ));
        assert_eq!(
            completed.startup.descriptor(),
            &target[layout::DESCRIPTOR.start..layout::DESCRIPTOR.start + 0x58]
        );
        for revision in [*b"INTM", *b"BOOT"] {
            let (drive, update, _) = setup();
            drive.borrow_mut().inquiry_revision = Some(revision);
            assert!(matches!(
                run_completed(&drive, &update, mode),
                Err(FlashError::Startup(StartupError::TargetMismatch))
            ));
            assert!(
                drive.borrow().committed,
                "the bytes were transferred; readiness alone cannot prove startup"
            );
        }
    }
}

#[test]
fn limited_readback_requires_target_startup_and_remains_qualified() {
    use crate::update::{flash::ExecutionMode, ReadbackQuality, StartupError};
    for mode in [ExecutionMode::Flash, ExecutionMode::Recovery] {
        let (drive, update, _) = setup();
        drive.borrow_mut().short_at = Some(0x14000);
        let completed = run_completed(&drive, &update, mode).unwrap();
        assert!(
            matches!(completed.readback, ReadbackQuality::Limited { checked, unverified: 1 } if checked < PROTECTED)
        );
        assert!(matches!(
            completed.into_verified::<&str>(),
            Err(FlashError::Incomplete { unverified: 1, .. })
        ));
        let (drive, update, _) = setup();
        drive.borrow_mut().short_at = Some(0x14000);
        drive.borrow_mut().inquiry_revision = Some(*b"INTM");
        assert!(matches!(
            run_completed(&drive, &update, mode),
            Err(FlashError::Startup(StartupError::TargetMismatch))
        ));
    }
}

#[test]
fn completion_rejects_same_revision_with_wrong_build_and_unreadable_descriptor() {
    use crate::update::{flash::ExecutionMode, StartupError};
    for mode in [ExecutionMode::Flash, ExecutionMode::Recovery] {
        let (drive, update, _) = setup();
        // Outside the fixture's CMAC range: startup must independently compare build metadata.
        drive.borrow_mut().corrupt = Some(layout::DESCRIPTOR.start + 0x30);
        assert!(matches!(
            run_completed(&drive, &update, mode),
            Err(FlashError::Startup(StartupError::TargetMismatch))
        ));
        let (drive, update, _) = setup();
        drive.borrow_mut().short_at = Some(layout::DESCRIPTOR.start);
        drive.borrow_mut().short_after_commit = true;
        let result = run_completed(&drive, &update, mode);
        assert!(
            matches!(result, Err(FlashError::Startup(StartupError::Read(_)))),
            "{result:?}"
        );
    }
}

#[test]
fn completion_never_probes_startup_after_partial_write_or_corrupt_readback() {
    use crate::update::flash::ExecutionMode;
    for mode in [ExecutionMode::Flash, ExecutionMode::Recovery] {
        let (drive, update, _) = setup();
        drive.borrow_mut().refuse =
            Some(cdb::transfer(0x4000, update.class().chunk() as u16).to_vec());
        assert!(matches!(
            run_completed(&drive, &update, mode),
            Err(FlashError::Transfer { .. })
        ));
        assert!(!drive.borrow().log.iter().any(|(_, cdb, _)| cdb[0] == 0x12));
        let (drive, update, _) = setup();
        drive.borrow_mut().corrupt = Some(fixtures::SIGNED.0 as usize);
        assert!(matches!(
            run_completed(&drive, &update, mode),
            Err(FlashError::Mismatch { .. })
        ));
        assert!(!drive.borrow().log.iter().any(|(_, cdb, _)| cdb[0] == 0x12));
    }
}