LDPC_5G

LDPC Encoder Decoder


In order to interact with this project, make sure you have provided your ssh key here.

By convention, the original / primary remote repository is called origin.

Instructions

Local Project Setup - Git Commands

If you are starting a brand new project without a local repository, here are the suggested Git commands:

git clone ssh://git@repositories.efabless.com/manishmahajan/LDPC_5G.git
cd LDPC_5G
... do some changes
git push -u origin main

If you already have a local Git repository, initialized with git init, you will need to associate your local repository with the Efabless Repository remote location. The following Git commands will add Efabless Repository as a remote repository and push your changes to the main branch.

git remote add origin ssh://git@repositories.efabless.com/manishmahajan/LDPC_5G.git
git pull origin main --rebase --allow-unrelated-histories
git push -u origin main

If you already have a remote repository, for example one on GitHub, use the Git command below to add another remote Git repo (make sure that each repo has its unique ID, e.g. origin, ef-repo in the example below).

git remote add ef-repo ssh://git@repositories.efabless.com/manishmahajan/LDPC_5G.git
git push -u ef-repo main --force

How To Update Your Project Cover Image

A default cover.png has already been added to the root directory of this remote repository.

If your project is not private, this image can be viewed in the project search results list.

To show your own cover image, replace cover.png with a file called 'cover' and an allowed image extension ('.jpg', '.jpeg', '.png', '.gif', '.webp') and then push your changes.

(Maximum allowed file size: 1 MB)


This is a LDPC Project for 5g lower matrix

LDPC_Project

LDPC Project is a sample smaller version of the design that is optimized using a SRAM to have low area. This increases the simulation time, as every iteration takes more number of clocks to do one step at a time, but it is still fast enough to correct errors. There is 4ms delay for sequential decoding with 13 iterations to converge at 40MHz. each iteration is 310,516,666ps there are 13 iterations 4,081,550,000ps for convergence at 40MHz. encoding 790,475,000ps to encode the code-word at 40MHz. Encoding takes 0.8ms to encode at 40MHz. This time is fixed for any code-word. It takes 4ms to complete the task of correcting errors for a LDPC(208,168,40) codeblock at clock frequency of 40MHz.

Synthesis runs at 20 KHz for 13um

Typically the code converges from 8 to 12 iterations. With implementatio using SRAMS the area utilization is lower SRAMS LDPC Design takes 12421 clock ticks per iteration For parallel LDPC Design it takes 23 clock per iteration The area utilization is higher in parallel LDPC design. This design can operate at very high frequency clocks.

The design for 5 clocks per iteration, with upto maximum required loops of 12 the number of clocks required are 60 clocks, at a clock which can be as fast as 1.2 GHz or more.

The slower design is for proof of concept, though can be used for 5G. For 6G the same matrices can be used with the faster design to get high throughput.

The matrices for 5G,6G are...

| | | | |

