hw_dcmi_wrapper

中文文档

Description

The HW_DCMI_WRAPPER project provides a set of third-party FFI (Foreign Function Interface) bindings for interacting with Huawei DCMI. This repository contains two main packages:

1. hw_dcmi_wrapper: Provides safe and user-friendly bindings for integrating DCMI functionality into your applications.
2. hw_dcmi_wrapper_sys: Offers low-level, unsafe bindings that provide direct access to the underlying DCMI system calls.

Platform Support

Important: This library only supports Linux platforms.

• ✅ Linux: Full support
• ❌ macOS: Not supported
• ❌ Windows: Not supported

The Huawei DCMI API is only available on Linux systems. Attempting to compile this crate on other platforms will result in a build error.

Getting Started

Prerequisites

• Ubuntu 22.04 or later
• Atlas 6.0.0 or newer with DCMI support installed
• Required dependencies:
  • DCMI shared library
  • Ascend driver

Default Configuration

By default, the library searches for DCMI components in the /usr/local/dcmi directory. You can override this path by setting the HW_DCMI_PATH environment variable.

If you want to regenerate bindings, you can set HW_DCMI_BINDING_BUILD to true and enable feature bindgen to regenerate bindings, the generated bindings will be saved in:

• Static link: hw_dcmi_wrapper_sys/src/bindings.rs
• Dynamic link: hw_dcmi_wrapper_sys/src/bindings_dyn.rs

Example Usage

• Before using any DCMI API, you need to initialize the library first. You can Initialize the library with Dcmi::init
• Most API interfaces are encapsulated to conform to ergonomics, such as Card: Query_cards returned a Vec<Card>.
• If you are confident that the parameters are correct, you can use Card::new_uncheckto create a Card instance.

Please refer to the document for details（ https://docs.rs/hw_dcmi_wrapper )

use hw_dcmi_wrapper::dcmi;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let dcmi = DCMI::init().unwrap();

    let dcmi_version = dcmi.get_dcmi_version().unwrap();
    println!("DCMI version: {}", dcmi_version);

    let cards = Card::query_cards(&dcmi).unwrap();
    println!("Card list: {:?}", cards);
}

Version Strategy

• This project follows the semantic version Standardization

• The version number format for this project is <major>< minor>.<patch>， The rule for increasing version numbers is as follows:

  • Major: Incompatible API changes
  • Minor: Added functionality for backward compatibility
  • Patch: Fix backward compatibility issues

• When the project is in version '0.0.z', any change in version number may result in incompatible API changes.

• When the project is in version '0.y.z', only increasing 'y' will result in incompatible API changes.

Project Status

Currently `Hw_dcmi_wrapper is under development, please refer to the API mapping table below for details.

Due to the instability of the DCMI API, this project will always be in version 0. y. z to adapt to possible changes in the DCMI API.

API Mapping

Device Management Interface

Compute power splitting interface

License

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.