Merge branch 'main' into RoundRobin

.github/ISSUE_TEMPLATE/config.yml

@@ -10,5 +10,5 @@ contact_links:
     about: Instant communication... if someone is online.
 
   - name: ROHD Forum
-    url: https://github.com/intel/rohd/wiki/ROHD-Forum
+    url: https://intel.github.io/rohd-website/forum/rohd-forum/
     about: Public periodic meeting for users and developers to discuss topics related to ROHD.

.github/configs/mlc_config.json

@@ -1,3 +1,7 @@
 {
-  "ignorePatterns": []
+  "ignorePatterns": [
+    {
+      "pattern":"^https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html$"
+    }
+  ]
 }

.github/workflows/general.yml

@@ -20,7 +20,7 @@ jobs:
           submodules: recursive
 
       - name: Lint Markdown files
-        uses: DavidAnson/markdownlint-cli2-action@v9
+        uses: DavidAnson/markdownlint-cli2-action@v11
         with:
           globs: '**/*.md'
 

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+<[email protected]>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -1,69 +1,70 @@
-
 # Contributing to the ROHD Hardware Component Library
 
-Thank you for considering contributing to the ROHD Hardware Component Library (ROHD-HCL)!  Contributions from the community are vital to making this a successful project.
+Thank you for considering contributing to the ROHD Hardware Component Library (ROHD-HCL)! Contributions from the community are vital to making this a successful project.
 
 Anyone interested in participating in ROHD-HCL is more than welcome to help!
 
 ## Code of Conduct
 
