Enhancing PySlint with TOML Configurability: Insights from OSDA 2024

OSDA is the premier European forum for open-source design automation. In 2024, this was co-hosted along with Design Automation & Test in Europe (DATE-24), the equivalent of USA's DAC. 


Being held in the beautiful city of Valencia, Spain, AsFigo presented an insightful poster on "Adding Configurability to PySlint using TOML".

This poster delved into the technical details and practical implications of integrating TOML (Tom's Obvious Minimal Language) into PySlint, a burgeoning SystemVerilog linter based on the open-source PySlang parser.

The Need for Configurability in Linters

Linting tools play a crucial role in maintaining code quality by enforcing coding standards and detecting potential issues early in the development process. SystemVerilog, a widely used language in ASIC and FPGA designs, often presents multiple ways to achieve the same functionality, making the role of linters even more significant. Customizability in these tools allows development teams to tailor linting rules to their specific coding styles and project requirements, enhancing both code consistency and functionality.

PySlint: Leveraging Open-Source for SystemVerilog Linting

PySlint is designed to leverage the capabilities of the open-source PySlang parser, providing a flexible and powerful linter for SystemVerilog. By allowing users to define custom linting rules via a Python API, PySlint facilitates a high degree of customization. However, as the tool gained traction, the need for an intuitive and structured configuration method became apparent.




Integrating TOML for Enhanced Configurability

TOML, known for its simplicity and readability, emerged as an ideal choice for configuring PySlint. The integration of TOML into PySlint enables users to easily define and manage linting rules and settings in a straightforward, human-readable format. This approach not only simplifies the configuration process but also enhances the overall usability of PySlint.


The poster presented at OSDA 2024 outlined the following key points:

  • Configurability Features: Detailed how TOML can be used to enable/disable various linting rules and configurations, making it easier for users to adapt PySlint to their specific needs.
  • Implementation Details: Discussed the technical aspects of integrating TOML with PySlint, including challenges faced and solutions implemented.
  • User Case Studies: Highlighted early use cases from industry projects such as the tinyODIN spiking neural network processor and OpenTitan IPs. These case studies demonstrated the practical benefits of TOML-based configurations in real-world scenarios, showcasing improvements in code consistency and reduced risk of functional errors and race conditions.

Conclusion and Future Prospects

The addition of TOML configurability to PySlint marks a significant step forward in the tool's development, making it more accessible and useful for a broader range of users. AsFigo's presentation at OSDA 2024 not only underscored the importance of customizable linting tools but also set the stage for further innovations in open-source design automation.

For more technical details and to explore PySlint, you can visit the PySlint GitHub repository and the OSDA official website.






Comments

Post a Comment

Popular posts from this blog

Don't go "wild" with Associative arrays in SystemVerilog - PySlint it!

Image
 Hash tables, modeled via Associative arrays is a powerful data structure in SystemVerilog. Python calls it as "dictionary". One of the "wild" features of SystemVerilog is that it allows associative arrays to be declared with arbitrary key type. An example:           class wild_c;             string wild_hash_table [*];           endclass : wild_c While the above is a legal SystemVerilog code, may even be seen as "easier" to write, it is bad from a reuse perspective. Some of the side effects (mostly bad) are: Unclear data structure to begin with - for writer and then the reader/maintainer of the code.  As the key can be anything, SV does not allow wildcard indexed associative array to be iterated via foreach loop. It cannot be passed as function parameter. Many find*  methods do not work on wild-card indexed associative arrays. For instance, find_first would need to return a queue of the keys, and when used on wild-card indexed array, it would be a queue o
Read more

Porting a complete UVC to Verilator + UVM - an anecdote!

Image
 So, here we are on Day-1 of UVM + Verilator becoming available to the public, start of democratizing chip design verification. In case you just woke-up/started on this topic, read the release of UVM + Verilator with some intricate details on the challenge on the way by Antmicro via:  https://antmicro.com/blog/2023/10/running-simple-uvm-testbenches-in-verilator/  Awesome work by the folks at Antmicro and fantastic support by the ecosystem specifically Western Digital, kudos!  At AsFigo , we are committed to fueling open-source driven chip design and verification. So we took this opportunity to port a commercial-grade UVC (Universal Verification Component or a Verification IP) and ported it to compile and run on Verilator. Below are our reflections from this experiment. Get in touch with us to discuss how AsFigo can help your VIPs and testbenches to be ported to opensource EDA.  Case study: VLBus - a simple peripheral bus intended for write/read to configuration registers (like the pop
Read more

Opensource testbench generator for VHDL designs, OSVVM included!

Image
VHDL holds a prominent position in the world of FPGA design, particularly within the military, aerospace, and defense sectors. It serves both as a Register Transfer Level (RTL) design language and as a tool for creating testbenches. The availability of open-source simulators, such as GHDL and NVC, alongside numerous free FPGA simulators and synthesis tools, has provided FPGA designers with a significant advantage over their SystemVerilog counterparts. While the Universal Verification Methodology (UVM) is widely adopted among SystemVerilog users, VHDL practitioners have traditionally relied on various homegrown methodologies and frameworks. Recently, however, off-the-shelf methodologies and frameworks such as OSVVM, UVVM, and VUnit have become available to VHDL users. Each of these options presents different levels of complexity, allowing users to choose the one that best meets their needs. Despite these advancements, the development of open-source utility tools supporting the latest me
Read more