GIC Standalone driver

Introduction

This page gives an overview of scugic driver which is available as part of the Xilinx Vivado and SDK distribution.


Driver Sources

The source code for the driver is included with the Vitis Unified Software Platform installation, as well as being available in the Xilinx Github repository. 

Driver Name

Path in Vitis

Path in Github

scugic

<Vitis Install Directory>/data/embedded/XilinxProcessorIPLib/drivers/scugic

https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/scugic

Note: To view the sources for a particular release, use the rel-version tag in github.  For example, for the 2020.1 release, the proper version of the code is: https://github.com/Xilinx/embeddedsw/tree/release-2020.1/XilinxProcessorIPLib/drivers/scugic

The driver source code is organized into different folders.  The table below shows the ospipsv driver source organization. 

Directory
Description

doc

Provides the API and data structure details

data

Driver .tcl and .mdd file

examples

Example applications that show how to use the driver features

src

Driver source files

Driver Implementation

For a full list of features supported by this IP, please refer ARM GIC v2 and v3 specifications.

Features Supported


  • Support for following type of interrupts,
    • Software generated interrupts (SGIs)
    • Shared-peripheral interrupts (SPIs) from PS and PL
    • Private-peripheral interrupts (PPIs)
  • Interrupt prioritization and handling
  • Programming of interrupt routing to one or more processors
  • Enabling and disabling of interrupts.
  • Programming interrupt sensitivity
  • Uni-processor and multiprocessor environments

Known issues and Limitations

NA


Example Applications

Refer to the driver examples directory for various example applications that exercise the different features of the driver. Each application is linked in the table below. The following sections describe the usage and expected output of the various applications.  These example applications can be imported into the Vitis IDE from the Board Support Package  settings tab. 

Links to Examples

Examples Path:

https://github.com/Xilinx/embeddedsw/tree/release-2020.1/XilinxProcessorIPLib/drivers/scugic/examples

Test Name

Example Source

Description
SCUGIC software generated interrupt example

xscugic_example.c

This example demonstrates triggering of interrupts by simulating software generated interrupt.
SCUGIC self test example

xscugic_tapp_example.c

This examples demonstrates basic initialization of scugic driver
SCUGIC low level example

xscugic_low_level_example.c

This example demonstrates triggering of interrupts by simulating software generated interrupt. It uses low level APIs of scugic driver.

Example Application Usage

SCUGIC software generated interrupt example

This example demonstrates triggering of interrupts by simulating software generated interrupt.

Expected output
GIC Example Test
Successfully ran GIC example Test

SCUGIC low level example

This example demonstrates triggering of interrupts by simulating software generated interrupt. It uses low level APIs of scugic driver.
Expected Output
Low Level GIC Example Test
Successfully ran Low Level GIC example Test

SCUGIC selftest example

This examples demonstrates basic initialization of scugic driver

Expected Output

Successfully ran Scugic self test Example

Changelog

2021.2

https://github.com/Xilinx/embeddedsw/blob/xlnx_rel_v2021.2/doc/ChangeLog#L189

2021.1

https://github.com/Xilinx/embeddedsw/blob/xlnx_rel_v2021.1/doc/ChangeLog#L385

2020.2

https://github.com/Xilinx/embeddedsw/blob/release-2020.2/doc/ChangeLog#L659

2020.1

https://github.com/Xilinx/embeddedsw/blob/release-2020.1/doc/ChangeLog#L519

2019.2

https://github.com/Xilinx/embeddedsw/blob/release-2019.2/doc/ChangeLog#L195

2019.1

https://github.com/Xilinx/embeddedsw/blob/release-2019.1/doc/ChangeLog#L142

2018.3

https://github.com/Xilinx/embeddedsw/blob/release-2018.3/doc/ChangeLog#L252

2018.2

None

2018.1

https://github.com/Xilinx/embeddedsw/blob/release-2018.1/doc/ChangeLog#L211