diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/DJ-ISA_rev_0.0.3.md | 174 | ||||
| -rw-r--r-- | doc/LICENSE | 451 | ||||
| -rw-r--r-- | doc/Makefile | 24 | ||||
| -rw-r--r-- | doc/README.md | 8 | ||||
| -rw-r--r-- | doc/missfont.log | 3 | ||||
| -rw-r--r-- | doc/src/01-About.md | 73 | ||||
| -rw-r--r-- | doc/src/02-Instruction-Format.md | 5 | ||||
| -rw-r--r-- | doc/src/03-Instruction-Set-Reference.md | 92 | ||||
| -rw-r--r-- | doc/src/04-System-Architecture-Overview.md | 14 | ||||
| -rw-r--r-- | doc/src/05-Interrupt-Handling.md | 30 | ||||
| -rw-r--r-- | doc/src/06-Memory-Management.md | 11 | ||||
| -rw-r--r-- | doc/src/figs/registers.svg | 4 | ||||
| -rw-r--r-- | doc/src/title.txt | 8 |
13 files changed, 897 insertions, 0 deletions
diff --git a/doc/DJ-ISA_rev_0.0.3.md b/doc/DJ-ISA_rev_0.0.3.md new file mode 100644 index 0000000..f8c85a3 --- /dev/null +++ b/doc/DJ-ISA_rev_0.0.3.md @@ -0,0 +1,174 @@ +# Vertex KISS 48 - Machine Code Spec + +## General Instruction Format + X = HEX + B = BIN + + d = HEX (not used / don't care) + + MAX INSTRUCTIIONS = 256 + ALL INSTRUCTIONS ARE ATOMIC + +### C-Type, Control + XX XX XX XXXXXX + Opcode dd RS1 Address/IMM + +### I-Type, Immediate + XX XX XX XXXXXX + Opcode RD RS IMM + +### R-Type, Arithmetic + XX XXXX XX XX XX + Opcode dddd RD RS1 RS2 + +### J-Type, Jump / Branch + XX XX XXXX XXXX + Opcode dd Address (XX * 2^32 + XXXX) + +## Registers + Maximum registers = 16 + Register width = 32 + All are R/W except 0X + + 0X Always Zero + AX GP-0 + BX GP-1 + CX GP-2 + DX GP-3 + EX GP-4 + FX GP-5 + GX GP-6 + FX GP-7 + HI Mult/Div Hi + LO Mult/Div Lo + FLG Processor Flags + CRX Control register (Writable only in supervisor mode) + IP Instruction Pointer + SP Stack Pointer + + +### FLG Register Bitfield + These registers are Read/Write + + NOTE: + I think this is needed in order to restore from interupt, if this is not true, then I propose the + bottom half be read only and the top half be read / write. Then just re-assign the registers to differnt locations + + FLG[0] Carry + FLG[1] Overflow + FLG[2] Zero + FLG[3] Sign + FLG[4]* Interrupt Enable + FLG[5]* User Mode + FLG[6-31] RESERVED + +*To be moved to control register* + +## Integer Instructions + +### R-Type + ADD RD, RS1, RS2 RD = RS1 + RS2 + SUB RD, RS1, RS2 RD = RS1 - RS2 + XOR RD, RS1, RS2 RD = RS1 ^ RS2 + OR RD, RS1, RS2 RD = RS1 | RS2 + AND RD, RS1, RS2 RD = RS1 & RS2 + LSL RD, RS1, RS2 RD = RS1 << RS2 (logical) + LSR RD, RS1, RS2 RD = RS1 >> RS2 (logical) + ASR RD, RS1, RS2 RD = RS1 >> RS2 + MUL RD, RS1, RS2 HI,LO = RS1 * RS2 + MULU RD, RS1, RS2 HI,LO = RS1 * RS2 + DIV RD, RS1, RS2 HI,LO = RS1 / RS2 + DIVU RD, RS1, RS2 HI,LO = RS1 / RS2 (unsigned) + + LDB RD, RS1, RS2 RD = &(RS1 + RS2) Load Byte + STB RD, RS1, RS2 &(RS1 + RS2) = (RD >> 24) Store Byte + LDW RD, RS1, RS2 RD = &(RS1 + RS2) Load Word (4 bytes) + STW RD, RS1, RS2 &(RS1 + RS2) = RD Store Word (4 bytes) + + +### I-Type + ADDI RD, RS, IMM RD = RS + IMM + SUBI RD, RS, IMM RD = RS - IMM + XORI RD, RS, IMM RD = RS ^ IMM + ORI RD, RS, IMM RD = RS | IMM + ANDI RD, RS, IMM RD = RS & IMM + LSLI RD, RS, IMM RD = RS << IMM (logical) + LSRI RD, RS, IMM RD = RS >> IMM (logical) + ASRI RD, RS, IMM RD = RS >> IMM + MULI dd, RS, IMM HI,LO = RS * IMM + MULIU dd, RS, IMM HI,LO = RS * IMM + DIVI dd, RS, IMM HI,LO = RS / IMM + DIVIU dd, RS, IMM HI,LO = RS / IMM (unsigned) + + LDBI RD, RS, RS2 RD = &(RS + IMM) Load Byte + STBI RD, RS, RS2 &(RS + IMM) = (RD >> 24) Store Byte + LDWI RD, RS, RS2 RD = &(RS + IMM) Load Word (4 bytes) + STWI RD, RS, RS2 &(RS + IMM) = RD Store Word (4 bytes) + + +### Jump Instructions + JMP ADDR IP = ADDR + JEQ ADDR if (FLG.ZERO == 1) IP = ADDR + JLT ADDR if (FLG.SIGN == 0) IP = ADDR + JGT* ADDR if (FLG.SIGN == 1) IP = ADDR + JLE ADDR if (FLG.ZERO == 1 & FLG.SIGN == 0) IP = ADDR + JGE ADDR if (FLG.ZERO == 1 & FLG.SIGN == 1) IP = ADDR + JLTU ADDR if (FLG.OVERFLOW == 1) IP = ADDR + JGTU ADDR if (FLG.OVERFLOW == 0) IP = ADDR + JLEU* ADDR if (FLG.ZERO == 1 & FLG.SIGN == 0) IP = ADDR + JGEU* ADDR if (FLG.ZERO == 1 & FLG.SIGN == 1) IP = ADDR + +*Duplicate OP code* + +### Control Instructions + NOP Do nothing -> opcode = ZERO + PUSHR RS SP+=4;SP = RS + POPR RS RS = SP;SP-=4 + PUSHI IMM SP+=4;SP = IMM + INVP IMM Invalidate entry in TLB + RET POPR BX;JMP BX + CALL IMM PUSHI $;JMP ADDR + INT IMM PUSHR SP;PUSHR FLG;PUSHR IP;PUSHI errno;IP = IDT[IMM] + IRET POPR IP;POPR FLG;POPR SP + SIF Set interrupt flag + CIF Clear interrupt flag + +## Interrupt Descriptor Table +This will be in a fixed memory location, this will contain pointers to the interupt function. Once an interupt is entered, all interupts are turned off. + + IDT[0] Divide-by-zero exception + IDT[1] Hardware error (NMI) + IDT[2] Overflow + IDT[3] Invalid Opcode + IDT[4] General-protection fault + IDT[5] Page fault + IDT[6-15] RESERVED + + IDT[16-255] Platform interrupts (PIC, hard drive, keyboard, etc.) + IDT[80] Software interrupt (reserved for OS) + + + + + + + + + + +## Page Directory + +The page directory contains 1024 page tables that have 1024 entries. + +### Page table layout + +PT[0] Present +PT[1] R/W +PT[2] User-mode +PT[3-4] RESERVED +PT[5] Accessed +PT[6-7] RESERVED +PT[8-31] Physical address of page table (XX * 2^16 + XXXX) + + *This is still WIP but I wanted to get your input on the layout. I also have + the jank memory offset that will more than likely change.* diff --git a/doc/LICENSE b/doc/LICENSE new file mode 100644 index 0000000..857214d --- /dev/null +++ b/doc/LICENSE @@ -0,0 +1,451 @@ + + GNU Free Documentation License + Version 1.3, 3 November 2008 + + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The "publisher" means any person or entity that distributes copies of +the Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects. + +You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation 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. See +https://www.gnu.org/licenses/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..f6f1090 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,24 @@ +BOOK:=manual.pdf +SOURCES:=src/*.md +FIGURES:=src/figs/*.svg +PFLAGS:=--table-of-contents \ + --pdf-engine=xelatex \ + --from=markdown \ + --number-sections \ + --indented-code-classes=javascript \ + --highlight-style=monochrome \ + -V mainfont="Apple Garamond" \ + -V monofont="FreeMono" \ + -V documentclass=report \ + -V papersize=letter \ + -V geometry:margin=1in + +.PHONY: all clean + +all: $(BOOK) + +$(BOOK): $(SOURCES) src/title.txt $(FIGURES) + pandoc $^ -o $@ $(PFLAGS) + +clean: + $(RM) *.pdf diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..d09b264 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,8 @@ +# Vertex ISA Manual + +This repository contains the Markdown source for the Vertex instruction set +manual. This work is licensed under the terms of the GNU Free Documentation +License v1.3. + +Copyright (C) 2022 Danny Holman <dholman@gymli.org> + Jon Sanderson <jjsuperpower@gmail.com> diff --git a/doc/missfont.log b/doc/missfont.log new file mode 100644 index 0000000..7e582e9 --- /dev/null +++ b/doc/missfont.log @@ -0,0 +1,3 @@ +mktextfm FreeMono +mktextfm FreeMono +mktextfm FreeMono diff --git a/doc/src/01-About.md b/doc/src/01-About.md new file mode 100644 index 0000000..0468708 --- /dev/null +++ b/doc/src/01-About.md @@ -0,0 +1,73 @@ +# About this Manual + +This manual describes the architecture and programming environment of a Vertex +Mark I microprocessor. This manual applies to application programmers, operating +system programmers and BIOS designers. + +## Notational Conventions + +This manual uses specific notation for data-structure formats, for symbolic +representation and for hexadecimal and binary numbers. A review of this notation +makes the manual easier to read. + +### Bit and Byte Order + +In illustrations of data structures in memory, smaller addresses appear toward +the bottom of the figure; addresses increase toward the top. Bit positions are +numbered from right to left. The numerical value of a set bit is two raised to +the power of the bit position. Vertex processors are "little endian" machines; +this means the bytes of a word are numbered starting from the least significant +byte. Figure 1.1 illustrates these conventions. + +### Reserved Bits + +In many register and memory layout descriptions, certain bits are marked as +**reserved**. When bits are marked as reserved, it is essential for +compatibility with future processors that software treat these bits as having +a future, but unknown, use. These bits should be treated as, not only undefined, +but unpredictable. + +### Instruction Operands + +When instructions are represented symbolically, a subset of the Vertex-32 +assembly language is used. In this subset, an instruction has the following +format: + +``` +label: mnemonic argument1, argument2, argument3 +``` + +where: + +* A **label** is an identifier which is followed by a colon +* A **mnemonic** is a reserved name for an instruction opcode +* The operands *argument1*, *argument2* and *argument3* are optional. There may + be from zero to three operands, depending on the opcode. + +When three operands are present in an arithmetic or logical operation, the first +operand is the destination register and the remaining two are either source +registers or immediate values. For example: + +``` +load: ADDI AX, BX, subtotal +``` + +In this example, `ADDI` is the mnemonic identifier of an opcode, `AX` is the +destination operand, and `BX` and `subtotal` are the source operands. + +### Hexadecimal and Binary Numbers + +Base 16 (hexadecimal) numbers are represented by a '0x' followed by a string of +hexadecimal digits. A hexadecimal digit is a character from '0' to '9' and 'A' +to 'F'. Base 2 (binary) numbers are represented by a string of 1s and 0s, +sometimes preceded by '0b' (for example, 0b1010). The '0b' designation is only +used in situations in which confusion about a number's base may arise. + +### Exceptions + +An exception is an event that typically occurs when an instruction causes an +error. For example, an attempt to divide by zero generates a divide-by-zero +exception. All exceptions provide either an error code or 0, indicating no +error. An error code reports additional information about the error. For +example, a page fault would provide a fault code indicating what caused the page +fault. diff --git a/doc/src/02-Instruction-Format.md b/doc/src/02-Instruction-Format.md new file mode 100644 index 0000000..e08f110 --- /dev/null +++ b/doc/src/02-Instruction-Format.md @@ -0,0 +1,5 @@ +# Instruction Format + +## Instruction Format for V32 Mode + +WIP diff --git a/doc/src/03-Instruction-Set-Reference.md b/doc/src/03-Instruction-Set-Reference.md new file mode 100644 index 0000000..e258393 --- /dev/null +++ b/doc/src/03-Instruction-Set-Reference.md @@ -0,0 +1,92 @@ +# Instruction Set Reference + +This chapter describes the instruction set for the Vertex-32 and Vertex-64 +architectures in V32 and V64 modes of operation. For each instruction, each +operand combination is described, a description of the effect upon the FLG +register and a summary of possible exceptions are also provided. + +## Registers + +Figure 3.1 shows the initial state of the registers in the ISA. For V32, the +16 registers are each 32 bits wide. Register `0X` is hardwired with all bits +equal to 0. General purpose registers `AX` to `GX` hold values that various +instructions interpret as a collection of Boolean values, or as two's +complement signed binary integers or unsigned binary integers. The registers +`PTR`, `IDTR` and `CRX` are considered privileged and writing to them in the +unprivileged state will generate a general protection fault. + +## Base Instruction Formats + +In the core V32 ISA, there are four instruction formats (C/I/R/J), as shown in +Figure 3.3. All are a fixed 32 bits in length and must be aligned on a four-byte +boundary in memory. An instruction alignment exception is generated if a branch +or jump instruction is called on an address that is not four-byte aligned. No +exception is generated on a branch or jump not taken. + +## Integer Instructions + +Most integer computational instructions operate on 32 or 64 bit values held in +a register or memory location. Integer instructions are encoded as +register-immediate operations using the I-type format or as register-register +operations using the R-type format. The destination is `RD` for both +register-immediate and register-register operations. If any of the following +instructions cause an overflow or underflow, the overflow flag is set. + +### Integer-Register Instructions + +The instructions that follow are operations between registers; an attempt to use +a non-register operand will result in an invalid opcode exception. The format +for these exceptions follow Figure 3.4. + +#### ADD + +`ADD` adds the second and third operands and stores the result in the first +operand. + +#### SUB + +`SUB` subtracts the third operand from the second operand and stores the result +in the first operand. + +#### MUL/MULU + +`MUL` multiplies the second operand by the third operand and stores the result +in the first operand. `MULU` performs the same operation on unsigned integers. + +#### DIV/DIVU + +`DIV` divides the second operand by the third operand. The dividend is stored in +the upper 16 bits of the first operand, and the remainder is stored in the lower +16 bits. `DIVU` performs the same operation on unsigned integers. + +#### XOR + +`XOR` performs a bitwise 'exclusive or' operation between the second and third +operands and stores the result in the first operand. + +#### OR + +`OR` performs a bitwise 'or' operation between the second and third operands and +stores the result in the first operand. + +#### AND + +`AND` performs a bitwise 'and' operation between the second and third operands +and stores the result in the first operand. + +#### LSL + +`LSL` performs a logical shift left. The second operand is shifted left by `n` +bits, where `n` is the third operand. The result is stored in the first operand. + +#### LSR + +`LSR` performs a logical shift right. The second operand is shifted right by +'n' bits, where 'n' is the third operand. The result is stored in the first +operand. + +#### ASR + +`ASR` performs an arithmetic shift right. The second operand is shifted right by +'n' bits, where 'n' is the third operand. The result is stored in the first +operand. diff --git a/doc/src/04-System-Architecture-Overview.md b/doc/src/04-System-Architecture-Overview.md new file mode 100644 index 0000000..2aa76d3 --- /dev/null +++ b/doc/src/04-System-Architecture-Overview.md @@ -0,0 +1,14 @@ +# System Architecture Overview + +## Overview of the System-level Architecture + +The system-level architecture consists of a set of registers, data structures +and instructions designed to support basic system management operations such as +memory management, interrupt handling, task management and control of multiple +processors. Figure 4.1 describes the registers and data structures relevant to +V32 mode. + +## Memory Management Overview + +The Vertex-32 architecture provides several instructions that create and +manipulate pages and page tables. diff --git a/doc/src/05-Interrupt-Handling.md b/doc/src/05-Interrupt-Handling.md new file mode 100644 index 0000000..0c549e1 --- /dev/null +++ b/doc/src/05-Interrupt-Handling.md @@ -0,0 +1,30 @@ +# Interrupt and Exception Handling + +This chapter describes the interrupt and exception-handling mechanism on a +Vertex-32 or Vertex-64 processor. + +## Interrupts Overview + +Interrupts and exceptions are events that get triggered either upon a special +condition or when the instruction `INT interrupt_number` is executed. Typically, +an interrupt forces a transfer of execution from the currently executing task to +a special routine called an interrupt handler or an exception handler. The +action taken by a processor in response to an interrupt is referred to as +servicing or handling the interrupt or exception. + +Interrupts can occur at regular intervals or randomly during the execution of a +task or software routine in response to signals from hardware, such as requests +from peripheral devices. Interrupts can also be generated by software by calling +the `INT` instruction. + +Exceptions occur when the processor detects an error condition while executing +an instruction. For instance, the processor could detect that a program is +requesting a page that is currently not mapped, generating a page fault. + +When an interrupt is received, the currently running task is suspended while the +processor services the interrupt or exception. Upon completion of the interrupt +handler, execution is returned to the suspended task without loss of continuity. +If the exception cannot be handled or the exception handler does not return, a +double fault is generated. If a further exception is encountered while servicing +the double fault, it is considered an unrecoverable error and the processor is +reset. diff --git a/doc/src/06-Memory-Management.md b/doc/src/06-Memory-Management.md new file mode 100644 index 0000000..0813c6a --- /dev/null +++ b/doc/src/06-Memory-Management.md @@ -0,0 +1,11 @@ +# Memory Management + +This chapter describes the Vertex-32 and Vertex-64 architecture's memory +management facilities, including physical memory requirements and paging. + +## Memory Management Overview + +The Vertex family of processors provide facilities to perform demand-paged +paging algorithms. Although recommended for most applications, the paging +mechanism can be disabled and memory can then be access directly. Segmentation, +such as what is found on Intel's x86 architecture, is not supported. diff --git a/doc/src/figs/registers.svg b/doc/src/figs/registers.svg new file mode 100644 index 0000000..1522f2a --- /dev/null +++ b/doc/src/figs/registers.svg @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Do not edit this file with editors other than diagrams.net --> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="141px" height="451px" viewBox="-0.5 -0.5 141 451" content="<mxfile host="Electron" modified="2022-05-06T03:17:17.485Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/17.4.2 Chrome/100.0.4896.60 Electron/18.0.1 Safari/537.36" etag="LDFEIayXnVHNOMXlRYny" version="17.4.2" type="device"><diagram id="aj0NjsLKcaomzQoa0Eas" name="Page-1">7ZpNb6MwEIZ/DcddAQ5teiykya6USlVSaffqggNWjSc1TpP01+8QTAhxPw9dOBChCL+e8cfM4wAODony3UzRdXYLCROO7yY7h0wc3x9fjPG7FPaVEFz6lZAqnlSS1whL/sKM6Bp1wxNWtAw1gNB83RZjkJLFuqVRpWDbNluBaPe6pimzhGVMha3+4YnOzLQCt9F/MZ5mdc+ea2pyWhsbochoAtsTidw4JFIAujrLdxETZezquFR+0zdqjwNTTOrPOED0tFvwZx3T+ez+cb5/Yhv1w7usmnmmYmNmvGApLzRThRm23texKLY8F1RiKVyB1EtT42I5zrhI5nQPm3IshabxY10KM1D8Be2pwCoPBaxW2qSauC2LZelp2lSsQJu7eoLemXRLdy3DOS10PRoQgq4L/nAYX+mYU5VyGYLWkBujcgpTmnNRkjmjiuYgMVThM1OaIwDXgqcSq3KeJGU7oYkUVrPdmznwjpnFFcEgZ1rt0cQ4kCCoXMxq8K4MHNuGLW9ktOyEq1ENHDU8p8e2j90tkH8qUxzrm/35l3Z/wSvdkbPeqEAgJNUshI1MilPO8ORkpo10oO8rJI4tEt2/FoIYen0gSMEji0CAQl1CxSQX4kyiJocx5oep95JbrGnMZTpnqzIEo0ZZmKiUEqD7ShwWcYaODFsI18ClPoQpCPHAwEXuz8AJcLQRlr2mjEdprnQEEidA+YEZhthuWYluqEBTTR+Oi6pF6FQxdgsSjF5P1MFcHT6fBfSdnwEb230bh48oPcfmFNIWL1+Fg1xYcFwPcPQDjouu4fCuLDjCAY5+wPHZ69u3wVHffZ3AEQ1w9AMOz++cDvu6Mhno6AkdQed02A9HNwMdPaFj3Dkd9gPLdKCjH3Qct4+6o8O+KZ0NdPSEjlHXdBD7rnQ6nw149AOPVzbJ/jMenoXH77uBjl7QQdzO6fAtOpYDHT2ho/utUmLREQ509ISOzvdKycii426yGPDoBx6d75aSwL7xmNwPfPSDj9E37pdisXkVofpPt3mfg9z8Aw==</diagram></mxfile>" style="background-color: rgb(42, 42, 42);"><defs><clipPath id="mx-clip-4-30-132-30-0"><rect x="4" y="30" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-60-132-30-0"><rect x="4" y="60" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-90-132-30-0"><rect x="4" y="90" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-120-132-30-0"><rect x="4" y="120" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-150-132-30-0"><rect x="4" y="150" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-180-132-30-0"><rect x="4" y="180" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-210-132-30-0"><rect x="4" y="210" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-240-132-30-0"><rect x="4" y="240" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-270-132-30-0"><rect x="4" y="270" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-300-132-30-0"><rect x="4" y="300" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-330-132-30-0"><rect x="4" y="330" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-360-132-30-0"><rect x="4" y="360" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-390-132-30-0"><rect x="4" y="390" width="132" height="30"/></clipPath><clipPath id="mx-clip-4-420-132-30-0"><rect x="4" y="420" width="132" height="30"/></clipPath></defs><g><path d="M 0 30 L 0 0 L 140 0 L 140 30" fill="rgb(42, 42, 42)" stroke="rgb(240, 240, 240)" stroke-miterlimit="10" pointer-events="all"/><path d="M 0 30 L 0 450 L 140 450 L 140 30" fill="none" stroke="rgb(240, 240, 240)" stroke-miterlimit="10" pointer-events="none"/><path d="M 0 30 L 140 30" fill="none" stroke="rgb(240, 240, 240)" stroke-miterlimit="10" pointer-events="none"/><g fill="rgb(240, 240, 240)" font-family="Garamond" pointer-events="none" text-anchor="middle" font-size="12px"><text x="69.5" y="19.5">Registers</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-30-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="49.5">0X</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-60-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="79.5">AX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-90-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="109.5">BX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-120-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="139.5">CX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-150-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="169.5">DX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-180-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="199.5">EX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-210-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="229.5">FX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-240-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="259.5">GX</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-270-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="289.5">FLG</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-300-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="319.5">IP</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-330-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="349.5">SP</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-360-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="379.5">BP</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-390-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="409.5">PDR</text></g><g fill="#000000" font-family="FreeMono" pointer-events="none" clip-path="url(#mx-clip-4-420-132-30-0)" text-anchor="middle" font-size="12px"><text x="69.5" y="439.5">IDTR</text></g></g></svg>
\ No newline at end of file diff --git a/doc/src/title.txt b/doc/src/title.txt new file mode 100644 index 0000000..8ff72f6 --- /dev/null +++ b/doc/src/title.txt @@ -0,0 +1,8 @@ +--- +title: Vertex Architecture Manual +subtitle: A KISS Architecture +author: + - Danny Holman + - Jon Sanderson +date: June 14, 2022 +--- |
