rggen 0.30.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d14eb79b4aa6568799c559bc45cf3436529455b24fc429e4ec189db34dc554c5
-  data.tar.gz: ce4d8a598f6f9a4936805b0f4cbdb2db52c89d734215c773f7a1fdf68b553d05
+  metadata.gz: be852aa5d1ddb6e535365f74ef362aaccf3d40fa99af54ae685f218e48cfcb07
+  data.tar.gz: 0430eed7cefbb6c4a71ba3792de6e40b13757b8701a7d0c84376e5242971bb4f
 SHA512:
-  metadata.gz: 1bada8f68a33fbeae389a2de39e66e2caa5155949e36e2f323f12570d0c8d51aec66ce9336e5306377e72554c7af54542a119a5f2b63efc8c111b57c8f3dc5dc
-  data.tar.gz: b60c695a19ea44aebbacb1d0567ad2d4f8124e84ac79f4927f7f8b886826e35440e7213cc4a0aee1178af08326d097d625aeb219f470db81321fedfca1c29ec3
+  metadata.gz: e989301d1c40c7d6aff2db9f2076c30bc8ec8fd4f202c47062f4275d496e80d478036a694edf50b7a10d84a402f391728a7143be13b1b51ec2019be295b4e480
+  data.tar.gz: 04b09ca79adffa909adf0a0627b5d475d445b8fa33bed02655a771150081710fb7cd6819e86637bb932fbdf33c1c312b62828266f95afa1806ca1055423f4790

data/README.md

@@ -82,6 +82,17 @@ ERROR:  Error installing rggen:
 To resolve the above error, there are three solutions.
 See [this page](https://github.com/rggen/rggen/wiki/Resolve-Confliction-of-Installed-Executable)
 
+### Docker Image
+
+The [rggen-docker](https://hub.docker.com/r/rggendev/rggen-docker) is a Docker image to simplify installation and use of RgGen.
+You can also execute RgGen by using this image:
+
+```
+$ docker run -ti --rm -v ${PWD}:/work --user $(id -u):$(id -g) rggendev/rggen-docker:latest -c config.yml -o out block_0.yml
+```
+
+See the [rggen-docker repository](https://github.com/rggen/rggen-docker) for further details.
+
 ## Usage
 
 See [Wiki documents](https://github.com/rggen/rggen/wiki).
@@ -112,39 +123,57 @@ Following EDA tools can accept the generated source files.
 
 ## Example
 
-You can get an example configuration file and register map specifications listed below:
+You can get sample configuration file and register map specification from the [rggen-sample](https://github.com/rggen/rggen-sample) repository.
+This register map specification is for a UART IP.
 
 * Configuration file
     * https://github.com/rggen/rggen-sample/blob/master/config.yml
-* Register map specifications
-    * https://github.com/rggen/rggen-sample/blob/master/block_0.yml
-    * https://github.com/rggen/rggen-sample/blob/master/block_1.yml
+* Register map specification
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.yml
 
 You can try to use RgGen by uisng these example files. Hit command below:
 
 ```
-$ rggen -c config.yml -o out block_0.yml block_1.yml
+$ rggen -c config.yml -o out uart_csr.yml
 ```
 
 * `-c`: Specify path to your configuration file
 * `-o`: Specify path to the directory where generated files will be written to
 
-Then, generated files listed below will be written to `out` directory.
+Then, generated files will be written to the `out` directory.
+
+If you want to generate Verilog RTL and/or VHDL RTL then you need to instll optional plugins listed below.
+
+* Verilog writer plugin: [rggen-verilog](https://github.com/rggen/rggen-verilog)
+* VHDL writer plugin: [rggen-vhdl](https://github.com/rggen/rggen-vhdl)
+
+```
+$ gem install rggen-verilog
+$ gem install rggen-vhdl
+```
+
+In addition, you need to tell RgGen to use these plugins by using the `--plugin` option switch:
+
+```
+rggen -c config.yml --plugin rggen-verilog --plugin rggen-vhdl uart_csr.yml
+```
+
+RgGen will generate following source files from the [`uart_csr.yml`](https://github.com/rggen/rggen-sample/blob/master/uart_csr.yml) register map specification:
 
 * SystemVerilog RTL
-    * https://github.com/rggen/rggen-sample/blob/master/block_0.sv
-    * https://github.com/rggen/rggen-sample/blob/master/block_0_rtl_pkg.sv
-    * https://github.com/rggen/rggen-sample/blob/master/block_1.sv
-    * https://github.com/rggen/rggen-sample/blob/master/block_1_rtl_pkg.sv
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.sv
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr_rtl_pkg.sv
+* Verilog RTL
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.v
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.vh 
+* VHDL RTL
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.vhd 
 * UVM register model
-    * https://github.com/rggen/rggen-sample/blob/master/block_0_ral_pkg.sv
-    * https://github.com/rggen/rggen-sample/blob/master/block_1_ral_pkg.sv
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr_ral_pkg.sv
 * C header file
-    * https://github.com/rggen/rggen-sample/blob/master/block_0.h
-    * https://github.com/rggen/rggen-sample/blob/master/block_1.h
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.h
 * Markdown document
-    * https://github.com/rggen/rggen-sample/blob/master/block_0.md
-    * https://github.com/rggen/rggen-sample/blob/master/block_1.md
+    * https://github.com/rggen/rggen-sample/blob/master/uart_csr.md
 
 ## Contributing
 
@@ -171,6 +200,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 * https://github.com/rggen/rggen-duh
 * https://github.com/rggen/rggen-verilog
 * https://github.com/rggen/rggen-vhdl
+* https://github.com/rggen/rggen-docker
 
 ## Copyright & License
 

data/lib/rggen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RgGen
-  VERSION = '0.30.1'
+  VERSION = '0.31.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.31.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rggen-c-header
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: rggen-default-register-map
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: rggen-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.1
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.1
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Code generation tool for configuration and status registers