rggen 0.16.0 → 0.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +54 -4
- data/lib/rggen/version.rb +1 -1
- metadata +16 -16
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4b0ca89bd97b12fadfdc1e78eb91cad417d4faa07b4c61904cbeaef395d52987
|
4
|
+
data.tar.gz: 37056eff9ac783741b928a4b45440bd1f23cf49fd4a766175e39113e12bd5fda
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 27cdc3cd55728b72d6f9330a9602c63ea705c61b0808031477c822be4a6c6e08015234fc92707e834a82f924e3b29158e1f15259c27d5082a6b6a40c7eda34f5
|
7
|
+
data.tar.gz: 343b959bbcab5b6763ee242cf6908f1c0317e3c65c676534ed0963b2961e0bb2261de3a5497a804260ef9144b02f7a0ff6d8e91c5fc0879b91f06c23ee181b78
|
data/LICENSE
CHANGED
data/README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
[![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
|
2
|
-
[![
|
2
|
+
[![CI](https://github.com/rggen/rggen/workflows/CI/badge.svg)](https://github.com/rggen/rggen/actions?query=workflow%3ACI)
|
3
3
|
[![Maintainability](https://api.codeclimate.com/v1/badges/5ee2248300ec0517e597/maintainability)](https://codeclimate.com/github/rggen/rggen/maintainability)
|
4
4
|
[![codecov](https://codecov.io/gh/rggen/rggen/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen)
|
5
5
|
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen)
|
@@ -7,7 +7,7 @@
|
|
7
7
|
|
8
8
|
# RgGen
|
9
9
|
|
10
|
-
RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers. It will automatically generate soruce code related to
|
10
|
+
RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers. It will automatically generate soruce code related to configuration and status registers (CSR), e.g. SytemVerilog RTL, UVM RAL model, Wiki documents, from human readable register map specifications.
|
11
11
|
|
12
12
|
RgGen has following features:
|
13
13
|
|
@@ -28,7 +28,7 @@ RgGen has following features:
|
|
28
28
|
|
29
29
|
### Ruby
|
30
30
|
|
31
|
-
RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.
|
31
|
+
RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.4 or later. You need to install any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
|
32
32
|
|
33
33
|
### Installatin Command
|
34
34
|
|
@@ -68,6 +68,56 @@ To resolve the above error, there are three solutions. See [this page](https://g
|
|
68
68
|
|
69
69
|
See [Wiki documents](https://github.com/rggen/rggen/wiki).
|
70
70
|
|
71
|
+
## Supported Tools
|
72
|
+
|
73
|
+
Following EDA tools can accept the generated source files.
|
74
|
+
|
75
|
+
* Simulation tools
|
76
|
+
* Synopsys VCS
|
77
|
+
* Cadence Xcelium
|
78
|
+
* Xilinx Vivado Simulator
|
79
|
+
* Confirmed RTL only
|
80
|
+
* Not sure if RAL models are accepted
|
81
|
+
* Verilator
|
82
|
+
* Need `-Wno-fatal` switch
|
83
|
+
* Synthesis tools
|
84
|
+
* Synopsys Design Compiler
|
85
|
+
* Intel Quartus
|
86
|
+
* Xilinx Vivado
|
87
|
+
|
88
|
+
## Example
|
89
|
+
|
90
|
+
You can get example configuration file and register map specification listed below:
|
91
|
+
|
92
|
+
* Configuration file
|
93
|
+
* https://github.com/rggen/rggen-sample/blob/master/config.yml
|
94
|
+
* Register map specifications
|
95
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_0.yml
|
96
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_1.yml
|
97
|
+
|
98
|
+
By using these example files, you can try to use RgGen. Hit command below:
|
99
|
+
|
100
|
+
```
|
101
|
+
$ rggen -c config.yml -o out block_0.yml block_1.yml
|
102
|
+
```
|
103
|
+
|
104
|
+
* `-c`
|
105
|
+
* Specify path to your configuration file
|
106
|
+
* `-o`
|
107
|
+
* Specify path to the directory where generated files will be written to
|
108
|
+
|
109
|
+
Then, generated files listed below will be written to `out` directory.
|
110
|
+
|
111
|
+
* SystemVerilog RTL
|
112
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_0.sv
|
113
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_1.sv
|
114
|
+
* UVM RAL model
|
115
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_0_ral_pkg.sv
|
116
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_1_ral_pkg.sv
|
117
|
+
* Markdown document
|
118
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_0.md
|
119
|
+
* https://github.com/rggen/rggen-sample/blob/master/block_1.md
|
120
|
+
|
71
121
|
## Contact
|
72
122
|
|
73
123
|
Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
|
@@ -88,7 +138,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
|
|
88
138
|
|
89
139
|
## Copyright & License
|
90
140
|
|
91
|
-
Copyright © 2019 Taichi Ishitani. RgGen is licensed
|
141
|
+
Copyright © 2019-2020 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
|
92
142
|
|
93
143
|
## Code of Conduct
|
94
144
|
|
data/lib/rggen/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rggen
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.20.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Taichi Ishitani
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-07-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rggen-core
|
@@ -16,70 +16,70 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 0.20.0
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version:
|
26
|
+
version: 0.20.0
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: rggen-default-register-map
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version:
|
33
|
+
version: 0.20.0
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version:
|
40
|
+
version: 0.20.0
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rggen-markdown
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version:
|
47
|
+
version: 0.17.0
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version:
|
54
|
+
version: 0.17.0
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: rggen-spreadsheet-loader
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version:
|
61
|
+
version: 0.16.0
|
62
62
|
type: :runtime
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
66
|
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version:
|
68
|
+
version: 0.16.0
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: rggen-systemverilog
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
72
72
|
requirements:
|
73
73
|
- - "~>"
|
74
74
|
- !ruby/object:Gem::Version
|
75
|
-
version:
|
75
|
+
version: 0.20.0
|
76
76
|
type: :runtime
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
80
|
- - "~>"
|
81
81
|
- !ruby/object:Gem::Version
|
82
|
-
version:
|
82
|
+
version: 0.20.0
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
84
|
name: bundler
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
@@ -96,7 +96,7 @@ dependencies:
|
|
96
96
|
version: '0'
|
97
97
|
description: |
|
98
98
|
RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers.
|
99
|
-
It will automatically generate soruce code related to
|
99
|
+
It will automatically generate soruce code related to configuration and status registers (CSR),
|
100
100
|
e.g. SytemVerilog RTL, UVM RAL model, Wiki documents, from human readable register map specifications.
|
101
101
|
email:
|
102
102
|
- rggen@googlegroups.com
|
@@ -127,15 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
127
127
|
requirements:
|
128
128
|
- - ">="
|
129
129
|
- !ruby/object:Gem::Version
|
130
|
-
version: '2.
|
130
|
+
version: '2.4'
|
131
131
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
132
132
|
requirements:
|
133
133
|
- - ">="
|
134
134
|
- !ruby/object:Gem::Version
|
135
135
|
version: '0'
|
136
136
|
requirements: []
|
137
|
-
rubygems_version: 3.
|
137
|
+
rubygems_version: 3.1.2
|
138
138
|
signing_key:
|
139
139
|
specification_version: 4
|
140
|
-
summary: Code generation tool for
|
140
|
+
summary: Code generation tool for configuration and status registers
|
141
141
|
test_files: []
|