efabless / caravel

Caravel is a standard SoC harness with on chip resources to control and read/write operations from a user-dedicated space.
https://caravel-harness.readthedocs.io/
Apache License 2.0
296 stars 69 forks source link

Documentation issues and enhancements identified from config.tcl. #191

Closed azwefabless closed 1 year ago

azwefabless commented 2 years ago

CLK_WIRE_RC_LAYER still says Met5

CLK_BUFRFER, CLK_BUFFER_INPUT, CLK_BUFFER_OUTPUT are not documented in env doc on caravel openlane This needs to become an openlane ticket as there are many issues like this.

Some blocks seem to be implemented in Openlane using ant strategy 3 and some using ant strategy 4 with no clear documentation or reasoning.

TS_ROOT_BUFFER not documented

CTS SQR CAP, CTS_SQR_RES not documented and values do not seem consistent with Met 5 in item1 above.

CTS_TECH_DIT is N/A and item is undocumented.

Range for CTS TOLERANCE is not defined in documentation.

DATA_WIRE_RC_LAYER is not documented. Setting of M2 seems reasonable if it is used for Groute estimation.

DEF_UNITS_PER_MICRON 1000 (surprised that this is not 200). Undocumented. Creates he opportunity for offgrid placement errors.

DESIGN_CONFIG seems to reference itself.

DPL_CELL_PADDING is not documented

DRC_EXCLUDE_CELL_LISTt is pointed to a design specific cell. It seems to be being used to solve problems that are unrelated to routing DRC.Probably need a different solution t this problem.

DRC_EXCLUDE_CELL_LIST_OPT is pointed to the pdk default cell list.

ECO_ENABLE, ECO_FINISH and ECO_ITER and ECO_SKIP_PIN are undocumented.

FAKEDIODE_CELL is undocumented

FILL_CELL is undocumented

HLENGTH seems like a crude routing solution which produces inefficient layouts. Future enhancement VLENGTH Is same issue

FP_IO_HTHICKNESS_MULT seems very odd and is not a routed wire pitch. Future enhancement

FP_IO_MIN_DISTANCE functionality needs improvement. Not connecting on routed pitches and consuming a lot of distance for amount of connectivity

IO_MODE default is set to 1 we need to understand the other modes or options. Future enhancement

FP_PDN_COORERING * are undocumented.

ENABLE_GLOBAL_CONNECTIONS is undocumented.

FP_PDN_IRDROP needs clarifying documentation and a result.

PDN_LOWER_LAYER is not documented

PDNRAILS* not documented

PDN_UPPER_LAYER not documented

Stopped at row 132 of config.tcl for mgmt_soc

azwefabless commented 2 years ago

This is the documentation related items that were originally part of ticket 188 and have been split out as they are not as urgent to address as the actionable items on the implementation script itself.

kareefardi commented 1 year ago

Edit: I only realized that this, removed, comment was here after creating the new comment bellow. The new comment is more comprehensive so I am removing this one.

kareefardi commented 1 year ago

Removed and was undocumented:

Removed - is documented or added documentation to with removed status:

Documented:

Internal Variable used by the flow:

Actionable:

Additional comments: