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

Unscheduled DFCIR & SystemVerilog output path options revamp #31

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

Muxianesty
Copy link
Collaborator

Unscheduled DFCIR option requested in #25 was added. SystemVerilog output path is no longer the only output option, thus its strict requirement was removed from both README.md and the codebase.

@Muxianesty Muxianesty requested a review from ssmolov July 29, 2024 14:02
@Muxianesty Muxianesty self-assigned this Jul 29, 2024
README.md Outdated
@@ -216,13 +216,16 @@ The list of arguments for `hls`-mode is presented below:

* `-h,--help`: *optional* flag; used to print the help-message about other arguments.
* `--config <PATH>`: *required* filesystem-path option; used to specify the file for a JSON latency configuration file. Its format is presented in *JSON Configuration* section.
* `--out <NAME>`: *optional* filesystem-path option; used to specify the destination file for the output SystemVerilog to be generated in. If the name isn't provided or the provided name is an empty string, standard output stream is used.
* `--sv_out <PATH>`: *optional* filesystem-path option; used to specify the destination file for the output SystemVerilog to be generated in.
Copy link
Collaborator

Choose a reason for hiding this comment

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

  1. "destination file for the output SystemVerilog to be generated in" -> "output SystemVerilog file"
  2. "--sv_out" -> "--out-sv"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

README.md Outdated
@@ -216,13 +216,16 @@ The list of arguments for `hls`-mode is presented below:

* `-h,--help`: *optional* flag; used to print the help-message about other arguments.
* `--config <PATH>`: *required* filesystem-path option; used to specify the file for a JSON latency configuration file. Its format is presented in *JSON Configuration* section.
* `--out <NAME>`: *optional* filesystem-path option; used to specify the destination file for the output SystemVerilog to be generated in. If the name isn't provided or the provided name is an empty string, standard output stream is used.
* `--sv_out <PATH>`: *optional* filesystem-path option; used to specify the destination file for the output SystemVerilog to be generated in.
* `--dfcir_out <PATH>`: *optional* filesystem-path option; used to specify the destination file for the output DFCIR to be generated in.
Copy link
Collaborator

Choose a reason for hiding this comment

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

  1. "destination file for the output DFCIR to be generated in" -> "output DFCIR file"
    1. "--dfcir_out" -> "--out-dfcir"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

README.md Outdated
* `-a` or `-l`: *required* flag; used to specify the chosen scheduling strategy - either as-soon-as-possible or linear programming. **Exactly one of these flags has to be specified**.

**At least one of the `*_out` options has to be specified.**
Copy link
Collaborator

Choose a reason for hiding this comment

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

"_out" -> "--out-"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

README.md Outdated
Here is an example of an Utopia HLS CLI call:

```bash
umain hls --config ~/utopia-user/config.json --out ~/outFile -a
umain hls --config ~/utopia-user/config.json --sv_out ~/outFile.sv --dfcir_out ~/outFile2.mlir -a
Copy link
Collaborator

Choose a reason for hiding this comment

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

Fix options as are described above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

src/options.h Outdated
Comment on lines 38 to 39
#define SV_OUT_JSON "sv_out"
#define DFCIR_OUT_JSON "dfcir_out"
Copy link
Collaborator

Choose a reason for hiding this comment

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

See above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

src/options.h Outdated
Comment on lines 50 to 51
#define SV_OUT_ARG CLI_ARG("sv_out")
#define DFCIR_OUT_ARG CLI_ARG("dfcir_out")
Copy link
Collaborator

Choose a reason for hiding this comment

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

See above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

src/options.h Outdated
Comment on lines 184 to 187
"Path to output SystemVerilog module to");
outputGroup->add_option(DFCIR_OUT_ARG,
outNames[OUT_FORMAT_ID_INT(DFCIR)],
"Path to output unscheduled DFCIR to");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Worth to think about...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

@ssmolov ssmolov merged commit 632f248 into master Jul 30, 2024
@Muxianesty Muxianesty deleted the dfcir_output_format branch August 15, 2024 14:21
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.

2 participants