axi_tdl 0.0.7 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ae825b35bd8f0680262cd912deaab26389908ef2ec6714b41ec78cac3396c2
-  data.tar.gz: dac56ef59fba0409fd2be3d416b27ada73f2883148d753cd2c8b77506bc569dc
+  metadata.gz: 54ad63bab726d7657a764ee9ba830d4db48a7f12eda602e79dd25ed24a48290a
+  data.tar.gz: e2251135f036fd5ea2c4c8e4e754afa9ac2e67c3b6283c7685ae341fcd6961d5
 SHA512:
-  metadata.gz: a1418ec55197a4cff6fdbaadfd30b942c7b3ed349c69a0b79d9b8a0ee48c6c6261b8d5b729356e3f41c8a96f10dbd460aead590e3c3a15c06d5de761a905c585
-  data.tar.gz: 8914485b24d7f2233c3c12d47e5cc853642afe31996acb36fcff9035c447a5ec5376d9adbea26c9846207bca02ea0e0bd6e7fab89e1a088007bf7eec13365255
+  metadata.gz: 0037dac29e8452b3719a24647f0f712a3f195721fa71755af8c2f8b6783e110ac18641749ee68db9aa3f52597e29cbf319f9899664a6fef8d9ad27ce6b7265c6
+  data.tar.gz: 246a589f4776261bd265141ea44428b2b532f42589fe59905139f08fcd73751c7da1546cf0445b1e1c3bc24cf413abf813b75e24f4dfa72e4b1e8e6f5bde319f

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake test

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+before_install:
+  - gem install bundler
+  
+rvm:
+  - 2.6
+  - 3.0
+
+script: rake test

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in axi_tdl.gemspec
 gemspec
+
+gem 'rake'
+# gem 'minitest',"~> 5.10"
+# gem 'pry',"~> 0.11"

data/README.EN.md

