summaryrefslogtreecommitdiff
path: root/src/lib.rs
blob: 7977c88632666d62b51356179302e540289cdf78 (plain)
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
#[cfg(feature="use-serde")]
#[macro_use] extern crate serde_derive;
#[cfg(feature="use-serde")]
extern crate serde;
//#[cfg(feature="use-serde")]
//use serde::{Serialize, Deserialize};

extern crate yaxpeax_arch;
extern crate termion;

use yaxpeax_arch::{Arch, AddressDiff, Decoder, LengthedInstruction};

mod display;
pub use display::NoContext;

#[cfg(feature="use-serde")]
#[derive(Debug, Serialize, Deserialize)]
pub struct MSP430;

#[cfg(not(feature="use-serde"))]
#[derive(Debug)]
pub struct MSP430;

impl Arch for MSP430 {
    type Address = u16;
    type Instruction = Instruction;
    type DecodeError = DecodeError;
    type Decoder = InstDecoder;
    type Operand = Operand;
}

#[derive(Debug, Copy, Clone)]
pub struct Instruction {
    pub opcode: Opcode,
    pub op_width: Width,
    pub operands: [Operand; 2]
}

#[derive(Debug, Copy, Clone)]
pub enum Width {
    W, B
}

impl Default for Instruction {
    fn default() -> Instruction {
        Instruction {
            opcode: Opcode::Invalid(0xffff),
            op_width: Width::W,
            operands: [Operand::Nothing, Operand::Nothing]
        }
    }
}

