Interface for determining package pins by robtaylor · Pull Request #38 · ChipFlow/chipflow-lib

robtaylor · 2025-02-12T23:19:40Z

Package Pin Interface

This PR implements a structured interface for determining package pins in ChipFlow.

Key Changes

Added abstract methods to define standard pin types in package definitions:
- Power and ground pins
- Clock pins
- Reset pins
- JTAG pins
- Heartbeat pins
Implemented these methods in both package types:
- BareDiePackageDef
- QuadPackageDef
Enhanced the Package class to:
- Support new pin types
- Initialize pins from package definitions
- Support both legacy and new pin formats
Added comprehensive tests in test_package_pins.py
Created documentation in docs/package_pins.md

Backward Compatibility

The implementation maintains backward compatibility with the existing TOML configuration format while introducing a new, more flexible format.

Ready for Review

All tests are passing, and the implementation is ready for review.

github-actions · 2025-02-12T23:21:19Z

PR Preview Action v1.6.2
🚀 View preview at https://chipflow-lib.docs.chipflow-infra.com/pr-preview/pr-38/
Built to branch `gh-pages` at 2025-07-07 11:00 UTC. Preview will be ready when the GitHub Pages deployment is complete.

lanserge · 2025-02-14T10:40:03Z

+
+ @property
+ @abc.abstractmethod
+ def heartbeat(self) -> Dict(int, Pin):


The clock in some cases comes as two pins close to each other to be connected to XTAL.

hmm, good point. Is that a config option to generate a oscillator?

interesting read: https://www.sitime.com/company/newsroom/articles/do-you-know-when-use-crystal-or-oscillator-wrong-answer-can-cost-you

Currently we have nothing to specify use of XTAL, this needs to be added somehow.

The clock in some cases comes as two pins close to each other to be connected to XTAL.
If you have external crystal you will need a crystal oscillator analog block on the chip. The actual clock will then be an output of this oscillator.

What also can happen is that clock is delivered as differential signal; but this can also be for digital signals. Likely only to add when use case is there.

robtaylor · 2025-03-18T13:28:59Z

I've updated this PR to implement a complete interface for package pins as discussed.

Key enhancements:

Implemented all abstract methods in both package types with sensible defaults
Added support for new power pin format while maintaining backward compatibility
Created comprehensive tests with 76% code coverage
Added documentation explaining the new interface

All tests are passing. Ready for review!

github-actions · 2025-05-01T17:36:12Z

Tests	Skipped	Failures	Errors	Time
9	0 💤	0 ❌	9 🔥	4.118s ⏱️

gatecat

Haven't looked through the tests yet, but these are my comments so far

gatecat · 2025-06-24T11:54:01Z

+ core_jtag: JTAGPins
+
+ def to_set(self) -> Set[Pin]:
+ return {p for pp in self.core_power for p in asdict(pp).values()} | \


what is the asdict doing here?

gatecat · 2025-06-24T11:58:57Z

+ ret = []
+ for q in range(0,3):
+ ret.append(sorted(quadrants[q]))
+ return ret


it's worth noting that this won't give pins in bonding pad order which might be relevant in some cases - this can only be determined on a pattern-by-package (or by custom design in the case of a substrate or RDL for a WLCSP package).
An example for the PGA144 we used for the previous tapeout is the table on page 3 of https://europractice-ic.com/wp-content/uploads/2019/06/CD_PGA144.pdf but this is always going to differ

…efinition Also enables grid array and quad format packages

robtaylor · 2025-09-26T13:44:49Z

Has some WIP for better pin allocation.

This should become shell and padring aware

robtaylor · 2025-12-17T01:02:39Z

This is massively outdated, but keeping it around as there were some good ideas that need extracting

robtaylor requested review from gatecat and lanserge February 12, 2025 23:19

robtaylor force-pushed the packagepins branch from 7647f03 to 7b415ceCompare February 12, 2025 23:20

gatecat reviewed Feb 13, 2025
View reviewed changes

Comment threadchipflow_lib/platforms/utils.py Outdated

lanserge reviewed Feb 14, 2025
View reviewed changes

robtaylor linked an issue Feb 14, 2025 that may be closed by this pull request
Add power, clock, jtag and heartbeat pins to package definitions #33
Closed

robtaylor force-pushed the packagepins branch from 7b415ce to f3f6894Compare March 12, 2025 12:21

robtaylor marked this pull request as ready for review March 18, 2025 13:28

robtaylor closed this Mar 28, 2025

robtaylor force-pushed the packagepins branch from cf2bc92 to 49594f9Compare March 28, 2025 13:07

robtaylor reopened this May 1, 2025

robtaylor force-pushed the packagepins branch from 954faff to ee057f7Compare May 19, 2025 13:34

robtaylor force-pushed the packagepins branch 2 times, most recently from 4146e57 to e14af0cCompare June 23, 2025 17:04

robtaylor requested review from gatecat, lanserge and stafverhaegen-chipflow June 23, 2025 17:05

gatecat reviewed Jun 24, 2025
View reviewed changes

robtaylor force-pushed the packagepins branch 9 times, most recently from 7d71c83 to 5fc63cfCompare July 2, 2025 10:06

robtaylor force-pushed the packagepins branch 3 times, most recently from 3ec99b5 to 203e0d6Compare July 2, 2025 12:08

robtaylor changed the base branch from main to sim-commonJuly 2, 2025 15:10

robtaylor force-pushed the packagepins branch 2 times, most recently from 2ceb202 to d63aa26Compare July 3, 2025 10:40

robtaylor force-pushed the sim-common branch from a1d2f34 to a515815Compare July 8, 2025 12:04

robtaylor force-pushed the packagepins branch from 0efa14f to d72ff60Compare July 10, 2025 10:11

Base automatically changed from sim-common to mainJuly 11, 2025 17:20

robtaylor marked this pull request as draft July 12, 2025 15:31

robtaylor added 7 commits July 12, 2025 16:40

Update sim infrastructure so it all lives in chipflow-lib
239996b

Make wiring up ports common code and fix invert case
fa83889

feat: Enable configuring of package pin allocation from the package d…
bd84ffb
…efinition Also enables grid array and quad format packages

Clean up test suite and get it running
03600d1

Fix up docs generation
ff8ec0f

Fix wiring up of resets and clocks
012742d

WIP for power pin placement on arbiatary padring/package
c2bf855

robtaylor force-pushed the packagepins branch from d72ff60 to c2bf855Compare July 12, 2025 15:56

Uh oh!

Conversation

robtaylor commented Feb 12, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Pin Interface

Key Changes

Backward Compatibility

Ready for Review

Uh oh!

github-actionsBot commented Feb 12, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2025-07-07 11:00 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robtaylor commented Mar 18, 2025

Uh oh!

github-actionsBot commented May 1, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gatecat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robtaylor commented Sep 26, 2025

Uh oh!

robtaylor commented Dec 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

robtaylor commented Feb 12, 2025•
edited
Loading

github-actionsBot commented Feb 12, 2025•
edited
Loading

Built to branch `gh-pages` at 2025-07-07 11:00 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actionsBot commented May 1, 2025•
edited
Loading