xintc_example.c 분석

1. 해당 example 파일 위치

 

 

 

---

 

 

 

2. xintc_example.c 

/******************************************************************************
*
* Copyright (C) 2002 - 2014 Xilinx, Inc.  All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/******************************************************************************/
/**
*
* @file xintc_example.c
*
* This file contains a design example using the Interrupt Controller driver
* (XIntc) and hardware device. Please reference other device driver examples to
* see more examples of how the intc and interrupts can be used by a software
* application.
*
* This example shows the use of the Interrupt Controller both with a PowerPC
* and MicroBlaze processor.
*
* @note
*		This example can also be used for Cascade mode interrupt
*		controllers by using the interrupt IDs generated in
*		xparameters.h. For Cascade mode, Interrupt IDs are generated
*		in xparameters.h as shown below:
*
*	    Master/Primary INTC
*		 ______
*		|      |-0      Secondary INTC
*		|      |-.         ______
*		|      |-.        |      |-32        Last INTC
*		|      |-.        |      |-.          ______
*		|______|<--31-----|      |-.         |      |-64
*			              |      |-.         |      |-.
*			              |______|<--63------|      |-.
*                                            |      |-.
*                                            |______|-95
*
*		All driver functions has to be called using
*		DeviceId/InstancePtr of Primary/Master Controller only. Driver
*		functions takes care of Slave Controllers based on Interrupt
*		ID passed. User must not use Interrupt source/ID  31 of Primary
*		and Secondary controllers to call driver functions.
*
* <pre>
*
* MODIFICATION HISTORY:
* Ver   Who  Date	 Changes
* ----- ---- -------- ----------------------------------------------------
* 1.00b jhl  02/13/02 First release
* 1.00c rpm  11/13/03 Updated to show microblaze and PPC interrupt use and
*		      to use the common L0/L1 interrupt handler with device ID.
* 1.00c sv   06/29/05 Minor changes to comply to Doxygen and coding guidelines
* 2.00a ktn  10/20/09 Updated to use HAL Processor APIs amd minor modifications
*		      as per coding guidelines.
* 3.6   ms   01/23/17 Added xil_printf statement in main function to
*                     ensure that "Successfully ran" and "Failed" strings
*                     are available in all examples. This is a fix for
*                     CR-965028.
* </pre>
******************************************************************************/

/***************************** Include Files *********************************/

#include "xparameters.h"
#include "xstatus.h"
#include "xintc.h"
#include "xil_exception.h"
#include "xil_printf.h"

/************************** Constant Definitions *****************************/

/*
 * The following constants map to the XPAR parameters created in the
 * xparameters.h file. They are defined here such that a user can easily
 * change all the needed parameters in one place.
 */
#define INTC_DEVICE_ID		  XPAR_INTC_0_DEVICE_ID

/*
 *  This is the Interrupt Number of the Device whose Interrupt Output is
 *  connected to the Input of the Interrupt Controller
 */
#define INTC_DEVICE_INT_ID	  XPAR_INTC_0_UARTLITE_0_VEC_ID


/**************************** Type Definitions *******************************/


/***************** Macros (Inline Functions) Definitions *********************/


/************************** Function Prototypes ******************************/

int IntcExample(u16 DeviceId);

int SetUpInterruptSystem(XIntc *XIntcInstancePtr);

void DeviceDriverHandler(void *CallbackRef);


/************************** Variable Definitions *****************************/

static XIntc InterruptController; /* Instance of the Interrupt Controller */

/*
 * Create a shared variable to be used by the main thread of processing and
 * the interrupt processing
 */
volatile static int InterruptProcessed = FALSE;

