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
use core::marker::PhantomData;

/// Errors in this crate
#[derive(Debug)]
pub enum Error<E> {
    /// I²C bus communication error
    I2C(E),
    /// Invalid input data provided
    InvalidInputData,
    /// Seek operation failed / Band limit reached
    SeekFailed,
}

/// Errors for operations involving I2C communication as well
/// as interaction with pins
#[derive(Debug)]
pub enum ErrorWithPin<CommE, PinE> {
    /// I²C bus communication error
    I2C(CommE),
    /// Error while communicating with pin
    Pin(PinE),
    /// Invalid input data provided
    InvalidInputData,
    /// Seek operation failed / Band limit reached
    SeekFailed,
}

impl<CommE, PinE> From<Error<CommE>> for ErrorWithPin<CommE, PinE> {
    fn from(error: Error<CommE>) -> Self {
        match error {
            Error::I2C(e) => ErrorWithPin::I2C(e),
            Error::InvalidInputData => ErrorWithPin::InvalidInputData,
            Error::SeekFailed => ErrorWithPin::SeekFailed,
        }
    }
}

/// IC markers
#[doc(hidden)]
pub mod ic {
    /// Used for Si4702 devices
    pub struct Si4702(());
    /// Used for Si4703 devices
    pub struct Si4703(());
}

/// markers
#[doc(hidden)]
pub mod marker {
    use super::super::private;
    pub trait WithRds: private::Sealed {}
}

#[derive(Debug, Copy, Clone, PartialEq)]
pub enum OperationState {
    Idle,
    Busy,
    WaitingForStcToClear(bool),
}

/// Si4703 device driver
#[derive(Debug)]
pub struct Si4703<I2C, IC> {
    pub(crate) i2c: I2C,
    pub(crate) seeking_state: OperationState,
    pub(crate) tuning_state: OperationState,
    pub(crate) _ic: PhantomData<IC>,
}

/// Seek mode
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SeekMode {
    /// Wrap at the end of the band (default)
    Wrap,
    /// Stop at the end of the band
    NoWrap,
}

impl Default for SeekMode {
    fn default() -> Self {
        SeekMode::Wrap
    }
}

/// Seek direction
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SeekDirection {
    /// Down (default)
    Down,
    /// Up
    Up,
}

impl Default for SeekDirection {
    fn default() -> Self {
        SeekDirection::Down
    }
}

/// De-emphasis
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum DeEmphasis {
    /// 75 us (used in USA) (default)
    Us75,
    /// 50 us (used in Europe, Australia and Japan)
    Us50,
}

impl Default for DeEmphasis {
    fn default() -> Self {
        DeEmphasis::Us75
    }
}

/// GPIO1 configuration
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Gpio1Config {
    /// High impedance (default)
    HighImpedance,
    /// High
    High,
    /// Low
    Low,
}

impl Default for Gpio1Config {
    fn default() -> Self {
        Gpio1Config::HighImpedance
    }
}

/// GPIO2 configuration
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Gpio2Config {
    /// High impedance (default)
    HighImpedance,
    /// STC/RDS interrupt (logic high until interrupt occurs)
    StcRdsInterrupt,
    /// High
    High,
    /// Low
    Low,
}

impl Default for Gpio2Config {
    fn default() -> Self {
        Gpio2Config::HighImpedance
    }
}

/// GPIO3 configuration
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Gpio3Config {
    /// High impedance (default)
    HighImpedance,
    /// Mono/Stereo indicator (logic low for mono, high for stereo)
    MonoStereoIndicator,
    /// High
    High,
    /// Low
    Low,
}

impl Default for Gpio3Config {
    fn default() -> Self {
        Gpio3Config::HighImpedance
    }
}

/// RDS mode
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum RdsMode {
    /// Standard (default)
    Standard,
    /// Verbose
    Verbose,
}

impl Default for RdsMode {
    fn default() -> Self {
        RdsMode::Standard
    }
}

/// Band
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Band {
    /// 87.5-108 Mhz (USA, Europe) (default)
    Mhz875_108,
    /// 76 - 108 MHz (Japan wide band)
    Mhz76_108,
    /// 76 - 90 MHz (Japan)
    Mhz76_90,
}

impl Default for Band {
    fn default() -> Self {
        Band::Mhz875_108
    }
}

/// Channel spacing
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum ChannelSpacing {
    /// 200 kHz (USA, Australia) (default)
    Khz200,
    /// 100 kHz (Europe, Japan)
    Khz100,
    /// 50 kHz
    Khz50,
}

impl Default for ChannelSpacing {
    fn default() -> Self {
        ChannelSpacing::Khz200
    }
}

/// Output mode
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum OutputMode {
    /// Stereo (default)
    Stereo,
    /// Mono
    Mono,
}

impl Default for OutputMode {
    fn default() -> Self {
        OutputMode::Stereo
    }
}

/// Stereo to mono blend level
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum StereoToMonoBlendLevel {
    /// 19–37 RSSI dBμV (–12 dB)
    Dbuv19_37,
    /// 25–43 RSSI dBμV (–6 dB).
    Dbuv25_43,
    /// 31–49 RSSI dBμV (default)
    Dbuv31_49,
    /// 37–55 RSSI dBμV (+6 dB)
    Dbuv37_55,
}

impl Default for StereoToMonoBlendLevel {
    fn default() -> Self {
        StereoToMonoBlendLevel::Dbuv31_49
    }
}

/// Volume
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Volume {
    /// Mute (0 volume) (default)
    Mute,
    /// –58 dBFS (extended volume range).
    Dbfsm58,
    /// –56 dBFS (extended volume range).
    Dbfsm56,
    /// –54 dBFS (extended volume range).
    Dbfsm54,
    /// –52 dBFS (extended volume range).
    Dbfsm52,
    /// –50 dBFS (extended volume range).
    Dbfsm50,
    /// –48 dBFS (extended volume range).
    Dbfsm48,
    /// –46 dBFS (extended volume range).
    Dbfsm46,
    /// –44 dBFS (extended volume range).
    Dbfsm44,
    /// –42 dBFS (extended volume range).
    Dbfsm42,
    /// –40 dBFS (extended volume range).
    Dbfsm40,
    /// –38 dBFS (extended volume range).
    Dbfsm38,
    /// –36 dBFS (extended volume range).
    Dbfsm36,
    /// –34 dBFS (extended volume range).
    Dbfsm34,
    /// –32 dBFS (extended volume range).
    Dbfsm32,
    /// –30 dBFS (extended volume range).
    Dbfsm30,
    /// –28 dBFS.
    Dbfsm28,
    /// –26 dBFS.
    Dbfsm26,
    /// –24 dBFS.
    Dbfsm24,
    /// –22 dBFS.
    Dbfsm22,
    /// –20 dBFS.
    Dbfsm20,
    /// –18 dBFS.
    Dbfsm18,
    /// –16 dBFS.
    Dbfsm16,
    /// –14 dBFS.
    Dbfsm14,
    /// –12 dBFS.
    Dbfsm12,
    /// –10 dBFS.
    Dbfsm10,
    /// –8 dBFS.
    Dbfsm8,
    /// –6 dBFS.
    Dbfsm6,
    /// –4 dBFS.
    Dbfsm4,
    /// –2 dBFS.
    Dbfsm2,
    /// 0 dBFS (maximum).
    Dbfs0,
}

impl Default for Volume {
    fn default() -> Self {
        Volume::Mute
    }
}

/// Softmute Attack/Recover Rate
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SoftmuteRate {
    /// Fastest (default)
    Fastest,
    /// Fast
    Fast,
    /// Slow
    Slow,
    /// Slowest
    Slowest,
}

impl Default for SoftmuteRate {
    fn default() -> Self {
        SoftmuteRate::Fastest
    }
}

/// Softmute Attenuation
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SoftmuteAttenuation {
    /// 16 dB (default)
    Db16,
    /// 14 dB
    Db14,
    /// 12 dB
    Db12,
    /// 10 dB
    Db10,
}

impl Default for SoftmuteAttenuation {
    fn default() -> Self {
        SoftmuteAttenuation::Db16
    }
}

