//***********************************************************************/
//    Author                    : Garry
//    Original Date             : Oct,15 2005
//    Module Name               : PCI_DRV.H
//    Module Funciton           : 
//                                This module countains PCI local system bus driver's definition
//                                code.
//    Last modified Author      :
//    Last modified Date        :
//    Last modified Content     :
//                                1.
//                                2.
//    Lines number              :
//***********************************************************************/

#ifndef __PCI_DRV_H__
#define __PCI_DRV_H__
#endif

//
//The implementation of PciBusDriver routine.
//This is the entry routine for all system bus drivers,it is called by DeviceManager when
//this object is initializing.
//This routine checks if there is(are) PCI bus(es) in system,if not,returns FALSE,else,scan
//all PCI buses,configure all devices reside on the PCI buses,and returns TRUE.
//
BOOL PciBusDriver(__DEVICE_MANAGER* lpDevMgr);


//
//Constants used by PCI driver.
//
#define CONFIG_REGISTER          0xCF8    //Configure register used to read configure space.
#define DATA_REGISTER            0xCFC    //Data register.

//
//Common  part for all kinds of pre-defined headers.
//
#define PCI_CONFIG_OFFSET_VENDOR        0x00
#define PCI_CONFIG_OFFSET_DEVICE        0x02
#define PCI_CONFIG_OFFSET_COMMAND       0x04
#define PCI_CONFIG_OFFSET_STATUS        0x06
#define PCI_CONFIG_OFFSET_REVISION      0x08
#define PCI_CONFIG_OFFSET_CLASS         0x09
#define PCI_CONFIG_OFFSET_CACHELINESZ   0x0C
#define PCI_CONFIG_OFFSET_LATENCY       0x0D
#define PCI_CONFIG_OFFSET_HDRTYPE       0x0E
#define PCI_CONFIG_OFFSET_BIST          0x0F

//
//Configure space content for normal PCI device(Header type 0).
//
#define PCI_CONFIG_OFFSET_BASE1         0x10
#define PCI_CONFIG_OFFSET_BASE2         0x14
#define PCI_CONFIG_OFFSET_BASE3         0x18
#define PCI_CONFIG_OFFSET_BASE4         0x1C
#define PCI_CONFIG_OFFSET_BASE5         0x20
#define PCI_CONFIG_OFFSET_BASE6         0x24

#define PCI_CONFIG_OFFSET_CIS           0x28
#define PCI_CONFIG_OFFSET_SUBSYSID      0x2C
#define PCI_CONFIG_OFFSET_SYSID         0x2E
#define PCI_CONFIG_OFFSET_ROMBASE       0x30
#define PCI_CONFIG_OFFSET_CAP           0x34

#define PCI_CONFIG_OFFSET_INTLINE       0x3C
#define PCI_CONFIG_OFFSET_INTPIN        0x3D
#define PCI_CONFIG_OFFSET_MINGNT        0x3E
#define PCI_CONFIG_OFFSET_MAXLAT        0x3F

//
//Configure space content for PCI-PCI bridge(Header type 1).
//
#define PCI_CONFIG_OFFSET_PRIMARY       0x18
#define PCI_CONFIG_OFFSET_SECONDARY     0x19
#define PCI_CONFIG_OFFSET_SUBORDINAGE   0x1A
//#define PCI_CONFIG_OFFSET_LATENCY       0x1B

#define PCI_CONFIG_OFFSET_IOBASE        0x1C
#define PCI_CONFIG_OFFSET_IOLIMIT       0x1D
#define PCI_CONFIG_OFFSET_SECONDSTATUS  0x1E
#define PCI_CONFIG_OFFSET_MEMBASE       0x20
#define PCI_CONFIG_OFFSET_MEMLIMIT      0x22
#define PCI_CONFIG_OFFSET_PREMEMBASE    0x24
#define PCI_CONFIG_OFFSET_PREMEMLIMIT   0x26
#define PCI_CONFIG_OFFSET_PREMEMBASEUP  0X28
#define PCI_CONFIG_OFFSET_PREMEMLIMITUP 0x2C
#define PCI_CONFIG_OFFSET_IOBASEUP      0x30
#define PCI_CONFIG_OFFSET_IOLIMITUP     0x32
#define PCI_CONFIG_OFFSET_BCONTROL      0x3E

//
//The following defines used to indicate which part of __IDENTIFIER structure is
//set.Please refer to __IDENTIFIER's definition.
//
#define PCI_IDENTIFIER_MASK_VENDOR      0x01
#define PCI_IDENTIFIER_MASK_DEVICE      0x02
#define PCI_IDENTIFIER_MASK_CLASS       0x04
#define PCI_IDENTIFIER_MASK_HDRTYPE     0x08
#define PCI_IDENTIFIER_MASK_ALL         (0x01 | 0x02 | 0x04 | 0x08)

//
//Define a structure to contain PCI device specific information.
//
//BEGIN_DEFINE_OBJECT(__PCI_DEVICE_INFO)
struct __PCI_DEVICE_INFO{
	DWORD             dwDeviceType;
	DWORD             DeviceNum   : 5;
	DWORD             FunctionNum : 3;
	DWORD             dwClassCode;
	UCHAR             ucPrimary;     //For PCI-PCI bridge only.
	UCHAR             ucSecondary;   //For PCI-PCI bridge only.
	UCHAR             ucSubordinate; //For PCI-PCI bridge only.
};
//END_DEFINE_OBJECT()

//
//Device type's definition.
//
#define PCI_DEVICE_TYPE_BRIDGE       0x00000001
#define PCI_DEVICE_TYPE_NORMAL       0x00000002
#define PCI_DEVICE_TYPE_CARDBUS      0x00000004
#define PCI_DEVICE_TYPE_UNSUPPORTED  0x00000008
#define PCI_DEVICE_TYPE_EMPTY        0x00000000