bmm350 0.0.1

Platform agnostic Rust driver for the BMM350 Magnetometer.
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
use crate::{
    interface::{I2cInterface, ReadData, WriteData},
    types::{
        AxisEnableDisable, DataRate, Error, MagCompensation, PerformanceMode, PmuCmdStatus0,
        PowerMode, Sensor3DData, Sensor3DDataScaled,
    },
    AverageNum, Bmm350, InterruptDrive, InterruptEnableDisable, InterruptLatch, InterruptMap,
    InterruptPolarity, MagConfig, Register,
};
use embedded_hal::delay::DelayNs;

impl<I2C, D> Bmm350<I2cInterface<I2C>, D>
where
    D: DelayNs,
{
    /// Create a new BMM350 device instance
    ///
    /// # Arguments
    ///
    /// * `i2c` - The I2C interface
    /// * `address` - The I2C address of the device
    /// * `delay` - A delay provider
    pub fn new_with_i2c(i2c: I2C, address: u8, delay: D) -> Self {
        Bmm350 {
            iface: I2cInterface { i2c, address },
            delay,
            mag_range: 1000.0,
            var_id: 0,
            mag_comp: MagCompensation::default(), // Default range in uT
        }
    }
}

impl<DI, D, E> Bmm350<DI, D>
where
    DI: ReadData<Error = Error<E>> + WriteData<Error = Error<E>>,
    D: DelayNs,
{
    /// Initialize the device
    pub fn init(&mut self) -> Result<(), Error<E>> {
        self.delay.delay_us(3_000);
        self.write_register_16bit(Register::CMD, Register::CMD_SOFT_RESET)?;
        self.delay.delay_us(24_000);

        let err = self.read_register(Register::ERR_REG)?;
        if err != 0 {
            return Err(Error::InvalidConfig);
        }

        let chip_id = self.read_register(Register::CHIPID)?;
        if chip_id != Register::BMM350_CHIP_ID {
            return Err(Error::InvalidDevice);
        }

        // Perform OTP dump after boot
        self.otp_dump_after_boot()?;

        // Power off OTP
        self.write_register(Register::OTP_CMD_REG, Register::OTP_CMD_PWR_OFF_OTP)?;

        self.magnetic_reset()?;

        Ok(())
    }

    fn otp_dump_after_boot(&mut self) -> Result<(), Error<E>> {
        let mut otp_data = [0u16; 32];

        for i in 0..32 {
            otp_data[i] = self.read_otp_word(i as u8)?;
        }

        self.var_id = ((otp_data[30] & 0x7f00) >> 9) as u8;

        // Update magnetometer offset and sensitivity data
        self.update_mag_compensation(&otp_data)?;

        Ok(())
    }

    fn read_otp_word(&mut self, addr: u8) -> Result<u16, Error<E>> {
        let otp_cmd = 0x20 | (addr & 0x1F); // OTP read command
        self.write_register(Register::OTP_CMD_REG, otp_cmd)?;

        // Wait for OTP read to complete
        for _ in 0..10 {
            self.delay.delay_us(300);
            let status = self.read_register(Register::OTP_STATUS_REG)?;
            if status & 0x01 != 0 {
                break;
            }
        }

        let msb = self.read_register(Register::OTP_DATA_MSB_REG)?;
        let lsb = self.read_register(Register::OTP_DATA_LSB_REG)?;

        Ok(((msb as u16) << 8) | (lsb as u16) & 0xFFFF)
    }

    fn update_mag_compensation(&mut self, otp_data: &[u16; 32]) -> Result<(), Error<E>> {
        // Implement the logic to update magnetometer compensation data
        // This is a simplified version and may need to be expanded based on the specific BMM350 requirements
        self.mag_comp = MagCompensation {
            offset_x: self.extract_signed_12bit(otp_data[0x0E] & 0x0FFF),
            offset_y: self
                .extract_signed_12bit(((otp_data[0x0E] & 0xF000) >> 4) + (otp_data[0x0F] & 0x00FF)),
            offset_z: self
                .extract_signed_12bit((otp_data[0x0F] & 0x0F00) + (otp_data[0x10] & 0x00FF)),
            // Add more fields as necessary
        };

        Ok(())
    }

    fn extract_signed_12bit(&self, value: u16) -> i16 {
        if value & 0x0800 != 0 {
            (value | 0xF000) as i16
        } else {
            value as i16
        }
    }

    /// Perform magnetic reset of the sensor.
    /// This is necessary after a field shock (400mT field applied to sensor).
    /// It performs both a bit reset and flux guide reset in suspend mode.
    pub fn magnetic_reset(&mut self) -> Result<(), Error<E>> {
        // Check if we're in normal mode
        let mut restore_normal = false;
        let mut pmu_status = self.read_pmu_cmd_status_0()?;

        // If we're in normal mode, we need to go to suspend first
        if pmu_status.power_mode_is_normal == 0x1 {
            restore_normal = true;
            self.set_power_mode(PowerMode::Suspend)?;
        }

        // Set Bit Reset (BR) command
        // TODO set BitReset as register instead of PowerMode enum
        self.write_register(Register::PMU_CMD, PowerMode::BitReset as u8)?;
        self.delay.delay_us(14_000); // BR_DELAY

        // Verify BR status
        pmu_status = self.read_pmu_cmd_status_0()?;
        if pmu_status.pmu_cmd_value != Register::PMU_CMD_STATUS_0_BR {
            return Err(Error::ResetUnfinished);
        }

        // Set Flux Guide Reset (FGR) command
        // TODO set FluxGuideReset as register instead of PowerMode enum
        self.write_register(Register::PMU_CMD, PowerMode::FluxGuideReset as u8)?;
        self.delay.delay_us(18_000); // FGR_DELAY

        // Verify FGR status
        let pmu_status = self.read_pmu_cmd_status_0()?;
        if pmu_status.pmu_cmd_value != Register::PMU_CMD_STATUS_0_FGR {
            return Err(Error::ResetUnfinished);
        }

        // Restore normal mode if we were in it before
        if restore_normal {
            self.set_power_mode(PowerMode::Normal)?;
        }

        Ok(())
    }

    /// Read the PMU command status register 0
    fn read_pmu_cmd_status_0(&mut self) -> Result<PmuCmdStatus0, Error<E>> {
        let status = self.read_register(Register::PMU_CMD_STATUS_0)?;

        Ok(PmuCmdStatus0 {
            pmu_cmd_busy: (status & 0x01),
            odr_overwrite: (status & 0x2) >> 0x1,
            avg_overwrite: (status & 0x4) >> 0x2,
            power_mode_is_normal: (status & 0x8) >> 0x3,
            cmd_is_illegal: (status & 0x10) >> 0x4,
            pmu_cmd_value: (status & 0xE0) >> 5,
        })
    }

    /// Set the magnetometer configuration
    ///
    /// # Arguments
    ///
    /// * `config` - The magnetometer configuration
    pub fn set_mag_config(&mut self, config: MagConfig) -> Result<(), Error<E>> {
        let reg_data = u16::from(config);
        self.write_register_16bit(Register::PMU_CMD_AGGR_SET, reg_data)?;

        // Wait for magnetometer data to be ready
        self.wait_for_data_ready()?;

        Ok(())
    }

    /// Set the power mode of the sensor
    ///
    /// # Arguments
    ///
    /// * `mode` - The power mode to set
    pub fn set_power_mode(&mut self, mode: PowerMode) -> Result<(), Error<E>> {
        // TODO fix

        let last_pwr = self.read_register(Register::REG_PMU_CMD)?;
        if last_pwr > Register::PMU_CMD_NM_TC {
            return Err(Error::InvalidConfig);
        }

        if last_pwr == Register::PMU_CMD_NM || last_pwr == Register::PMU_CMD_UPD_OAE {
            self.write_register(Register::REG_PMU_CMD, Register::PMU_CMD_SUS)?;
            self.delay.delay_us(6_000);
        }

        self.power_mode(mode)?;

        Ok(())
    }

    fn power_mode(&mut self, mode: PowerMode) -> Result<(), Error<E>> {
        let sus_to_forced_mode: [u32; 4] = [
            Register::SUS_TO_FORCEDMODE_NO_AVG_DELAY,
            Register::SUS_TO_FORCEDMODE_AVG_2_DELAY,
            Register::SUS_TO_FORCEDMODE_AVG_4_DELAY,
            Register::SUS_TO_FORCEDMODE_AVG_8_DELAY,
        ];

        /* Array to store suspend to forced mode fast delay */
        let sus_to_forced_mode_fast: [u32; 4] = [
            Register::SUS_TO_FORCEDMODE_FAST_NO_AVG_DELAY,
            Register::SUS_TO_FORCEDMODE_FAST_AVG_2_DELAY,
            Register::SUS_TO_FORCEDMODE_FAST_AVG_4_DELAY,
            Register::SUS_TO_FORCEDMODE_FAST_AVG_8_DELAY,
        ];

        self.write_register(Register::REG_PMU_CMD, mode as u8)?;
        let get_avg: u8 = self.read_register(Register::REG_PMU_CMD_AGGR_SET)?;
        let avg = (get_avg & Register::AVG_MASK) >> Register::AVG_POS;
        let mut delay_us = 0;
        match mode {
            PowerMode::Normal => {
                delay_us = 38_000;
            }
            PowerMode::Forced => {
                delay_us = sus_to_forced_mode[avg as usize];
            }
            PowerMode::ForcedFast => {
                delay_us = sus_to_forced_mode_fast[avg as usize];
            }
            _ => {}
        }

        self.delay.delay_us(delay_us);

        Ok(())
    }

    /// Enable or disable axes
    ///
    /// # Arguments
    ///
    /// * `x` - Enable or disable X axis
    /// * `y` - Enable or disable Y axis
    /// * `z` - Enable or disable Z axis
    pub fn enable_axes(
        // TODO fix
        &mut self,
        x: AxisEnableDisable,
        y: AxisEnableDisable,
        z: AxisEnableDisable,
    ) -> Result<(), Error<E>> {
        let mut reg_data: u8 = 0;
        reg_data = ((x as u8) & 0x01)
            | ((reg_data & 0x02) | ((y as u8) << 0x1) & 0x02)
            | ((reg_data & 0x04) | ((z as u8) << 0x2) & 0x04);
        self.write_register(Register::PMU_CMD_AXIS_EN, reg_data)
    }

    /// Read the raw magnetometer data
    pub fn read_mag_data(&mut self) -> Result<Sensor3DData, Error<E>> {
        // Prepare a buffer: 1 byte for start address + 9 bytes for data (X, Y, Z)
        const DATA_LEN: usize = 9;
        const BUFFER_LEN: usize = 1 + DATA_LEN;
        let mut buffer = [0u8; BUFFER_LEN]; // Size 10
        buffer[0] = Register::MAG_X_LSB; // Start address 0x31

        // read_data will return a slice referencing buffer[1..10] containing the 9 data bytes
        let sensor_data_slice = self.read_data(&mut buffer[0..BUFFER_LEN])?;

        // Helper function for 24-bit signed reconstruction (still needed!)
        fn reconstruct_signed_24bit(xlsb: u8, lsb: u8, msb: u8) -> i32 {
            let unsigned_val = (xlsb as u32) | ((lsb as u32) << 8) | ((msb as u32) << 16);
            if (msb & 0x80) != 0 {
                (unsigned_val | 0xFF000000) as i32 // Manual sign extension
            } else {
                unsigned_val as i32
            }
        }

        // Use indices relative to the returned slice
        Ok(Sensor3DData {
            x: reconstruct_signed_24bit(
                sensor_data_slice[0],
                sensor_data_slice[1],
                sensor_data_slice[2],
            ),
            y: reconstruct_signed_24bit(
                sensor_data_slice[3],
                sensor_data_slice[4],
                sensor_data_slice[5],
            ),
            z: reconstruct_signed_24bit(
                sensor_data_slice[6],
                sensor_data_slice[7],
                sensor_data_slice[8],
            ),
        })
    }

    /// Perform a self-test
    // TODO fix this
    fn perform_self_test(&mut self) -> Result<bool, Error<E>> {
        // Save current configuration
        let current_power_mode = self.read_register(Register::PMU_CMD)?;
        let current_odr = self.read_register(Register::PMU_CMD_AGGR_SET)?;

        // Set device to normal mode and 100Hz ODR
        self.set_power_mode(PowerMode::Normal)?;
        self.set_mag_config(
            MagConfig::builder()
                .odr(DataRate::ODR100Hz)
                .performance(PerformanceMode::Regular)
                .build(),
        )?;

        // Perform self-test
        let self_test_passed = true;

        // Restore original configuration
        self.write_register(Register::PMU_CMD, current_power_mode)?;
        self.write_register(Register::PMU_CMD_AGGR_SET, current_odr)?;

        Ok(self_test_passed)
    }

    /// Set the output data rate and performance mode
    pub fn set_odr_performance(
        &mut self,
        odr: DataRate,
        performance: AverageNum,
    ) -> Result<(), Error<E>> {
        let reg_data = (odr as u8) & 0xf;
        let new_reg_data = (reg_data & Register::AVG_MASK)
            | ((performance as u8) << Register::AVG_POS) & Register::AVG_MASK;

        self.write_register(Register::PMU_CMD_AGGR_SET, new_reg_data)?;
        self.write_register(Register::PMU_CMD, Register::PMU_CMD_UPD_OAE)?;

        self.delay.delay_us(1_000);
        Ok(())
    }

    /// Enable or disable the data ready interrupt
    pub fn enable_interrupt(&mut self, enable: InterruptEnableDisable) -> Result<(), Error<E>> {
        self.read_register(Register::INT_CTRL)?;
        let reg_data: u8 = 0;
        let new_reg_data = (reg_data & (0x80)) | (((enable as u8) << 0x7) & 0x80);
        self.write_register(Register::INT_CTRL, new_reg_data)
    }

    /// Configure interrupt settings
    pub fn configure_interrupt(
        &mut self,
        latch: InterruptLatch,
        polarity: InterruptPolarity,
        drive: InterruptDrive,
        map: InterruptMap,
    ) -> Result<(), Error<E>> {
        self.read_register(Register::INT_CTRL)?;
        let mut reg_data: u8 = 0;
        reg_data = ((reg_data & (0x1)) | (latch as u8 & 0x1))
            | ((reg_data & (0x2)) | ((polarity as u8) << 0x1) & 0x2)
            | ((reg_data & (0x4)) | ((drive as u8) << 0x2) & 0x4)
            | ((reg_data & (0x8)) | ((map as u8) << 0x3) & 0x8);
        self.write_register(Register::INT_CTRL, reg_data)
    }

    /// Read the interrupt status
    pub fn get_interrupt_status(&mut self) -> Result<bool, Error<E>> {
        let status = self.read_register(Register::STATUS)?;
        Ok((status & 0x04) != 0)
    }

    /// Set the I2C watchdog timer
    pub fn set_i2c_watchdog(&mut self, enable: bool, long_timeout: bool) -> Result<(), Error<E>> {
        let reg_data = (enable as u8) | ((long_timeout as u8) << 1);
        self.write_register(Register::I2C_WDT_SET, reg_data)
    }

    fn write_register(&mut self, reg: u8, value: u8) -> Result<(), Error<E>> {
        self.iface.write_data(&[reg, value])
    }

    fn write_register_16bit(&mut self, reg: u8, value: u16) -> Result<(), Error<E>> {
        let bytes = value.to_le_bytes();
        self.iface.write_data(&[reg, bytes[0], bytes[1]])
    }

    fn read_register(&mut self, reg: u8) -> Result<u8, Error<E>> {
        self.iface.read_register(reg)
    }

    fn read_data<'a>(&mut self, data: &'a mut [u8]) -> Result<&'a [u8], Error<E>> {
        self.iface.read_data(data)
    }

    fn wait_for_data_ready(&mut self) -> Result<(), Error<E>> {
        for _ in 0..100 {
            if self.get_interrupt_status()? {
                return Ok(());
            }
            self.delay.delay_ms(1);
        }
        Err(Error::Timeout)
    }
}