diff options
| author | Miquel Sabaté Solà <mssola@mssola.com> | 2026-09-16 22:34:56 +0200 |
|---|---|---|
| committer | Miquel Sabaté Solà <mssola@mssola.com> | 2026-09-16 22:34:56 +0200 |
| commit | 70a801a43c16fd7a5f61e8d876e5d5c2db48ebe8 (patch) | |
| tree | f1836f8facd9dc69429ab5693afec8d4d326025d | |
| download | btree.nes-main.tar.gz btree.nes-main.zip | |
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
| -rw-r--r-- | .gitattributes | 1 | ||||
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | .nasm/addresses.txt | 10 | ||||
| -rw-r--r-- | .nasm/memory.txt | 17 | ||||
| -rw-r--r-- | .nasm/segments.txt | 5 | ||||
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | Makefile | 52 | ||||
| -rw-r--r-- | README.md | 59 | ||||
| -rw-r--r-- | assets/btree.chr | bin | 0 -> 8192 bytes | |||
| -rw-r--r-- | assets/session.nss | 620 | ||||
| -rw-r--r-- | config/mmc1.cfg | 22 | ||||
| -rw-r--r-- | include/apu.s | 4 | ||||
| -rw-r--r-- | include/asm.s | 9 | ||||
| -rw-r--r-- | include/mmc1.s | 5 | ||||
| -rw-r--r-- | include/oam.s | 12 | ||||
| -rw-r--r-- | include/ppu.s | 6 | ||||
| -rw-r--r-- | src/btree.s | 132 | ||||
| -rw-r--r-- | src/interrupts.s | 37 | ||||
| -rw-r--r-- | src/lib.s | 7 |
19 files changed, 1675 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1a6c279 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +assets/* linguist-generated diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1849194 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +out/ +TODO +*.patch diff --git a/.nasm/addresses.txt b/.nasm/addresses.txt new file mode 100644 index 0000000..774e129 --- /dev/null +++ b/.nasm/addresses.txt @@ -0,0 +1,10 @@ +nmi,8008,8028 +irq,8028,8029 +reset,8029,809B +reset::reset_mmc1,803D,803D +reset::@vblankwait1,8043,8043 +reset::@sprite_reset_loop,804C,804C +reset::@vblankwait2,805F,805F +main,809B,80A1 +main::@tbd,809E,809E +Btree::todo,C000,C001 diff --git a/.nasm/memory.txt b/.nasm/memory.txt new file mode 100644 index 0000000..0bde330 --- /dev/null +++ b/.nasm/memory.txt @@ -0,0 +1,17 @@ +$0180-$01FF: <stack> +$0200-$02FF: OAM::m_sprites +$2000: PPU::m_control +$2001: PPU::m_mask +$2002: PPU::m_status +$2003: OAM::m_address +$2005: PPU::m_scroll +$4010: APU::m_dmc +$4014: OAM::m_dma +$4017: APU::m_frame_counter +$8000: MMC1::m_control +$A000: MMC1::m_chr_bank +$E000: MMC1::m_prg_bank + +--- Summary (in bytes) --- +- Internal RAM: 384/2048 (18.75%) +- Working RAM: 0/8192 (0.00%) diff --git a/.nasm/segments.txt b/.nasm/segments.txt new file mode 100644 index 0000000..8799302 --- /dev/null +++ b/.nasm/segments.txt @@ -0,0 +1,5 @@ +- HEADER: 16/16 (100%) +- PRG0: 161/16384 (0.98%) +- PRG1: 1/16378 (0.01%) +- ROMV: 6/6 (100%) +- ROM2: 8192/8192 (100%) @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 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. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + 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, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..b04fce7 --- /dev/null +++ b/Makefile @@ -0,0 +1,52 @@ +V = +ifeq ($(strip $(V)),) + E = @echo + Q = @ +else + E = @\# + Q = +endif + +# CC65 is set to `xa65` if that exists, otherwise we resort to `cl65` by default. +XA65_BIN := $(shell command -v xa65 2>/dev/null) +ifneq ($(XA65_BIN),) + CC65 ?= xa65 +else + CC65 ?= cl65 +endif + +# NOTE: you can configure `CC65` and `CCOPTS` with the compiler and its options +# that you might require. +CCOPTS ?= --target nes + +# Be strict when using xa65, and extra verbose if V=1. +ifeq ($(CC65),xa65) + CCOPTS += --strict --stats +endif + +## +# all: clean the workspace and build the ROM file. + +.PHONY: all +all: clean deps build + +## +# clean & deps: clean the workspace and check that all dependencies are met. + +.PHONY: clean +clean: + $(Q) rm -rf out + $(Q) find . -type f -name "*.nes" -delete + $(Q) rm -rf .nasm/ + $(Q) mkdir -p out/ + +.PHONY: deps +deps: + @which $(CC65) >/dev/null 2>/dev/null || (echo "ERROR: '$(CC65)' not found." && false) + +## +# build: create the ROM file. + +.PHONY: build +build: + $(Q) $(CC65) $(CCOPTS) src/btree.s -C config/mmc1.cfg -o out/btree.nes 1>/dev/null diff --git a/README.md b/README.md new file mode 100644 index 0000000..c87a374 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +Manipulate B-Trees with your NES/Famicom controller. This is basically an +implementation of COW-friendly B-Trees in pure 6502 assembly, with a little UI +on top of it just to showcase it. + +## The "game" + +The "game" is just a file explorer. Use the arrow keys to go up/down the list, +and press <kbd>A</kbd> or <kbd>Start</kbd> to edit one of the files. There's +also the option to create a new file. Press <kbd>A</kbd> or <kbd>Start</kbd> and +it will prompt you to give it a unique name. With that, a file will be created +and you will jump into edit mode. + +You can edit the file currently selected with the following button mapping: + +- <kbd>B</kbd>: change the character. +- <kbd>A</kbd>: write the character in place. +- <kbd>Arrows</kbd>: move around the document. +- <kbd>Start</kbd>: save the file. +- <kbd>Select</kbd>: go back to the file explorer. + +## Internal design +### The data structure + +The main data structure is a COW-friendly B-tree (just like filesystems like +[btrfs](https://btrfs.readthedocs.io/en/latest/)). You can read all about them +[here](https://btrfs.readthedocs.io/en/latest/dev/dev-btrfs-design.html). To sum +things up, these are B+-trees which: + +1. Are updated top-down. +2. Leaf nodes are not chained. +3. Storage management is done via delayed reference counting. + +Here we have the invariant that a node has between 2 to 5 elements before it +gets split or merged. When a modification happens, it's done top-down, and all +modified elements are copied in a new location: the update is not done in-place. + +### On top of the NES/Famicom + +The storage is covered via the 8KB battery-backed PRG-RAM that some chips +allowed. In particular, here the MMC1 chip is being used just because it's the +one that allows for this and it's simple enough. This chip allows for having a +swappable bank, and here's where I've written my code, inside of the "LIBTREE" +segment and on the `lib.s` file. There is no good reason to have the library +into another segment, but it felt like a good way to have separation of +concerns. + +In the context of operating systems, we would be manipulating at the page +level. Out of simplicity here the same is done, the size of which will be the +one native to the 6502 platform: 256B. Hence, on PRG-RAM we have 32 pages in +total. + +## But, why? + +Just for fun :) + +## License + +Released under the [GPLv3+](http://www.gnu.org/licenses/gpl-3.0.txt), Copyright +(C) 2026-<i>Ω</i> Miquel Sabaté Solà. diff --git a/assets/btree.chr b/assets/btree.chr Binary files differnew file mode 100644 index 0000000..6b06f77 --- /dev/null +++ b/assets/btree.chr diff --git a/assets/session.nss b/assets/session.nss new file mode 100644 index 0000000..c170e67 --- /dev/null +++ b/assets/session.nss @@ -0,0 +1,620 @@ +NSTssTXT
+
+BtnTiles=1
+BtnChecker=0
+BtnSelTiles=0
+BtnChrBank1=1
+BtnChrBank2=0
+BtnChrBank3=0
+BtnChrBank4=0
+BtnGridAll=1
+BtnGridTile=0
+BtnGridAtr=1
+BtnGridBlock=0
+BtnGridScr=0
+BtnSelectedOnlyInverted=0
+BtnSolidityMask=0
+BtnPal=1
+BtnTypeIn=0
+BtnFrameAll=1
+BtnFrameSelected=0
+BtnFrameNone=0
+BtnSpriteSnap=0
+BtnSprite8x16=0
+BtnForce8x16=1
+MenuBestOffsets=0
+MenuLossy=0
+MenuThreshold=0
+MenuNoColorData=0
+MenuMetaSprAutoInc=0
+MenuMetaSprSkipZero=0
+MenuMetaSprMerge=0
+MenuSaveIncName=1
+MenuSaveIncAttr=1
+MenuSaveRLE=0
+CheckLinkedCHRmode=0
+CheckMetatileEditor_ReserveFirst=0
+CheckMetatileEditor_AlignToScreen=0
+BtnMetatileEditor_UseAttributes=0
+BtnMetatileEditor_Clonestamp=0
+BtnMetatileEditor_CloneSnap=0
+BtnMetatileEditor_Tiles=0
+BtnMetatileEditor_Attributes=0
+BtnMetatileEditor_Properties=0
+BtnMetatileEditor_Map=0
+ChkSwapBanks_Properties=0
+ChkSwapBanks_Labels=0
+BtnPPuMaskA=0
+BtnPPuMaskB=0
+BtnPPuMaskLinked=1
+VarNullTile=0
+VarBankActive_mapBuffer=0
+VarBankActive_msprBuffer=0
+VarPalBank_mapBuffer=0
+VarPalBank_msprBuffer=0
+VarTileViewTagBuf=0
+VarBgPalCur=3
+VarPalActive=0
+VarTileActive=243
+VarBankActive=0
+VarPPUMask=0
+VarPPUMaskSet0=0
+VarPPUMaskSet1=0
+VarPPUMaskSet2=0
+VarPPUMaskSet3=0
+VarPPUMaskGlobal0=0
+VarPPUMaskGlobal1=0
+VarPalBank=0
+VarMetaSpriteActive=0
+VarSpriteActive=0
+VarSpriteGridX=64
+VarSpriteGridY=64
+VarNameW=32
+VarNameH=30
+VarNameViewX=0
+VarNameViewY=-1
+VarNameViewX2=0
+VarNameViewY2=-1
+VarNameSelectionL=-1
+VarNameSelectionR=0
+VarNameSelectionT=-1
+VarNameSelectionB=0
+VarNameCopyW=-1
+VarNameCopyH=-1
+VarCHRSelectionL=3
+VarCHRSelectionR=4
+VarCHRSelectionT=15
+VarCHRSelectionB=16
+VarCHRCopyW=-1
+VarCHRCopyH=-1
+VarCHRCopyRect=1
+VarCHRSelectRect=1
+VarCHRBanks=4
+VarCHRBanksUndo=4
+VarCheckpoint_CHRBanks=4
+VarCheckpoint_CHRBanksUndo=4
+VarMtClickID=0
+VarMtClickID_store_2x2=0
+VarMtClickID_store_4x4=0
+VarMtClickID_store_8x8=0
+VarMetatileSets_2x2=4
+VarUndo_metatileSets_2x2=4
+VarCheckpoint_metatileSets_2x2=4
+VarUndo_checkpoint_metatileSets_2x2=4
+VarMetatileSets_4x4=4
+VarUndo_metatileSets_4x4=4
+VarCheckpoint_metatileSets_4x4=4
+VarUndo_checkpoint_metatileSets_4x4=4
+VarMetatileSets_8x8=2
+VarUndo_metatileSets_8x8=2
+VarCheckpoint_metatileSets_8x8=2
+VarUndo_checkpoint_metatileSets_8x8=2
+VarCustomScanlineWarningCyan=2
+VarBrushPresetIndex=0
+BtnStateMtProps0=0
+BtnStateMtProps1=0
+BtnStateMtProps2=0
+BtnStateMtProps3=0
+BtnStateMtProps4=0
+BtnStateMtProps5=0
+BtnStateMtProps6=0
+BtnStateMtProps7=0
+BtnStateCHRProps0=0
+BtnStateCHRProps1=0
+BtnStateCHRProps2=0
+BtnStateCHRProps3=0
+BtnStateCHRProps4=0
+BtnStateCHRProps5=0
+BtnStateCHRProps6=0
+BtnStateCHRProps7=0
+propertyCHRlabel0=solid
+propertyCHRlabel1=dangerous
+propertyCHRlabel2=unlabeled2
+propertyCHRlabel3=unlabeled3
+propertyCHRlabel4=unlabeled4
+propertyCHRlabel5=unlabeled5
+propertyCHRlabel6=escape bit
+propertyCHRlabel7=global condition
+
+
+
+MetaSpriteBankName=session
+MetaspritePlayBackCursor=0
+
+
+FilterCHR=1
+FilterName=1
+FileNameCHR=C:\users\mssola\Desktop\src\git.mssola.com\public\nes\btree.nes\assets\btree
+FileNameName=
+FileNamePal=
+FileNameMetaSpriteBank=
+FileNameTileProps=
+FileNameMetatileText=
+FileNameAssociatedMetatiles=
+FileNameAssociatedTileset=
+CheckboxDoAssociateMetatiles=0
+CheckboxDoAssociateTileset=0
+RadioAutoexport_UseWorkDir=0
+RadioAutoexport_UseSubDir_Project=0
+RadioAutoexport_UseSubDir_NEXXT=0
+CheckAutoexport_MetatileAsBMP=0
+
+
+VarCHRSelected=00[f3]0100[c]
+
+
+Palette=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+PalUndo=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+CHRMain=00[101]3c464a52623c00[a]182808[3]3e00[a]3c42023c407e00[a]3c420c02423c00[a]081828487e0800[a]7e407c02423c00[a]3e407c42[2]3c00[a]3e02040810[2]00[a]3c423c42[2]3c00[a]3c42[2]3e023c00[9]3c4299a1[2]99423c00[9]3c42[2]7e42[2]00[a]7c427c42[2]3c00[a]3c4240[2]423c00[a]7c42[4]7c00[a]7c407040[2]7c00[a]3c40[2]7040[2]00[a]3c42404e423c00[a]42[3]7e42[2]00[a]3e08[4]3e00[a]02[3]42[2]3c00[a]44487048444200[a]40[5]7e00[a]42665a42[3]00[a]4262524a464200[a]3c42[4]3c00[a]7c42[2]7c40[2]00[a]3c42[3]3c0600[a]3c42[2]7c444200[a]3e403c02[2]7c00[a]3e08[5]00[a]42[5]3c00[a]22[4]140800[a]42[3]5a664200[a]422418[2]244200[a]41221408[3]00[a]7e040810207e00[9]3c4299a5[2]9f423c00[3ca8]
+
+
+CHRUndo=00[101]3c464a52623c00[a]182808[3]3e00[a]3c42023c407e00[a]3c420c02423c00[a]081828487e0800[a]7e407c02423c00[a]3e407c42[2]3c00[a]3e02040810[2]00[a]3c423c42[2]3c00[a]3c42[2]3e023c00[9]3c4299a1[2]99423c00[9]3c42[2]7e42[2]00[a]7c427c42[2]3c00[a]3c4240[2]423c00[a]7c42[4]7c00[a]7c407040[2]7c00[a]3c40[2]7040[2]00[a]3c42404e423c00[a]42[3]7e42[2]00[a]3e08[4]3e00[a]02[3]42[2]3c00[a]44487048444200[a]40[5]7e00[a]42665a42[3]00[a]4262524a464200[a]3c42[4]3c00[a]7c42[2]7c40[2]00[a]3c42[3]3c0600[a]3c42[2]7c444200[a]3e403c02[2]7c00[a]3e08[5]00[a]42[5]3c00[a]22[4]140800[a]42[3]5a664200[a]422418[2]244200[a]41221408[3]00[a]7e040810207e00[9]3c4299a5[2]9f423c00[cb9]c000[4]e000[2]c000f070[2]e0002b3f01[2]03[3]002b3f01[2]03[3]00e0[2]d0a030b8fc00e0[2]d0a030b8fc0001[2]02[2]05[2]090801[2]02[2]05[2]090880[2]c0[2]e0[2]f01080[2]c0[2]e0[2]f01009[5]19[2]2909[5]19[2]2910f0b030b018f8fc10f0b030b018f8fcb9[3]f9a9[2]f4f5b9[3]f9a9[2]f4f5f7[2]fff5[3]6feff7[2]fff5[3]6fef00[2]3c3f7f7c7d[2]071f3f7ffffcfd[2]00[3]e0f038[2]bce0f8fcfeff3fbf[2]00[c]18ff[2]8a00[c]18ff[2]8bff[2]00[16]ff[2]00[16]c068[2]1ce0[4]c068[2]1ce0[4]2a3d070f667038002a3d070f66703800e060[3]70787c00e060[3]70787c0009[10]f0[5]50[3]f0[5]50[3]2959[2]89b9[4]2959[2]89b9[4]fcf4f6[2]f1f7[3]fcf4f6[2]f1f7[3]555289b9b858a850555289b9b800[3]eacb9197171a150aeacb91971700[3]7c7f[2]3f[3]00[2]fcfff17c7f[2]3f073efef8fcf0e000[2]3fffe71efc[2]f8e000[8]ba8abab8ff[2]1800[9]bb9bbb89ff[2]1800ff[2]00[6]ff[2]00[26]e0[2]c000c0e0f000e0[2]c000c0e0f0002a3e00281c206c102a3e00[6]f0[2]3000383c00[2]f0[2]3000383c00[3]071f3f7f[2]ff[2]00071f3f7f[2]ff[2]00e0f89c8ec6e7[2]00e0f89c8ec6e7[2]00[2]092e4f33f1fc00[2]092e4f33f1fc00[3]2080e4f07400[3]2080e4f07400121a6b5f3ff93600121a6b5f3ff936004094eafffe9f6c004094eafffe9f6c00[3]031ffcff0300[3]031ffcff0308[2]7cfe8301ff5108[2]7cfe8301ff51030607[2]047b94d5030607[2]047b94d58040[2]c040bc525a8040[2]c040bc525a0c1f13[2]3f4cd0df0c1f13[2]3f4cd0df60f098[2]f46e9fff60f098[2]f46e9fff00[13]1f6ff7031f00[3]1f6ff7031f003ef8f3ffdfe3f8003ef8f3ffdfe3f800[10]ff[2]7f[2]3f1f0700ff[2]7f[2]3f1f0700ff[2]fe[2]fcf8e000ff[2]fe[2]fcf8e000f1c7797531190e00f1c7797531190e00d6e1e4f2b8402000d6e1e4f2b8402000f6793f4d0f160a00f6793f4d0f160a006e9ffefdf4e844006e9ffefdf4e8440003fffc1f0300[3]03fffc1f0300[3]51ff0183fe7c08[2]51ff0183fe7c08[2]f47b040704070300f47b0407040703005ebc40c040[2]80005ebc40c040[2]8000df7f3f130c00[3]df7f3f130c00[3]fffefcc83000[3]fffefcc83000[13]80e0b0fcfe9bfefc80e0b0fcfe9bfefc00[20]071f3f7f[2]ff[3]071f3f7f[2]ff[3]e0f8fc9e8ec7e7[2]e0f8fc9e8ec7e7[2]00[2]082e4f33f1fc00[2]082e4f33f1fc00[2]801088e2f07600[2]801088e2f07600022957ff7ff93600022957ff7ff936004858d6fafc9f6c004858d6fafc9f6c00[3]031ffcff0f00[3]031ffcff0b08[2]7cfe8331ff4508[2]7cfe8331ff4503040507047b94b503040507047b94b580c0[3]40bc525680c0[3]40bc5256060f19[2]2f76f9ff060f19[2]2f76f9ff30f8c8[2]fc320bfb30f8c8[2]fc320bfb00[10]80e0b0fcfe73fefc80e0b0fcfe73fefc00[20]ff[3]7f[2]3f1f07ff[3]7f[2]3f1f07ff[3]fe[2]fcf8e0ff[3]fe[2]fcf8e0f1c7797531190e00f1c7797531190e00d2e0e4f2b900a410d2e0e4f2b900a41076f97fbf2f17220076f97fbf2f1722006f9efcb2f06850006f9efcb2f06850000ffffc1f0300[3]0bfffc1f0300[3]45ff3183fe7c08[2]45ff3183fe7c08[2]f47b040704050300f47b0407040503005ebc40c040c080005ebc40c040c08000ff7f3f130c00[3]ff7f3f130c00[3]fbfefcc83000[3]fbfefcc83000[14]3ef8f3ffdfe3f8003ef8f2fcdce2f800[2]0304050f0b1000[2]0304050f0b1000[2]80c0[2]e0a01000[2]80c0[2]e0a01000[4]1f20489c00[4]1f20489c00[4]f008247200[4]f008247200[3]071f3f5f8f00[b]80e0f0e8c400[e]0f3800[6]0f3800[6]f03c00[6]f03c00[7]0f00[7]0f00[7]e000[7]e000[53]c0e0f0f878002000[2]0400[2]8010207098bff8700010207098bff8700010081c26ee3e1c0010081c26ee3e1c00de41c18347201f00de41c18347201f00f6040682c408f000f6040682c408f000d0703f1f0f070300[9]2c38f0e0c08000[a]60c3c7cfff7f3f0060c3c7cfff7f3f007eff[4]fefc007eff[4]fefc001f3f2040[2]80ff001f3f2040[2]80ff00b078fc7c7838f000b078fc7c7838f000[51]78f8f0e0c000[3]8000[5]2000[23]01[2]03[2]070900[2]01[2]03[2]070970f8e4[6]70f8e4[6]16[2]1a16[2]17[2]1a16[2]1a16[2]17[2]1ab4[2]a4ac2cec[2]2cb4[2]a4ac2cec[2]2c1a16366e[2]af[3]1a16366e[2]af[3]ec[4]fc[2]3844ec[4]fc[2]384400[72]e0f0f8bc5c3c0008040200402000[21]090f19[2]1f[2]17[2]090f19[2]1f[2]17[2]f4[10]1716[3]1f[2]18161716[3]1f[2]1816ac2cec2cec[2]f8ecac2cec2cec[2]f8ecae[3]be[2]800001ae[3]be[2]8000[2]5c429e[3]deaa755c429e[3]00[73]3c5c1cf8f0e000[3]20e000[2]020600[21]01[4]0205080901[4]0205080980[4]40e010f080[4]40e010f0d9[2]a6[2]ff8b[2]8ad9[2]a6[2]ff8b[2]8a9b[2]65[2]ff[3]d19b[2]65[2]ff[3]d1a6[2]7f45[4]7fa6[2]7f45[4]7f65[2]fe[6]65[2]fe[6]00[72]e0380c04060204080100[4]6000[20]09[2]1e1325[2]4b7f09[2]1e1325[2]4b7ff0[2]08f8fc[2]fe[2]f0[2]08f8fc[2]fe[2]8a[4]8bffd9[2]8a[4]8bffd9[2]ddd1dd11ff[2]9b98ddd1dd11ff[2]9b98285c[2]829ed6aa54285c[2]829e00[3]142e[2]414f6b552a142e[2]414f00[73]0206040c38e000[2]8000[3]0100080400[20]01[2]03[3]0705[2]01[2]03[3]0705[2]80[2]c0[3]e0a0[2]80[2]c0[3]e0a0[2]1911191d1f[3]0f1911191d1f[3]0f88[2]98b8f8[3]f088[2]98b8f8[3]f0bbfbab[3]8bfbf3bbfbab[3]8bfbf3dddfd7dfd5d1ddcfdddfd7dfd5d1ddcf00[a0]0d09[2]1b151913150d09[2]1b15191315b090[2]9888[4]b090[2]9888[4]8f[3]97[3]bb[2]8f[3]97[3]bb[2]f1[3]e9[3]dd[2]f1[3]e9[3]dd[2]f2e5[2]c8c98d8a85f2e5[2]c8c980[3]4fe7[2]13f3b1d1214fe7[2]13f301[3]00[2260]
+
+
+CHRCopy=00[4000]
+
+
+NameTable=00[3c0]
+
+
+NameCopy=00[3c0]
+
+
+NameUndo=00[3c0]
+
+
+AttrTable=00[40]
+
+
+AttrCopy=00[40]
+
+
+AttrUndo=00[40]
+
+
+MetaSprites=ff[10000]
+
+
+iBrushSize=02030405
+
+
+iBrushSnapSize_x=02030405
+
+
+iBrushSnapSize_y=02030405
+
+
+iBrushCursorAlignment=04[4]
+
+
+BrushMask_2a=01[100]
+
+
+BrushMask_3a=000100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100
+
+
+BrushMask_4a=0001[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00
+
+
+BrushMask_5a=0001[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[2]
+
+
+BrushMask_6a=01[100]
+
+
+BrushMask_7a=01[100]
+
+
+BrushMask_8a=01[100]
+
+
+BrushMask_2b=00[5]01[6]00[8]01[2]00[6]01[2]00[5]0100[a]0100[3]0100[c]0100[2]0100[c]01000100[e]01[2]00[e]01[2]00[e]01[2]00[e]01[2]00[e]01[2]00[e]01000100[c]0100[2]0100[c]0100[3]0100[a]0100[5]01[2]00[6]01[2]00[8]01[6]00[5]
+
+
+BrushMask_3b=000100[e]01[3]00[e]0100[de]
+
+
+BrushMask_4b=0001[2]00[d]01[4]00[c]01[4]00[d]01[2]00[cd]
+
+
+BrushMask_5b=0001[3]00[c]01[5]00[b]01[5]00[b]01[5]00[c]01[3]00[bc]
+
+
+BrushMask_6b=00[2]01[2]00[d]01[4]00[b]01[6]00[a]01[6]00[b]01[4]00[d]01[2]00[ac]
+
+
+BrushMask_7b=00[2]01[3]00[c]01[5]00[a]01[7]00[9]01[7]00[9]01[7]00[a]01[5]00[c]01[3]00[9b]
+
+
+BrushMask_8b=00[2]01[4]00[b]01[6]00[9]01[8]00[8]01[8]00[8]01[8]00[8]01[8]00[9]01[6]00[b]01[4]00[8a]
+
+
+32_BankViewTable=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+32_BankViewTableUndo=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+8_TileCollisionProperties=00[400]
+
+
+8_TileCollisionPropertiesUndo=00[400]
+
+
+PropertyConditions=1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]
+
+
+PropertyConditionsUndo=1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]
+
+
+TilePropConditionType=00[7]02
+
+
+TilePropConditionTypeUndo=00[7]02
+
+
+MetatileSet_2x2_id=00[400]
+
+
+MetatileSet_2x2_idUndo=00[400]
+
+
+MetatileSet_2x2_pal=00[400]
+
+
+MetatileSet_2x2_palUndo=00[400]
+
+
+MetatileSet_2x2_props=00[400]
+
+
+MetatileSet_2x2_propsUndo=00[400]
+
+
+MetatileSet_4x4_id=00[1000]
+
+
+MetatileSet_4x4_idUndo=00[1000]
+
+
+MetatileSet_4x4_pal=00[1000]
+
+
+MetatileSet_4x4_palUndo=00[1000]
+
+
+MetatileSet_4x4_props=00[1000]
+
+
+MetatileSet_4x4_propsUndo=00[1000]
+
+
+MetatileSet_8x8_id=00[2000]
+
+
+MetatileSet_8x8_idUndo=00[2000]
+
+
+MetatileSet_8x8_pal=00[2000]
+
+
+MetatileSet_8x8_palUndo=00[2000]
+
+
+MetatileSet_8x8_props=00[2000]
+
+
+MetatileSet_8x8_propsUndo=00[2000]
+
+
+MetatileSetLabels_2x2=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+MetatileSetLabels_2x2Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+MetatileSetLabels_4x4=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+MetatileSetLabels_4x4Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+MetatileSetLabels_8x8=Unlabeled,Unlabeled
+MetatileSetLabels_8x8Undo=Unlabeled,Unlabeled
+
+CHRBankLabels=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+CHRBankLabelsUndo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+32_NTSC_MsprDuration=00000006[100]
+
+
+32_NTSC_MsprDurationUndo=00000006[100]
+
+
+32_PAL_MsprDuration=00000005[100]
+
+
+32_PAL_MsprDurationUndo=00000005[100]
+
+
+MsprDirectTagStart=0[100]
+
+
+MsprDirectTagStartUndo=0[100]
+
+
+MsprDirectTagLoop=0[100]
+
+
+MsprDirectTagLoopUndo=0[100]
+
+
+MsprDirectTagCall=0[100]
+
+
+MsprDirectTagCallUndo=0[100]
+
+
+MsprDirectTagCall2=0[100]
+
+
+MsprDirectTagCall2Undo=0[100]
+
+
+MsprDirectTagRevert=0[100]
+
+
+MsprDirectTagRevertUndo=0[100]
+
+
+MsprDirectTagSeconds=0[100]
+
+
+MsprDirectTagSecondsUndo=0[100]
+
+
+MsprDirectTagHalfSeconds=0[100]
+
+
+MsprDirectTagHalfSecondsUndo=0[100]
+
+
+Checkpoint_Palette=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+Checkpoint_PalUndo=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+Checkpoint_CHRMain=00[4000]
+
+
+Checkpoint_CHRUndo=00[4000]
+
+
+Checkpoint_NameTable=00[3c0]
+
+
+Checkpoint_NameUndo=00[3c0]
+
+
+Checkpoint_AttrTable=00[40]
+
+
+Checkpoint_AttrUndo=00[40]
+
+
+Checkpoint_MetaSprites=ff[10000]
+
+
+Checkpoint_32_BankViewTable=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+Checkpoint_32_BankViewTableUndo=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+Checkpoint_8_TileCollisionProperties=00[400]
+
+
+Checkpoint_8_TileCollisionPropertiesUndo=00[400]
+
+
+Checkpoint_PropertyConditions=0[20]
+
+
+Checkpoint_PropertyConditionsUndo=0[20]
+
+
+Checkpoint_TilePropConditionType=00[7]02
+
+
+Checkpoint_TilePropConditionTypeUndo=00[7]02
+
+
+Checkpoint_MetatileSet_2x2_id=00[400]
+
+
+Checkpoint_MetatileSet_2x2_idUndo=00[400]
+
+
+Checkpoint_MetatileSet_2x2_pal=00[400]
+
+
+Checkpoint_MetatileSet_2x2_palUndo=00[400]
+
+
+Checkpoint_MetatileSet_2x2_props=00[400]
+
+
+Checkpoint_MetatileSet_2x2_propsUndo=00[400]
+
+
+Checkpoint_MetatileSet_4x4_id=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_idUndo=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_pal=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_palUndo=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_props=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_propsUndo=00[1000]
+
+
+Checkpoint_MetatileSet_8x8_id=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_idUndo=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_pal=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_palUndo=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_props=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_propsUndo=00[2000]
+
+
+Checkpoint_MetatileSetLabels_2x2=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_2x2Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_MetatileSetLabels_4x4=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_4x4Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_MetatileSetLabels_8x8=Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_8x8Undo=Unlabeled,Unlabeled
+
+Checkpoint_CHRBankLabels=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_CHRBankLabelsUndo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+
+Checkpoint_32_NTSC_MsprDuration=00000006[100]
+
+
+Checkpoint_32_NTSC_MsprDurationUndo=00000000[100]
+
+
+Checkpoint_32_PAL_MsprDuration=00000005[100]
+
+
+Checkpoint_32_PAL_MsprDurationUndo=00000000[100]
+
+
+Checkpoint_MsprDirectTagStart=0[100]
+
+
+Checkpoint_MsprDirectTagStartUndo=0[100]
+
+
+Checkpoint_MsprDirectTagLoop=0[100]
+
+
+Checkpoint_MsprDirectTagLoopUndo=0[100]
+
+
+Checkpoint_MsprDirectTagCall=0[100]
+
+
+Checkpoint_MsprDirectTagCallUndo=0[100]
+
+
+Checkpoint_MsprDirectTagCall2=0[100]
+
+
+Checkpoint_MsprDirectTagCall2Undo=0[100]
+
+
+Checkpoint_MsprDirectTagRevert=0[100]
+
+
+Checkpoint_MsprDirectTagRevertUndo=0[100]
+
+
+Checkpoint_MsprDirectTagSeconds=0[100]
+
+
+Checkpoint_MsprDirectTagSecondsUndo=0[100]
+
+
+Checkpoint_MsprDirectTagHalfSeconds=0[100]
+
+
+Checkpoint_MsprDirectTagHalfSecondsUndo=0[100]
+
+=========================================================
+Current settings switch tiles
+=========================================================
+
+
+
+Metadata:
+---------------------------------------------------------
+Switch tiles enabled=0
+Current preset ID=0
+
+GUI behaviour:
+---------------------------------------------------------
+Use paired mode if possible=1
+Affect backgrounds=1
+Affect sprites=1
+
+Nonpaired mode start set behaviour:
+---------------------------------------------------------
+Nonpaired, Use set of 1st checked switch tile=1
+Nonpaired, Use active set=0
+Nonpaired, Use fixed set=0
+Nonpaired, fixed set ID=0
+
+Paired mode start set behaviour:
+---------------------------------------------------------
+Paired, Use set of 1st checked switch tile=1
+
+Switch tile IDs:
+---------------------------------------------------------
+Switch tile 1 ID=254
+Switch tile 2 ID=253
+Switch tile 3 ID=252
+Switch tile 4 ID=251
+
+Switch tile targets:
+---------------------------------------------------------
+Switch tile 1 target=4096
+Switch tile 2 target=0
+Switch tile 3 target=12288
+Switch tile 4 target=8192
+
+Switch tile checkboxes:
+---------------------------------------------------------
+Switch tile 1 checkbox=1
+Switch tile 2 checkbox=1
+Switch tile 3 checkbox=0
+Switch tile 4 checkbox=0
diff --git a/config/mmc1.cfg b/config/mmc1.cfg new file mode 100644 index 0000000..4803993 --- /dev/null +++ b/config/mmc1.cfg @@ -0,0 +1,22 @@ +MEMORY { + # iNES header. + HEADER: start = $0, size = $10, fill = yes; + + # Banked PRG ROM: one for the NES game, the other for the library. + PRG0: start = $8000, size = $4000, fill = yes, fillval = $00, define = yes; + PRG1: start = $C000, size = $3FFA, fill = yes, fillval = $01, define = yes; + + # Hardware Vectors. + ROMV: start = $FFFA, size = $0006, fill = yes; + + # No banking on CHR, we keep it simple. + ROM2: start = $0000, size = $2000, fill = yes, fillval = $02; +} + +SEGMENTS { + HEADER: load = HEADER, type = ro; + FIXED: load = PRG0, type = ro; + LIBTREE: load = PRG1, type = ro; + VECTORS: load = ROMV, type = ro; + CHARS: load = ROM2, type = ro; +}
\ No newline at end of file diff --git a/include/apu.s b/include/apu.s new file mode 100644 index 0000000..8a23c49 --- /dev/null +++ b/include/apu.s @@ -0,0 +1,4 @@ +.scope APU + m_dmc = $4010 + m_frame_counter = $4017 +.endscope diff --git a/include/asm.s b/include/asm.s new file mode 100644 index 0000000..f5d39bc --- /dev/null +++ b/include/asm.s @@ -0,0 +1,9 @@ +;; Pseudo-instruction from 'nasm' that is not available for 'ca65'. An empty +;; implementation is actually quite accurate, as it's just a way for 'nasm' to +;; perform extra checks when programmers want to explicitly make the code fall +;; through. +.ifndef __NASM__ + .macro __fallthrough__ arg + ;; Nothing to do. + .endmacro +.endif diff --git a/include/mmc1.s b/include/mmc1.s new file mode 100644 index 0000000..3a6bc5d --- /dev/null +++ b/include/mmc1.s @@ -0,0 +1,5 @@ +.scope MMC1 + m_control = $8000 + m_chr_bank = $A000 + m_prg_bank = $E000 +.endscope diff --git a/include/oam.s b/include/oam.s new file mode 100644 index 0000000..a73494d --- /dev/null +++ b/include/oam.s @@ -0,0 +1,12 @@ +.scope OAM + ;; Region in internal RAM where sprites are being allocated for later use in + ;; the DMA process. The entire page is reserved, as there are 64 sprites x 4 + ;; bytes each = 256 bytes in total. + m_sprites = $200 ; asan:reserve $100 + + ;;; + ;; Actual addresses from OAM space. + + m_address = $2003 + m_dma = $4014 +.endscope diff --git a/include/ppu.s b/include/ppu.s new file mode 100644 index 0000000..dbef40e --- /dev/null +++ b/include/ppu.s @@ -0,0 +1,6 @@ +.scope PPU + m_control = $2000 + m_mask = $2001 + m_status = $2002 + m_scroll = $2005 +.endscope diff --git a/src/btree.s b/src/btree.s new file mode 100644 index 0000000..2867bf0 --- /dev/null +++ b/src/btree.s @@ -0,0 +1,132 @@ +.segment "HEADER" + .byte 'N', 'E', 'S', $1A + + ;; We split the PRG-ROM into two 16KB sections, the first fixed (the game + ;; itself), and then the second one, which holds the library. + .byte $02 + + ;; We keep the CHR-ROM simple: the most basic one (8KB) and no windows. + .byte $01 + + ;; - bit 1: contains battery-backed PRG RAM ($6000-7FFF) + ;; - bit 7-4: the lower nibble of the mapper (#%0001 for MMC1) + .byte $12 + + ;; Blanked out stuff. + .res $09, $00 + +;; asan:fixed-segments FIXED, LIBTREE +.segment "FIXED" +.asciiz "@mssola" + +.include "../include/apu.s" +.include "../include/oam.s" +.include "../include/ppu.s" +.include "../include/mmc1.s" +.include "../include/asm.s" + +.include "lib.s" +.include "interrupts.s" + +.proc reset + ;; Disable interrupts and decimal mode. + sei + cld + + ;; Disable APU frame counter. + ldx #$40 + stx APU::m_frame_counter + + ;; Setup the stack. + ldx #$FF + txs ; asan:stack $80-$FF + + ;; Disable NMIs and the APU's DMC. + inx + stx PPU::m_control + stx PPU::m_mask + stx APU::m_dmc + + ;; Reset MMC1 chip. +reset_mmc1: + inc reset_mmc1 + + ;; First PPU wait. + bit PPU::m_status +@vblankwait1: + bit PPU::m_status + bpl @vblankwait1 + + ;; Reset all sprites by simply moving the Y coordinate out of screen. + lda #$EF + ldx #0 +@sprite_reset_loop: + sta OAM::m_sprites, x + inx + inx + inx + inx + bne @sprite_reset_loop + + ;; DMA setup for sprite reset. + lda #$00 + sta OAM::m_address + lda #$02 + sta OAM::m_dma + + ;; Second PPU wait. After that the PPU is stable. +@vblankwait2: + bit PPU::m_status + bpl @vblankwait2 + + ;;; + ;; Configure the MMC1 chip. + + ;; The control register: + ;; + ;; - bits 0-1: nametable arrangement: horizontal mirroring. + ;; - bits 2-3: PRG-ROM fixed at $8000 (game), swappable at $C000 (library). + ;; - bit 4: CHR-ROM: 8KB at a time. + lda #%00001011 + sta MMC1::m_control + lsr + sta MMC1::m_control + lsr + sta MMC1::m_control + lsr + sta MMC1::m_control + lsr + sta MMC1::m_control + + ;; CHR bank: 0. + lda #0 + sta MMC1::m_chr_bank + sta MMC1::m_chr_bank + sta MMC1::m_chr_bank + sta MMC1::m_chr_bank + sta MMC1::m_chr_bank + + ;; The swappable bank is 1, which contains the library. Also set PRG-RAM to + ;; be enabled. + lda #1 + sta MMC1::m_prg_bank + sta MMC1::m_prg_bank + sta MMC1::m_prg_bank + sta MMC1::m_prg_bank + sta MMC1::m_prg_bank + + __fallthrough__ main +.endproc + +.proc main + jsr Btree::todo + +@tbd: + jmp @tbd +.endproc + +.segment "VECTORS" +.addr nmi, reset, irq + +.segment "CHARS" +.incbin "../assets/btree.chr" diff --git a/src/interrupts.s b/src/interrupts.s new file mode 100644 index 0000000..be276df --- /dev/null +++ b/src/interrupts.s @@ -0,0 +1,37 @@ +.segment "FIXED" + +.proc nmi + pha + txa + pha + tya + pha + + ;; Sprite DMA. + lda #$00 + sta OAM::m_address + lda #$02 + sta OAM::m_dma + + ;; TODO + + ;; Always reset the scroll just in case. + bit PPU::m_status + lda #$00 + sta PPU::m_scroll + sta PPU::m_scroll + + ;; Restore registers. + pla + tay + pla + tax + pla + + rti +.endproc + +;; Unused. +.proc irq + rti +.endproc diff --git a/src/lib.s b/src/lib.s new file mode 100644 index 0000000..64effd0 --- /dev/null +++ b/src/lib.s @@ -0,0 +1,7 @@ +.segment "LIBTREE" + +.scope Btree + .proc todo + rts + .endproc +.endscope |
