Merge branch 'main' into chapter-9-ROHDVF

intel · Sep 8, 2023 · cc762b6 · cc762b6
2 parents 7f5f832 + 858daad
commit cc762b6
Show file tree

Hide file tree

Showing 165 changed files with 3,022 additions and 1,869 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.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.
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -2,7 +2,8 @@
   "config": {
     "default": true,
     "MD013": false,
-    "MD041": false
+    "MD041": false,
+    "MD033": false
   },
 
   "ignores": [

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
 
+## Next
+
+- Breaking: Iterable instead of Map in Interface
+
 ## 0.4.2
 
 - Added a GitHub Codespace to the repository as a quick way to experiment with ROHD without any environment setup.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ You can file an issue here: <https://github.com/intel/rohd/issues/new/choose>
 
 ### 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
 

diff --git a/README.md b/README.md
diff --git a/analysis_options.yaml b/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

diff --git a/benchmark/many_seq_and_comb_benchmark.dart b/benchmark/many_seq_and_comb_benchmark.dart
@@ -191,11 +191,6 @@ class ManySeqAndCombBenchmark extends AsyncBenchmarkBase {
   ManySeqAndCombBenchmark(this.combConnectionType)
       : super('ManySeqAndCombBenchmark_${combConnectionType.name}');
 
-  @override
-  Future<void> teardown() async {
-    await Simulator.reset();
-  }
-
   @override
   Future<void> run() async {
     final combinationalWrapper = _CombinationalWrapper(

diff --git a/doc/tutorials/README.md b/doc/tutorials/README.md
@@ -81,8 +81,10 @@
 
 ## Chapter 8: Abstractions
 
-- Pipelines: Normally Delayed exists in between a big circuit, abstractions split the logic across multiple cycles and let us decide what logic do you want it to occur in each of the cycle.
-- Finite state machines
+- [ROHD Abstraction](./chapter_8/00_abstraction.md#rohd-abstraction)
+- [Interface](./chapter_8/01_interface.md)
+- [Finite State Machine](./chapter_8/02_finite_state_machine.md)
+- [Pipeline](./chapter_8/03_pipeline.md)
 
 ## Chapter 9: ROHD-VF
 

diff --git a/doc/tutorials/chapter_2/a_logic.dart b/doc/tutorials/chapter_2/a_logic.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// a_logic.dart
-/// Creation of logic in rohd.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// a_logic.dart
+// Creation of logic in rohd.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, omit_local_variable_types
 

diff --git a/doc/tutorials/chapter_2/answers/exercise_1.dart b/doc/tutorials/chapter_2/answers/exercise_1.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// exercise_1.dart
-/// Answer to exercise 1.
-///
-/// 2023 February 14
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// exercise_1.dart
+// Answer to exercise 1.
+//
+// 2023 February 14
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/answers/exercise_2.dart b/doc/tutorials/chapter_2/answers/exercise_2.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// exercise_2.dart
-/// Answer to exercise 2.
-///
-/// 2023 February 14
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// exercise_2.dart
+// Answer to exercise 2.
+//
+// 2023 February 14
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unnecessary_this
 import 'package:rohd/rohd.dart';

diff --git a/doc/tutorials/chapter_2/answers/exercise_3.dart b/doc/tutorials/chapter_2/answers/exercise_3.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// exercise_3.dart
-/// Answer to exercise 3.
-///
-/// 2023 February 14
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// exercise_3.dart
+// Answer to exercise 3.
+//
+// 2023 February 14
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print
 

diff --git a/doc/tutorials/chapter_2/b_logic_width.dart b/doc/tutorials/chapter_2/b_logic_width.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// a_logic_width.dart
-/// Creation logic value and width in rohd.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// a_logic_width.dart
+// Creation logic value and width in rohd.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/c_logic_gate_part_1.dart b/doc/tutorials/chapter_2/c_logic_gate_part_1.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// c_logic_gate_part_1.dart
-/// Initialize of logic gate Logic.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// c_logic_gate_part_1.dart
+// Initialize of logic gate Logic.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/d_assignment_operator.dart b/doc/tutorials/chapter_2/d_assignment_operator.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// d_assignment_operator.dart
-/// Demo how to the assignment operator work.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// d_assignment_operator.dart
+// Demo how to the assignment operator work.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/e_logic_gate_part_2.dart b/doc/tutorials/chapter_2/e_logic_gate_part_2.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// e_logic_gate_part_2.dart
-/// Add assignment and mathematical & operator to create Logic Gate.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// e_logic_gate_part_2.dart
+// Add assignment and mathematical & operator to create Logic Gate.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/f_logic_gate_part_3.dart b/doc/tutorials/chapter_2/f_logic_gate_part_3.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// f_logic_gate_part_3.dart
-/// Test and simulate the logic gate created using put().
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// f_logic_gate_part_3.dart
+// Test and simulate the logic gate created using put().
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/g_constant.dart b/doc/tutorials/chapter_2/g_constant.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// g_constant.dart
-/// Creation of constant Logic in rohd.
-///
-/// 2023 February 20
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// g_constant.dart
+// Creation of constant Logic in rohd.
+//
+// 2023 February 20
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable
 

diff --git a/doc/tutorials/chapter_2/h_bus_range_swizzling.dart b/doc/tutorials/chapter_2/h_bus_range_swizzling.dart
@@ -1,12 +1,11 @@
-/// Copyright (C) 2023 Intel Corporation
-/// SPDX-License-Identifier: BSD-3-Clause
-///
-/// bus_range_swizzling.dart
-/// Demonstrated the use of bus range and swizzling.
-///
-/// 2023 February 14
-/// Author: Yao Jing Quek <[email protected]>
-///
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// bus_range_swizzling.dart
+// Demonstrated the use of bus range and swizzling.
+//
+// 2023 February 14
+// Author: Yao Jing Quek <[email protected]>
 
 // ignore_for_file: avoid_print, unused_local_variable