/*****************************************************************************/
/**
*
* This is the main function for the Interrupt Controller example.
*
* @param	None.
*
* @return	XST_SUCCESS to indicate success, otherwise XST_FAILURE.
*
* @note		None.
*
****************************************************************************/
int main_intr(void)
{
	int Status;

	/*
	 * Run the Intc example , specify the Device ID generated in
	 * xparameters.h
	 */
	Status = IntcExample(INTC_DEVICE_ID);
	if (Status != XST_SUCCESS) {
		xil_printf("Intc Example Failed\r\n");
		return XST_FAILURE;
	}

	xil_printf("Successfully ran Intc Example\r\n");
	return XST_SUCCESS;

}


/*****************************************************************************/
/**
*
* This function is an example of how to use the interrupt controller driver
* component (XIntc) and the hardware device.  This function is designed to
* work without any hardware devices to cause interrupts.  It may not return
* if the interrupt controller is not properly connected to the processor in
* either software or hardware.
*
* This function relies on the fact that the interrupt controller hardware
* has come out of the reset state such that it will allow interrupts to be
* simulated by the software.
*
* @param	DeviceId is Device ID of the Interrupt Controller Device,
*		typically XPAR_<INTC_instance>_DEVICE_ID value from
*		xparameters.h.
*
* @return	XST_SUCCESS to indicate success, otherwise XST_FAILURE.
*
* @note		None.
*
******************************************************************************/
int IntcExample(u16 DeviceId)
{
	int Status;

	/*
	 * Initialize the interrupt controller driver so that it is ready to
	 * use.
	 */
	Status = XIntc_Initialize(&InterruptController, DeviceId);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 * Perform a self-test to ensure that the hardware was built
	 * correctly.
	 */
	Status = XIntc_SelfTest(&InterruptController);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 * Setup the Interrupt System.
	 */
	Status = SetUpInterruptSystem(&InterruptController);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 *  Simulate the Interrupt.
	 */
	Status = XIntc_SimulateIntr(&InterruptController, INTC_DEVICE_INT_ID);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 * Wait for the interrupt to be processed, if the interrupt does not
	 * occur this loop will wait forever.
	 */
	while (1)
	{
		/*
		 * If the interrupt occurred which is indicated by the global
		 * variable which is set in the device driver handler, then
		 * stop waiting.
		 */
		if (InterruptProcessed) {
			break;
		}
	}

	return XST_SUCCESS;

}

/******************************************************************************/
/**
*
* This function connects the interrupt handler of the interrupt controller to
* the processor.  This function is seperate to allow it to be customized for
* each application.  Each processor or RTOS may require unique processing to
* connect the interrupt handler.
*
* @param	None.
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
int SetUpInterruptSystem(XIntc *XIntcInstancePtr)
{
	int Status;


	/*
	 * Connect a device driver handler that will be called when an interrupt
	 * for the device occurs, the device driver handler performs the
	 * specific interrupt processing for the device.
	 */
	Status = XIntc_Connect(XIntcInstancePtr, INTC_DEVICE_INT_ID,
				   (XInterruptHandler)DeviceDriverHandler,
				   (void *)0);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 * Start the interrupt controller such that interrupts are enabled for
	 * all devices that cause interrupts, specify simulation mode so that
	 * an interrupt can be caused by software rather than a real hardware
	 * interrupt.
	 */
	Status = XIntc_Start(XIntcInstancePtr, XIN_SIMULATION_MODE);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}


	/*
	 * Enable the interrupt for the device and then cause (simulate) an
	 * interrupt so the handlers will be called.
	 */
	XIntc_Enable(XIntcInstancePtr, INTC_DEVICE_INT_ID);

	/*
	 * Initialize the exception table.
	 */
	Xil_ExceptionInit();

	/*
	 * Register the interrupt controller handler with the exception table.
	 */
	Xil_ExceptionRegisterHandler(XIL_EXCEPTION_ID_INT,
				(Xil_ExceptionHandler)XIntc_InterruptHandler,
				XIntcInstancePtr);

	/*
	 * Enable exceptions.
	 */
	Xil_ExceptionEnable();

	return XST_SUCCESS;

}

