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
//! The format used by Vega10 and older GPUs.
use super::{parse_range_line, push_level_line, ClocksLevel, ClocksTable, Range};
use crate::{
    error::{Error, ErrorKind::ParseError},
    Result,
};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::{io::Write, str::FromStr};

/// Vega10 clocks table.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Table {
    /// List of core clock levels.
    pub sclk_levels: Vec<ClocksLevel>,
    /// List of memory clock levels.
    pub mclk_levels: Vec<ClocksLevel>,
    /// The allowed ranges for clockspeeds and voltages.
    pub od_range: OdRange,
}

impl ClocksTable for Table {
    fn write_commands<W: Write>(&self, writer: &mut W) -> Result<()> {
        for (i, level) in self.sclk_levels.iter().enumerate() {
            let command = level_command(*level, i, 's');
            writer.write_all(command.as_bytes())?;
        }

        for (i, level) in self.mclk_levels.iter().enumerate() {
            let command = level_command(*level, i, 'm');
            writer.write_all(command.as_bytes())?;
        }

        Ok(())
    }

    fn get_max_sclk_range(&self) -> Option<Range> {
        Some(self.od_range.sclk)
    }

    fn get_min_sclk_range(&self) -> Option<Range> {
        Some(self.od_range.sclk)
    }

    fn get_max_mclk_range(&self) -> Option<Range> {
        self.od_range.mclk
    }

    fn get_min_mclk_range(&self) -> Option<Range> {
        self.od_range.mclk
    }

    fn get_max_voltage_range(&self) -> Option<Range> {
        self.od_range.vddc
    }

    fn get_min_voltage_range(&self) -> Option<Range> {
        self.od_range.vddc
    }

    fn get_current_voltage_range(&self) -> Option<Range> {
        let min = self.sclk_levels.first().map(|level| level.voltage);
        let max = self.sclk_levels.last().map(|level| level.voltage);
        Some(Range { min, max })
    }

    fn get_current_sclk_range(&self) -> Range {
        let min = self.sclk_levels.first().map(|level| level.clockspeed);
        let max = self.sclk_levels.last().map(|level| level.clockspeed);
        Range { min, max }
    }

    fn get_current_mclk_range(&self) -> Range {
        let min = self.mclk_levels.first().map(|level| level.clockspeed);
        let max = self.mclk_levels.last().map(|level| level.clockspeed);
        Range { min, max }
    }

    fn set_max_sclk_unchecked(&mut self, clockspeed: i32) -> Result<()> {
        self.sclk_levels
            .last_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .clockspeed = clockspeed;
        Ok(())
    }

    fn set_min_sclk_unchecked(&mut self, clockspeed: i32) -> Result<()> {
        self.sclk_levels
            .first_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .clockspeed = clockspeed;
        Ok(())
    }

    fn set_max_mclk_unchecked(&mut self, clockspeed: i32) -> Result<()> {
        self.mclk_levels
            .last_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .clockspeed = clockspeed;
        Ok(())
    }

    fn set_min_mclk_unchecked(&mut self, clockspeed: i32) -> Result<()> {
        self.mclk_levels
            .first_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .clockspeed = clockspeed;
        Ok(())
    }

    fn set_max_voltage_unchecked(&mut self, voltage: i32) -> Result<()> {
        self.sclk_levels
            .last_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .voltage = voltage;

        Ok(())
    }

    fn set_min_voltage_unchecked(&mut self, voltage: i32) -> Result<()> {
        self.sclk_levels
            .first_mut()
            .ok_or_else(|| {
                Error::not_allowed("The GPU did not report any power levels".to_owned())
            })?
            .voltage = voltage;

        Ok(())
    }

    fn get_max_sclk_voltage(&self) -> Option<i32> {
        self.sclk_levels.last().map(|level| level.voltage)
    }
}

/// The ranges for overclocking values which the GPU allows to be used.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct OdRange {
    /// Clocks range for sclk (in MHz). Should be present on all GPUs.
    pub sclk: Range,
    /// Clocks range for mclk (in MHz). Present on discrete GPUs only.
    pub mclk: Option<Range>,
    /// Voltage range (in mV). Present on Vega10 and older GPUs only.
    pub vddc: Option<Range>,
}

impl FromStr for Table {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        let mut sclk_levels = Vec::with_capacity(7);
        let mut mclk_levels = Vec::with_capacity(2);
        let mut sclk_range = None;
        let mut mclk_range = None;
        let mut vddc_range = None;

        let mut current_section = None;

