1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef SPDK_ENV_INTERNAL_H 35 #define SPDK_ENV_INTERNAL_H 36 37 #include "spdk/stdinc.h" 38 39 #include "spdk/env.h" 40 41 #include <rte_config.h> 42 #include <rte_version.h> 43 #include <rte_eal.h> 44 #include <rte_bus.h> 45 #include <rte_pci.h> 46 #include <rte_bus_pci.h> 47 #include <rte_dev.h> 48 49 #if RTE_VERSION < RTE_VERSION_NUM(19, 11, 0, 0) 50 #error RTE_VERSION is too old! Minimum 19.11 is required. 51 #endif 52 53 /* x86-64 and ARM userspace virtual addresses use only the low 48 bits [0..47], 54 * which is enough to cover 256 TB. 55 */ 56 #define SHIFT_256TB 48 /* (1 << 48) == 256 TB */ 57 #define MASK_256TB ((1ULL << SHIFT_256TB) - 1) 58 59 #define SHIFT_1GB 30 /* (1 << 30) == 1 GB */ 60 #define MASK_1GB ((1ULL << SHIFT_1GB) - 1) 61 62 #define SPDK_PCI_DRIVER_MAX_NAME_LEN 32 63 struct spdk_pci_driver { 64 struct rte_pci_driver driver; 65 66 const char *name; 67 const struct spdk_pci_id *id_table; 68 uint32_t drv_flags; 69 70 spdk_pci_enum_cb cb_fn; 71 void *cb_arg; 72 TAILQ_ENTRY(spdk_pci_driver) tailq; 73 }; 74 75 int pci_device_init(struct rte_pci_driver *driver, struct rte_pci_device *device); 76 int pci_device_fini(struct rte_pci_device *device); 77 78 void pci_env_init(void); 79 void pci_env_reinit(void); 80 void pci_env_fini(void); 81 int mem_map_init(bool legacy_mem); 82 int vtophys_init(void); 83 84 /** 85 * Report a DMA-capable PCI device to the vtophys translation code. 86 * Increases the refcount of active DMA-capable devices managed by SPDK. 87 * This must be called after a `rte_pci_device` is created. 88 */ 89 void vtophys_pci_device_added(struct rte_pci_device *pci_device); 90 91 /** 92 * Report the removal of a DMA-capable PCI device to the vtophys translation code. 93 * Decreases the refcount of active DMA-capable devices managed by SPDK. 94 * This must be called before a `rte_pci_device` is destroyed. 95 */ 96 void vtophys_pci_device_removed(struct rte_pci_device *pci_device); 97 98 #endif 99