/******************************************************************************/
/**
*
* This function is designed to look like an interrupt handler in a device
* driver. This is typically a 2nd level handler that is called from the
* interrupt controller interrupt handler.  This handler would typically
* perform device specific processing such as reading and writing the registers
* of the device to clear the interrupt condition and pass any data to an
* application using the device driver.  Many drivers already provide this
* handler and the user is not required to create it.
*
* @param	CallbackRef is passed back to the device driver's interrupt
*		handler by the XIntc driver.  It was given to the XIntc driver
*		in the XIntc_Connect() function call.  It is typically a pointer
*		to the device driver instance variable if using the Xilinx
*		Level 1 device drivers.  In this example, we do not care about
*		the callback reference, so we passed it a 0 when connecting the
*		handler to the XIntc driver and we make no use of it here.
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
void DeviceDriverHandler(void *CallbackRef)
{
	/*
	 * Indicate the interrupt has been processed using a shared variable.
	 */
	InterruptProcessed = TRUE;

}

 

 

 

 

---

 

 

 

 

3. 각각의 변수의 역활 및 의미

3.1) INTC_DEVICE_ID 

#define INTC_DEVICE_ID		  XPAR_INTC_0_DEVICE_ID

• Device ID는 하드웨어 플랫폼에서 각 장치에 대한 고유한 식별자이다. 해당 ID값은 하드웨어에 따라 다른 값을 갖게 되며, 주로 xparameters.h 헤더파일에 정의 되어 있다.
• INTC_DEVICE_ID는 Xilinx FPGA 시스템내에서 Interrupt Controller를 나타내는 Device ID이다.
  
  

Xilinx FPGA System내에서 microblaze와 연결된 axi Interrupt Controller를 나타내고 있다.

• Device ID를 통해 해당 모듈 및 장치에 접근이 가능하며, 환경값 설정이 가능하다. 즉, Deivce ID를 통해 하드웨어 접근 및 제어가 가능한 것이다.

 

 

3.2) InterruptController

• Interrupt Controller는  하드웨어를 실질적으로 설정 및 제어하기 위한 객체 인스턴스이다.
  Interrupt Controller 객체 인스턴스를 통해 하드웨어와 소프트웨어 중간 다리 역활을 수행한다.
• InterruptController 인스턴스를 통해 초기화, 리소스 관리, 설정값 제어, 인터럽트 처리 등을 수행할 수 있다.
  
  

 

 

 

3.3) INTC_DEVICE_INT_ID

• Interrupt Controller는 FPGA 시스템내에서 다양한 모듈로부터 발생한 Interrupt 신호들을 종합 및 정리하여 MicroBlaze에게 전달하는 역활을 수행하게 된다.
• 그런데, 만약 각각의 Interrupt 신호에 대해서 식별할 수 있는 수단이 없다면 Interrupt Controller에 들어온 임의의 Interrupt 신호에 대해서 "어떤 모듈이 interrupt 신호를 보냈는가?"를 알 수 없다.
• 따라서 이를 식별하기 위해서 각각의 Interrupt 신호들을 식별할 수 있는 ID를 부여함으로서 Interrupt Controller는 들어온 임의의 Interrupt 신호에 대해서 "어떤 모듈이 Interrupt 신호를 보냈구나,"를 알 수 있는 것이다.
• 그래서 예시로 작성한 INTC_DEVICE_INT_ID는 Interrupt 모듈에서 발생한 Interrupt 을 알리는 상수이다. 해당 값이 활성화 된다면 Interrupt Controller는 "UART 모듈에서 Interrupt가 발생했구나."를 확인할 수 있는 것이다.

 

 

 

---

 

 

 

 

 

4. 각 함수의 역활

4.1) XIntc_Initialize 

Status = XIntc_Initialize(&InterruptController, DeviceId);

