system/include/ke/pci.h

   1 /*
   2 Copyright (C) 2008  Mathias Gottschlag
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy of
   5 this software and associated documentation files (the "Software"), to deal in the
   6 Software without restriction, including without limitation the rights to use,
   7 copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
   8 Software, and to permit persons to whom the Software is furnished to do so,
   9 subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all
  12 copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  15 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  16 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  17 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  18 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  19 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20 */
  21 /**
  22  * \file pci.h
  23  * PCI functions.
  24  */
  25
  26 #ifndef KE_PCI_H_INCLUDED
  27 #define KE_PCI_H_INCLUDED
  28
  29 #include <stdint.h>
  30
  31 #define KE_ADDR_MEMORY 0
  32 #define KE_ADDR_PORT 1
  33
  34 /**
  35  * PCI device resource. Can be either a port address or a memory address.
  36  */
  37 typedef struct
  38 {
  39         /**
  40          * Base address of the resource.
  41          */
  42         uintptr_t addr;
  43         /**
  44          * Approximated size of the resource.
  45          */
  46         uint32_t size;
  47         /**
  48          * Type of the resource.
  49          */
  50         uint8_t type;
  51 } KePCIResource;
  52
  53 /**
  54  * Struct holding the information about a PCI device.
  55  */
  56 typedef struct
  57 {
  58         uint8_t bus;
  59         uint8_t slot;
  60         uint8_t func;
  61
  62         /**
  63          * Device class.
  64          */
  65         uint8_t devclass;
  66         /**
  67          * Device subclass.
  68          */
  69         uint8_t subclass;
  70         /**
  71          * Device revision.
  72          */
  73         uint16_t revision;
  74
  75         /**
  76          * Device ID.
  77          */
  78         uint16_t device;
  79         /**
  80          * Vendor ID.
  81          */
  82         uint16_t vendor;
  83
  84         /**
  85          * Number of valid resources.
  86          */
  87         uint32_t rescount;
  88         /**
  89          * Resources. Only rescount entries are valid.
  90          */
  91         KePCIResource res[6];
  92         /**
  93          * Device IRQ.
  94          */
  95         uint8_t irq;
  96 } KePCIDevice;
  97
  98 /**
  99  * Initializes the PCI functions.
 100  */
 101 int keInitPCI(void);
 102
 103 /**
 104  * Fills device with the info about the device at the given address.
 105  * \param device Pointer to the struct to be filled.
 106  * \param bus Bus of the device.
 107  * \param slot Slot of the device on the given bus.
 108  * \param func Function number.
 109  * \return Returns 0 if the device is available.
 110  */
 111 int keGetPCIDevice(KePCIDevice *device, uint8_t bus, uint8_t slot, uint8_t func);
 112 /**
 113  * Returns the number of PCI devices in the system.
 114  */
 115 int keGetPCIDeviceCount(void);
 116 /**
 117  * Returns a pointer to structs holding the information about the PCI devices
 118  * in the system. The returned buffer holds keGetPCIDeviceCount() devices.
 119  */
 120 KePCIDevice *keGetPCIDevices(void);
 121
 122 #endif
 123