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
use crate::ParseError;
use enum_iterator::IntoEnumIterator;
use log::*;
use std::{fmt, str::FromStr};
/// Supported Pico drivers
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash, IntoEnumIterator)]
pub enum Driver {
PS2000,
PS2000A,
PS3000A,
PS4000,
PS4000A,
PS5000A,
PS6000,
/// Only used to get the full dependency name on each platform
PicoIPP,
/// Only used to get the full dependency name on each platform
IOMP5,
}
impl FromStr for Driver {
type Err = ParseError;
fn from_str(input: &str) -> Result<Self, Self::Err> {
let input = input.to_uppercase().replace("PS", "").replace(" ", "");
match &input[..] {
"2000" => Ok(Driver::PS2000),
"2000A" => Ok(Driver::PS2000A),
"3000A" => Ok(Driver::PS3000A),
"4000" => Ok(Driver::PS4000),
"4000A" => Ok(Driver::PS4000A),
"5000A" => Ok(Driver::PS5000A),
"6000" => Ok(Driver::PS6000),
_ => Err(ParseError),
}
}
}
impl fmt::Display for Driver {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", format!("{:?}", self).to_lowercase())
}
}
impl Driver {
/// Returns the relevant `Driver` for the supplied USB PID
pub fn from_pid(pid: u16) -> Option<Driver> {
match pid {
0x1007 => Some(Driver::PS2000),
0x1016 | 0x1200 => Some(Driver::PS2000A),
0x1012 | 0x1201 | 0x1211 | 0x1213 => Some(Driver::PS3000A),
0x1009 | 0x100F => Some(Driver::PS4000),
0x1202 | 0x1212 | 0x1214 | 0x1219 | 0x1220 | 0x121A | 0x121B => Some(Driver::PS4000A),
0x1019 | 0x1203 | 0x1217 | 0x1218 => Some(Driver::PS5000A),
0x100E | 0x1204 | 0x1215 | 0x1216 | 0x12A0 | 0x12A1 => Some(Driver::PS6000),
u => {
warn!("Unsupported Pico Product ID found: {:#X}", u);
None
}
}
}
/// Returns the platform dependent name of the driver binary with file
/// extension
/// ```
/// let driver = pico_common::Driver::PS2000A;
/// let binary_name = driver.get_binary_name();
///
/// if cfg!(target_os = "windows") {
/// assert_eq!(binary_name, "ps2000a.dll");
/// } else if cfg!(target_os = "macos") {
/// assert_eq!(binary_name, "libps2000a.dylib");
/// } else {
/// assert_eq!(binary_name, "libps2000a.so");
/// }
/// ```
pub fn get_binary_name(self) -> String {
if cfg!(target_os = "windows") {
format!("{}.dll", self)
} else if cfg!(target_os = "macos") {
format!("lib{}.dylib", self)
} else {
format!("lib{}.so", self)
}
}
/// Gets the required driver dependencies for this platform
pub fn get_dependencies_for_platform() -> Vec<Driver> {
if cfg!(target_os = "windows") {
vec![Driver::PicoIPP]
} else if cfg!(target_os = "macos") {
vec![Driver::IOMP5, Driver::PicoIPP]
} else {
// There is no libiomp5 requirement for Pico ARM drivers
if cfg!(all(target_arch = "arm", target_os = "linux")) {
vec![Driver::PicoIPP]
} else {
vec![Driver::IOMP5, Driver::PicoIPP]
}
}
}
/// Gets the symbol name for this driver
/// ```
/// use pico_common::Driver;
///
/// let driver = Driver::PS5000A;
/// let sym_name = driver.get_symbol_name(b"OpenUnit");
///
/// assert_eq!(sym_name, b"ps5000aOpenUnit");
///
/// let driver = Driver::PS2000;
/// let sym_name = driver.get_symbol_name(b"_open_unit");
///
/// assert_eq!(sym_name, b"ps2000_open_unit");
/// ```
pub fn get_symbol_name(self, sym: &[u8]) -> Vec<u8> {
[self.to_string().as_bytes(), sym].concat()
}
}