opengnm

KO | EN

gitlite — search

#framework #chatbot #rag #reactjs #postgresql #electron #openai #security #gpt #nlp

(★ 9)

Clean-rewrite PS4 GNM library — sceGnm*/sceGpa* drop-in API compatibility with the Sony official PS4 SDK

File Explorer

ZIP Download

- - docs.yml
- opengnmConfig.cmake.in
- - hardware-smoke.md
  - index.md
- - command-buffers.md
  - index.md
  - render-targets.md
  - rendering-pipeline.md
  - shaders.md
  - surface-computation.md
  - textures-and-formats.md
- - buffer.md
  - commandbuffer.md
  - compat.md
  - controls.md
  - dataformat.md
  - depthrendertarget.md
  - drawcommandbuffer.md
  - driver.md
  - error.md
  - gpuaddr.md
  - helpers.md
  - index.md
  - platform.md
  - rendertarget.md
  - sampler.md
  - shader.md
  - shaderbinary.md
  - strings.md
  - texture.md
  - types.md
- - extract_api.py
- architecture.md
- backends.md
- freegnm-compat.md
- getting-started.md
- index.md
- requirements.txt
- - freegnm.h
  - gnf.h
  - pssl.h
- - buffer.h
  - commandbuffer.h
  - controls.h
  - dataformat.h
  - depthrendertarget.h
  - drawcommandbuffer.h
  - driver.h
  - error.h
  - gnm.h
  - platform.h
  - rendertarget.h
  - sampler.h
  - shader.h
  - shaderbinary.h
  - strings.h
  - texture.h
  - types.h
- - amdgfxregs.h
  - gpuaddr_types.h
  - pm4_ps4.h
  - sid.h
- gnm.h
- gnm_buffer.h
- gnm_commandbuffer.h
- gnm_controls.h
- gnm_dataformat.h
- gnm_depthrendertarget.h
- gnm_drawcommandbuffer.h
- gnm_error.h
- gnm_helpers.h
- gnm_rendertarget.h
- gnm_sampler.h
- gnm_shader.h
- gnm_shaderbinary.h
- gnm_strings.h
- gnm_texture.h
- gnm_types.h
- gnmdriver.h
- gpuaddr.h
- platform.h
- - bcdec.h
- - analyzer.c
  - assembler.c
  - decoder.c
  - error.c
  - format.c
  - gcn.h
  - gcn_error.h
  - gcn_types.h
  - microcode.h
  - types.c
- - decompress.c
  - error.c
  - gpuaddr_private.h
  - surface.c
  - surfgen.c
  - tilemodes.c
  - tiler.c
- - decoder.c
  - error.c
  - format.c
  - pm4.h
  - pm4_error.h
  - pm4_types.h
  - types.c
- - fs.h
  - ktx.h
  - utility.h
  - vector.h
- commandbuffer.c
- dataformat.c
- depthrendertarget.c
- drawcommandbuffer.c
- driver_generic.c
- driver_orbis.c
- error.c
- helpers.c
- hwinit_sequences.h
- platform_generic.c
- platform_orbis.c
- rendertarget.c
- shader.c
- texture.c
- hardware_smoke.c
- link_smoke.c
- test.h
- test_api.c
- test_compat.c
- test_drawcmd.c
- test_helpers.c
- test_main.c
- test_pm4.c
- test_surface.c
- test_validate.c
.gitignore
build.sh
CMakeLists.txt
config.generic.mak
config.orbis.mak
LICENSE
Makefile
mkdocs.yml
opengnm.pc.in
OPENGNM_REWRITE_PLAN.md
PS4_PACKAGING.md
README.md
stage_hw_smoke_pkg.sh
VULKAN_PS4_PLAN.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

opengnm is a clean-rewrite PS4 GNM library providing `sceGnm*` / `sceGpa*` drop-in
API compatibility with the Sony official PS4 SDK.

Any PS4 app or game written against the official SDK headers should compile and link
against opengnm unmodified.

## Features

- **Full `sceGnm*` API surface** — 207 functions matching the Sony SDK ABI
- **OpenOrbis SDK compatible** — builds with the OpenOrbis PS4 toolchain
- **Two backends:**
  - `orbis` — delegates to the official `libSceGnmDriver` firmware (74 real
    externs + 14 `sceGnmDriver*` forwarding wrappers + 172 retail stubs +
    11 validate stubs)
  - `generic` — pure software PM4 emission for host testing (no PS4 needed,
    14 PM4 packet builders + real `sceGnm*` + 172 stubs + 11 validate stubs)
- **Binary-compatible struct layouts** — `_Static_assert` verified sizes
- **Surface computation** — `sceGpa*` (gpuaddr / AddrLib) for RT/texture sizing
- **GCN assembler** — fetch shader generation
- **PM4 encoding** — command buffer packet building
- **Firmware-captured hardware init** — `DrawInitDefaultHardwareState` uses
  real PS4 firmware sequences (from shadPS4 RE) with FW version-specific
  (base/1.75/2.00/3.50) and Neo/OG/Neo-compat variants
