English | 中文

Introduction

fxmac_rs provides FXMAC Ethernet driver in Rust for PhytiumPi (Phytium Pi) board, supporting DMA-based packet transmission and reception. It is maintained as part of the TGOSKits component set and is intended for Rust projects that integrate with ArceOS, AxVisor, or related low-level systems software.

Quick Start

Installation

Add this crate to your Cargo.toml:

[dependencies]
fxmac_rs = "0.4.1"

Run Check and Test

# Enter the crate directory
cd components/fxmac_rs

# Format code
cargo fmt --all

# Run clippy
cargo clippy --all-targets --all-features

# Run tests
cargo test --all-features

# Build documentation
cargo doc --no-deps

Integration

Example

use fxmac_rs as _;

fn main() {
    // Integrate `fxmac_rs` into your project here.
}

Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/fxmac_rs

Contributing

Fork the repository and create a branch
Run local format and checks
Run local tests relevant to this crate
Submit a PR and ensure CI passes

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

fxmac_rs 0.4.8