flashthing 0.2.2

tool for flashing your Spotify Car Thing
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
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
use std::{io::Read, sync::Arc, thread::sleep, time::Duration};

use rusb::{Context, DeviceHandle, Direction, UsbContext};

use crate::{
  ADDR_BL2, ADDR_TMP, AMLC_AMLS_BLOCK_LENGTH, AMLC_MAX_BLOCK_LENGTH, AMLC_MAX_TRANSFER_LENGTH, BL2_BIN, BOOTLOADER_BIN,
  Callback, Error, Event, FLAG_KEEP_POWER_ON, PART_SECTOR_SIZE, PRODUCT_ID, REQ_BULKCMD, REQ_GET_AMLC,
  REQ_IDENTIFY_HOST, REQ_READ_MEM, REQ_RUN_IN_ADDR, REQ_WR_LARGE_MEM, REQ_WRITE_AMLC, REQ_WRITE_MEM, Result,
  TRANSFER_BLOCK_SIZE, TRANSFER_SIZE_THRESHOLD, UNBRICK_BIN_ZIP, VENDOR_ID, flash::FlashProgress,
  partitions::PartitionInfo,
};

const COMMAND_TIMEOUT: Duration = Duration::from_secs(10);

#[derive(Debug)]
struct AmlInner {
  handle: DeviceHandle<Context>,
  interface_number: u8,
  endpoint_in: u8,
  endpoint_out: u8,
}

/// The main interface for interacting with Amlogic-based hardware
///
/// This provides low-level access to the Amlogic SoC on the Superbird device,
/// allowing for memory operations, partition management, and firmware flashing.
#[derive(Clone)]
pub struct AmlogicSoC {
  inner: Arc<AmlInner>,
}

impl AmlogicSoC {
  /// Initialize a connection to an Amlogic SoC device
  ///
  /// This will search for a connected device, put it in the correct mode if necessary,
  /// and establish a connection for flashing operations.
  ///
  /// # Parameters
  /// - `callback`: Optional callback function to receive status updates
  ///
  /// # Returns
  /// - `Result<Self>`: A connected AmlogicSoC instance or an error
  pub fn init(callback: Option<Callback>) -> Result<Self> {
    if let Some(callback) = &callback {
      callback(Event::FindingDevice);
    };

    let mode = find_device();
    if let Some(callback) = &callback {
      callback(Event::DeviceMode(mode));
    };

    match mode {
      DeviceMode::Usb => {
        tracing::info!("device booted in usb mode - moving to usb burn mode");
        let device = Self::connect(callback.clone())?;
        if let Some(callback) = &callback {
          callback(Event::Bl2Boot);
        };

        device.bl2_boot(None, None)?;
        drop(device);

        if let Some(callback) = &callback {
          callback(Event::Resetting);
        };

        tracing::debug!("device successfully moved to usb burn mode, sleeping then grabbing new handle");
        sleep(Duration::from_millis(5000));
      }
      DeviceMode::UsbBurn => tracing::info!("device found!"),
      DeviceMode::Normal => {
        tracing::error!(
          "device is booted in normal mode. make sure to power on the car thing while holding buttons 1 & 4"
        );
        return Err(Error::WrongMode);
      }
      DeviceMode::NotFound => {
        tracing::error!("device not found!! make sure to power on the car thing while holding buttons 1 & 4");
        return Err(Error::NotFound);
      }
    };

    let mut attempts = 0;
    while attempts < 3 {
      match Self::connect(callback.clone()) {
        Ok(dev) => return Ok(dev),
        Err(e) => {
          tracing::debug!("failed to connect to device: {}. Attempt {}/3", e, attempts + 1);
          attempts += 1;
          sleep(Duration::from_secs(1));
        }
      }
    }

    Self::connect(callback)
  }

  fn connect(callback: Option<Callback>) -> Result<Self> {
    tracing::debug!("connecting to Amlogic device");
    if let Some(callback) = &callback {
      callback(Event::Connecting);
    };

    let context = Context::new()?;
    let handle = {
      let device = context
        .devices()?
        .iter()
        .find(|device| {
          if let Ok(desc) = device.device_descriptor() {
            desc.vendor_id() == VENDOR_ID && desc.product_id() == PRODUCT_ID
          } else {
            false
          }
        })
        .ok_or_else(|| Error::InvalidOperation("Device not found".into()))?;
      device.open()?
    };

    handle.set_active_configuration(1)?;
    let interface_number: u8 = 0;
    handle.claim_interface(interface_number)?;

    let device = handle.device();
    let config_desc = device.active_config_descriptor()?;
    let interface = config_desc
      .interfaces()
      .find(|i| i.number() == interface_number)
      .ok_or_else(|| Error::InvalidOperation("Interface not found".into()))?;
    let descriptor = interface
      .descriptors()
      .next()
      .ok_or_else(|| Error::InvalidOperation("No alt setting".into()))?;
    let mut endpoint_in = None;
    let mut endpoint_out = None;
    for ep in descriptor.endpoint_descriptors() {
      match ep.direction() {
        Direction::In => endpoint_in = Some(ep.address()),
        Direction::Out => endpoint_out = Some(ep.address()),
      }
    }
    let endpoint_in = endpoint_in.ok_or_else(|| Error::InvalidOperation("IN endpoint not found".into()))?;
    let endpoint_out = endpoint_out.ok_or_else(|| Error::InvalidOperation("OUT endpoint not found".into()))?;
    tracing::info!("device connected, claiming interface {}", interface_number);
    if let Some(callback) = &callback {
      callback(Event::Connected);
    };

    Ok(Self {
      inner: Arc::new(AmlInner {
        handle,
        interface_number,
        endpoint_in,
        endpoint_out,
      }),
    })
  }