if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• FPGA 시스템에 있는 Interrupt Controller 모듈을 초기화하는 함수
• 여기서 '초기화'는 Interrupt Controller의 설정값들을 초기화하는 작업을 의미
• Intc_Initialize 함수는 구체적으로 다음과 같은 작업들을 수행한다.
  - 하드웨어 리소스 준비 : 소프트웨어가 사용할 수 있도록 리소스 준비하는 과정
  - 하드웨어와 소프트웨어의 연결 : 소프트웨어가 하드웨어와 상호작용할 수 있도록 설정
  - 제어 구조체 초기화 : XIntc 객체의 인스턴스인 InterruptController를 초기화

 

 

 

 

4.2) XIntc_SelfTest 

Status = XIntc_SelfTest(&InterruptController);

if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• 하드웨어가 정상적으로 동작하는지 확인하기 위해 간단한 기본적인 검사를 수행하는 함수
• 즉, 다시 말해 FPGA 시스템내에 있는 Interrupt Controller가 제대로 동작하는지 여부 확인하는 작업이다.
• 이를 통해 Interrupt Controller 모듈을 정상 동작 여부, 소프트웨어 간의 기본적인 연결 설정 등을 확인함으로서 사전에 방지가 가능하다.

 

 

 

 

4.3) SetUpInterruptSystem 

Status = SetUpInterruptSystem(&InterruptController);
	
if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• SetUpInterruptSystem 함수는 Interrupt Set Up의 전반적인 작업을 수행하는 함수이다. 
  [ 해당 함수는 예시 파일에 따로 정의되었기 때문에 해당 위치로 가서 확인할 것! ] 
• SetUpInterruptSystem 함수는 다음과 같은 작업들을 수행하게 된다.
  - Interrupt Handler 등록
  - Interrupt Controller 시작
  - Interrupt 활성화
  - Exception Handing System 설정

 

 

 

 

4.4) XIntc_Connect [ SetUpInterruptSystem 함수 내에 정의 ]

Status = XIntc_Connect(XIntcInstancePtr, INTC_DEVICE_INT_ID,
        (XInterruptHandler)DeviceDriverHandler,
        (void *)0);
                   
if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• Interrupt Controller와 특정 Interrupt 소스의 Interrupt ID를 연결하는 동시에 해당 Interrupt 발생시, 이에 대한 Interrupt Handler를 지정하는 함수이다.
• XIntc_Connect 함수는 다음과 같은 파라미터들을 갖는다.
  - 첫 번째 파라미터 : Interrupt Controller의 XIntc 객체의 인스턴스
  - 두 번째 파라미터 : Interrupt ID
  - 세 번째 파라미터 : 해당 Interrupt 발생시, 이에 대한 처리를 위한 Interrupt Handler
  - 네 번째 파라미터 : 인터럽트 처리 완료 후 호출될 콜백 함수

 

 

 

★ ISR (Interrupt Service Routine)과 Interrupt Handler의 차이

• ISR이나 Interrupt Handler 둘 모두 Interrupt에 대한 처리 작업을 수행하는 함수이지만, Interrupt Handler는 경우에 따라서 Interrupt 처리의 시작점으로서 직접적으로 Interrupt 처리 작업을 수행하지 않고, ISR를 호출 등 Interrupt 처리에 대한 관리 / 감독을 수행할 수 있다.

 

 

 

 

 

 

4.5) XIntc_Start [ SetUpInterruptSystem 함수 내에 정의 ]

Status = XIntc_Start(XIntcInstancePtr, XIN_SIMULATION_MODE);

if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• Interrupt Controller를 어떤 모드에서 동작시킬 것인지를 정의하고, Interrupt Controller를 해당 모드 및 환경에서 활성화시키는 함수
• 주로 인터럽트 컨트롤러를 시작하고, 인터럽트 처리를 활성화하기 위해 호출

 

 

 

 

4.6) XIntc_Enable [ SetUpInterruptSystem 함수 내에 정의 ]

/*
* Enable the interrupt for the device and then cause (simulate) an
* interrupt so the handlers will be called.
*/
	
XIntc_Enable(XIntcInstancePtr, INTC_DEVICE_INT_ID);