- **Opt-in freegnm source compatibility** — `<compat/freegnm.h>` and
  `<gnm/...>` forwarding headers map compatible `gnm*` / `gpa*` wrapper calls to
  `sceGnm*` without exporting a second ABI. PSSL and GNF tooling types are
  provided via `<compat/pssl.h>` and `<compat/gnf.h>` with `<gnm/pssl/types.h>`
  and `<gnm/gnf/gnf.h>` forwarding headers.

## Status

**Feature-complete.** All planned phases (0-5D), TODO cleanup, RPCSX
cross-audit, and downstream migration are done. The OpenOrbis Docker build,
PS4-target link smoke, PS4 hardware-smoke package build, FTP staging, and PS4
hardware run all pass. All 207+ `sceGnm*` functions are implemented across
both backends, and the generic host backend passes 88 tests via CMake/CTest
and Makefile. Zero TODO/FIXME comments remain in the source.

Hardware init uses firmware-captured register sequences from shadPS4 RE data,
with FW version-specific (base/1.75/2.00/3.50) and Neo/OG/Neo-compat variants.
The gpuaddr tiling implementation was cross-audited against RPCSX with no gaps
found.

All freegnm-examples (triangle, cube, shader-test, eden-composite-blit,
eden-composite-dma, eden-triangle-wrapper, gltf, indirect, instances) build
with `USE_OPENGNM=1` via the compat layer. The companion shader compiler
`opengnm-psbc` is complete and hardware-validated on PS4 FW 9.00.

See `OPENGNM_REWRITE_PLAN.md` for the full plan and progress.

## Building

### Host (generic, for testing)

```sh
cmake -B build -DCMAKE_BUILD_TYPE=Debug -DOPENGNM_PLATFORM=generic
cmake --build build
```

Or with Make:

```sh
cp config.generic.mak config.mak
make
```

### PS4 (OpenOrbis)

```sh
export OO_PS4_TOOLCHAIN=/path/to/openorbis
cp config.orbis.mak config.mak
make
make install DESTDIR=$OO_PS4_TOOLCHAIN
```

When linking a PS4 target, link `opengnm` together with the firmware libraries
it delegates to:

```sh
-lopengnm -lkernel -lSceGnmDriver -lSceVideoOut
```

The Orbis backend forwards submit and flip paths to firmware-provided
`sceGnmSubmit*` exports in `libSceGnmDriver`. The generic backend provides host
test no-op implementations, but an Orbis archive is expected to keep those
symbols resolved by the platform SDK libraries.

### Installed Consumers

OpenGNM installs a CMake package and pkg-config file:

```cmake
find_package(opengnm CONFIG REQUIRED)
target_link_libraries(my_renderer PRIVATE opengnm::opengnm)
```

```sh
cc $(pkg-config --cflags opengnm) -c renderer.c
cc renderer.o $(pkg-config --libs --static opengnm)
```

### Docker

```sh
./build.sh docker-build          # OpenOrbis build + link/hardware-smoke ELFs
./build.sh docker-link-smoke     # PS4-target link smoke only
./build.sh docker-hardware-smoke # PS4 hardware-smoke ELF only
./build.sh docker-hardware-pkg   # PS4 hardware-smoke package
./build.sh stage-hardware-pkg    # build/upload package to the configured PS4
./build.sh tests                 # build + run host tests
```

## freegnm Source Compatibility

Code that used the old wrapper API can either include `<compat/freegnm.h>` before
using `gnm*` names, or switch its include path to opengnm and keep core includes
such as `<gnm/drawcommandbuffer.h>`, `<gnm/platform.h>`, and
`<gnm/gpuaddr/gpuaddr.h>`. The compatibility layer is source-only: linked
objects still call the Sony SDK-style `sceGnm*` / `sceGpa*` symbols.

## Renderer Helper API

`<gnm_helpers.h>` provides small convenience APIs for renderer backends such as
bgfx:

- direct-memory allocation/mapping with a host fallback for tests
- VideoOut backbuffer layout helpers, plus Orbis registration/flip helpers when
  OpenOrbis VideoOut/libkernel headers are available
- 2D texture and color render-target descriptor setup with size/alignment output
- shader binary metadata extraction for vertex and pixel shader headers
- command-buffer range validation and diagnostic messages

## License

MIT, see [LICENSE](LICENSE).

## Sources

- Clean rewrite, based on the PS4 SDK ABI and AMD public documentation
- Sony ABI reference: `shadPS4/src/core/libraries/gnmdriver/`
- Firmware init sequences: `shadPS4/src/core/libraries/gnmdriver/gnmdriver_init.h`
  (captured from real PS4 firmware)
- Surface computation: AMD PAL / Mesa AddrLib
- gpuaddr cross-audit: RPCSX (independent AMD tiler implementation)

opengnm

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README