  /// Write data to device memory
  ///
  /// This writes a small amount of data (up to 64 bytes) to device memory.
  /// For larger transfers, use `write_large_memory` instead.
  ///
  /// # Parameters
  /// - `address`: The memory address to write to
  /// - `data`: The data to write, must be <= 64 bytes
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_simple_memory(&self, address: u32, data: &[u8]) -> Result<()> {
    tracing::debug!(
      "writing simple memory at address: {:#X}, length: {}",
      address,
      data.len()
    );
    if data.len() > 64 {
      return Err(Error::InvalidOperation("Maximum size of 64 bytes".into()));
    }
    let value = (address >> 16) as u16;
    let index = (address & 0xffff) as u16;
    self
      .inner
      .handle
      .write_control(0x40, REQ_WRITE_MEM, value, index, data, COMMAND_TIMEOUT)?;
    tracing::trace!(
      "write_control completed for write_simple_memory at address: {:#X}",
      address
    );
    Ok(())
  }

  /// Write arbitrary size data to device memory
  ///
  /// This breaks down larger transfers into multiple write_simple_memory operations.
  ///
  /// # Parameters
  /// - `address`: The memory address to write to
  /// - `data`: The data to write
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_memory(&self, address: u32, data: &[u8]) -> Result<()> {
    tracing::debug!(
      "writing memory starting at address: {:#X} with total length: {}",
      address,
      data.len()
    );
    let mut offset = 0;
    let length = data.len();
    while offset < length {
      let chunk_size = std::cmp::min(64, length - offset);
      self.write_simple_memory(address + offset as u32, &data[offset..offset + chunk_size])?;
      tracing::trace!(
        "chunk written for write_memory at address: {:#X}, new offset: {}",
        address,
        offset + chunk_size
      );
      offset += chunk_size;
    }
    Ok(())
  }

