<<<<<<<<<< Jump to Main Workshop Series Landing Page >>>>>>>>>>

---

Introduction

---

This workshop will demonstrate common linux device driver implementation techniques for use on Altera SoC devices to provide user space access into custom user peripherals in the FPGA fabric. The format of this session will be mostly code review and demonstration on a live Cyclone V SoC target.

The following topics will be discussed and demonstrated:

• Development environment setup for modules/drivers
• Using /dev/mem to mmap() into a device's memory map
• Basic module API
• Module parameters
• Platform drivers
• Memory region reservation
• IRQ handler registration
• Creating sysfs files
• Creating misc devices
• Creating uio devices
• Kernel memory allocation techniques
• DMA scenarios
• Supporting multiple device instances with a single driver

---

Presentation Material and Demonstration Examples

---

The WS3 presenatation material is available in this PDF document.

WS3_Developing_Drivers_for_Altera_SoC.pdf

The WS3 demonstration script is available in this text document.

workshop_demonstration_script.txt

The WS3 example driver and demonstration sources are available in this archive.

example_drivers.tgz

---

Setup for Labs

---

What you will accomplish

• Configure your host development environment.
• Build an example misc driver.
• Build a test application for the misc driver.
• Modify the uio_pdrv_genirq template and build it.
• Build a test application for the UIO driver.
• Load all of the above onto your dev kit target.
• Run the test applications to verify proper driver functionality.
• Run a validation program.
  • Verifies the lab was completed.
• Submit results & feedback.

What you will need

• A supported SoC development board.
• A blank SD card to use with your development board.
• An SD card programming adapter to use with your development host machine.
• One USB cable to connect the console port of your development board to your development host and allow a terminal emulation program to interact with the serial console.
• One USB cable to connect the USB OTG port of your development board to your development host and allow the USB gadget mass storage and network functions to interact with your development host.
• A terminal emulator to run on your development host, like Putty, minicom, etc.

Obtain Development Board

You will need to obtain and configure one of the supported SoC development boards in order to complete the lab work for this workshop. The list of supported boards and their configuration requirements for the workshop lab environment is available on this page:

SoC SW Workshop Series Board Configuration

Obtain SD card Image

Once you have obtained your SoC development board and configured it to run the workshop environment you will need to download the SD card image for that board and program it onto the appropriate SD card for your board. You can download the SD card image and find instructions for programming the SD card on this page:

SoC SW Workshop Series SD Card Images

Locate WS3 Lab README

Once you get the SD card image programmed onto your card, you should find a directory at the top level of the FAT partition that is called “WS3-DevelopingDrivers”. There is a README.TXT file in that directory that should be sufficient to guide you through the WS3 required tools installation and labwork material.

There are two ways that you can locate this README.TXT file on the SD card, first, you could insert the SD card into an SD card reader that you can plug into your development host, much like you did when you programmed the SD card image in the first place, and then you can mount the FAT partition on your develpment host and locate the README.TXT file. Or secondly, you could insert the SD card into your development board, connect the USB OTG cable from the development board to your development host machine, then boot your development target board and wait for the USB gadget driver to present the mass storage device to your development host, and then you should be able to mount the FAT partition on your development host through the USB gadget interface.

Once mounted you should be able to locate the README file on the FAT partition like this:

$ cd <FAT-partition-mount-point>
$ tree -L 1 WS3-DevelopingDrivers/
WS3-DevelopingDrivers/
├── example_drivers.tgz
├── install_lab_environment.sh
├── linux.defconfig.socfpga-4.1-ltsi
├── README.TXT                          <<<<Start with this README file.
├── workshop_demonstration_script.txt
├── ws3_lab_environment.src
└── ws3_lab_material

Or graphically like this in a file browser:

Target Orientation

For more information on the general use of the target workshop environment you may wish to read this page:

SoC SW Workshop Series Target Orientation

<<<<<<<<<< Jump to Main Workshop Series Landing Page >>>>>>>>>>