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 31 #ifndef __DEV_NVDIMM_VAR_H__ 32 #define __DEV_NVDIMM_VAR_H__ 33 34 #define NVDIMM_INDEX_BLOCK_SIGNATURE "NAMESPACE_INDEX" 35 36 struct nvdimm_label_index { 37 char signature[16]; 38 uint8_t flags[3]; 39 uint8_t label_size; 40 uint32_t seq; 41 uint64_t this_offset; 42 uint64_t this_size; 43 uint64_t other_offset; 44 uint64_t label_offset; 45 uint32_t slot_cnt; 46 uint16_t rev_major; 47 uint16_t rev_minor; 48 uint64_t checksum; 49 uint8_t free[0]; 50 }; 51 52 struct nvdimm_label { 53 struct uuid uuid; 54 char name[64]; 55 uint32_t flags; 56 uint16_t nlabel; 57 uint16_t position; 58 uint64_t set_cookie; 59 uint64_t lba_size; 60 uint64_t dimm_phys_addr; 61 uint64_t raw_size; 62 uint32_t slot; 63 uint8_t alignment; 64 uint8_t reserved[3]; 65 struct uuid type_guid; 66 struct uuid address_abstraction_guid; 67 uint8_t reserved1[88]; 68 uint64_t checksum; 69 }; 70 71 struct nvdimm_label_entry { 72 SLIST_ENTRY(nvdimm_label_entry) link; 73 struct nvdimm_label label; 74 }; 75 76 _Static_assert(sizeof(struct nvdimm_label_index) == 72, "Incorrect layout"); 77 _Static_assert(sizeof(struct nvdimm_label) == 256, "Incorrect layout"); 78 79 typedef uint32_t nfit_handle_t; 80 81 enum nvdimm_acpi_ivar { 82 NVDIMM_ROOT_IVAR_ACPI_HANDLE, 83 NVDIMM_ROOT_IVAR_DEVICE_HANDLE, 84 NVDIMM_ROOT_IVAR_MAX, 85 }; 86 __BUS_ACCESSOR(nvdimm_root, acpi_handle, NVDIMM_ROOT, ACPI_HANDLE, ACPI_HANDLE) 87 __BUS_ACCESSOR(nvdimm_root, device_handle, NVDIMM_ROOT, DEVICE_HANDLE, 88 nfit_handle_t) 89 90 struct nvdimm_dev { 91 device_t nv_dev; 92 nfit_handle_t nv_handle; 93 uint64_t **nv_flush_addr; 94 char *nv_flags_str; 95 int nv_flush_addr_cnt; 96 uint32_t label_area_size; 97 uint32_t max_label_xfer; 98 struct nvdimm_label_index *label_index; 99 SLIST_HEAD(, nvdimm_label_entry) labels; 100 }; 101 102 enum SPA_mapping_type { 103 SPA_TYPE_VOLATILE_MEMORY = 0, 104 SPA_TYPE_PERSISTENT_MEMORY = 1, 105 SPA_TYPE_CONTROL_REGION = 2, 106 SPA_TYPE_DATA_REGION = 3, 107 SPA_TYPE_VOLATILE_VIRTUAL_DISK = 4, 108 SPA_TYPE_VOLATILE_VIRTUAL_CD = 5, 109 SPA_TYPE_PERSISTENT_VIRTUAL_DISK= 6, 110 SPA_TYPE_PERSISTENT_VIRTUAL_CD = 7, 111 SPA_TYPE_UNKNOWN = 127, 112 }; 113 114 struct nvdimm_spa_dev { 115 int spa_domain; 116 vm_memattr_t spa_memattr; 117 uint64_t spa_phys_base; 118 uint64_t spa_len; 119 uint64_t spa_efi_mem_flags; 120 void *spa_kva; 121 struct vm_object *spa_obj; 122 struct cdev *spa_dev; 123 struct g_geom *spa_g; 124 }; 125 126 struct g_spa { 127 struct nvdimm_spa_dev *dev; 128 struct g_provider *spa_p; 129 struct bio_queue_head spa_g_queue; 130 struct mtx spa_g_mtx; 131 struct devstat *spa_g_devstat; 132 struct proc *spa_g_proc; 133 bool spa_g_proc_run; 134 bool spa_g_proc_exiting; 135 }; 136 137 struct nvdimm_namespace { 138 SLIST_ENTRY(nvdimm_namespace) link; 139 struct SPA_mapping *spa; 140 struct nvdimm_spa_dev dev; 141 }; 142 143 struct SPA_mapping { 144 SLIST_ENTRY(SPA_mapping) link; 145 enum SPA_mapping_type spa_type; 146 int spa_nfit_idx; 147 struct nvdimm_spa_dev dev; 148 SLIST_HEAD(, nvdimm_namespace) namespaces; 149 }; 150 151 MALLOC_DECLARE(M_NVDIMM); 152 153 void acpi_nfit_get_dimm_ids(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t **listp, 154 int *countp); 155 void acpi_nfit_get_spa_range(ACPI_TABLE_NFIT *nfitbl, uint16_t range_index, 156 ACPI_NFIT_SYSTEM_ADDRESS **spa); 157 void acpi_nfit_get_spa_ranges(ACPI_TABLE_NFIT *nfitbl, 158 ACPI_NFIT_SYSTEM_ADDRESS ***listp, int *countp); 159 void acpi_nfit_get_region_mappings_by_spa_range(ACPI_TABLE_NFIT *nfitbl, 160 uint16_t spa_range_index, ACPI_NFIT_MEMORY_MAP ***listp, int *countp); 161 void acpi_nfit_get_control_region(ACPI_TABLE_NFIT *nfitbl, 162 uint16_t control_region_index, ACPI_NFIT_CONTROL_REGION **out); 163 void acpi_nfit_get_flush_addrs(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t dimm, 164 uint64_t ***listp, int *countp); 165 void acpi_nfit_get_memory_maps_by_dimm(ACPI_TABLE_NFIT *nfitbl, 166 nfit_handle_t dimm, ACPI_NFIT_MEMORY_MAP ***listp, int *countp); 167 enum SPA_mapping_type nvdimm_spa_type_from_name(const char *); 168 enum SPA_mapping_type nvdimm_spa_type_from_uuid(struct uuid *); 169 bool nvdimm_spa_type_user_accessible(enum SPA_mapping_type); 170 struct nvdimm_dev *nvdimm_find_by_handle(nfit_handle_t nv_handle); 171 int nvdimm_spa_init(struct SPA_mapping *spa, ACPI_NFIT_SYSTEM_ADDRESS *nfitaddr, 172 enum SPA_mapping_type spa_type); 173 void nvdimm_spa_fini(struct SPA_mapping *spa); 174 int nvdimm_spa_dev_init(struct nvdimm_spa_dev *dev, const char *name, int unit); 175 void nvdimm_spa_dev_fini(struct nvdimm_spa_dev *dev); 176 int nvdimm_create_namespaces(struct SPA_mapping *spa, ACPI_TABLE_NFIT *nfitbl); 177 void nvdimm_destroy_namespaces(struct SPA_mapping *spa); 178 179 #endif /* __DEV_NVDIMM_VAR_H__ */ 180