Martin Roth | 239b5df | 2022-07-26 22:18:26 -0600 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
| 2 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 3 | #ifndef DEVICE_H |
Aaron Durbin | a0dabd1 | 2018-07-25 08:49:19 -0600 | [diff] [blame] | 4 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 5 | #define DEVICE_H |
| 6 | |
| 7 | #include <device/resource.h> |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 8 | #include <device/path.h> |
Elyes HAOUAS | e3682b6 | 2018-12-03 09:32:31 +0100 | [diff] [blame] | 9 | #include <device/pci_type.h> |
Elyes HAOUAS | c712144 | 2020-04-10 18:04:59 +0200 | [diff] [blame] | 10 | #include <smbios.h> |
Furquan Shaikh | 28e61f1 | 2021-01-06 22:40:40 -0800 | [diff] [blame] | 11 | #include <static.h> |
Julius Werner | a214837 | 2019-11-13 19:50:33 -0800 | [diff] [blame] | 12 | #include <types.h> |
Aaron Durbin | c30d913 | 2017-08-07 16:55:43 -0600 | [diff] [blame] | 13 | |
Duncan Laurie | 36e6c6f | 2020-05-09 19:20:10 -0700 | [diff] [blame] | 14 | struct fw_config; |
Elyes HAOUAS | f9e47cc | 2018-12-05 11:03:36 +0100 | [diff] [blame] | 15 | struct device; |
Eric Biederman | 992cd00 | 2004-10-14 21:10:23 +0000 | [diff] [blame] | 16 | struct pci_operations; |
Duncan Laurie | ec00968 | 2016-06-07 15:38:14 -0700 | [diff] [blame] | 17 | struct i2c_bus_operations; |
Eric Biederman | 992cd00 | 2004-10-14 21:10:23 +0000 | [diff] [blame] | 18 | struct smbus_bus_operations; |
Nico Huber | dd4715b | 2013-06-10 22:08:35 +0200 | [diff] [blame] | 19 | struct pnp_mode_ops; |
Furquan Shaikh | 7606c37 | 2017-02-11 10:57:23 -0800 | [diff] [blame] | 20 | struct spi_bus_operations; |
Duncan Laurie | bae9f85 | 2018-05-07 14:18:13 -0700 | [diff] [blame] | 21 | struct usb_bus_operations; |
Michael Niewöhner | dbb667a | 2020-12-11 21:26:02 +0100 | [diff] [blame] | 22 | struct gpio_operations; |
Mario Scheithauer | 67f63e7 | 2022-11-02 15:57:10 +0100 | [diff] [blame] | 23 | struct mdio_bus_operations; |
Eric Biederman | 7a5416a | 2003-06-12 19:23:51 +0000 | [diff] [blame] | 24 | |
Eric Biederman | 7003ba4 | 2004-10-16 06:20:29 +0000 | [diff] [blame] | 25 | /* Chip operations */ |
| 26 | struct chip_operations { |
Eric Biederman | 7003ba4 | 2004-10-16 06:20:29 +0000 | [diff] [blame] | 27 | void (*enable_dev)(struct device *dev); |
Nico Huber | acd7d95 | 2012-07-25 10:33:05 +0200 | [diff] [blame] | 28 | void (*init)(void *chip_info); |
Marc Jones | 2a58ecd | 2013-10-29 17:32:00 -0600 | [diff] [blame] | 29 | void (*final)(void *chip_info); |
Nico Huber | acd7d95 | 2012-07-25 10:33:05 +0200 | [diff] [blame] | 30 | unsigned int initialized : 1; |
Marc Jones | 2a58ecd | 2013-10-29 17:32:00 -0600 | [diff] [blame] | 31 | unsigned int finalized : 1; |
Myles Watson | 6e23576 | 2009-09-29 14:56:15 +0000 | [diff] [blame] | 32 | const char *name; |
Eric Biederman | 7003ba4 | 2004-10-16 06:20:29 +0000 | [diff] [blame] | 33 | }; |
| 34 | |
Eric Biederman | 018d8dd | 2004-11-04 11:04:33 +0000 | [diff] [blame] | 35 | #define CHIP_NAME(X) .name = X, |
Eric Biederman | 018d8dd | 2004-11-04 11:04:33 +0000 | [diff] [blame] | 36 | |
Yinghai Lu | 13f1c2a | 2005-07-08 02:49:49 +0000 | [diff] [blame] | 37 | struct bus; |
| 38 | |
Vladimir Serbinenko | 2d7bd8a | 2014-08-30 19:28:05 +0200 | [diff] [blame] | 39 | struct acpi_rsdp; |
Vladimir Serbinenko | 6abb33c | 2014-08-27 23:42:45 +0200 | [diff] [blame] | 40 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 41 | struct device_operations { |
Aaron Durbin | c30d913 | 2017-08-07 16:55:43 -0600 | [diff] [blame] | 42 | void (*read_resources)(struct device *dev); |
| 43 | void (*set_resources)(struct device *dev); |
| 44 | void (*enable_resources)(struct device *dev); |
| 45 | void (*init)(struct device *dev); |
| 46 | void (*final)(struct device *dev); |
| 47 | void (*scan_bus)(struct device *bus); |
| 48 | void (*enable)(struct device *dev); |
Arthur Heymans | b238caa | 2021-02-22 18:33:08 +0100 | [diff] [blame] | 49 | void (*vga_disable)(struct device *dev); |
Yinghai Lu | 13f1c2a | 2005-07-08 02:49:49 +0000 | [diff] [blame] | 50 | void (*reset_bus)(struct bus *bus); |
Felix Held | ab8a094 | 2023-11-16 13:38:14 +0100 | [diff] [blame] | 51 | |
Aaron Durbin | c30d913 | 2017-08-07 16:55:43 -0600 | [diff] [blame] | 52 | int (*get_smbios_data)(struct device *dev, int *handle, |
Lee Leahy | 6a566d7 | 2017-03-07 17:45:12 -0800 | [diff] [blame] | 53 | unsigned long *current); |
Aaron Durbin | c30d913 | 2017-08-07 16:55:43 -0600 | [diff] [blame] | 54 | void (*get_smbios_strings)(struct device *dev, struct smbios_type11 *t); |
Felix Held | ab8a094 | 2023-11-16 13:38:14 +0100 | [diff] [blame] | 55 | |
Furquan Shaikh | 0f007d8 | 2020-04-24 06:41:18 -0700 | [diff] [blame] | 56 | unsigned long (*write_acpi_tables)(const struct device *dev, |
Aaron Durbin | c30d913 | 2017-08-07 16:55:43 -0600 | [diff] [blame] | 57 | unsigned long start, struct acpi_rsdp *rsdp); |
Furquan Shaikh | 7536a39 | 2020-04-24 21:59:21 -0700 | [diff] [blame] | 58 | void (*acpi_fill_ssdt)(const struct device *dev); |
Aaron Durbin | aa090cb | 2017-09-13 16:01:52 -0600 | [diff] [blame] | 59 | const char *(*acpi_name)(const struct device *dev); |
Patrick Rudolph | eeb8e74 | 2019-08-20 08:20:01 +0200 | [diff] [blame] | 60 | /* Returns the optional _HID (Hardware ID) */ |
| 61 | const char *(*acpi_hid)(const struct device *dev); |
Felix Held | 10e478c4 | 2023-10-23 21:26:54 +0200 | [diff] [blame] | 62 | |
Eric Biederman | a9e632c | 2004-11-18 22:38:08 +0000 | [diff] [blame] | 63 | const struct pci_operations *ops_pci; |
Duncan Laurie | ec00968 | 2016-06-07 15:38:14 -0700 | [diff] [blame] | 64 | const struct i2c_bus_operations *ops_i2c_bus; |
Furquan Shaikh | 7606c37 | 2017-02-11 10:57:23 -0800 | [diff] [blame] | 65 | const struct spi_bus_operations *ops_spi_bus; |
Eric Biederman | a9e632c | 2004-11-18 22:38:08 +0000 | [diff] [blame] | 66 | const struct smbus_bus_operations *ops_smbus_bus; |
Nico Huber | dd4715b | 2013-06-10 22:08:35 +0200 | [diff] [blame] | 67 | const struct pnp_mode_ops *ops_pnp_mode; |
Michael Niewöhner | dbb667a | 2020-12-11 21:26:02 +0100 | [diff] [blame] | 68 | const struct gpio_operations *ops_gpio; |
Mario Scheithauer | 67f63e7 | 2022-11-02 15:57:10 +0100 | [diff] [blame] | 69 | const struct mdio_bus_operations *ops_mdio; |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 70 | }; |
Kyösti Mälkki | f41cb4e | 2014-06-30 13:15:42 +0300 | [diff] [blame] | 71 | |
Edward O'Callaghan | 530355d | 2014-10-31 08:31:44 +1100 | [diff] [blame] | 72 | /** |
| 73 | * Standard device operations function pointers shims. |
| 74 | */ |
Nico Huber | 2f8ba69 | 2020-04-05 14:05:24 +0200 | [diff] [blame] | 75 | static inline void noop_read_resources(struct device *dev) {} |
| 76 | static inline void noop_set_resources(struct device *dev) {} |
Edward O'Callaghan | 530355d | 2014-10-31 08:31:44 +1100 | [diff] [blame] | 77 | |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 78 | struct bus { |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 79 | DEVTREE_CONST struct device *dev; /* This bridge device */ |
| 80 | DEVTREE_CONST struct device *children; /* devices behind this bridge */ |
Felix Held | 0154fa5 | 2023-08-08 15:43:55 +0200 | [diff] [blame] | 81 | DEVTREE_CONST struct bus *next; /* The next bridge on this device */ |
| 82 | unsigned int bridge_ctrl; /* Bridge control register */ |
Kyösti Mälkki | 3345240 | 2015-02-23 06:58:26 +0200 | [diff] [blame] | 83 | uint16_t bridge_cmd; /* Bridge command register */ |
Felix Held | 0154fa5 | 2023-08-08 15:43:55 +0200 | [diff] [blame] | 84 | unsigned char link_num; /* The index of this link */ |
| 85 | uint16_t secondary; /* secondary bus number */ |
| 86 | uint16_t subordinate; /* subordinate bus number */ |
Arthur Heymans | 20d2577 | 2021-11-17 17:25:48 +0100 | [diff] [blame] | 87 | uint16_t max_subordinate; /* max subordinate bus number */ |
Felix Held | 3b5b66d | 2024-01-11 22:26:18 +0100 | [diff] [blame] | 88 | uint8_t segment_group; /* PCI segment group */ |
Kyösti Mälkki | 7752147 | 2015-02-22 11:38:49 +0200 | [diff] [blame] | 89 | |
Lee Leahy | 0ca2a06 | 2017-03-06 18:01:04 -0800 | [diff] [blame] | 90 | unsigned int reset_needed : 1; |
Felix Held | 0154fa5 | 2023-08-08 15:43:55 +0200 | [diff] [blame] | 91 | unsigned int no_vga16 : 1; /* No support for 16-bit VGA decoding */ |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 92 | }; |
| 93 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 94 | /* |
Eric Biederman | 2c018fb | 2003-07-21 20:13:45 +0000 | [diff] [blame] | 95 | * There is one device structure for each slot-number/function-number |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 96 | * combination: |
| 97 | */ |
| 98 | |
| 99 | struct device { |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 100 | DEVTREE_CONST struct bus *bus; /* bus this device is on, for bridge |
Li-Ta Lo | 0493069 | 2004-11-25 17:37:19 +0000 | [diff] [blame] | 101 | * devices, it is the up stream bus */ |
Stefan Reinauer | 57879c9 | 2012-07-31 16:47:25 -0700 | [diff] [blame] | 102 | |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 103 | DEVTREE_CONST struct device *sibling; /* next device on this bus */ |
Stefan Reinauer | 57879c9 | 2012-07-31 16:47:25 -0700 | [diff] [blame] | 104 | |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 105 | DEVTREE_CONST struct device *next; /* chain of all devices */ |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 106 | |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 107 | struct device_path path; |
Lee Leahy | 0ca2a06 | 2017-03-06 18:01:04 -0800 | [diff] [blame] | 108 | unsigned int vendor; |
| 109 | unsigned int device; |
Sven Schnelle | b8269e2 | 2011-03-01 21:51:29 +0000 | [diff] [blame] | 110 | u16 subsystem_vendor; |
| 111 | u16 subsystem_device; |
Stefan Reinauer | debb11f | 2008-10-29 04:46:52 +0000 | [diff] [blame] | 112 | unsigned int class; /* 3 bytes: (base, sub, prog-if) */ |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 113 | unsigned int hdr_type; /* PCI header type */ |
Li-Ta Lo | 69c5a90 | 2004-04-29 20:08:54 +0000 | [diff] [blame] | 114 | unsigned int enabled : 1; /* set if we should enable the device */ |
Lee Leahy | 6a566d7 | 2017-03-07 17:45:12 -0800 | [diff] [blame] | 115 | unsigned int initialized : 1; /* 1 if we have initialized the device */ |
Eric Biederman | dbec2d4 | 2004-10-21 10:44:08 +0000 | [diff] [blame] | 116 | unsigned int on_mainboard : 1; |
Nico Huber | 570b183 | 2017-08-30 13:38:50 +0200 | [diff] [blame] | 117 | unsigned int disable_pcie_aspm : 1; |
Ronald G. Minnich | 466ca2c | 2019-10-22 02:02:24 +0000 | [diff] [blame] | 118 | /* set if we should hide from UI */ |
| 119 | unsigned int hidden : 1; |
| 120 | /* set if this device is used even in minimum PCI cases */ |
| 121 | unsigned int mandatory : 1; |
Nico Huber | 577c6b9 | 2022-08-15 00:08:58 +0200 | [diff] [blame] | 122 | unsigned int hotplug_port : 1; |
Myles Watson | 29cc9ed | 2009-07-02 18:56:24 +0000 | [diff] [blame] | 123 | u8 command; |
Jeremy Soller | cf2ac54 | 2019-10-09 21:40:36 -0600 | [diff] [blame] | 124 | uint16_t hotplug_buses; /* Number of hotplug buses to allocate */ |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 125 | |
Li-Ta Lo | 85e76c6 | 2004-12-27 17:53:45 +0000 | [diff] [blame] | 126 | /* Base registers for this device. I/O, MEM and Expansion ROM */ |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 127 | DEVTREE_CONST struct resource *resource_list; |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 128 | |
Myles Watson | 29cc9ed | 2009-07-02 18:56:24 +0000 | [diff] [blame] | 129 | /* links are (downstream) buses attached to the device, usually a leaf |
Myles Watson | c25cc11 | 2010-05-21 14:33:48 +0000 | [diff] [blame] | 130 | * device with no children has 0 buses attached and a bridge has 1 bus |
Yinghai Lu | 13f1c2a | 2005-07-08 02:49:49 +0000 | [diff] [blame] | 131 | */ |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 132 | DEVTREE_CONST struct bus *link_list; |
Eric Biederman | e9a271e3 | 2003-09-02 03:36:25 +0000 | [diff] [blame] | 133 | |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 134 | #if !DEVTREE_EARLY |
Kyösti Mälkki | cac0231 | 2019-06-30 08:40:04 +0300 | [diff] [blame] | 135 | struct device_operations *ops; |
Nico Huber | acd7d95 | 2012-07-25 10:33:05 +0200 | [diff] [blame] | 136 | struct chip_operations *chip_ops; |
Kyösti Mälkki | 7d54eb8 | 2012-10-10 23:14:28 +0300 | [diff] [blame] | 137 | const char *name; |
Patrick Rudolph | ac24d3c | 2019-04-12 14:42:17 +0200 | [diff] [blame] | 138 | #if CONFIG(GENERATE_SMBIOS_TABLES) |
| 139 | u8 smbios_slot_type; |
| 140 | u8 smbios_slot_data_width; |
| 141 | u8 smbios_slot_length; |
| 142 | const char *smbios_slot_designation; |
Angel Pons | 437da71 | 2021-09-03 16:51:40 +0200 | [diff] [blame] | 143 | |
| 144 | #if CONFIG(SMBIOS_TYPE41_PROVIDED_BY_DEVTREE) |
| 145 | /* |
| 146 | * These fields are intentionally guarded so that attempts to use |
| 147 | * the corresponding devicetree syntax without selecting the Kconfig |
| 148 | * option result in build-time errors. Smaller size is a side effect. |
| 149 | */ |
| 150 | bool smbios_instance_id_valid; |
| 151 | u8 smbios_instance_id; |
| 152 | const char *smbios_refdes; |
| 153 | #endif |
Patrick Rudolph | ac24d3c | 2019-04-12 14:42:17 +0200 | [diff] [blame] | 154 | #endif |
Stefan Reinauer | a675d49 | 2012-08-07 14:50:47 -0700 | [diff] [blame] | 155 | #endif |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 156 | DEVTREE_CONST void *chip_info; |
Duncan Laurie | 36e6c6f | 2020-05-09 19:20:10 -0700 | [diff] [blame] | 157 | |
| 158 | /* Zero-terminated array of fields and options to probe. */ |
| 159 | DEVTREE_CONST struct fw_config *probe_list; |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 160 | }; |
| 161 | |
Myles Watson | 3fe6b70 | 2009-10-09 20:13:43 +0000 | [diff] [blame] | 162 | /** |
| 163 | * This is the root of the device tree. The device tree is defined in the |
| 164 | * static.c file and is generated by the config tool at compile time. |
| 165 | */ |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 166 | extern DEVTREE_CONST struct device dev_root; |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 167 | /* list of all devices */ |
| 168 | extern DEVTREE_CONST struct device * DEVTREE_CONST all_devices; |
Myles Watson | c25cc11 | 2010-05-21 14:33:48 +0000 | [diff] [blame] | 169 | extern struct resource *free_resources; |
Myles Watson | 894a347 | 2010-06-09 22:41:35 +0000 | [diff] [blame] | 170 | extern struct bus *free_links; |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 171 | |
| 172 | /* Generic device interface functions */ |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 173 | struct device *alloc_dev(struct bus *parent, struct device_path *path); |
Arthur Heymans | 3e99ba0 | 2024-01-25 22:26:07 +0100 | [diff] [blame] | 174 | struct bus *alloc_bus(struct device *parent); |
Nico Huber | acd7d95 | 2012-07-25 10:33:05 +0200 | [diff] [blame] | 175 | void dev_initialize_chips(void); |
Stefan Reinauer | be7f798 | 2009-03-13 15:42:27 +0000 | [diff] [blame] | 176 | void dev_enumerate(void); |
| 177 | void dev_configure(void); |
| 178 | void dev_enable(void); |
| 179 | void dev_initialize(void); |
Marc Jones | 2a58ecd | 2013-10-29 17:32:00 -0600 | [diff] [blame] | 180 | void dev_finalize(void); |
| 181 | void dev_finalize_chips(void); |
Subrata Banik | ed5c7ac | 2021-06-10 13:04:07 +0530 | [diff] [blame] | 182 | /* Function used to override device state */ |
| 183 | void devfn_disable(const struct bus *bus, unsigned int devfn); |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 184 | |
| 185 | /* Generic device helper functions */ |
Stefan Reinauer | be7f798 | 2009-03-13 15:42:27 +0000 | [diff] [blame] | 186 | int reset_bus(struct bus *bus); |
Kyösti Mälkki | 2d2367c | 2015-02-20 21:28:31 +0200 | [diff] [blame] | 187 | void scan_bridges(struct bus *bus); |
Stefan Reinauer | be7f798 | 2009-03-13 15:42:27 +0000 | [diff] [blame] | 188 | void assign_resources(struct bus *bus); |
Furquan Shaikh | 5b5c233 | 2020-04-24 21:31:35 -0700 | [diff] [blame] | 189 | const char *dev_name(const struct device *dev); |
Lubomir Rintel | 9ba8f7c | 2018-04-26 00:00:22 +0200 | [diff] [blame] | 190 | const char *dev_path(const struct device *dev); |
Subrata Banik | 564547f | 2018-05-02 10:27:36 +0530 | [diff] [blame] | 191 | u32 dev_path_encode(const struct device *dev); |
Patrick Rudolph | ab6bcd2 | 2024-01-19 08:24:36 +0100 | [diff] [blame] | 192 | struct device *dev_get_pci_domain(struct device *dev); |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 193 | void dev_set_enabled(struct device *dev, int enable); |
Stefan Reinauer | be7f798 | 2009-03-13 15:42:27 +0000 | [diff] [blame] | 194 | void disable_children(struct bus *bus); |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 195 | bool dev_is_active_bridge(struct device *dev); |
Jacob Garber | 464f4d6 | 2019-06-05 17:03:30 -0600 | [diff] [blame] | 196 | void add_more_links(struct device *dev, unsigned int total_links); |
Furquan Shaikh | 7f6ae79 | 2021-05-20 22:47:02 -0700 | [diff] [blame] | 197 | bool is_dev_enabled(const struct device *const dev); |
Subrata Banik | eca3e62 | 2021-06-08 00:55:04 +0530 | [diff] [blame] | 198 | bool is_devfn_enabled(unsigned int devfn); |
Fabio Aiuto | c5573d6 | 2022-09-10 14:23:38 +0200 | [diff] [blame] | 199 | bool is_cpu(const struct device *cpu); |
| 200 | bool is_enabled_cpu(const struct device *cpu); |
Fabio Aiuto | 4fce79f | 2022-09-30 11:22:09 +0200 | [diff] [blame] | 201 | bool is_pci(const struct device *pci); |
| 202 | bool is_enabled_pci(const struct device *pci); |
| 203 | bool is_pci_dev_on_bus(const struct device *pci, unsigned int bus); |
Angel Pons | a7d9266 | 2020-07-25 16:00:28 +0200 | [diff] [blame] | 204 | |
Nico Huber | 577c6b9 | 2022-08-15 00:08:58 +0200 | [diff] [blame] | 205 | /* Returns whether there is a hotplug port on the path to the given device. */ |
Elyes Haouas | 3813ca5 | 2023-01-14 07:30:21 +0100 | [diff] [blame] | 206 | bool dev_path_hotplug(const struct device *); |
Nico Huber | 577c6b9 | 2022-08-15 00:08:58 +0200 | [diff] [blame] | 207 | |
Myles Watson | b025911 | 2010-03-05 18:27:19 +0000 | [diff] [blame] | 208 | /* Option ROM helper functions */ |
| 209 | void run_bios(struct device *dev, unsigned long addr); |
| 210 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 211 | /* Helper functions */ |
Kyösti Mälkki | 2df1c12 | 2018-05-21 01:52:10 +0300 | [diff] [blame] | 212 | DEVTREE_CONST struct device *find_dev_path( |
| 213 | const struct bus *parent, |
| 214 | const struct device_path *path); |
Rob Barnes | a223e65 | 2020-07-23 08:25:42 -0600 | [diff] [blame] | 215 | DEVTREE_CONST struct device *find_dev_nested_path( |
| 216 | const struct bus *parent, |
| 217 | const struct device_path nested_path[], |
| 218 | size_t nested_path_length); |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 219 | struct device *alloc_find_dev(struct bus *parent, struct device_path *path); |
| 220 | struct device *dev_find_device(u16 vendor, u16 device, struct device *from); |
| 221 | struct device *dev_find_class(unsigned int class, struct device *from); |
Nico Huber | f6a4344 | 2018-05-15 14:13:32 +0200 | [diff] [blame] | 222 | DEVTREE_CONST struct device *dev_find_path( |
| 223 | DEVTREE_CONST struct device *prev_match, |
| 224 | enum device_path_type path_type); |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 225 | struct device *dev_find_lapic(unsigned int apic_id); |
Stefan Reinauer | dc8448fd | 2012-03-30 13:52:58 -0700 | [diff] [blame] | 226 | int dev_count_cpu(void); |
Aaron Durbin | f034902 | 2017-11-10 10:47:54 -0700 | [diff] [blame] | 227 | struct device *add_cpu_device(struct bus *cpu_bus, unsigned int apic_id, |
| 228 | int enabled); |
Kyösti Mälkki | b3267e0 | 2019-08-13 16:44:04 +0300 | [diff] [blame] | 229 | void mp_init_cpus(DEVTREE_CONST struct bus *cpu_bus); |
| 230 | static inline void mp_cpu_bus_init(struct device *dev) |
| 231 | { |
Arthur Heymans | 45be5b3 | 2023-08-25 11:50:25 +0200 | [diff] [blame] | 232 | /* Make sure the cpu cluster has a downstream bus for LAPICs to be allocated. */ |
Arthur Heymans | 3e99ba0 | 2024-01-25 22:26:07 +0100 | [diff] [blame] | 233 | struct bus *bus = alloc_bus(dev); |
Felix Held | 60e9114 | 2021-10-21 02:03:04 +0200 | [diff] [blame] | 234 | |
Arthur Heymans | 3e99ba0 | 2024-01-25 22:26:07 +0100 | [diff] [blame] | 235 | mp_init_cpus(bus); |
Kyösti Mälkki | b3267e0 | 2019-08-13 16:44:04 +0300 | [diff] [blame] | 236 | } |
| 237 | |
Myles Watson | bb3d812 | 2009-05-11 22:45:35 +0000 | [diff] [blame] | 238 | /* Debug functions */ |
Lubomir Rintel | 9ba8f7c | 2018-04-26 00:00:22 +0200 | [diff] [blame] | 239 | void print_resource_tree(const struct device *root, int debug_level, |
Myles Watson | bb3d812 | 2009-05-11 22:45:35 +0000 | [diff] [blame] | 240 | const char *msg); |
Lubomir Rintel | 9ba8f7c | 2018-04-26 00:00:22 +0200 | [diff] [blame] | 241 | void show_devs_tree(const struct device *dev, int debug_level, int depth); |
Myles Watson | bb3d812 | 2009-05-11 22:45:35 +0000 | [diff] [blame] | 242 | void show_devs_subtree(struct device *root, int debug_level, const char *msg); |
| 243 | void show_all_devs(int debug_level, const char *msg); |
Maciej Pijanka | ea92185 | 2009-10-27 14:29:29 +0000 | [diff] [blame] | 244 | void show_all_devs_tree(int debug_level, const char *msg); |
Myles Watson | bb3d812 | 2009-05-11 22:45:35 +0000 | [diff] [blame] | 245 | void show_one_resource(int debug_level, struct device *dev, |
| 246 | struct resource *resource, const char *comment); |
Lee Leahy | 6d71a43 | 2017-03-07 15:24:16 -0800 | [diff] [blame] | 247 | void show_all_devs_resources(int debug_level, const char *msg); |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 248 | |
Marc Jones | 5b5c52e | 2020-10-12 11:44:46 -0600 | [diff] [blame] | 249 | /* Debug macros */ |
Marc Jones | 8b522db | 2020-10-12 11:58:46 -0600 | [diff] [blame] | 250 | #if CONFIG(DEBUG_FUNC) |
| 251 | #include <console/console.h> |
| 252 | #define DEV_FUNC_ENTER(dev) \ |
| 253 | printk(BIOS_SPEW, "%s:%s:%d: ENTER (dev: %s)\n", \ |
| 254 | __FILE__, __func__, __LINE__, dev_path(dev)) |
| 255 | |
| 256 | #define DEV_FUNC_EXIT(dev) \ |
| 257 | printk(BIOS_SPEW, "%s:%s:%d: EXIT (dev: %s)\n", __FILE__, \ |
| 258 | __func__, __LINE__, dev_path(dev)) |
| 259 | #else /* DEBUG_FUNC */ |
| 260 | #define DEV_FUNC_ENTER(dev) |
| 261 | #define DEV_FUNC_EXIT(dev) |
| 262 | #endif /* DEBUG_FUNC */ |
| 263 | |
Stefan Reinauer | be7f798 | 2009-03-13 15:42:27 +0000 | [diff] [blame] | 264 | extern struct device_operations default_dev_ops_root; |
Myles Watson | 29cc9ed | 2009-07-02 18:56:24 +0000 | [diff] [blame] | 265 | void pci_domain_read_resources(struct device *dev); |
Raul E Rangel | 5cb34e2 | 2020-05-04 16:41:22 -0600 | [diff] [blame] | 266 | void pci_domain_set_resources(struct device *dev); |
Arthur Heymans | 0b0113f | 2023-08-31 17:09:28 +0200 | [diff] [blame] | 267 | void pci_host_bridge_scan_bus(struct device *dev); |
Uwe Hermann | 4b42a62 | 2010-10-11 19:36:13 +0000 | [diff] [blame] | 268 | |
Kyösti Mälkki | e25b5ef | 2016-12-02 08:56:05 +0200 | [diff] [blame] | 269 | void mmconf_resource(struct device *dev, unsigned long index); |
| 270 | |
Kyösti Mälkki | ce34596 | 2021-06-11 19:31:22 +0300 | [diff] [blame] | 271 | /* These are temporary resource constructors to get us through the |
| 272 | migration away from open-coding all the IORESOURCE_FLAGS. */ |
| 273 | |
| 274 | const struct resource *fixed_resource_range_idx(struct device *dev, unsigned long index, |
| 275 | uint64_t base, uint64_t size, |
| 276 | unsigned long flags); |
| 277 | |
| 278 | static inline |
| 279 | const struct resource *fixed_mem_range_flags(struct device *dev, unsigned long index, |
| 280 | uint64_t base, uint64_t size, |
| 281 | unsigned long flags) |
| 282 | { |
| 283 | return fixed_resource_range_idx(dev, index, base, size, IORESOURCE_MEM | flags); |
| 284 | } |
| 285 | |
| 286 | static inline |
| 287 | const struct resource *fixed_mem_from_to_flags(struct device *dev, unsigned long index, |
| 288 | uint64_t base, uint64_t end, unsigned long flags) |
| 289 | { |
| 290 | if (end <= base) |
| 291 | return NULL; |
| 292 | return fixed_mem_range_flags(dev, index, base, end - base, flags); |
| 293 | } |
| 294 | |
Kyösti Mälkki | ad5fab2 | 2021-06-13 08:02:56 +0300 | [diff] [blame] | 295 | static inline |
Kyösti Mälkki | d0525d4 | 2021-06-13 10:09:51 +0300 | [diff] [blame] | 296 | const struct resource *ram_range(struct device *dev, unsigned long index, uint64_t base, |
| 297 | uint64_t size) |
| 298 | { |
| 299 | return fixed_mem_range_flags(dev, index, base, size, IORESOURCE_CACHEABLE | IORESOURCE_STORED); |
| 300 | } |
| 301 | |
| 302 | static inline |
| 303 | const struct resource *ram_from_to(struct device *dev, unsigned long index, uint64_t base, |
| 304 | uint64_t end) |
| 305 | { |
| 306 | if (end <= base) |
| 307 | return NULL; |
| 308 | return ram_range(dev, index, base, end - base); |
| 309 | } |
| 310 | |
| 311 | static inline |
| 312 | const struct resource *reserved_ram_range(struct device *dev, unsigned long index, |
| 313 | uint64_t base, uint64_t size) |
| 314 | { |
| 315 | return fixed_mem_range_flags(dev, index, base, size, IORESOURCE_CACHEABLE | |
| 316 | IORESOURCE_RESERVE | IORESOURCE_STORED); |
| 317 | } |
| 318 | |
| 319 | static inline |
| 320 | const struct resource *reserved_ram_from_to(struct device *dev, unsigned long index, |
| 321 | uint64_t base, uint64_t end) |
| 322 | { |
| 323 | if (end <= base) |
| 324 | return NULL; |
| 325 | return reserved_ram_range(dev, index, base, end - base); |
| 326 | } |
| 327 | |
| 328 | static inline |
| 329 | const struct resource *mmio_range(struct device *dev, unsigned long index, uint64_t base, |
| 330 | uint64_t size) |
| 331 | { |
| 332 | return fixed_mem_range_flags(dev, index, base, size, IORESOURCE_RESERVE | IORESOURCE_STORED); |
| 333 | } |
| 334 | |
| 335 | static inline |
| 336 | const struct resource *mmio_from_to(struct device *dev, unsigned long index, uint64_t base, |
| 337 | uint64_t end) |
| 338 | { |
| 339 | if (end <= base) |
| 340 | return NULL; |
| 341 | return mmio_range(dev, index, base, end - base); |
| 342 | } |
| 343 | |
| 344 | const struct resource *lower_ram_end(struct device *dev, unsigned long index, uint64_t end); |
| 345 | const struct resource *upper_ram_end(struct device *dev, unsigned long index, uint64_t end); |
| 346 | |
| 347 | #define bad_ram_range(...) reserved_ram_range(__VA_ARGS__) |
| 348 | #define uma_range(...) mmio_range(__VA_ARGS__) |
| 349 | #define uma_from_to(...) mmio_from_to(__VA_ARGS__) |
| 350 | |
| 351 | static inline |
Kyösti Mälkki | ad5fab2 | 2021-06-13 08:02:56 +0300 | [diff] [blame] | 352 | const struct resource *fixed_io_range_flags(struct device *dev, unsigned long index, |
| 353 | uint16_t base, uint16_t size, unsigned long flags) |
| 354 | { |
| 355 | return fixed_resource_range_idx(dev, index, base, size, IORESOURCE_IO | flags); |
| 356 | } |
| 357 | |
| 358 | static inline |
| 359 | const struct resource *fixed_io_from_to_flags(struct device *dev, unsigned long index, |
| 360 | uint16_t base, uint16_t end, unsigned long flags) |
| 361 | { |
| 362 | if (end <= base) |
| 363 | return NULL; |
| 364 | return fixed_io_range_flags(dev, index, base, end - base, flags); |
| 365 | } |
| 366 | |
| 367 | static inline |
| 368 | const struct resource *fixed_io_range_reserved(struct device *dev, unsigned long index, |
| 369 | uint16_t base, uint16_t size) |
| 370 | { |
| 371 | return fixed_io_range_flags(dev, index, base, size, IORESOURCE_RESERVE); |
| 372 | } |
| 373 | |
Kyösti Mälkki | ce34596 | 2021-06-11 19:31:22 +0300 | [diff] [blame] | 374 | /* Compatibility code */ |
| 375 | |
| 376 | static inline void fixed_mem_resource_kb(struct device *dev, unsigned long index, |
| 377 | unsigned long basek, unsigned long sizek, |
| 378 | unsigned long flags) |
| 379 | { |
| 380 | fixed_mem_range_flags(dev, index, ((uint64_t)basek) << 10, |
| 381 | ((uint64_t)sizek) << 10, IORESOURCE_STORED | flags); |
| 382 | } |
| 383 | |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 384 | /* It is the caller's responsibility to adjust regions such that ram_resource_kb() |
| 385 | * and mmio_resource_kb() do not overlap. |
Kyösti Mälkki | 1ec5e74 | 2012-07-26 23:51:20 +0300 | [diff] [blame] | 386 | */ |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 387 | #define ram_resource_kb(dev, idx, basek, sizek) \ |
| 388 | fixed_mem_resource_kb(dev, idx, basek, sizek, IORESOURCE_CACHEABLE) |
Kyösti Mälkki | ecf1ed4 | 2012-07-27 08:37:12 +0300 | [diff] [blame] | 389 | |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 390 | #define reserved_ram_resource_kb(dev, idx, basek, sizek) \ |
| 391 | fixed_mem_resource_kb(dev, idx, basek, sizek, IORESOURCE_CACHEABLE \ |
Lee Leahy | 6a566d7 | 2017-03-07 17:45:12 -0800 | [diff] [blame] | 392 | | IORESOURCE_RESERVE) |
Aaron Durbin | c965076 | 2013-03-22 22:03:09 -0500 | [diff] [blame] | 393 | |
Jonathan Zhang | e111de0 | 2021-04-21 10:40:31 -0700 | [diff] [blame] | 394 | #define soft_reserved_ram_resource(dev, idx, basek, sizek) \ |
| 395 | fixed_mem_resource(dev, idx, basek, sizek, IORESOURCE_SOFT_RESERVE) |
| 396 | |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 397 | #define bad_ram_resource_kb(dev, idx, basek, sizek) \ |
| 398 | reserved_ram_resource_kb((dev), (idx), (basek), (sizek)) |
Kyösti Mälkki | ecf1ed4 | 2012-07-27 08:37:12 +0300 | [diff] [blame] | 399 | |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 400 | #define uma_resource_kb(dev, idx, basek, sizek) \ |
| 401 | fixed_mem_resource_kb(dev, idx, basek, sizek, IORESOURCE_RESERVE) |
Kyösti Mälkki | ecf1ed4 | 2012-07-27 08:37:12 +0300 | [diff] [blame] | 402 | |
Kyösti Mälkki | 27d6299 | 2022-05-24 20:25:58 +0300 | [diff] [blame] | 403 | #define mmio_resource_kb(dev, idx, basek, sizek) \ |
| 404 | fixed_mem_resource_kb(dev, idx, basek, sizek, IORESOURCE_RESERVE) |
Kyösti Mälkki | ecf1ed4 | 2012-07-27 08:37:12 +0300 | [diff] [blame] | 405 | |
Uwe Hermann | 4b42a62 | 2010-10-11 19:36:13 +0000 | [diff] [blame] | 406 | void tolm_test(void *gp, struct device *dev, struct resource *new); |
| 407 | u32 find_pci_tolm(struct bus *bus); |
Kyösti Mälkki | ef84401 | 2013-06-25 23:17:43 +0300 | [diff] [blame] | 408 | |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 409 | DEVTREE_CONST struct device *dev_find_next_pci_device( |
| 410 | DEVTREE_CONST struct device *previous_dev); |
| 411 | DEVTREE_CONST struct device *dev_find_slot_on_smbus(unsigned int bus, |
Stefan Reinauer | 57879c9 | 2012-07-31 16:47:25 -0700 | [diff] [blame] | 412 | unsigned int addr); |
Aaron Durbin | e4d7abc | 2017-04-16 22:05:36 -0500 | [diff] [blame] | 413 | DEVTREE_CONST struct device *dev_find_slot_pnp(u16 port, u16 device); |
Aaron Durbin | a0dabd1 | 2018-07-25 08:49:19 -0600 | [diff] [blame] | 414 | DEVTREE_CONST struct device *dev_bus_each_child(const struct bus *parent, |
| 415 | DEVTREE_CONST struct device *prev_child); |
Kyösti Mälkki | ef84401 | 2013-06-25 23:17:43 +0300 | [diff] [blame] | 416 | |
Kyösti Mälkki | ad7674e | 2018-05-20 10:31:23 +0300 | [diff] [blame] | 417 | DEVTREE_CONST struct device *pcidev_path_behind(const struct bus *parent, |
| 418 | pci_devfn_t devfn); |
| 419 | DEVTREE_CONST struct device *pcidev_path_on_root(pci_devfn_t devfn); |
Kyösti Mälkki | ab275f0 | 2019-07-04 07:16:59 +0300 | [diff] [blame] | 420 | DEVTREE_CONST struct device *pcidev_path_on_bus(unsigned int bus, pci_devfn_t devfn); |
Kyösti Mälkki | ad7674e | 2018-05-20 10:31:23 +0300 | [diff] [blame] | 421 | DEVTREE_CONST struct device *pcidev_on_root(uint8_t dev, uint8_t fn); |
Kyösti Mälkki | fffc9f3 | 2019-07-03 09:55:01 +0300 | [diff] [blame] | 422 | DEVTREE_CONST struct bus *pci_root_bus(void); |
Furquan Shaikh | 7778e5c | 2020-04-16 08:25:58 -0700 | [diff] [blame] | 423 | /* Find PCI device with given D#:F# sitting behind the given PCI-to-PCI bridge device. */ |
| 424 | DEVTREE_CONST struct device *pcidev_path_behind_pci2pci_bridge( |
| 425 | const struct device *bridge, |
| 426 | pci_devfn_t devfn); |
Kyösti Mälkki | ad7674e | 2018-05-20 10:31:23 +0300 | [diff] [blame] | 427 | |
Aaron Durbin | 55ef0d2 | 2019-09-26 12:05:27 -0600 | [diff] [blame] | 428 | /* To be deprecated, avoid using. |
| 429 | * |
| 430 | * Note that this function can return the incorrect device prior |
| 431 | * to PCI enumeration because the secondary field of the bus object |
| 432 | * is 0. The failing scenario is determined by the order of the |
| 433 | * devices in all_devices singly-linked list as well as the time |
| 434 | * when this function is called (secondary reflecting topology). |
| 435 | */ |
Kyösti Mälkki | f2ac013 | 2019-07-12 15:26:29 +0300 | [diff] [blame] | 436 | DEVTREE_CONST struct device *pcidev_path_on_root_debug(pci_devfn_t devfn, const char *func); |
| 437 | |
Kyösti Mälkki | 4323d26 | 2019-07-12 16:20:14 +0300 | [diff] [blame] | 438 | /* Robust discovery of chip_info. */ |
| 439 | void devtree_bug(const char *func, pci_devfn_t devfn); |
| 440 | void __noreturn devtree_die(void); |
| 441 | |
Nico Huber | 7e6ee91 | 2020-10-05 11:08:44 +0200 | [diff] [blame] | 442 | /* |
| 443 | * Dies if `dev` or `dev->chip_info` are NULL. Returns `dev->chip_info` otherwise. |
| 444 | * |
| 445 | * Only use if missing `chip_info` is fatal and we can't boot. If it's |
| 446 | * not fatal, please handle the NULL case gracefully. |
| 447 | */ |
Kyösti Mälkki | 4323d26 | 2019-07-12 16:20:14 +0300 | [diff] [blame] | 448 | static inline DEVTREE_CONST void *config_of(const struct device *dev) |
| 449 | { |
| 450 | if (dev && dev->chip_info) |
| 451 | return dev->chip_info; |
| 452 | |
| 453 | devtree_die(); |
| 454 | } |
| 455 | |
Furquan Shaikh | 28e61f1 | 2021-01-06 22:40:40 -0800 | [diff] [blame] | 456 | /* |
| 457 | * Returns pointer to config structure of root device (B:D:F = 0:00:0) defined by |
| 458 | * sconfig in static.{h/c}. |
| 459 | */ |
| 460 | #define config_of_soc() __pci_0_00_0_config |
Kyösti Mälkki | 4323d26 | 2019-07-12 16:20:14 +0300 | [diff] [blame] | 461 | |
Patrick Rudolph | f95dbce | 2024-01-22 15:39:46 +0100 | [diff] [blame] | 462 | static inline bool is_root_device(const struct device *dev) |
| 463 | { |
| 464 | if (!dev || !dev->bus) |
| 465 | return false; |
| 466 | |
| 467 | return (dev->path.type == DEVICE_PATH_ROOT) || |
| 468 | (dev->bus->dev == dev); |
| 469 | } |
| 470 | |
Duncan Laurie | 3e4a14e1 | 2020-10-18 15:04:41 -0700 | [diff] [blame] | 471 | void enable_static_device(struct device *dev); |
Nico Huber | f7ed3d4 | 2019-03-14 15:50:06 +0100 | [diff] [blame] | 472 | void enable_static_devices(struct device *bus); |
Aaron Durbin | 6f1e8d2 | 2017-11-09 12:38:03 -0700 | [diff] [blame] | 473 | void scan_smbus(struct device *bus); |
| 474 | void scan_generic_bus(struct device *bus); |
Nico Huber | a89c82e | 2017-09-14 15:40:28 +0200 | [diff] [blame] | 475 | void scan_static_bus(struct device *bus); |
Kyösti Mälkki | ef84401 | 2013-06-25 23:17:43 +0300 | [diff] [blame] | 476 | |
Furquan Shaikh | 26e2afd | 2021-09-16 16:27:10 -0700 | [diff] [blame] | 477 | /* Macro to generate `struct device *` name that points to a device with the given alias. */ |
| 478 | #define DEV_PTR(_alias) _dev_##_alias##_ptr |
| 479 | |
| 480 | /* Macro to generate weak `struct device *` definition that points to a device with the given |
| 481 | alias. */ |
| 482 | #define WEAK_DEV_PTR(_alias) \ |
| 483 | __weak DEVTREE_CONST struct device *const DEV_PTR(_alias) |
| 484 | |
Eric Biederman | 5899fd8 | 2003-04-24 06:25:08 +0000 | [diff] [blame] | 485 | #endif /* DEVICE_H */ |