mint-core 1.3.1

Core library for building hex files from data and layout definitions.
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

use std::io::Write;

#[path = "common/mod.rs"]
mod common;

/// Helper to create a minimal layout with bitmap in data section
fn bitmap_layout(data_content: &str) -> String {
    format!(
        r#"
[mint]
endianness = "little"

[block.header]
start_address = 0x80000
length = 0x100
padding = 0x00

[block.data]
{data_content}
"#
    )
}

#[test]
fn bitmap_u8_literal_values() {
    common::ensure_out_dir();

    // u8 bitmap: bit0=1, bits1-2=3, bits3-7=0x15 (21)
    // Expected: 0b10101_11_1 = 0xAF
    let layout = bitmap_layout(
        r#"flags = { type = "u8", bitmap = [
    { bits = 1, value = 1 },
    { bits = 2, value = 3 },
    { bits = 5, value = 21 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_u8.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let (bytes, _) = common::build_block(block, &cfg.mint, false, None).expect("build");

    assert_eq!(bytes[0], 0xAF, "u8 bitmap packing: got {:#04x}", bytes[0]);
}

#[test]
fn bitmap_u16_little_endian() {
    common::ensure_out_dir();

    // u16 bitmap: bits0-7=0xAB, bits8-15=0xCD
    // Little endian: [0xAB, 0xCD]
    let layout = bitmap_layout(
        r#"val = { type = "u16", bitmap = [
    { bits = 8, value = 0xAB },
    { bits = 8, value = 0xCD },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_u16_le.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let (bytes, _) = common::build_block(block, &cfg.mint, false, None).expect("build");

    assert_eq!(&bytes[0..2], &[0xAB, 0xCD], "u16 LE bitmap");
}

#[test]
fn bitmap_i16_signed_negative_values() {
    common::ensure_out_dir();

    // i16 bitmap with signed interpretation
    // bits0-3: -1 (4-bit signed = 0xF)
    // bits4-7: -8 (4-bit signed = 0x8, which is -8 in 4-bit two's complement)
    // bits8-15: 0
    // Result: 0x008F in little endian = [0x8F, 0x00]
    let layout = bitmap_layout(
        r#"flags = { type = "i16", bitmap = [
    { bits = 4, value = -1 },
    { bits = 4, value = -8 },
    { bits = 8, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_i16_signed.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let (bytes, _) = common::build_block(block, &cfg.mint, false, None).expect("build");

    // -1 in 4 bits = 0xF, -8 in 4 bits = 0x8
    // Combined: 0x8F in low byte, 0x00 in high byte
    assert_eq!(
        &bytes[0..2],
        &[0x8F, 0x00],
        "i16 signed bitmap: got {:02x?}",
        &bytes[0..2]
    );
}

#[test]
fn bitmap_signed_storage_preserves_high_bit_patterns() {
    common::ensure_out_dir();

    let i8_layout = bitmap_layout(
        r#"flags = { type = "i8", bitmap = [
    { bits = 8, value = -1 },
] }"#,
    );
    let i8_path = common::write_layout_file("bitmap_i8_high_bit", &i8_layout);
    let i8_cfg = mint_core::layout::load_layout(&i8_path).expect("parse");
    let i8_block = i8_cfg.blocks.get("block").expect("block");
    let (i8_bytes, _) = common::build_block(i8_block, &i8_cfg.mint, false, None).expect("build");
    assert_eq!(&i8_bytes[0..1], &[0xFF]);

    let i16_layout = bitmap_layout(
        r#"flags = { type = "i16", bitmap = [
    { bits = 16, value = -32768 },
] }"#,
    );
    let i16_path = common::write_layout_file("bitmap_i16_high_bit", &i16_layout);
    let i16_cfg = mint_core::layout::load_layout(&i16_path).expect("parse");
    let i16_block = i16_cfg.blocks.get("block").expect("block");
    let (i16_bytes, _) = common::build_block(i16_block, &i16_cfg.mint, false, None).expect("build");
    assert_eq!(&i16_bytes[0..2], &[0x00, 0x80]);
}

#[test]
fn bitmap_u32_mixed_fields() {
    common::ensure_out_dir();

    // u32: bit0=true(1), bits1-8=0xFF, bits9-31=0
    // Result: 0x000001FF in little endian
    let layout = bitmap_layout(
        r#"status = { type = "u32", bitmap = [
    { bits = 1, value = true },
    { bits = 8, value = 255 },
    { bits = 23, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_u32.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let (bytes, _) = common::build_block(block, &cfg.mint, false, None).expect("build");

    assert_eq!(
        &bytes[0..4],
        &[0xFF, 0x01, 0x00, 0x00],
        "u32 bitmap: got {:02x?}",
        &bytes[0..4]
    );
}

#[test]
fn bitmap_saturation_non_strict() {
    common::ensure_out_dir();

    // 3-bit unsigned field, value 10 should saturate to 7
    let layout = bitmap_layout(
        r#"sat = { type = "u8", bitmap = [
    { bits = 3, value = 10 },
    { bits = 5, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_saturate.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let (bytes, _) = common::build_block(block, &cfg.mint, false, None)
        .expect("saturation should succeed in non-strict");

    assert_eq!(bytes[0], 7, "3-bit field saturates 10 to 7");
}

#[test]
fn bitmap_strict_rejects_out_of_range() {
    common::ensure_out_dir();

    // 3-bit unsigned field, value 10 is out of range (max 7)
    let layout = bitmap_layout(
        r#"bad = { type = "u8", bitmap = [
    { bits = 3, value = 10 },
    { bits = 5, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_strict_range.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let res = common::build_block(block, &cfg.mint, true, None);
    assert!(res.is_err(), "strict mode rejects out-of-range value");
}

#[test]
fn bitmap_rejects_wrong_bit_sum() {
    common::ensure_out_dir();

    // u8 needs 8 bits, but we only provide 7
    let layout = bitmap_layout(
        r#"bad = { type = "u8", bitmap = [
    { bits = 3, value = 0 },
    { bits = 4, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_bad_sum.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let res = common::build_block(block, &cfg.mint, false, None);
    assert!(res.is_err(), "bitmap with wrong bit sum should error");
}

#[test]
fn bitmap_rejects_zero_bits() {
    common::ensure_out_dir();

    let layout = bitmap_layout(
        r#"bad = { type = "u8", bitmap = [
    { bits = 0, value = 0 },
    { bits = 8, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_zero_bits.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let res = common::build_block(block, &cfg.mint, false, None);
    assert!(res.is_err(), "bitmap with zero-bit field should error");
}

#[test]
fn bitmap_rejects_float_storage() {
    common::ensure_out_dir();

    let layout = bitmap_layout(
        r#"bad = { type = "f32", bitmap = [
    { bits = 16, value = 0 },
    { bits = 16, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_float.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let res = common::build_block(block, &cfg.mint, false, None);
    assert!(res.is_err(), "bitmap with float storage should error");
}

#[test]
fn bitmap_rejects_size_key() {
    common::ensure_out_dir();

    let layout = bitmap_layout(
        r#"bad = { type = "u8", size = 2, bitmap = [
    { bits = 8, value = 0 },
] }"#,
    );

    let path = std::path::Path::new("out").join("test_bitmap_size_key.toml");
    std::fs::File::create(&path)
        .unwrap()
        .write_all(layout.as_bytes())
        .unwrap();

    let cfg = mint_core::layout::load_layout(path.to_str().unwrap()).expect("parse");
    let block = cfg.blocks.get("block").expect("block");

    let res = common::build_block(block, &cfg.mint, false, None);
    assert!(res.is_err(), "bitmap with size key should error");
}