himpp-rs

Hi3XXX MPP API for Rust bindings.

Requirements

1. The target board toolchain must be installed and export to PATH:
   • hi3516ev200 - arm-himix100-linux.
   • hi3516ev300 - same as hi3516ev200.
   • hi3518ev200 - same as hi3516ev200.
   • hi3518ev300 - same as hi3516ev200.
   • hi3519av100 - arm-himix200-linux.
   • hi3531v100 - arm-hisiv100nptl-linux.
   • hi3559av100 - aarch64-himix100-linux.
2. The rust target must be installed for target board:
   • hi3516ev200 - armv7-unknown-linux-musleabihf.
   • hi3516ev300 - same as hi3516ev200.
   • hi3518ev200 - same as hi3516ev200.
   • hi3518ev300 - same as hi3516ev200.
   • hi3519av100 - aarch64-unknown-linux-gnu.
   • hi3531v100 - arm-hisiv100-linux-uclibcgnueabi.
   • hi3559av100 - aarch64-unknown-linux-gnu.
3. Export MPP_DIR to directory that contains the mpp-lib.
4. Export SYS_INCLUDE to the directory that contains the system headers.

The toolchain and the mpp-lib you can get from the BSP sdk. The arm-hisiv100-linux-uclibcgnueabi if build with xargo.

Envionment Defaults

Hi3516EV200

The Hi3616EV300、Hi3616EV200、Hi3618EV300 use the same SDK.

export PATH=/opt/hisi-linux/x86-arm/arm-himix100-linux/bin:$PATH
export MPP_DIR=$(pwd)/vendor/mpp-lib-Hi3516EV200_V1.0.1.0
export SYS_INCLUDE=/opt/hisi-linux/x86-arm/arm-himix100-linux/target/usr/include

Hi3519AV100

export PATH=/opt/hisi-linux/x86-arm/arm-himix200-linux/bin:$PATH
export MPP_DIR=$(pwd)/vendor/mpp-lib-Hi3519AV100_V2.0.2.0
export SYS_INCLUDE=/opt/hisi-linux/x86-arm/arm-himix200-linux/target/usr/include

Hi3531V100

export PATH=/opt/hisi-linux-nptl/arm-hisiv100-linux/target/bin:$PATH
export MPP_DIR=$(pwd)/vendor/mpp-lib-Hi3531V100_V1.0.D.0
export SYS_INCLUDE=/opt/hisi-linux-nptl/arm-hisiv100-linux/target/usr/include

Hi3559AV100

export PATH=/opt/hisi-linux/x86-arm/aarch64-himix100-linux/bin:$PATH
export MPP_DIR=$(pwd)/vendor/mpp-lib-Hi3559AV100_V2.0.2.0
export SYS_INCLUDE=/opt/hisi-linux/x86-arm/aarch64-himix100-linux/aarch64-linux-gnu/sys-include
export TARGET_CC=aarch64-himix100-linux-gcc
export BINDGEN_EXTRA_CLANG_ARGS="--sysroot=/opt/hisi-linux/x86-arm/aarch64-himix100-linux/target"

Building

To build the package, you must set cross compile environments first.

There is some preset in .cargo/ can help you fasten setup the cross compile.

Example:

# Setup for Hi3559AV100 boards
cp .cargo/hi3559av100.toml .cargo/config
# or for link static libraries
cp .cargo/hi3559av100-static.toml .cargo/config
# Build the package ...
cargo b

Make sure the hi3559av100 feature is enabled in the Cargo.toml, The hi3559av100 specified the target board, you can change to others, like: hi3531v100 More features see the Cargo.toml.

To build with arm-hisiv100-linux-uclibcgnueabi:

# the nightly toolchain and rust-src must be installed.
rustup override set nightly
rustup component add rust-src
# the xargo command must be installed.
cargo install xargo
# if the above already, that should be work now.
RUST_TARGET_PATH=$(pwd) xargo [build|clean|run|test] ...

if RUST_TARGET_PATH not set, the xargo will raise "Error loading target specification..."

Examples

ffi-example

use himpp::ffi::*;

fn main() {
    unsafe {
        println!("HI_MPI_SYS_Init() = {}", HI_MPI_SYS_Init());
        println!("HI_MPI_SYS_Exit() = {}", HI_MPI_SYS_Exit());
    }
}

mpi-example

use himpp::mpi;

fn main() {
    mpi::sys::init()
        .or_else(|err| {
            println!("Initialize failed: {}, exit and try again!", err);
            mpi::sys::exit().and_then(|_| mpi::sys::init())
        })
        .unwrap();
    // Add your code here
    mpi::sys::exit().unwrap();
}

More exmaples

FAQ

How to enable Doc-Tests on Target != Host

To enable doc-tests on target != host, you have to use nighlty toolchain and turn on the -Z doctest-xcompile flags.

For Example:

RUSTDOCFLAGS="-C linker=aarch64-himix100-linux-gcc" cargo +nightly t -Z doctest-xcompile

How to change my target board connections

Just export the TARGET_SSH_USER and TARGET_SSH_HOST environments, like:

export TARGET_SSH_USER=hello
export TARGET_SSH_HOST=192.168.3.4