  /// Read a small amount of data from device memory
  ///
  /// This reads up to 64 bytes from device memory.
  /// For larger transfers, use `read_memory` instead.
  ///
  /// # Parameters
  /// - `address`: The memory address to read from
  /// - `length`: The number of bytes to read (must be <= 64)
  ///
  /// # Returns
  /// - `Result<Vec<u8>>`: The read data or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn read_simple_memory(&self, address: u32, length: usize) -> Result<Vec<u8>> {
    tracing::debug!(
      "reading simple memory at address: {:#X} with length: {}",
      address,
      length
    );
    if length == 0 {
      return Ok(vec![]);
    }
    if length > 64 {
      return Err(Error::InvalidOperation("Maximum size of 64 bytes".into()));
    }
    let value = (address >> 16) as u16;
    let index = (address & 0xffff) as u16;
    let mut buf = vec![0u8; length];
    let read = self
      .inner
      .handle
      .read_control(0xC0, REQ_READ_MEM, value, index, &mut buf, COMMAND_TIMEOUT)?;
    tracing::trace!(
      "read_control completed for read_simple_memory at address: {:#X}, bytes read: {}",
      address,
      read
    );
    if read != length {
      return Err(Error::InvalidOperation("Incomplete read".into()));
    }
    Ok(buf)
  }

  /// Read arbitrary size data from device memory
  ///
  /// This breaks down larger transfers into multiple read_simple_memory operations.
  ///
  /// # Parameters
  /// - `address`: The memory address to read from
  /// - `length`: The number of bytes to read
  ///
  /// # Returns
  /// - `Result<Vec<u8>>`: The read data or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn read_memory(&self, address: u32, length: usize) -> Result<Vec<u8>> {
    tracing::debug!("reading memory at address: {:#X} with length: {}", address, length);
    let mut data = vec![0u8; length];
    let mut offset = 0;
    while offset < length {
      let read_length = std::cmp::min(64, length - offset);
      let chunk = self.read_simple_memory(address + offset as u32, read_length)?;
      data[offset..offset + read_length].copy_from_slice(&chunk);
      tracing::trace!(
        "chunk read for read_memory at address: {:#X}, offset: {}",
        address,
        offset
      );
      offset += read_length;
    }
    Ok(data)
  }

  /// Execute code at the specified memory address
  ///
  /// # Parameters
  /// - `address`: The memory address to execute code from
  /// - `keep_power`: Whether to keep power on after execution
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn run(&self, address: u32, keep_power: Option<bool>) -> Result<()> {
    let keep_power = keep_power.unwrap_or(true);
    tracing::debug!("running at address: {:#X} with keep_power: {}", address, keep_power);
    let data = if keep_power {
      address | FLAG_KEEP_POWER_ON
    } else {
      address
    };
    let buffer = data.to_le_bytes();
    let value = (address >> 16) as u16;
    let index = (address & 0xffff) as u16;
    self
      .inner
      .handle
      .write_control(0x40, REQ_RUN_IN_ADDR, value, index, &buffer, COMMAND_TIMEOUT)?;
    tracing::trace!("run command sent at address: {:#X}", address);
    Ok(())
  }

  /// Identify the device
  ///
  /// # Returns
  /// - `Result<String>`: The device identification string or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn identify(&self) -> Result<String> {
    tracing::debug!("identifying device");
    let mut buf = [0u8; 8];
    let read = self
      .inner
      .handle
      .read_control(0xC0, REQ_IDENTIFY_HOST, 0, 0, &mut buf, COMMAND_TIMEOUT)?;
    tracing::trace!("identify response received: {:?} ({} bytes)", &buf, read);
    if read != 8 {
      return Err(Error::InvalidOperation("Failed to read identify data".into()));
    }
    Ok(String::from_utf8(buf.to_vec())?)
  }

  /// Write large blocks of data to device memory
  ///
  /// This is used for writing firmware images and other large data blocks.
  ///
  /// # Parameters
  /// - `memory_address`: The memory address to write to
  /// - `data`: The data to write
  /// - `block_length`: The size of each block to transfer
  /// - `append_zeros`: Whether to pad data with zeros to match block_length
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_large_memory(
    &self,
    memory_address: u32,
    data: &[u8],
    block_length: usize,
    append_zeros: bool,
  ) -> Result<()> {
    tracing::debug!(
      "writing large memory to address: {:#X} with data length: {}",
      memory_address,
      data.len()
    );

    let mut data_vec = data.to_vec();
    if append_zeros {
      let remainder = data_vec.len() % block_length;
      if remainder != 0 {
        let padding = block_length - remainder;
        data_vec.extend(vec![0u8; padding]);
      }
    } else if !data_vec.len().is_multiple_of(block_length) {
      return Err(Error::InvalidOperation(
        "Large Data must be a multiple of block length".into(),
      ));
    }

    let total_bytes = data_vec.len() as u32;
    let block_count = (data_vec.len() / block_length) as u16;
    let mut control_data = Vec::with_capacity(16);
    control_data.extend_from_slice(&memory_address.to_le_bytes());
    control_data.extend_from_slice(&total_bytes.to_le_bytes());
    control_data.extend_from_slice(&0u32.to_le_bytes());
    control_data.extend_from_slice(&0u32.to_le_bytes());

    tracing::trace!("writing control data: {:?}", &control_data);
    self.inner.handle.write_control(
      0x40,
      REQ_WR_LARGE_MEM,
      block_length as u16,
      block_count,
      &control_data,
      COMMAND_TIMEOUT,
    )?;

    let mut data_offset = 0;
    while data_offset < data_vec.len() {
      let end = data_offset + block_length;
      let chunk = &data_vec[data_offset..end];
      tracing::trace!(target: "flashthing::aml::write_large_memory", "writing actual data from offset: {:#X}", &data_offset);

      self
        .inner
        .handle
        .write_bulk(self.inner.endpoint_out, chunk, Duration::from_millis(2000))?;

      tracing::trace!(target: "flashthing::aml::write_large_memory", "wrote actual data from offset: {:#X}", &data_offset);

      data_offset += block_length;
    }

    Ok(())
  }

  /// Write large blocks of data directly to a disk address with progress tracking
  ///
  /// # Parameters
  /// - `disk_address`: The disk address to write to
  /// - `reader`: A reader providing the data to write
  /// - `data_size`: The total size of data to write
  /// - `block_length`: The size of each block to transfer
  /// - `append_zeros`: Whether to pad data with zeros to match block_length
  /// - `progress_callback`: Function to call with progress updates
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_large_memory_to_disk<R: std::io::Read, F: Fn(FlashProgress)>(
    &self,
    disk_address: u32,
    reader: &mut R,
    data_size: usize,
    block_length: usize,
    append_zeros: bool,
    progress_callback: F,
  ) -> Result<()> {
    tracing::debug!("streaming {} bytes to disk address: {:#X}", data_size, disk_address);

    let start_time = std::time::Instant::now();
    let mut total_chunks = 0;
    let mut avg_chunk_time_secs = 0.0;

    // needed for write operations
    self.bulkcmd("mmc dev 1")?;
    self.bulkcmd("amlmmc key")?;

    let total_len = data_size;
    let max_bytes_per_transfer = TRANSFER_SIZE_THRESHOLD;
    let mut offset = 0;
    let mut buffer = vec![0u8; max_bytes_per_transfer];

    while offset < total_len {
      let chunk_start_time = std::time::Instant::now();

      let remaining = total_len - offset;
      let write_length = std::cmp::min(remaining, max_bytes_per_transfer);

      let data_slice = &mut buffer[..write_length];
      reader.read_exact(data_slice)?;

      self.write_large_memory(ADDR_TMP, &buffer[..write_length], block_length, append_zeros)?;

      let start_time_cmd = std::time::Instant::now();
      let mut retries = 0;
      let max_retries = 3;

      loop {
        match self.bulkcmd(&format!(
          "mmc write {:#X} {:#X} {:#X}",
          ADDR_TMP,
          (disk_address as usize + offset) / 512,
          write_length / 512
        )) {
          Ok(_) => {
            let elapsed = start_time_cmd.elapsed();
            if elapsed > Duration::from_millis(3000) {
              tracing::debug!("mmc write command took {}ms, cooling down for 5s", elapsed.as_millis());
              sleep(Duration::from_secs(5));
            }
            break;
          }
          Err(e) => {
            retries += 1;
            if retries >= max_retries {
              return Err(e);
            }
            sleep(Duration::from_secs(5)); // cooldown after error
          }
        }
      }

      let chunk_time = chunk_start_time.elapsed();
      let chunk_time_secs = chunk_time.as_secs_f64();
      total_chunks += 1;
      if total_chunks == 1 {
        avg_chunk_time_secs = chunk_time_secs;
      } else {
        avg_chunk_time_secs = avg_chunk_time_secs + (chunk_time_secs - avg_chunk_time_secs) / total_chunks as f64;
      }

      offset += write_length;
      let progress_percent = offset as f64 / total_len as f64 * 100.0;

      let elapsed = start_time.elapsed();
      let elapsed_secs = elapsed.as_secs_f64();
      let bytes_per_sec = if elapsed_secs > 0.0 {
        offset as f64 / elapsed_secs
      } else {
        offset as f64
      };

      let remaining_bytes = total_len - offset;
      let eta_secs = if bytes_per_sec > 0.0 {
        remaining_bytes as f64 / bytes_per_sec
      } else {
        0.0
      };

      tracing::info!(
        "progress: {:.1}% | elapsed: {:.1}s | eta: {:.1}s | rate: {:.2} KB/s | avg chunk: {:.1}s | avg rate: {:.2} KB/s",
        progress_percent,
        elapsed_secs,
        eta_secs,
        write_length as f64 / chunk_time_secs / 1024.0,
        avg_chunk_time_secs,
        bytes_per_sec / 1024.0
      );

      progress_callback(FlashProgress {
        percent: progress_percent,
        elapsed: elapsed_secs * 1000.0,
        eta: eta_secs * 1000.0,
        rate: write_length as f64 / chunk_time_secs / 1024.0,
        avg_chunk_time: avg_chunk_time_secs * 1000.0,
        avg_rate: bytes_per_sec / 1024.0,
      });
    }

    let total_elapsed = start_time.elapsed();
    let total_elapsed_secs = total_elapsed.as_secs_f64();
    let avg_bytes_per_sec = if total_elapsed_secs > 0.0 {
      total_len as f64 / total_elapsed_secs
    } else {
      total_len as f64
    };

    tracing::info!(
      "Transfer complete | total time: {:?} | avg rate: {:.2} KB/s",
      total_elapsed,
      avg_bytes_per_sec / 1024.0
    );

    Ok(())
  }

  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_amlc_data(&self, offset: u32, data: &[u8]) -> Result<()> {
    tracing::debug!("writing amlc data at offset: {:#X} with length: {}", offset, data.len());

    self.inner.handle.write_control(
      0x40,
      REQ_WRITE_AMLC,
      (offset / AMLC_AMLS_BLOCK_LENGTH as u32) as u16,
      (data.len() - 1) as u16,
      &[],
      COMMAND_TIMEOUT,
    )?;
    tracing::trace!("amlc header sent for data write at offset: {:#X}", offset);

    let max_chunk_size = AMLC_MAX_BLOCK_LENGTH;
    let mut data_offset = 0;
    let write_length = data.len();
    let mut remaining = write_length;

    let bulk_timeout = Duration::from_millis(1000);

    while remaining > 0 {
      let block_length = std::cmp::min(remaining, max_chunk_size);
      let chunk = &data[data_offset..data_offset + block_length];

      let mut retries = 0;
      let max_retries = 3;
      let mut success = false;

      while !success && retries < max_retries {
        match self
          .inner
          .handle
          .write_bulk(self.inner.endpoint_out, chunk, bulk_timeout)
        {
          Ok(written) => {
            if written == block_length {
              success = true;
              tracing::trace!(
                "bulk write in AMLC data, data_offset: {}, chunk: {}",
                data_offset,
                block_length
              );
            } else {
              tracing::warn!(
                "Incomplete bulk write: {} of {} bytes. Retry {}/{}",
                written,
                block_length,
                retries + 1,
                max_retries
              );
              retries += 1;
              sleep(Duration::from_millis(100));
            }
          }
          Err(e) => {
            tracing::warn!("Error in bulk write: {}. Retry {}/{}", e, retries + 1, max_retries);
            retries += 1;
            sleep(Duration::from_millis(100));

            if retries >= max_retries {
              return Err(Error::UsbError(e));
            }
          }
        }
      }

      data_offset += block_length;
      remaining -= block_length;

      sleep(Duration::from_millis(10));
    }

    let mut ack_buf = [0u8; 16];
    let mut retries = 0;
    let max_retries = 3;
    let mut read = 0;

    while retries < max_retries {
      match self
        .inner
        .handle
        .read_bulk(self.inner.endpoint_in, &mut ack_buf, bulk_timeout)
      {
        Ok(bytes_read) => {
          read = bytes_read;
          if read >= 4 {
            break;
          }
          tracing::warn!("short ack read: {} bytes. retry {}/{}", read, retries + 1, max_retries);
        }
        Err(e) => {
          tracing::warn!("error reading ack: {}. retry {}/{}", e, retries + 1, max_retries);
        }
      }
      retries += 1;
      sleep(Duration::from_millis(100));
    }

    tracing::trace!("received amlc ack: {:?} ({} bytes)", &ack_buf[..read], read);

    if read < 4 {
      return Err(Error::InvalidOperation("no acknowledgment received".into()));
    }

    let ack = String::from_utf8(ack_buf[0..4].to_vec())?;
    if ack != "OKAY" {
      return Err(Error::InvalidOperation(format!("invalid amlc data write ack: {}", ack)));
    }

    Ok(())
  }

  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_amlc_data_packet(&self, seq: u8, amlc_offset: u32, data: &[u8]) -> Result<()> {
    tracing::debug!("writing amlc data packet, seq: {}, offset: {:#X}", seq, amlc_offset);

    let data_len = data.len();
    let max_transfer_length = AMLC_MAX_TRANSFER_LENGTH;
    let transfer_count = data_len.div_ceil(max_transfer_length);

    if data_len > 0 {
      let mut offset = 0;
      for i in 0..transfer_count {
        let write_length = std::cmp::min(max_transfer_length, data_len - offset);
        tracing::trace!(
          "sending amlc data packet chunk {}/{} at offset: {} with length: {}",
          i + 1,
          transfer_count,
          offset,
          write_length
        );

        self.write_amlc_data(offset as u32, &data[offset..offset + write_length])?;
        sleep(Duration::from_millis(50));

        offset += write_length;
      }
    }

    let checksum = self.amlc_checksum(data)?;

    let mut amlc_header = [0u8; 16];
    amlc_header[0..4].copy_from_slice(b"AMLS"); // ! This is AMLS not AMLC for final packet - do not change
    amlc_header[4] = seq;
    amlc_header[8..12].copy_from_slice(&checksum.to_le_bytes());

    let mut amlc_data = vec![0u8; AMLC_AMLS_BLOCK_LENGTH];
    amlc_data[0..16].copy_from_slice(&amlc_header);

    if data.len() > 16 {
      let copy_len = std::cmp::min(AMLC_AMLS_BLOCK_LENGTH - 16, data.len() - 16);
      amlc_data[16..16 + copy_len].copy_from_slice(&data[16..16 + copy_len]);
    }

    tracing::debug!("sending AMLS block with seq {} to offset {:#X}", seq, amlc_offset);
    self.write_amlc_data(amlc_offset, &amlc_data)?;

    Ok(())
  }

  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn get_boot_amlc(&self) -> Result<(u32, u32)> {
    tracing::debug!("getting boot amlc data");
    self.inner.handle.write_control(
      0x40,
      REQ_GET_AMLC,
      AMLC_AMLS_BLOCK_LENGTH as u16,
      0,
      &[],
      COMMAND_TIMEOUT,
    )?;
    tracing::trace!("amlc get request sent");
    let mut buf = vec![0u8; AMLC_AMLS_BLOCK_LENGTH];
    let read = self
      .inner
      .handle
      .read_bulk(self.inner.endpoint_in, &mut buf, Duration::from_secs(2))?;
    tracing::trace!("amlc data received, length: {}", read);
    if read < AMLC_AMLS_BLOCK_LENGTH {
      return Err(Error::InvalidOperation("No amlc data received".into()));
    }
    let tag = String::from_utf8(buf[0..4].to_vec())?;
    if tag != "AMLC" {
      return Err(Error::InvalidOperation(format!("invalid amlc request: {}", tag)));
    }
    let length = u32::from_le_bytes(buf[8..12].try_into()?);
    let offset = u32::from_le_bytes(buf[12..16].try_into()?);
    let mut ack = [0u8; 16];
    ack[..4].copy_from_slice(b"OKAY");
    self
      .inner
      .handle
      .write_bulk(self.inner.endpoint_out, &ack, Duration::from_secs(2))?;
    tracing::trace!("acknowledgment sent for amlc data");
    Ok((length, offset))
  }

  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  fn amlc_checksum(&self, data: &[u8]) -> Result<u32> {
    let mut checksum: u32 = 0;
    let mut offset = 0;
    let uint32_max = u32::MAX as u64 + 1;
    while offset < data.len() {
      let remaining = data.len() - offset;
      let val: u32 = if remaining >= 4 {
        let v = u32::from_le_bytes(data[offset..offset + 4].try_into()?);
        offset += 4;
        v
      } else if remaining >= 3 {
        let mut temp = [0u8; 4];
        temp[..remaining].copy_from_slice(&data[offset..]);
        offset += 3;
        u32::from_le_bytes(temp) & 0xffffff
      } else if remaining >= 2 {
        let v = u16::from_le_bytes(data[offset..offset + 2].try_into()?) as u32;
        offset += 2;
        v
      } else {
        let v = data[offset] as u32;
        offset += 1;
        v
      };
      checksum = ((checksum as u64 + (val as i64).unsigned_abs()) % uint32_max) as u32;
    }
    Ok(checksum)
  }

  /// Execute the BL2 boot sequence
  ///
  /// This boots the device using the specified BL2 and bootloader binaries.
  ///
  /// # Parameters
  /// - `bl2`: Optional BL2 binary data (uses built-in if None)
  /// - `bootloader`: Optional bootloader binary data (uses built-in if None)
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn bl2_boot(&self, bl2: Option<&[u8]>, bootloader: Option<&[u8]>) -> Result<()> {
    let bl2 = bl2.unwrap_or(BL2_BIN);
    let bootloader = bootloader.unwrap_or(BOOTLOADER_BIN);

    tracing::info!("sending bl2 binary to address {:#X}...", ADDR_BL2);
    self.write_large_memory(ADDR_BL2, bl2, 4096, true)?;

    tracing::info!("booting from bl2...");
    self.run(ADDR_BL2, Some(true))?;

    tracing::debug!("waiting for bootloader to initialize...");
    sleep(Duration::from_secs(2));

    let mut prev_length: u32 = 0;
    let mut prev_offset: u32 = 0;
    let mut seq: u8 = 0;

    let max_retries = 3;
    let max_iterations = 50;
    let mut iterations = 0;

    tracing::info!("starting AMLC data transfer sequence...");

    loop {
      if iterations >= max_iterations {
        return Err(Error::InvalidOperation("maximum iterations reached in bl2_boot".into()));
      }
      iterations += 1;

      let mut retry_count = 0;
      let (length, offset) = loop {
        match self.get_boot_amlc() {
          Ok(result) => break result,
          Err(e) => {
            retry_count += 1;
            if retry_count >= max_retries {
              tracing::error!("failed to get boot amlc data after {} attempts: {}", max_retries, e);
              return Err(e);
            }
            tracing::warn!("failed to get boot amlc, retry {}/{}: {}", retry_count, max_retries, e);
            sleep(Duration::from_millis(500));
          }
        }
      };

      tracing::debug!("amlc request: dataSize={}, offset={}, seq={}", length, offset, seq);

      if length == prev_length && offset == prev_offset {
        tracing::debug!("amlc transfer complete - received same length/offset twice");
        break;
      }

      prev_length = length;
      prev_offset = offset;

      if offset as usize >= bootloader.len() {
        tracing::warn!(
          "amlc requested offset {} exceeds bootloader size {}",
          offset,
          bootloader.len()
        );
        let empty_slice = &[];
        self.write_amlc_data_packet(seq, offset, empty_slice)?;
      } else {
        let actual_length = std::cmp::min(length as usize, bootloader.len() - offset as usize);
        let data_slice = &bootloader[offset as usize..offset as usize + actual_length];

        tracing::debug!("sending {} bytes at offset {} with seq {}", actual_length, offset, seq);
        self.write_amlc_data_packet(seq, offset, data_slice)?;
      }

      seq = seq.wrapping_add(1);
      sleep(Duration::from_millis(100));
    }

    tracing::info!("bl2 boot sequence completed successfully!");
    Ok(())
  }

  /// Send a bulk command to the device
  ///
  /// # Parameters
  /// - `command`: The command string to send
  ///
  /// # Returns
  /// - `Result<String>`: The command response or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn bulkcmd(&self, command: &str) -> Result<String> {
    tracing::debug!("sending bulk command: {:?}", command);
    let mut command = command.as_bytes().to_vec();
    command.push(0x00);
    self
      .inner
      .handle
      .write_control(0x40, REQ_BULKCMD, 0, 0, &command, COMMAND_TIMEOUT)?;
    tracing::trace!("bulk command control write completed");

    let mut buf = vec![0u8; 512];
    let read = self
      .inner
      .handle
      .read_bulk(self.inner.endpoint_in, &mut buf, COMMAND_TIMEOUT)?;
    tracing::trace!("bulk command response received, length: {}", read);

    if read == 0 {
      return Err(Error::InvalidOperation("No response received for bulk command".into()));
    }
    let slice = &buf[..read];
    let start = slice.iter().position(|&b| b != 0).unwrap_or(0);
    let end = slice.iter().rposition(|&b| b != 0).map(|pos| pos + 1).unwrap_or(0);
    let trimmed = &slice[start..end];
    let response = String::from_utf8(trimmed.to_vec())?;
    if !response.to_lowercase().contains("success") {
      return Err(Error::InvalidOperation(format!(
        "Bulk command failed, response did not contain 'success': {}",
        response
      )));
    }
    Ok(response)
  }

  /// Validate the size of a partition
  ///
  /// # Parameters
  /// - `part_name`: The name of the partition
  /// - `part_info`: Partition information
  ///
  /// # Returns
  /// - `Result<usize>`: The validated partition size or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn validate_partition_size(&self, part_name: &str, part_info: &PartitionInfo) -> Result<usize> {
    tracing::debug!("validating partition size for partition: {}", part_name);

    if part_name == "cache" {
      tracing::warn!("The \"cache\" partition is zero-length on superbird, you cannot read or write to it!");
      return Err(Error::InvalidOperation("Cache partition is zero-length".into()));
    }

    if part_name == "reserved" {
      tracing::warn!("The \"reserved\" partition cannot be read or written!");
      return Err(Error::InvalidOperation("Reserved partition cannot be accessed".into()));
    }

    let part_size = part_info.size * PART_SECTOR_SIZE;
    tracing::info!(
      "Validating size of partition: {} size: {:#x} {}MB - ...",
      part_name,
      part_size,
      part_size / 1024 / 1024
    );

    // Try to read the last sector
    match self.bulkcmd(&format!(
      "amlmmc read {} {:#x} {:#x} {:#x}",
      part_name,
      ADDR_TMP,
      part_size - PART_SECTOR_SIZE,
      PART_SECTOR_SIZE
    )) {
      Ok(_) => {
        tracing::info!(
          "Validating size of partition: {} size: {:#x} {}MB - OK",
          part_name,
          part_size,
          part_size / 1024 / 1024
        );
        Ok(part_size)
      }
      Err(e) => {
        tracing::warn!(
          "Validating size of partition: {} size: {:#x} {}MB - FAIL",
          part_name,
          part_size,
          part_size / 1024 / 1024
        );

        // Check if it's the data partition which can have an alternate size
        if part_name == "data"
          && let Some(alt_size_raw) = part_info.size_alt
        {
          let alt_size = alt_size_raw * PART_SECTOR_SIZE;
          tracing::info!(
            "Failed while fetching last chunk of partition: {}, trying alternate size: {:#x} {}MB",
            part_name,
            alt_size,
            alt_size / 1024 / 1024
          );

          tracing::info!(
            "Validating size of partition: {} size: {:#x} {}MB - ...",
            part_name,
            alt_size,
            alt_size / 1024 / 1024
          );

          match self.bulkcmd(&format!(
            "amlmmc read {} {:#x} {:#x} {:#x}",
            part_name,
            ADDR_TMP,
            alt_size - PART_SECTOR_SIZE,
            PART_SECTOR_SIZE
          )) {
            Ok(_) => {
              tracing::info!(
                "Validating size of partition: {} size: {:#x} {}MB - OK",
                part_name,
                alt_size,
                alt_size / 1024 / 1024
              );
              Ok(alt_size)
            }
            Err(e2) => {
              tracing::error!(
                "Validating size of partition: {} size: {:#x} {}MB - FAIL",
                part_name,
                alt_size,
                alt_size / 1024 / 1024
              );
              tracing::error!(
                "Failed while validating size of partition: {}, is partition size {:#x} correct? error: {}",
                part_name,
                alt_size,
                e2
              );
              Err(e2)
            }
          }
        } else {
          tracing::error!(
            "Failed while validating size of partition: {}, is partition size {:#x} correct? error: {}",
            part_name,
            part_size,
            e
          );
          Err(e)
        }
      }
    }
  }

  /// Write a boot hwpartition (boot0 / boot1) wholesale.
  ///
  /// Switches the eMMC to the named hwpart, single-shot DDR-stages the bytes,
  /// `mmc write`s them at LBA 0, then restores the user area selection.
  ///
  /// # Parameters
  /// - `hwpart`: 1 for boot0, 2 for boot1.
  /// - `data`: payload (signed boot.bin). Capped at `TRANSFER_SIZE_THRESHOLD`.
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_boot_partition(&self, hwpart: u8, data: &[u8]) -> Result<()> {
    if !(1..=2).contains(&hwpart) {
      return Err(Error::InvalidOperation(format!(
        "boot hwpart must be 1 or 2, got {hwpart}"
      )));
    }
    if data.len() > TRANSFER_SIZE_THRESHOLD {
      return Err(Error::InvalidOperation(format!(
        "boot partition payload {} bytes exceeds single-transfer cap {}",
        data.len(),
        TRANSFER_SIZE_THRESHOLD
      )));
    }

    tracing::info!("writing {} bytes to boot{}", data.len(), hwpart - 1);

    self.bulkcmd(&format!("mmc dev 1 {hwpart}"))?;
    self.bulkcmd("amlmmc key")?;

    self.write_large_memory(ADDR_TMP, data, TRANSFER_BLOCK_SIZE, true)?;

    let sector_count = data.len().div_ceil(PART_SECTOR_SIZE);
    self.bulkcmd(&format!("mmc write {ADDR_TMP:#X} 0 {sector_count:#X}"))?;

    self.bulkcmd("mmc dev 1 0")?;
    Ok(())
  }

  /// Stream bytes onto the user area at an absolute LBA, chunked with progress.
  ///
  /// Same DDR-stage + `mmc write` loop as `write_large_memory_to_disk`, but
  /// takes the LBA directly (no byte->sector conversion at the call site) and
  /// pins hwpart 0 up front so a prior `mmc dev 1 N` for a boot partition
  /// doesn't leak into the write.
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn write_user_area<R: Read, F: Fn(FlashProgress)>(
    &self,
    lba_offset: u32,
    mut reader: R,
    data_size: usize,
    progress_callback: F,
  ) -> Result<()> {
    tracing::info!(
      "streaming {} bytes to user area starting at LBA {}",
      data_size,
      lba_offset
    );

    let start_time = std::time::Instant::now();
    let mut total_chunks = 0;
    let mut avg_chunk_time_secs = 0.0;

    self.bulkcmd("mmc dev 1 0")?;
    self.bulkcmd("amlmmc key")?;

    let max_bytes_per_transfer = TRANSFER_SIZE_THRESHOLD;
    let mut offset = 0;
    let mut buffer = vec![0u8; max_bytes_per_transfer];

    while offset < data_size {
      let chunk_start_time = std::time::Instant::now();

      let remaining = data_size - offset;
      let write_length = std::cmp::min(remaining, max_bytes_per_transfer);

      let data_slice = &mut buffer[..write_length];
      reader.read_exact(data_slice)?;

      self.write_large_memory(ADDR_TMP, &buffer[..write_length], TRANSFER_BLOCK_SIZE, true)?;

      let chunk_lba = lba_offset as usize + offset / PART_SECTOR_SIZE;
      let chunk_sectors = write_length / PART_SECTOR_SIZE;

      let cmd_start = std::time::Instant::now();
      let mut retries = 0;
      let max_retries = 3;
      loop {
        match self.bulkcmd(&format!("mmc write {ADDR_TMP:#X} {chunk_lba:#X} {chunk_sectors:#X}")) {
          Ok(_) => {
            if cmd_start.elapsed() > Duration::from_millis(3000) {
              tracing::debug!("mmc write took {}ms, cooling down 5s", cmd_start.elapsed().as_millis());
              sleep(Duration::from_secs(5));
            }
            break;
          }
          Err(e) => {
            retries += 1;
            if retries >= max_retries {
              return Err(e);
            }
            tracing::warn!(
              "mmc write failed at LBA {chunk_lba:#X}, retrying ({}/{}): {}",
              retries,
              max_retries,
              e
            );
            sleep(Duration::from_secs(5));
          }
        }
      }

      let chunk_time_secs = chunk_start_time.elapsed().as_secs_f64();
      total_chunks += 1;
      if total_chunks == 1 {
        avg_chunk_time_secs = chunk_time_secs;
      } else {
        avg_chunk_time_secs += (chunk_time_secs - avg_chunk_time_secs) / total_chunks as f64;
      }

      offset += write_length;
      let progress_percent = offset as f64 / data_size as f64 * 100.0;
      let elapsed_secs = start_time.elapsed().as_secs_f64();
      let bytes_per_sec = if elapsed_secs > 0.0 {
        offset as f64 / elapsed_secs
      } else {
        offset as f64
      };
      let eta_secs = if bytes_per_sec > 0.0 {
        (data_size - offset) as f64 / bytes_per_sec
      } else {
        0.0
      };

      progress_callback(FlashProgress {
        percent: progress_percent,
        elapsed: elapsed_secs * 1000.0,
        eta: eta_secs * 1000.0,
        rate: write_length as f64 / chunk_time_secs / 1024.0,
        avg_chunk_time: avg_chunk_time_secs * 1000.0,
        avg_rate: bytes_per_sec / 1024.0,
      });
    }

    tracing::info!(
      "user-area write complete: {} bytes in {:?}",
      data_size,
      start_time.elapsed()
    );
    Ok(())
  }

  /// Restore a partition from a data source
  ///
  /// # Parameters
  /// - `part_name`: The name of the partition to restore
  /// - `part_size`: The size of the partition
  /// - `reader`: A reader providing the partition data
  /// - `file_size`: The size of the data being read
  /// - `progress_callback`: Function to call with progress updates
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn restore_partition<R: Read, F: Fn(FlashProgress)>(
    &self,
    part_name: &str,
    part_size: usize,
    mut reader: R,
    file_size: usize,
    progress_callback: F,
  ) -> Result<()> {
    tracing::debug!("restoring partition: {} with file size: {}", part_name, file_size);

    let adjusted_part_size = if part_name == "bootloader" {
      // Bootloader is only 2MB, though dumps may be zero-padded to 4MB
      2 * 1024 * 1024
    } else {
      part_size
    };

    if file_size > adjusted_part_size && part_name != "bootloader" {
      return Err(Error::InvalidOperation(format!(
        "file is larger than target partition: {} bytes vs {} bytes",
        file_size, adjusted_part_size
      )));
    }

    let start_time = std::time::Instant::now();
    let mut total_chunks = 0;
    let mut avg_chunk_time_secs = 0.0;

    self.bulkcmd("amlmmc key")?;

    let total_len = file_size;
    let max_bytes_per_transfer = TRANSFER_SIZE_THRESHOLD;
    let mut offset = 0;
    let mut buffer = vec![0u8; max_bytes_per_transfer];

    while offset < total_len {
      let chunk_start_time = std::time::Instant::now();

      let remaining = total_len - offset;
      let write_length = std::cmp::min(remaining, max_bytes_per_transfer);

      let data_slice = &mut buffer[..write_length];
      reader.read_exact(data_slice)?;

      self.write_large_memory(ADDR_TMP, &buffer[..write_length], TRANSFER_BLOCK_SIZE, true)?;

      let start_time_cmd = std::time::Instant::now();
      let mut retries = 0;
      let max_retries = 3;

      // Special handling for bootloader partition
      if part_name == "bootloader" {
        // Bootloader writes always cause timeout - this is expected
        match self.bulkcmd(&format!(
          "amlmmc write {} {:#x} {:#x} {:#x}",
          part_name, ADDR_TMP, offset, write_length
        )) {
          Ok(_) => tracing::debug!("bootloader write succeeded unexpectedly"),
          Err(e) => tracing::debug!("expected timeout for bootloader write: {}", e),
        }
        sleep(Duration::from_secs(2)); // Allow time for write to complete
      } else {
        loop {
          match self.bulkcmd(&format!(
            "amlmmc write {} {:#x} {:#x} {:#x}",
            part_name, ADDR_TMP, offset, write_length
          )) {
            Ok(_) => {
              let elapsed = start_time_cmd.elapsed();
              if elapsed > Duration::from_millis(3000) {
                tracing::debug!("write command took {}ms, cooling down for 5s", elapsed.as_millis());
                sleep(Duration::from_secs(5));
              }
              break;
            }
            Err(e) => {
              retries += 1;
              if retries >= max_retries {
                return Err(e);
              }
              tracing::warn!("write command failed, retrying ({}/{}): {}", retries, max_retries, e);
              sleep(Duration::from_secs(5)); // cooldown after error
            }
          }
        }
      }

      let chunk_time = chunk_start_time.elapsed();
      let chunk_time_secs = chunk_time.as_secs_f64();
      total_chunks += 1;
      if total_chunks == 1 {
        avg_chunk_time_secs = chunk_time_secs;
      } else {
        avg_chunk_time_secs = avg_chunk_time_secs + (chunk_time_secs - avg_chunk_time_secs) / total_chunks as f64;
      }

      offset += write_length;
      let progress_percent = offset as f64 / total_len as f64 * 100.0;

      let elapsed = start_time.elapsed();
      let elapsed_secs = elapsed.as_secs_f64();
      let bytes_per_sec = if elapsed_secs > 0.0 {
        offset as f64 / elapsed_secs
      } else {
        offset as f64
      };

      let remaining_bytes = total_len - offset;
      let eta_secs = if bytes_per_sec > 0.0 {
        remaining_bytes as f64 / bytes_per_sec
      } else {
        0.0
      };

      tracing::info!(
        "progress: {:.1}% | elapsed: {:.1}s | eta: {:.1}s | rate: {:.2} KB/s | avg chunk: {:.1}s | avg rate: {:.2} KB/s",
        progress_percent,
        elapsed_secs,
        eta_secs,
        write_length as f64 / chunk_time_secs / 1024.0,
        avg_chunk_time_secs,
        bytes_per_sec / 1024.0
      );

      progress_callback(FlashProgress {
        percent: progress_percent,
        elapsed: elapsed_secs * 1000.0,
        eta: eta_secs * 1000.0,
        rate: write_length as f64 / chunk_time_secs / 1024.0,
        avg_chunk_time: avg_chunk_time_secs * 1000.0,
        avg_rate: bytes_per_sec / 1024.0,
      });
    }

    let total_elapsed = start_time.elapsed();
    let total_elapsed_secs = total_elapsed.as_secs_f64();
    let avg_bytes_per_sec = if total_elapsed_secs > 0.0 {
      total_len as f64 / total_elapsed_secs
    } else {
      total_len as f64
    };

    tracing::info!(
      "partition restore complete | total time: {:?} | avg rate: {:.2} KB/s",
      total_elapsed,
      avg_bytes_per_sec / 1024.0
    );

    Ok(())
  }

  /// Execute the unbrick procedure
  ///
  /// This writes the emergency unbrick image to the device.
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  #[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
  pub fn unbrick(&self) -> Result<()> {
    tracing::info!("starting unbrick procedure...");

    let cursor = std::io::Cursor::new(UNBRICK_BIN_ZIP);

    let mut archive = match zip::ZipArchive::new(cursor) {
      Ok(archive) => archive,
      Err(e) => {
        tracing::error!("failed to open unbrick zip archive: {}", e);
        return Err(Error::Zip(e));
      }
    };

    let mut file = match archive.by_name("unbrick.bin") {
      Ok(file) => file,
      Err(e) => {
        tracing::error!("failed to find unbrick.bin in zip archive: {}", e);
        return Err(Error::Zip(e));
      }
    };

    let file_size = file.size() as usize;
    self.write_large_memory_to_disk(0, &mut file, file_size, TRANSFER_BLOCK_SIZE, true, |progress| {
      tracing::info!(
        "unbrick progress: {:.1}% | elapsed: {:.1}s | eta: {:.1}s | rate: {:.2} KB/s | avg rate: {:.2} KB/s",
        progress.percent,
        progress.elapsed,
        progress.eta,
        progress.rate,
        progress.avg_rate
      );
    })?;

    tracing::info!("unbrick procedure completed successfully!");
    Ok(())
  }

  /// Set up the host environment for USB access
  ///
  /// On Linux, this creates udev rules to allow access to the device.
  ///
  /// # Returns
  /// - `Result<()>`: Success or an error
  pub fn host_setup() -> Result<()> {
    #[cfg(target_os = "linux")]
    crate::setup::setup_host_linux()?;

    Ok(())
  }
}

