This commit is contained in:
u2 2025-02-13 11:12:23 +00:00
commit 838ff60264
99 changed files with 4951 additions and 0 deletions

52
.gitignore vendored Normal file
View File

@ -0,0 +1,52 @@
# Prerequisites
*.d
# Object files
*.o
*.ko
*.obj
*.elf
# Linker output
*.ilk
*.map
*.exp
# Precompiled Headers
*.gch
*.pch
# Libraries
*.lib
*.a
*.la
*.lo
# Shared objects (inc. Windows DLLs)
*.dll
*.so
*.so.*
*.dylib
# Executables
*.exe
*.out
*.app
*.i*86
*.x86_64
*.hex
# Debug files
*.dSYM/
*.su
*.idb
*.pdb
# Kernel Module Compile Results
*.mod*
*.cmd
.tmp_versions/
modules.order
Module.symvers
Mkfile.old
dkms.conf

46
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at john@winans.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
<http://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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

145
README.md Normal file
View File

@ -0,0 +1,145 @@
# rvddt
RISC-V Dynamic Debugging Tool
This is an RV32I simulator that was written to gernerate the figures for a book
in progress here: https://github.com/johnwinans/rvalp that will (eventually) include
several examples on how to use rvddt and other tools mentioned below.
To build everything:
mkdir -p ~/projects/riscv
cd ~/projects/riscv
git clone https://github.com/johnwinans/rvddt.git
cd rvddt/src
make world
cd ../examples
make world
echo "export PATH=$PATH:~/projects/riscv/rvddt/src" >> ~/.bashrc
Note that you will need a suitable compiler to build the examples.
On Ubuntu, I installed mine like this:
sudo apt-get install autoconf automake autotools-dev curl libmpc-dev libmpfr-dev \
libgmp-dev gawk build-essential bison flex texinfo gperf libtool patchutils \
bc zlib1g-dev libexpat-dev
mkdir -p ~/projects/riscv
cd ~/projects/riscv
git clone https://github.com/riscv/riscv-gnu-toolchain
cd riscv-gnu-toolchain
INS_DIR=~/projects/riscv/install/rv32i
./configure --prefix=$INS_DIR --with-arch=rv32i --with-abi=ilp32
make
echo "export PATH=$PATH:~/projects/riscv/install/rv32i/bin" >> ~/.bashrc
If you are new to building the GNU tools be careful about following the numerous
opinions on how to configure them. `rvddt` will ONLY execute instructions in the
`rv32i` base ISA. Configure and/or use the tools appropriately!
See the rvddt examples and their makefiles for help figuring out how to run the compiler.
After building, the rvddt executable will be left sitting in the `src` directory.
Put it wherever you want to install it. I just run it from the src directory like this:
rvddt -f proggie.bin
To ask for command-line help, run it like this:
rvddt -h
All the regs ('cept x0) are set to 0xf0f0f0f0 and the memory is filled with
0xa5 prior to reading the binary memory image into memory starting at address
zero and initializing the sp register and priming the stack top as discussed below.
By default rvddt will create a memory space starting at 0 with a size of 0x10000,
set the pc register to zero, the sp register to the last memory address +1. You can see this
initialization in the pre-trace register dump in the same output below.
(Note that you can change the memory size with the`-l <memlen>` arg and the stack
initialization will follow it.)
If your program reads or writes outside of the simulated memory region a warning
will be printed to help you track down the instruction that did it. In dumps, such
'unimplemented' memory bytes are all 0xff.
The simulator will stop on an illegal instruction or an `ebreak`.
To see a list of commands type `?` at the prompt:
ddt> ?
commands:
a toggle the display of register ABI and x-names
d [addr [len]] dump memory starting at addr for len bytes
g [addr] set pc=addr and silently execute qty instructions
r dump the contents of the CPU regs
t [[addr] qty] set pc=addr and trace qty instructions
ti [[addr] qty] set pc=addr and trace qty instructions w/o reg dumps
x exit
> filename redirect output to 'filename' (use - for stdout)
ddt>
The way you use rvddt is to create an executable binary memory image with
its entry point (the first instruction to execute) located at address 0 and then
run it like this:
$ rvddt -f examples/load4regs/load4regs.bin
sp initialized to top of memory: 0x00010000
Loading 'examples/load4regs/load4regs.bin' to 0x0
This is rvddt. Enter ? for help.
ddt> t1000
x0 00000000 f0f0f0f0 00010000 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x8 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x16 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x24 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
pc 00000000
00000000: 00000e13 addi x28, x0, 0 # x28 = 0x00000000 = 0x00000000 + 0x00000000
x0 00000000 f0f0f0f0 00010000 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x8 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x16 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x24 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 00000000 f0f0f0f0 f0f0f0f0 f0f0f0f0
pc 00000004
00000004: 00000e93 addi x29, x0, 0 # x29 = 0x00000000 = 0x00000000 + 0x00000000
x0 00000000 f0f0f0f0 00010000 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x8 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x16 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x24 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 00000000 00000000 f0f0f0f0 f0f0f0f0
pc 00000008
00000008: 00000f13 addi x30, x0, 0 # x30 = 0x00000000 = 0x00000000 + 0x00000000
x0 00000000 f0f0f0f0 00010000 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x8 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x16 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x24 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 00000000 00000000 00000000 f0f0f0f0
pc 0000000c
0000000c: 00000f93 addi x31, x0, 0 # x31 = 0x00000000 = 0x00000000 + 0x00000000
x0 00000000 f0f0f0f0 00010000 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x8 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x16 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0
x24 f0f0f0f0 f0f0f0f0 f0f0f0f0 f0f0f0f0 00000000 00000000 00000000 00000000
pc 00000010
00000010: ebreak
ddt>
If you prefer the ABI register names, then use the `a` command and run it like this:
$ ./src/rvddt -f examples/counter/counter.bin
sp initialized to top of memory: 0x00010000
Loading 'examples/counter/counter.bin' to 0x0
This is rvddt. Enter ? for help.
ddt> a
ddt> t
zero 00000000 ra f0f0f0f0 sp 00010000 gp f0f0f0f0
tp f0f0f0f0 t0 f0f0f0f0 t1 f0f0f0f0 t2 f0f0f0f0
s0 f0f0f0f0 s1 f0f0f0f0 a0 f0f0f0f0 a1 f0f0f0f0
a2 f0f0f0f0 a3 f0f0f0f0 a4 f0f0f0f0 a5 f0f0f0f0
a6 f0f0f0f0 a7 f0f0f0f0 s2 f0f0f0f0 s3 f0f0f0f0
s4 f0f0f0f0 s5 f0f0f0f0 s6 f0f0f0f0 s7 f0f0f0f0
s8 f0f0f0f0 s9 f0f0f0f0 s10 f0f0f0f0 S11 f0f0f0f0
t3 f0f0f0f0 t4 f0f0f0f0 t5 f0f0f0f0 t6 f0f0f0f0
pc 00000000
00000000: 00300293 addi t0, zero, 3 # t0 = 0x00000003 = 0x00000000 + 0x00000003
ddt>
Note that when an instruction is traced a comment is displayed explaining what the
instruction did and what values it used. I originally added this feature to debug rvddt.
But I think it is very useful instructional tool... so I kept it in.
rvddt is more of a STATIC debugging tool at the moment. :smile: It has no commands for the
editing of registers or memory.

3
examples/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.lst
*.bin
xx

79
examples/Make.rules Normal file
View File

@ -0,0 +1,79 @@
ARCH=riscv32-unknown-elf
GNU_DIR=$(HOME)/riscv/opt/rv32im_zicsr/
GNU_BIN=$(GNU_DIR)/bin
CC=$(GNU_BIN)/$(ARCH)-gcc
CXX=$(GNU_BIN)/$(ARCH)-g++
AS=$(GNU_BIN)/$(ARCH)-as
LD=$(GNU_BIN)/$(ARCH)-ld
OBJCOPY=$(GNU_BIN)/$(ARCH)-objcopy
OBJDUMP=$(GNU_BIN)/$(ARCH)-objdump
SIZE=$(GNU_BIN)/$(ARCH)-size
AR=$(GNU_BIN)/$(ARCH)-ar
RANLIB=$(GNU_BIN)/$(ARCH)-ranlib
CFLAGS+=-ffreestanding
CFLAGS+=-fno-pic
CFLAGS+=-march=rv32i -mabi=ilp32
LDFLAGS+=-nostdlib
LDFLAGS+=-Wl,-Ttext=0x80000000
# see: https://github.com/riscv/riscv-gcc/issues/120
#LDFLAGS+=-Wl,--no-relax
ASFLAGS+=$(CFLAGS)
CXXFLAGS+=$(CFLAGS)
CLEAN_DIRS=$(SUBDIRS:%=clean-%)
ALL_DIRS=$(SUBDIRS:%=all-%)
OBJDUMPFLAGS+=-Mnumeric,no-aliases
.PHONY: all clean world $(CLEAN_DIRS) $(ALL_DIRS)
%.bin : %
$(OBJCOPY) $< -O binary $@
%.lst : %
$(OBJDUMP) $(OBJDUMPFLAGS) -dr $< > $<.lst
% : %.o
$(LINK.c) $(LDFLAGS) -o $@ $^ $(LDLIBS)
$(SIZE) -x -A $@
%.s: %.c
$(COMPILE.c) -S -o $@ $<
%.s: %.cc
$(COMPILE.cc) -S -o $@ $<
%.o: %.c
$(COMPILE.c) -o $@ $<
%.o: %.cc
$(COMPILE.cc) -o $@ $<
%.srec: %
$(OBJCOPY) $< -O srec $@
all:: $(ALL_DIRS)
clean:: $(CLEAN_DIRS)
$(ALL_DIRS)::
$(MAKE) -C $(@:all-%=%) all
$(CLEAN_DIRS)::
$(MAKE) -C $(@:clean-%=%) clean
world:: clean all

79
examples/Make.rules-k Normal file
View File

@ -0,0 +1,79 @@
ARCH=riscv32-unknown-elf
GNU_DIR=$(HOME)/riscv/opt/rv32im_zicsr/
GNU_BIN=$(GNU_DIR)/bin
CC=$(GNU_BIN)/$(ARCH)-gcc
CXX=$(GNU_BIN)/$(ARCH)-g++
AS=$(GNU_BIN)/$(ARCH)-as
LD=$(GNU_BIN)/$(ARCH)-ld
OBJCOPY=$(GNU_BIN)/$(ARCH)-objcopy
OBJDUMP=$(GNU_BIN)/$(ARCH)-objdump
SIZE=$(GNU_BIN)/$(ARCH)-size
AR=$(GNU_BIN)/$(ARCH)-ar
RANLIB=$(GNU_BIN)/$(ARCH)-ranlib
CFLAGS+=-ffreestanding
CFLAGS+=-fno-pic
CFLAGS+=-march=rv32i -mabi=ilp32
LDFLAGS+=-nostdlib
LDFLAGS+=-Wl,-Ttext=0x80000000
# see: https://github.com/riscv/riscv-gcc/issues/120
#LDFLAGS+=-Wl,--no-relax
ASFLAGS+=$(CFLAGS)
CXXFLAGS+=$(CFLAGS)
CLEAN_DIRS=$(SUBDIRS:%=clean-%)
ALL_DIRS=$(SUBDIRS:%=all-%)
OBJDUMPFLAGS+=-Mnumeric,no-aliases
.PHONY: all clean world $(CLEAN_DIRS) $(ALL_DIRS)
%.bin : %
$(OBJCOPY) $< -O binary $@
%.lst : %
$(OBJDUMP) $(OBJDUMPFLAGS) -dr $< > $<.lst
% : %.o
$(LINK.c) $(LDFLAGS) -o $@ $^ $(LDLIBS)
$(SIZE) -x -A $@
%.s: %.c
$(COMPILE.c) -S -o $@ $<
%.s: %.cc
$(COMPILE.cc) -S -o $@ $<
%.o: %.c
$(COMPILE.c) -o $@ $<
%.o: %.cc
$(COMPILE.cc) -o $@ $<
%.srec: %
$(OBJCOPY) $< -O srec $@
all:: $(ALL_DIRS)
clean:: $(CLEAN_DIRS)
$(ALL_DIRS)::
$(MAKE) -C $(@:all-%=%) all
$(CLEAN_DIRS)::
$(MAKE) -C $(@:clean-%=%) clean
world:: clean all

12
examples/Makefile Normal file
View File

@ -0,0 +1,12 @@
SUBDIRS=\
load4regs \
counter \
padd \
link \
uart \
sw \
freestanding
TOP=.
include $(TOP)/Make.rules

1
examples/counter/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
counter

16
examples/counter/1 Normal file
View File

@ -0,0 +1,16 @@
# Count from zero to two using register t1
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
addi t0, zero, 5 # t0 = 3
addi t1, zero, 0 # t1 = 0
loop:
addi t1, t1, 2 # t1 = t1 + 1
1, t blt t1, t0, loop # if t1 < t0 then goto loop
done:
ebreak

14
examples/counter/Makefile Normal file
View File

@ -0,0 +1,14 @@
PROG=counter
all:: $(PROG).bin $(PROG).lst
$(PROG).bin:: $(PROG)
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

1
examples/counter/__ Normal file
View File

@ -0,0 +1 @@
riscv32-unknown-elf-objcopy -I binary -O elf32-littleriscv --binary-architecture=riscv --redefine-sym _binary_main_bin_start=_start main.bin main.elf

View File

@ -0,0 +1,16 @@
# Count from zero to two using register t1
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
addi t0, zero, 5 # t0 = 3
addi t1, zero, 0 # t1 = 0
loop:
addi t1, t1, 2 # t1 = t1 + 1
blt t1, t0, loop # if t1 < t0 then goto loop
done:
ebreak

View File

@ -0,0 +1,14 @@
SUBDIRS=\
stand00\
stand01\
stand02\
stand03\
stand04\
stand05\
stand06\
stand08\
stand10
TOP=..
include $(TOP)/Make.rules

View File

@ -0,0 +1,89 @@
These illustrate an approach to initializing an address space suitable
for running a C program that uses newlib.
*** freestanding example apps:
stand00:
long-form %pcrel() assembler macros
stand01:
use pseudo-ops to implement crt0.S in an understandable manner
stand02:
- add some variables to the data and bss regions
- now there is somehting to zero-out
- note that the text region now is zero-padded in order to be able to initialize the page-aligned data region
- see the bss region get zeroed out this time
stand03:
call main --> main() { return 0x8675309 }
- the "call main" pseudo-operation is same as:
cm1: auipc x1,%pcrel_hi(main)
jalr x1,%pcrel_lo(callmain)(cm1)
- how does 'call' know to use x1 as the return address register??????
Because the ABI says so!
stand04:
call main() and set the value of a variable in the BSS
stand05:
call main() and set the values from variables in the DATA and BSS regions.
stand06:
Create a char array in main() that is not used. Even with an initializer it is optimized away!
stand07: (error)
Create char array in main() and then use it.
This examle fails due to missing memset()!!
stand08:
Add -lgcc and -lc libraries.
stand09: (error)
Add a call to malloc() that fails because there is no sbrk()
stand10: (note that the text region is too big to hardcode the data to start at 0x1000)
Add stubs for the newlib's stdlib dependancies in stub_stdlib.c
Demonstrate that malloc() is working properly.
Conclusion:
We can now execute single-threaded C programs that can use functions from the
standard library. There are no provisions, however, for things like I/O.
*** Related issues:
- use ABI names since x-this and x-that make thinking about arg-1 and arg-2 of a
C func calls easier. Show reg table from RVALP here.
- auipc + addi = how we put the address of some label into a register.
This method is optimized to eliminate accessing memory (where we could just store a pointer).
There is an 'la' pseudo-instruction:
la a1,target
... that tells the assembler to do this:
la1: auipc a1,%pcrel_hi(target)
addi a1,a1,%pcrel_lo(la1)
- pcrel_hi(label) represents an immediate-value suitable for auipc based on the label.
This immediate will be the distance from the PC to the label!!
- pcrel_lo(hi_label) is used to calc the right imm value for an addi insn matched to an auipc!
- lui + addi = how we put an absolute value into a register
There is an 'li' pseudo-instruction that can load any value into a register:
li a1,0x12345678
The li pseudo-operation on an RV32I will expand into this:
lui a1,%hi(0x12345678)
addi a1,a1,%lo(0x12345678)
On RV32 the assembler will only need to use either an addi or a lui and addi.
Note that 'li' works on RV64 and RV128 machines too. To accomplish the loading
the assembler will use a series of instructions like lui, addi, and shift.

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,22 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
run: prog.bin
../../../src/rvddt -l0x2000 -f prog.bin

View File

@ -0,0 +1,34 @@
.text
.global _start // void _start() { ... }
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
setgp:
auipc gp,%pcrel_hi(__global_pointer$)
addi gp,gp, %pcrel_lo(setgp)
.option pop
# Clear the bss segment (starting at __bss_start and ending at __BSS_END__-1)
// a0 = __bss_start
lui a0,%hi(__bss_start)
addi a0,a0,%lo(__bss_start)
// a1 = _end
lui a1,%hi(__BSS_END__)
addi a1,a1,%lo(__BSS_END__)
clear_bss:
bgeu a0,a1,done_bss # while (!(a0 >= a1)) {
sb x0,0(a0) # *a0 = 0;
addi a0,a0,1 # ++a0
beq x0,x0,clear_bss # }
done_bss:
ebreak
.size _start, .-_start

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x2000 -f prog.bin

View File

@ -0,0 +1,27 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start # a0 = start zeroing memory here
la a1,__BSS_END__ # a1 = end zeroing here-1
clear_bss:
bgeu a0,a1,done_bss # while (!(a0 >= a1))
sb x0,0(a0) # *a0 = 0;
addi a0,a0,1 # ++a0
beq x0,x0,clear_bss
done_bss:
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x2000 -f prog.bin

View File

@ -0,0 +1,38 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start # a0 = start zeroing memory here
la a1,__BSS_END__ # a1 = end zeroing here-1
clear_bss:
bgeu a0,a1,done_bss # while (!(a0 >= a1))
sb x0,0(a0) # *a0 = 0;
addi a0,a0,1 # ++a0
beq x0,x0,clear_bss
done_bss:
# abort execution here
ebreak
.size _start, .-_start
// how to put items into the data region
.data
v1: .word 0x11,0x22,0x33,0x44 // this is same as: int32_t v1[] = {0x11,0x22,0x33,0x44};
v2: .word 0x11111111,0x22222222,0x33333333,0x44444444 // this is same as: int32_t v2[] = {0x11111111,0x22222222,0x33333333,0x44444444};
// how to put items into the bss
.lcomm b1,4 // this is the same as: int32_t b1;
.lcomm b2,16 // this is the same as: int32_t b2[4];

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,24 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x2000 -f prog.bin

View File

@ -0,0 +1,35 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
#if 1
call main
#else
callmain:
auipc x1,%pcrel_hi(main)
jalr x1,%pcrel_lo(callmain)(x1)
#endif
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,5 @@
int main()
{
return 0x8675309;
}

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x2000 -f prog.bin

View File

@ -0,0 +1,29 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,10 @@
#include <stdint.h>
uint32_t b1;
uint32_t b2[4];
int main()
{
b2[3] = 0x8675309;
return 0;
}

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,29 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,18 @@
#include <stdint.h>
uint32_t d1 = 0xdddddddd;
uint32_t d2[1000] = { 1,2,3,4,5,6,7,8,9,10 };
uint32_t d3[1000] = { 10,9,8,7,6,5,4,3,2,1 };
uint32_t b1;
uint32_t b2[4];
int main()
{
b2[3] = 0x8675309;
d3[0] = 0x12345678;
d2[0] = 0x87654321;
return 0;
}

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,29 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,11 @@
#include <stdint.h>
uint32_t b1;
uint32_t b2[4];
int main()
{
char s[100] = "Hello World";
return 0;
}

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o myfunc.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,29 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,13 @@
#include "myfunc.h"
#include <stdint.h>
uint32_t b1;
uint32_t b2[4];
int main()
{
char s[100] = { 1,2,3 };
return myfunc(s);
}

View File

@ -0,0 +1,13 @@
#include "myfunc.h" // always include my own decls so compiler will tell me if I mess up!
int myfunc(const char *s)
{
int i = 0;
// sum up all the character codes in the string
while (*s)
i += *s++;
return i;
}

View File

@ -0,0 +1,6 @@
#ifndef myfunc_H
#define myfunc_H
int myfunc(const char *s);
#endif

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,23 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=-lc -lgcc
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o myfunc.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,31 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call __libc_init_array # Run global initialization functions
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,13 @@
#include "myfunc.h"
#include <stdint.h>
uint32_t b1;
uint32_t b2[4];
int main(int argc, char **argv)
{
char s[100] = { 1,2,3 };
return myfunc(s);
}

View File

@ -0,0 +1,13 @@
#include "myfunc.h" // always include my own decls so compiler will tell me if I mess up!
int myfunc(const char *s)
{
int i = 0;
// sum up all the character codes in the string
while (*s)
i += *s++;
return i;
}

View File

@ -0,0 +1,6 @@
#ifndef myfunc_H
#define myfunc_H
int myfunc(const char *s);
#endif

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,25 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=-lc -lgcc
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
LDFLAGS+=-Wl,-Tdata=0x1000
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o myfunc.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,31 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call __libc_init_array # Run global initialization functions
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,20 @@
#include "myfunc.h"
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
uint32_t b1;
uint32_t b2[4];
int main()
{
char *s;
s = malloc(0x100);
strcpy(s, "Hello World");
int rc = myfunc(s);
free(s);
return rc;
}

View File

@ -0,0 +1,13 @@
#include "myfunc.h" // always include my own decls so compiler will tell me if I mess up!
int myfunc(const char *s)
{
int i = 0;
// sum up all the character codes in the string
while (*s)
i += *s++;
return i;
}

View File

@ -0,0 +1,6 @@
#ifndef myfunc_H
#define myfunc_H
int myfunc(const char *s);
#endif

View File

@ -0,0 +1,4 @@
*.o
*.lst
*.bin
prog

View File

@ -0,0 +1,24 @@
TOP=../..
include $(TOP)/Make.rules
LDLIBS=-lc -lgcc
CFLAGS+=-O
LDFLAGS+=-Wl,--no-relax
#LDFLAGS+=-Wl,-Tdata=0x1000
LDFLAGS+=-Wl,-Tdata=0x1400
PROGS=prog prog.bin prog.lst
all:: $(PROGS)
prog: crt0.o main.o myfunc.o stub_stdlib.o
$(LINK.c) -o $@ $^ $(LDLIBS)
$(SIZE) -A -x $@
clean::
rm -f $(PROGS) *.o *.s *.lst *.bin *.srec
.PHONY: run
run: prog.bin
../../../src/rvddt -l0x3000 -f prog.bin

View File

@ -0,0 +1,31 @@
.text
.global _start
.type _start, @function
_start:
# Initialize global pointer
.option push
.option norelax
la gp,__global_pointer$
.option pop
# Clear the bss segment
la a0,__bss_start
la a1,__BSS_END__
clear_bss:
bgeu a0,a1,finish_bss
sb x0,0(a0)
addi a0,a0,1
beq x0,x0,clear_bss
finish_bss:
call __libc_init_array # Run global initialization functions
call main
# abort execution here
ebreak
.size _start, .-_start

View File

@ -0,0 +1,20 @@
#include "myfunc.h"
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
uint32_t b1;
uint32_t b2[4];
int main()
{
char *s;
s = malloc(0x100);
strcpy(s, "Hello World");
int rc = myfunc(s);
free(s);
return rc;
}

View File

@ -0,0 +1,13 @@
#include "myfunc.h" // always include my own decls so compiler will tell me if I mess up!
int myfunc(const char *s)
{
int i = 0;
// sum up all the character codes in the string
while (*s)
i += *s++;
return i;
}

View File

@ -0,0 +1,6 @@
#ifndef myfunc_H
#define myfunc_H
int myfunc(const char *s);
#endif

View File

@ -0,0 +1,148 @@
#include <sys/stat.h>
#include <errno.h>
#include <errno.h>
#undef errno
extern int errno;
/**
* This will execute an ebreak instruction and assume that the
* CPU will halt or simulation environment will terminate.
*****************************************************************/
void _exit(int i)
{
asm volatile (" ebreak ");
}
/**
* It is assumed that there is exactly only process running and that
* it does not support signals. Therefore calling this is effectively
* illegal and will therefore execute an ebreak instruction.
*****************************************************************/
void _kill(int pid)
{
#if 1
asm volatile (" ebreak ");
#else
return; // arguably, this might also be acceptable
#endif
}
/**
* This returns the process ID of the runnung program.
* This library assumes that there is only process that
* can ever run.
*
* @return 1
*****************************************************************/
int _getpid(void)
{
return 1;
}
/**
* This library does not support any file I/O of any kind.
*
* @return -1 Indicating that file could not be closed.
*****************************************************************/
int _close(int file)
{
errno = EBADF;
return -1;
}
/**
* This library does not support any file I/O of any kind.
* This call will return a status indicating that the file
* in question is a character device.
*
* @return 0 Indicating that the call has succeeded.
*****************************************************************/
int _fstat(int file, struct stat *st)
{
st->st_mode = S_IFCHR;
return 0;
}
/**
* This library does not support any file I/O of any kind.
*
* @return 1 Indicating that file is a tty device (a terminal.)
*****************************************************************/
int _isatty(int file)
{
return 1;
}
/**
* This library does not support any file I/O of any kind.
*
* @return 0 Indicating that the request has succeeded.
*****************************************************************/
int _lseek(int file, int ptr, int dir)
{
return 0;
}
/**
* This library does not support any file I/O of any kind.
*
* @return -1 (error codition.)
*****************************************************************/
int _open(const char *name, int flags, int mode)
{
errno = ENFILE; // The system-wide limit (0) on total open files has been reached.
return -1;
}
/**
* This library does not support any file I/O of any kind.
*
* @return EOF.
*****************************************************************/
int _read(int file, char *ptr, int len)
{
return 0;
}
/**
* This function should satify the caller by simply returning len
* indicating that the write has succeeded as requested in spite
* of the fact that the data is simply ignored/discarded.
*
* @return len
*****************************************************************/
int _write(int file, char *ptr, int len)
{
return len;
}
/**
* Adjust the brk pointer up or down as requested.
*
* The initial brk address is set to _end (the end of the BSS).
* Any requests to adjust the brk will be performed without any
* error checking.
*
* @param delta The number of bytes to raise or lower the brk.
*
* @return The address that brk was set to before adjusting it by
* delta. Note that when delta is positive, this will return the
* address of the newly allocated region of memory.
*
* @bug It is possible that an errant program could call this and
* reduce the brk such that it points below _end or increase the
* brk to the point that it overlaps the stack.
*****************************************************************/
char *_sbrk (int delta)
{
extern char _end[];
static char *end_of_data = _end;
char *ptr = end_of_data;
end_of_data += delta;
return ptr;
}

1
examples/link/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
app

17
examples/link/Makefile Normal file
View File

@ -0,0 +1,17 @@
PROG=app
all:: $(PROG).bin
$(PROG):: part1.o part2.o
$(LINK.c) $(LDFLAGS) -o $@ $^ $(LDLIBS)
$(SIZE) -x -A $@
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

20
examples/link/part1.S Normal file
View File

@ -0,0 +1,20 @@
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
la t0, _vector # this is undefined when this module is assembled!
addi t1, zero, 4 # t1 = 4
addi t2, zero, 0 # t2 = 0
loop:
sw t2, 0(t0) # 0(t0) = t2
addi t0, t0, 4 # point to next element in the val array
addi t2, t2, 1 # t2 = t2 + 1
blt t2, t1, loop
done:
ebreak

10
examples/link/part2.S Normal file
View File

@ -0,0 +1,10 @@
.data # put this into the data section
.align 2 # align to 2^2
.globl _vector # make _vector visible to other load modules
.ascii "STRT"
_vector:
.skip 4*4, 0xaa
.ascii "END"

1
examples/load4regs/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
load4regs

View File

@ -0,0 +1,14 @@
PROG=load4regs
all:: $(PROG).bin $(PROG).lst
$(PROG).bin:: $(PROG)
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

View File

@ -0,0 +1,10 @@
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
addi x28, x0, 0 # set register x28 to zero
addi x29, x0, 0 # set register x29 to zero
addi x30, x0, 0 # set register x30 to zero
addi x31, x0, 0 # set register x31 to zero
ebreak

1
examples/padd/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
padd

14
examples/padd/Makefile Normal file
View File

@ -0,0 +1,14 @@
PROG=padd
all:: $(PROG).bin $(PROG).lst
$(PROG).bin:: $(PROG)
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

24
examples/padd/padd.S Normal file
View File

@ -0,0 +1,24 @@
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
la t0, val
li t1, 32 # t1 = 32 (num of elements in val array)
li t2, 0 # t2 = pointer used to fill inthe array
# addi t1, zero, 32 # t1 = 32 (num of elements in val array)
# addi t2, zero, 0 # t2 = 0
loop:
sh t2, 0(t0) # 0(t0) = t2
addi t0, t0, 2 # point to next element in the val array
addi t2, t2, 1 # t2 = t2 + 1
blt t2, t1, loop # if t2 < t1 then goto loop
done:
ebreak
.comm val, 64, 0x100 # align to a 256-byte boundary

1
examples/sw/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
sw

14
examples/sw/Makefile Normal file
View File

@ -0,0 +1,14 @@
PROG=sw
all:: $(PROG).bin $(PROG).lst
$(PROG).bin:: $(PROG)
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

20
examples/sw/sw.S Normal file
View File

@ -0,0 +1,20 @@
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
sw t1, val, a0
sw t2, val, a1
sw t3, val, x29
li a0,0x12345678
la a1, val
auipc t0, %hi(val)
addi t0, t0, %lo(val)
done:
ebreak
val:
.word 0

1
examples/uart/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
uart

14
examples/uart/Makefile Normal file
View File

@ -0,0 +1,14 @@
PROG=uart
all:: $(PROG).bin $(PROG).lst
$(PROG).bin:: $(PROG)
clean::
rm -f $(PROG) *.o *.lst *.bin *.srec
TOP=..
include $(TOP)/Make.rules
LDFLAGS+=-Wl,--no-relax

3
examples/uart/README Normal file
View File

@ -0,0 +1,3 @@
This demonstrates how to print to the rvddt console using a
simulated, infinitely fast, 'UART' whose transmit buffer is
mapped to address 0xffff0000.

20
examples/uart/uart.S Normal file
View File

@ -0,0 +1,20 @@
.text # put this into the text section
.align 2 # align to 2^2
.globl _start
_start:
li t0, 0xffff0000 # UART base address
addi t1, zero, 79
addi t2, zero, 'z'
loop:
sb t2, 1(t0) # write a 'z' character to UART tx register
addi t1, t1, -1
bne t1, zero, loop
addi t2, zero, '\n'
sb t2, 1(t0) # be kind, rewind
done:
ebreak

2
src/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
*.o
rvddt

33
src/Makefile Normal file
View File

@ -0,0 +1,33 @@
CFLAGS+=-DDEBUGGING_HACKS
CFLAGS+=-Wall -Werror
CXXFLAGS=$(CFLAGS) -std=c++11
CPPFLAGS+=-I.
CSRC=
CCSRC=\
main.cc\
memory.cc\
devices.cc\
saferead.cc\
rv32.cc\
dev/memcard.cc
COBJ=$(CSRC:.c=.o)
CCOBJ=$(CCSRC:.cc=.o)
OBJS=$(COBJ) $(CCOBJ)
.PHONY: all clean world
all: rvddt
rvddt: $(OBJS)
$(LINK.cc) $(LDFLAGS) -o $@ $(OBJS) $(LDLIBS)
clean:
rm -f *.o rvddt
world: clean all

43
src/dev/console.h Normal file
View File

@ -0,0 +1,43 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef console_H
#define console_H
#include "device.h"
#include <stdint.h>
class console : public device
{
public:
void set8(uint64_t addr, uint8_t val) { putchar(val); }
uint64_t getBaseAddress() { return 0xffff0001; }
uint64_t getLastAddress() { return 0xffff0001; }
const char *getIdent() { return "CON"; }
private:
};
#endif

58
src/dev/device.h Normal file
View File

@ -0,0 +1,58 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef device_H
#define device_H
#include "devices.h"
#include <stdint.h>
#include <string>
class device
{
public:
device() {}
virtual ~device() {}
virtual int8_t get8(uint64_t addr) { devices::errorGet("8", addr); return -1; }
virtual int16_t get16(uint64_t addr) { devices::errorGet("16", addr); return -1; }
virtual int32_t get32(uint64_t addr) { devices::errorGet("32", addr); return -1; }
virtual int64_t get64(uint64_t addr) { devices::errorGet("64", addr); return -1; }
virtual void set8(uint64_t addr, uint8_t val) { devices::errorSet("8", addr, val); }
virtual void set16(uint64_t addr, uint16_t val) { devices::errorSet("16", addr, val); }
virtual void set32(uint64_t addr, uint32_t val) { devices::errorSet("32", addr, val); }
virtual void set64(uint64_t addr, uint64_t val) { devices::errorSet("64", addr, val); }
virtual void dump() {}
virtual uint64_t getBaseAddress() = 0;
virtual uint64_t getLastAddress() = 0;
virtual const char *getIdent() = 0;
private:
};
#endif

83
src/dev/memcard.cc Normal file
View File

@ -0,0 +1,83 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#include "memcard.h"
#include <stdint.h>
int32_t memcard::get32(uint64_t addr)
{
if (addr == statusRegAddr)
return status;
else if (addr == controlRegAddr)
return control;
else if (addr == addressRegAddr)
return address;
return buf[(addr-bufFirstAddr)/4];
}
void memcard::set32(uint64_t addr, uint32_t val)
{
if (addr == statusRegAddr)
return; // ignore a write to the status register
else if (addr == controlRegAddr)
writeControl(val);
else if (addr == addressRegAddr)
writeAddress(val);
else
writeBuf(addr, val);
}
void memcard::writeControl(uint32_t val)
{
control = val;
if (control == controlWriteCommand)
{
printf("%s: Begin write operation...\n", getIdent());
}
else if (control == controlReadCommand)
{
printf("%s: Begin read operation...\n", getIdent());
}
else
{
devices::errorInvalidWrite("32", controlRegAddr, val, "Invalid command value");
}
}
void memcard::writeAddress(uint32_t val)
{
address = val;
}
void memcard::writeBuf(uint64_t addr, uint32_t val)
{
buf[(addr-bufFirstAddr)/4] = val;
}
#if 0
void memcard::dump()
{
}
#endif

74
src/dev/memcard.h Normal file
View File

@ -0,0 +1,74 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef memcard_H
#define memcard_H
#include "device.h"
#include <stdint.h>
#include <string>
class memcard : public device
{
public:
memcard() {}
virtual ~memcard() {}
int8_t get8(uint64_t addr) { devices::errorGet("8", addr); return -1; }
int16_t get16(uint64_t addr) { devices::errorGet("16", addr); return -1; }
int32_t get32(uint64_t addr);
int64_t get64(uint64_t addr) { devices::errorGet("64", addr); return -1; }
void set8(uint64_t addr, uint8_t val) { devices::errorSet("8", addr, val); }
void set16(uint64_t addr, uint16_t val) { devices::errorSet("16", addr, val); }
void set32(uint64_t addr, uint32_t val);
void set64(uint64_t addr, uint64_t val) { devices::errorSet("64", addr, val); }
void writeControl(uint32_t val);
void writeAddress(uint32_t val);
void writeBuf(uint64_t addr, uint32_t val);
//virtual void dump();
uint64_t getBaseAddress() { return 0xf0000000; }
uint64_t getLastAddress() { return 0xf0000217; }
const char *getIdent() { return "MEMCARD"; }
constexpr static uint64_t statusRegAddr = { 0xf0000214 };
constexpr static uint64_t controlRegAddr = { 0xf0000210 };
constexpr static uint64_t addressRegAddr = { 0xf0000200 };
constexpr static uint64_t bufFirstAddr = { 0xf0000000 };
constexpr static uint64_t bufLastAddr = { 0xf00001ff };
constexpr static uint32_t controlWriteCommand = { 0x80000001 };
constexpr static uint32_t controlReadCommand = { 0x80000002 };
private:
uint32_t buf[512/4] = { 0 }; // the device buffer
uint32_t status = { 0 }; // the current status register value
uint32_t control = { 0 }; // the current control register value
uint32_t address = { 0 }; // the current address register value
};
#endif

167
src/devices.cc Normal file
View File

@ -0,0 +1,167 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <unistd.h>
#include "devices.h"
#include "dev/device.h"
#include "main.h"
devices::devices()
{
setWarnings(1);
}
devices::~devices()
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
delete *itr;
}
int8_t devices::get8(uint64_t addr)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
return pdev->get8(addr);
}
errorGet("8", addr);
return -1; // invalid devices area, act like a hi-z TTL bus
}
int16_t devices::get16(uint64_t addr)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
return pdev->get16(addr);
}
errorGet("16", addr);
return -1; // invalid devices area, act like a hi-z TTL bus
}
int32_t devices::get32(uint64_t addr)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
return pdev->get32(addr);
}
errorGet("32", addr);
return -1; // invalid devices area, act like a hi-z TTL bus
}
int64_t devices::get64(uint64_t addr)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
return pdev->get64(addr);
}
errorGet("64", addr);
return -1; // invalid devices area, act like a hi-z TTL bus
}
void devices::set8(uint64_t addr, uint8_t val)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
{
pdev->set8(addr, val);
return;
}
}
errorSet("8", addr, val);
}
void devices::set16(uint64_t addr, uint16_t val)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
{
pdev->set16(addr, val);
return;
}
}
errorSet("16", addr, val);
}
void devices::set32(uint64_t addr, uint32_t val)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
{
pdev->set32(addr, val);
return;
}
}
errorSet("32", addr, val);
}
void devices::set64(uint64_t addr, uint64_t val)
{
for (auto itr = devs.begin(); itr != devs.end(); ++itr)
{
device *pdev = *itr;
if (pdev->getBaseAddress() <= addr && pdev->getLastAddress() >= addr)
{
pdev->set64(addr, val);
return;
}
}
errorSet("64", addr, val);
}
void devices::errorSet(const char *len, uint64_t addr, uint64_t val)
{
printf("WARNING: %s-bit write to non-existent device at address: 0x%8.8x = 0x%8.8x\n", len, (uint32_t)addr, (uint32_t)val);
}
void devices::errorGet(const char *len, uint64_t addr)
{
printf("WARNING: %s-bit read from non-existent device at address: 0x%8.8x\n", len, (uint32_t)addr);
}
void devices::errorInvalidWrite(const char *len, uint64_t addr, uint64_t val, const char *msg)
{
printf("WARNING: %s-bit write to address 0x%8.8x with illegal value 0x%8.8x\n", len, (uint32_t)addr, (uint32_t)val);
if (msg)
printf("%s\n", msg);
}