• Interrupt Controller와 연결된 Interrupt ID들 중 어떤 Interrupt ID를 활성화시킬지에 대한 정의하는 함수
  
  
• Q) XIntc_Connect 함수와 XIntc_Start 함수를 통해 Interrupt Controller와 Interrupt ID를 연결하고, Interrupt Controller를 활성화시켜주었으면 되는거 아닌가? 추가적으로 XIntc_Start 함수를 통해 특정 Interrupt ID를 활성화시켜 줘야 하는가?
  
  A) XIntc_Connect 함수를 통해 Interrupt ID와 Interrupt Controller를 연결하고, Interrupt Handler를 정의하고, XIntc_Start 함수를 통해 Interrupt Controller를 활성화시켜준다고 하더라도, XIntc_Start 함수를 통해 Interrupt Controller와 연결된 Interrupt ID들 중에서 특정 Interrupt을 활성화시켜줘야 그제서야 해당 모듈에서 Interrupt 발생시, Interrupt Handler는 해당 Interrupt를 확인하고, Interrrupt Handler를 통해 처리 할 수 있다.

 

 

 

4.7) Xil_ExceptionInit [ SetUpInterruptSystem 함수 내에 정의 ]

/*
* Initialize the exception table.
*/

Xil_ExceptionInit();

• MicroBlaze에서 예외처리 시스템의 초기화하는 함수
• 예외처리 시스템이란?
  ▶ 예외 처리 시스템은 주로 예상 외의 상황에서 시스템이 비정상적으로 동작하거나 인터럽트 처리가 제대로 이루어지지 않았을 경우를 처리하는 시스템이다.
  ▶ 정상적인 동작을 보장하기 위한 보호 메커니즘입니다. 예를 들어, 인터럽트가 발생했을 때 예상치 못한 오류나 비정상적인 동작을 발견했을 때 이를 신속하게 처리하고, 시스템이 불안정해지지 않도록 합니다.

 

 

 

 

4.8) Xil_ExceptionRegisterHandler [ SetUpInterruptSystem 함수 내에 정의 ]

/*
* Register the interrupt controller handler with the exception table.
*/
Xil_ExceptionRegisterHandler(XIL_EXCEPTION_ID_INT,
          (Xil_ExceptionHandler)XIntc_InterruptHandler,
           XIntcInstancePtr);

• 예외상황에 대한 처리가 필요한 경우, "어떠한 함수 및 핸들러가 예외상황를 처리할 것인가?"에 대한 예외상황헨들러를 등록하는 함수이다.

 

 

 

 

4.9) Xil_ExceptionEnable[ SetUpInterruptSystem 함수 내에 정의 ]

/*
* Enable exceptions.
*/

Xil_ExceptionEnable();

• 예외처리시스템을 활성화시켜주는 함수

 

 

 

 

 

4.10) XIntc_SimulateIntr

/*
*  Simulate the Interrupt.
*/
	
Status = XIntc_SimulateIntr(&InterruptController, INTC_DEVICE_INT_ID);

if (Status != XST_SUCCESS) {
	return XST_FAILURE;
}

• XIntc_SimulateIntr 함수는 인터럽트 시스템에서 소프트웨어 기반으로 인터럽트를 시뮬레이션할 수 있는 함수이다.
• 이 함수는 실제 하드웨어 인터럽트가 발생하지 않더라도, 지정된 인터럽트 ID에 해당하는 인터럽트를 소프트웨어적으로 발생시키고, 이를 처리할 수 있도록 한다.
  
  
• 해당 함수는 소프트웨어 기반으로 인터럽트를 시뮬레이션하는 것이기 때문에 해당 함수를 사용하려면 XIntc_Start 함수 선언 시, 시뮬레이션 모드로 설정해야하며, Real 모드일 시, 실제로 물리적인 하드웨어 상으로부터 Interrupt를 받기 때문에 Real 모드에서 해당 함수를 사용할 수 없다.