Enum Message 

pub enum Message<B = Box<[u8]>> {
    GetInfo,
    SetTck {
        period_ns: u32,
    },
    Shift {
        num_bits: u32,
        tms: B,
        tdi: B,
    },
}

A Message is transferred from the client to the server. For each message, the client is expected to send the message and wait for a response from the server. The server needs to process each message in the order received and promptly provide a response. For the XVC 1.0 protocol, only one connection is assumed.

Variants

GetInfo

Requests info from the server. This is used to determine protocol capabilities of the server.

SetTck

Configures the TCK period. When sending JTAG vectors the TCK rate may need to be varied to accommodate cable and board signal integrity conditions. This command is used by clients to adjust the TCK rate in order to slow down or speed up the shifting of JTAG vectors.

Fields

period_ns: u32

Shift

Used to shift JTAG vectors in-and out of a device.

Fields

num_bits: u32

represents the number of TCK clk toggles needed to shift the vectors out

tms: B

a byte sized vector with all the TMS data. The vector is num_bits and rounds up to the nearest byte.

tdi: B

a byte sized vector with all the TDI data. The vector is num_bits and rounds up to the nearest byte.

Implementations

impl Message<Box<[u8]>>

pub fn from_reader( reader: &mut impl Read, max_shift_bytes: usize, ) -> Result<OwnedMessage, ReadError>

Read a Message from reader using an internal Decoder.

This is a convenience wrapper that constructs a Decoder configured with max_shift_bytes and delegates to its read_message method.

Example:

use std::io::Cursor;
let mut c = Cursor::new(b"getinfo:");
let msg = xvc_protocol::OwnedMessage::from_reader(&mut c, 1024).unwrap();
assert!(matches!(msg, xvc_protocol::Message::GetInfo));

pub fn borrow<'a>(&'a self) -> BorrowedMessage<'a>

Borrows this message into a BorrowedMessage

impl<B: AsRef<[u8]>> Message<B>

pub fn write_to(&self, writer: &mut impl Write) -> Result<()>

Serialize this Message to writer in the protocol command format.

• GetInfo is written as getinfo:
• SetTck is written as settck: followed by a 4-byte little-endian period
• Shift is written as shift: followed by a 4-byte little-endian num_bits, then the tms and tdi payload bytes

The function writes raw bytes and returns any I/O error encountered.

Trait Implementations

impl<B: Clone> Clone for Message<B>

fn clone(&self) -> Message<B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Debug> Debug for Message<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: PartialEq> PartialEq for Message<B>

fn eq(&self, other: &Message<B>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: Eq> Eq for Message<B>

impl<B> StructuralPartialEq for Message<B>