nander-rs 0.5.5

Modern SPI NAND/NOR Flash programmer for CH341A with cross-platform GUI and comprehensive diagnostics
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

//! Read Flash Use Case
//!
//! Orchestrates reading data from flash memory.

use crate::domain::{
    bad_block::BadBlockTable, Address, BadBlockStrategy, FlashOperation, OobMode, Progress,
    ReadRequest,
};
use crate::error::Result;

/// Parameters for read operation
pub struct ReadParams {
    pub address: u32,
    pub length: u32,
    pub use_ecc: bool,
    /// Ignore ECC errors and continue reading (for data recovery)
    pub ignore_ecc_errors: bool,
    pub oob_mode: OobMode,
    pub bad_block_strategy: BadBlockStrategy,
    pub bbt: Option<BadBlockTable>,
    pub retry_count: u32,
}

/// Use case for reading data from flash
pub struct ReadFlashUseCase<F: FlashOperation> {
    flash: F,
}

impl<F: FlashOperation> ReadFlashUseCase<F> {
    /// Create a new read flash use case
    pub fn new(flash: F) -> Self {
        Self { flash }
    }

    /// Execute the read operation
    pub fn execute<P>(&mut self, params: ReadParams, on_progress: P) -> Result<Vec<u8>>
    where
        P: Fn(Progress),
    {
        let request = ReadRequest {
            address: Address::new(params.address),
            length: params.length,
            use_ecc: params.use_ecc,
            ignore_ecc_errors: params.ignore_ecc_errors,
            oob_mode: params.oob_mode,
            bad_block_strategy: params.bad_block_strategy,
            bbt: params.bbt,
            retry_count: params.retry_count,
        };

        self.flash.read(request, &on_progress)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::domain::{EraseRequest, FlashOperation, Progress, WriteRequest};
    use crate::error::Result;
    use std::cell::RefCell;

    struct MockFlashSpy {
        pub last_read_request: RefCell<Option<ReadRequest>>,
    }

    impl MockFlashSpy {
        fn new() -> Self {
            Self {
                last_read_request: RefCell::new(None),
            }
        }
    }

    impl FlashOperation for MockFlashSpy {
        fn read(
            &mut self,
            request: ReadRequest,
            _on_progress: &dyn Fn(Progress),
        ) -> Result<Vec<u8>> {
            *self.last_read_request.borrow_mut() = Some(request);
            Ok(vec![0xAA; 10])
        }

        fn write(&mut self, _request: WriteRequest, _on_progress: &dyn Fn(Progress)) -> Result<()> {
            Ok(())
        }
        fn erase(&mut self, _request: EraseRequest, _on_progress: &dyn Fn(Progress)) -> Result<()> {
            Ok(())
        }
    }

    #[test]
    fn test_read_flash_use_case() {
        let flash = MockFlashSpy::new();
        let mut use_case = ReadFlashUseCase::new(flash);

        let params = ReadParams {
            address: 0x1000,
            length: 2048,
            use_ecc: true,
            ignore_ecc_errors: false,
            oob_mode: OobMode::Included,
            bad_block_strategy: BadBlockStrategy::Skip,
            bbt: None,
            retry_count: 3,
        };

        let result = use_case.execute(params, |_| {});
        assert!(result.is_ok());

        assert!(use_case.flash.last_read_request.borrow().is_some());
        let req = use_case.flash.last_read_request.borrow();
        let req = req.as_ref().unwrap();

        assert_eq!(req.address.as_u32(), 0x1000);
        assert_eq!(req.length, 2048);
        assert!(req.use_ecc);
        assert_eq!(req.oob_mode, OobMode::Included);
        assert_eq!(req.bad_block_strategy, BadBlockStrategy::Skip);
        assert_eq!(req.retry_count, 3);
    }
}