impl Drop for AmlogicSoC {
  fn drop(&mut self) {
    match self.inner.handle.release_interface(self.inner.interface_number) {
      Ok(()) => tracing::trace!("successfully dropped usb interface"),
      Err(err) => tracing::warn!("failed to release usb interface: {:?}", err),
    }
  }
}

/// The current mode of the Superbird device
///
/// The device can be in different modes depending on how it was powered on
/// and what stage of the boot process it's in.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum DeviceMode {
  /// Normal operating mode (running regular firmware)
  Normal,
  /// USB mode (entered by holding buttons 1 & 4 during power-on)
  Usb,
  /// USB Burn mode (ready for flashing operations)
  UsbBurn,
  /// Device not detected
  NotFound,
}

#[cfg_attr(feature = "instrument", tracing::instrument(level = "trace", skip_all))]
fn find_device() -> DeviceMode {
  let context = match Context::new() {
    Ok(c) => c,
    Err(_) => return DeviceMode::NotFound,
  };
  let devices = match context.devices() {
    Ok(d) => d,
    Err(_) => return DeviceMode::NotFound,
  };
  for device in devices.iter() {
    let desc = match device.device_descriptor() {
      Ok(d) => d,
      Err(_) => continue,
    };
    // Match normal mode: vendor=0x18d1, product=0x4e40
    if desc.vendor_id() == 0x18d1 && desc.product_id() == 0x4e40 {
      tracing::debug!("Found device booted normally, with USB Gadget (adb/usbnet) enabled");
      return DeviceMode::Normal;
    }
    // Match USB burn/usb mode: vendor=0x1b8e, product=0xc003
    if desc.vendor_id() == 0x1b8e && desc.product_id() == 0xc003 {
      // Attempt to open device and read product string
      match device.open() {
        Ok(handle) => {
          // Common language ID
          let lang = handle.read_languages(COMMAND_TIMEOUT).unwrap_or_default();
          let Some(lang) = lang.first() else {
            tracing::debug!("Found device in USB Burn Mode (unable to read product string)");
            return DeviceMode::UsbBurn;
          };

          let prod = handle
            .read_product_string(*lang, &desc, Duration::from_millis(100))
            .ok();
          if prod.as_deref() == Some("GX-CHIP") {
            tracing::debug!("Found device booted in USB Mode (buttons 1 & 4 held at boot)");
            return DeviceMode::Usb;
          } else {
            tracing::debug!("Found device booted in USB Burn Mode (ready for commands)");
            return DeviceMode::UsbBurn;
          }
        }
        Err(_) => {
          tracing::debug!("Found device in USB Burn Mode (unable to read product string)");
          return DeviceMode::UsbBurn;
        }
      }
    }
  }

  tracing::debug!("No device found!");
  DeviceMode::NotFound
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn test_amlogic_soc_connect() {
    let soc = AmlogicSoC::init(None);
    // This test will only pass if the device is connected
    assert!(soc.is_ok());
  }
}