1 // SPDX-License-Identifier: GPL-2.0 OR MIT 2 /* 3 * Intel Xe I2C attached Microcontroller Units (MCU) 4 * 5 * Copyright (C) 2025 Intel Corporation. 6 */ 7 8 #include <linux/array_size.h> 9 #include <linux/container_of.h> 10 #include <linux/device.h> 11 #include <linux/err.h> 12 #include <linux/i2c.h> 13 #include <linux/ioport.h> 14 #include <linux/irq.h> 15 #include <linux/irqdomain.h> 16 #include <linux/notifier.h> 17 #include <linux/pci.h> 18 #include <linux/platform_device.h> 19 #include <linux/property.h> 20 #include <linux/regmap.h> 21 #include <linux/sprintf.h> 22 #include <linux/string.h> 23 #include <linux/types.h> 24 #include <linux/workqueue.h> 25 26 #include "regs/xe_i2c_regs.h" 27 #include "regs/xe_irq_regs.h" 28 29 #include "xe_device.h" 30 #include "xe_device_types.h" 31 #include "xe_i2c.h" 32 #include "xe_mmio.h" 33 #include "xe_platform_types.h" 34 35 /** 36 * DOC: Xe I2C devices 37 * 38 * Register a platform device for the I2C host controller (Synpsys DesignWare 39 * I2C) if the registers of that controller are mapped to the MMIO, and also the 40 * I2C client device for the Add-In Management Controller (the MCU) attached to 41 * the host controller. 42 * 43 * See drivers/i2c/busses/i2c-designware-* for more information on the I2C host 44 * controller. 45 */ 46 47 static const char adapter_name[] = "i2c_designware"; 48 49 static const struct property_entry xe_i2c_adapter_properties[] = { 50 PROPERTY_ENTRY_STRING("compatible", "intel,xe-i2c"), 51 PROPERTY_ENTRY_U32("clock-frequency", I2C_MAX_FAST_MODE_PLUS_FREQ), 52 { } 53 }; 54 55 static inline void xe_i2c_read_endpoint(struct xe_mmio *mmio, void *ep) 56 { 57 u32 *val = ep; 58 59 val[0] = xe_mmio_read32(mmio, REG_SG_REMAP_ADDR_PREFIX); 60 val[1] = xe_mmio_read32(mmio, REG_SG_REMAP_ADDR_POSTFIX); 61 } 62 63 static void xe_i2c_client_work(struct work_struct *work) 64 { 65 struct xe_i2c *i2c = container_of(work, struct xe_i2c, work); 66 struct i2c_board_info info = { 67 .type = "amc", 68 .flags = I2C_CLIENT_HOST_NOTIFY, 69 .addr = i2c->ep.addr[1], 70 }; 71 72 i2c->client[0] = i2c_new_client_device(i2c->adapter, &info); 73 } 74 75 static int xe_i2c_notifier(struct notifier_block *nb, unsigned long action, void *data) 76 { 77 struct xe_i2c *i2c = container_of(nb, struct xe_i2c, bus_notifier); 78 struct i2c_adapter *adapter = i2c_verify_adapter(data); 79 struct device *dev = data; 80 81 if (action == BUS_NOTIFY_ADD_DEVICE && 82 adapter && dev->parent == &i2c->pdev->dev) { 83 i2c->adapter = adapter; 84 schedule_work(&i2c->work); 85 return NOTIFY_OK; 86 } 87 88 return NOTIFY_DONE; 89 } 90 91 static int xe_i2c_register_adapter(struct xe_i2c *i2c) 92 { 93 struct pci_dev *pci = to_pci_dev(i2c->drm_dev); 94 struct platform_device *pdev; 95 struct fwnode_handle *fwnode; 96 int ret; 97 98 fwnode = fwnode_create_software_node(xe_i2c_adapter_properties, NULL); 99 if (IS_ERR(fwnode)) 100 return PTR_ERR(fwnode); 101 102 /* 103 * Not using platform_device_register_full() here because we don't have 104 * a handle to the platform_device before it returns. xe_i2c_notifier() 105 * uses that handle, but it may be called before 106 * platform_device_register_full() is done. 107 */ 108 pdev = platform_device_alloc(adapter_name, pci_dev_id(pci)); 109 if (!pdev) { 110 ret = -ENOMEM; 111 goto err_fwnode_remove; 112 } 113 114 if (i2c->adapter_irq) { 115 struct resource res; 116 117 res = DEFINE_RES_IRQ_NAMED(i2c->adapter_irq, "xe_i2c"); 118 119 ret = platform_device_add_resources(pdev, &res, 1); 120 if (ret) 121 goto err_pdev_put; 122 } 123 124 pdev->dev.parent = i2c->drm_dev; 125 pdev->dev.fwnode = fwnode; 126 i2c->adapter_node = fwnode; 127 i2c->pdev = pdev; 128 129 ret = platform_device_add(pdev); 130 if (ret) 131 goto err_pdev_put; 132 133 return 0; 134 135 err_pdev_put: 136 platform_device_put(pdev); 137 err_fwnode_remove: 138 fwnode_remove_software_node(fwnode); 139 140 return ret; 141 } 142 143 static void xe_i2c_unregister_adapter(struct xe_i2c *i2c) 144 { 145 platform_device_unregister(i2c->pdev); 146 fwnode_remove_software_node(i2c->adapter_node); 147 } 148 149 /** 150 * xe_i2c_present - I2C controller is present and functional 151 * @xe: xe device instance 152 * 153 * Check whether the I2C controller is present and functioning with valid 154 * endpoint cookie. 155 * 156 * Return: %true if present, %false otherwise. 157 */ 158 bool xe_i2c_present(struct xe_device *xe) 159 { 160 return xe->i2c && xe->i2c->ep.cookie == XE_I2C_EP_COOKIE_DEVICE; 161 } 162 163 /** 164 * xe_i2c_irq_handler: Handler for I2C interrupts 165 * @xe: xe device instance 166 * @master_ctl: interrupt register 167 * 168 * Forward interrupts generated by the I2C host adapter to the I2C host adapter 169 * driver. 170 */ 171 void xe_i2c_irq_handler(struct xe_device *xe, u32 master_ctl) 172 { 173 if (!xe->i2c || !xe->i2c->adapter_irq) 174 return; 175 176 if (master_ctl & I2C_IRQ) 177 generic_handle_irq_safe(xe->i2c->adapter_irq); 178 } 179 180 static int xe_i2c_irq_map(struct irq_domain *h, unsigned int virq, 181 irq_hw_number_t hw_irq_num) 182 { 183 irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq); 184 return 0; 185 } 186 187 static const struct irq_domain_ops xe_i2c_irq_ops = { 188 .map = xe_i2c_irq_map, 189 }; 190 191 static int xe_i2c_create_irq(struct xe_i2c *i2c) 192 { 193 struct irq_domain *domain; 194 195 if (!(i2c->ep.capabilities & XE_I2C_EP_CAP_IRQ)) 196 return 0; 197 198 domain = irq_domain_create_linear(dev_fwnode(i2c->drm_dev), 1, &xe_i2c_irq_ops, NULL); 199 if (!domain) 200 return -ENOMEM; 201 202 i2c->adapter_irq = irq_create_mapping(domain, 0); 203 i2c->irqdomain = domain; 204 205 return 0; 206 } 207 208 static void xe_i2c_remove_irq(struct xe_i2c *i2c) 209 { 210 if (!i2c->irqdomain) 211 return; 212 213 irq_dispose_mapping(i2c->adapter_irq); 214 irq_domain_remove(i2c->irqdomain); 215 } 216 217 static int xe_i2c_read(void *context, unsigned int reg, unsigned int *val) 218 { 219 struct xe_i2c *i2c = context; 220 221 *val = xe_mmio_read32(i2c->mmio, XE_REG(reg + I2C_MEM_SPACE_OFFSET)); 222 223 return 0; 224 } 225 226 static int xe_i2c_write(void *context, unsigned int reg, unsigned int val) 227 { 228 struct xe_i2c *i2c = context; 229 230 xe_mmio_write32(i2c->mmio, XE_REG(reg + I2C_MEM_SPACE_OFFSET), val); 231 232 return 0; 233 } 234 235 static const struct regmap_config i2c_regmap_config = { 236 .reg_bits = 32, 237 .val_bits = 32, 238 .reg_read = xe_i2c_read, 239 .reg_write = xe_i2c_write, 240 .fast_io = true, 241 }; 242 243 void xe_i2c_pm_suspend(struct xe_device *xe) 244 { 245 struct xe_mmio *mmio = xe_root_tile_mmio(xe); 246 247 if (!xe_i2c_present(xe)) 248 return; 249 250 xe_mmio_rmw32(mmio, I2C_CONFIG_PMCSR, PCI_PM_CTRL_STATE_MASK, (__force u32)PCI_D3hot); 251 drm_dbg(&xe->drm, "pmcsr: 0x%08x\n", xe_mmio_read32(mmio, I2C_CONFIG_PMCSR)); 252 } 253 254 void xe_i2c_pm_resume(struct xe_device *xe, bool d3cold) 255 { 256 struct xe_mmio *mmio = xe_root_tile_mmio(xe); 257 258 if (!xe_i2c_present(xe)) 259 return; 260 261 if (d3cold) 262 xe_mmio_rmw32(mmio, I2C_CONFIG_CMD, 0, PCI_COMMAND_MEMORY); 263 264 xe_mmio_rmw32(mmio, I2C_CONFIG_PMCSR, PCI_PM_CTRL_STATE_MASK, (__force u32)PCI_D0); 265 drm_dbg(&xe->drm, "pmcsr: 0x%08x\n", xe_mmio_read32(mmio, I2C_CONFIG_PMCSR)); 266 } 267 268 static void xe_i2c_remove(void *data) 269 { 270 struct xe_i2c *i2c = data; 271 unsigned int i; 272 273 for (i = 0; i < XE_I2C_MAX_CLIENTS; i++) 274 i2c_unregister_device(i2c->client[i]); 275 276 bus_unregister_notifier(&i2c_bus_type, &i2c->bus_notifier); 277 xe_i2c_unregister_adapter(i2c); 278 xe_i2c_remove_irq(i2c); 279 } 280 281 /** 282 * xe_i2c_probe: Probe the I2C host adapter and the I2C clients attached to it 283 * @xe: xe device instance 284 * 285 * Register all the I2C devices described in the I2C Endpoint data structure. 286 * 287 * Return: 0 on success, error code on failure 288 */ 289 int xe_i2c_probe(struct xe_device *xe) 290 { 291 struct device *drm_dev = xe->drm.dev; 292 struct xe_i2c_endpoint ep; 293 struct regmap *regmap; 294 struct xe_i2c *i2c; 295 int ret; 296 297 if (xe->info.platform != XE_BATTLEMAGE) 298 return 0; 299 300 if (IS_SRIOV_VF(xe)) 301 return 0; 302 303 xe_i2c_read_endpoint(xe_root_tile_mmio(xe), &ep); 304 if (ep.cookie != XE_I2C_EP_COOKIE_DEVICE) 305 return 0; 306 307 i2c = devm_kzalloc(drm_dev, sizeof(*i2c), GFP_KERNEL); 308 if (!i2c) 309 return -ENOMEM; 310 311 INIT_WORK(&i2c->work, xe_i2c_client_work); 312 i2c->mmio = xe_root_tile_mmio(xe); 313 i2c->drm_dev = drm_dev; 314 i2c->ep = ep; 315 xe->i2c = i2c; 316 317 /* PCI PM isn't aware of this device, bring it up and match it with SGUnit state. */ 318 xe_i2c_pm_resume(xe, true); 319 320 regmap = devm_regmap_init(drm_dev, NULL, i2c, &i2c_regmap_config); 321 if (IS_ERR(regmap)) 322 return PTR_ERR(regmap); 323 324 i2c->bus_notifier.notifier_call = xe_i2c_notifier; 325 ret = bus_register_notifier(&i2c_bus_type, &i2c->bus_notifier); 326 if (ret) 327 return ret; 328 329 ret = xe_i2c_create_irq(i2c); 330 if (ret) 331 goto err_unregister_notifier; 332 333 ret = xe_i2c_register_adapter(i2c); 334 if (ret) 335 goto err_remove_irq; 336 337 return devm_add_action_or_reset(drm_dev, xe_i2c_remove, i2c); 338 339 err_remove_irq: 340 xe_i2c_remove_irq(i2c); 341 342 err_unregister_notifier: 343 bus_unregister_notifier(&i2c_bus_type, &i2c->bus_notifier); 344 345 return ret; 346 } 347