1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
LibPSn00b, PSn00bSDK software libraries
2019 - 2020 Lameguy64 / Meido-Tek Productions
Licensed under Mozilla Public License
LibPSn00b is a collection of libraries that make up the core backbone of
PSn00bSDK, as it provides a higher level software interface for developing
software for the PS1 platform. The majority of the libraries are been written
from scratch in a mix of C and hand optimized assembly language for optimal
software performance.
These libraries can only be compiled using a build of GCC that targets
mipsel-unknown-elf (or mipsel-none-elf). Compiler version shouldn't matter
much and it should work fine with the latest GCC release, though 7.4.0 is the
recommended version as that is what LibPSn00b is most tested most on.
Brief summary of libraries:
libc - Standard C library. Covers only a small subset of the full
standard C library such as basic string and memory manipulation
functions. Should include libgcc to avoid libc/libgcc linker
hell (endless cross referencing).
psxgpu - GPU library for video, graphics control, and interrupt service
subsystem that other libraries that uses interrupts depend on.
psxgte - GTE library for hardware accelerated vector transformations
that are integral for high performance 3D graphics on the PS1
(it is a Geometry Transformation Engine, NOT Transfer Engine).
psxapi - Provides function calls for using functions provided by the PS1
BIOS.
psxetc - Provides some miscellaneous features used by the other libraries
as well as a dynamic linker for loading DLLs at runtime.
psxspu - SPU library (work in progress). Currently supports hardware
init, sample data upload via DMA and playing sound samples.
Lacks support for reverb and a sequenced music subsystem.
psxcd - CD-ROM library for loading files, parsing directories
(PSn00bSDK addition), CD Audio/XA playback with provisions for
data streaming. Also supports multi-session discs (must be
selected manually).
psxpress - Experimental MDEC library. Currently provides APIs to feed data
to the MDEC and retrieve decoded images, as well as a
decompressor for the Huffman encoding used in FMVs encoded using
Sony tools. A custom decompressor based on arithmetic coding
might be implemented in the future.
Each library has its own readme file that contains a todo list, credits
and some additional details of the library. Changes of all the libraries
must be covered in the changelog.txt file.
Compiling:
Refer to installation.md in the doc directory for up-to-date installation
instructions.
--- THE SECTION BELOW IS OUTDATED AND ONLY KEPT FOR REFERENCE ---
To compile the LibPSn00b libraries, you will first need a working GCC
toolchain which you can either build yourself as described in the
toolchain.txt file (preferred on Linux/BSDs) or download a precompiled
toolchain from the PSn00bSDK page of Lameguy64's website:
http://lameguy64.net/?page=psn00bsdk
Once the toolchain is set up, you may want to set the following
environment variables if they're required for your particular setup:
* PSN00BSDK_TC specifies the base directory of the GCC toolchain to
compile the libraries with. If GCC_BASE is defined in the environment it
will use the path of that variable instead. If neither variable is
defined the makefiles will assume the toolchain binaries are accessible
from your PATH variable and the GCC toolchain directory is at
C:\mipsel-unknown-elf in Windows or /usr/local/mipsel-unknown-elf
in Linux/BSD.
* GCC_VERSION specifies the version of the toolchain. If not specified
the makefiles will default to 7.4.0. This is only used for building the
libc library which needs to inherit the libgcc library from the
toolchain directories to avoid the aforementioned linker hell, and the
path to that library file includes a directory named after the version
number.
* PSN00BSDK_LIBS specifies the absolute directory path you wish the
compiled libraries will be copied to. If not defined the compiled
libraries will simply be copied to the parent directory of the libraries
(libpsn00b).
Once the environment variables are set, building the libraries should just
be a matter of simply running 'make all install' within the LibPSn00b
directory and it should run through all the libraries. You may specify a
-j parameter to run the jobs in parallel on a mult-processor/core/thread
system.
Documentation:
LibPSn00b documentation is all covered in the LibPSn00b Reference.odf
document complete with the same document formatting as found in official
library documents. It may be wise to export the document as a PDF
document for easier viewing.
The PSn00bSDK CMake toolchain script also defines several macros and
helpers that can be used in project build scripts, documented in
cmake_reference.md.
Contributing:
Contributions are open for this project. But it is recommended to at
least follow the following rules when contributing to prevent headaches.
* If you add new functions to libpsn00b make sure you document them in
libn00bref.odf. Documentation using Doxygen is not recommended.
* Library functions can either be written in C or assembly language
whichever you prefer. Though it is not entirely mandatory but
recommended to write functions that directly interact with hardware
registers in assembly.
* Functions must work on both emulators and real hardware.
* Don't forget to put your name in the readme file of the library you've
made a contribution on and details of what you've changed in the
changelog.txt file. Updates by 'annoyingmous' are not tolerated in this
project.
* New functions that are not originally in the official SDK must be marked
as original code in both the library headers and the libn00bref document
to help differentiate from original functions and new additions.
LibPSn00b Library to-do list:
Because the PSn00bSDK project still a work in progress, a number of
libraries have been considered but not yet developed. The following
lists a number of libraries that are not yet in development.
psxpad - Pad/tap/gun library for better controller support. May support
PS2 controllers natively. Should provide functions for directly
controlling the controller/memory card interfaces to cater to
the development of custom peripherals.
psxmcrd - Better and faster memory card library with provisions for
low-level card access. The psxpad library would provide
communication routines for the card library.
psxexp - Support library for various devices connected to the serial or
expansion port, including both official ones (e.g. PCMCIA cards
and IDE drives used by some PS1-based arcade systems) as well
as cheat devices, RAM expanders or even ESP8266/ESP32 wireless
modules. May also include APIs for accessing the filesystem on
a connected drive (possibly by overriding psxcd and psxmcrd
functions) or reliably transferring data from/to a PC.
|
