pci: remove PIO pci_{read,write}{8,16,32} declarations
[akaros.git] / kern / arch / x86 / pci.h
index 85c70a7..89c355a 100644 (file)
@@ -4,13 +4,14 @@
  * Barret Rhoden <brho@cs.berkeley.edu>
  * Original by Paul Pearce <pearce@eecs.berkeley.edu> */
 
-#ifndef ROS_ARCH_PCI_H
-#define ROS_ARCH_PCI_H
+#pragma once
 
 #include <ros/common.h>
 #include <sys/queue.h>
+#include <atomic.h>
+#include <arch/pci_regs.h>
 
-#define pci_debug(...)  printk(__VA_ARGS__)  
+#define pci_debug(...)  printk(__VA_ARGS__)
 
 #define PCI_CONFIG_ADDR     0xCF8
 #define PCI_CONFIG_DATA     0xCFC
@@ -29,7 +30,7 @@
 #define PCI_DEV_VEND_REG       0x00    /* for the 32 bit read of dev/vend */
 #define PCI_VENDID_REG         0x00
 #define PCI_DEVID_REG          0x02
-#define PCI_CMD_REG                    0x04
+#define PCI_CMD_REG            0x04
 #define PCI_STATUS_REG         0x06
 #define PCI_REVID_REG          0x08
 #define PCI_PROGIF_REG         0x09
@@ -46,7 +47,7 @@
 #define PCI_BAR3_STD           0x1c
 #define PCI_BAR4_STD           0x20
 #define PCI_BAR5_STD           0x24
-#define PCI_BAR_OFF                    0x04
+#define PCI_BAR_OFF            0x04
 #define PCI_CARDBUS_STD                0x28
 #define PCI_SUBSYSVEN_STD      0x2c
 #define PCI_SUBSYSID_STD       0x2e
 /* Config space for header type 0x01 (PCI-PCI bridge) */
 /* None of these have been used, so if you use them, check them against
  * http://wiki.osdev.org/PCI#PCI_Device_Structure */
-#define PCI_BAR0_BR                    0x10
-#define PCI_BAR1_BR                    0x14
-#define PCI_BUS1_BR                    0x18
-#define PCI_BUS2_BR                    0x19
+#define PCI_BAR0_BR            0x10
+#define PCI_BAR1_BR            0x14
+#define PCI_BUS1_BR            0x18
+#define PCI_BUS2_BR            0x19
 #define PCI_SUBBUS_BR          0x1a
 #define PCI_LATTIM2_BR         0x1b
 #define PCI_IOBASE_BR          0x1c
 #define PCI_CMD_BUS_MAS                (1 << 2)
 #define PCI_CMD_SPC_CYC                (1 << 3)
 #define PCI_CMD_WR_EN          (1 << 4)
-#define PCI_CMD_VGA                    (1 << 5)
+#define PCI_CMD_VGA            (1 << 5)
 #define PCI_CMD_PAR_ERR                (1 << 6)
 /* #define PCI_CMD_XXX         (1 << 7) Reserved */
 #define PCI_CMD_SERR           (1 << 8)
 #define PCI_ST_PAR_ERR         (1 << 15)
 
 /* BARS: Base Address Registers */
-#define PCI_BAR_IO                     0x1                     /* 1 == IO, 0 == Mem */
+#define PCI_BAR_IO             0x1     /* 1 == IO, 0 == Mem */
 #define PCI_BAR_IO_MASK                0xfffffffc
 #define PCI_BAR_MEM_MASK       0xfffffff0
 #define PCI_MEMBAR_TYPE        (3 << 1)
 #define PCI_MEMBAR_32BIT       0x0
-#define PCI_MEMBAR_RESV        0x2                     /* type 0x1 shifted to MEMBAR_TYPE */
-#define PCI_MEMBAR_64BIT       0x4                     /* type 0x2 shifted to MEMBAR_TYPE */
+#define PCI_MEMBAR_RESV        0x2     /* type 0x1 shifted to MEMBAR_TYPE */
+#define PCI_MEMBAR_64BIT       0x4     /* type 0x2 shifted to MEMBAR_TYPE */
 
-#define PCI_MAX_BUS                    256
-#define PCI_MAX_DEV                    32
+#define PCI_MAX_BUS            256
+#define PCI_MAX_DEV            32
 #define PCI_MAX_FUNC           8
 
 // Run the PCI Code to loop over the PCI BARs. For now we don't use the BARs,
 // dont check em.
-#define CHECK_BARS                     0
+#define CHECK_BARS             0
 
-#define MAX_PCI_BAR                    6
+#define MAX_PCI_BAR            6
+
+/* Nothing yet, but this helps with Linux drivers. */
+struct device {
+};
 
 struct pci_bar {
-       uint32_t                                        raw_bar;
-       uint32_t                                        pio_base;
-       uint32_t                                        mmio_base32;
-       uint64_t                                        mmio_base64;
-       uint32_t                                        mmio_sz;
+       uint32_t                        raw_bar;
+       uint32_t                        pio_base;
+       uint32_t                        mmio_base32;
+       uint64_t                        mmio_base64;
+       uint32_t                        mmio_sz;
 };
 
-/* Struct for some meager contents of a PCI device */
 struct pci_device {
-       STAILQ_ENTRY(pci_device)        all_dev;        /* list of all devices */
-       SLIST_ENTRY(pci_device)         irq_dev;        /* list of all devs off an irq */
-       bool                                            in_use;         /* prevent double discovery */
-       uint8_t                                         bus;
-       uint8_t                                         dev;
-       uint8_t                                         func;
-       uint16_t                                        dev_id;
-       uint16_t                                        ven_id;
-       uint8_t                                         irqline;
-       uint8_t                                         irqpin;
-       char                                            *header_type;
-       uint8_t                                         class;
-       uint8_t                                         subclass;
-       uint8_t                                         progif;
-       uint8_t                                         nr_bars;
-       struct pci_bar                          bar[MAX_PCI_BAR];
+       STAILQ_ENTRY(pci_device)        all_dev; /* list of all devices */
+       SLIST_ENTRY(pci_device)         irq_dev; /* list of all devs on irq */
+       char                            name[9];
+       spinlock_t                      lock;
+       void                            *dev_data; /* device private pointer */
+       struct device                   device;
+       bool                            in_use; /* prevent double discovery */
+       uint8_t                         bus;
+       uint8_t                         dev;
+       uint8_t                         func;
+       uint16_t                        dev_id;
+       uint16_t                        ven_id;
+       uint8_t                         irqline;
+       uint8_t                         irqpin;
+       char                            *header_type;
+       uint8_t                         class;
+       uint8_t                         subclass;
+       uint8_t                         progif;
+       bool                            msi_ready;
+       uint32_t                        msi_msg_addr_hi;
+       uint32_t                        msi_msg_addr_lo;
+       uint32_t                        msi_msg_data;
+       uint8_t                         nr_bars;
+       struct pci_bar                  bar[MAX_PCI_BAR];
+       uint32_t                        caps[PCI_CAP_ID_MAX + 1];
+       uintptr_t                       msix_tbl_paddr;
+       uintptr_t                       msix_tbl_vaddr;
+       uintptr_t                       msix_pba_paddr;
+       uintptr_t                       msix_pba_vaddr;
+       unsigned int                    msix_nr_vec;
+       bool                            msix_ready;
+};
+
+struct msix_entry {
+       uint32_t addr_lo, addr_hi, data, vector;
+};
+
+struct msix_irq_vector {
+       struct pci_device               *pcidev;
+       struct msix_entry               *entry;
+       uint32_t                        addr_lo;
+       uint32_t                        addr_hi;
+       uint32_t                        data;
 };
 
 /* List of all discovered devices */
 STAILQ_HEAD(pcidev_stailq, pci_device);
-SLIST_HEAD(pcidev_slist, pci_device);
 extern struct pcidev_stailq pci_devices;
 
+/* Sync rules for PCI: once a device is added to the list, it is never removed,
+ * and its read-only fields can be accessed at any time.  There is no need for
+ * refcnts or things like that.
+ *
+ * The device list is built early on when we're single threaded, so I'm not
+ * bothering with locks for that yet.  Append-only, singly-linked-list reads
+ * don't need a lock either.
+ *
+ * Other per-device accesses (like read-modify-writes to config space or MSI
+ * fields) require the device's lock.  If we ever want to unplug, we'll probably
+ * work out an RCU-like scheme for the pci_devices list.
+ *
+ * Note this is in addition to the config space global locking done by every
+ * pci_read or write call. */
+
 void pci_init(void);
 void pcidev_print_info(struct pci_device *pcidev, int verbosity);
-uint32_t pci_config_addr(uint8_t bus, uint8_t dev, uint8_t func, uint8_t reg);
-
-/* Read and write helpers (Eventually, we should have these be statics, since no
- * device should touch PCI config space). */
-uint32_t pci_read32(uint8_t bus, uint8_t dev, uint8_t func, uint8_t offset);
-void pci_write32(uint8_t bus, uint8_t dev, uint8_t func, uint8_t offset,
-                 uint32_t value);
-uint32_t pcidev_read32(struct pci_device *pcidev, uint8_t offset);
-void pcidev_write32(struct pci_device *pcidev, uint8_t offset, uint32_t value);
-uint16_t pcidev_read16(struct pci_device *pcidev, uint8_t offset);
-void pcidev_write16(struct pci_device *pcidev, uint8_t offset, uint16_t value);
-uint8_t pcidev_read8(struct pci_device *pcidev, uint8_t offset);
-void pcidev_write8(struct pci_device *pcidev, uint8_t offset, uint8_t value);
-
-/* BAR helpers, some more helpful than others. */
-uint32_t pci_membar_get_sz(struct pci_device *pcidev, int bar);
-uint32_t pci_getbar(struct pci_device *pcidev, unsigned int bar);
-bool pci_is_iobar(uint32_t bar);
-bool pci_is_membar32(uint32_t bar);
-bool pci_is_membar64(uint32_t bar);
-uint32_t pci_getmembar32(uint32_t bar);
-uint32_t pci_getiobar32(uint32_t bar);
+uint32_t pci_config_addr(uint8_t bus, uint8_t dev, uint8_t func, uint32_t reg);
+
+uint32_t pcidev_read32(struct pci_device *pcidev, uint32_t offset);
+void pcidev_write32(struct pci_device *pcidev, uint32_t offset, uint32_t value);
+uint16_t pcidev_read16(struct pci_device *pcidev, uint32_t offset);
+void pcidev_write16(struct pci_device *pcidev, uint32_t offset, uint16_t value);
+uint8_t pcidev_read8(struct pci_device *pcidev, uint32_t offset);
+void pcidev_write8(struct pci_device *pcidev, uint32_t offset, uint8_t value);
 
 /* Other common PCI functions */
 void pci_set_bus_master(struct pci_device *pcidev);
+void pci_clr_bus_master(struct pci_device *pcidev);
+struct pci_device *pci_match_tbdf(int tbdf);
+uintptr_t pci_get_membar(struct pci_device *pcidev, int bir);
+uintptr_t pci_get_iobar(struct pci_device *pcidev, int bir);
+uint32_t pci_get_membar_sz(struct pci_device *pcidev, int bir);
+uint16_t pci_get_vendor(struct pci_device *pcidev);
+uint16_t pci_get_device(struct pci_device *pcidev);
+uint16_t pci_get_subvendor(struct pci_device *pcidev);
+uint16_t pci_get_subdevice(struct pci_device *pcidev);
+void pci_dump_config(struct pci_device *pcidev, size_t len);
+int pci_find_cap(struct pci_device *pcidev, uint8_t cap_id, uint32_t *cap_reg);
+unsigned int pci_to_tbdf(struct pci_device *pcidev);
+uintptr_t pci_map_membar(struct pci_device *dev, int bir);
+int pci_set_cacheline_size(struct pci_device *dev);
+int pci_set_mwi(struct pci_device *dev);
+void pci_clear_mwi(struct pci_device *dev);
+static inline void pci_set_drvdata(struct pci_device *pcidev, void *data);
+static inline void *pci_get_drvdata(struct pci_device *pcidev);
+
+/* MSI functions, msi.c */
+int pci_msi_enable(struct pci_device *p, uint64_t vec);
+int pci_msix_init(struct pci_device *p);
+struct msix_irq_vector *pci_msix_enable(struct pci_device *p, uint64_t vec);
+void pci_msi_mask(struct pci_device *p);
+void pci_msi_unmask(struct pci_device *p);
+void pci_msi_route(struct pci_device *p, int dest);
+void pci_msix_mask_vector(struct msix_irq_vector *linkage);
+void pci_msix_unmask_vector(struct msix_irq_vector *linkage);
+void pci_msix_route_vector(struct msix_irq_vector *linkage, int dest);
+
+/* TODO: this is quite the Hacke */
+#define explode_tbdf(tbdf) {pcidev.bus = tbdf >> 16;\
+               pcidev.dev = (tbdf>>11)&0x1f;\
+               pcidev.func = (tbdf>>8)&3;}
+
+static inline void pci_set_drvdata(struct pci_device *pcidev, void *data)
+{
+       pcidev->dev_data = data;
+}
 
-#endif /* ROS_ARCH_PCI_H */
+static inline void *pci_get_drvdata(struct pci_device *pcidev)
+{
+       return pcidev->dev_data;
+}