66
src/devices.h Normal file
View File

@ -0,0 +1,66 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef devices_H
#define devices_H
#include <stdint.h>
#include <set>
//#include "dev/device.h"
class device;
class devices
{
public:
devices();
~devices();
int8_t get8(uint64_t addr);
int16_t get16(uint64_t addr);
int32_t get32(uint64_t addr);
int64_t get64(uint64_t addr);
void set8(uint64_t addr, uint8_t val);
void set16(uint64_t addr, uint16_t val);
void set32(uint64_t addr, uint32_t val);
void set64(uint64_t addr, uint64_t val);
void dump();
void setWarnings(int i) { warnings=i; }
int getWarnings() const { return warnings; }
void addDevice(device *d) { devs.insert(d); }
static void errorGet(const char *len, uint64_t addr);
static void errorSet(const char *len, uint64_t addr, uint64_t val);
static void errorInvalidWrite(const char *len, uint64_t addr, uint64_t val, const char *msg=nullptr);
private:
int warnings;
std::set<device *> devs;
};
#endif

345
src/main.cc Normal file
View File

@ -0,0 +1,345 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "main.h"
#include "memory.h"
#include "rv32.h"
#include "dev/console.h"
#include "dev/memcard.h"
FILE *ddtout;
rv32 *cpu;
devices *dev;
static void cli();
static void usage()
{
printf("Usage: rvddt [-s <memstart>] [-l <memlen>] [-f memimage]\n");
}
int main(int argc, char **argv)
{
uint64_t memstart = 0; // default = 0
uint64_t memlen = 0x10000; // default = 64k
const char *loadfile = 0;
int opt;
while ((opt = getopt(argc, argv, "s:l:f:")) != -1)
{
switch (opt)
{
case 's': // memstart
memstart = strtoul(optarg, 0, 0);
break;
case 'l': // memory segment length
memlen = strtoul(optarg, 0, 0);
break;
case 'f': // load memory image from file
loadfile = optarg;
break;
default:
usage();
exit(1);
}
}
ddtout = stdout;
mem = new memory(memstart, memlen);
cpu = new rv32();
dev = new devices();
dev->addDevice(new console());
dev->addDevice(new memcard());
uint32_t start = memstart;
// Consider providing a method to bootstrap the pc & sp regs akin to an ARM?
// prime the program counter
cpu->setPc(start);
// Prime the stack pointer
#if 1
uint32_t stackTop = memstart+memlen;
cpu->setReg(2, stackTop);
#else
uint32_t stackTop = memstart+memlen-16; // newlib crt0 accesses beyond sp?
cpu->setReg(2, stackTop);
mem->set64(stackTop, 0); // XXX zero some space
mem->set64(stackTop+8, 0); // ... I never checked to see how argv & argc work
#endif
printf("sp initialized to top of memory: 0x%8.8x\n", cpu->getReg(2));
if (loadfile)
{
printf("Loading '%s' to 0x%x\n", loadfile, start);
mem->readRaw(loadfile, start);
}
cli();
delete cpu;
delete mem;
fflush(ddtout);
if (ddtout!=stdout)
fclose(ddtout);
return 0;
}
/**
* Run until we hit an EBREAK.
*************************************************************************/
static void run()
{
int save = cpu->setTrace(0);
while(!cpu->exec())
;
cpu->setTrace(save);
}
/**
* Set the pc to the given address and execute silently, continuously.
*************************************************************************/
static void cli_g(uint64_t pc)
{
cpu->setPc(pc);
run();
}
static void cli_g()
{
run();
}
/**
* Dump the CPU status and then execute one instruction.
*************************************************************************/
static int cli_t(int regs)
{
if (regs)
cpu->dump();
return cpu->exec();
}
static void cli_t(uint64_t count, int regs)
{
int s = 0;
while(count-- && !s)
s = cli_t(regs);
}
static void cli_t(uint64_t pc, uint64_t count, int regs)
{
cpu->setPc(pc);
cli_t(count, regs);
}
/**
* Examine the CPU regs/status.
*************************************************************************/
static void cli_r()
{
cpu->dump();
}
/**
* Dump memory contents.
*************************************************************************/
static void cli_d(uint64_t start, uint64_t len)
{
mem->dump(start, len);
}
static void redirect(const char *fname)
{
if (ddtout != stdout)
fclose(ddtout);
if (fname)
ddtout = fopen(fname, "a");
else
ddtout = stdout;
}
/**
* Command line interpreter.
*************************************************************************/
static void cli()
{
int running = 1;
char buf[2048];
char last[2048];
uint64_t d_next = 0;
char p1[1024];
char p2[64];
int echo = !isatty(fileno(stdin));
last[0] = '\0';
printf("This is rvddt. Enter ? for help.\n");
while (running)
{
// display a prompt
printf("ddt> ");
// get command line
if (fgets(buf, sizeof(buf), stdin) == 0)
{
// got EOF, process it like an 'x' command
buf[0] = 'x';
buf[1] = '\0';
}
// trim any white junk off the end of the line
int len = strlen(buf);
while (len>0 && isspace(buf[len-1]))
buf[--len] = '\0'; // trim junk newline
// if user hit return, repeat the last repeatable command
if (buf[0] == '\0')
strcpy(buf, last);
last[0] = '\0';
if (echo)
puts(buf);
char cmd[2048];
char* args;
int i = 0;
len = strlen(buf);
while (i<len && (isalpha(buf[i]) || buf[i]=='?' || buf[i]=='>'))
{
cmd[i] = buf[i];
++i;
}
cmd[i] = '\0';
args = &buf[i];
// exec command
if (cmd[0] == '\0') // empty line (with no repeatable command in the cache)
;
else if (!strcmp(cmd, "x")) // exit the simulator
running = 0;
else if (!strcmp(cmd, "r")) // dump the regs
cli_r();
else if (!strcmp(cmd, "t")) // trace insns
{
if (sscanf(args, " %63s %63s", p1, p2) == 2)
cli_t(strtoul(p1, 0, 0), strtoul(p2, 0, 0), 1);
else if (sscanf(args, " %63s", p1) == 1)
cli_t(strtoul(p1, 0, 0), 1);
else
cli_t(1);
strcpy(last, "t"); // suppress the args when repeating the command
}
else if (!strcmp(cmd, "ti")) // trace insns w/o reg dumps
{
if (sscanf(args, " %63s %63s", p1, p2) == 2)
cli_t(strtoul(p1, 0, 0), strtoul(p2, 0, 0), 0);
else if (sscanf(args, " %63s", p1) == 1)
cli_t(strtoul(p1, 0, 0), 0);
else
cli_t(0);
strcpy(last, "ti"); // suppress the args when repeating the command
}
else if (!strcmp(cmd, "g")) // go [entry]
{
if (sscanf(args, " %63s", p1) == 1)
cli_g(strtoul(p1, 0, 0));
else
cli_g();
strcpy(last, buf);
}
else if (!strcmp(cmd, "d")) // dump memory
{
int mw = mem->getMemoryWarnings();
mem->setMemoryWarnings(0);
uint64_t addr = d_next;
uint64_t count = 0x100;
if (sscanf(args, " %63s %63s", p1, p2) == 2)
{
addr = strtoul(p1, 0, 0);
count = strtoul(p2, 0, 0);
}
else if (sscanf(args, " %63s", p1) == 1)
{
addr = strtoul(p1, 0, 0);
}
cli_d(addr, count);
d_next = addr+count;
mem->setMemoryWarnings(mw);
strcpy(last, "d"); // suppress the args when repeating the command
}
else if (!strcmp(cmd, ">")) // redirect output
{
if (sscanf(args, " %1023s", p1) != 1)
{
printf("Invalid redirect (missing filename?)\n");
break;
}
if (!strcmp(p1, "-"))
redirect(0);
else
redirect(p1);
last[0] = '\0';
}
else if (!strcmp(cmd, "a")) // change register naming mode
{
cpu->setRegNamesABI(!cpu->getRegNamesABI());
last[0] = '\0';
}
else if (!strcmp(cmd, "?")) // help
{
printf("commands:\n"
" a toggle the display of register ABI and x-names\n"
" d [addr [len]] dump memory starting at addr for len bytes\n"
" g [addr] set pc=addr and silently execute qty instructions\n"
" r dump the contents of the CPU regs\n"
" t [[addr] qty] set pc=addr and trace qty instructions\n"
" ti [[addr] qty] set pc=addr and trace qty instructions w/o reg dumps\n"
" x exit\n"
" > filename redirect output to 'filename' (use - for stdout)\n"
);
}
else
{
printf("Illegal command. Press ? for help.\n");
}
}
}

