#linux #gpio #gpiochip #library #testing

gpiosim

A library to drive gpio-sims for GPIO software testing

10 releases

new 0.3.2 Feb 20, 2024
0.3.1 Jul 4, 2023
0.3.0 May 25, 2023
0.2.3 Dec 18, 2022
0.1.2 Oct 23, 2022

#414 in Unix APIs

Download history 27/week @ 2023-11-06 13/week @ 2023-11-13 28/week @ 2023-11-20 51/week @ 2023-11-27 18/week @ 2023-12-04 21/week @ 2023-12-11 17/week @ 2023-12-18 37/week @ 2023-12-25 6/week @ 2024-01-01 14/week @ 2024-01-08 16/week @ 2024-01-15 9/week @ 2024-01-22 34/week @ 2024-01-29 20/week @ 2024-02-05 73/week @ 2024-02-12 355/week @ 2024-02-19

482 downloads per month
Used in 3 crates

Apache-2.0 OR MIT

32KB
544 lines

gpiosim

Build Status github crate LICENSE

A Rust library for creating and controlling GPIO simulators for testing users of the Linux GPIO uAPI (both v1 and v2).

The simulators are provided by the Linux gpio-sim kernel module and require a recent kernel (5.19 or later) built with CONFIG_GPIO_SIM.

Simulators contain one or more Chips, each with a collection of lines being simulated. A Builder is responsible for constructing the Sim and taking it live. Configuring a simulator involves adding Banks, representing the chip, to the builder.

Once live, the Chip exposes lines which may be manipulated to drive the GPIO uAPI from the kernel side. For input lines, applying a pull using Chip pull methods controls the level of the simulated line. For output lines, the Chip.get_level method returns the level the simulated line is being driven to by userspace.

For tests that only require lines on a single chip, the Simpleton provides a slightly simpler interface.

Dropping the Sim deconstructs the simulator, removing the gpio-sim configuration and the corresponding gpiochips.

Configuring a simulator involves configfs, and manipulating the chips once live involves sysfs, so root permissions are typically required to run a simulator.

Example Usage

Creating a simulator with two chips, with 8 and 42 lines respectively, each with several named lines and a hogged line:

use gpiosim::{Bank, Direction, Level};

let sim = gpiosim::builder()
    .with_name("some unique name")
    .with_bank(
        Bank::new(8, "left")
            .name(3, "LED0")
            .name(5, "BUTTON1")
            .hog(2, "hogster", Direction::OutputLow)
        )
    .with_bank(
        Bank::new(42, "right")
            .name(3, "BUTTON2")
            .name(4, "LED2")
            .hog(7, "hogster", Direction::OutputHigh),
    )
    .live()?;

let chips = sim.chips();
let c = &chips[0];
c.set_pull(5, Level::High);
let level = c.get_level(3)?;

Use a Simpleton to create a single chip simulator with 12 lines, for where multiple chips or named lines are not required:

let s = gpiosim::Simpleton::new(12);
s.set_pull(5, Level::High);
let level = s.get_level(3)?;

License

Licensed under either of

at your option.

Contribution

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

Dependencies

~3–14MB
~168K SLoC