fpga device driver design guide on windows 7 embedded · 2013-12-17 · fpga device driver design...

Guangzhou ZHIYUAN Electronics Co.,LTD

FPGA Device Driver

Design Guide on

Windows 7 Embedded

Yunrui Zhang

Contents

Driver Installation 1

2 Driver Library

Driver Design Guide 3

1. Driver Installation

② Select “PCI Device”.

① Open device manager.


③ Right click on “PCI

Device“;

Select “Update Driver

Software…”.


④ Select "Browse

my computer for

driver software”.


⑤ Click “Browse...” to

select the driver path.

Then click “Next”.


⑥ select “Install

this driver software

anyway”.


⑦ After installation

is complete:

Click “Close” to

return.


Driver for “PCI Device” is

successfully installed :

a). The “ArCore Chipset System

Driver” will appear under the

“System devices”;

b). Several devices are enumerated

by “ArCore Chipset System Driver”.


The steps to install drivers for

these devices are similar to

those for “PCI Device” (See

Step ② to Step ⑦).

⑧ Install drivers for the

“other devices”.


After installation is

complete:

a). A new type of device

class is added: "ArCore

Chipset Device“.

2. Driver Library

ADC Device Object 1

2 DAC Device Object

3 GPIO Device Object

4 Video Capture And Net

2.1 ADC Device Object

• The method to operate ADC devices:

AiCreate

AiClose

Initialize

GetADCInfo

GetDeviceName

Start

Stop

RegisterADCallback


• Create an ADC device object with device index :

DWORD __stdcall

AiCreate(

IAiObject** ppIAiObj,

int Index

);


Parameters Meaning

ppIAiObj Pointer to a Pointer to the IAiObject

Index The index of ADC device

Parameters of AiCreate:

Return Value:

Return zreo if there is no error occurred, otherwise return non-zero value.


struct IAiObject {

virtual DWORD __stdcall Initialize(

IN void *pContext) = 0;

virtual DWORD __stdcall RegisterADCallback(

IN AD_CONVERT_CALLBACK pADCallback,

IN void *pADContext) = 0;

virtual DWORD __stdcall GetADCInfo(

IN OUT int *ByteWidth,

IN OUT int *BitWidth) = 0;

virtual DWORD __stdcall GetDeviceName(

IN OUT void* lpszName,

IN OUT DWORD* pdwReqiredSize) = 0;

virtual DWORD __stdcall Start() = 0;

virtual DWORD __stdcall Stop() = 0;

};

Prototype of

IAiObject:


• Close a specified ADC device object:

void __stdcall

AiClose(

IAiObject* pIAiObj

);


Parameters Meaning

ppIAiObj Pointer to the IAiObject

Parameters of AiClose:

Return Value:

None value to return.


• Initialize device function:

DWORD __stdcall

Initialize(

void* pContext,

);


Parameters Meaning

pContext Reserved ,must be NULL

Parameters of Initialize:

Return Value:



• Read ADC Device information function:

DWORD __stdcall

GetADCInfo(

int* ByteWidth,

int* BitWidth

);


Parameters Meaning

ByteWidth Pointer to the number of the bytes for

the data returned by the ADC

BitWidth Pointer to the number of bits of the

ADC device

Parameters of GetADCInfo:

Return Value:



• Read ADC device name function:

DWORD __stdcall

GetDeviceName(

void* lpszName,

DWORD* pdwReqiredSize

);


Parameter Meaning

lpszName Pointer to the device name

pdwReqiredSize Pointer to the number of bytes

required for the device name

Parameters of GetDeviceName:

Return Value:



• Start A/D Conversion function:

DWORD __stdcall Start();


Parameters of Start:

Return Value:


None Parameters to input.


• Stop A/D conversion function:

DWORD __stdcall Stop();


Parameters of Stop:

Return Value:


None Parameters to input.


• Register A/D data convert handler callback routine :

DWORD __stdcall

RegisterADCallback(

AD_CONVERT_CALLBACK pADCallback,

void* pADContext

);


Parameter Meaning

pADCallback Specifies the entry point for the user-

supplied A/D data convert handler

callback routine

pADContext Pointer to a user-determined context

to pass to the A/D data convert

handler callback routine

Parameters of RegisterADCallback :

Return Value:



• Prototype of A/D data convert handler

routine :

void (__stdcall

*AD_CONVERT_CALLBACK)(

DWORD dwRawData,

void* Context

);


Parameter Meaning

dwRawData The raw data get from the AD

converter

pADContext Pointer to a user-determined context

Parameters of AD_CONVERT_CALLBACK:

Return Value:


2.2 DAC Device Object

• Method to operate DAC device:

AoCreate

AoClose

Initialize

SendAoData


• Create a DAC device object with device index :

DWORD __stdcall

AoCreate(

IAoObject** ppIAoObj,

int Index

);


Parameters Meaning

ppIAoObj Pointer to a Pointer to the IAoObject

Index The index of DAC device

Parameters of AoCreate:

Return Value:



struct IAoObject

{


IN void *pContext) = 0;

virtual DWORD __stdcall SendAoData(

IN USHORT *pTxBuffer,

IN unsigned long dwBufferSize) = 0;

};

Prototype of IAoObject :


• Close a specified DAC device object:

void __stdcall

AoClose(

IAoObject* pIAoObj

);


Parameters Meaning

ppIAoObj Pointer to the IAoObject

Parameters of AoClose:

Return Value:




DWORD __stdcall

Initialize(

void* pContext,

);


Parameters Meaning



Return Value:



• Write data to DAC function:

DWORD __stdcall

SendAoData(

USHORT * pTxBuffer,

unsigned long dwBufferSize

);


Parameter Meaning

pTxBuffer Pointer to the DAC write buffer

dwBufferSize The size of the DAC write buffer

Parameters of SendAoData:

Return Value:


2.3 GPIO Device Object

• Method to operate GPIO interfaces:

GpioCreate

GpioClose

Initialize

RegisterEventProc

SetLEDState

GetLEDState


• Create a GPIO device object with device index :

DWORD __stdcall

GpioCreate(

IGpioObject** ppIGpioObj,

int Index

);


Parameters Meaning

ppIGpioObj Pointer to a Pointer to the

IGpioObject

Index The index of GPIO device

Parameters of GpioCreate :

Return Value:



struct IGpioObject {


void *pContext) = 0;

virtual DWORD __stdcall RegisterEventProc(

GPIO_EVENT_PROC_ROUTINE

pEventProcRoutine,

void *pEventProcContext) = 0;

virtual DWORD __stdcall SetLEDState(

DWORD State) = 0;

virtual DWORD __stdcall GetLEDState(

DWORD* pSate) = 0;

};

Prototype of IGpioObject :


• Close a specified GPIO device object:

void __stdcall

GpioClose(

IGpioObject* pIGpioObj

);


Parameters Meaning

pIGpioObj Pointer to the IGpioObject

Parameters of GpioClose :

Return Value:




DWORD __stdcall

Initialize(

void* pContext,

);


Parameters Meaning



Return Value:



• Register GPIO event handler callback routine :

DWORD __stdcall

RegisterEventProc(

GPIO_EVENT_PROC_ROUTINE pEventProcRoutine,

void* pEventProcContext

);


Parameter Meaning

pEventProcRoutine Specifies the entry point for the user-

supplied GPIO event handler callback

routine

pEventProcContext Pointer to a user-determined context

to pass to the GPIO event handler

callback routine

Parameters of RegisterEventProc:

Return Value:



• Prototype of GPIO event handler callback routine :

void (__stdcall*

GPIO_EVENT_PROC_ROUTINE)(

int Event,

int wParam,

int lParam,

void* Context

);


Parameter Meaning

Event Event message type

wParam Status of the switch or buttons

lParam Switch message : reserved

Button message : the index of the

button, if more than one button’s state

is changed or there are one or more

buttons are held, lParam will be

negative one

Context Pointer to a user-determined context

Parameters of GPIO_EVENT_PROC_ROUTINE:

Return Value:



Event type Meaning

GPIO_SWITCH_CHANGED Switch statue is changed

GPIO_BUTTON_DOWN Button down

GPIO_BUTTON_UP Button up

The enumeration values of Event:


• Set LED state:

DWORD __stdcall

SetLEDState(

DWORD State

);


Parameters Meaning

State The lower 8 bits of pSate are

corresponding to the states of 8 LEDs

Parameters of SetLEDState:

Return Value:



• Get LED state:

DWORD __stdcall

GetLEDState(

DWORD* pState

);


Parameters Meaning

pState The lower 8 bits of pSate are

corresponding to the states of 8 LEDs

Parameters of GetLEDState:

Return Value:


2.4 Video Capture And Net

Video Capture

NET

DirectShow. Refer to platform SDK Documentation.

Windows Sockets. Refer to platform SDK Documentation.

3. Driver Design Guide

Hardware Architecture

Driver Stack of FPGA Device

Supported Drivers And Driver Type

Driver Development Tools

Implement A Driver

Summary Driver Design Guide


Intel® Atom™

Processor

Intel® Atom™ E6x5C

Altera® Arria® IIEP2AGXE6XX FPGA

PCIe

COMe Connector 2

I/O

Ban

k 7

I/O

Ban

k 6

4Buttons

4Switches

8Leds

VideoDecoder

AnalogVideoInput

10-bit DAC

10Msps

8-bitADC

10Msps

12-bit ADC

400Ksps

PHY

Altera TSE

Hardware Architecture


Driver Stack of FPGA Device

PCI Bus

(pci.sys)

FPGA

(arcore.sys)

ADC

(aradc.sys)

DAC

(ardac.sys)

GPIO

(argpio.sys)

VIDEO

(arvideo.sys)

NET

(arndis.sys)

Parent Device

Child Device


ZLG Supported Drivers

ADC — One 8bit ADC and 12bit ADC Input

DAC — One 10bit DAC Output

GPIO — 8 LED Output, 4 Button Input, 4 Switch Input

Video Capture — AVStream minidriver

Net Driver — NDIS miniport driver

Bus Driver — FPGA bus driver, ArCore.sys


Hardware

Kernel / HAL

Device Driver

API DLL

Application

User

Kernel

Generic WDM Device Driver Overview

DDI (Device Driver Interface)

API (Application Interface)


Video Capture Driver Overview

Port Class Stream Class AVStream

Ks

audio

minidrivers

DVD video

capture

audio or video

minidrivers

Microsoft

supplied

Vendor

supplied


NDIS miniport

Net Card

NDIS Interface

Transport Driver

Interface (TDI)

LAN Protocols Native Media

Aware Protocol

Vendor

supplied

Net Device Driver Overview

Microsoft

supplied


Driver Development Tools

WDK Version 7600.16385.0

WinDbg or Other Debug Tools

Visual Studio (optional)

ESDC Hardware Platform

System Symbols (for debugging driver)


Implement ADC/DAC Drivers

ADC/DAC Running After Power On

ADC/DAC No FIFO, No Interrupt Generated

Driver Must Polling the ADC/DAC

Assume Bus Driver is Working as Design


Build ADC/DAC Drivers

fpga device driver design guide on windows 7 embedded · 2013-12-17 · fpga device driver design...

Documents