root/Whitix/trunk/include/pci.h

/*  This file is part of Whitix.
 *
 *  Whitix is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  Whitix is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Whitix; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef PCI_H
#define PCI_H

#include <devices/bus.h>
#include <console.h>
#include <module.h>
#include <typedefs.h>
#include <resource.h>

struct PciBus
{
        int index;
        struct ListHead next;
        struct ListHead deviceList;
        struct KeBus bus;
};

struct PciDriver;

struct PciDevice
{
        /* PCI configuration information; cached. */
        BYTE dev, func, headerType;
        DWORD vendorId, deviceId;
        int irq;
        DWORD devClass;
        WORD subVendor, subDevice;

        struct Resource spaces[6];
        
        /* PCI layer data. */
        struct PciBus* bus;
        struct PciDriver* driver;
        struct KeBusEntry entry;
        
        void* driverData;

        struct ListHead next;
};

#define PciSetData(driver, data) ((driver)->driverData = (data))

/* PCI BIOS structure. */
struct PciBios
{
        DWORD magicNumber;
        DWORD physEntry;
        BYTE version;
        BYTE length;
        BYTE crc;
        BYTE reserved[5];
}PACKED;

/* PCI configuration space registers */
#define PCI_VENDOR_ID           0x00
#define PCI_DEVICE_ID           0x02
#define PCI_COMMAND                     0x04
#define         PCI_COMMAND_IO          0x01
#define         PCI_COMMAND_MEM         0x02
#define         PCI_COMMAND_MASTER      0x04
#define PCI_SUBSYS_VENDOR_ID 0x2C
#define PCI_SUBSYS_ID           0x2E
#define PCI_INTERRUPT_PIN       0x3D

#define PCI_PRIMARY_BUS         0x18
#define PCI_SECONDARY_BUS       0x19

#define PCI_WRITE_TEST  0xFFFFFFFF
#define PCI_BAR_BASE    0x10

/* NUmber of I/O resource slots for each device. */
#define PCI_NUM_RESOURCES       6

#define PCI_RESOURCE_IO         0x01

extern int (*PciRead)(int bus, int dev, int func, int reg, int bytes, DWORD* val);
extern int (*PciWrite)(int bus, int dev, int func, int reg, DWORD v, int bytes);

/* Internal functions */
int PciDetectBios();

/* Internal defines */
#define PCI_VENDOR_INVALID(vendorId) (((vendorId) == 0xFFFF) || ((vendorId) == 0x0000))
#define PCI_RES_BEGIN_MASK(addressReg) ((addressReg) & 0xFFFFFFF0)

/*** LIBRARY CODE ***/

/* PCI library structures. Used by drivers. */

#define PCI_ID_ANY      (DWORD)(~0)     /* Used if the driver doesn't care about a certain ID field. */

#define PciIdTableEnd() {0, 0, 0, 0, 0, 0, NULL}

#define PCI_ID_DATA(id) ((id)->data)

struct PciDeviceId
{
        DWORD vendorId, deviceId;
        DWORD subVendor, subDevice;
        DWORD class, classMask;
        void* data;
};

/* PCI device classes. */
#define PCI_BASE_CLASS_DISPLAY          0x03

struct PciDriver
{
        char* name;
        struct PciDeviceId* idTable;

        /* Function pointers. */
        int (*initOne)(struct PciDevice* device, struct PciDeviceId* devId);

        /* Internal data */
        struct Module* module;
        struct ListHead next;
        void* data;
};

/* PCI library functions. Used by drivers. */
int PciEnableDevice(struct PciDevice* device);
int PciDisableDevice(struct PciDevice* device);
int PciSetMaster(struct PciDevice* device);
int PciRegisterDriverMod(struct Module* module, struct PciDriver* pciDriver);
#define PciRegisterDriver(driver) (PciRegisterDriverMod(THIS_MODULE, (driver)))

int PciWriteConfigByte(struct PciDevice* device, int reg, BYTE value);
int PciReadConfigByte(struct PciDevice* device, int reg, BYTE* value);
int PciReadConfigWord(struct PciDevice* device, int reg, WORD* value);
int PciWriteConfigWord(struct PciDevice* device, int reg, WORD value);

int PciReadConfigDword(struct PciDevice* device, int reg, DWORD* value);
int PciWriteConfigDword(struct PciDevice* device, int reg, DWORD value);

/* Inline library functions */
static inline unsigned long PciResourceStart(struct PciDevice* device, int index)
{
        if (index < 0 || index >= 6)
                return 0;
                
        return device->spaces[index].start;
}

static inline unsigned long PciResourceLen(struct PciDevice* device, int index)
{
        if (index < 0 || index >= 6)
                return 0;
                
        return device->spaces[index].len;
}

static inline unsigned long PciResourceFlags(struct PciDevice* device, int index)
{
        if (index < 0 || index >= 6)
                return 0;
                
        return device->spaces[index].flags;
}

#endif