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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
pub mod constant;
pub mod error;
use std::fmt::{Debug, Display, Formatter};
use std::sync::atomic::{AtomicU8, Ordering};
use bitflags::bitflags;
use crate::constant::MAX_ST_MIN;
use crate::error::Error;
bitflags! {
/// ISO-TP state.
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
pub struct IsoTpState: u8 {
const Idle = 0b0000_0000;
const WaitSingle = 0b0000_0001;
const WaitFirst = 0b0000_0010;
const WaitFlowCtrl = 0b0000_0100;
const WaitData = 0b0000_1000;
const ResponsePending = 0b0001_0000;
const Sending = 0b0010_0000;
const Error = 0b1000_0000;
}
}
impl Display for IsoTpState {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{:08b}", self.bits())
}
}
/// A wrapper around `AtomicU8` for `IsoTpState` with atomic operations.
#[derive(Debug)]
pub struct AtomicState(AtomicU8);
impl Default for AtomicState {
fn default() -> Self {
Self(AtomicU8::from(IsoTpState::Idle.bits()))
}
}
impl AtomicState {
/// Creates a new `AtomicState` with the initial state.
pub fn new(state: IsoTpState) -> Self {
Self(AtomicU8::new(state.bits()))
}
/// Loads the current state.
#[inline]
pub fn load(&self, order: Ordering) -> IsoTpState {
IsoTpState::from_bits_truncate(self.0.load(order))
}
/// Stores a new state.
#[inline]
pub fn store(&self, state: IsoTpState, order: Ordering) {
self.0.store(state.bits(), order);
}
/// Updates the state using the provided function.
pub fn fetch_update(&self,
set_order: Ordering,
fetch_order: Ordering,
mut f: impl FnMut(IsoTpState) -> Option<IsoTpState>,
) -> Result<IsoTpState, IsoTpState> {
let mut prev = self.load(fetch_order);
while let Some(next) = f(prev) {
match self.0.compare_exchange_weak(prev.bits(), next.bits(), set_order, fetch_order) {
Ok(_) => return Ok(next),
Err(next_prev) => prev = IsoTpState::from_bits_truncate(next_prev),
}
}
Err(prev)
}
/// Performs an atomic addition of flags to the current state.
#[inline]
pub fn fetch_add(&self,
flags: IsoTpState,
success: Ordering,
failure: Ordering,
) -> Result<IsoTpState, IsoTpState> {
self.fetch_update(success, failure, |state| Some(state | flags))
}
/// Performs an atomic removal of flags from the current state.
#[inline]
pub fn fetch_remove(&self,
flags: IsoTpState,
success: Ordering,
failure: Ordering,
) -> Result<IsoTpState, IsoTpState> {
self.fetch_update(success, failure, |state| Some(state & !flags))
}
}
#[derive(Debug, Clone)]
pub enum IsoTpEvent {
Wait,
DataReceived(Vec<u8>),
ErrorOccurred(Error),
}
pub trait IsoTpEventListener {
fn clear_buffer(&mut self);
fn on_iso_tp_event(&mut self, event: IsoTpEvent);
}
/// ISO-TP timeout type define.
/// The unit of value is µs.
#[derive(Debug, Copy, Clone)]
pub enum IsoTpTimeout {
TimeoutAr { timeout_us: u32 },
TimeoutAs { timeout_us: u32 },
TimeoutBr { timeout_us: u32 },
TimeoutBs { timeout_us: u32 },
TimeoutCr { timeout_us: u32 },
TimeoutCs { timeout_us: u32 },
}
/// ISO-TP frame type define.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum FrameType {
/// | - data length -| - N_PCI bytes - | - note - |
///
/// | - 8 ≤ - | - bit0(3~0) = length - | - std2004 - |
///
/// | - > 8 - | - bit0(3~0) = 0; bit1(7~0) = length - | - std2016 - |
Single = 0x00,
/// | - data length -| - N_PCI bytes - | - note - |
///
/// | - 4095 ≤ - | - bit0(3~0) + bit1(7~0) = length - | - std2004 - |
///
/// | - > 4095 - | - bit0(3~0) + bit1(7~0) = 0; byte2~5(7~0) = length - | - std2016 - |
First = 0x10,
Consecutive = 0x20,
FlowControl = 0x30,
}
impl std::ops::BitOr<u8> for FrameType {
type Output = u8;
#[inline]
fn bitor(self, rhs: u8) -> Self::Output {
let result: u8 = self.into();
result | rhs
}
}
impl Into<u8> for FrameType {
#[inline]
fn into(self) -> u8 {
self as u8
}
}
impl TryFrom<u8> for FrameType {
type Error = Error;
#[inline]
fn try_from(value: u8) -> Result<Self, Self::Error> {
match value & 0xF0 {
0x00 => Ok(Self::Single),
0x10 => Ok(Self::First),
0x20 => Ok(Self::Consecutive),
0x30 => Ok(Self::FlowControl),
v => Err(Error::InvalidParam(format!("`frame type`({})", v))),
}
}
}
/// Flow control type define.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum FlowControlState {
Continues = 0x00,
Wait = 0x01,
Overload = 0x02,
}
impl TryFrom<u8> for FlowControlState {
type Error = Error;
fn try_from(value: u8) -> Result<Self, Self::Error> {
match value {
0x00 => Ok(Self::Continues),
0x01 => Ok(Self::Wait),
0x02 => Ok(Self::Overload),
v => Err(Error::InvalidParam(format!("`state` ({})", v))),
}
}
}
impl Into<u8> for FlowControlState {
#[inline]
fn into(self) -> u8 {
self as u8
}
}
/// Flow control frame context.
#[derive(Debug, Copy, Clone)]
pub struct FlowControlContext {
state: FlowControlState,
block_size: u8,
/// Use milliseconds (ms) for values in the range 00 to 7F (0 ms to 127 ms).
/// If st_min is 0, set to default value. See [`constant::ST_MIN_ISO15765_2`]
/// and [`constant::ST_MIN_ISO15765_4`]
///
/// Use microseconds (μs) for values in the range F1 to F9 (100 μs to 900 μs).
///
/// Values in the ranges 80 to F0 and FA to FF are reserved.
st_min: u8,
}
impl FlowControlContext {
#[inline]
pub fn new(
state: FlowControlState,
block_size: u8,
st_min: u8,
) -> Self {
match st_min {
0x80..=0xF0 |
0xFA..=0xFF => {
log::warn!("ISO-TP - invalid st_min: {}, set to default 127ms", st_min);
Self { state, block_size, st_min: MAX_ST_MIN }
},
v => Self { state, block_size, st_min: v }
}
}
#[inline]
pub fn state(&self) -> FlowControlState {
self.state
}
#[inline]
pub fn block_size(&self) -> u8 {
self.block_size
}
#[inline]
pub fn st_min(&self) -> u8 {
self.st_min
}
#[inline]
pub fn st_min_us(&self) -> u32 {
match self.st_min {
..=0x7F => 1000 * (self.st_min as u32),
0x80..=0xF0 |
0xFA..=0xFF => {
// should not enter
let message = format!("ISO-TP: got an invalid st_min: {}", self.st_min);
log::error!("{}" ,message);
panic!("{}", message) // panic is dengrous
},
0xF1..=0xF9 => 100 * (self.st_min & 0x0F) as u32,
}
}
}
/// ISO-TP frame trait define.
pub trait IsoTpFrame: Sized + Send {
/// Decode frame from origin data like `02 10 01`.
///
/// # Parameters
///
/// * `data` - the source data.
///
/// # Return
///
/// A struct that implements [`IsoTpFrame`] if parameters are valid.
fn decode<T: AsRef<[u8]>>(data: T) -> Result<Self, Error>;
/// Encode frame to data.
///
/// # Parameters
///
/// * `padding` - the padding value when the length of return value is insufficient.
///
/// # Returns
///
/// The encoded data.
fn encode(self, padding: Option<u8>) -> Vec<u8>;
/// Encoding full multi-frame from original data.
///
/// # Parameters
///
/// * `data` - original data
///
/// * `flow_ctrl` - the flow control context(added one default)
///
/// # Returns
///
/// The frames contain either a `SingleFrame` or a multi-frame sequence starting
///
/// with a `FirstFrame` and followed by at least one `FlowControlFrame`.
fn from_data<T: AsRef<[u8]>>(
data: T,
flow_ctrl: Vec<FlowControlContext>,
) -> Result<Vec<Self>, Error>;
/// New single frame from data.
///
/// * `data` - the single frame data
///
/// # Returns
///
/// A new `SingleFrame` if parameters are valid.
fn single_frame<T: AsRef<[u8]>>(data: T) -> Result<Self, Error>;
/// New flow control frame from data.
///
/// # Parameters
///
/// * `state` - [`FlowControlState`]
/// * `block_size` - the block size
/// * `st_min` - separation time minimum
///
/// # Returns
///
/// A new `FlowControlFrame` if parameters are valid.
fn flow_ctrl_frame(
state: FlowControlState,
block_size: u8,
st_min: u8,
) -> Self;
#[inline]
fn default_flow_ctrl_frame() -> Self {
Self::flow_ctrl_frame(FlowControlState::Continues, 0x00, 10)
}
}