├── .gitattributes ├── .gitignore ├── LICENSE.txt ├── README.md ├── docs ├── MicroMini.html ├── MicroMini.lyx └── MicroMini.txt ├── examples ├── badinstruction.mmbin ├── helloworld.mmasm ├── helloworld.mmbin ├── helloworld2.mmbin └── hi.mmbin ├── main.rkt └── mmasm.rkt /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | *.sln merge=union 7 | *.csproj merge=union 8 | *.vbproj merge=union 9 | *.fsproj merge=union 10 | *.dbproj merge=union 11 | 12 | # Standard to msysgit 13 | *.doc diff=astextplain 14 | *.DOC diff=astextplain 15 | *.docx diff=astextplain 16 | *.DOCX diff=astextplain 17 | *.dot diff=astextplain 18 | *.DOT diff=astextplain 19 | *.pdf diff=astextplain 20 | *.PDF diff=astextplain 21 | *.rtf diff=astextplain 22 | *.RTF diff=astextplain 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.bak 2 | *.*~ 3 | DEADJOE -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MicroMini 2 | ========= 3 | 4 | A simple 8-bit virtual stack machine, with basic terminal I/O powered by CharTerm. 5 | 6 | Depends on a unix stty device, and thus only runs in those environs currently. 7 | 8 | Update 24-8-14: Does not appear to function on FreeBSD, charterm expects stty options which FreeBSD doesn't have. 9 | 10 | Requirements 11 | ------------ 12 | 13 | MicroMini is built with Racket 6.1. If you wish to edit or run the source directly, you will need this installed. 14 | 15 | Usage 16 | ----- 17 | 18 | From source: 19 | 20 | ``` 21 | racket main.rkt 22 | ``` 23 | 24 | From binary: 25 | 26 | ``` 27 | mmini 28 | ``` 29 | MicroMini expects a stream of 8-bit bytes not more than 64kb in length, of correct instructions, which it will execute from address #x0000 to the best of its ability. There is basic checking for a few standard errors: stack over/underflow, and invalid instructions, and MM will halt and report the address the error occured in. 30 | 31 | Documentation 32 | ------------- 33 | 34 | Enclosed in the repo are MicroMini.lyx and MicroMini.html files, which document the instruction set for the MM virtual machine. 35 | 36 | Licensing 37 | --------- 38 | 39 | Copyright 2014 John Berry 40 | 41 | Licensed via the GPL v3 42 | 43 | CharTerm is Copyright 2012-2013 Neil Van Dyke, licensed vial LGPL v3 44 | -------------------------------------------------------------------------------- /docs/MicroMini.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | MicroMini:A Racket-powered 8-bit stack machine 10 | 11 | 12 |
13 |

14 | MicroMini:
15 | A Racket-powered 8-bit stack machine 16 |

17 |

18 | John S. Berry III 19 |

20 |

21 | Last updated 11.08.2014 22 |

23 |

24 | 1 Introduction 25 |

26 |
27 | The MicroMini is a virtual stack machine inspired by classic minicomputers. It is written in Racket, an excellent Scheme-derived Lisp with a specialty in teaching and new language development. MicroMini is purely stack based: other than memory calls, almost all operations take no arguments, collecting their required operands from the top of the stack. 28 |
29 |

30 | 1.1 Specifications 31 |

32 |
33 | The MicroMini is patterned after an imaginary vintage minicomputer, scaled down to home-size. As such, it’s basic specifications are thus kept within those limits, save that at present, the device runs at the full speed of the user’s computer rather than an artificially limited operation speed. 34 |
35 |
    36 |
  • 37 | 8-bit data bus 38 |
    • 39 |
  • 40 | 16-bit address bus 41 |
    • 42 |
  • 43 | 64Kib of RAM 44 |
    • 45 |
  • 46 | 16-bit pointer-based stack 47 |
    • 48 |
  • 49 | 16-bit program and return pointers 50 |
    • 51 |
  • 52 | 1-bit halt flag 53 |
    • 54 |
  • 55 | 1-bit carry flag 56 |
    • 57 |
  • 58 | 8-bit cycle counter 59 |
    • 60 | 61 |
62 |

63 | 1.2 Usage and Requirements 64 |

65 |
66 | At this time, MicroMini only runs on Unix-derived operating systems which provide stty. Future implementations may correct this, however as it stands, there are no Racket libs for Windows platforms which can correctly handle the TRMI and TRMO instructions. 67 |
68 |
69 | If running the binary, you need only invoke it from the command line, like so: 70 |
71 |
72 |
73 | 
mmini <mm-binary-file>
 74 |
75 |
76 | 77 |
78 |
79 | Where mm-binary-file is the filename of a previously created binary file composed of 8-bit bytes of MicroMini machine code. Currently there is no compiler or assembler available for MicroMini, but the author intends to create one soon. 80 |
81 |
82 | If you wish to run MicroMini from the source, you will need to install Racket. The program was created with Racket 6.1, and the author can make no guarantees about backwards compatibility. To install and invoke it, you can do: 83 |
84 |
85 |
86 | 
> git clone https://github.com/jarcane/MicroMini.git
 87 | > cd ./MicroMini
 88 | > racket main.rkt <mm-binary-file>
 89 |
90 |
91 | 92 |
93 |
94 | Where, as before, mm-binary-file is a previously created MM binary. 95 |
96 |

97 | 2 MicroMini Operation 98 |

99 |
100 | On invocation, MicroMini will take the target file, read it byte by byte into memory, and begin executing from address #x0000. It will continue to run through valid instructions until it reaches the end of the RAM bank, it is given a HLT instruction, or there is an error. I/O at this point comes purely via terminal, handled via the TRMI and TRMO instructions. 101 |
102 |
103 | Each cycle, the MicroMini: 104 |
105 |
    106 |
  1. 107 | Executes the instruction found at the address designated by the program counter 108 |
    2. 109 |
  2. 110 | Increments the program pointer by 1 111 |
    3. 112 |
  3. 113 | Checks if the program pointer has reached the end of ram space and, if so, sets the halt-bit 114 |
    4. 115 |
  4. 116 | Checks the cycle counter:
      117 |
    1. 118 | If full, resets to 0 119 |
      2. 120 |
    2. 121 | If not, increments by 1 122 |
      3. 123 | 124 |
    125 | 126 |
    5. 127 |
  5. 128 | Checks the halt-bit, and stops execution if set 129 |
    6. 130 | 131 |
132 |