36
src/main.h Normal file
View File

@ -0,0 +1,36 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef main_H
#define main_H
#include <stdio.h>
#include "memory.h"
#include "devices.h"
#include "rv32.h"
extern FILE *ddtout;
extern rv32 *cpu;
extern devices *dev;
#endif

258
src/memory.cc Normal file
View File

@ -0,0 +1,258 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <unistd.h>
#include <inttypes.h>
#include "saferead.h"
#include "devices.h"
#include "memory.h"
#include "main.h"
memory *mem;
/**
****************************************************************************/
memory::memory(uint64_t start, uint64_t length)
{
mem = new int8_t[length];
memset(mem, 0xa5, length); // fill with an EZ to recognize pattern
this->start = start;
len = length;
setMemoryWarnings(1);
}
/**
****************************************************************************/
memory::~memory()
{
delete mem;
mem = 0;
}
/**
****************************************************************************/
int8_t memory::get8(uint64_t addr)
{
if (addr >= devBaseAddress)
return dev->get8(addr);
if (addr < start || addr >= start+len)
{
if (getMemoryWarnings())
{
printf("WARNING: accessing non-existent memory at address: 0x%8.8x", (uint32_t)addr);
#ifdef DEBUGGING_HACKS
printf(", pc=0x%8.8x", cpu->getPc());
#endif
printf("\n");
}
return 0xff; // invalid memory area, act like a hi-z TTL bus
}
return mem[addr-start];
}
/**
****************************************************************************/
int16_t memory::get16(uint64_t addr)
{
if (addr >= devBaseAddress)
return dev->get16(addr);
int16_t i = (uint8_t)get8(addr);
i |= ((uint16_t)get8(addr+1))<<8;
return i;
}
/**
****************************************************************************/
int32_t memory::get32(uint64_t addr)
{
if (addr >= devBaseAddress)
return dev->get32(addr);
int32_t i = (uint16_t)get16(addr);
i |= ((uint32_t)get16(addr+2))<<16;
return i;
}
/**
****************************************************************************/
int64_t memory::get64(uint64_t addr)
{
if (addr >= devBaseAddress)
return dev->get64(addr);
int64_t i = (uint32_t)get32(addr);
i |= ((uint64_t)get32(addr+4))<<32;
return i;
}
/**
****************************************************************************/
void memory::set8(uint64_t addr, uint8_t val)
{
if (addr >= devBaseAddress)
{
dev->set8(addr, val);
return;
}
if (addr < start || addr >= start+len)
{
if (getMemoryWarnings())
{
printf("WARNING: accessing non-existent memory at address: 0x%8.8x", (uint32_t)addr);
#ifdef DEBUGGING_HACKS
printf(", pc=0x%8.8x", cpu->getPc());
#endif
printf("\n");
}
return; // invalid memory area, throw it away
}
mem[addr-start] = val;
}
/**
****************************************************************************/
void memory::set16(uint64_t addr, uint16_t val)
{
if (addr >= devBaseAddress)
{
dev->set16(addr, val);
return;
}
set8(addr, val&0x00ff); // little-endian order
set8(addr+1, (val>>8)&0x00ff);
}
/**
****************************************************************************/
void memory::set32(uint64_t addr, uint32_t val)
{
if (addr >= devBaseAddress)
{
dev->set32(addr, val);
return;
}
set16(addr, val&0x0000ffff); // little-endian order
set16(addr+2, (val>>16)&0x0000ffff);
}
/**
****************************************************************************/
void memory::set64(uint64_t addr, uint64_t val)
{
if (addr >= devBaseAddress)
{
dev->set32(addr, val);
return;
}
set32(addr, val&0x0000ffffffff); // little-endian order
set32(addr+4, (val>>32)&0x0000ffffffff);
}
/**
* Read the given raw file into memory at the given address.
*****************************************************************/
void memory::readRaw(const char *filename, uint64_t addr)
{
int fd;
fd = open(filename, O_RDONLY);
if (fd == -1)
{
fprintf(stderr, "Failed to open file '%s', Reason: %s\n", filename, strerror(errno));
return;
}
saferead(fd, (char*)(&mem[addr-start]), len-(addr-start));
close(fd);
}
/**
****************************************************************************/
void memory::dump(uint64_t addr, uint64_t length)
{
int ch;
int i = 0;
uint64_t j;
unsigned char ascii[20]; /* to hold printable portion of string */
if (length==0)
return;
int startingoffset = addr%16;
if (startingoffset != 0)
{
// pre-padd the dump so it looks purdy
fprintf(ddtout, " %8.8" PRIx64 ":%s", addr&~0x0f, startingoffset>8?" ":"");
int i;
for (i=0; i<startingoffset; ++i)
fprintf(ddtout, " ");
}
for(j=addr; j<(addr+length); ++j)
{
ch = get8(j);// ((char*)buff)[j];
if ((j % 16) == 0)
{
if (j>addr)
{
ascii[i] = '\0';
fprintf(ddtout, " %*s*%s*\n", startingoffset, "", ascii);
startingoffset = 0;
}
fprintf(ddtout, " %8.8x:", (uint32_t)j);
i = 0;
}
fprintf(ddtout, "%s%2.2x", (j%8==0&&j%16!=0)?" ":" ", ch & 0xff);
ascii[i] = ch;
if ((ascii[i] >= 0x80)||(!isprint(ascii[i])))
ascii[i] = '.';
++i;
}
if (j%16 && j%16<9)
fprintf(ddtout, " ");
while (j%16)
{
fprintf(ddtout, " ");
++j;
}
ascii[i] = '\0';
fprintf(ddtout, " %*s*%s*\n", startingoffset, "", ascii);
}

