uofw/README.md

77 lines
3.5 KiB
Markdown
Raw Normal View History

2012-11-10 12:30:17 +00:00
uOFW
2012-11-09 23:39:19 +00:00
====
2012-11-10 16:38:02 +00:00
The unofficial Official FirmWare, a complete latest PSP firmware reverse engineering project.
2013-03-17 22:40:54 +00:00
2012-11-10 16:38:02 +00:00
Project page: http://uofw.psnpt.com/
Doxygen documentation: http://uofw.psnpt.com/sdkdoc/
For more information: http://dev.psnpt.com/redmine/projects/uofw/wiki
2013-03-17 22:40:54 +00:00
NOTE: We currently plan to move both the wiki and the documentation to Github and shutdown the project page
instead. We'll keep you updated on this as progress is being made.
## Getting started
2012-11-10 16:38:02 +00:00
2013-01-29 20:57:43 +00:00
In order to contribute to uOFW, you need advanced knowledge in MIPS ASM and C. Some good MIPS ASM
2013-03-17 23:08:53 +00:00
online resources can be found [on the MIPS company page](http://www.mips.com/products/product-materials/processor/mips-architecture/).
2012-11-10 16:38:02 +00:00
MIPS ASM Instruction Set Reference: http://math-atlas.sourceforge.net/devel/assembly/mips-iv.pdf
In addition, there is a nice MIPS runtime simulator and debugger which can be found at:
http://courses.missouristate.edu/kenvollmar/mars/
2013-03-17 23:08:53 +00:00
The next step is to improve your reverse engineering skills (if needed). We suggest reading [this excellent guide]
(http://psnpt.com/joomla/index.php/articles/39-tutorials) about reverse engineering for the PSP.
2012-11-10 16:38:02 +00:00
2013-02-06 16:27:17 +00:00
If you have questions, don't hesitate to ask us!
2012-11-10 16:38:02 +00:00
2013-03-17 22:40:54 +00:00
## Repository structure
2013-03-17 22:59:19 +00:00
uOFW's Github repository contains one 'master' branch and several sub-branches.
2013-03-17 22:40:54 +00:00
The master branch is aimed to contain only tested and working code (in fact, it should contain working modules).
Please note that this is not entirely the case right now as we still need to test, and fix, some of the code in the
master branch due to the past repository structure.
Then there are sub-branches which are aimed to each represent a module currently being worked on. Such a branch
contains unfinished, untested and undocumented code about the module it is named after. Once such a branch contains
finished, documented code (that is, the module has been finished reverse-engineering) it will be merged into
the 'master' branch.
2013-03-17 22:59:19 +00:00
Currently, there are three sub-branches: [clockgen] (https://github.com/uofw/uofw/tree/clockgen),
[memlmd](https://github.com/uofw/uofw/tree/memlmd), [power](https://github.com/uofw/uofw/tree/power)
2013-03-17 22:40:54 +00:00
## Additional Information
2012-11-10 12:30:17 +00:00
2013-01-29 20:57:43 +00:00
While you reverse-engineer parts of the PSP's kernel, you may will find yourself in a position
where you would like to know more about how Operating Systems work in general. We suggest to check
2013-03-17 23:08:53 +00:00
out [this webpage](http://wiki.osdev.org/Expanded_Main_Page).
2013-01-29 20:57:43 +00:00
If you are looking for more PSP-related resources, you should consider checking out the following links
below:
2013-01-29 21:21:25 +00:00
2013-03-17 22:40:54 +00:00
* [LAN.st - IdStorage](http://lan.st/archive/index.php/t-151.html)
* [LAN.st - General PSP questions](http://lan.st/archive/index.php/t-3013.html)
* [LAN.st - PSP Motherboard information](http://lan.st/archive/index.php/t-372.html)
2013-03-17 23:08:53 +00:00
* [Yet Another Playstation Portable Documentation](http://hitmen.c02.at/files/yapspd/psp_doc.pdf.tar.gz)
2013-03-17 22:40:54 +00:00
* [PSP Module Tutorial](http://pspdev1.com/wp-content/uploads/2007/03/moduletutorialv1.pdf)
* [24C3 - TyRaNiD on early PSP hacking + Pandorra hack](https://www.youtube.com/watch?v=INdUZk4NFIA)
2013-01-29 20:57:43 +00:00
2013-01-29 21:21:25 +00:00
Other websites are:
2013-03-17 22:40:54 +00:00
* http://wololo.net
* http://ps2dev.org
2013-01-29 20:57:43 +00:00
2013-03-19 19:04:45 +00:00
## Questions or need help?
2013-01-29 20:57:43 +00:00
You can stay in touch with us and discuss project-related topics with us via the following ways:
2013-03-17 23:08:53 +00:00
* via IRC on the [FreeNode server](http://webchat.freenode.net/) (irc.freenode.net) (join the channel #uofw)
2013-03-17 22:59:19 +00:00
* via e-mail
2013-03-19 19:04:45 +00:00
## Copyright and License
For copyright and license information, please check [this file](https://github.com/uofw/uofw/blob/master/COPYING)