-ROHD-HCL adopts the Contributor Covenant v2.1 for the code of conduct.  It can be accessed [here](https://github.com/intel/rohd-hcl/blob/main/CODE_OF_CONDUCT.md).
+ROHD-HCL adopts the [Contributor Covenant](https://www.contributor-covenant.org/) v2.1 for the code of conduct. It can be accessed [here](CODE_OF_CONDUCT.md).
 
 ## Getting Help
 
 ### Chat on Discord
 
-Discord is a free online instant messaging app which you can use directly in your web browser or install to your device.  Feel free to join to look around at the conversations and have a real-time discussion with the ROHD community.  This a great place to ask questions, get help, engage with the rest of the community, and discuss new ideas.
+[Discord](https://discord.com/) is a free online instant messaging app which you can use directly in your web browser or install to your device. Feel free to join to look around at the conversations and have a real-time discussion with the ROHD community. This a great place to ask questions, get help, engage with the rest of the community, and discuss new ideas.
 
 Join the Discord server here: <https://discord.com/invite/jubxF84yGw>
 
-### Issues
+### GitHub Discussions
 
-If something doesn't seem right, you're stuck, there's a critical feature/enhancement missing, you find a bug, etc. then filing an issue on the GitHub repository is a great option.  Please try to provide as much detail as possible.  Complete, stand-alone reproduction instructions are extremely helpful for bugs!
+GitHub Discussions is a place where you can find announcements, ask questions, share ideas, show new things you're working on, or just discuss in general with the community! If you have a question or need some help, this is a great place to go.
 
-You can file an issue here: <https://github.com/intel/rohd-hcl/issues/new>
+You can access the discussions area here: <https://github.com/intel/rohd-hcl/discussions>
 
-### Discussions
+### GitHub Issues
 
-GitHub Discussions is a place where you can find announcements, ask questions, share ideas, show new things you're working on, or just discuss in general with the community!  If you have a question or need some help, this is a great place to go.
+If something doesn't seem right, you're stuck, there's a critical feature/enhancement missing, you find a bug, etc. then filing an issue on the GitHub repository is a great option. Please try to provide as much detail as possible. Complete, stand-alone reproduction instructions are extremely helpful for bugs!
 
-You can access the discussions area here: <https://github.com/intel/rohd-hcl/discussions>
+You can file an issue here: <https://github.com/intel/rohd-hcl/issues/new/choose>
 
-### StackOverflow
+### Stack Overflow
 
-StackOverflow.com is a great tool to ask questions and get answers from the community.  Use the `rohd` and/or `rohd-hcl` tag when asking your question so that others in the community who subscribe to that tag can find and answer your question more quickly!
+[Stack Overflow](https://stackoverflow.com/) is a great tool to ask questions and get answers from the community. Use the `rohd` and/or `rohd-hcl` tag when asking your question so that others in the community who subscribe to that tag can find and answer your question more quickly!
 
 ### Meetings in the ROHD Forum
 
-The [ROHD Forum](https://github.com/intel/rohd/wiki/ROHD-Forum) is a periodic virtual meeting for developers and users of ROHD that anyone can join.  Feel free to join the call!
+The [ROHD Forum](https://intel.github.io/rohd-website/forum/rohd-forum/) is a periodic virtual meeting for developers and users of ROHD that anyone can join. Feel free to join the call!
 
 ## Getting Started
 
 ### Requirements
 
-You must have [Dart](https://dart.dev/) installed on your system to use ROHD and ROHD-HCL.  You can find detailed instructions for how to install Dart here:
-<https://dart.dev/get-dart>
+You must have [Dart](https://dart.dev/) installed on your system to use ROHD and ROHD-HCL. You can find detailed instructions for how to install Dart here: <https://dart.dev/get-dart>
 
 ### Setup Recommendations
 
 #### On your own system
 
-[Visual Studio Code (vscode)](https://code.visualstudio.com/) is a great IDE for development.  You can find installation instructions for vscode here: <https://code.visualstudio.com/Download>
+[Visual Studio Code (VSCode)](https://code.visualstudio.com/) is a great IDE for development. You can find installation instructions for VSCode here: <https://code.visualstudio.com/Download>
+
+The Dart extension extends VSCode with support for the Dart programming language and provides tools for effectively editing, refactoring and running. Check out the detailed information: <https://dartcode.org/>
 
-If you're developing on a remote host, vscode has a Remote SSH extension that can help: <https://code.visualstudio.com/blogs/2019/07/25/remote-ssh>
+If you're developing on a remote host, VSCode has a Remote SSH extension that can help: <https://code.visualstudio.com/docs/remote/ssh>
 
-If you're on Microsoft Windows, you may want to consider developing with Ubuntu WSL for a Linux environment: <https://docs.microsoft.com/en-us/windows/wsl/install-win10>
+If you're on Microsoft Windows, you may want to consider developing with Ubuntu WSL for a Linux environment: <https://learn.microsoft.com/windows/wsl/install>
 
-#### In a GitHub Codespace
+#### In GitHub Codespaces
 
-[GitHub Codespaces](https://github.com/features/codespaces) are a great feature provided by GitHub allowing you to get into a development environment based on a pre-configured container very quickly!  You can use them for a limited number of hours per month for free.  ROHD-HCL has set up GitHub Codespaces so that you can immediately start running examples and developing.
+[GitHub Codespaces](https://github.com/features/codespaces) are a great feature provided by GitHub allowing you to get into a development environment based on a pre-configured container very quickly! You can use them for a limited number of hours per month for free. ROHD-HCL has set up GitHub Codespaces so that you can immediately start running examples and developing.
+
+The below button will allow you to create a GitHub Codespace with ROHD-HCL already cloned and ready to roll:
 
-The below button will allow you to create a GitHub Codespace with ROHD-HCL already cloned and ready to roll.
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=621521356)
 
 ### Cloning and Running the Tests
 
-Once requirements are installed, you can clone and run the test suite.
+Once requirements are installed, you can clone and run the test suite:
 
 ```shell
 git clone https://github.com/intel/rohd-hcl.git
@@ -74,60 +75,70 @@ dart test
 
 ## How to Contribute
 
+### Reporting Vulnerabilities
+
+Please report any vulnerabilities according to the information provided in the [SECURITY.md](SECURITY.md) file.
+
 ### Reporting Bugs
 
 Please report any bugs you find as a GitHub issue. Please try to provide as much detail as possible. Complete, stand-alone reproduction instructions are extremely helpful for bugs!
 
 Some helpful information you can include:
 
 * Output of `dart --version`
-* Your dependencies from pubspec.yaml
+* Your dependencies from `pubspec.yaml`
 * The version of ROHD and ROHD-HCL you're using
 * Command you ran and output
 * Reproduction code and steps
 
 ### Suggesting Enhancements
 
-If you have an idea for a feature or enhancement that would make ROHD better, feel free to submit a GitHub issue!  Discussion on the ticket about pros & cons, strategy, etc. is encouraged.
+If you have an idea for a feature or enhancement that would make ROHD better, feel free to submit a GitHub issue! Discussion on the ticket about pros & cons, strategy, etc. is encouraged.
 
 ### Discussing Issues
 
-If you have an opinion or helpful information on any open issue, feel free to comment!  Even if you don't have the time to implement a change, providing valuable input is great too!
+If you have an opinion or helpful information on any open issue, feel free to comment! Even if you don't have the time to implement a change, providing valuable input is great too!
 
 ### Fix or implement an Issue
 
-Take a look around the issues on the repo and see if there's any you'd like to take ownership of.  For your first contributions, look for issues tagged with `good first issue`, which are intended to be easier to get started with.  Feel free to ask for help or guidance!
+Take a look around the issues on the repo and see if there's any you'd like to take ownership of. For your first contributions, look for issues tagged with `good first issue`, which are intended to be easier to get started with. Feel free to ask for help or guidance!
 
 ### Pull Requests
 
-If you have a change that you have implemented and would like to contribute, you can open a pull request.  Please try to make sure you have implemented tests covering the changes, if applicable.  Smaller, simpler pull requests are easier to review.
+If you have a change that you have implemented and would like to contribute, you can open a pull request. Please try to make sure you have implemented tests covering the changes, if applicable. Smaller, simpler pull requests are easier to review.
 
-Be sure to run the test suite (`dart test`) before asking for your code to be merged.  You may also locally generate API documentation (`dartdoc`) to make sure it looks right and doesn't have any errors.  You should use the dart formatter on all code (`dart format .`), and may prefer to have it automatically format on every file save.  If you're using Visual Studio Code, you could add this to `settings.json`:
+Be sure to run the test suite (`dart test`) before asking for your code to be merged. You may also locally generate API documentation (`dart doc`) to make sure it looks right and doesn't have any errors. You should use the dart formatter on all code (`dart format .`), and may prefer to have it automatically format on every file save. If you are using VSCode with the Dart extension, then consider using the recommended settings: <https://dartcode.org/docs/recommended-settings/>
 
-```json
-"[dart]": {
-    "editor.defaultFormatter": "Dart-Code.dart-code",
-    "editor.formatOnSave": true,
-}
-```
-
-**Tests must pass, documentation must generate, and the formatter must be run on every pull request or the automated GitHub Action flow will fail.**
+**Tests must pass, documentation must generate, and the formatter must be run on every pull request or the automated GitHub Actions flow will fail.**
 
 Maintainers of the project and other community members will provide feedback and help iterate as necessary until the contribution is ready to be merged.
 
 Please include the SPDX tag near the top of any new files you create:
 
 ```dart
-/// SPDX-License-Identifier: BSD-3-Clause
+// SPDX-License-Identifier: BSD-3-Clause
+```
+
+Here is an example of a recommended file header template:
+
+```dart
+// Copyright (C) 2021-2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// example.dart
+// A very basic example of a counter module.
+//
+// 2021 September 17
+// Author: Max Korbel <[email protected]>
 ```
 
 ### Creating a New Package
 
-Not every new contribution has to go directly into the ROHD or ROHD-HCL frameworks!  If you have an idea for a reusable piece of hardware, tooling, verification collateral, or anything else that helps the ROHD ecosystem but is somewhat standalone, you can make your own package that depends on ROHD.  Building an ecosystem of reusable components is important to the success of ROHD.  Reach out if you want some help or guidance deciding if or how you should create a new package.
+Not every new contribution has to go directly into the ROHD or ROHD-HCL frameworks! If you have an idea for a reusable piece of hardware, tooling, verification collateral, or anything else that helps the ROHD ecosystem but is somewhat standalone, you can make your own package that depends on ROHD. Building an ecosystem of reusable components is important to the success of ROHD. Reach out if you want some help or guidance deciding if or how you should create a new package.
 
 ## Style
 
-Like ROHD, ROHD-HCL follows the official Dart recommended style guides and lints.  The analyzer will help ensure that your code is written consistently with the rest of ROHD.
+Like ROHD, ROHD-HCL follows the official Dart recommended style guides and lints. The analyzer will help ensure that your code is written consistently with the rest of ROHD.
 
 Here are some links to help guide you on style as recommended by Dart:
 

README.md

@@ -120,8 +120,6 @@ Below is a list of components either already or planning to be implemented.
   - HBM
 
 ----------------
-2023 March 30  
-Author: Max Korbel <<[email protected]>>
 
 Copyright (C) 2023 Intel Corporation  
 SPDX-License-Identifier: BSD-3-Clause

analysis_options.yaml

@@ -65,15 +65,17 @@ linter:
     - cascade_invocations
     - cast_nullable_to_non_nullable
     - close_sinks
-    # - collection_methods_unrelated_type [not currently recognized]
-    # - combinators_ordering [not currently recognized]
+    - collection_methods_unrelated_type
+    - combinators_ordering
     - comment_references
     - conditional_uri_does_not_exist
     - constant_identifier_names
     - control_flow_in_finally
     - curly_braces_in_flow_control_structures
+    - dangling_library_doc_comments
     - depend_on_referenced_packages
     - deprecated_consistency
+    - deprecated_member_use_from_same_package
     - diagnostic_describe_all_properties
     - directives_ordering
     - discarded_futures
@@ -87,23 +89,31 @@ linter:
     - flutter_style_todos
     - hash_and_equals
     - implementation_imports
-    - iterable_contains_unrelated_type
+    - implicit_call_tearoffs
+    - implicit_reopen
+    - invalid_case_patterns
+    # - iterable_contains_unrelated_type [deprecated]
     - join_return_with_assignment
     - leading_newlines_in_multiline_strings
+    - library_annotations
     - library_names
     - library_prefixes
     - library_private_types_in_public_api
     - lines_longer_than_80_chars
-    - list_remove_unrelated_type
+    # - list_remove_unrelated_type [deprecated]
     - literal_only_boolean_expressions
+    - matching_super_parameters
     - missing_whitespace_between_adjacent_strings
     - no_adjacent_strings_in_list
     - no_default_cases
     - no_duplicate_case_values
     - no_leading_underscores_for_library_prefixes
     - no_leading_underscores_for_local_identifiers
+    - no_literal_bool_comparisons
     - no_logic_in_create_state
     - no_runtimeType_toString
+    - no_self_assignments
+    - no_wildcard_variable_uses
     - non_constant_identifier_names
     - noop_primitive_operations
     - null_check_on_nullable_type_parameter
@@ -128,7 +138,6 @@ linter:
     - prefer_constructors_over_static_methods
     - prefer_contains
     # - prefer_double_quotes
-    - prefer_equal_for_default_values
     - prefer_expression_function_bodies
     - prefer_final_fields
     - prefer_final_in_for_each
@@ -173,15 +182,18 @@ linter:
     - tighten_type_of_initializing_formals
     - type_annotate_public_apis
     - type_init_formals
+    - type_literal_in_constant_pattern
     - unawaited_futures
     - unnecessary_await_in_return
     - unnecessary_brace_in_string_interps
+    - unnecessary_breaks
     - unnecessary_const
     - unnecessary_constructor_name
     # - unnecessary_final
     - unnecessary_getters_setters
     - unnecessary_lambdas
     - unnecessary_late
+    - unnecessary_library_directive
     - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_aware_operator_on_extension_on_nullable
@@ -196,7 +208,7 @@ linter:
     - unnecessary_string_interpolations
     - unnecessary_this
     - unnecessary_to_list_in_spreads
-    # - unreachable_from_main [not currently recognized]
+    # - unreachable_from_main
     - unrelated_type_equality_checks
     - unsafe_html
     - use_build_context_synchronously
@@ -214,7 +226,7 @@ linter:
     - use_rethrow_when_possible
     - use_setters_to_change_properties
     - use_string_buffers
-    # - use_string_in_part_of_directives [not currently recognized]
+    - use_string_in_part_of_directives
     - use_super_parameters
     - use_test_throws_matchers
     - use_to_and_as_if_applicable

example/example.dart

@@ -6,7 +6,6 @@
 //
 // 2023 February 17
 // Author: Max Korbel <[email protected]>
-//
 
 // ignore_for_file: avoid_print
 

gen/arbiter_gen.dart

@@ -6,7 +6,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 // ignore_for_file: unused_element
 

gen/fifo_gen.dart

@@ -6,7 +6,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 import 'dart:io';
 import 'package:rohd/rohd.dart';

gen/generate.dart

@@ -9,7 +9,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 import 'arbiter_gen.dart';
 import 'fifo_gen.dart';

gen/one_hot_gen.dart

@@ -6,7 +6,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 import 'dart:io';
 import 'package:rohd/rohd.dart';

gen/rf_gen.dart

@@ -6,7 +6,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 import 'dart:io';
 import 'package:rohd/rohd.dart';

gen/rotate_gen.dart

@@ -6,7 +6,6 @@
 //
 // 2023 May 09
 // Author: Desmond Kirkpatrick <[email protected]>
-//
 
 import 'dart:io';
 import 'package:rohd/rohd.dart';