sr. No. alist filename n k
NR.1 . NewRadio_1_0_128.alist 8704 5888
NR.2 . NewRadio_1_0_16.alist 1088 736
NR.3 . NewRadio_1_0_2.alist 136 92
NR.4 . NewRadio_1_0_256.alist 17408 11776
NR.5 . NewRadio_1_0_32.alist 2176 1472
NR.6 . NewRadio_1_0_4.alist 272 184
NR.7 . NewRadio_1_0_64.alist 4352 2944
NR.8 . NewRadio_1_0_8.alist 544 368
NR.9 . NewRadio_1_1_12.alist 816 552
NR.10 . NewRadio_1_1_192.alist 13056 8832
NR.11 . NewRadio_1_1_24.alist 1632 1104
NR.12 . NewRadio_1_1_3.alist 204 138
NR.13 . NewRadio_1_1_384.alist 26112 17664
NR.14 . NewRadio_1_1_48.alist 3264 2208
NR.15 . NewRadio_1_1_6.alist 408 276
NR.16 . NewRadio_1_1_96.alist 6528 4416
NR.17 . NewRadio_1_2_10.alist 680 460
NR.18 . NewRadio_1_2_160.alist 10880 7360
NR.19 . NewRadio_1_2_20.alist 1360 920
NR.20 . NewRadio_1_2_320.alist 21760 14720
NR.21 . NewRadio_1_2_40.alist 2720 1840
NR.22 . NewRadio_1_2_5.alist 340 230
NR.23 . NewRadio_1_2_80.alist 5440 3680
NR.24 . NewRadio_1_3_112.alist 7616 5152
NR.25 . NewRadio_1_3_14.alist 952 644
NR.26 . NewRadio_1_3_224.alist 15232 10304
NR.27 . NewRadio_1_3_28.alist 1904 1288
NR.28 . NewRadio_1_3_56.alist 3808 2576
NR.29 . NewRadio_1_3_7.alist 476 322
NR.30 . NewRadio_1_4_144.alist 9792 6624
NR.31 . NewRadio_1_4_18.alist 1224 828
NR.32 . NewRadio_1_4_288.alist 19584 13248
NR.33 . NewRadio_1_4_36.alist 2448 1656
NR.34 . NewRadio_1_4_72.alist 4896 3312
NR.35 . NewRadio_1_4_9.alist 612 414
NR.36 . NewRadio_1_5_11.alist 748 506
NR.37 . NewRadio_1_5_176.alist 11968 8096
NR.38 . NewRadio_1_5_22.alist 1496 1012
NR.39 . NewRadio_1_5_352.alist 23936 16192
NR.40 . NewRadio_1_5_44.alist 2992 2024
NR.41 . NewRadio_1_5_88.alist 5984 4048
NR.42 . NewRadio_1_6_104.alist 7072 4784
NR.43 . NewRadio_1_6_13.alist 884 598
NR.44 . NewRadio_1_6_208.alist 14144 9568
NR.45 . NewRadio_1_6_26.alist 1768 1196
NR.46 . NewRadio_1_6_52.alist 3536 2392
NR.47 . NewRadio_1_7_120.alist 8160 5520
NR.48 . NewRadio_1_7_15.alist 1020 690
NR.49 . NewRadio_1_7_240.alist 16320 11040
NR.50 . NewRadio_1_7_30.alist 2040 1380
NR.51 . NewRadio_1_7_60.alist 4080 2760
----------- ----------------------- ----------- ------------------
NR.52 . NewRadio_2_0_128.alist 6656 5376
NR.53 . NewRadio_2_0_16.alist 832 672
NR.54 . NewRadio_2_0_2.alist 104 84
NR.55 . NewRadio_2_0_256.alist 13312 10752
NR.56 . NewRadio_2_0_32.alist 1664 1344
+----- used in this
v----- design...
NR.57 . NewRadio_2_0_4.alist 208 168
NR.58 . NewRadio_2_0_64.alist 3328 2688
NR.59 . NewRadio_2_0_8.alist 416 336
NR.60 . NewRadio_2_1_12.alist 624 504
NR.61 . NewRadio_2_1_192.alist 9984 8064
NR.62 . NewRadio_2_1_24.alist 1248 1008
NR.63 . NewRadio_2_1_3.alist 156 126
NR.64 . NewRadio_2_1_384.alist 19968 16128
NR.65 . NewRadio_2_1_48.alist 2496 2016
NR.66 . NewRadio_2_1_6.alist 312 252
NR.67 . NewRadio_2_1_96.alist 4992 4032
NR.68 . NewRadio_2_2_10.alist 520 420
NR.69 . NewRadio_2_2_160.alist 8320 6720
NR.70 . NewRadio_2_2_20.alist 1040 840
NR.71 . NewRadio_2_2_320.alist 16640 13440
NR.72 . NewRadio_2_2_40.alist 2080 1680
NR.73 . NewRadio_2_2_5.alist 260 210
NR.74 . NewRadio_2_2_80.alist 4160 3360
NR.75 . NewRadio_2_3_112.alist 5824 4704
NR.76 . NewRadio_2_3_14.alist 728 588
NR.77 . NewRadio_2_3_224.alist 11648 9408
NR.78 . NewRadio_2_3_28.alist 1456 1176
NR.79 . NewRadio_2_3_56.alist 2912 2352
NR.80 . NewRadio_2_3_7.alist 364 294
NR.81 . NewRadio_2_4_144.alist 7488 6048
NR.82 . NewRadio_2_4_18.alist 936 756
NR.83 . NewRadio_2_4_288.alist 14976 12096
NR.84 . NewRadio_2_4_36.alist 1872 1512
NR.85 . NewRadio_2_4_72.alist 3744 3024
NR.86 . NewRadio_2_4_9.alist 468 378
NR.87 . NewRadio_2_5_11.alist 572 462
NR.88 . NewRadio_2_5_176.alist 9152 7392
NR.89 . NewRadio_2_5_22.alist 1144 924
NR.90 . NewRadio_2_5_352.alist 18304 14784
NR.91 . NewRadio_2_5_44.alist 2288 1848
NR.92 . NewRadio_2_5_88.alist 4576 3696
NR.93 . NewRadio_2_6_104.alist 5408 4368
NR.94 . NewRadio_2_6_13.alist 676 546
NR.95 . NewRadio_2_6_208.alist 10816 8736
NR.96 . NewRadio_2_6_26.alist 1352 1092
NR.97 . NewRadio_2_6_52.alist 2704 2184
NR.98 . NewRadio_2_7_120.alist 6240 5040
NR.99 . NewRadio_2_7_15.alist 780 630
NR.100 . NewRadio_2_7_240.alist 12480 10080
NR.101 . NewRadio_2_7_30.alist 1560 1260
NR.102 . NewRadio_2_7_60.alist 3120 2520

ENV setup

env.bash env.tcsh

Project Structure

module git@github.com:manish03/LDPCENCDEC.git sub modules: git@github.com:rggen/rggen-verilog-rtl.git git@github.com:mattvenn/openlane_summary.git git@repositories.efabless.com:manishmahajan/LDPC_ENC_DEC.git

Simulation can be run using the script

LDPCENCDEC/run.sh

For Synthesis use the script

Makefile in LDPCENCDEC/openlane/

ip_files

are present in the LDPCENCDEC/verilog/rtl directory.

design files

are present in LDPCENCDEC/verilog/rtl/LDPC_ENC_DEC directory

NOTE: Current design file examples are provided for initial reference. These files are currently being updated and will be reposted once complete. The simulations are working, gds has been created successfully.

C Program sample

A C program with an example for stimulus which will be encoded, error insertion and decoding has been provided at LDPCENCDEC/verilog/dv/wb_port/wb_port.c

FROM --platform=linux/amd64 ubuntu:focal
RUN apt update; apt install -y curl jq build-essential python3.8 python3-pip docker-compose jsonnet bison mercurial
RUN ln -s /usr/bin/python3.8 /usr/bin/python
RUN curl -OL https://golang.org/dl/go1.17.linux-amd64.tar.gz; mkdir /etc/golang; tar -xvzf go1.17.linux-amd64.tar.gz -C /etc/golang; ln -s /etc/golang/go/bin/go /usr/bin/go; rm -f go1.17.linux-amd64.tar.gz
RUN GO111MODULE="on" go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb; ln -s $(go env GOPATH)/bin/jb /usr/bin/jb
RUN apk add libc6-compat
WORKDIR /workspace
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.