libmctp 0.2.0

libMCTP is a MCTP (Management Component Transport Protocol) implementation for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! libMCTP is a MCTP (Management Component Transport Protocol) implementation
//! for Rust.
//!
//! libMCTP aims to implement the MCTP protocol as described in the [DMTF DSP2016
//! specification](https://www.dmtf.org/sites/default/files/standards/documents/DSP2016.pdf).
//!
//!
//! MCTP allows multiple transport layers, the protocols supported by this library
//! include:
//!  * SMBus/I2C version 1.2.0. See [DMTF DSP0237](https://www.dmtf.org/sites/default/files/standards/documents/DSP0237_1.2.0.pdf)
//!
//! libMCTP does not send or receive any data. Instead it generates `[u8]`
//! arrays that contain all of the bytes that should be sent. It also
//! decodes `[u8]` arrays. This allows you to use your own SMBus/I2C
//! implementation.
//!
//! Developers wanting to use this as a library should focus on the relevant
//! transport layer context. For example, for SMBus support use the
//! `MCTPSMBusContext` struct in the `smbus` module.

#![no_std]
#![deny(missing_docs)]
#![allow(clippy::result_unit_err)]

#[macro_use]
extern crate bitfield;

pub mod base_packet;
pub mod control_packet;
pub mod errors;
pub mod mctp_traits;
pub mod smbus;
pub mod smbus_proto;
pub mod smbus_request;
pub mod smbus_response;
pub mod vendor_packets;

// Use this to generate nicer docs
#[doc(inline)]
pub use crate::base_packet::MessageType;
#[doc(inline)]
pub use crate::errors::ControlMessageError;
#[doc(inline)]
pub use crate::errors::DecodeError;
#[doc(inline)]
pub use crate::smbus::MCTPSMBusContext;

// This is used to run the tests on a host
#[cfg(test)]
#[macro_use]
extern crate std;