sravan/system76-embedded-controller
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ectool version 0.2.1:

Browse Source 
- Add hidapi feature
- Add redox_hwio feature
- Add feature documentation
This commit is contained in:
Jeremy Soller
2020-10-02 08:56:30 -06:00
committed by Jeremy Soller
parent 8da8342e40
commit 726a0e0837
7 changed files with 151 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
tool/src/lib.rs
View File

@ -1,5 +1,19 @@
#![cfg_attr(not(feature = "std"), no_std)]
//! Library for accessing System76 ECs
//! First, construct an access method, using an object implementing the `Access` trait. Next, an Ec
//! object can be contructed, which exposes the command interface.
//!
//! There are some differences between targets and features that are listed below:
//! - `AccessHid` requires the `hidapi` feature. Only functional on USB ECs.
//! - `AccessLpcDirect` requires the `redox_hwio` feature and a nightly compiler. This method is
//! only recommended for use in firmware with LPC ECs, as mutual exclusion is not guaranteed.
//! - `AccessLpcLinux` requires the `std` feature and `linux` target_os. Recommended for LPC ECs,
//! as this method can utilize mutual exclusion.
//! - `EcLegacy`, `Pmc`, and `SuperIo` all require the `redox_hwio` feature and a nightly
//! compiler. It is only recommended to use these in firmware, as mutual exclusion is not
//! guaranteed.
pub use self::access::*;
mod access;
@ -12,16 +26,22 @@ mod error;
pub use self::firmware::Firmware;
mod firmware;
#[cfg(feature = "redox_hwio")]
pub use self::legacy::EcLegacy;
#[cfg(feature = "redox_hwio")]
mod legacy;
#[cfg(feature = "redox_hwio")]
pub use self::pmc::Pmc;
#[cfg(feature = "redox_hwio")]
mod pmc;
pub use self::spi::{Spi, SpiRom, SpiTarget};
mod spi;
#[cfg(feature = "redox_hwio")]
pub use self::super_io::SuperIo;
#[cfg(feature = "redox_hwio")]
mod super_io;
pub use self::timeout::Timeout;