@@ -0,0 +1,317 @@
+# Axi
+  It is a wonderful library of axi4, but it is not full axi4, It is designed by systemverilog. I compact axi4 and add something to it.
+
+  axi hdl path
+```ruby
+require 'axi_tdl'
+AxiTdl::AXI_PATH
+```
+# Other
+  It contain a simple interface that only define three signals, `valid`, `ready`, and `data`. I think it is useful for design. 
+
+## What is tdl?
+  tdl is a hardware Construction language, it like chisel, but more intresting. It is a DSL and base on ruby. Finally, it convert to systemverilog. And it depend on the axi library of my other github respo.
+
+## What tdl can do?
+  When you write RTL code by tdl, it look like systemverilog. And not only that, you can verify design by tdl. Even more, you can construct `Logic System`, I think it is main difference between tdl and other hardware Construction languages. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'axi_tdl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install axi_tdl
+
+## Code Example
+
+### 1. define module 
+It will create a module of systemverilog that name is `test_module` in current dir.
+```ruby 
+TdlBuild.test_module(__dir__) do
+## Other code
+end
+```
+the sv file look like this
+```systemverilog
+`timescale 1ns/1ps
+module test_module(
+);
+endmodule
+```
+### 2. ports
+```ruby 
+TdlBuild.test_module(__dir__) do 
+    input.clock         - 'clock'
+    input.reset('low')  - 'rst_n'
+    input               - 'd0'
+    input[32]           - 'd32'
+    output[16]          - 'o16'
+    output.logic[8]     - 'o8'
+    output.logic        - 'o1'
+end
+```
+```systemverilog
+module test_module (
+    input             clock,
+    input             rst_n,
+    input             d0,
+    input [31:0]      d32,
+    output [15:0]     o16,
+    output logic[7:0] o8,
+    output logic      o1
+);
+endmodule
+```
+
+## 3. interface
+```ruby 
+TdlBuild.test_interface(__dir__) do 
+
+    input.clock         - 'clock'
+    input.reset('low')  - 'rst_n'
+    input               - 'd0'
+    input[32]           - 'd32'
+    output[16]          - 'o16'
+    output.logic[8]     - 'o8'
+    output.logic        - 'o1'
+
+    port.axis.slaver    - 'axis_in'
+    port.axis.master    - 'axis_out'
+    port.axis.mirror    - 'axis_mirror'
+
+    port.data_c.master  - 'intf_data_inf'
+    port.axi4.slaver    - 'taxi4_inf' 
+
+end 
+```
+```systemverilog
+module test_module (
+    input                   clock,
+    input                   rst_n,
+    input                   d0,
+    input [31:0]            d32,
+    output [15:0]           o16,
+    output logic[7:0]       o8,
+    output logic            o1,
+    axi_stream_inf.slaver   axis_in,
+    axi_stream_inf.master   axis_out,
+    axi_stream_inf.mirror   axis_mirror,
+    data_inf_c.master       intf_data_inf,
+    axi_inf.slaver          taxi4_inf
+);
+end
+```
+## 4. always assign 
+```ruby 
+TdlBuild.test_module(__dir__) do 
+    input.clock         - 'clock'
+    input.reset('low')  - 'rst_n'
+    input               - 'd0'
+    input[32]           - 'd32'
+    output[16]          - 'o16'
+    output.logic[8]     - 'o8'
+    output.logic        - 'o1'
+
+    port.axis.slaver    - 'axis_in'
+    port.axis.master    - 'axis_out'
+    port.axis.mirror    - 'axis_mirror'
+
+    port.data_c.master  - 'intf_data_inf'
+    port.axi4.slaver    - 'taxi4_inf'
+
+
+    always_ff(posedge: clock,negedge: rst_n) do 
+        IF ~rst_n do 
+            o16 <= 0.A 
+        end
+        ELSE do 
+            IF d0 do 
+                o16 <= 1.A 
+            end 
+            ELSE do 
+                o16 <= o16 + 1.b1 
+            end
+        end
+    end
+
+    always_comb do 
+        o8  <= d32[7,0]
+    end
+
+    Assign do 
+        o1  <= 1.b0
+    end
+end
+```
+```systemverilog
+module test_module (
+    input                   clock,
+    input                   rst_n,
+    input                   d0,
+    input [31:0]            d32,
+    output [15:0]           o16,
+    output logic[7:0]       o8,
+    output logic            o1,
+    axi_stream_inf.slaver   axis_in,
+    axi_stream_inf.master   axis_out,
+    axi_stream_inf.mirror   axis_mirror,
+    data_inf_c.master       intf_data_inf,
+    axi_inf.slaver          taxi4_inf
+);
+
+always_ff@(posedge clock,negedge rst_n) begin 
+    if(~rst_n)begin
+         o16 <= '0;
+    end
+    else begin
+        if(d0)begin
+             o16 <= '1;
+        end
+        else begin
+             o16 <= ( o16+1'b1);
+        end
+    end
+end
+
+always_comb begin 
+     o8 = d32[7:0];
+end
+
+assign  o1 = 1'b0;
+
+endmodule
+```
+## 5. generate
+```ruby
+TdlBuild.test_generate(__dir__) do 
+    parameter.NUM       8
+    input[8]            - 'ain'
+    output[8]           - 'bout'
+
+    input[param.NUM,6]  - 'cin'
+    output[6,param.NUM] - 'dout'
+
+    input[param.NUM]    - 'ein'
+    output[param.NUM]   - 'fout'
+
+    generate(8) do |kk|
+        Assign do 
+            bout[kk]    <= ain[7-kk]
+        end
+    end
+
+    generate(param.NUM) do |cc|
+        IF cc < 4 do
+            Assign do  
+                dout[cc]    <= cin[cc]
+            end
+        end
+        ELSE do 
+            Assign do 
+                dout[cc]    <= cin[cc] + cc 
+            end
+        end
+    end
+
+    generate(param.NUM,6) do |ii,gg|
+        Assign do 
+            fout[ii][gg]    <= ein[gg][ii]
+        end
+    end
+end
+```
+```systemverilog
+module test_generate #(
+    parameter  NUM = 8
+)(
+    input [7:0]       ain,
+    output [7:0]      bout,
+    input [5:0]       cin  [NUM-1:0],
+    output [ NUM-1:0] dout [6-1:0],
+    input [ NUM-1:0]  ein,
+    output [ NUM-1:0] fout
+);
+
+generate
+for(genvar KK0=0;KK0 < 8;KK0++)begin
+    assign  bout[ KK0] = ain[ 7-( KK0)];
+end
+endgenerate
+
+generate
+for(genvar KK0=0;KK0 < NUM;KK0++)begin
+
+    if( KK0<4)begin
+        assign  dout[ KK0] = cin[ KK0];
+    end 
+    else begin
+        assign  dout[ KK0] = ( cin[ KK0]+( KK0));
+    end
+end
+endgenerate
+
+generate
+for(genvar KK0=0;KK0 < NUM;KK0++)begin
+    for(genvar KK1=0;KK1 < 6;KK1++)begin
+        assign  fout[ KK0][ KK1] = ein[ KK1][ KK0];
+    end
+end
+endgenerate
+
+endmodule
+```
+
+## 6. combin logic
+```ruby
+TdlBuild.test_logic_combin(__dir__) do 
+    logic[7]    - 'a0'
+    logic[5]    - 'a1'
+    logic[9]    - 'a2'
+    logic[9+5+7]    - 'ca'
+
+    logic[2,8]  - 'b0'
+    logic[16]   - 'b1'
+    logic[32]   - 'cb'
+
+    logic[1,8]  - 'c0'
+    logic[3,8]  - 'c1'
+    logic[2,16] - 'cc'
+
+    Assign do 
+        ca <= logic_bind_(a0, a1, a2)
+        cb <= self.>>(b1, b0)
+        cc <= self.<<(c0, c1)
+    end
+end
+```
+```systemverilog
+module test_logic_combin ();
+
+logic [7-1:0]  a0 ;
+logic [5-1:0]  a1 ;
+logic [9-1:0]  a2 ;
+logic [21-1:0]  ca ;
+logic [8-1:0]  b0[2-1:0] ;
+logic [16-1:0]  b1 ;
+logic [32-1:0]  cb ;
+logic [8-1:0]  c0[1-1:0] ;
+logic [8-1:0]  c1[3-1:0] ;
+logic [16-1:0]  cc[2-1:0] ;
+
+assign  ca = {a0,a1,a2};
+assign  cb = {>>{b1,b0}};
+assign  cc = {<<{c0,c1}};
+
+endmodule
+```
+
+

data/README.md

@@ -1,47 +1,53 @@
 # Axi
-  It is a wonderful library of axi4, but it is not full axi4, It is designed by systemverilog. I compact axi4 and add something to it. 
-# Other
-  It contain a simple interface that only define three signals, `valid`, `ready`, and `data`. I think it is useful for design. 
+  axi是一个 axi4 拓展库，它使用的是删减版的AXI4协议，使用systemverilog开发，除此外我还拓展了AXI4的一些信号。
 
-## What is tdl?
-  tdl is a hardware Construction language, it like chisel, but more intresting. It is a DSL and base on ruby. Finally, it convert to systemverilog. And it depend on the axi library of my other github respo.
+  axi hdl 所在路径可以如下Ruby 脚本获取
+```ruby
+require 'axi_tdl'
+AxiTdl::AXI_PATH
+```
+# 其他
+  此库还包含一个简单的接口定义, 接口信号只有 `valid`, `ready`, 和 `data`. 对于一些轻量设计很有帮助。
+
+## tdl 是什么？
+  tdl 是一种硬件构造语言, 和chisel类似, 但是更加有趣, 他是一种基于Ruby的DSL. 最终它会编译输出systemverilog。 tdl也是基于axi库做的设计。这两部分都包含这此gem包中。
 
-## What tdl can do?
-  When you write RTL code by tdl, it look like systemverilog. And not only that, you can verify design by tdl. Even more, you can construct `Logic System`, I think it is main difference between tdl and other hardware Construction languages. 
+## tdl 能做什么？
+  使用tdl做设计开发, 语法类似systemverilog，这样更亲切。不止于此, tdl加入了大量的验证语法。tdl创建的初衷就是为了快速构建`逻辑系统`, 这就是tdl和其他硬件构造语言最大的区别。
 
-## Installation
+## 安装
 
-Add this line to your application's Gemfile:
+ Gemfile中添加:
 
 ```ruby
 gem 'axi_tdl'
 ```
 
-And then execute:
+然后执行:
 
     $ bundle
 
-Or install it yourself as:
+或则通过gem命令安装:
 
     $ gem install axi_tdl
 
-## Code Example
+## 代码示例
 
-### 1. define module 
-It will create a module of systemverilog that name is `test_module` in current dir.
+### 1. 定义模块 
+在当前tdl所在的路径创建一个systemverilog模块文件，模块名为 `test_module`.
 ```ruby 
 TdlBuild.test_module(__dir__) do
 ## Other code
 end
 ```
-the sv file look like this
+输出的systemverilog 文件如下：
 ```systemverilog
 `timescale 1ns/1ps
 module test_module(
 );
 endmodule
 ```
-### 2. ports
+### 2. 端口
 ```ruby 
 TdlBuild.test_module(__dir__) do 
     input.clock         - 'clock'
@@ -66,7 +72,7 @@ module test_module (
 endmodule
 ```
 
-## 3. interface
+## 3. 接口
 ```ruby 
 TdlBuild.test_interface(__dir__) do 
 
@@ -264,7 +270,7 @@ endgenerate
 endmodule
 ```
 
-## 6. combin logic
+## 6. 合并 logic
 ```ruby
 TdlBuild.test_logic_combin(__dir__) do 
     logic[7]    - 'a0'