Skip to content

Made the verilog module consistent with the Circuit simulation logic #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

092vk
Copy link
Member

@092vk 092vk commented Jun 29, 2025

Fixes #561

Describe the changes you have made in this PR -

  1. Added the logic for pre parameter in the verilog module
  2. According to simulation logic pre is not a control signal but a register which sets the q or output

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • New Features

    • Enhanced support for vector-based asynchronous preset signals in D flip-flop simulations.
    • Improved output initialization logic for cases where preset signals are unknown.
  • Bug Fixes

    • Corrected handling of asynchronous preset to ensure accurate output states in all scenarios.

Copy link

netlify bot commented Jun 29, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit c71af00
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/6860afa84c80310008deb35e
😎 Deploy Preview https://deploy-preview-619--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 27 (🔴 down 20 from production)
Accessibility: 72 (no change from production)
Best Practices: 92 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 29, 2025

Walkthrough

The Verilog module generation for the DflipFlop component was updated to treat the asynchronous preset (pre) as a vector input, aligning it with the data input width. The reset logic in the generated Verilog now conditionally sets outputs based on the value of pre, ensuring correct handling of unknown states and consistency with the intended logic implementation.

Changes

Files Change Summary
src/simulator/src/sequential/DflipFlop.js Updated Verilog module generation: pre input is now a vector, reset logic improved for consistency.

Assessment against linked issues

Objective Addressed Explanation
Fix errors in Verilog modules of circuit elements, ensuring consistency with simulation logic (#561)
Implement preset (pre) handling in Verilog for flip-flop modules, matching actual logic (#561)
Update Verilog port declarations to match simulation parameters and logic (#561)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-29T03_15_49_479Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/simulator/src/sequential/DflipFlop.js (1)

143-149: Enhanced preset logic aligns well with simulation behavior.

The conditional preset logic correctly implements the behavior where:

  • Unknown preset values result in a safe default state (q=0, q_inv=1)
  • Valid preset values are applied directly to the outputs

This aligns with the JavaScript simulation logic that uses this.preset.value || 0 to handle undefined/null preset values.

Note that the ^pre === 1'bx construct is simulation-specific and may not synthesize. If synthesis compatibility is needed, consider using a different approach for detecting uninitialized signals.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d8ca00 and c71af00.

📒 Files selected for processing (1)
  • src/simulator/src/sequential/DflipFlop.js (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: 092vk
PR: CircuitVerse/cv-frontend-vue#591
File: v1/src/simulator/src/sequential/JKflipFlop.js:159-188
Timestamp: 2025-06-10T11:26:38.102Z
Learning: In the CircuitVerse project, Verilog modules for circuit elements like JKflipFlop are designed to be consistent with the circuit simulation design, which means reset and preset signals are implemented synchronously (triggered on clock edge) rather than asynchronously, even when the signals are named as asynchronous reset/preset.
src/simulator/src/sequential/DflipFlop.js (2)
Learnt from: 092vk
PR: CircuitVerse/cv-frontend-vue#591
File: v1/src/simulator/src/sequential/JKflipFlop.js:159-188
Timestamp: 2025-06-10T11:26:38.102Z
Learning: In the CircuitVerse project, Verilog modules for circuit elements like JKflipFlop are designed to be consistent with the circuit simulation design, which means reset and preset signals are implemented synchronously (triggered on clock edge) rather than asynchronously, even when the signals are named as asynchronous reset/preset.
Learnt from: 092vk
PR: CircuitVerse/cv-frontend-vue#593
File: v1/src/simulator/src/modules/ALU.js:191-192
Timestamp: 2025-06-10T11:55:53.137Z
Learning: The ALU Verilog module in v1/src/simulator/src/modules/ALU.js currently only supports 1-bit processing. Width parameter support will be added in the future for scalability, even though the JavaScript ALU implementation already supports variable bit widths.
🔇 Additional comments (2)
src/simulator/src/sequential/DflipFlop.js (2)

141-155: Implementation successfully achieves PR objectives.

The Verilog module now correctly treats pre as a vector register that sets the output q, consistent with the circuit simulation logic. Key improvements:

  1. Vector consistency: pre is now a vector input matching the JavaScript preset.bitWidth
  2. Logic alignment: Preset values are applied during reset, consistent with the JavaScript resolve() method (line 65)
  3. Safe defaults: Unknown preset values are handled gracefully

This aligns with the retrieved learning about CircuitVerse's synchronous reset/preset implementation approach.


138-139: Confirm Port Ordering Impact on DflipFlop Instantiations

The change making pre a vector input correctly aligns the Verilog with the JavaScript simulation logic. However, it does alter the port ordering:

• File: src/simulator/src/sequential/DflipFlop.js
Lines 138–139:

    input clk, a_rst, en;
    input [WIDTH-1:0] d, pre;

Please verify that every instantiation of this module now uses named port connections (rather than positional) to avoid mismatches.

Copy link
Member

@niladrix719 niladrix719 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@niladrix719 niladrix719 requested a review from JoshVarga July 4, 2025 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the errors in the Verilog module of the circuit elements
2 participants