1 // SPDX-License-Identifier: GPL-2.0 2 #include <linux/err.h> 3 #include <linux/pci.h> 4 #include <linux/io.h> 5 #include <linux/gfp.h> 6 #include <linux/export.h> 7 #include <linux/of_address.h> 8 9 enum devm_ioremap_type { 10 DEVM_IOREMAP = 0, 11 DEVM_IOREMAP_NC, 12 DEVM_IOREMAP_WC, 13 }; 14 15 void devm_ioremap_release(struct device *dev, void *res) 16 { 17 iounmap(*(void __iomem **)res); 18 } 19 20 static int devm_ioremap_match(struct device *dev, void *res, void *match_data) 21 { 22 return *(void **)res == match_data; 23 } 24 25 static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset, 26 resource_size_t size, 27 enum devm_ioremap_type type) 28 { 29 void __iomem **ptr, *addr = NULL; 30 31 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL); 32 if (!ptr) 33 return NULL; 34 35 switch (type) { 36 case DEVM_IOREMAP: 37 addr = ioremap(offset, size); 38 break; 39 case DEVM_IOREMAP_NC: 40 addr = ioremap_nocache(offset, size); 41 break; 42 case DEVM_IOREMAP_WC: 43 addr = ioremap_wc(offset, size); 44 break; 45 } 46 47 if (addr) { 48 *ptr = addr; 49 devres_add(dev, ptr); 50 } else 51 devres_free(ptr); 52 53 return addr; 54 } 55 56 /** 57 * devm_ioremap - Managed ioremap() 58 * @dev: Generic device to remap IO address for 59 * @offset: Resource address to map 60 * @size: Size of map 61 * 62 * Managed ioremap(). Map is automatically unmapped on driver detach. 63 */ 64 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset, 65 resource_size_t size) 66 { 67 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP); 68 } 69 EXPORT_SYMBOL(devm_ioremap); 70 71 /** 72 * devm_ioremap_nocache - Managed ioremap_nocache() 73 * @dev: Generic device to remap IO address for 74 * @offset: Resource address to map 75 * @size: Size of map 76 * 77 * Managed ioremap_nocache(). Map is automatically unmapped on driver 78 * detach. 79 */ 80 void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset, 81 resource_size_t size) 82 { 83 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC); 84 } 85 EXPORT_SYMBOL(devm_ioremap_nocache); 86 87 /** 88 * devm_ioremap_wc - Managed ioremap_wc() 89 * @dev: Generic device to remap IO address for 90 * @offset: Resource address to map 91 * @size: Size of map 92 * 93 * Managed ioremap_wc(). Map is automatically unmapped on driver detach. 94 */ 95 void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset, 96 resource_size_t size) 97 { 98 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC); 99 } 100 EXPORT_SYMBOL(devm_ioremap_wc); 101 102 /** 103 * devm_iounmap - Managed iounmap() 104 * @dev: Generic device to unmap for 105 * @addr: Address to unmap 106 * 107 * Managed iounmap(). @addr must have been mapped using devm_ioremap*(). 108 */ 109 void devm_iounmap(struct device *dev, void __iomem *addr) 110 { 111 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match, 112 (__force void *)addr)); 113 iounmap(addr); 114 } 115 EXPORT_SYMBOL(devm_iounmap); 116 117 /** 118 * devm_ioremap_resource() - check, request region, and ioremap resource 119 * @dev: generic device to handle the resource for 120 * @res: resource to be handled 121 * 122 * Checks that a resource is a valid memory region, requests the memory 123 * region and ioremaps it. All operations are managed and will be undone 124 * on driver detach. 125 * 126 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code 127 * on failure. Usage example: 128 * 129 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 130 * base = devm_ioremap_resource(&pdev->dev, res); 131 * if (IS_ERR(base)) 132 * return PTR_ERR(base); 133 */ 134 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res) 135 { 136 resource_size_t size; 137 void __iomem *dest_ptr; 138 139 BUG_ON(!dev); 140 141 if (!res || resource_type(res) != IORESOURCE_MEM) { 142 dev_err(dev, "invalid resource\n"); 143 return IOMEM_ERR_PTR(-EINVAL); 144 } 145 146 size = resource_size(res); 147 148 if (!devm_request_mem_region(dev, res->start, size, dev_name(dev))) { 149 dev_err(dev, "can't request region for resource %pR\n", res); 150 return IOMEM_ERR_PTR(-EBUSY); 151 } 152 153 dest_ptr = devm_ioremap(dev, res->start, size); 154 if (!dest_ptr) { 155 dev_err(dev, "ioremap failed for resource %pR\n", res); 156 devm_release_mem_region(dev, res->start, size); 157 dest_ptr = IOMEM_ERR_PTR(-ENOMEM); 158 } 159 160 return dest_ptr; 161 } 162 EXPORT_SYMBOL(devm_ioremap_resource); 163 164 /* 165 * devm_of_iomap - Requests a resource and maps the memory mapped IO 166 * for a given device_node managed by a given device 167 * 168 * Checks that a resource is a valid memory region, requests the memory 169 * region and ioremaps it. All operations are managed and will be undone 170 * on driver detach of the device. 171 * 172 * This is to be used when a device requests/maps resources described 173 * by other device tree nodes (children or otherwise). 174 * 175 * @dev: The device "managing" the resource 176 * @node: The device-tree node where the resource resides 177 * @index: index of the MMIO range in the "reg" property 178 * @size: Returns the size of the resource (pass NULL if not needed) 179 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded 180 * error code on failure. Usage example: 181 * 182 * base = devm_of_iomap(&pdev->dev, node, 0, NULL); 183 * if (IS_ERR(base)) 184 * return PTR_ERR(base); 185 */ 186 void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index, 187 resource_size_t *size) 188 { 189 struct resource res; 190 191 if (of_address_to_resource(node, index, &res)) 192 return IOMEM_ERR_PTR(-EINVAL); 193 if (size) 194 *size = resource_size(&res); 195 return devm_ioremap_resource(dev, &res); 196 } 197 EXPORT_SYMBOL(devm_of_iomap); 198 199 #ifdef CONFIG_HAS_IOPORT_MAP 200 /* 201 * Generic iomap devres 202 */ 203 static void devm_ioport_map_release(struct device *dev, void *res) 204 { 205 ioport_unmap(*(void __iomem **)res); 206 } 207 208 static int devm_ioport_map_match(struct device *dev, void *res, 209 void *match_data) 210 { 211 return *(void **)res == match_data; 212 } 213 214 /** 215 * devm_ioport_map - Managed ioport_map() 216 * @dev: Generic device to map ioport for 217 * @port: Port to map 218 * @nr: Number of ports to map 219 * 220 * Managed ioport_map(). Map is automatically unmapped on driver 221 * detach. 222 */ 223 void __iomem *devm_ioport_map(struct device *dev, unsigned long port, 224 unsigned int nr) 225 { 226 void __iomem **ptr, *addr; 227 228 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL); 229 if (!ptr) 230 return NULL; 231 232 addr = ioport_map(port, nr); 233 if (addr) { 234 *ptr = addr; 235 devres_add(dev, ptr); 236 } else 237 devres_free(ptr); 238 239 return addr; 240 } 241 EXPORT_SYMBOL(devm_ioport_map); 242 243 /** 244 * devm_ioport_unmap - Managed ioport_unmap() 245 * @dev: Generic device to unmap for 246 * @addr: Address to unmap 247 * 248 * Managed ioport_unmap(). @addr must have been mapped using 249 * devm_ioport_map(). 250 */ 251 void devm_ioport_unmap(struct device *dev, void __iomem *addr) 252 { 253 ioport_unmap(addr); 254 WARN_ON(devres_destroy(dev, devm_ioport_map_release, 255 devm_ioport_map_match, (__force void *)addr)); 256 } 257 EXPORT_SYMBOL(devm_ioport_unmap); 258 #endif /* CONFIG_HAS_IOPORT_MAP */ 259 260 #ifdef CONFIG_PCI 261 /* 262 * PCI iomap devres 263 */ 264 #define PCIM_IOMAP_MAX PCI_ROM_RESOURCE 265 266 struct pcim_iomap_devres { 267 void __iomem *table[PCIM_IOMAP_MAX]; 268 }; 269 270 static void pcim_iomap_release(struct device *gendev, void *res) 271 { 272 struct pci_dev *dev = to_pci_dev(gendev); 273 struct pcim_iomap_devres *this = res; 274 int i; 275 276 for (i = 0; i < PCIM_IOMAP_MAX; i++) 277 if (this->table[i]) 278 pci_iounmap(dev, this->table[i]); 279 } 280 281 /** 282 * pcim_iomap_table - access iomap allocation table 283 * @pdev: PCI device to access iomap table for 284 * 285 * Access iomap allocation table for @dev. If iomap table doesn't 286 * exist and @pdev is managed, it will be allocated. All iomaps 287 * recorded in the iomap table are automatically unmapped on driver 288 * detach. 289 * 290 * This function might sleep when the table is first allocated but can 291 * be safely called without context and guaranteed to succed once 292 * allocated. 293 */ 294 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev) 295 { 296 struct pcim_iomap_devres *dr, *new_dr; 297 298 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL); 299 if (dr) 300 return dr->table; 301 302 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL); 303 if (!new_dr) 304 return NULL; 305 dr = devres_get(&pdev->dev, new_dr, NULL, NULL); 306 return dr->table; 307 } 308 EXPORT_SYMBOL(pcim_iomap_table); 309 310 /** 311 * pcim_iomap - Managed pcim_iomap() 312 * @pdev: PCI device to iomap for 313 * @bar: BAR to iomap 314 * @maxlen: Maximum length of iomap 315 * 316 * Managed pci_iomap(). Map is automatically unmapped on driver 317 * detach. 318 */ 319 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen) 320 { 321 void __iomem **tbl; 322 323 BUG_ON(bar >= PCIM_IOMAP_MAX); 324 325 tbl = (void __iomem **)pcim_iomap_table(pdev); 326 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */ 327 return NULL; 328 329 tbl[bar] = pci_iomap(pdev, bar, maxlen); 330 return tbl[bar]; 331 } 332 EXPORT_SYMBOL(pcim_iomap); 333 334 /** 335 * pcim_iounmap - Managed pci_iounmap() 336 * @pdev: PCI device to iounmap for 337 * @addr: Address to unmap 338 * 339 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap(). 340 */ 341 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr) 342 { 343 void __iomem **tbl; 344 int i; 345 346 pci_iounmap(pdev, addr); 347 348 tbl = (void __iomem **)pcim_iomap_table(pdev); 349 BUG_ON(!tbl); 350 351 for (i = 0; i < PCIM_IOMAP_MAX; i++) 352 if (tbl[i] == addr) { 353 tbl[i] = NULL; 354 return; 355 } 356 WARN_ON(1); 357 } 358 EXPORT_SYMBOL(pcim_iounmap); 359 360 /** 361 * pcim_iomap_regions - Request and iomap PCI BARs 362 * @pdev: PCI device to map IO resources for 363 * @mask: Mask of BARs to request and iomap 364 * @name: Name used when requesting regions 365 * 366 * Request and iomap regions specified by @mask. 367 */ 368 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name) 369 { 370 void __iomem * const *iomap; 371 int i, rc; 372 373 iomap = pcim_iomap_table(pdev); 374 if (!iomap) 375 return -ENOMEM; 376 377 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) { 378 unsigned long len; 379 380 if (!(mask & (1 << i))) 381 continue; 382 383 rc = -EINVAL; 384 len = pci_resource_len(pdev, i); 385 if (!len) 386 goto err_inval; 387 388 rc = pci_request_region(pdev, i, name); 389 if (rc) 390 goto err_inval; 391 392 rc = -ENOMEM; 393 if (!pcim_iomap(pdev, i, 0)) 394 goto err_region; 395 } 396 397 return 0; 398 399 err_region: 400 pci_release_region(pdev, i); 401 err_inval: 402 while (--i >= 0) { 403 if (!(mask & (1 << i))) 404 continue; 405 pcim_iounmap(pdev, iomap[i]); 406 pci_release_region(pdev, i); 407 } 408 409 return rc; 410 } 411 EXPORT_SYMBOL(pcim_iomap_regions); 412 413 /** 414 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones 415 * @pdev: PCI device to map IO resources for 416 * @mask: Mask of BARs to iomap 417 * @name: Name used when requesting regions 418 * 419 * Request all PCI BARs and iomap regions specified by @mask. 420 */ 421 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask, 422 const char *name) 423 { 424 int request_mask = ((1 << 6) - 1) & ~mask; 425 int rc; 426 427 rc = pci_request_selected_regions(pdev, request_mask, name); 428 if (rc) 429 return rc; 430 431 rc = pcim_iomap_regions(pdev, mask, name); 432 if (rc) 433 pci_release_selected_regions(pdev, request_mask); 434 return rc; 435 } 436 EXPORT_SYMBOL(pcim_iomap_regions_request_all); 437 438 /** 439 * pcim_iounmap_regions - Unmap and release PCI BARs 440 * @pdev: PCI device to map IO resources for 441 * @mask: Mask of BARs to unmap and release 442 * 443 * Unmap and release regions specified by @mask. 444 */ 445 void pcim_iounmap_regions(struct pci_dev *pdev, int mask) 446 { 447 void __iomem * const *iomap; 448 int i; 449 450 iomap = pcim_iomap_table(pdev); 451 if (!iomap) 452 return; 453 454 for (i = 0; i < PCIM_IOMAP_MAX; i++) { 455 if (!(mask & (1 << i))) 456 continue; 457 458 pcim_iounmap(pdev, iomap[i]); 459 pci_release_region(pdev, i); 460 } 461 } 462 EXPORT_SYMBOL(pcim_iounmap_regions); 463 #endif /* CONFIG_PCI */ 464