Difference between revisions of "Main Page"

From SoC Design Wiki
Jump to: navigation, search
m
(participants link)
 
(179 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
==Intorduction==
+
[[File:Logo_SoC.png|300px|right]]
−
Welcome to SoC design wiki.
+
−
===Learning Objectives===
+
−
By completion of this SoC Design labs, you should be able to:
+
−
*...
+
−
*...
+
  
−
===Grading Policy===
+
=Introduction=
−
* Attendance
+
Welcome to the wiki for the SoC Design course! We started this series of labs/projects in 2014 and we are upgrading and fixing problems every year to make it better.
−
* Peer Assessments
+
  
−
===Contact Us===
+
Slides for the introductory presentation are available [https://docs.google.com/presentation/d/1n4VfibjQcfBR-hYUb8m64C-zhhVq0kOHvIEwQkTPN8I/edit?usp=sharing here]
−
In case of questions, please contact us:
+
−
* Karl Janson
+
−
* [http://ati.ttu.ee/socdesign/index.php/User:Siavoosh Siavoosh Payandeh Azad]
+
−
== Lab Tutorials ==
+
−
*[[Lab 1]]
+
−
*[[Lab 2]]
+
−
*[[Lab 3]]
+
  
−
===Labs additional readings===
+
==Learning Objectives==
−
We keep the design material for the labs at moodle. However the additional reading and more information about the labs can be found here:
+
After the completion of the labs, you will be able to:
−
*[[Lab1 additional material]]
+
−
*[[Lab2 additional material]]
+
−
*[[Lab3 additional material]]
+
  
−
===Labs known issues===
+
{|
−
Please add related issues to each lab under the [[Labs known Issues]] page.
+
|style="vertical-align:top;"|
 +
'''Tutorials''':
 +
# Make Linux kernel drivers: Write a simple kernel driver for controlling a simple IP (intellectual property) on ZedBoard.
 +
# Build custom SoC (System-on-Chip) on ZedBoard:
 +
#* Create a simple SoC with Vivado from existing IPs
 +
#* Build a custom embedded Linux system to run on the SoC
 +
#* Using custom kernel drivers to control the IPs in the SoC
 +
# Create custom IPs:
 +
#* Development of simple custom IP from VHDL code
 +
#* Integrate the IP into the SoC using AXI bus
 +
#* Control the IP from Linux using custom driver
 +
# Build a simple audio processor system
 +
#* Complex system integration
 +
#* Preparation for course project
  
−
===Tutorial Labs Archive ===
+
|style="vertical-align:top;"|
−
*[[2015 Tutorials]]
+
          
−
*[[2014 Tutorials]]
+
          
 +
          
 +
 
  
−
==Project Description==
+
|style="vertical-align:top;"|
−
[[File:mixer.jpg|300px|right]]
+
'''Project''':
−
Design project is defined in each round for System on Chip design(IAY0550) students with the aim of providing them with real world experience of working on a SoC project, teamwork and project management. This wiki will serve as a platform for students to pass-on their designs and documents to students in the next round of course. Full description of the project can be found [[Project Description]] page.
+
* Component reuse and system improvement
 +
* Functional test and analysis
 +
* Work in a team
 +
|}
 +
 
 +
==Requirements for Taking the Labs==
 +
For these labs we assume that you have basic knowledge of the following:
 +
* C language '''<- This is a must!'''
 +
* Digital Systems Design
 +
* Embedded Systems Programming
 +
 
 +
==Lab Organization==
 +
{|
 +
|style="vertical-align:top;"|
 +
'''Important dates'''
 +
 
 +
* <span style="color:#FF0000">'''Week 2''':</span> Lab 1
 +
* <span style="color:#FF0000">'''Week 3 ... week 5''':</span> Lab 2
 +
* <span style="color:#FF0000">'''Week 6 ... week 9''':</span> Lab 3
 +
* <span style="color:#FF0000">'''Week 10, week 11''':</span> Lab 4
 +
* <span style="color:#FF0000">'''End of week 15''':</span> Project Deadline
 +
 
 +
|style="vertical-align:top;"|
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
&nbsp;
 +
 
 +
|style="vertical-align:top;"|
 +
'''Lab Grading  Policy'''
 +
* Tutorials (Pass/Fail - prerequisite for project)
 +
* Project (50% of the grade)
 +
* Examination (50% of the grade)
 +
 
 +
'''In order to pass the course, you have to get a positive result in both the project and the exam.'''
 +
 
 +
'''You cannot finish the project without passing all tutorial labs!'''
 +
 
 +
|style="vertical-align:top;"|
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
 
 +
 
 +
|style="vertical-align:top;"|
 +
[[File:Grading.png]]
 +
 
 +
|}
  
 
==Rules and Regulations==
 
==Rules and Regulations==
−
Please read the following page before you start the project:  
+
<big><big>For your programs, <span style="color:green"> '''please follow the coding style:''' [https://blue.pri.ee/ttu/resources/coding-style/ [LINK]] </span></big></big>
−
*[[Rules and Regulations]]
+
  
−
==Team Organization==
+
<span style="color:red"> '''Please read the following page before you start the course:''' </span>
−
The following page is for clear and transparent team organization for design project:
+
 
−
*[[Team Organization Spring 2014]]
+
===Timing and Plans===
−
*[[Team Organization Spring 2015]]
+
'''Please note that the project's (strong) deadline is on the last lab session, no extension will be made!'''
 +
 
 +
===General Rules===
 +
* <span style="color:red">'''Unplugging any cables from the lab computers is NOT ALLOWED!'''</span> If you use your own computer, please use Wi-Fi.
 +
* It is '''OK''' to discuss your code with colleagues during the labs.
 +
* Copying a colleague's code '''is not''' OK! You need to write your own code.
 +
* You '''must understand''' the code you write! We will check that you do!
 +
 
 +
===When writing Code===
 +
* '''The first thing your code MUST do is print out your name, ''otherwise you are not allowed defend the lab!''''' Kernel modules should print your name when they are inserted.
 +
(This requirement only applies for code that you have modified or written yourself)
 +
 
 +
Have in mind that you or someone else might want to reuse your code!
 +
* '''Use comments in your code.''' Even you, as the author of the code, may not understand it in the future.
 +
* '''Write a proper doc-string for the functions.''' It makes your life and of others much easier.
 +
* '''Use meaningful variable names.''' A variable named "counterMaxValue" is much easier to understand than one for the same purpose named "cMNum", for example.
 +
 
 +
===In Case of Problems===
 +
'''Please use the following methods in the following order for solving your issues:'''
 +
 
 +
# Check the current lab's additional materials.
 +
# Re-read the lab manual to make sure you did not miss anything.
 +
# Google your problems
 +
# Ask the lab assistants for help.
 +
 
 +
'''NOTE:''' In case you find a problem with the documentation, please tell the assistants. Then we can fix the problem and everyone will be happy :)
 +
 
 +
<!-- *[[Rules and Regulations]] -->
 +
 
 +
=Lab Results=
 +
{|
 +
! rowspan="2" | [[File:statistics-512.png|70px|left]]
 +
! style="text-align:left;" | You can view you current lab results and statistics [https://docs.google.com/spreadsheets/d/1s_j7C3gGAiq2GUs0if-Slpvjip6cRRFBDOIC7cAv_GA/edit?usp=sharing '''here''']
 +
|}
 +
 
 +
=Contact Us=
 +
In case of any questions, please contact us:
 +
 
 +
{|
 +
! rowspan="2" | [[File:redphone.png|70px|left]]
 +
|-
 +
| style="text-align:left;" | '''• [http://ati.ttu.ee/socdesign/index.php/User:madker Madis Kerner]'''
 +
|}
 +
 
 +
= Labs =
 +
==Lab Tutorials==
 +
Here you can find lab manuals for the tutorials:
 +
*[[Lab 1|Lab 1: Building Custom SoC on ZedBoard]]
 +
*[[Lab 2|Lab 2: Kernel Driver]]
 +
*[[Lab 3|Lab 3: Custom IP creation]]
 +
*[[Lab 4|Lab 4: Setup 1 board system for the lab]]
 +
 
 +
==Additional Material==
 +
 
 +
Additional reading materials and more information about the labs can be found here:
 +
 
 +
===Lab Specific Information===
 +
*[[Lab1 Additional Material]]
 +
*[[Lab2 Additional Material]]
 +
*[[Lab3 additional material]]
 +
*[[Lab4 additional material]] <!--<span style="color:red"> TBU </span>-->
 +
 
 +
===General Information===
 +
*[[Creating New Vivado Project]]
 +
*[[Basic Linux Usage]]
 +
*[[Using ZedBoard]]
 +
 
 +
==Audio Mixer Project==
 +
[[File:mixer.jpg|300px|right]]
 +
[[File:Zedboard_icon.png|53px|left]]
 +
Design project is defined in each round for System on Chip design(IAY0550) students with the aim of providing them with real world experience of working on a SoC project, teamwork and project management. This wiki will serve as a platform for students to pass-on their designs and documents to students in the next round of course. Full description of the project can be found on the Project Description page
 +
* '''[[Project Description]] page'''.
 +
 
 +
=Using Own Computer for the Labs=
 +
You can find some information about using your own computer on the [[Using Own Computer]] page.
 +
 
 +
'''Please note that using any other computer than the ones in lab is not officially supported. The information on this page is not checked by the lab supervisors and might not be up-to-date and might not work! We recommend not to rely your course progress on getting the systems running on your personal machine and use the lab computers!'''
 +
 
 +
However, if you decide to follow the instructions on the page, please let us know about the problems you encounter, so we can update the manual for the benefit of other students.
 +
 
 +
=Git=
 +
[[File:github.png|43px|left]]
 +
The project code should be stored in git. Every component of the project should be uploaded as a separate branch.
 +
 
 +
There exists a dedicated Github repository for the course, that can be accessed here: [https://github.com/karljans/SoC_Design]
 +
 
 +
=Archive=
 +
'''Tutorials:'''
 +
*[[2016 Tutorials]]
 +
*[[2015 Tutorials]]
 +
*[[2014 Tutorials]]
  
−
==Design project parts==
+
'''Design project:'''
−
The following pages contain data about different parts of the project:
+
* [[Old project archive (2014/2015)]]
−
*[[General]]
+
−
*[[Amplifier Design]]
+
−
**[[Balance Unit]]
+
−
*[[Audio Interface]]
+
−
**[[Buffers Design]]
+
−
*[[Communication]]
+
−
*[[External Control Panel]]
+
−
**[[Pmod Encoder]]
+
−
*[[Filter Design]]
+
−
*[[Web Server]]
+
−
+
−
We keep separate pages for special design parts that will be used/shared by different groups:
+
−
*[[Shift and Add Multiplier]]
+

Latest revision as of 07:51, 20 September 2024

Logo SoC.png

Introduction

Welcome to the wiki for the SoC Design course! We started this series of labs/projects in 2014 and we are upgrading and fixing problems every year to make it better.

Slides for the introductory presentation are available here

Learning Objectives

After the completion of the labs, you will be able to:

Tutorials:

  1. Make Linux kernel drivers: Write a simple kernel driver for controlling a simple IP (intellectual property) on ZedBoard.
  2. Build custom SoC (System-on-Chip) on ZedBoard:
    • Create a simple SoC with Vivado from existing IPs
    • Build a custom embedded Linux system to run on the SoC
    • Using custom kernel drivers to control the IPs in the SoC
  3. Create custom IPs:
    • Development of simple custom IP from VHDL code
    • Integrate the IP into the SoC using AXI bus
    • Control the IP from Linux using custom driver
  4. Build a simple audio processor system
    • Complex system integration
    • Preparation for course project

                                  

Project:

  • Component reuse and system improvement
  • Functional test and analysis
  • Work in a team

Requirements for Taking the Labs

For these labs we assume that you have basic knowledge of the following:

  • C language <- This is a must!
  • Digital Systems Design
  • Embedded Systems Programming

Lab Organization

Important dates

  • Week 2: Lab 1
  • Week 3 ... week 5: Lab 2
  • Week 6 ... week 9: Lab 3
  • Week 10, week 11: Lab 4
  • End of week 15: Project Deadline

                                  

Lab Grading Policy

  • Tutorials (Pass/Fail - prerequisite for project)
  • Project (50% of the grade)
  • Examination (50% of the grade)

In order to pass the course, you have to get a positive result in both the project and the exam.

You cannot finish the project without passing all tutorial labs!

          


Grading.png

Rules and Regulations

For your programs, please follow the coding style: [LINK]

Please read the following page before you start the course:

Timing and Plans

Please note that the project's (strong) deadline is on the last lab session, no extension will be made!

General Rules

  • Unplugging any cables from the lab computers is NOT ALLOWED! If you use your own computer, please use Wi-Fi.
  • It is OK to discuss your code with colleagues during the labs.
  • Copying a colleague's code is not OK! You need to write your own code.
  • You must understand the code you write! We will check that you do!

When writing Code

  • The first thing your code MUST do is print out your name, otherwise you are not allowed defend the lab! Kernel modules should print your name when they are inserted.

(This requirement only applies for code that you have modified or written yourself)

Have in mind that you or someone else might want to reuse your code!

  • Use comments in your code. Even you, as the author of the code, may not understand it in the future.
  • Write a proper doc-string for the functions. It makes your life and of others much easier.
  • Use meaningful variable names. A variable named "counterMaxValue" is much easier to understand than one for the same purpose named "cMNum", for example.

In Case of Problems

Please use the following methods in the following order for solving your issues:

  1. Check the current lab's additional materials.
  2. Re-read the lab manual to make sure you did not miss anything.
  3. Google your problems
  4. Ask the lab assistants for help.

NOTE: In case you find a problem with the documentation, please tell the assistants. Then we can fix the problem and everyone will be happy :)


Lab Results

Statistics-512.png
 You can view you current lab results and statistics here

Contact Us

In case of any questions, please contact us:

Redphone.png
• Madis Kerner

Labs

Lab Tutorials

Here you can find lab manuals for the tutorials:

Additional Material

Additional reading materials and more information about the labs can be found here:

Lab Specific Information

General Information

Audio Mixer Project

Mixer.jpg
Zedboard icon.png

Design project is defined in each round for System on Chip design(IAY0550) students with the aim of providing them with real world experience of working on a SoC project, teamwork and project management. This wiki will serve as a platform for students to pass-on their designs and documents to students in the next round of course. Full description of the project can be found on the Project Description page

Using Own Computer for the Labs

You can find some information about using your own computer on the Using Own Computer page.

Please note that using any other computer than the ones in lab is not officially supported. The information on this page is not checked by the lab supervisors and might not be up-to-date and might not work! We recommend not to rely your course progress on getting the systems running on your personal machine and use the lab computers!

However, if you decide to follow the instructions on the page, please let us know about the problems you encounter, so we can update the manual for the benefit of other students.

Git

Github.png

The project code should be stored in git. Every component of the project should be uploaded as a separate branch.

There exists a dedicated Github repository for the course, that can be accessed here: [1]

Archive

Tutorials:

Design project:

Retrieved from "https://strudel.pld.ttu.ee/wiki/soc/index.php?title=Main_Page&oldid=7990"