[RACL] Add documentation and example config #26198
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidschrammel
requested review from
Razer6,
rswarbrick,
andreaskurth and
vogelpi
davidschrammel
force-pushed
the
racl-doc-1
branch
2 times, most recently
from
8aebeae to
873e7a6
Compare
Razer6
reviewed
Feb 11, 2025
Razer6
reviewed
Feb 11, 2025
davidschrammel
force-pushed
the
racl-doc-1
branch
4 times, most recently
from
af586d9 to
9f6cebf
Compare
rswarbrick
reviewed
Feb 12, 2025
hw/ip_templates/racl_ctrl/README.md
Outdated
| ```hjson | ||
| racl_mappings: { | ||
| soc: 'top_darjeeling/data/racl/all_rd_wr_mapping.hjson' | ||
| sram: 'top_darjeeling/data/racl/all_rd_wr_mapping.hjson' |
There was a problem hiding this comment.
Would it make sense to give an example where the different interfaces have different mappings?
| parser.add_argument('--racl-config', | ||
| '-r', | ||
| required=True, | ||
| required=not is_doc, |
There was a problem hiding this comment.
This is rather clever! But the error messages might be a bit confusing. I'd probably make these optional for argparse, but then put an extra check just after the call to parse_args, which does something like this? (Completely untested!)
if not args.is_doc:
if (args.racl_config is None or
args.ip is None or
args.mapping is None):
raise SystemExit("--racl-config, --ip and --mapping are all required for non-doc runs.")There was a problem hiding this comment.
@rswarbrick I pushed some changes and came up with a different solution. Let me know what you think of it!
% ./util/raclgen.py
usage:
raclgen.py --doc DOC
Generates markdown documentation of the RACL configuration for a given top.
raclgen.py --racl-config RACL_CONFIG --ip IP --mapping MAPPING [--if-name IF_NAME]
Generates the RACL policy selection vector for the given IP, RACL mapping, and interface name.
raclgen.py: error: the following arguments are required: --racl-config/-r, --ip/-i, --mapping/-m
Arguably, this error message is still not 100% correct but I would like to avoid the if (args.racl_config ... checks.
davidschrammel
force-pushed
the
racl-doc-1
branch
3 times, most recently
from
b687cea to
b19bb50
Compare
Signed-off-by: David Schrammel <[email protected]>
Signed-off-by: David Schrammel <[email protected]>
davidschrammel
force-pushed
the
racl-doc-1
branch
from
b19bb50 to
3834170
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds initial documentation for RACL and describes the racl configuration files in the form of inline examples.
Furthermore, it generates a
racl_configuration.mdfile which documents the current RACL configuration for each module instance and interface.I don't have a strong opinion on how to format the RACL config information in the generated tables. We can still discuss and changes this!