Struct usbd_blaster::Blaster

pub struct Blaster<'a, B: UsbBus, E, TDI: OutputPin<Error = E>, TCK: OutputPin<Error = E>, TMS: OutputPin<Error = E>, TDO: InputPin<Error = E>> { /* fields omitted */ }

Blaster device class

Methods

impl<'a, B: UsbBus, E, TDI: OutputPin<Error = E>, TCK: OutputPin<Error = E>, TMS: OutputPin<Error = E>, TDO: InputPin<Error = E>> Blaster<'a, B, E, TDI, TCK, TMS, TDO>

pub fn new(
    alloc: &'a UsbBusAllocator<B>,
    tdi: TDI,
    tck: TCK,
    tms: TMS,
    tdo: TDO
) -> Blaster<'a, B, E, TDI, TCK, TMS, TDO>

Allocate a Blaster on the USB bus. Takes control of the four JTAG pins. The JTAG pins can be any pins you want, just make sure you assign them correctly.

pub fn read(&mut self) -> Result<usize>

Read data from the host output endpoint into the Blaster's internal read buffer.

pub fn write(&mut self, heartbeat: bool) -> Result<usize>

Write data to the host input endpoint from the Blaster's internal write buffer. The heartbeat parameter must be true at least once every 10 milliseconds, so that the blaster can output the modem status. See libftdi ftdi.c for more on this. Otherwise, a BSOD could occur on Windows A safe default for the heartbeat seems to be true all the time. This will output the modem status whenever the host reads the device.

pub fn handle(&mut self) -> Result<(), E>

Runs all pending operations from the internal read buffer until either no operations are left or the internal write buffer is full. If a GPIO error occurs, the JTAG state machine will enter an undefined state requiring a forced USB bus reset.

Trait Implementations

impl<'_, B, E, TDI: OutputPin<Error = E>, TCK: OutputPin<Error = E>, TMS: OutputPin<Error = E>, TDO: InputPin<Error = E>> UsbClass<B> for Blaster<'_, B, E, TDI, TCK, TMS, TDO> where
    B: UsbBus,
    E: Debug, 

fn get_configuration_descriptors(
    &self,
    writer: &mut DescriptorWriter
) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a configuration descriptor. When called, the implementation should write its interface, endpoint and any extra class descriptors into writer. The configuration descriptor itself will be written by UsbDevice and shouldn't be written by classes.

fn reset(&mut self)

Called after a USB reset after the bus reset sequence is complete.

fn control_in(&mut self, xfer: ControlIn<B>)

Called when a control request is received with direction DeviceToHost.

fn control_out(&mut self, xfer: ControlOut<B>)

Called when a control request is received with direction HostToDevice.

fn get_bos_descriptors(&self, writer: &mut BosWriter) -> Result<(), UsbError>

Called when a GET_DESCRIPTOR request is received for a BOS descriptor. When called, the implementation should write its blobs such as capability descriptors into writer. The BOS descriptor itself will be written by UsbDevice and shouldn't be written by classes.

fn get_string(&self, index: StringIndex, lang_id: u16) -> Option<&str>

Gets a class-specific string descriptor.

fn poll(&mut self)

Called whenever the UsbDevice is polled.

fn endpoint_setup(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received a SETUP packet. Implementing this shouldn't be necessary in most cases, but is provided for completeness' sake.

fn endpoint_out(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received data (OUT packet).

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has completed transmitting data (IN packet).