/// Required channel SNR for a valid seek.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SeekSnrThreshold {
    /// Disabled (default)
    Disabled,
    /// Enabled
    ///
    /// The value provided corresponds to the stops:
    /// - Minimum (most stops): `Enable(1)`
    /// - Maximum (fewest stops): `Enable(7)`
    Enabled(u8),
}

impl Default for SeekSnrThreshold {
    fn default() -> Self {
        SeekSnrThreshold::Disabled
    }
}

/// Allowable number of FM impulses for a valid seek channel.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SeekFmImpulseThreshold {
    /// Disabled (default)
    Disabled,
    /// Enabled
    ///
    /// The value provided corresponds to the stops:
    /// - Maximum (most stops): `Enable(1)`
    /// - Minimum (fewest stops): `Enable(15)`
    Enabled(u8),
}

impl Default for SeekFmImpulseThreshold {
    fn default() -> Self {
        SeekFmImpulseThreshold::Disabled
    }
}

/// Tune channel frequency
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum TuneChannel {
    /// Raw value for the channel select (10 bits)
    Raw(u16),
    /// Target frequency in MHz. The raw value will be aproximated taking
    /// the configured band and spacing into account
    Mhz(f32),
}

/// RDS block errors
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum RdsBlockErrors {
    /// No errors
    None,
    /// 1-2 errors requiring correction.
    OneOrTwo,
    /// 3-5 errors requiring correction.
    ThreeToFive,
    /// 6+ errors or error in checkword. Correction not possible.
    TooMany,
}

impl Default for RdsBlockErrors {
    fn default() -> Self {
        RdsBlockErrors::None
    }
}

/// RDS block data
#[derive(Debug, Default, Clone, Copy, PartialEq)]
pub struct RdsBlockData {
    /// Data
    pub data: u16,
    /// Block errors
    pub errors: RdsBlockErrors,
}

/// RDS data data
#[derive(Debug, Default, Clone, Copy, PartialEq)]
pub struct RdsData {
    /// Block A
    pub a: RdsBlockData,
    /// Block B
    pub b: RdsBlockData,
    /// Block C
    pub c: RdsBlockData,
    /// Block D
    pub d: RdsBlockData,
}

/// RDS radio text data
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum RdsRadioTextData {
    /// Two characters
    Two(char, char),
    /// Four characters
    Four(char, char, char, char),
}
/// RDS radio text
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct RdsRadioText {
    /// Screen clear requested (Text A/B)
    pub screen_clear: bool,
    /// Text + segment offset [0-63]
    pub text: Option<(RdsRadioTextData, usize)>,
}

#[cfg(test)]
mod tests {
    use super::*;
    macro_rules! default_test {
        ($name:ident, $type:ident, $default:ident) => {
            #[test]
            fn $name() {
                assert_eq!($type::$default, $type::default());
            }
        };
    }

    default_test!(default_seek_mode, SeekMode, Wrap);
    default_test!(default_seek_direction, SeekDirection, Down);
    default_test!(default_de, DeEmphasis, Us75);
    default_test!(default_gpio1, Gpio1Config, HighImpedance);
    default_test!(default_gpio2, Gpio2Config, HighImpedance);
    default_test!(default_gpio3, Gpio3Config, HighImpedance);
    default_test!(default_rds_mode, RdsMode, Standard);
    default_test!(default_band, Band, Mhz875_108);
    default_test!(default_spacing, ChannelSpacing, Khz200);
    default_test!(default_output_mode, OutputMode, Stereo);
    default_test!(default_volume, Volume, Mute);
    default_test!(default_softmute_att, SoftmuteAttenuation, Db16);
    default_test!(default_softmute_rate, SoftmuteRate, Fastest);
    default_test!(default_blend, StereoToMonoBlendLevel, Dbuv31_49);
    default_test!(default_snr, SeekSnrThreshold, Disabled);
    default_test!(default_fm_impulse, SeekFmImpulseThreshold, Disabled);
    default_test!(default_rds_block_err, RdsBlockErrors, None);
}