        let mut i = 1;
        for line in s.lines().map(str::trim).filter(|line| !line.is_empty()) {
            match line {
                "OD_SCLK:" => current_section = Some(Section::Sclk),
                "OD_MCLK:" => current_section = Some(Section::Mclk),
                "OD_RANGE:" => current_section = Some(Section::Range),
                line => match current_section {
                    Some(Section::Sclk) => {
                        push_level_line(line, &mut sclk_levels, i)?;
                    }
                    Some(Section::Mclk) => {
                        push_level_line(line, &mut mclk_levels, i)?;
                    }
                    Some(Section::Range) => {
                        let (range, name) = parse_range_line(line, i)?;
                        match name {
                            "SCLK" => sclk_range = Some(range),
                            "MCLK" => mclk_range = Some(range),
                            "VDDC" => vddc_range = Some(range),
                            other => {
                                return Err(ParseError {
                                    msg: format!("Unexpected range item: {other}"),
                                    line: i,
                                }
                                .into())
                            }
                        }
                    }
                    None => {
                        return Err(ParseError {
                            msg: "Could not find section".to_owned(),
                            line: i,
                        }
                        .into())
                    }
                },
            }
            i += 1;
        }

        sclk_levels.shrink_to_fit();
        mclk_levels.shrink_to_fit();

        let od_range = OdRange {
            sclk: sclk_range.ok_or_else(|| ParseError {
                msg: "No sclk range found".to_owned(),
                line: i,
            })?,
            mclk: mclk_range,
            vddc: vddc_range,
        };

        Ok(Self {
            sclk_levels,
            mclk_levels,
            od_range,
        })
    }
}

fn level_command(level: ClocksLevel, i: usize, symbol: char) -> String {
    let ClocksLevel {
        clockspeed,
        voltage,
    } = level;
    format!("{symbol} {i} {clockspeed} {voltage}\n")
}

#[derive(PartialEq)]
enum Section {
    Sclk,
    Mclk,
    Range,
}

#[cfg(test)]
mod tests {
    use super::{ClocksLevel, Table};
    use crate::{
        gpu_handle::overdrive::{arr_commands, vega10::OdRange, ClocksTable, Range},
        include_table,
    };
    use pretty_assertions::assert_eq;
    use std::str::FromStr;

    const TABLE_RX580: &str = include_table!("rx580");

    #[test]
    fn parse_full_table() {
        let table = Table::from_str(TABLE_RX580).unwrap();

        let sclk_levels = [
            (300, 750),
            (600, 769),
            (900, 912),
            (1145, 1125),
            (1215, 1150),
            (1257, 1150),
            (1300, 1150),
            (1366, 1150),
        ]
        .map(|(clockspeed, voltage)| ClocksLevel {
            clockspeed,
            voltage,
        });
        let mclk_levels =
            [(300, 750), (1000, 825), (1750, 975)].map(|(clockspeed, voltage)| ClocksLevel {
                clockspeed,
                voltage,
            });
        let ranges = OdRange {
            sclk: Range::full(300, 2000),
            mclk: Some(Range::full(300, 2250)),
            vddc: Some(Range::full(750, 1200)),
        };

        assert_eq!(table.sclk_levels, sclk_levels);
        assert_eq!(table.mclk_levels, mclk_levels);
        assert_eq!(table.od_range, ranges);
    }

    #[test]
    fn table_into_commands() {
        let mut table = Table::from_str(TABLE_RX580).unwrap();

        table.set_max_sclk(1500).unwrap();
        table.set_max_mclk(2250).unwrap();

        table.set_min_sclk(350).unwrap();
        table.set_min_mclk(360).unwrap();

        table.set_min_voltage(800).unwrap();
        table.set_max_voltage(1200).unwrap();

        let mut buf = Vec::new();
        table.write_commands(&mut buf).unwrap();
        let commands = String::from_utf8(buf).unwrap();

        let expected_commands = arr_commands([
            "s 0 350 800",
            "s 1 600 769",
            "s 2 900 912",
            "s 3 1145 1125",
            "s 4 1215 1150",
            "s 5 1257 1150",
            "s 6 1300 1150",
            "s 7 1500 1200",
            "m 0 360 750",
            "m 1 1000 825",
            "m 2 2250 975",
        ]);

        assert_eq!(expected_commands, commands);
    }

    #[test]
    fn generic_actions() {
        let mut table = Table::from_str(TABLE_RX580).unwrap();
        let sclk = table.get_max_sclk().unwrap();
        assert_eq!(sclk, 1366);
        let mclk = table.get_max_mclk().unwrap();
        assert_eq!(mclk, 1750);
        let voltage = table.get_max_sclk_voltage().unwrap();
        assert_eq!(voltage, 1150);

        table.set_max_sclk(1400).unwrap();
        let sclk = table.get_max_sclk().unwrap();
        assert_eq!(sclk, 1400);
        assert_eq!(table.sclk_levels[7].clockspeed, 1400);

        table.set_max_mclk(1800).unwrap();
        let mclk = table.get_max_mclk().unwrap();
        assert_eq!(mclk, 1800);
        assert_eq!(table.mclk_levels[2].clockspeed, 1800);

        let sclk_range = table.get_max_sclk_range();
        let mclk_range = table.get_max_mclk_range();
        let voltage_range = table.get_max_voltage_range();
        assert_eq!(sclk_range, Some(Range::full(300, 2000)));
        assert_eq!(mclk_range, Some(Range::full(300, 2250)));
        assert_eq!(voltage_range, Some(Range::full(750, 1200)));
    }
}