jep106 0.3.0

A pollable collection of all JEP106 manufacturer codes.
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

#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
//! This crate provides a means to retrieve the JEDEC manufacturer string
//! for a corresponding JEP106 ID Code.
//!
//! All the codes can be found on the page of the JEDEC organization
//! but are presented in the riddiculous form of a PDF.
//!
//! This crate parses the PDF and exposes an interface
//! to poll the JEDEC manufacturer string of a JEP106 ID code.
//!
//! # Example
//!
//! ```
//!
//! let nordic = jep106::JEP106Code::new(0x02, 0x44).get();
//! assert_eq!(Some("Nordic VLSI ASA"), nordic);
//!
//! ```

mod codes;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

pub use codes::version;

/// A Struct which contains a fully qualified JEP106 manufacturer code.
#[derive(Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct JEP106Code {
    /// JEP106 identification code.
    /// Points to a manufacturer name in the bank table corresponding to `cc`.
    pub id: u8,
    /// JEP106 continuation code.
    /// This code represents the bank which the manufacturer for a corresponding `id` has to be looked up.
    pub cc: u8,
}

impl JEP106Code {
    /// Creates a new [JEP106Code](struct.JEP106Code.html) struct from
    /// a JEP106 continuation code and a JEP106 id code tuple.
    pub const fn new(cc: u8, id: u8) -> Self {
        Self { id, cc }
    }

    /// Returns the manufacturer corresponding to a complete JEP106 code.
    ///
    /// Returns an empty string if the JEP106 code is unknown.
    pub const fn get(&self) -> Option<&'static str> {
        get(self.cc, self.id)
    }

    /// Returns the manufacturer corresponding to
    /// a JEP106 continuation code and a JEP106 id code tuple.
    ///
    /// Returns an empty string if the JEP106 code is unknown.
    pub const fn get_raw(cc: u8, id: u8) -> Option<&'static str> {
        get(cc, id)
    }
}

impl core::fmt::Debug for JEP106Code {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        write!(
            f,
            "JEP106Code({{ cc: 0x{:02x?}, id: 0x{:02x?} }} => {:?})",
            self.cc,
            self.id,
            self.get()
        )
    }
}

impl core::fmt::Display for JEP106Code {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        write!(f, "{}", self.get().unwrap_or("Unknown Manufacturer Code"))
    }
}

/// Returns the manufacturer corresponding to a complete JEP106 code.
/// Returns an empty string if the JEP106 code is unknown.
const fn get(cc: u8, id: u8) -> Option<&'static str> {
    // The `get` function is unfortunately not const,
    // so we have to check the index manually.
    if cc as usize >= codes::CODES.len() {
        return None;
    }

    let cc_values = codes::CODES[cc as usize];

    if id as usize >= cc_values.len() {
        return None;
    }

    cc_values[id as usize]
}

#[test]
fn test_out_of_bound_access() {
    let last_valid_cc = codes::CODES.len() - 1;

    let last_valid_id = codes::CODES[last_valid_cc].len() - 1;

    // Verify that acces does not panic. We don't care if this actually a valid entry.
    let _ = crate::get(last_valid_cc as u8, last_valid_id as u8);

    assert!(crate::get(last_valid_cc as u8, (last_valid_id + 1) as u8).is_none());

    assert!(crate::get((last_valid_cc + 1) as u8, last_valid_id as u8).is_none());
}