1 /*- 2 * Copyright (c) 2017 The FreeBSD Foundation 3 * All rights reserved. 4 * Copyright (c) 2018, 2019 Intel Corporation 5 * 6 * This software was developed by Konstantin Belousov <kib@FreeBSD.org> 7 * under sponsorship from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef __DEV_NVDIMM_VAR_H__ 34 #define __DEV_NVDIMM_VAR_H__ 35 36 typedef uint32_t nfit_handle_t; 37 38 enum nvdimm_root_ivar { 39 NVDIMM_ROOT_IVAR_ACPI_HANDLE, 40 NVDIMM_ROOT_IVAR_DEVICE_HANDLE, 41 NVDIMM_ROOT_IVAR_MAX, 42 }; 43 __BUS_ACCESSOR(nvdimm_root, acpi_handle, NVDIMM_ROOT, ACPI_HANDLE, ACPI_HANDLE) 44 __BUS_ACCESSOR(nvdimm_root, device_handle, NVDIMM_ROOT, DEVICE_HANDLE, 45 nfit_handle_t) 46 47 struct nvdimm_root_dev { 48 SLIST_HEAD(, SPA_mapping) spas; 49 }; 50 51 struct nvdimm_dev { 52 device_t nv_dev; 53 nfit_handle_t nv_handle; 54 uint64_t **nv_flush_addr; 55 int nv_flush_addr_cnt; 56 }; 57 58 enum SPA_mapping_type { 59 SPA_TYPE_VOLATILE_MEMORY = 0, 60 SPA_TYPE_PERSISTENT_MEMORY = 1, 61 SPA_TYPE_CONTROL_REGION = 2, 62 SPA_TYPE_DATA_REGION = 3, 63 SPA_TYPE_VOLATILE_VIRTUAL_DISK = 4, 64 SPA_TYPE_VOLATILE_VIRTUAL_CD = 5, 65 SPA_TYPE_PERSISTENT_VIRTUAL_DISK= 6, 66 SPA_TYPE_PERSISTENT_VIRTUAL_CD = 7, 67 SPA_TYPE_UNKNOWN = 127, 68 }; 69 70 struct SPA_mapping { 71 SLIST_ENTRY(SPA_mapping) link; 72 enum SPA_mapping_type spa_type; 73 int spa_domain; 74 int spa_nfit_idx; 75 uint64_t spa_phys_base; 76 uint64_t spa_len; 77 uint64_t spa_efi_mem_flags; 78 void *spa_kva; 79 struct cdev *spa_dev; 80 struct g_geom *spa_g; 81 struct g_provider *spa_p; 82 struct bio_queue_head spa_g_queue; 83 struct mtx spa_g_mtx; 84 struct mtx spa_g_stat_mtx; 85 struct devstat *spa_g_devstat; 86 struct proc *spa_g_proc; 87 struct vm_object *spa_obj; 88 bool spa_g_proc_run; 89 bool spa_g_proc_exiting; 90 }; 91 92 MALLOC_DECLARE(M_NVDIMM); 93 94 void acpi_nfit_get_dimm_ids(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t **listp, 95 int *countp); 96 void acpi_nfit_get_spa_range(ACPI_TABLE_NFIT *nfitbl, uint16_t range_index, 97 ACPI_NFIT_SYSTEM_ADDRESS **spa); 98 void acpi_nfit_get_spa_ranges(ACPI_TABLE_NFIT *nfitbl, 99 ACPI_NFIT_SYSTEM_ADDRESS ***listp, int *countp); 100 void acpi_nfit_get_region_mappings_by_spa_range(ACPI_TABLE_NFIT *nfitbl, 101 uint16_t spa_range_index, ACPI_NFIT_MEMORY_MAP ***listp, int *countp); 102 void acpi_nfit_get_control_region(ACPI_TABLE_NFIT *nfitbl, 103 uint16_t control_region_index, ACPI_NFIT_CONTROL_REGION **out); 104 void acpi_nfit_get_flush_addrs(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t dimm, 105 uint64_t ***listp, int *countp); 106 enum SPA_mapping_type nvdimm_spa_type_from_uuid(struct uuid *); 107 struct nvdimm_dev *nvdimm_find_by_handle(nfit_handle_t nv_handle); 108 int nvdimm_spa_init(struct SPA_mapping *spa, ACPI_NFIT_SYSTEM_ADDRESS *nfitaddr, 109 enum SPA_mapping_type spa_type); 110 void nvdimm_spa_fini(struct SPA_mapping *spa); 111 112 #endif /* __DEV_NVDIMM_VAR_H__ */ 113