133 | 3 MicroMini Instructions 134 |

135 |
136 | The following are the standard instructions currently implemented in MicroMini, with descriptions of their operation. 137 |
138 |

139 | 3.1 #x00 NOP - No OPeration 140 |

141 |
142 | Does nothing, and will be skipped by the processor. 143 |
144 |

145 | 3.2 #x01 HLT - HaLT 146 |

147 |
148 | Sets the halt-bit on the processor, which will cause it to end operation at the end of the cycle. 149 |
150 |

151 | 3.3 #x02 DATA num 152 |

153 |
154 | Consumes the next byte, and increments the program pointer by num spaces, essentially skipping over that many bytes in RAM. 155 |
156 |

157 | 3.4 #x10 ADD 158 |

159 |
160 | Pops the top two values in the stack, adds them, and pushes the result to the stack. If there has been an overflow, the carry-bit is set. 161 |
162 |

163 | 3.5 #x20 SUB 164 |

165 |
166 | Pops the top two values in the stack, subtracts the top value from the one below it, and pushes the result to the stack. If there is an underflow, the carry-bit is set. 167 |
168 |

169 | 3.6 #x30 AND 170 |

171 |
172 | Pops the top two values in the stack, ANDs their bits, and pushes the result to the stack. 173 |
174 |

175 | 3.7 #x31 OR 176 |

177 |
178 | Pops the top two values in the stack, ORs their bits, and pushes the result to the stack. 179 |
180 |

181 | 3.8 #x32 XOR 182 |

183 |
184 | Pops the top two values in the stack, XORs their bits, and pushes the result to the stack. 185 |
186 |

187 | 3.9 #x33 NOT 188 |

189 |
190 | Pops the top value from the stack, applies NOT, and pushes the result to the stack. 191 |
192 |

193 | 3.10 #x40 EQ? - EQual? 194 |

195 |
196 | Pops the top two values from the stack, and compares them. If they are equal, pushes 0x01 to the stack. If not equal, pushes 0x00. 197 |
198 |

199 | 3.11 #x41 LES? - LESser? 200 |

201 |
202 | Pops the top two values from the stack, and compares the top value to the one below it. If the top value is lesser, pushes 0x01 to the stack. If the top value is greater, pushes 0x00 to the stack. 203 |
204 |

205 | 3.12 #x42 GRT? - GReaTer? 206 |

207 |
208 | Pops the top two values from the stack, and compares the top value to the one below it. If the top value is greater, pushes 0x01 to the stack. If the top value is lesser, pushes 0x00 to the stack. 209 |
210 |

211 | 3.13 #x50 PUSH num 212 |

213 |
214 | Consumes the next byte of ram, and pushes the value to the stack. 215 |
216 |

217 | 3.14 #x51 PUFA address - PUsh From Address 218 |

219 |
220 | Consumes the next two bytes as an address location, and pushes the value at that address to the stack. 221 |
222 |

223 | 3.15 #x52 PUCA - PUsh CArry 224 |

225 |
226 | Pushes the current carry flag to the stack. 227 |
228 |

229 | 3.16 #x53 PUTI - PUsh TImer 230 |

231 |
232 | Pushes the current value of the cycle counter to the stack. 233 |
234 |

235 | 3.17 #x60 POP 236 |

237 |
238 | Consumes the top value from the stack. 239 |
240 |

241 | 3.18 #x61 POTA address - POp To Address 242 |

243 |
244 | Consumes the next two bytes as an address location, pops the value from the top of the stack, and stores at at that address. 245 |
246 |

247 | 3.19 #x70 JMP address - JuMP 248 |

249 |
250 | Consumes the next two bytes as an address location, and sets the program pointer to continue execution from that address on the next cycle. 251 |
252 |

253 | 3.20 #x71 JSR address - Jump to SubRoutine 254 |

255 |
256 | Stores the current program pointer (skipping itself) to the return pointer, consumes the next two bytes as an address location, then sets the program pointer to continue execution at that address on the next cycle. Note that the return pointer does not actually point to the original location, but rather the location just past the original JSR instruction and its address, in order to prevent unbreakable loops. 257 |
258 |

259 | 3.21 #x72 JIF address - Jump IF 260 |

261 |
262 | Pops the top value of the stack. If it is 0x01, it consumes the next two bytes as an address, then sets the program pointer to continue execution from that address on the next cycle. Otherwise, it skips the next two bytes (to avoid attempting to execute the address values), but otherwise does nothing. 263 |
264 |

265 | 3.22 #x73 RET - Return 266 |

267 |
268 | Sets the program pointer equal to the return pointer, thus causing the CPU to resume execution just past the original JSR on the next cycle. 269 |
270 |

271 | 3.23 #x80 TRMI - TeRMinal Input 272 |

273 |
274 | Waits for the terminal to send a byte of input, then pushes that byte to the stack. 275 |
276 |

277 | 3.24 #x90 TRMO 278 |

