Skip to content

About

mailbox driver for IMX + FPGA based systems

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

i.MX9 QSPI FPGA Mailbox

BMC-side software for the i.MX9 OpenBMC platforms where a Lattice MachXO5-T FPGA is the sole gateway between the BMC and all platform sensors, GPIOs, power rails, and the managed host. Everything - sensor reads, actuator writes, firmware update, host IPMI/PLDM traffic, fault events - is multiplexed over a single QSPI "mailbox" link.

This repo contains the kernel driver, a hardware-free simulator, the Entity Manager configs, and the tests.

Layout

Path Contents
kernel_driver/imx9-qspi-mailbox/ Out-of-tree kernel module imx9-qspi-mailbox.ko. Bridges the FPGA mailbox to standard Linux subsystems (hwmon, virtual I2C/I3C, GPIO, PWM, IIO, eSPI, PLDM) so stock dbus-sensors / entity-manager bind unmodified.
app/ mock_server - a userspace daemon that plays the managed server behind the FPGA, so the whole stack runs with no FPGA and no DC-SCM hardware. See app/MOCK_SERVER_USER_GUIDE.md.
json/ Entity Manager chassis configs (imx91/imx93/imx943/imx95).
test/ Offline protocol unit tests and an on-target integration script.
doc/ PLDM/MCTP demo notes.
HIGH_LEVEL_DESIGN.md Architecture, protocol, and design rationale. Start here.

Build

# everything (app + kernel module); KERNEL_DIR is needed for the module
make KERNEL_DIR=/path/to/kernel-build

# just the userspace simulator
make -C app                         # standalone, no D-Bus
make -C app SYSROOT=<yocto-sysroot> # with the D-Bus publication surface

# offline protocol unit tests (host, no hardware)
make -C test check

In a Yocto/OpenBMC image the driver and simulator are packaged by the qspi-mailbox and mock-server recipes in meta-nxp; this top-level build is for standalone/bench use.

Quick start (no hardware)

The driver defaults to the userspace mock relay, so no build-time option and no FPGA are needed - hw=0 is the default (pass hw=1 for real hardware):

modprobe imx9-qspi-mailbox          # hw=0: userspace mock relay
mock_server -s                      # answer the mailbox, trace sensor access
sensors                             # FPGA-backed sensors appear via hwmon

Full simulator usage - value pinning, alert/alarm injection, GPIO line events, and D-Bus/Redfish verification - is in app/MOCK_SERVER_USER_GUIDE.md.

Documentation

  • HIGH_LEVEL_DESIGN.md - architecture, QSPI protocol, transport backends, concurrency, event path, and the gap register.
  • app/MOCK_SERVER_USER_GUIDE.md - operator guide for the mock_server simulator.
  • doc/pldm-mctp-demo.md - PLDM-over-MCTP terminus demo.

License

Apache-2.0 for the userspace apps and tests; GPL-2.0-only for the kernel module; shared UAPI/protocol headers are dual-licensed. See LICENSE.txt, the LICENSES/ directory, and SW-Content-Register.txt for the per-component breakdown.

About

mailbox driver for IMX + FPGA based systems

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages