rggen 0.23.1 → 0.25.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +66 -0
- data/LICENSE +1 -1
- data/README.md +24 -4
- data/lib/rggen/version.rb +1 -1
- data/logo/rggen.png +0 -0
- metadata +16 -14
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d8b877a8a74325abe8615eb98759f7b23c524370803e77e548c7c8ab7247172a
|
4
|
+
data.tar.gz: '0719316a6cd12cb612358f742ae54ff22f3e879ee87d97bf7921f36c9c5fce5e'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4da898a77d0eb5e7badef9e07161e5c2b7502bc3fcad19cf5f20acf3c257019b7a27c2b796c98b1135a1234d1f8e113765a3dc6b8cac09b882c883a37b43d0e
|
7
|
+
data.tar.gz: b93b2a570b9e93439efc78e9f193baf151652be81fbd45694c66a77946a2196f5ba5a22dd231b3b6122d6f64a5b9d01a1885eb9bf411076ff00949de3a9aedca
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
# Contributing
|
2
|
+
|
3
|
+
Your contributions are welcome!
|
4
|
+
|
5
|
+
## Bug Report
|
6
|
+
|
7
|
+
You can submit bug reports on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
|
8
|
+
Please include information below in your report:
|
9
|
+
|
10
|
+
* How to reproduce the bug which you found
|
11
|
+
* test code
|
12
|
+
* command
|
13
|
+
* Information about your environment
|
14
|
+
* Ruby/RgGen version
|
15
|
+
* OS
|
16
|
+
* etc.
|
17
|
+
* Expected result
|
18
|
+
|
19
|
+
## Question
|
20
|
+
|
21
|
+
Questions are accepted on following channels:
|
22
|
+
|
23
|
+
* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
|
24
|
+
* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
|
25
|
+
* [Gitter Chat Room](https://gitter.im/rggen/rggen)
|
26
|
+
|
27
|
+
## Enhancement Request
|
28
|
+
|
29
|
+
You can submit your enhancement request on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
|
30
|
+
|
31
|
+
## Pull Request
|
32
|
+
|
33
|
+
You can also submit pull requests on [GitHub Issue Tracker](https://github.com/rggen/rggen/pulls)
|
34
|
+
to fix the bug which you found or implement enhancements which you want.
|
35
|
+
|
36
|
+
1. Fork the repositories which you will change
|
37
|
+
2. Setup your working environment
|
38
|
+
* See the next section
|
39
|
+
3. Add your change to the repositories
|
40
|
+
* You need to add RSpec exmaples if you add new features
|
41
|
+
* You need to make sure all existing RSpec examples pass
|
42
|
+
* Invoke `rake spec` on the repositry root
|
43
|
+
4. Make sure all existing RSpec exmaples for other repositories pass
|
44
|
+
* Invoke command below on the working directory
|
45
|
+
* `./rggen-devtools/bin/run_all_spec.rb`
|
46
|
+
5. Commit your changes and submit a pull request
|
47
|
+
|
48
|
+
### Setup Working Environment
|
49
|
+
|
50
|
+
1. Create a working directory
|
51
|
+
2. Clone your forked version of the repositories to the working directory
|
52
|
+
3. Clone folloiwng repositories for development tools to the working directory
|
53
|
+
* https://github.com/rggen/rggen-devtools
|
54
|
+
* https://github.com/rggen/rggen-checkout
|
55
|
+
4. Clone other RgGen's repositories
|
56
|
+
* Invoke commnad below on to the working directory
|
57
|
+
* `./rggen-devtools/bin/checkout --list ./rggen-checkout/all.yml --dir .`
|
58
|
+
|
59
|
+
```
|
60
|
+
$ mkdir work
|
61
|
+
$ cd work
|
62
|
+
$ git clone git@github.com:yourname/your_repository.git
|
63
|
+
$ git clone git@github.com:rggen/rggen-devtools.git
|
64
|
+
$ git clone git@github.com:rggen/rggen-checkout.git
|
65
|
+
$ ./rggen-devtools/bin/checkout.rb --list ./rggen-checkout/all.yml --dir .
|
66
|
+
```
|
data/LICENSE
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
The MIT License (MIT)
|
2
2
|
|
3
|
-
Copyright (c) 2019-
|
3
|
+
Copyright (c) 2019-2021 Taichi Ishitani
|
4
4
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
of this software and associated documentation files (the "Software"), to deal
|
data/README.md
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
![RgGen](logo/rggen.png)
|
2
|
+
|
1
3
|
[![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
|
2
4
|
[![CI](https://github.com/rggen/rggen/workflows/CI/badge.svg)](https://github.com/rggen/rggen/actions?query=workflow%3ACI)
|
3
5
|
[![Maintainability](https://api.codeclimate.com/v1/badges/5ee2248300ec0517e597/maintainability)](https://codeclimate.com/github/rggen/rggen/maintainability)
|
@@ -5,6 +7,8 @@
|
|
5
7
|
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen)
|
6
8
|
[![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
7
9
|
|
10
|
+
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A231E3I)
|
11
|
+
|
8
12
|
# RgGen
|
9
13
|
|
10
14
|
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 register model (UVM RAL), Wiki documents, from human readable register map specifications.
|
@@ -15,12 +19,15 @@ RgGen has following features:
|
|
15
19
|
* SystemVerilog RTL
|
16
20
|
* Verilog RTL
|
17
21
|
* Need [rggen-verilog](https://github.com/rggen/rggen-verilog) plugin
|
22
|
+
* VHDL RTL
|
23
|
+
* Need [rggen-vhdl](https://github.com/rggen/rggen-vhdl) plugin
|
18
24
|
* UVM register model (UVM RAL)
|
19
25
|
* Register map documents written in Markdown
|
20
26
|
* Register map specifications can be written in human readable format
|
21
27
|
* Ruby with APIs to describe register map information
|
22
28
|
* YAML
|
23
29
|
* JSON
|
30
|
+
* TOML
|
24
31
|
* Spreadsheet (XLSX, XLS, OSD, CSV)
|
25
32
|
* [SiFive DUH](https://github.com/sifive/duh)
|
26
33
|
* Need [rggen-duh](https://github.com/rggen/rggen-duh) plugin
|
@@ -31,7 +38,7 @@ RgGen has following features:
|
|
31
38
|
|
32
39
|
### Ruby
|
33
40
|
|
34
|
-
RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.
|
41
|
+
RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.5 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/).
|
35
42
|
|
36
43
|
### Installatin Command
|
37
44
|
|
@@ -65,12 +72,18 @@ ERROR: Error installing rggen:
|
|
65
72
|
"rggen" from rggen-core conflicts with installed executable from rggen
|
66
73
|
```
|
67
74
|
|
68
|
-
To resolve the above error, there are three solutions.
|
75
|
+
To resolve the above error, there are three solutions.
|
76
|
+
See [this page](https://github.com/rggen/rggen/wiki/Resolve-Confliction-of-Installed-Executable)
|
69
77
|
|
70
78
|
## Usage
|
71
79
|
|
72
80
|
See [Wiki documents](https://github.com/rggen/rggen/wiki).
|
73
81
|
|
82
|
+
## Plugin
|
83
|
+
|
84
|
+
RgGen has `plugin` feature to allow your cusomization.
|
85
|
+
See [this Wiki document](https://github.com/rggen/rggen/wiki/Create-Your-Own-Plugin) for futher detals.
|
86
|
+
|
74
87
|
## Supported Tools
|
75
88
|
|
76
89
|
Following EDA tools can accept the generated source files.
|
@@ -119,11 +132,16 @@ Then, generated files listed below will be written to `out` directory.
|
|
119
132
|
* https://github.com/rggen/rggen-sample/blob/master/block_0.md
|
120
133
|
* https://github.com/rggen/rggen-sample/blob/master/block_1.md
|
121
134
|
|
135
|
+
## Contributing
|
136
|
+
|
137
|
+
See [Contributing Guide](CONTRIBUTING.md).
|
138
|
+
|
122
139
|
## Contact
|
123
140
|
|
124
141
|
Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
|
125
142
|
|
126
143
|
* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
|
144
|
+
* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
|
127
145
|
* [Chat Room](https://gitter.im/rggen/rggen)
|
128
146
|
* [Mailing List](https://groups.google.com/d/forum/rggen)
|
129
147
|
* [Mail](mailto:rggen@googlegroups.com)
|
@@ -136,11 +154,13 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
|
|
136
154
|
* https://github.com/rggen/rggen-markdown
|
137
155
|
* https://github.com/rggen/rggen-spreadsheet-loader
|
138
156
|
* https://github.com/rggen/rggen-duh
|
157
|
+
* https://github.com/rggen/rggen-verilog
|
158
|
+
* https://github.com/rggen/rggen-vhdl
|
139
159
|
|
140
160
|
## Copyright & License
|
141
161
|
|
142
|
-
Copyright © 2019-
|
162
|
+
Copyright © 2019-2021 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
|
143
163
|
|
144
164
|
## Code of Conduct
|
145
165
|
|
146
|
-
Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](
|
166
|
+
Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
|
data/lib/rggen/version.rb
CHANGED
data/logo/rggen.png
ADDED
Binary file
|
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.25.2
|
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: 2021-05-16 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: 0.
|
19
|
+
version: 0.25.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: 0.
|
26
|
+
version: 0.25.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: 0.
|
33
|
+
version: 0.25.1
|
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: 0.
|
40
|
+
version: 0.25.1
|
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: 0.
|
47
|
+
version: 0.21.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: 0.
|
54
|
+
version: 0.21.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: 0.
|
61
|
+
version: 0.20.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: 0.
|
68
|
+
version: 0.20.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: 0.
|
75
|
+
version: 0.25.1
|
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: 0.
|
82
|
+
version: 0.25.1
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
84
|
name: bundler
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
@@ -105,11 +105,13 @@ extensions: []
|
|
105
105
|
extra_rdoc_files: []
|
106
106
|
files:
|
107
107
|
- CODE_OF_CONDUCT.md
|
108
|
+
- CONTRIBUTING.md
|
108
109
|
- LICENSE
|
109
110
|
- README.md
|
110
111
|
- lib/rggen.rb
|
111
112
|
- lib/rggen/setup.rb
|
112
113
|
- lib/rggen/version.rb
|
114
|
+
- logo/rggen.png
|
113
115
|
homepage: https://github.com/rggen/rggen
|
114
116
|
licenses:
|
115
117
|
- MIT
|
@@ -126,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
126
128
|
requirements:
|
127
129
|
- - ">="
|
128
130
|
- !ruby/object:Gem::Version
|
129
|
-
version: '2.
|
131
|
+
version: '2.5'
|
130
132
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
131
133
|
requirements:
|
132
134
|
- - ">="
|
133
135
|
- !ruby/object:Gem::Version
|
134
136
|
version: '0'
|
135
137
|
requirements: []
|
136
|
-
rubygems_version: 3.
|
138
|
+
rubygems_version: 3.2.3
|
137
139
|
signing_key:
|
138
140
|
specification_version: 4
|
139
141
|
summary: Code generation tool for configuration and status registers
|