279 |
280 | Pops the top value of the stack, and sends the byte to the terminal as output. 281 |
282 | 283 |
284 | 287 |
288 | 289 | 290 | -------------------------------------------------------------------------------- /docs/MicroMini.lyx: -------------------------------------------------------------------------------- 1 | #LyX 2.0 created this file. For more info see http://www.lyx.org/ 2 | \lyxformat 413 3 | \begin_document 4 | \begin_header 5 | \textclass article 6 | \use_default_options true 7 | \maintain_unincluded_children false 8 | \language english 9 | \language_package default 10 | \inputencoding auto 11 | \fontencoding global 12 | \font_roman default 13 | \font_sans default 14 | \font_typewriter default 15 | \font_default_family default 16 | \use_non_tex_fonts false 17 | \font_sc false 18 | \font_osf false 19 | \font_sf_scale 100 20 | \font_tt_scale 100 21 | 22 | \graphics default 23 | \default_output_format default 24 | \output_sync 0 25 | \bibtex_command default 26 | \index_command default 27 | \paperfontsize default 28 | \use_hyperref false 29 | \papersize default 30 | \use_geometry false 31 | \use_amsmath 1 32 | \use_esint 1 33 | \use_mhchem 1 34 | \use_mathdots 1 35 | \cite_engine basic 36 | \use_bibtopic false 37 | \use_indices false 38 | \paperorientation portrait 39 | \suppress_date false 40 | \use_refstyle 1 41 | \index Index 42 | \shortcut idx 43 | \color #008000 44 | \end_index 45 | \secnumdepth 3 46 | \tocdepth 3 47 | \paragraph_separation indent 48 | \paragraph_indentation default 49 | \quotes_language english 50 | \papercolumns 1 51 | \papersides 1 52 | \paperpagestyle default 53 | \tracking_changes false 54 | \output_changes false 55 | \html_math_output 0 56 | \html_css_as_file 0 57 | \html_be_strict false 58 | \end_header 59 | 60 | \begin_body 61 | 62 | \begin_layout Title 63 | MicroMini: 64 | \begin_inset Newline newline 65 | \end_inset 66 | 67 | A Racket-powered 8-bit stack machine 68 | \end_layout 69 | 70 | \begin_layout Author 71 | John S. 72 | Berry III 73 | \end_layout 74 | 75 | \begin_layout Date 76 | Last updated 11.08.2014 77 | \end_layout 78 | 79 | \begin_layout Section 80 | Introduction 81 | \end_layout 82 | 83 | \begin_layout Standard 84 | The MicroMini is a virtual stack machine inspired by classic minicomputers. 85 | It is written in Racket, an excellent Scheme-derived Lisp with a specialty 86 | in teaching and new language development. 87 | MicroMini is purely stack based: other than memory calls, almost all operations 88 | take no arguments, collecting their required operands from the top of the 89 | stack. 90 | 91 | \end_layout 92 | 93 | \begin_layout Subsection 94 | Specifications 95 | \end_layout 96 | 97 | \begin_layout Standard 98 | The MicroMini is patterned after an imaginary vintage minicomputer, scaled 99 | down to home-size. 100 | As such, it's basic specifications are thus kept within those limits, save 101 | that at present, the device runs at the full speed of the user's computer 102 | rather than an artificially limited operation speed. 103 | \end_layout 104 | 105 | \begin_layout Itemize 106 | 8-bit data bus 107 | \end_layout 108 | 109 | \begin_layout Itemize 110 | 16-bit address bus 111 | \end_layout 112 | 113 | \begin_layout Itemize 114 | 64Kib of RAM 115 | \end_layout 116 | 117 | \begin_layout Itemize 118 | 16-bit pointer-based stack 119 | \end_layout 120 | 121 | \begin_layout Itemize 122 | 16-bit program and return pointers 123 | \end_layout 124 | 125 | \begin_layout Itemize 126 | 1-bit halt flag 127 | \end_layout 128 | 129 | \begin_layout Itemize 130 | 1-bit carry flag 131 | \end_layout 132 | 133 | \begin_layout Itemize 134 | 8-bit cycle counter 135 | \end_layout 136 | 137 | \begin_layout Subsection 138 | Usage and Requirements 139 | \end_layout 140 | 141 | \begin_layout Standard 142 | At this time, MicroMini only runs on Unix-derived operating systems which 143 | provide 144 | \emph on 145 | stty. 146 | 147 | \emph default 148 | Future implementations may correct this, however as it stands, there are 149 | no Racket libs for Windows platforms which can correctly handle the TRMI 150 | and TRMO instructions. 151 | \end_layout 152 | 153 | \begin_layout Standard 154 | If running the binary, you need only invoke it from the command line, like 155 | so: 156 | \end_layout 157 | 158 | \begin_layout Standard 159 | \begin_inset listings 160 | inline false 161 | status open 162 | 163 | \begin_layout Plain Layout 164 | 165 | mmini 166 | \end_layout 167 | 168 | \end_inset 169 | 170 | 171 | \end_layout 172 | 173 | \begin_layout Standard 174 | Where 175 | \emph on 176 | mm-binary-file 177 | \emph default 178 | is the filename of a previously created binary file composed of 8-bit bytes 179 | of MicroMini machine code. 180 | Currently there is no compiler or assembler available for MicroMini, but 181 | the author intends to create one soon. 182 | \end_layout 183 | 184 | \begin_layout Standard 185 | If you wish to run MicroMini from the source, you will need to install Racket. 186 | The program was created with Racket 6.1, and the author can make no guarantees 187 | about backwards compatibility. 188 | To install and invoke it, you can do: 189 | \end_layout 190 | 191 | \begin_layout Standard 192 | \begin_inset listings 193 | inline false 194 | status open 195 | 196 | \begin_layout Plain Layout 197 | 198 | > git clone https://github.com/jarcane/MicroMini.git 199 | \end_layout 200 | 201 | \begin_layout Plain Layout 202 | 203 | > cd ./MicroMini 204 | \end_layout 205 | 206 | \begin_layout Plain Layout 207 | 208 | > racket main.rkt 209 | \end_layout 210 | 211 | \end_inset 212 | 213 | 214 | \end_layout 215 | 216 | \begin_layout Standard 217 | Where, as before, 218 | \emph on 219 | mm-binary-file 220 | \emph default 221 | is a previously created MM binary. 222 | \end_layout 223 | 224 | \begin_layout Section 225 | MicroMini Operation 226 | \end_layout 227 | 228 | \begin_layout Standard 229 | On invocation, MicroMini will take the target file, read it byte by byte 230 | into memory, and begin executing from address #x0000. 231 | It will continue to run through valid instructions until it reaches the 232 | end of the RAM bank, it is given a HLT instruction, or there is an error. 233 | I/O at this point comes purely via terminal, handled via the TRMI and TRMO 234 | instructions. 235 | \end_layout 236 | 237 | \begin_layout Standard 238 | Each cycle, the MicroMini: 239 | \end_layout 240 | 241 | \begin_layout Enumerate 242 | Executes the instruction found at the address designated by the program 243 | counter 244 | \end_layout 245 | 246 | \begin_layout Enumerate 247 | Increments the program pointer by 1 248 | \end_layout 249 | 250 | \begin_layout Enumerate 251 | Checks if the program pointer has reached the end of ram space and, if so, 252 | sets the halt-bit 253 | \end_layout 254 | 255 | \begin_layout Enumerate 256 | Checks the cycle counter: 257 | \end_layout 258 | 259 | \begin_deeper 260 | \begin_layout Enumerate 261 | If full, resets to 0 262 | \end_layout 263 | 264 | \begin_layout Enumerate 265 | If not, increments by 1 266 | \end_layout 267 | 268 | \end_deeper 269 | \begin_layout Enumerate 270 | Checks the halt-bit, and stops execution if set 271 | \end_layout 272 | 273 | \begin_layout Section 274 | MicroMini Instructions 275 | \end_layout 276 | 277 | \begin_layout Standard 278 | The following are the standard instructions currently implemented in MicroMini, 279 | with descriptions of their operation. 280 | 281 | \end_layout 282 | 283 | \begin_layout Subsection 284 | #x00 NOP - No OPeration 285 | \end_layout 286 | 287 | \begin_layout Standard 288 | Does nothing, and will be skipped by the processor. 289 | \end_layout 290 | 291 | \begin_layout Subsection 292 | #x01 HLT - HaLT 293 | \end_layout 294 | 295 | \begin_layout Standard 296 | Sets the halt-bit on the processor, which will cause it to end operation 297 | at the end of the cycle. 298 | \end_layout 299 | 300 | \begin_layout Subsection 301 | #x02 DATA 302 | \emph on 303 | num 304 | \end_layout 305 | 306 | \begin_layout Standard 307 | Consumes the next byte, and increments the program pointer by 308 | \emph on 309 | num 310 | \emph default 311 | spaces, essentially skipping over that many bytes in RAM. 312 | \end_layout 313 | 314 | \begin_layout Subsection 315 | #x10 ADD 316 | \end_layout 317 | 318 | \begin_layout Standard 319 | Pops the top two values in the stack, adds them, and pushes the result to 320 | the stack. 321 | If there has been an overflow, the carry-bit is set. 322 | 323 | \end_layout 324 | 325 | \begin_layout Subsection 326 | #x20 SUB 327 | \end_layout 328 | 329 | \begin_layout Standard 330 | Pops the top two values in the stack, subtracts the top value from the one 331 | below it, and pushes the result to the stack. 332 | If there is an underflow, the carry-bit is set. 333 | \end_layout 334 | 335 | \begin_layout Subsection 336 | #x30 AND 337 | \end_layout 338 | 339 | \begin_layout Standard 340 | Pops the top two values in the stack, ANDs their bits, and pushes the result 341 | to the stack. 342 | \end_layout 343 | 344 | \begin_layout Subsection 345 | #x31 OR 346 | \end_layout 347 | 348 | \begin_layout Standard 349 | Pops the top two values in the stack, ORs their bits, and pushes the result 350 | to the stack. 351 | \end_layout 352 | 353 | \begin_layout Subsection 354 | #x32 XOR 355 | \end_layout 356 | 357 | \begin_layout Standard 358 | Pops the top two values in the stack, XORs their bits, and pushes the result 359 | to the stack. 360 | \end_layout 361 | 362 | \begin_layout Subsection 363 | #x33 NOT 364 | \end_layout 365 | 366 | \begin_layout Standard 367 | Pops the top value from the stack, applies NOT, and pushes the result to 368 | the stack. 369 | \end_layout 370 | 371 | \begin_layout Subsection 372 | #x40 EQ? - EQual? 373 | \end_layout 374 | 375 | \begin_layout Standard 376 | Pops the top two values from the stack, and compares them. 377 | If they are equal, pushes 0x01 to the stack. 378 | If not equal, pushes 0x00. 379 | \end_layout 380 | 381 | \begin_layout Subsection 382 | #x41 LES? - LESser? 383 | \end_layout 384 | 385 | \begin_layout Standard 386 | Pops the top two values from the stack, and compares the top value to the 387 | one below it. 388 | If the top value is lesser, pushes 0x01 to the stack. 389 | If the top value is greater, pushes 0x00 to the stack. 390 | \end_layout 391 | 392 | \begin_layout Subsection 393 | #x42 GRT? - GReaTer? 394 | \end_layout 395 | 396 | \begin_layout Standard 397 | Pops the top two values from the stack, and compares the top value to the 398 | one below it. 399 | If the top value is greater, pushes 0x01 to the stack. 400 | If the top value is lesser, pushes 0x00 to the stack. 401 | \end_layout 402 | 403 | \begin_layout Subsection 404 | #x50 PUSH 405 | \emph on 406 | num 407 | \end_layout 408 | 409 | \begin_layout Standard 410 | Consumes the next byte of ram, and pushes the value to the stack. 411 | \end_layout 412 | 413 | \begin_layout Subsection 414 | #x51 PUFA 415 | \emph on 416 | address - 417 | \emph default 418 | PUsh From Address 419 | \end_layout 420 | 421 | \begin_layout Standard 422 | Consumes the next two bytes as an address location, and pushes the value 423 | at that address to the stack. 424 | \end_layout 425 | 426 | \begin_layout Subsection 427 | #x52 PUCA - PUsh CArry 428 | \end_layout 429 | 430 | \begin_layout Standard 431 | Pushes the current carry flag to the stack. 432 | \end_layout 433 | 434 | \begin_layout Subsection 435 | #x53 PUTI - PUsh TImer 436 | \end_layout 437 | 438 | \begin_layout Standard 439 | Pushes the current value of the cycle counter to the stack. 440 | \end_layout 441 | 442 | \begin_layout Subsection 443 | #x60 POP 444 | \end_layout 445 | 446 | \begin_layout Standard 447 | Consumes the top value from the stack. 448 | \end_layout 449 | 450 | \begin_layout Subsection 451 | #x61 POTA 452 | \emph on 453 | address - 454 | \emph default 455 | POp To Address 456 | \end_layout 457 | 458 | \begin_layout Standard 459 | Consumes the next two bytes as an address location, pops the value from 460 | the top of the stack, and stores at at that address. 461 | \end_layout 462 | 463 | \begin_layout Subsection 464 | #x70 JMP 465 | \emph on 466 | address - 467 | \emph default 468 | JuMP 469 | \end_layout 470 | 471 | \begin_layout Standard 472 | Consumes the next two bytes as an address location, and sets the program 473 | pointer to continue execution from that address on the next cycle. 474 | \end_layout 475 | 476 | \begin_layout Subsection 477 | #x71 JSR 478 | \emph on 479 | address - 480 | \emph default 481 | Jump to SubRoutine 482 | \end_layout 483 | 484 | \begin_layout Standard 485 | Stores the current program pointer (skipping itself) to the return pointer, 486 | consumes the next two bytes as an address location, then sets the program 487 | pointer to continue execution at that address on the next cycle. 488 | Note that the return pointer does not actually point to the original location, 489 | but rather the location just past the original JSR instruction and its 490 | address, in order to prevent unbreakable loops. 491 | \end_layout 492 | 493 | \begin_layout Subsection 494 | #x72 JIF 495 | \emph on 496 | address - 497 | \emph default 498 | Jump IF 499 | \end_layout 500 | 501 | \begin_layout Standard 502 | Pops the top value of the stack. 503 | If it is 0x01, it consumes the next two bytes as an address, then sets 504 | the program pointer to continue execution from that address on the next 505 | cycle. 506 | Otherwise, it skips the next two bytes (to avoid attempting to execute 507 | the address values), but otherwise does nothing. 508 | \end_layout 509 | 510 | \begin_layout Subsection 511 | #x73 RET - Return 512 | \end_layout 513 | 514 | \begin_layout Standard 515 | Sets the program pointer equal to the return pointer, thus causing the CPU 516 | to resume execution just past the original JSR on the next cycle. 517 | \end_layout 518 | 519 | \begin_layout Subsection 520 | #x80 TRMI - TeRMinal Input 521 | \end_layout 522 | 523 | \begin_layout Standard 524 | Waits for the terminal to send a byte of input, then pushes that byte to 525 | the stack. 526 | \end_layout 527 | 528 | \begin_layout Subsection 529 | #x90 TRMO 530 | \end_layout 531 | 532 | \begin_layout Standard 533 | Pops the top value of the stack, and sends the byte to the terminal as output. 534 | 535 | \end_layout 536 | 537 | \end_body 538 | \end_document 539 | -------------------------------------------------------------------------------- /docs/MicroMini.txt: -------------------------------------------------------------------------------- 1 | MicroMini: 2 | A Racket-powered 8-bit stack machine 3 | 4 | John S. Berry III 5 | 6 | Last updated 11.08.2014 7 | 8 | 1 Introduction 9 | 10 | The MicroMini is a virtual stack machine inspired by classic 11 | minicomputers. It is written in Racket, an excellent 12 | Scheme-derived Lisp with a specialty in teaching and new language 13 | development. MicroMini is purely stack based: other than memory 14 | calls, almost all operations take no arguments, collecting their 15 | required operands from the top of the stack. 16 | 17 | 1.1 Specifications 18 | 19 | The MicroMini is patterned after an imaginary vintage 20 | minicomputer, scaled down to home-size. As such, it's basic 21 | specifications are thus kept within those limits, save that at 22 | present, the device runs at the full speed of the user's computer 23 | rather than an artificially limited operation speed. 24 | 25 | • 8-bit data bus 26 | 27 | • 16-bit address bus 28 | 29 | • 64Kib of RAM 30 | 31 | • 16-bit pointer-based stack 32 | 33 | • 16-bit program and return pointers 34 | 35 | • 1-bit halt flag 36 | 37 | • 1-bit carry flag 38 | 39 | • 8-bit cycle counter 40 | 41 | 1.2 Usage and Requirements 42 | 43 | At this time, MicroMini only runs on Unix-derived operating 44 | systems which provide stty. Future implementations may correct 45 | this, however as it stands, there are no Racket libs for Windows 46 | platforms which can correctly handle the TRMI and TRMO 47 | instructions. 48 | 49 | If running the binary, you need only invoke it from the command 50 | line, like so: 51 | 52 | mmini 53 | 54 | Where mm-binary-file is the filename of a previously created 55 | binary file composed of 8-bit bytes of MicroMini machine code. 56 | Currently there is no compiler or assembler available for 57 | MicroMini, but the author intends to create one soon. 58 | 59 | If you wish to run MicroMini from the source, you will need to 60 | install Racket. The program was created with Racket 6.1, and the 61 | author can make no guarantees about backwards compatibility. To 62 | install and invoke it, you can do: 63 | 64 | > git clone https://github.com/jarcane/MicroMini.git 65 | 66 | > cd ./MicroMini 67 | 68 | > racket main.rkt 69 | 70 | Where, as before, mm-binary-file is a previously created MM 71 | binary. 72 | 73 | 2 MicroMini Operation 74 | 75 | On invocation, MicroMini will take the target file, read it byte 76 | by byte into memory, and begin executing from address #x0000. It 77 | will continue to run through valid instructions until it reaches 78 | the end of the RAM bank, it is given a HLT instruction, or there 79 | is an error. I/O at this point comes purely via terminal, handled 80 | via the TRMI and TRMO instructions. 81 | 82 | Each cycle, the MicroMini: 83 | 84 | 1. Executes the instruction found at the address designated by 85 | the program counter 86 | 87 | 2. Increments the program pointer by 1 88 | 89 | 3. Checks if the program pointer has reached the end of ram space 90 | and, if so, sets the halt-bit 91 | 92 | 4. Checks the cycle counter: 93 | 94 | (a) If full, resets to 0 95 | 96 | (b) If not, increments by 1 97 | 98 | 5. Checks the halt-bit, and stops execution if set 99 | 100 | 3 MicroMini Instructions 101 | 102 | The following are the standard instructions currently implemented 103 | in MicroMini, with descriptions of their operation. 104 | 105 | 3.1 #x00 NOP - No OPeration 106 | 107 | Does nothing, and will be skipped by the processor. 108 | 109 | 3.2 #x01 HLT - HaLT 110 | 111 | Sets the halt-bit on the processor, which will cause it to end 112 | operation at the end of the cycle. 113 | 114 | 3.3 #x02 DATA num 115 | 116 | Consumes the next byte, and increments the program pointer by num 117 | spaces, essentially skipping over that many bytes in RAM. 118 | 119 | 3.4 #x10 ADD 120 | 121 | Pops the top two values in the stack, adds them, and pushes the 122 | result to the stack. If there has been an overflow, the carry-bit 123 | is set. 124 | 125 | 3.5 #x20 SUB 126 | 127 | Pops the top two values in the stack, subtracts the top value 128 | from the one below it, and pushes the result to the stack. If 129 | there is an underflow, the carry-bit is set. 130 | 131 | 3.6 #x30 AND 132 | 133 | Pops the top two values in the stack, ANDs their bits, and pushes 134 | the result to the stack. 135 | 136 | 3.7 #x31 OR 137 | 138 | Pops the top two values in the stack, ORs their bits, and pushes 139 | the result to the stack. 140 | 141 | 3.8 #x32 XOR 142 | 143 | Pops the top two values in the stack, XORs their bits, and pushes 144 | the result to the stack. 145 | 146 | 3.9 #x33 NOT 147 | 148 | Pops the top value from the stack, applies NOT, and pushes the 149 | result to the stack. 150 | 151 | 3.10 #x40 EQ? - EQual? 152 | 153 | Pops the top two values from the stack, and compares them. If 154 | they are equal, pushes 0x01 to the stack. If not equal, pushes 155 | 0x00. 156 | 157 | 3.11 #x41 LES? - LESser? 158 | 159 | Pops the top two values from the stack, and compares the top 160 | value to the one below it. If the top value is lesser, pushes 161 | 0x01 to the stack. If the top value is greater, pushes 0x00 to 162 | the stack. 163 | 164 | 3.12 #x42 GRT? - GReaTer? 165 | 166 | Pops the top two values from the stack, and compares the top 167 | value to the one below it. If the top value is greater, pushes 168 | 0x01 to the stack. If the top value is lesser, pushes 0x00 to the 169 | stack. 170 | 171 | 3.13 #x50 PUSH num 172 | 173 | Consumes the next byte of ram, and pushes the value to the stack. 174 | 175 | 3.14 #x51 PUFA address - PUsh From Address 176 | 177 | Consumes the next two bytes as an address location, and pushes 178 | the value at that address to the stack. 179 | 180 | 3.15 #x52 PUCA - PUsh CArry 181 | 182 | Pushes the current carry flag to the stack. 183 | 184 | 3.16 #x53 PUTI - PUsh TImer 185 | 186 | Pushes the current value of the cycle counter to the stack. 187 | 188 | 3.17 #x60 POP 189 | 190 | Consumes the top value from the stack. 191 | 192 | 3.18 #x61 POTA address - POp To Address 193 | 194 | Consumes the next two bytes as an address location, pops the 195 | value from the top of the stack, and stores at at that address. 196 | 197 | 3.19 #x70 JMP address - JuMP 198 | 199 | Consumes the next two bytes as an address location, and sets the 200 | program pointer to continue execution from that address on the 201 | next cycle. 202 | 203 | 3.20 #x71 JSR address - Jump to SubRoutine 204 | 205 | Stores the current program pointer (skipping itself) to the 206 | return pointer, consumes the next two bytes as an address 207 | location, then sets the program pointer to continue execution at 208 | that address on the next cycle. Note that the return pointer does 209 | not actually point to the original location, but rather the 210 | location just past the original JSR instruction and its address, 211 | in order to prevent unbreakable loops. 212 | 213 | 3.21 #x72 JIF address - Jump IF 214 | 215 | Pops the top value of the stack. If it is 0x01, it consumes the 216 | next two bytes as an address, then sets the program pointer to 217 | continue execution from that address on the next cycle. 218 | Otherwise, it skips the next two bytes (to avoid attempting to 219 | execute the address values), but otherwise does nothing. 220 | 221 | 3.22 #x73 RET - Return 222 | 223 | Sets the program pointer equal to the return pointer, thus 224 | causing the CPU to resume execution just past the original JSR on 225 | the next cycle. 226 | 227 | 3.23 #x80 TRMI - TeRMinal Input 228 | 229 | Waits for the terminal to send a byte of input, then pushes that 230 | byte to the stack. 231 | 232 | 3.24 #x90 TRMO 233 | 234 | Pops the top value of the stack, and sends the byte to the 235 | terminal as output. 236 | 237 | -------------------------------------------------------------------------------- /examples/badinstruction.mmbin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jarcane/MicroMini/521770bb3bf1b6c6f896b6ac353dddd1e95afcab/examples/badinstruction.mmbin -------------------------------------------------------------------------------- /examples/helloworld.mmasm: -------------------------------------------------------------------------------- 1 | DATA 12 Hello #x20 World! 2 | PUFA #x00 #x13 3 | PUFA #x00 #x02 4 | TRMO 5 | PUSH 1 6 | ADD 7 | POTA #x00 #x13 8 | PUFA #x00 #x13 9 | PUSH #x0e 10 | GRT? 11 | JIF #x00 #x0e 12 | HLT 13 | -------------------------------------------------------------------------------- /examples/helloworld.mmbin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jarcane/MicroMini/521770bb3bf1b6c6f896b6ac353dddd1e95afcab/examples/helloworld.mmbin -------------------------------------------------------------------------------- /examples/helloworld2.mmbin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jarcane/MicroMini/521770bb3bf1b6c6f896b6ac353dddd1e95afcab/examples/helloworld2.mmbin -------------------------------------------------------------------------------- /examples/hi.mmbin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jarcane/MicroMini/521770bb3bf1b6c6f896b6ac353dddd1e95afcab/examples/hi.mmbin -------------------------------------------------------------------------------- /main.rkt: -------------------------------------------------------------------------------- 1 | #lang racket 2 | 3 | ; MicroMini - A vintage minicomputer inspired stack machine 4 | ; 5 | ; Copyright 2014 John S. Berry III 6 | ; 7 | ; This program is free software: you can redistribute it and/or modify 8 | ; it under the terms of the GNU General Public License as published by 9 | ; the Free Software Foundation, either version 3 of the License, or 10 | ; (at your option) any later version. 11 | ; 12 | ; This program is distributed in the hope that it will be useful, 13 | ; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ; GNU General Public License for more details. 16 | ; 17 | ; You should have received a copy of the GNU General Public License 18 | ; along with this program. If not, see . 19 | 20 | (require racket/fixnum) 21 | (require racket/cmdline) 22 | (require racket/format) 23 | (require (planet neil/charterm:3:1)) 24 | 25 | ; Constants 26 | (define DATA-BUS 8) ; the data bus width 27 | (define DATA-MASK (sub1 (expt 2 DATA-BUS))) ; The bitmask used to constrain add/sub 28 | (define CARRY-MASK (expt 2 DATA-BUS)) ; The bitmask used to check for carry 29 | (define ADDRESS-BUS 16) ; the address bus width 30 | (define STACK-SIZE 16) 31 | (define RAM-SIZE (expt 2 ADDRESS-BUS)) 32 | 33 | ; Initialize the terminal 34 | ;(define term (open-charterm #:current? #t)) 35 | 36 | ;; Helper Functions 37 | 38 | ; Byte-string maker 39 | ; given a number of bits that are a multiple of 8, returns bytestring of that many bytes 40 | (define (bits x) 41 | (make-bytes (/ x 8) 0)) 42 | 43 | ; Turns bytes into integer decimals for internal use by Racket 44 | (define (decode bytes) 45 | (if (= (bytes-length bytes) 1) 46 | (bytes-ref bytes 0) 47 | (integer-bytes->integer bytes #f #t))) 48 | 49 | ; Converts a boolean to 1 for #t and 0 for #f 50 | (define (bool->int x) 51 | (if (false? x) 52 | 0 53 | 1)) 54 | 55 | ; increments the program pointer 56 | (define (add1-progptr) 57 | (set-register-progptr! cpu (add1 (register-progptr cpu))) 58 | (when (>= (register-progptr cpu) RAM-SIZE) (crash-handler "Out of Address"))) 59 | 60 | ; gets an address from the next two bytes in RAM 61 | (define (get-address) 62 | (let ([x 0] 63 | [y 0]) 64 | (add1-progptr) 65 | (set! x (vector-ref ram (register-progptr cpu))) 66 | (add1-progptr) 67 | (set! y (vector-ref ram (register-progptr cpu))) 68 | (decode (bytes-append x y)))) 69 | 70 | ; Add with overflow, returns fxvector with result and carry flag 71 | (define (add/overflow a b) 72 | (let ([x (fx+ a b)]) 73 | (fxvector (fxand DATA-MASK x) (fxrshift (fxand CARRY-MASK x) DATA-BUS)))) 74 | 75 | ; Subtraction with overflow, returns fxvector with result and carry flag 76 | (define (sub/overflow a b) 77 | (let ([x (fx- a b)]) 78 | (fxvector (fxand DATA-MASK x) (fxrshift (fxand CARRY-MASK x) DATA-BUS)))) 79 | 80 | ; execute - executes a given instruction, with all requisite side effects. 81 | (define (execute instr) 82 | (if (hash-has-key? INSTRUCTIONS instr) 83 | ((hash-ref INSTRUCTIONS instr)) ; looks up the instruction in the INSTRUCTION hash and executes 84 | (crash-handler "Invalid Instruction"))) 85 | 86 | ; Crash Handler: takes an error message, dumps key values, and displays it 87 | (define (crash-handler cause) 88 | (let ([p (num->hex (register-progptr cpu))]) 89 | (charterm-newline) 90 | (charterm-display (string-append cause " at #x" p)) 91 | (set-register-halt! cpu 1))) 92 | 93 | ; Make a number into a hexadecimal string 94 | (define (num->hex num) 95 | (~r num #:base 16 #:min-width (/ ADDRESS-BUS 4) #:pad-string "0")) 96 | 97 | ;; Main Variables 98 | 99 | ; Instruction Table 100 | (define INSTRUCTIONS (hash #"\x00" (lambda () (void)) ; No OPeration 101 | #"\x01" (lambda () (set-register-halt! cpu 1)) ; HaLT 102 | #"\x02" (lambda () 103 | (add1-progptr) 104 | (set-register-progptr! 105 | cpu 106 | (+ (register-progptr cpu) 107 | (decode (vector-ref ram (register-progptr cpu)))))) ; DATA 108 | #"\x10" (lambda () 109 | (let ([result (add/overflow (pop) (pop))]) 110 | (push (fxvector-ref result 0)) 111 | (set-register-carry! cpu (fxvector-ref result 1)))) ; ADD 112 | #"\x20" (lambda () 113 | (let ([result (sub/overflow (pop) (pop))]) 114 | (push (fxvector-ref result 0)) 115 | (set-register-carry! cpu (fxvector-ref result 1)))) ; SUBtract 116 | #"\x30" (lambda () 117 | (push (bitwise-and (pop) (pop)))) ; AND 118 | #"\x31" (lambda () 119 | (push (bitwise-ior (pop) (pop)))) ; OR 120 | #"\x32" (lambda () 121 | (push (bitwise-xor (pop) (pop)))) ; XOR 122 | #"\x33" (lambda () 123 | (push (bitwise-not (pop)))) ; NOT 124 | #"\x40" (lambda () 125 | (push (bool->int (= (pop) (pop))))) ; EQuals? 126 | #"\x41" (lambda () 127 | (push (bool->int (< (pop) (pop))))) ; LESser? 128 | #"\x42" (lambda () 129 | (push (bool->int (> (pop) (pop))))) ; GReaTer? 130 | #"\x50" (lambda () 131 | (add1-progptr) 132 | (push (decode (vector-ref ram (register-progptr cpu))))) ; PUSH 133 | #"\x51" (lambda () 134 | (push (decode (vector-ref ram (get-address))))) ; PUsh From Address 135 | #"\x52" (lambda () 136 | (push (register-carry cpu))) ; PUsh CArry 137 | #"\x53" (lambda () 138 | (push (register-cycles cpu))) ; PUsh TImer 139 | #"\x60" (lambda () (pop)) ; POP 140 | #"\x61" (lambda () 141 | (vector-set! ram (get-address) (bytes (pop)))) ; POp To Address 142 | #"\x70" (lambda () 143 | (set-register-progptr! cpu (sub1 (get-address)))) ; JuMP 144 | #"\x71" (lambda () 145 | (set-register-retptr! cpu (+ 2 (register-progptr cpu))) 146 | (set-register-progptr! cpu (sub1 (get-address)))) ; Jump to SubRoutine 147 | #"\x72" (lambda () 148 | (if (= (pop) 0) 149 | (void (get-address)) 150 | (set-register-progptr! cpu (sub1 (get-address))))) ; Jump IF 151 | #"\x73" (lambda () 152 | (set-register-progptr! cpu (register-retptr cpu))) ; RETurn 153 | #"\x80" (lambda () 154 | (let ([key (charterm-read-keyinfo)]) 155 | (push (first (charterm-keyinfo-bytelist key))))) ; TeRMinal Input 156 | #"\x90" (lambda () 157 | (charterm-display (bytes (pop)))) ; TeRMinal Output 158 | )) 159 | 160 | ; The CPU contains two pointers (program, return), the main stack, 161 | ; and a cycle counter 162 | (struct register (progptr retptr stkptr cycles carry halt) 163 | #:mutable #:transparent) 164 | 165 | ; Now we create the initial CPU instance 166 | (define cpu (register 167 | 0 ; program pointer 168 | 0 ; return pointer 169 | -1 ; stack pointer 170 | 0 ; Cycle counter 171 | 0 ; Carry flag 172 | 0)) ; Halt-bit 173 | 174 | ; Create the stack, STACK-SIZE long 175 | ; This is kept as integer values internally (rather than bytes) to avoid repetitive decode-encode cycles 176 | ; PUSH/POP instructions instead decode/encode any operations that transmit between RAM or I/O 177 | (define stack (make-vector STACK-SIZE 0)) 178 | 179 | ; Next we create the RAM array, a vector of bytes as long as RAM-SIZE 180 | ; This is kept as bytestrings, for easier dumping and hash-referencing of instructions 181 | (define ram (make-vector RAM-SIZE (bits DATA-BUS))) 182 | 183 | ;; Stack Functions 184 | 185 | ; push - Takes an integer, then puts it in the stack 186 | ; moving the pointer to match. 187 | (define (push num) 188 | (set-register-stkptr! cpu (add1 (register-stkptr cpu))) 189 | (if (> (register-stkptr cpu) STACK-SIZE) 190 | (crash-handler "Stack Overflow") 191 | (vector-set! stack (register-stkptr cpu) num))) 192 | 193 | ; pop - returns the current top value of the stack and removes it, decrementing the stack pointer 194 | (define (pop) 195 | (when (< (register-stkptr cpu) 0) (crash-handler "Stack Underflow")) 196 | (define ret (vector-ref stack (register-stkptr cpu))) 197 | (vector-set! stack (register-stkptr cpu) 0) 198 | (set-register-stkptr! cpu (sub1 (register-stkptr cpu))) 199 | ret) 200 | 201 | ;; Execution cycle 202 | 203 | ; run - the main run-time loop for the CPU 204 | ; Steps through ram, decoding then executing instruction, then incrementing progptr and cycles 205 | (define (run) 206 | (let loop () 207 | (let ([instr (vector-ref ram (register-progptr cpu))]) ; Grab the next instruction 208 | (execute instr) ; execute the instr 209 | (add1-progptr) ; increment program register 210 | (when (>= (register-progptr cpu) RAM-SIZE) 211 | (set-register-halt! cpu 1)) ; If the program counter reaches the bounds of memory, halt 212 | (if (byte? (register-cycles cpu)) ; check if the cycle counter is under a byte 213 | (set-register-cycles! cpu (add1 (register-cycles cpu))) ; incr if so 214 | (set-register-cycles! cpu 0))) ; reset if too big 215 | (when (= (register-halt cpu) 0) (loop)))) ; check the halt bit, and keep running if off 216 | 217 | ;; Startup behaviors 218 | 219 | ; Get file to run from command-line 220 | (define file-to-run 221 | (command-line 222 | #:args (filename) 223 | filename)) 224 | 225 | ; Read the file byte-by-byte into memory 226 | (let ([index 0]) 227 | (for ([c (in-port read-byte (open-input-file file-to-run))]) 228 | (vector-set! ram index (bytes c)) 229 | (set! index (add1 index)))) 230 | 231 | ; Set up terminal and run program 232 | (void (with-charterm 233 | (run) 234 | (charterm-newline) 235 | (crash-handler "Execution ended") 236 | (charterm-newline))) 237 | 238 | -------------------------------------------------------------------------------- /mmasm.rkt: -------------------------------------------------------------------------------- 1 | #lang racket 2 | 3 | ;; MMASM - The MicroMini Assembler 4 | ; 5 | ; Translates MicroMini assembler into executable binaries for the MicroMini virtual machine. 6 | ; 7 | ; Copyright 2014 John S Berry III 8 | ; 9 | ; This program is free software: you can redistribute it and/or modify 10 | ; it under the terms of the GNU General Public License as published by 11 | ; the Free Software Foundation, either version 3 of the License, or 12 | ; (at your option) any later version. 13 | ; 14 | ; This program is distributed in the hope that it will be useful, 15 | ; but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | ; GNU General Public License for more details. 18 | ; 19 | ; You should have received a copy of the GNU General Public License 20 | ; along with this program. If not, see . 21 | 22 | (require racket/cmdline) 23 | 24 | ; The Lookup Table 25 | 26 | (define LOOKUP (hash "NOP" #"\x00" 27 | "HLT" #"\x01" 28 | "DATA" #"\x02" 29 | "ADD" #"\x10" 30 | "SUB" #"\x20" 31 | "AND" #"\x30" 32 | "OR" #"\x31" 33 | "XOR" #"\x32" 34 | "NOT" #"\x33" 35 | "EQ?" #"\x40" 36 | "LES?" #"\x41" 37 | "GRT?" #"\x42" 38 | "PUSH" #"\x50" 39 | "PUFA" #"\x51" 40 | "PUCA" #"\x52" 41 | "PUTI" #"\x53" 42 | "POP" #"\x60" 43 | "POTA" #"\x61" 44 | "JMP" #"\x70" 45 | "JSR" #"\x71" 46 | "JIF" #"\x72" 47 | "RET" #"\x73" 48 | "TRMI" #"\x80" 49 | "TRMO" #"\x90")) 50 | 51 | ; Get the filename to be assembled from the command line 52 | (define filenames 53 | (command-line 54 | #:args (asm-file bin-file) 55 | (list asm-file bin-file))) 56 | 57 | ; Initialize the empty byte stream 58 | (define binary #"") 59 | 60 | ;; Main Functions 61 | 62 | ; Converts numbers or characters to bytes 63 | (define (input-bytes input) 64 | (cond 65 | [(string->number input) (let ([num (string->number input)]) 66 | (cond [(byte? num) (bytes num)] 67 | [(< input (expt 2 16)) (integer->integer-bytes num 2 #f #t)] 68 | [else (error "MASM only supports 8-bit or 16-bit numbers")]))] 69 | [(string? input) (let ([bstr #""]) 70 | (for ([i input]) 71 | (if (byte? (char->integer i)) 72 | (set! bstr (bytes-append bstr (bytes (char->integer i)))) 73 | (error "Unsupported ASCII character"))) 74 | bstr)] 75 | [else (error "Unidentified or unsupported input")])) 76 | 77 | ; Encodes an input into bytes and appends it to the running binary 78 | (define (encode input) 79 | (if (hash-has-key? LOOKUP input) 80 | (set! binary (bytes-append binary (hash-ref LOOKUP input))) 81 | (set! binary (bytes-append binary (input-bytes input))))) 82 | 83 | ; Parses the file and sends it to encode 84 | (define (parse) 85 | (for ([c (in-port read-line (open-input-file (first filenames)))]) 86 | (let ([s (string-split c)]) 87 | (for ([i s]) 88 | (encode i))))) 89 | 90 | ; Writes the binary to a file 91 | (define (write-binary) 92 | (with-output-to-file (second filenames) 93 | (lambda () (write-bytes binary)) #:exists 'replace)) 94 | 95 | ;; Main Execution 96 | (parse) 97 | (write-binary) --------------------------------------------------------------------------------