pflib v2.7.0-1-gd371ab6a
Polarfire Interaction Library
pflib::WishboneInterface Class Referenceabstract

Abstract interface for wishbone transactions, used by ~all classes in pflib. More...

#include <WishboneInterface.h>

Inheritance diagram for pflib::WishboneInterface:
[legend]

Public Member Functions

virtual void wb_write (int target, uint32_t addr, uint32_t data)=0
 write a 32-bit word to the given target and address More...
 
virtual uint32_t wb_read (int target, uint32_t addr)=0
 read a 32-bit word from the given target and address More...
 
virtual void wb_reset ()=0
 reset the wishbone bus (on/off cycle) More...
 
virtual void wb_errors (uint32_t &crcup_errors, uint32_t &crcdn_errors, uint32_t &wb_errors)=0
 Read the monitoring counters crcup_errors – CRC errors observed on the uplink (wraps) crcdn_errors – CRC errors from the downlink reported on the uplink (wraps) wb_errors – Wishbone errors indicated by the Polarfire. More...
 
virtual void wb_clear_counters ()=0
 Clear the monitoring counters. More...
 

Detailed Description

Abstract interface for wishbone transactions, used by ~all classes in pflib.

This defines the necessary functions that communications methods need to implement.

Member Function Documentation

◆ wb_clear_counters()

virtual void pflib::WishboneInterface::wb_clear_counters ( )
pure virtual

Clear the monitoring counters.

Implemented in pflib::rogue::RogueWishboneInterface, and pflib::uhal::uhalWishboneInterface.

◆ wb_errors()

virtual void pflib::WishboneInterface::wb_errors ( uint32_t &  crcup_errors,
uint32_t &  crcdn_errors,
uint32_t &  wb_errors 
)
pure virtual

Read the monitoring counters crcup_errors – CRC errors observed on the uplink (wraps) crcdn_errors – CRC errors from the downlink reported on the uplink (wraps) wb_errors – Wishbone errors indicated by the Polarfire.

Implemented in pflib::rogue::RogueWishboneInterface, and pflib::uhal::uhalWishboneInterface.

◆ wb_read()

virtual uint32_t pflib::WishboneInterface::wb_read ( int  target,
uint32_t  addr 
)
pure virtual

read a 32-bit word from the given target and address

Exceptions
pflib::Exceptionin the case of a timeout or wishbone error

Implemented in pflib::rogue::RogueWishboneInterface, and pflib::uhal::uhalWishboneInterface.

◆ wb_reset()

virtual void pflib::WishboneInterface::wb_reset ( )
pure virtual

reset the wishbone bus (on/off cycle)

Implemented in pflib::rogue::RogueWishboneInterface, and pflib::uhal::uhalWishboneInterface.

◆ wb_write()

virtual void pflib::WishboneInterface::wb_write ( int  target,
uint32_t  addr,
uint32_t  data 
)
pure virtual

write a 32-bit word to the given target and address

Exceptions
pflib::Exceptionin the case of a timeout or wishbone error

Implemented in pflib::rogue::RogueWishboneInterface, and pflib::uhal::uhalWishboneInterface.


The documentation for this class was generated from the following file: