msp430-help: using the power of The Parser™️, create a silly search tool
This commit is contained in:
parent
51e14334db
commit
b24dd831fc
251
examples/msp430-help/LICENSE.txt
Normal file
251
examples/msp430-help/LICENSE.txt
Normal file
@ -0,0 +1,251 @@
|
|||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 1, February 1989
|
||||||
|
|
||||||
|
Copyright (C) 1989 Free Software Foundation, Inc.
|
||||||
|
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The license agreements of most software companies try to keep users
|
||||||
|
at the mercy of those companies. By contrast, our General Public
|
||||||
|
License is intended to guarantee your freedom to share and change free
|
||||||
|
software--to make sure the software is free for all its users. The
|
||||||
|
General Public License applies to the Free Software Foundation's
|
||||||
|
software and to any other program whose authors commit to using it.
|
||||||
|
You can use it for your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Specifically, the General Public License is designed to make
|
||||||
|
sure that you have the freedom to give away or sell copies of free
|
||||||
|
software, that you receive source code or can get it if you want it,
|
||||||
|
that you can change the software or use pieces of it in new free
|
||||||
|
programs; and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to make restrictions that forbid
|
||||||
|
anyone to deny you these rights or to ask you to surrender the rights.
|
||||||
|
These restrictions translate to certain responsibilities for you if you
|
||||||
|
distribute copies of the software, or if you modify it.
|
||||||
|
|
||||||
|
For example, if you distribute copies of a such a program, whether
|
||||||
|
gratis or for a fee, you must give the recipients all the rights that
|
||||||
|
you have. You must make sure that they, too, receive or can get the
|
||||||
|
source code. And you must tell them their rights.
|
||||||
|
|
||||||
|
We protect your rights with two steps: (1) copyright the software, and
|
||||||
|
(2) offer you this license which gives you legal permission to copy,
|
||||||
|
distribute and/or modify the software.
|
||||||
|
|
||||||
|
Also, for each author's protection and ours, we want to make certain
|
||||||
|
that everyone understands that there is no warranty for this free
|
||||||
|
software. If the software is modified by someone else and passed on, we
|
||||||
|
want its recipients to know that what they have is not the original, so
|
||||||
|
that any problems introduced by others will not reflect on the original
|
||||||
|
authors' reputations.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||||
|
|
||||||
|
0. This License Agreement applies to any program or other work which
|
||||||
|
contains a notice placed by the copyright holder saying it may be
|
||||||
|
distributed under the terms of this General Public License. The
|
||||||
|
"Program", below, refers to any such program or work, and a "work based
|
||||||
|
on the Program" means either the Program or any work containing the
|
||||||
|
Program or a portion of it, either verbatim or with modifications. Each
|
||||||
|
licensee is addressed as "you".
|
||||||
|
|
||||||
|
1. You may copy and distribute verbatim copies of the Program's source
|
||||||
|
code as you receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice and
|
||||||
|
disclaimer of warranty; keep intact all the notices that refer to this
|
||||||
|
General Public License and to the absence of any warranty; and give any
|
||||||
|
other recipients of the Program a copy of this General Public License
|
||||||
|
along with the Program. You may charge a fee for the physical act of
|
||||||
|
transferring a copy.
|
||||||
|
|
||||||
|
2. You may modify your copy or copies of the Program or any portion of
|
||||||
|
it, and copy and distribute such modifications under the terms of Paragraph
|
||||||
|
1 above, provided that you also do the following:
|
||||||
|
|
||||||
|
a) cause the modified files to carry prominent notices stating that
|
||||||
|
you changed the files and the date of any change; and
|
||||||
|
|
||||||
|
b) cause the whole of any work that you distribute or publish, that
|
||||||
|
in whole or in part contains the Program or any part thereof, either
|
||||||
|
with or without modifications, to be licensed at no charge to all
|
||||||
|
third parties under the terms of this General Public License (except
|
||||||
|
that you may choose to grant warranty protection to some or all
|
||||||
|
third parties, at your option).
|
||||||
|
|
||||||
|
c) If the modified program normally reads commands interactively when
|
||||||
|
run, you must cause it, when started running for such interactive use
|
||||||
|
in the simplest and most usual way, to print or display an
|
||||||
|
announcement including an appropriate copyright notice and a notice
|
||||||
|
that there is no warranty (or else, saying that you provide a
|
||||||
|
warranty) and that users may redistribute the program under these
|
||||||
|
conditions, and telling the user how to view a copy of this General
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
d) You may charge a fee for the physical act of transferring a
|
||||||
|
copy, and you may at your option offer warranty protection in
|
||||||
|
exchange for a fee.
|
||||||
|
|
||||||
|
Mere aggregation of another independent work with the Program (or its
|
||||||
|
derivative) on a volume of a storage or distribution medium does not bring
|
||||||
|
the other work under the scope of these terms.
|
||||||
|
|
||||||
|
3. You may copy and distribute the Program (or a portion or derivative of
|
||||||
|
it, under Paragraph 2) in object code or executable form under the terms of
|
||||||
|
Paragraphs 1 and 2 above provided that you also do one of the following:
|
||||||
|
|
||||||
|
a) accompany it with the complete corresponding machine-readable
|
||||||
|
source code, which must be distributed under the terms of
|
||||||
|
Paragraphs 1 and 2 above; or,
|
||||||
|
|
||||||
|
b) accompany it with a written offer, valid for at least three
|
||||||
|
years, to give any third party free (except for a nominal charge
|
||||||
|
for the cost of distribution) a complete machine-readable copy of the
|
||||||
|
corresponding source code, to be distributed under the terms of
|
||||||
|
Paragraphs 1 and 2 above; or,
|
||||||
|
|
||||||
|
c) accompany it with the information you received as to where the
|
||||||
|
corresponding source code may be obtained. (This alternative is
|
||||||
|
allowed only for noncommercial distribution and only if you
|
||||||
|
received the program in object code or executable form alone.)
|
||||||
|
|
||||||
|
Source code for a work means the preferred form of the work for making
|
||||||
|
modifications to it. For an executable file, complete source code means
|
||||||
|
all the source code for all modules it contains; but, as a special
|
||||||
|
exception, it need not include source code for modules which are standard
|
||||||
|
libraries that accompany the operating system on which the executable
|
||||||
|
file runs, or for standard header files or definitions files that
|
||||||
|
accompany that operating system.
|
||||||
|
|
||||||
|
4. You may not copy, modify, sublicense, distribute or transfer the
|
||||||
|
Program except as expressly provided under this General Public License.
|
||||||
|
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
|
||||||
|
the Program is void, and will automatically terminate your rights to use
|
||||||
|
the Program under this License. However, parties who have received
|
||||||
|
copies, or rights to use copies, from you under this General Public
|
||||||
|
License will not have their licenses terminated so long as such parties
|
||||||
|
remain in full compliance.
|
||||||
|
|
||||||
|
5. By copying, distributing or modifying the Program (or any work based
|
||||||
|
on the Program) you indicate your acceptance of this license to do so,
|
||||||
|
and all its terms and conditions.
|
||||||
|
|
||||||
|
6. Each time you redistribute the Program (or any work based on the
|
||||||
|
Program), the recipient automatically receives a license from the original
|
||||||
|
licensor to copy, distribute or modify the Program subject to these
|
||||||
|
terms and conditions. You may not impose any further restrictions on the
|
||||||
|
recipients' exercise of the rights granted herein.
|
||||||
|
|
||||||
|
7. The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies a version number of the license which applies to it and "any
|
||||||
|
later version", you have the option of following the terms and conditions
|
||||||
|
either of that version or of any later version published by the Free
|
||||||
|
Software Foundation. If the Program does not specify a version number of
|
||||||
|
the license, you may choose any version ever published by the Free Software
|
||||||
|
Foundation.
|
||||||
|
|
||||||
|
8. If you wish to incorporate parts of the Program into other free
|
||||||
|
programs whose distribution conditions are different, write to the author
|
||||||
|
to ask for permission. For software which is copyrighted by the Free
|
||||||
|
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||||
|
make exceptions for this. Our decision will be guided by the two goals
|
||||||
|
of preserving the free status of all derivatives of our free software and
|
||||||
|
of promoting the sharing and reuse of software generally.
|
||||||
|
|
||||||
|
NO WARRANTY
|
||||||
|
|
||||||
|
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||||
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||||
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||||
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||||
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||||
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||||
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||||
|
REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||||
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||||
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||||
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||||
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||||
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||||
|
POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
Appendix: How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to humanity, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively convey
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) 19yy <name of author>
|
||||||
|
|
||||||
|
This program is free software; you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation; either version 1, or (at your option)
|
||||||
|
any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
|
||||||
|
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program is interactive, make it output a short notice like this
|
||||||
|
when it starts in an interactive mode:
|
||||||
|
|
||||||
|
Gnomovision version 69, Copyright (C) 19xx name of author
|
||||||
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, the
|
||||||
|
commands you use may be called something other than `show w' and `show
|
||||||
|
c'; they could even be mouse-clicks or menu items--whatever suits your
|
||||||
|
program.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or your
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. Here a sample; alter the names:
|
||||||
|
|
||||||
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||||
|
program `Gnomovision' (a program to direct compilers to make passes
|
||||||
|
at assemblers) written by James Hacker.
|
||||||
|
|
||||||
|
<signature of Ty Coon>, 1 April 1989
|
||||||
|
Ty Coon, President of Vice
|
||||||
|
|
||||||
|
That's all there is to it!
|
||||||
194
examples/msp430-help/data.rs
Normal file
194
examples/msp430-help/data.rs
Normal file
@ -0,0 +1,194 @@
|
|||||||
|
use super::*;
|
||||||
|
|
||||||
|
/// Creates a [Parsable] implementation for an enum whose variants
|
||||||
|
/// are named after other [Parsable] items
|
||||||
|
macro make_parsable($(#[$meta:meta])* $vis:vis enum $id:ident {$($(#[$vmeta:meta])*$v:ident),*$(,)?}) {
|
||||||
|
$( #[$meta] )* $vis enum $id {$($(#[$vmeta])*$v($v),)* }
|
||||||
|
impl ::msp430_asm::parser::parsable::Parsable for $id {
|
||||||
|
fn parse<'text, T>(p: &Parser, stream: &mut T) -> Result<Self, ParseError>
|
||||||
|
where T: TokenStream<'text> {
|
||||||
|
$(if let Some(v) = Parsable::try_parse(p, stream)? { Ok(Self::$v(v)) } else )*
|
||||||
|
{ Err(ParseError::UnrecognizedDirective("".into())) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
impl TryFrom<&str> for $id {
|
||||||
|
type Error = ParseError;
|
||||||
|
fn try_from(value: &str) -> Result<Self, Self::Error> {
|
||||||
|
Parsable::parse(&Parser::default(), &mut Tokenizer::new(value).ignore(Type::Space).preprocessed())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
make_parsable! {
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub enum SyntaxFragment {
|
||||||
|
Opcode,
|
||||||
|
PrimaryOperand,
|
||||||
|
Number,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SyntaxFragment {
|
||||||
|
pub fn info(&self) {
|
||||||
|
match self {
|
||||||
|
SyntaxFragment::Opcode(o) => Self::opcode_info(o),
|
||||||
|
SyntaxFragment::PrimaryOperand(o) => Self::operand_info(o),
|
||||||
|
SyntaxFragment::Number(n) => println!("The number {n}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fn opcode_info(o: &Opcode) {
|
||||||
|
header!("Instruction:");
|
||||||
|
let (desc, as_rust) = usage(o);
|
||||||
|
println!("Usage: {o}{}\n{desc} ( {as_rust} )", params(o));
|
||||||
|
footer!("https://mspgcc.sourceforge.net/manual/x223.html");
|
||||||
|
}
|
||||||
|
// TODO: re-enable full instruction decoding
|
||||||
|
// fn encoding_info(e: &Encoding) {
|
||||||
|
// match e {
|
||||||
|
// Encoding::Single { dst, .. } => Self::operand_info(dst),
|
||||||
|
// Encoding::Jump { target } => println!("Jumps to (pc + {target})"),
|
||||||
|
// Encoding::Double { src, dst, .. } => {
|
||||||
|
// Self::operand_info(src);
|
||||||
|
// Self::operand_info(&dst.clone().into())
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
fn operand_info(o: &PrimaryOperand) {
|
||||||
|
match o {
|
||||||
|
PrimaryOperand::Direct(r) => Self::register_info(r),
|
||||||
|
PrimaryOperand::Indirect(r) => {
|
||||||
|
Self::register_info(r);
|
||||||
|
println!("Indirect addressing mode: use data pointed to by {r}");
|
||||||
|
}
|
||||||
|
PrimaryOperand::PostInc(r) => {
|
||||||
|
Self::register_info(r);
|
||||||
|
println!("Indirect post-increment mode: use data pointed to by {r}, then increment {r}");
|
||||||
|
}
|
||||||
|
PrimaryOperand::Indexed(r, n) => {
|
||||||
|
Self::register_info(r);
|
||||||
|
println!("Indexed mode: use the data at {r}[{n}]");
|
||||||
|
}
|
||||||
|
PrimaryOperand::Relative(_) => return,
|
||||||
|
PrimaryOperand::Absolute(n) => println!("Absolute mode: use the data at absolute address {n}"),
|
||||||
|
PrimaryOperand::Immediate(n) => println!("Immediate mode: the constant {n}"),
|
||||||
|
PrimaryOperand::Four => println!("#4 mode: Immediate 4 is encoded @sr"),
|
||||||
|
PrimaryOperand::Eight => println!("#8 mode: Immediate 8 is encoded @sr+"),
|
||||||
|
PrimaryOperand::Zero => println!("#0 mode: Immediate 0 is encoded cg (r3)"),
|
||||||
|
PrimaryOperand::One => println!("#1 mode: Immediate 1 is encoded _(cg), where _ is a nonexistent ext-word"),
|
||||||
|
PrimaryOperand::Two => println!("#2 mode: Immediate 2 is encoded @cg"),
|
||||||
|
PrimaryOperand::MinusOne => println!("#-1 mode: the all-ones constant, is encoded @cg+"),
|
||||||
|
}
|
||||||
|
footer!("https://mspgcc.sourceforge.net/manual/x82.html");
|
||||||
|
}
|
||||||
|
fn register_info(r: &Register) {
|
||||||
|
use Register as Re;
|
||||||
|
match r {
|
||||||
|
Re::pc => println!("pc (r0) is the Program Counter. Post-increment addressing will increase it by 2."),
|
||||||
|
Re::sp => println!("sp (r1) is the Stack Pointer. Post-increment addressing will increase it by 2."),
|
||||||
|
Re::sr => println!(
|
||||||
|
"sr (r2) is the Status Register. It has arithmetic flags: oVerflow, Negative, Zero, and Carry;\nInterrupt Enable; and toggles for various clock/sleep functions.\n8\t7\t6\t5\t4\t3\t2\t1\t0\nV\tSCG1\tSCG1\tOSCOFF\tCPUOFF\tGIE\tN\tZ\tC",
|
||||||
|
),
|
||||||
|
Re::cg => println!("cg (r3) is the Constant Generator. It's hard-wired to zero."),
|
||||||
|
Re::r4 | Re::r5 | Re::r6 | Re::r7 | Re::r8 | Re::r9 | Re::r10 | Re::r11 => {
|
||||||
|
println!("{r} is a callee-saved general purpose register.")
|
||||||
|
}
|
||||||
|
Re::r12 | Re::r13 | Re::r14 | Re::r15 => {
|
||||||
|
println!("{r} is a caller-saved general purpose register, allowed for return values.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gets parameter usage information from the opcode's EncodingParser
|
||||||
|
pub fn params(opcode: &Opcode) -> &'static str {
|
||||||
|
match opcode.resolve().1 {
|
||||||
|
EncodingParser::Jump { target: None } => " target (relative address or label)",
|
||||||
|
EncodingParser::Single { width: None, dst: None } => "[.b] dst",
|
||||||
|
EncodingParser::Single { dst: None, .. } => " dst",
|
||||||
|
EncodingParser::Double { src: None, dst: None, .. } => "[.b] src, dst",
|
||||||
|
EncodingParser::Double { src: None, .. } => "[.b] src",
|
||||||
|
EncodingParser::Double { dst: None, .. } => "[.b] dst",
|
||||||
|
EncodingParser::Double { .. } => "[.b]",
|
||||||
|
EncodingParser::Reflexive { reg: None, .. } => "[.b] dst",
|
||||||
|
_ => "",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn usage(opcode: &Opcode) -> (&'static str, &'static str) {
|
||||||
|
match opcode {
|
||||||
|
// Single
|
||||||
|
Opcode::Rrc => ("Rotates dst right, through carry flag", "dst = (dst >> 1) | (sr[C] << 15)"),
|
||||||
|
Opcode::Swpb => ("Swaps the high and low byte of dst", "dst.swap_bytes()"),
|
||||||
|
Opcode::Rra => ("Shifts dst right, sign-extending the result", "dst >>= 1"),
|
||||||
|
Opcode::Sxt => ("Sign-extends the 8-bit dst to 16-bits", "dst as i16 << 8 >> 8"),
|
||||||
|
Opcode::Push => ("Pushes dst to the stack", "stack.push(dst)"),
|
||||||
|
Opcode::Call => ("Calls a subroutine at an absolute address", "dst()"),
|
||||||
|
Opcode::Reti => ("Return from interrupt handler", "{ sr = stack.pop(); pc = stack.pop() }"),
|
||||||
|
// Jump
|
||||||
|
Opcode::Jnz => ("Jump if the last result was not zero", "if !Z { pc += target }"),
|
||||||
|
Opcode::Jz => ("Jump if the last result was zero", "if Z { pc += target }"),
|
||||||
|
Opcode::Jnc => ("Jump if the last operation did not carry", "if !C { pc += target }"),
|
||||||
|
Opcode::Jc => ("Jump if the last operation produced a carry bit", "if C { pc += target }"),
|
||||||
|
Opcode::Jn => ("Jump if the last result was negative", "if N { pc += target }"),
|
||||||
|
Opcode::Jge => ("Jump if the flags indicate src >= dst", "if sr[C] == sr[V] { pc += target }"),
|
||||||
|
Opcode::Jl => ("Jump if the flags indicate src < dst", "if sr[C] != sr[V] { pc += target }"),
|
||||||
|
Opcode::Jmp => ("Jump unconditionally", "pc += target"),
|
||||||
|
// Double
|
||||||
|
Opcode::Mov => ("Copy src into dst", "dst = src"),
|
||||||
|
Opcode::Add => ("Add src to dst", "dst += src"),
|
||||||
|
Opcode::Addc => ("Add src to dst with carry", "dst += src + sr[C]"),
|
||||||
|
Opcode::Subc => ("Subtract src from dst with carry", "dst -= src - sr[C]"),
|
||||||
|
Opcode::Sub => ("Subtract src from dst", "dst -= src"),
|
||||||
|
Opcode::Cmp => ("Subtract src from dst, but discard the result, keeping the flags", "dst - src"),
|
||||||
|
Opcode::Dadd => ("Add src to dst in Binary Coded Decimal", "dst = dst as BCD + src as BCD"),
|
||||||
|
Opcode::Bit => ("Test if bits in src are set in dst", "(src & dst).cmp(0)"),
|
||||||
|
Opcode::Bic => ("Clear bits in dst that are set in src, without changing flags", "dst &= !src"),
|
||||||
|
Opcode::Bis => ("Set bits in dst that are set in src, without changing flags", "dst |= src"),
|
||||||
|
Opcode::Xor => ("Bitwise Xor src into dst", "dst ^= src"),
|
||||||
|
Opcode::And => ("Bitwise And src into dst", "dst &= src"),
|
||||||
|
// Emulated
|
||||||
|
Opcode::Nop => ("Does nothing", "{}"),
|
||||||
|
Opcode::Pop => ("Pops a value from the stack", "dst = stack.pop()"),
|
||||||
|
Opcode::Br => ("Branches to the absolute address in src", "pc = src"),
|
||||||
|
Opcode::Ret => ("Returns from subroutine", "pc = stack.pop()"),
|
||||||
|
Opcode::Clrc => ("Clears the carry flag", "sr[C] = 0"),
|
||||||
|
Opcode::Setc => ("Sets the carry flag", "sr[C] = 1"),
|
||||||
|
Opcode::Clrz => ("Clears the zero flag", "sr[Z] = 0"),
|
||||||
|
Opcode::Setz => ("Sets the zero flag", "sr[Z] = 1"),
|
||||||
|
Opcode::Clrn => ("Clears the negative flag", "sr[N] = 0"),
|
||||||
|
Opcode::Setn => ("Sets the negative flag", "sr[N] = 1"),
|
||||||
|
Opcode::Dint => ("Disables interrupts", "sr[GIE] = 0"),
|
||||||
|
Opcode::Eint => ("Enables interrupts", "sr[GIE] = 1"),
|
||||||
|
Opcode::Rla => ("Shifts dst to the left, padding with zeros", "dst <<= 1"),
|
||||||
|
Opcode::Rlc => ("Rotates dst to the left, through carry flag", "dst = (dst << 1) + sr[C]"),
|
||||||
|
Opcode::Inv => ("Inverts the bits in dst", "dst = !dst"),
|
||||||
|
Opcode::Clr => ("Sets dst to 0", "dst = 0"),
|
||||||
|
Opcode::Tst => ("Sets the status register flags (CNZV) using dst", ""),
|
||||||
|
Opcode::Dec => ("Decrements dst", "dst -= 1"),
|
||||||
|
Opcode::Decd => ("Decrements dst by 2 (one processor word)", "dst -= 2"),
|
||||||
|
Opcode::Inc => ("Increments dst", "dst += 1"),
|
||||||
|
Opcode::Incd => ("Increments dst by 2 (one processor word)", "dst += 2"),
|
||||||
|
Opcode::Adc => ("Adds the carry bit to dst", "dst += sr[C]"),
|
||||||
|
Opcode::Dadc => ("Adds the carry bit to dst, in Binary Coded Decimal", "dst as BCD = sr[C]"),
|
||||||
|
Opcode::Sbc => ("Subtracts the carry bit from dst", "dst -= sr[C]"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn list_opcodes() {
|
||||||
|
header!("Single-operand instructions:");
|
||||||
|
println!("rrc\tswpb\trra\tsxt\tpush\tcall\nreti");
|
||||||
|
header!("Relative Jump instructions:");
|
||||||
|
println!("jnz\tjz\tjnc\tjc\tjn\tjge\njl\tjmp");
|
||||||
|
header!("Double-operand instructions:");
|
||||||
|
println!("mov\tadd\taddc\tsubc\tsub\tcmp\ndadd\tbit\tbic\tbis\txor\tand");
|
||||||
|
header!("Simulated instructions:");
|
||||||
|
println!("nop\tpop\tbr\tret\tclrc\tsetc\nclrz\tsetz\tclrn\tsetn\tdint\teint");
|
||||||
|
println!("rla\trlc\tinv\tclr\ttst\tdec\ndecd\tinc\tincd\tadc\tdadc\tsbc");
|
||||||
|
}
|
||||||
|
|
||||||
|
macro header ($($x: expr),+) {
|
||||||
|
{print!("{}",SetForegroundColor(Color::Cyan));print!($($x),+);println!("{}",ResetAttributes);}
|
||||||
|
}
|
||||||
|
macro footer ($($x: expr),+) {
|
||||||
|
{print!("{}",SetForegroundColor(Color::Black));print!($($x),+);println!("{}",ResetAttributes);}
|
||||||
|
}
|
||||||
61
examples/msp430-help/main.rs
Normal file
61
examples/msp430-help/main.rs
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
// This example contains information adapted from the MSPGCC project's documentation.
|
||||||
|
// As such, it is licensed under the GPL, to the extent that such a thing is possible.
|
||||||
|
// https://mspgcc.sourceforge.net/manual/ln16.html
|
||||||
|
#![feature(decl_macro)]
|
||||||
|
|
||||||
|
use anes::{Color, ResetAttributes, SetForegroundColor};
|
||||||
|
use msp430_asm::parser::preamble::*;
|
||||||
|
use msp430_asm::preamble::*;
|
||||||
|
use std::{
|
||||||
|
error::Error,
|
||||||
|
io::{stdin, IsTerminal, Write},
|
||||||
|
};
|
||||||
|
|
||||||
|
type AsmResult<T> = Result<T, Box<dyn Error>>;
|
||||||
|
|
||||||
|
mod data;
|
||||||
|
|
||||||
|
fn main() -> AsmResult<()> {
|
||||||
|
if stdin().is_terminal() {
|
||||||
|
hello();
|
||||||
|
}
|
||||||
|
repl()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn hello() {
|
||||||
|
println!(
|
||||||
|
"{}{} v{}
|
||||||
|
This software contains instruction and register descriptions adapted from
|
||||||
|
the mspgcc project's fantastic documentation, which is licensed under the GPL.
|
||||||
|
https://mspgcc.sourceforge.net/manual/book1.html{}\n",
|
||||||
|
SetForegroundColor(Color::DarkGray),
|
||||||
|
env!("CARGO_BIN_NAME"),
|
||||||
|
env!("CARGO_PKG_VERSION"),
|
||||||
|
ResetAttributes
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn repl() -> AsmResult<()> {
|
||||||
|
printflush!("> ");
|
||||||
|
let mut line = String::new();
|
||||||
|
while let Ok(len) = stdin().read_line(&mut line) {
|
||||||
|
match len {
|
||||||
|
0 => break, // No newline (reached EOF)
|
||||||
|
1 => (), // Line is empty
|
||||||
|
_ => {
|
||||||
|
if line.starts_with('?') || line.starts_with("help") {
|
||||||
|
data::list_opcodes()
|
||||||
|
} else if let Ok(sf) = data::SyntaxFragment::try_from(line.as_str()) {
|
||||||
|
sf.info();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
printflush!("> ");
|
||||||
|
line.clear();
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
macro printflush ($($x: expr),+) {
|
||||||
|
{print!($($x),+); let _ = ::std::io::stdout().flush();}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user