HM2_SOC_OL

NAME

hm2_soc_ol - Machinekit HAL driver for Altera CycloneV and Xilinx Zynq platforms running HostMot2 firmware.

SYNOPSIS

newinst hm2_soc_ol hm2-socfpga0 -- [config="str[,str…]"] __

hm2-socfpga0

Note: The 2 dashes between the instance name and the config string, became effective for builds after 3rd Feb 2017 ( commit a2984ebb091109fd4c33b6a5ebe3dac1442a1e8 ) due to changes as to how string arguments are dealt with.

HAL instance name, must match the device name in the Device Tree Overlay (see below). Do not change.

config [default: ""]

HostMot2 config strings, described in the hostmot2(9) manpage.

DESCRIPTION

hm2_soc_ol is a HAL driver that interfaces the FPGA of the CycloneV and Zynq platforms running HostMot2 firmware to the Machinekit HAL. Both platforms are supported transparently, the only difference being the firmware pathname.

The driver talks to the FPGA by memory-mapped access.

The driver programs the FPGA when it registers the board with the hostmot2 driver. The firmware to load is specified in the config modparam, as described in the hostmot2(9) manpage, in the config modparam section.

Specifying the firmware

No firmware load

If you are dependent upon programming the fpga before starting Machinekit (ie: from u-boot before booting linux for framebuffer or similar) It is possible to inform the hm2_soc_ol driver to not re-program the fpga by issuing (already_programmed=1):

newinst HOSTMOT2 [HOSTMOT2]DEVNAME already_programmed=1 -- config=HOSTMOT2

a working example of how to get this into a working .ini file is in the example config (5i25-soc-cramps_no-fw-load.ini) here: https://github.com/machinekit/machinekit/blob/master/configs/hm2-soc-stepper/5i25-soc-cramps_no-fw-load.ini

With firmware load

The "firmware=" config argument must point to a file with extension ".dtbo" (a device tree overlay). The locations of these overlays are:

CycloneV: /lib/firmware/socfpga/dtbo
Zynq: /lib/firmware/zynq/dtbo

The argument to "firmware=" must be relative to /lib/firmware - example:

# CycloneV:
newinst hm2_soc_ol hm2-socfpga0 config="firmware=socfpga/dtbo/DE0_Nano_SoC_DB25.7I76_7I85S_GPIO_GPIO.dtbo"

# Zynq:
newinst hm2_soc_ol hm2-socfpga0 config="firmware=zynq/dtbo/zturn_ztio_7z020_ol.dtbo"

Currently firmware is provided by the socfpga-rbf (CycloneV) and socfpga-bit (Zynq) packages in the deb.machinekit.io repository.

Firmware creation

Firmware is automatically built from the https://github.com/machinekit/mksocfpga repository.

LICENSE

GPL