Difference between revisions of "BeagleBoard/GSoC/2021 Proposal/OmkarBhilare"

From eLinux.org
Jump to: navigation, search
(Experience and approach)
(Proposal for Beaglewire Software)
 
(19 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
''Mentors'': [https://elinux.org/User:M_w Michael Welling]<br>
 
''Mentors'': [https://elinux.org/User:M_w Michael Welling]<br>
 
''Proposal'':[https://elinux.org/BeagleBoard/GSoC/2021_Proposal/OmkarBhilare BeagleWire Software]<br>
 
''Proposal'':[https://elinux.org/BeagleBoard/GSoC/2021_Proposal/OmkarBhilare BeagleWire Software]<br>
''Code'': N/A<br>
+
''Code'': [https://github.com/ombhilare999/BeagleWire BeagleWire Code]
''Wiki'': N/A<br>
+
''Wiki'': [https://ombhilare999.github.io/GSoC-2021/ BeagleWire Software]
''GSoC'': N/A<br>
+
''GSoC'': [https://summerofcode.withgoogle.com/projects/#4845032915337216 BeagleWire GSoC Project]
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
  
 
=Status=
 
=Status=
This project is currently just a proposal.
+
This project is Selected for GSoC 2021. <br>
 +
Logs can be found here: https://ombhilare999.github.io/GSoC-2021/
  
 
=Proposal=
 
=Proposal=
Line 63: Line 64:
 
The steps give on [https://elinux.org/BeagleBoard/BeagleWire#Quick_Start_Guide Quick Start Guide]: <br>
 
The steps give on [https://elinux.org/BeagleBoard/BeagleWire#Quick_Start_Guide Quick Start Guide]: <br>
 
* To generate the bitstream I'm going to first try the existing [https://github.com/mwelling/BeagleWire/blob/master/load_fw/fpga-load.c fpga-load] script which leverages the FPGA manager, which is the core that exports a set of functions for programming an FPGA with an Image.
 
* To generate the bitstream I'm going to first try the existing [https://github.com/mwelling/BeagleWire/blob/master/load_fw/fpga-load.c fpga-load] script which leverages the FPGA manager, which is the core that exports a set of functions for programming an FPGA with an Image.
==== LiteDRAM: ====
+
==== LiteDRAM ====
 
1. LiteDRAM provides a small footprint and configurable DRAM core. The configuration of LiteDRAM can be changed using yml input. The [https://github.com/enjoy-digital/litedram/tree/master/examples examples] given the repository as follows:<br>
 
1. LiteDRAM provides a small footprint and configurable DRAM core. The configuration of LiteDRAM can be changed using yml input. The [https://github.com/enjoy-digital/litedram/tree/master/examples examples] given the repository as follows:<br>
  
Line 106: Line 107:
 
0 | 1 | 2 | 3 | GND | 3.3V
 
0 | 1 | 2 | 3 | GND | 3.3V
 
</pre>
 
</pre>
2. So to use PMODs with BeagleWire One needs to connect the PMOD upside down or use some sort of Breakout Board. I found this Breakout madeout especially for BeagleWire: [https://github.com/CapableRobot/PMOD-Adapters#cr7csz-beaglewire-to-pmod BeagleWire to PMOD]<br>
+
2. So to use PMODs with BeagleWire One needs to connect the PMOD upside down or use some sort of Breakout Board. I found this Breakout made out especially for BeagleWire: [https://github.com/CapableRobot/PMOD-Adapters#cr7csz-beaglewire-to-pmod BeagleWire to PMOD]<br>
 
3. Using this Breakout board I will be Interfacing New PMODs to BeagleWire, changes will be done in the current pcf file for GPIO position if found wrong.
 
3. Using this Breakout board I will be Interfacing New PMODs to BeagleWire, changes will be done in the current pcf file for GPIO position if found wrong.
 +
 +
==== Hardware Needed ====
 +
 +
#BeagleWire
 +
#BeagleBone Black / BeagleBone Black Wireless
 +
#Various PMODs
 +
#PMOD Breakout Board
  
 
===Timeline===
 
===Timeline===
Provide a development timeline with a milestone each of the 11 weeks and any pre-work. (A realistic timeline is critical to our selection process.)
+
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 137: Line 145:
 
| June 28 || Milestone #3 ||
 
| June 28 || Milestone #3 ||
 
*Testing the SDRAM in Hardware.
 
*Testing the SDRAM in Hardware.
 +
*Understand and try to solve the Issues related to SDRAM on the BeagleWire repo:
 +
#[https://github.com/pmezydlo/BeagleWire/issues/7 sdram read results are occasionally wrong #7] <br>
 +
#[https://github.com/pmezydlo/BeagleWire/issues/8 sdram rd_busy should be rd_ready? #8] <br>
 +
#[https://github.com/pmezydlo/BeagleWire/issues/10 sdram can miss command transitions #10] <br>
 +
*In case of any issues arises in LiteDRAM Core also check the backup of Advanced SDRAM Controller on Lattice Sites.
 
|-
 
|-
 
| July 5 || Milestone #4 ||
 
| July 5 || Milestone #4 ||
 +
*Test and Improve Following Subsystems:
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/spi ''SPI'']
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/uart ''UART'']
 
|-
 
|-
| July 5 || Milestone #5 ||
+
| July 12 - 16, 2021 || Milestone #5(First Evaluation) ||  
 +
*Demonstrating the use of SDRAM on BeagleWire, SPI, and UART
 +
*After the review from the mentor, finalizing and Documenting Everything done till now
 
|-
 
|-
| July 5 || Milestone #6 ||
+
| July 23 || Milestone #6 ||  
 +
*Test and Improve Following Subsystems:
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/pwm ''PWM''] (Write Servo Code using PWM)
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/i2c ''I2C'']
 
|-
 
|-
| July 5 || Milestone #7 ||
+
| July 30 || Milestone #7 ||
 +
*Test the other Examples provided in the BeagleWire Repo:
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/stepper_motor stepper motor]
 +
#[https://github.com/pmezydlo/BeagleWire/tree/master/examples/lcd_game lcd_game]
 +
*Add New Examples for the BeagleWire using updated subsystem codes.
 
|-
 
|-
| July 5 || Milestone #8 ||
+
| August 6 || Milestone #8 ||
 +
*Interface Various PMODs with BeagleWire.
 +
*Use the Breakout Board with Beaglewire for Hardware testing of PMODs.
 
|-
 
|-
| July 5 || Milestone #9 ||
+
| August 16 || Milestone #9 ||
 +
*Solve all the issues opened on the BeagleWire Repo: [https://github.com/pmezydlo/BeagleWire/issues Issues]
 +
*Document Everything Until Now.
 +
*Add final About page.
 
|-
 
|-
| July 5 || Milestone #10 ||
+
| August 21 || Milestone #10 ||
 +
*Submit final work product and final mentor evaluation
 +
*Completion YouTube video
 
|-
 
|-
| August 3 || Milestone #11, Completion YouTube video
+
| August 31 || Milestone #11 ||
|-
+
*Completion of GSoC
| August 10 - 17 18:00 UTC || Final week: Students submit their final work product and their final mentor evaluation
 
|-
 
| August 17 - 24 18:00 UTC || Mentors submit final student evaluations
 
 
|}
 
|}
  
Line 170: Line 199:
  
 
===Contingency===
 
===Contingency===
What will you do if you get stuck on your project and your mentor isn’t around?
+
if I get stuck on my project and my mentor isn’t around, I will use the following resources:<br>
 +
#Getting Started Guide for BeagleBone by derek molloy: [http://derekmolloy.ie/beaglebone http://derekmolloy.ie/beaglebone]
 +
*Current Github Repos:
 +
#[https://github.com/pmezydlo/BeagleWire https://github.com/pmezydlo/BeagleWire]
 +
#[https://github.com/mwelling/BeagleWire https://github.com/mwelling/BeagleWire]
 +
#[https://github.com/osresearch/BeagleWire https://github.com/osresearch/BeagleWire]
 +
*Documentation on the pmezydlo repo of BeagleWire: [https://github.com/pmezydlo/BeagleWire/tree/master/documentation Documentation]
 +
*[https://elinux.org/BeagleBoard/BeagleWire BeagleWire Page]
  
 
===Benefit===
 
===Benefit===
If successfully completed, what will its impact be on the BeagleBoard.org community? Include quotes from BeagleBoard.org community members who can be found on http://beagleboard.org/discuss and http://bbb.io/gsocchat.
+
''The completed project will provide the BeagleBoard.org community with easy to implement and powerful tools for the realization of projects based on Programmable Logic Device(FPGA), which will surely increase the number of applications based on it. The developed software will be easy and, at the same time, efficient tool for communication with FPGA. At this point, FPGA will be able to meet the requirements of even more advanced applications. The BeagleWire creates a powerful and versatile digital cape for users to create their imaginative digital designs.''
 
 
==Misc==
 
Please complete the requirements listed on the [[BeagleBoard/GSoC/Ideas#General_requirements|ideas page]]. Provide link to pull request.
 
 
 
===Suggestions===
 
Is there anything else we should have asked you?
 

Latest revision as of 09:54, 2 June 2021


Proposal for Beaglewire Software

About Student: Omkar Bhilare
Mentors: Michael Welling
Proposal:BeagleWire Software
Code: BeagleWire Code Wiki: BeagleWire Software GSoC: BeagleWire GSoC Project

Status

This project is Selected for GSoC 2021.
Logs can be found here: https://ombhilare999.github.io/GSoC-2021/

Proposal

  • Completed All the requirements listed on the ideas page.
  • The PR request for cross-compilation task: #154.

About you

IRC: Omkar Bhilare [@ombhilare99:matrix.org]
Github: ombhilare999
School: Veermata Jijabai Technological Institute
Country: India
Primary language : English, Hindi, Marathi
Typical work hours: 10AM-8PM Indian Standard Time
Previous GSoC participation: This is my first time applying for GSoC, I'm an Electronics enthusiast and have a great interest in fields like FPGA, Digital VLSI, Computer Architecture. I have experienced with Intel's Quartus, Xilinx's vivado, and opensource toolchains for ice40. I have also done many projects related to Cyclone2, Upduino3.0(ICE40), Sipeed Tang Primer FPGA.

About your project

  • Project name: Beaglewire Software

Description

Introduction

The BeagleWire is an FPGA development platform that has been designed for use with BeagleBone boards. BeagleWire is a cape on which there is an FPGA device (Lattice iCE40HX). The software support for BeagleWire is still in the development phase. In this project, I'm developing and testing the existing software support of Beaglewire.
The known primary issue in Beaglewire is the interface between 32MB SDRAM and ICE40HX4K. For this Solution, I'm going to try options like LiteDRAM(a small footprint and configurable DRAM core) or Advanced SDRAM controller provided by LATTICE.

Why LiteDRAM for SDRAM Control

The Core produced by LiteDRAM is
1. Fully pipelined, high performance.
2. Configurable commands depth on bankmachines.
3. Auto-Precharge.
4. Periodic refresh/ZQ short calibration (up to 8 postponed refreshes).
(;LiteDRAM is already used in commercial and open-source designs)

Testing and Improvement of Subsystem Like I2C, SPI, PWM, UART

In this project I'm going to test all the subsystems like I2C, SPI, PWM, UART in Hardware and the primary goal will be to debug the issues related to it and fix them accordingly. Along with the driver code ready to use solutions will be added in software support.

  • I2C: There are two grove Connectors on BeagleWire for I2C, I will test the current Verilog Code of I2C in hardware, and will found out if further improvements can be done or not.
  • UART: The existing code of Uart will be tested in hardware, and few examples also will be added for UART.
  • PWM: New Example will be created for testing of PWM. Servo Code will serve the purpose of testing the PWM drivers.

Others

  • There are current Issues open on BeagleWire Repository, These will be solved during this project.
  • More PMODs will be interfaced with the BeagleWire.
  • Increase the Documentation and also add getting started guide for BeagleWire.

Details of Implementation

  • First of all, I need to load a pre-prepared BBB image to beagle with existing all required drivers and scripts to start BeagleWire development.

The steps give on Quick Start Guide:

  • To generate the bitstream I'm going to first try the existing fpga-load script which leverages the FPGA manager, which is the core that exports a set of functions for programming an FPGA with an Image.

LiteDRAM

1. LiteDRAM provides a small footprint and configurable DRAM core. The configuration of LiteDRAM can be changed using yml input. The examples given the repository as follows:

#
# This file is part of LiteDRAM.
#
# Copyright (c) 2018-2019 Florent Kermarrec <florent@enjoy-digital.fr>
# SPDX-License-Identifier: BSD-2-Clause

{
    # General ------------------------------------------------------------------
    "cpu":        "vexriscv",  # Type of CPU used for init/calib (vexriscv, lm32)
    "speedgrade": -1,          # FPGA speedgrade
    "memtype":    "DDR2",      # DRAM type
.
.
.

2. This configuration can be changed for this application that is memory type to SDRAM and CPU None:

cpu=None

Testing of Subsystems

1. For this I need to synthesize the Verilog code first using IceStorm Toolchains, I will be first referring to the steps mentioned in the BeagleWire Documentation:
Synthesizing Verilog Code using Icestorm Toolchains
2. Using this I can test the driver codes in hardware and observe the waveforms on DSO if needed.

PMOD Support

1. The BeagleWire has the PMOD connectors reversed from the "Standard" template.
The standard template is as follows:

3.3V | GND | 3 | 2 | 1 | 0
3.3V | GND | 7 | 6 | 5 | 4

The pinout for BeagleWire PMOD:

4 | 5 | 6 | 7 | GND | 3.3V
0 | 1 | 2 | 3 | GND | 3.3V

2. So to use PMODs with BeagleWire One needs to connect the PMOD upside down or use some sort of Breakout Board. I found this Breakout made out especially for BeagleWire: BeagleWire to PMOD
3. Using this Breakout board I will be Interfacing New PMODs to BeagleWire, changes will be done in the current pcf file for GPIO position if found wrong.

Hardware Needed

  1. BeagleWire
  2. BeagleBone Black / BeagleBone Black Wireless
  3. Various PMODs
  4. PMOD Breakout Board

Timeline

Date Status Details
13 April :: 17 May Application Review Period
15 May :: 7 June Community Bonding
  • Discuss with a mentor about the doubts related to implementation.
  • Setting Up BeagleBone with the Image used by Michael Welling for testing BeagleWire Boards.
  • Documenting the Process for getting started guide.
June 14 Milestone #1
  • Introductory YouTube video
  • Make Sure Everything setup correctly on BeagleWire and able to generate bitstream.
  • Running blink_leds code from BeagleWire Repo.
June 21 Milestone #2
  • Generate the LiteDRAM Core with the Memory Type: SDRAM and CPU: NONE
  • Understand the Current SDRAM Controller.
  • Interface the LiteDRAM Core with other firmware
June 28 Milestone #3
  • Testing the SDRAM in Hardware.
  • Understand and try to solve the Issues related to SDRAM on the BeagleWire repo:
  1. sdram read results are occasionally wrong #7
  2. sdram rd_busy should be rd_ready? #8
  3. sdram can miss command transitions #10
  • In case of any issues arises in LiteDRAM Core also check the backup of Advanced SDRAM Controller on Lattice Sites.
July 5 Milestone #4
  • Test and Improve Following Subsystems:
  1. SPI
  2. UART
July 12 - 16, 2021 Milestone #5(First Evaluation)
  • Demonstrating the use of SDRAM on BeagleWire, SPI, and UART
  • After the review from the mentor, finalizing and Documenting Everything done till now
July 23 Milestone #6
  • Test and Improve Following Subsystems:
  1. PWM (Write Servo Code using PWM)
  2. I2C
July 30 Milestone #7
  • Test the other Examples provided in the BeagleWire Repo:
  1. stepper motor
  2. lcd_game
  • Add New Examples for the BeagleWire using updated subsystem codes.
August 6 Milestone #8
  • Interface Various PMODs with BeagleWire.
  • Use the Breakout Board with Beaglewire for Hardware testing of PMODs.
August 16 Milestone #9
  • Solve all the issues opened on the BeagleWire Repo: Issues
  • Document Everything Until Now.
  • Add final About page.
August 21 Milestone #10
  • Submit final work product and final mentor evaluation
  • Completion YouTube video
August 31 Milestone #11
  • Completion of GSoC

Experience and approach

  • I'm well experienced with Verilog and C. I have actual experience with working with FPGAs. I have worked with Intel's Cyclone2, Sipeed's Tang primer, and Upduino3.0(ICE40) FPGA Boards.
  • I have done several projects related to these boards with Verilog some of them are as follows:
  1. riscv-core in verilog
  2. VGA Interface With Tang Primer FPGA
  3. Seven Segment Interface with Tang Primer FPGA

More projects done by me can be found on my github

  • I have also designed various double-sided boards using Autodesk Eagle and Kicad.
  • Esp32 Development Board designed for Embedded and Robotics Application: Design, This is the last Board I had designed, this shows that I have a very good understanding of reading schematics which was one of the requirements of the project

Contingency

if I get stuck on my project and my mentor isn’t around, I will use the following resources:

  1. Getting Started Guide for BeagleBone by derek molloy: http://derekmolloy.ie/beaglebone
  • Current Github Repos:
  1. https://github.com/pmezydlo/BeagleWire
  2. https://github.com/mwelling/BeagleWire
  3. https://github.com/osresearch/BeagleWire

Benefit

The completed project will provide the BeagleBoard.org community with easy to implement and powerful tools for the realization of projects based on Programmable Logic Device(FPGA), which will surely increase the number of applications based on it. The developed software will be easy and, at the same time, efficient tool for communication with FPGA. At this point, FPGA will be able to meet the requirements of even more advanced applications. The BeagleWire creates a powerful and versatile digital cape for users to create their imaginative digital designs.