impl LengthedInstruction for Instruction {
    type Unit = AddressDiff<<MSP430 as Arch>::Address>;
    fn min_size() -> Self::Unit {
        AddressDiff::from_const(2)
    }
    fn len(&self) -> Self::Unit {
        let mut size = 2;
        match self.operands[0] {
            Operand::Indexed(_, _) |
            Operand::Symbolic(_) |
            Operand::Immediate(_) |
            Operand::Absolute(_) => { size += 2; },
            _ => {}
        };
        match self.operands[1] {
            Operand::Indexed(_, _) |
            Operand::Symbolic(_) |
            Operand::Immediate(_) |
            Operand::Absolute(_) => { size += 2; },
            _ => {}
        };
        AddressDiff::from_const(size)
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
pub enum Opcode {
    Invalid(u16),
    RRC,
    SWPB,
    RRA,
    SXT,
    PUSH,
    CALL,
    RETI,
    JNE,
    JEQ,
    JNC,
    JC,
    JN,
    JGE,
    JL,
    JMP,
    MOV,
    ADD,
    ADDC,
    SUBC,
    SUB,
    CMP,
    DADD,
    BIT,
    BIC,
    BIS,
    XOR,
    AND
}

#[derive(Debug, Copy, Clone)]
pub enum Operand {
    Register(u8),
    Indexed(u8, u16),
    RegisterIndirect(u8),
    IndirectAutoinc(u8),
    Symbolic(u16),
    Immediate(u16),
    Absolute(u16),
    Offset(i16),
    Const4,
    Const8,
    Const0,
    Const1,
    Const2,
    ConstNeg1,
    Nothing
}

#[derive(Debug, PartialEq)]
pub enum DecodeError {
    ExhaustedInput,
    InvalidOpcode,
    InvalidOperand,
}

impl yaxpeax_arch::DecodeError for DecodeError {
    fn data_exhausted(&self) -> bool { self == &DecodeError::ExhaustedInput }
    fn bad_opcode(&self) -> bool { self == &DecodeError::InvalidOpcode }
    fn bad_operand(&self) -> bool { self == &DecodeError::InvalidOperand }
}

impl yaxpeax_arch::Instruction for Instruction {
    // TODO: this is wrong!!
    fn well_defined(&self) -> bool { true }
}

#[derive(Debug)]
pub struct InstDecoder {
    flags: u8
}

impl InstDecoder {
    pub fn minimal() -> Self {
        InstDecoder {
            flags: 0
        }
    }

    pub fn with_microcorruption(mut self) -> Self {
        self.flags |= 1;
        self
    }

    pub fn microcorruption_quirks(&self) -> bool {
        (self.flags & 1) != 0
    }
}

impl Default for InstDecoder {
    fn default() -> Self {
        InstDecoder {
            flags: 0xff
        }
    }
}

impl Decoder<Instruction> for InstDecoder {
    type Error = DecodeError;

    fn decode_into<T: IntoIterator<Item=u8>>(&self, inst: &mut Instruction, bytes: T) -> Result<(), Self::Error> {
        let mut bytes_iter = bytes.into_iter();
        let word: Vec<u8> = bytes_iter.by_ref().take(2).collect();

        let fullword = match word[..] {
            [] | [_] => { return Err(DecodeError::ExhaustedInput); },
            [low, high] => (high as u16) << 8 | (low as u16),
            _ => unreachable!()
        };

        fn decode_operand<T: Iterator<Item=u8>>(bytes: &mut T, reg: u8, mode: u8, oper: &mut Operand) -> bool {
            *oper = match reg {
                0 => {
                    if mode == 0 {
                        Operand::Register(reg)
                    } else if mode == 1 {
                        let next = match bytes.take(2).collect::<Vec<u8>>()[..] {
                            [] | [_] => { return false; },
                            [low, high] => { ((high as u16) << 8) | (low as u16) },
                            _ => { unreachable!() }
                        };
                        Operand::Symbolic(next)
                    } else if mode == 2 {
                        Operand::RegisterIndirect(reg)
                    } else if mode == 3 {
                        let next = match bytes.take(2).collect::<Vec<u8>>()[..] {
                            [] | [_] => { return false; },
                            [low, high] => { ((high as u16) << 8) | (low as u16) },
                            _ => { unreachable!() }
                        };
                        Operand::Immediate(next)
                    } else {
                        return false;
                    }
                },
                2 => {
                    match mode {
                        0 => { Operand::Register(reg) },
                        1 => {
                            let next = match bytes.take(2).collect::<Vec<u8>>()[..] {
                                [] | [_] => { return false; },
                                [low, high] => { ((high as u16) << 8) | (low as u16) },
                                _ => { unreachable!() }
                            };
                            Operand::Absolute(next)
                        },
                        2 => { Operand::Const8 },
                        3 => { Operand::Const4 },
                        _ => { unreachable!() }
                    }
                },
                3 => {
                    match mode {
                        0 => { Operand::Const0 },
                        1 => { Operand::Const1 },
                        2 => { Operand::Const2 },
                        3 => { Operand::ConstNeg1 },
                        _ => { unreachable!() }
                    }
                },
                _ => {
                    match mode {
                        0 => { Operand::Register(reg) },
                        1 => {
                            let next = match bytes.take(2).collect::<Vec<u8>>()[..] {
                                [] | [_] => { return false; },
                                [low, high] => { ((high as u16) << 8) | (low as u16) },
                                _ => { unreachable!() }
                            };
                            Operand::Indexed(reg, next)
                        },
                        2 => { Operand::RegisterIndirect(reg) },
                        3 => { Operand::IndirectAutoinc(reg) },
                        _ => { unreachable!() }
                    }
                }
            };
            return true;
        }

        inst.op_width = Width::W;

        match fullword {
            /*
            instrword if instrword < 0x1000 => {
                // MSP430X instructions go here
                inst.opcode = Opcode::Invalid(instrword);
                inst.operands[0] = Operand::Nothing;
                inst.operands[1] = Operand::Nothing;
                return None;
            }, */
            instrword if instrword < 0x2000 => {
                // microcorruption msp430 is non-standard and accepts invalid instructions..
                if !self.microcorruption_quirks() {
                    return Err(DecodeError::InvalidOpcode);
                }

                let (opcode_idx, operands) = ((instrword & 0x0380) >> 7, instrword & 0x7f);
                match opcode_idx {
                    x if x < 6 => {
                        inst.opcode = [
                            Opcode::RRC,
                            Opcode::SWPB,
                            Opcode::RRA,
                            Opcode::SXT,
                            Opcode::PUSH,
                            Opcode::CALL
                        ][x as usize];
                        inst.op_width = if operands & 0b01000000 == 0 {
                            Width::W
                        } else {
                            if x == 1 || x == 3 || x == 5 {
                                inst.opcode = Opcode::Invalid(instrword);
                                return Err(DecodeError::InvalidOpcode);
                            }
                            Width:: B
                        };
                        #[allow(non_snake_case)]
                        let (As, source) = (
                            ((instrword & 0x0030) >> 4) as u8,
                            (instrword & 0x000f) as u8
                        );
                        if !decode_operand(&mut bytes_iter, source, As, &mut inst.operands[0]) {
                            inst.opcode = Opcode::Invalid(instrword);
                            return Err(DecodeError::InvalidOperand);
                        };
                        inst.operands[1] = Operand::Nothing;
                        Ok(())
                    },
                    6 => {
                        if operands == 0 {
                            inst.opcode = Opcode::RETI;
                            inst.operands[0] = Operand::Nothing;
                            inst.operands[1] = Operand::Nothing;
                            Ok(())
                        } else {
                            inst.opcode = Opcode::Invalid(instrword);
                            return Err(DecodeError::InvalidOperand);
                        }
                    }
                    7 => {
                        inst.opcode = Opcode::Invalid(instrword);
                        return Err(DecodeError::InvalidOpcode);
                    }
                    _ => {
                        unreachable!();
                    }
                }
            },
            instrword if instrword < 0x4000 => {
                let (opcode_idx, offset) = ((instrword & 0x1c00) >> 10, instrword & 0x3ff);
                inst.opcode = [
                    Opcode::JNE,
                    Opcode::JEQ,
                    Opcode::JNC,
                    Opcode::JC,
                    Opcode::JN,
                    Opcode::JGE,
                    Opcode::JL,
                    Opcode::JMP
                ][opcode_idx as usize];
                inst.operands[0] = Operand::Offset(((offset as i16) << 6) >> 6);
                inst.operands[1] = Operand::Nothing;
                Ok(())
            },
            instrword @ _ => {
                let (opcode_idx, operands) = ((instrword & 0xf000) >> 12, instrword & 0x0fff);
                inst.opcode = [
                    Opcode::MOV,
                    Opcode::ADD,
                    Opcode::ADDC,
                    Opcode::SUBC,
                    Opcode::SUB,
                    Opcode::CMP,
                    Opcode::DADD,
                    Opcode::BIT,
                    Opcode::BIC,
                    Opcode::BIS,
                    Opcode::XOR,
                    Opcode::AND
                ][(opcode_idx - 4) as usize];
                inst.op_width = if operands & 0b01000000 == 0 { Width::W } else { Width:: B };
                #[allow(non_snake_case)]
                let (source, Ad, As, dest) = (
                    ((instrword & 0x0f00) >> 8) as u8,
                    ((instrword & 0x0080) >> 7) as u8,
                    ((instrword & 0x0030) >> 4) as u8,
                    (instrword & 0x000f) as u8
                );
                if !decode_operand(&mut bytes_iter, source, As, &mut inst.operands[0]) {
                    inst.opcode = Opcode::Invalid(instrword);
                    return Err(DecodeError::InvalidOperand);
                }
                if !decode_operand(&mut bytes_iter, dest, Ad, &mut inst.operands[1]) {
                    inst.opcode = Opcode::Invalid(instrword);
                    return Err(DecodeError::InvalidOperand);
                }
                Ok(())
            }
        }
    }
}