kgubbi / CNN_keyword_spotting

Created

Maintained by kgubbi

CNN Hardware Accelerator was designed and implemented using GenAI (ChatGPT 4o) for Keyword Spotting.

Star 0

main 42b959d lvs_violations_check_passed_local

kgubbi committed 4 months ago

Caravel User Project - Keyword Spotting Accelerator

CNN Accelerator Project

Overview

This project implements a Convolutional Neural Network (CNN) accelerator on an ASIC. The design includes modules for managing weights and inputs, performing multiply-accumulate (MAC) operations, summing results with an adder tree, normalizing data, applying ReLU activation, and performing pooling operations. The project is integrated into a top-level wrapper (user_project_wrapper) that interfaces with external pins and a Wishbone bus.

Project Structure

Modules

WeightBuffer
- Description: Stores weights for the CNN operations.
- Ports:
  - clk (input): Clock signal.
  - reset (input): Reset signal.
  - weight_data (input): Weight data to be written.
  - write_enable (input): Write enable signal.
  - write_addr (input): Address to write weight data.
  - weight_out (output): Array of stored weights.
LineBuffer
- Description: Stores input data for the CNN operations.
- Ports:
  - clk (input): Clock signal.
  - reset (input): Reset signal.
  - data_in (input): Input data to be stored.
  - write_enable (input): Write enable signal.
  - write_addr (input): Address to write input data.
  - read_addr (input): Address to read input data.
  - data_out (output): Output data.
MAC
- Description: Performs multiplication of two input values.
- Ports:
  - a (input): First operand.
  - b (input): Second operand.
  - y (output): Product of operands.
MACArray
- Description: Consists of an array of MAC units.
- Ports:
  - a (input): Array of first operands.
  - b (input): Array of second operands.
  - product (output): Array of products.
AdderTree
- Description: Sums multiple inputs to produce a single output.
- Ports:
  - in0 to in7 (input): Input values.
  - sum (output): Sum of inputs.
ConfigurableAdderTree
- Description: Sums products based on a mode (depthwise or pointwise).
- Ports:
  - products (input): Array of product values.
  - sum_mode (input): Mode select (0 for pointwise, 1 for depthwise).
  - final_sum (output): Array of final sums.
Norm (removed from latest version)
- Description: Performs normalization on the input data.
- Ports:
  - data_in (input): Input data.
  - norm_param (input): Normalization parameter.
  - data_out (output): Normalized data.
ReLU
- Description: Applies the ReLU activation function.
- Ports:
  - data_in (input): Input data.
  - data_out (output): Activated data.
Pooling
- Description: Performs average pooling on the input data.
- Ports:
  - data_in0 to data_in3 (input): Input data values.
  - data_out (output): Pooled data.
ControlFSM
- Description: Controls the state transitions and operations of the CNN accelerator.
- Ports:
  - clk (input): Clock signal.
  - reset (input): Reset signal.
  - start (input): Start signal.
  - norm_param (input): Normalization parameter.
  - weight_write_enable, line_write_enable, sum_mode, weight_data, weight_write_addr, line_data, line_write_addr, norm_enable, relu_enable, pool_enable (output): Control signals.
  - done (output): Done signal.
CNN_Accelerator
- Description: Performs the core CNN operations, integrating all the sub-modules.
- Ports:
  - clk, reset, weight_data, weight_write_enable, weight_write_addr, line_data, line_write_enable, line_write_addr, sum_mode, norm_param, norm_enable, relu_enable, pool_enable (input): Control signals.
  - result (output): Result of the CNN operations.
CNN_Accelerator_Top
- Description: Top-level module integrating the ControlFSM, WeightBuffer, and CNN_Accelerator modules.
- Ports:
  - clk, reset, start, norm_param (input): Control signals.
  - result (output): Result of the CNN operations.
  - done (output): Done signal.
user_project_wrapper
- Description: Integrates the CNN_Accelerator_Top into a wrapper that interfaces with external pins and a Wishbone bus.
- Ports:
  - Power, Wishbone bus, Logic Analyzer, IO, Analog, and Clock signals.

File Structure

├── src
│ ├── WeightBuffer.v
│ ├── LineBuffer.v
│ ├── MAC.v
│ ├── MACArray.v
│ ├── AdderTree.v
│ ├── ConfigurableAdderTree.v
│ ├── Norm.v
│ ├── ReLU.v
│ ├── Pooling.v
│ ├── ControlFSM.v
│ ├── CNN_Accelerator.v
│ ├── CNN_Accelerator_Top.v
│ └── user_project_wrapper.v
├── tb
│ └── tb_CNN_Accelerator.sv
├── README.md

This README file provides an overview of the project, descriptions of each module, the file structure, and a sample testbench for verification. You can paste this directly into your GitHub repository's README.md file.

Use of Generative AI (ChatGPT-4) in the CNN Accelerator Project

Generative AI, specifically ChatGPT-4, played a pivotal role in the design, verification, development, and debugging of the CNN Accelerator Project. Leveraging the capabilities of ChatGPT-4 provided several advantages, including accelerating the development process, ensuring accuracy, and enhancing the overall efficiency of the project.

How Generative AI Was Used

Design and Development
- Module Creation: ChatGPT-4 assisted in creating Verilog modules for different components of the CNN accelerator, such as weight buffers, line buffers, MAC units, and more.
- Architecture Design: The AI provided insights and suggestions for optimizing the hardware architecture, ensuring efficient data flow and processing.
- Code Generation: Generated Verilog code snippets for various modules, reducing the manual coding effort and minimizing errors.
Verification
- Testbench Generation: ChatGPT-4 helped in generating testbenches for verifying the functionality of individual modules and the entire system.
- Simulation Guidance: Provided guidance on running simulations and interpreting results, ensuring that the design met the expected performance and functionality.
Debugging and Fixing Code
- Error Diagnosis: Assisted in identifying and diagnosing syntax and logical errors in the Verilog code.
- Code Correction: Suggested fixes and improvements to resolve errors and enhance code robustness.

Steps to Use Generative AI Effectively

To maximize the benefits of Generative AI in hardware design and development, consider the following steps:

Clear and Specific Prompts
- Provide detailed and specific prompts when asking for code generation or debugging help. Clear instructions help the AI understand the requirements better and deliver more accurate results.
Iterative Development
- Use an iterative approach to development. Start with simple designs and gradually add complexity, using Generative AI to verify each step and suggest improvements.
Code Review and Validation
- Always review and validate the code generated by AI. While AI can significantly speed up development, human oversight ensures that the design meets all requirements and standards.
Combining AI with Traditional Methods
- Use Generative AI alongside traditional design and verification methods. AI can handle repetitive and straightforward tasks, freeing up human developers to focus on complex and critical aspects of the project.
Continuous Learning and Adaptation
- Stay updated with the latest advancements in Generative AI and adapt your workflows to incorporate new features and capabilities. This ensures that you are leveraging the full potential of AI in your projects.

Example Workflow

Initial Design: Describe the required module and functionality to the AI and request a basic Verilog implementation.
Verification Setup: Ask the AI to generate a testbench for the module and guide you through running simulations.
Iterative Refinement: Based on simulation results, request modifications and enhancements to the design from the AI.
Debugging: When errors are encountered, provide the error messages to the AI and request assistance in diagnosing and fixing the issues.
Final Integration: Once all modules are verified, ask the AI to help integrate them into the top-level design and generate the final project wrapper.

By following these steps, you can effectively harness the power of Generative AI to streamline the design, verification, development, and debugging processes in hardware projects like the CNN Accelerator.

                                 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.

kgubbi / CNN_keyword_spotting

Source Code

kgubbi / CNN_keyword_spotting

kgubbi

Caravel User Project - Keyword Spotting Accelerator

CNN Accelerator Project

Overview

Project Structure

Modules

File Structure

Use of Generative AI (ChatGPT-4) in the CNN Accelerator Project

How Generative AI Was Used

Steps to Use Generative AI Effectively

Example Workflow