65
src/memory.h Normal file
View File

@ -0,0 +1,65 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef memory_H
#define memory_H
#include <stdint.h>
#include <string>
constexpr uint32_t devBaseAddress = 0xf0000000;
class memory
{
public:
memory(uint64_t start, uint64_t length);
~memory();
int8_t get8(uint64_t addr);
int16_t get16(uint64_t addr);
int32_t get32(uint64_t addr);
int64_t get64(uint64_t addr);
void set8(uint64_t addr, uint8_t val);
void set16(uint64_t addr, uint16_t val);
void set32(uint64_t addr, uint32_t val);
void set64(uint64_t addr, uint64_t val);
void dump(uint64_t addr, uint64_t length);
void readRaw(const char *filename, uint64_t addr);
void setMemoryWarnings(int i) { memoryWarnings=i; }
int getMemoryWarnings() const { return memoryWarnings; }
private:
int8_t *mem; // the actual memory buffer
uint64_t start;
uint64_t len;
int memoryWarnings;
};
extern memory *mem;
#endif

65
src/memorymap.md Normal file
View File

@ -0,0 +1,65 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
Memory map
ffff0001-ffff0001 console printer transmit register
f0000214-f0000217 memory card status register
f0000210-f0000213 memory card control register
f0000200-f0000203 memory card address register
f0000000-f00001ff 512-byte memory card DMA buffer
00000040-0000ffff RAM *
00000000-0000003f vectors
* The amount of RAM in the system can be specidfied by the -s and -l arguments to rvddt
A simplified 'printer' device that runs infinitely fast and that prints
bytes that are sent to it on the terminal has a 8-bit transmit register
at address 0xffff0001.
The simplified 'memory card' is simulated by using a file to contain
the card's data bytes.
Writing data to the memory card:
* Wait for the memory card to become IDLE by checking the status register.
* Place 512 bytes to be written into the memory card buffer: f0000000-f00001ff.
* Write the memory card block number into the memory card address register.
* Write the 'write command' onto the memory card control register.
The data transfer simulation will take some number of instruction cycles to complete.
The busy/idle status is always available in the memory card status register.
Memory card control register commands:
0x80000001 = write the 512-byte DMA buffer into the memory card at the address in the memory card address register*0x200.
0x80000002 = read 512 bytes from the memory card at the address in the memory card address register*0x200 into the 512-byte DMA buffer.
Memory card status register:
0x00000000 = idle
0x00000001 = busy writing
0x00000002 = busy reading

