Under development (#25)

Fixed
 - Moved machine timer nodes to platform yaml.
Added
  - --version option to arguments to print version and exit when specified.
  - Print help and exit when no options/arguments are specified.
  - Closes #24

Author: pawks

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.1.0 - 2020-03-29
+## Fixed
+- Moved machine timer nodes to platform yaml.
+## Added
+- `--version` option to arguments to print version and exit when specified.
+- Print help and exit when no options/arguments are specified.
+
 ## 2.0.2 - 2020-03-28
 ### Fixed
 - Redundant reset-val check for mtvec and misa registers.

docs/source/quickstart.rst

@@ -78,20 +78,21 @@ Once you have RISCV_CONFIG installed, executing ``riscv_config --help`` should p
 
 .. code-block:: bash
 
-    riscv-config [-h] --isa_spec YAML --platform_spec YAML [--verbose]
-
-    RISC-V Configuration Validator 
+    riscv_config [-h] [--version] [--isa_spec YAML] [--platform_spec YAML]
+                        [--work_dir DIR] [--verbose]
+    
+    RISC-V Configuration Validator
     
     optional arguments:
       --isa_spec YAML, -ispec YAML
                             The YAML which contains the ISA specs.
       --platform_spec YAML, -pspec YAML
                             The YAML which contains the Platfrorm specs.
       --verbose             debug | info | warning | error
+      --version, -v         Print version of RISCV-CONFIG being used
+      --work_dir DIR        The name of the work dir to dump the output files to.
       -h, --help            show this help message and exit
 
-
-
 RISCV_CONFIG for Developers
 ===========================
 

examples/rv32i_isa.yaml

@@ -23,18 +23,6 @@ mvendorid:
       ro_constant: [0xdeadbeef]
   rv64:
     implemented: false
-
-mtime:
-  rv32:
-    implemented: false
-  rv64:
-    implemented: false
-mtimecmp:
-  rv32:
-    implemented: false
-  rv64:
-    implemented: false
-
 mtvec:
   reset-val: 0x80010000
   rv32:

examples/rv64i_isa.yaml

@@ -24,17 +24,6 @@ mvendorid:
     implemented: true
     type:
       ro_constant: [0xdeadbeef]
-mtime:
-  rv32:
-    implemented: false
-  rv64:
-    implemented: false
-mtimecmp:
-  rv32:
-    implemented: false
-  rv64:
-    implemented: false
-
 mtvec:
   reset-val: 0x0000000080000000
   rv64:

riscv_config/__init__.py

@@ -1,3 +1,3 @@
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
-__version__ = "2.0.2"
+__version__ = "2.1.0"

riscv_config/main.py

@@ -1,6 +1,8 @@
 import logging
 import os
+import sys
 import shutil
+from riscv_config import __version__ as version
 import riscv_config.checker as checker
 import riscv_config.utils as utils
 from riscv_config.errors import ValidationError
@@ -13,6 +15,13 @@ def main():
     # Set up the parser
     parser = utils.riscv_config_cmdline_args()
     args = parser.parse_args()
+    if len(sys.argv) < 2:
+        parser.print_help()
+        raise SystemExit
+    if (args.version):
+        print('RISCV-CONFIG: RISC-V Configuration Validator')
+        print('Version: ' + version)
+        return 0
 
     # Set up the logger
     utils.setup_logging(args.verbose)

riscv_config/schemas/schema_isa.yaml

@@ -4111,204 +4111,6 @@ mie:
             implemented: true
       required: true
   required: true
-mtime:
-  type: dict
-  schema:
-    description:
-      type: string
-      default: Memory mapped timer register.
-    address:
-      type: integer
-    priv_mode:
-      type: string
-      allowed:
-      - M
-      default: M
-    reset-val:
-      type: integer
-      check_with: max_length
-      default: 0
-    rv32:
-      type: dict
-      schema:
-        implemented:
-          type: boolean
-          default: false
-          check_with: rv32_check
-        fields:
-          type: list
-          default: []
-        shadow:
-          type: string
-          default: none
-        msb:
-          type: integer
-          default: 63
-          allowed:
-          - 63
-        lsb:
-          type: integer
-          default: 0
-          allowed:
-          - 0
-        type:
-          type: dict
-          check_with: wr_illegal
-          oneof:
-          - schema:
-              ro_constant:
-                type: list
-                schema:
-                  type: integer
-                  max: 4611686018427387903
-                maxlength: 1
-          - schema:
-              ro_variable:
-                type: boolean
-          - schema:
-              warl: *id001
-      default:
-        implemented: false
-    rv64:
-      type: dict
-      schema:
-        implemented:
-          default: false
-          check_with: rv64_check
-        fields:
-          type: list
-          default: []
-        shadow:
-          type: string
-          default: none
-        msb:
-          type: integer
-          default: 63
-          allowed:
-          - 63
-        lsb:
-          type: integer
-          default: 0
-          allowed:
-          - 0
-        type:
-          type: dict
-          check_with: wr_illegal
-          oneof:
-          - schema:
-              ro_constant:
-                type: list
-                schema:
-                  type: integer
-                  max: 4611686018427387903
-                maxlength: 1
-          - schema:
-              ro_variable:
-                type: boolean
-          - schema:
-              warl: *id001
-      default:
-        implemented: false
-  required: true
-mtimecmp:
-  type: dict
-  schema:
-    description:
-      type: string
-      default: Memory mapped timer compare register.
-    address:
-      type: integer
-    priv_mode:
-      type: string
-      allowed:
-      - M
-      default: M
-    reset-val:
-      type: integer
-      default: 0
-      check_with: max_length
-    rv32:
-      type: dict
-      schema:
-        implemented:
-          type: boolean
-          default: false
-          check_with: rv32_check
-        fields:
-          type: list
-          default: []
-        shadow:
-          type: string
-          default: none
-        msb:
-          type: integer
-          default: 63
-          allowed:
-          - 63
-        lsb:
-          type: integer
-          default: 0
-          allowed:
-          - 0
-        type:
-          type: dict
-          check_with: wr_illegal
-          oneof:
-          - schema:
-              ro_constant:
-                type: list
-                schema:
-                  type: integer
-                  max: 4611686018427387903
-                maxlength: 1
-          - schema:
-              ro_variable:
-                type: boolean
-          - schema:
-              warl: *id001
-      default:
-        implemented: false
-    rv64:
-      type: dict
-      schema:
-        implemented:
-          default: false
-          check_with: rv64_check
-        fields:
-          type: list
-          default: []
-        shadow:
-          type: string
-          default: none
-        msb:
-          type: integer
-          default: 63
-          allowed:
-          - 63
-        lsb:
-          type: integer
-          default: 0
-          allowed:
-          - 0
-        type:
-          type: dict
-          check_with: wr_illegal
-          oneof:
-          - schema:
-              ro_constant:
-                type: list
-                schema:
-                  type: integer
-                  max: 4611686018427387903
-                maxlength: 1
-          - schema:
-              ro_variable:
-                type: boolean
-          - schema:
-              warl: *id001
-      default:
-        implemented: false
-  required: true
 mscratch:
   type: dict
   schema:

riscv_config/schemas/schema_platform.yaml

@@ -57,6 +57,69 @@ nmi:
       excludes: ['label']
   required: True
 
+###
+#mtime
+#-----
+#
+# **Description**: Stores the fields for memory mapped *mtime* register.
+#
+#       * implemented: A boolean field indicating that the register has been implemented.
+#       * address: A value equal to the physical address at which the register is present.
+# 
+# **Examples**: 
+# 
+# .. code-block:: yaml
+#
+#   mtime:
+#      implemented: True
+#      address: 0x458
+#
+# **Constraints**: 
+#
+#       - None
+
+mtime:
+  type: dict
+  schema:
+    address:
+      type: integer
+    implemented:
+      type: boolean
+      default: False
+  default:
+    implemented: False
+
+### 
+#mtimecmp
+#--------
+# 
+# **Description**: Stores the fields for memory mapped *mtimecmp* register.
+#
+#       * implemented: A boolean field indicating that the register has been implemented.
+#       * address: A value equal to the physical address at which the register is present.
+# 
+# **Examples**: 
+# 
+# .. code-block:: yaml
+#
+#   mtimecmp:
+#      implemented: True
+#      address: 0x458
+#
+# **Constraints**:
+#
+#       - None
+
+mtimecmp:
+  type: dict
+  schema:
+    address:
+      type: integer
+    implemented:
+      type: boolean
+      default: False
+  default:
+    implemented: False
 
 ###
 #mcause_non_standard
@@ -75,7 +138,8 @@ nmi:
 #      implemented: True
 #      value: [16,17,20]
 #
-# **Constraints**: 
+# **Constraints**:
+#
 #       - None
 
 mcause_non_standard: