src/include/device/device.h

   1 #ifndef DEVICE_H
   2 #define DEVICE_H
   3
   4 #include <stdint.h>
   5 #include <device/resource.h>
   6 #include <device/path.h>
   7
   8
   9 struct device;
  10 typedef struct device * device_t;
  11 struct pci_operations;
  12 struct pci_bus_operations;
  13 struct smbus_bus_operations;
  14
  15 /* Chip operations */
  16 struct chip_operations {
  17         void (*enable_dev)(struct device *dev);
  18         const char *name;
  19 };
  20
  21 #define CHIP_NAME(X) .name = X,
  22
  23 struct bus;
  24
  25 struct device_operations {
  26         void (*read_resources)(device_t dev);
  27         void (*set_resources)(device_t dev);
  28         void (*enable_resources)(device_t dev);
  29         void (*init)(device_t dev);
  30         unsigned int (*scan_bus)(device_t bus, unsigned int max);
  31         void (*enable)(device_t dev);
  32         void (*set_link)(device_t dev, unsigned int link);
  33         void (*reset_bus)(struct bus *bus);
  34         const struct pci_operations *ops_pci;
  35         const struct smbus_bus_operations *ops_smbus_bus;
  36         const struct pci_bus_operations *ops_pci_bus;
  37 };
  38
  39
  40 struct bus {
  41         device_t        dev;            /* This bridge device */
  42         device_t        children;       /* devices behind this bridge */
  43         unsigned        bridge_ctrl;    /* Bridge control register */
  44         unsigned char   link;           /* The index of this link */
  45         uint16_t        secondary;      /* secondary bus number */
  46         uint16_t        subordinate;    /* max subordinate bus number */
  47         unsigned char   cap;            /* PCi capability offset */
  48         unsigned        reset_needed : 1;
  49         unsigned        disable_relaxed_ordering : 1;
  50 };
  51
  52 #define MAX_RESOURCES 24
  53 #define MAX_LINKS    8
  54 /*
  55  * There is one device structure for each slot-number/function-number
  56  * combination:
  57  */
  58
  59 struct device {
  60         struct bus *    bus;            /* bus this device is on, for bridge
  61                                          * devices, it is the up stream bus */
  62         device_t        sibling;        /* next device on this bus */
  63         device_t        next;           /* chain of all devices */
  64
  65         struct device_path path;
  66         unsigned        vendor;
  67         unsigned        device;
  68         unsigned int    class;          /* 3 bytes: (base, sub, prog-if) */
  69         unsigned int    hdr_type;       /* PCI header type */
  70         unsigned int    enabled : 1;    /* set if we should enable the device */
  71         unsigned int    initialized : 1; /* set if we have initialized the device */
  72         unsigned int    on_mainboard : 1;
  73
  74         u8 command;
  75
  76         /* Base registers for this device. I/O, MEM and Expansion ROM */
  77         struct resource resource[MAX_RESOURCES];
  78         unsigned int resources;
  79
  80         /* links are (downstream) buses attached to the device, usually a leaf
  81          * device with no children have 0 buses attached and a bridge has 1 bus
  82          */
  83         struct bus link[MAX_LINKS];
  84         /* number of buses attached to the device */
  85         unsigned int links;
  86
  87         struct device_operations *ops;
  88         const struct chip_operations *chip_ops;
  89         void *chip_info;
  90 };
  91
  92 /**
  93  * This is the root of the device tree. The device tree is defined in the
  94  * static.c file and is generated by the config tool at compile time.
  95  */
  96 extern struct device    dev_root;
  97 extern struct device    *all_devices;   /* list of all devices */
  98
  99
 100 /* Generic device interface functions */
 101 device_t alloc_dev(struct bus *parent, struct device_path *path);
 102 void dev_enumerate(void);
 103 void dev_configure(void);
 104 void dev_enable(void);
 105 void dev_initialize(void);
 106 void dev_optimize(void);
 107
 108 /* Generic device helper functions */
 109 int reset_bus(struct bus *bus);
 110 unsigned int scan_bus(struct device *bus, unsigned int max);
 111 void assign_resources(struct bus *bus);
 112 void enable_resources(struct device *dev);
 113 void enumerate_static_device(void);
 114 void enumerate_static_devices(void);
 115 const char *dev_path(device_t dev);
 116 const char *bus_path(struct bus *bus);
 117 void dev_set_enabled(device_t dev, int enable);
 118 void disable_children(struct bus *bus);
 119
 120 /* Option ROM helper functions */
 121 void run_bios(struct device *dev, unsigned long addr);
 122
 123 /* Helper functions */
 124 device_t find_dev_path(struct bus *parent, struct device_path *path);
 125 device_t alloc_find_dev(struct bus *parent, struct device_path *path);
 126 device_t dev_find_device (unsigned int vendor, unsigned int device, device_t from);
 127 device_t dev_find_class (unsigned int class, device_t from);
 128 device_t dev_find_slot (unsigned int bus, unsigned int devfn);
 129 device_t dev_find_slot_on_smbus (unsigned int bus, unsigned int addr);
 130
 131 /* Debug functions */
 132 void print_resource_tree(struct device * root, int debug_level,
 133                          const char *msg);
 134 void show_devs_tree(struct device *dev, int debug_level, int depth, int linknum);
 135 void show_devs_subtree(struct device *root, int debug_level, const char *msg);
 136 void show_all_devs(int debug_level, const char *msg);
 137 void show_all_devs_tree(int debug_level, const char *msg);
 138 void show_one_resource(int debug_level, struct device *dev,
 139                        struct resource *resource, const char *comment);
 140 void show_all_devs_resources(int debug_level, const char* msg);
 141
 142 /* Rounding for boundaries.
 143  * Due to some chip bugs, go ahead and round IO to 16
 144  */
 145 #define DEVICE_IO_ALIGN 16
 146 #define DEVICE_MEM_ALIGN 4096
 147
 148 extern struct device_operations default_dev_ops_root;
 149 void pci_domain_read_resources(struct device *dev);
 150 unsigned int pci_domain_scan_bus(struct device *dev, unsigned int max);
 151 void root_dev_read_resources(device_t dev);
 152 void root_dev_set_resources(device_t dev);
 153 unsigned int scan_static_bus(device_t bus, unsigned int max);
 154 void enable_childrens_resources(device_t dev);
 155 void root_dev_enable_resources(device_t dev);
 156 unsigned int root_dev_scan_bus(device_t root, unsigned int max);
 157 void root_dev_init(device_t dev);
 158 void root_dev_reset(struct bus *bus);
 159 #endif /* DEVICE_H */