1033
src/rv32.cc Normal file

File diff suppressed because it is too large Load Diff

138
src/rv32.h Normal file
View File

@ -0,0 +1,138 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef rv32_H
#define rv32_H
#include <stdint.h>
#include <stdint.h>
#include "memory.h"
enum class insntype { R, I, S, B, U, J };
class rv32;
typedef void (*execInsnFunc)(rv32 *, uint32_t);
struct insn
{
uint8_t opcode;
insntype itype;
uint8_t funct3_flag;
uint8_t funct3;
uint8_t funct7_flag;
uint8_t funct7;
const char *mneumonic;
execInsnFunc func;
};
class rv32
{
public:
rv32();
~rv32();
void reset();
void dump();
int32_t getReg(uint8_t reg);
int32_t getPc();
void setReg(uint8_t reg, int32_t val);
void setPc(int32_t val);
int exec();
int setTrace(int);
int getRegNamesABI() const { return regNamesABI; }
void setRegNamesABI(int i) { regNamesABI = i?1:0; }
const char *getRegName(uint8_t r);
int32_t getInsnImmI(uint32_t insn);
int32_t getInsnImmS(uint32_t insn);
int32_t getInsnImmB(uint32_t insn);
int32_t getInsnImmU(uint32_t insn);
int32_t getInsnImmJ(uint32_t insn);
int8_t getInsnRd(uint32_t insn) { return (insn&0x00000f80)>>7; }
int8_t getInsnRs1(uint32_t insn) { return (insn&0x000f8000)>>15; }
int8_t getInsnRs2(uint32_t insn) { return (insn&0x01f00000)>>20; }
int8_t getInsnOpcode(uint32_t insn) { return insn&0x000007f; }
int8_t getInsnFunct3(uint32_t insn) { return (insn&0x0007000)>>12; }
int8_t getInsnFunct7(uint32_t insn) { return (insn&0xfe000000)>>25; }
static void exec_LUI(rv32 *, uint32_t insn);
static void exec_AUIPC(rv32 *, uint32_t insn);
static void exec_JAL(rv32 *, uint32_t insn);
static void exec_JALR(rv32 *, uint32_t insn);
static void exec_BEQ(rv32 *, uint32_t insn);
static void exec_BNE(rv32 *, uint32_t insn);
static void exec_BLT(rv32 *, uint32_t insn);
static void exec_BGE(rv32 *, uint32_t insn);
static void exec_BLTU(rv32 *, uint32_t insn);
static void exec_BGEU(rv32 *, uint32_t insn);
static void exec_LB(rv32 *, uint32_t insn);
static void exec_LH(rv32 *, uint32_t insn);
static void exec_LW(rv32 *, uint32_t insn);
static void exec_LBU(rv32 *, uint32_t insn);
static void exec_LHU(rv32 *, uint32_t insn);
static void exec_SB(rv32 *, uint32_t insn);
static void exec_SH(rv32 *, uint32_t insn);
static void exec_SW(rv32 *, uint32_t insn);
static void exec_ADDI(rv32 *, uint32_t insn);
static void exec_SLTI(rv32 *, uint32_t insn);
static void exec_SLTIU(rv32 *, uint32_t insn);
static void exec_XORI(rv32 *, uint32_t insn);
static void exec_ORI(rv32 *, uint32_t insn);
static void exec_ANDI(rv32 *, uint32_t insn);
static void exec_SLLI(rv32 *, uint32_t insn);
static void exec_SRLI(rv32 *, uint32_t insn);
static void exec_SRAI(rv32 *, uint32_t insn);
static void exec_ADD(rv32 *, uint32_t insn);
static void exec_SUB(rv32 *, uint32_t insn);
static void exec_SLL(rv32 *, uint32_t insn);
static void exec_SLT(rv32 *, uint32_t insn);
static void exec_SLTU(rv32 *, uint32_t insn);
static void exec_XOR(rv32 *, uint32_t insn);
static void exec_SRL(rv32 *, uint32_t insn);
static void exec_SRA(rv32 *, uint32_t insn);
static void exec_OR(rv32 *, uint32_t insn);
static void exec_AND(rv32 *, uint32_t insn);
//void printInsn(uint32_t insn);
private:
static const char *regNames[2][32];
static const insn insns[];
//void printInsnArgs(const insn *pi, uint32_t insn);
int execInsn(int32_t insn);
//void execInsn2(const insn *pi, uint32_t insn);
int32_t reg[32];
uint32_t pc;
int trace;
int regNamesABI; // true = print ABI names
};
#endif

51
src/saferead.cc Normal file
View File

@ -0,0 +1,51 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <unistd.h>
#include "saferead.h"
/**
* read len bytes or die trying
*****************************************************************/
ssize_t saferead(int fd, char *buf, ssize_t want)
{
ssize_t got = 0;
while (got < want)
{
ssize_t len = read(fd, &buf[got], want);
if (len == -1)
return -1;
if (len == 0)
break;
got += len;
want -= len;
}
return got;
}

31
src/saferead.h Normal file
View File

@ -0,0 +1,31 @@
//****************************************************************************
//
// RVDDT (RISC-V Dynamic Debugging Tool)
//
// Copyright (C) 2020 John Winans
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
// USA
//
//****************************************************************************
#ifndef saferead_H
#define saferead_H
#include <unistd.h>
ssize_t saferead(int fd, char *buf, ssize_t want);
#endif