Skip to content
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

Write a "cell index / table" generator for the documentation #86

Closed
mithro opened this issue Jul 11, 2020 · 6 comments · Fixed by #266
Closed

Write a "cell index / table" generator for the documentation #86

mithro opened this issue Jul 11, 2020 · 6 comments · Fixed by #266
Labels
documentation Improvements or additions to documentation files-definition Issues related to the definition.json provided for each cell. good-first-issue This issue is suitable for a new person who has never contributed to the PDK before. help-wanted This issue is open to help from anyone who can work on it! lib-sky130_fd_sc_hd Issues with the "high density" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hdll Issues with the "high density low leakage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hs Issues with the "high speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hvl Issues with the "high voltage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_lp Issues with the "low power" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ls Issues with the "low speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ms Issues with the "medium speed" digital standard cells provided by the SkyWater foundry. scripts-documentation Issues with the scripts involved in the PDK documentation generation.

Comments

@mithro
Copy link
Contributor

mithro commented Jul 11, 2020

It is very useful to have tables of the cells available in each library. This should be included in the Sphinx generated PDK documentation. The task here is to auto-generate these tables as either;

This should be easily be done due to the library structure being based around each cell having its own directory and a definition.json file which describes the basic shape and features of the cell.

Here is an example from a spreadsheet I created;

Screenshot from 2020-07-11 13-08-19
Screenshot from 2020-07-11 13-08-39

Here is an example from the libresilicon Standard Cell Library Build Report;

Screenshot from 2020-07-11 13-12-18

Here is an example from this random document

Screenshot from 2020-07-11 13-19-23

Here is another example from a random thesis on creating standard cells

Screenshot from 2020-07-11 13-21-25

@mithro mithro added documentation Improvements or additions to documentation files-definition Issues related to the definition.json provided for each cell. good-first-issue This issue is suitable for a new person who has never contributed to the PDK before. help-wanted This issue is open to help from anyone who can work on it! lib-sky130_fd_sc_hd Issues with the "high density" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hdll Issues with the "high density low leakage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hs Issues with the "high speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ms Issues with the "medium speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ls Issues with the "low speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_lp Issues with the "low power" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hvl Issues with the "high voltage" digital standard cells provided by the SkyWater foundry. scripts-documentation Issues with the scripts involved in the PDK documentation generation. labels Jul 11, 2020
PiotrZierhoffer added a commit to antmicro/skywater-pdk that referenced this issue Aug 25, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
PiotrZierhoffer added a commit to antmicro/skywater-pdk that referenced this issue Aug 25, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
@PiotrZierhoffer
Copy link
Collaborator

I used some of the definitions.json data to create a basic list. The script just takes a path to the library and creates a file. I also modified the README.rst manually to include the file inline (so we don't have to parse it when regenerating).

How do I submit the results for review? Create a sample PR in one of the submodules maybe?

@PiotrZierhoffer
Copy link
Collaborator

Also it now takes data both from cells and models. This can obviously be changed if needed, but seemed to make sense

PiotrZierhoffer added a commit to antmicro/skywater-pdk that referenced this issue Aug 26, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
PiotrZierhoffer added a commit to antmicro/skywater-pdk that referenced this issue Aug 26, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
@mithro
Copy link
Contributor Author

mithro commented Oct 22, 2020

The issue at #143 does some initial work here.

wgryncewicz pushed a commit to antmicro/skywater-pdk that referenced this issue Oct 27, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
wgryncewicz pushed a commit to antmicro/skywater-pdk that referenced this issue Nov 3, 2020
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
kgugala pushed a commit to antmicro/skywater-pdk that referenced this issue May 20, 2022
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
@proppy
Copy link
Member

proppy commented May 30, 2022

@kgugala @PiotrZierhoffer found #143 #256 and #266 that all seem to contribute to fixing this, could you advise on the best way to merge them (rebase, apply in order, drop duplicate changes?). Are there other changes from https://github.com/antmicro/skywater-pdk/ that need to be added as well?

@wgryncewicz
Copy link
Collaborator

@proppy I'll take a look into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation files-definition Issues related to the definition.json provided for each cell. good-first-issue This issue is suitable for a new person who has never contributed to the PDK before. help-wanted This issue is open to help from anyone who can work on it! lib-sky130_fd_sc_hd Issues with the "high density" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hdll Issues with the "high density low leakage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hs Issues with the "high speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hvl Issues with the "high voltage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_lp Issues with the "low power" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ls Issues with the "low speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ms Issues with the "medium speed" digital standard cells provided by the SkyWater foundry. scripts-documentation Issues with the scripts involved in the PDK documentation generation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants