1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. 4 */ 5 #ifndef __ND_CORE_H__ 6 #define __ND_CORE_H__ 7 #include <linux/libnvdimm.h> 8 #include <linux/device.h> 9 #include <linux/sizes.h> 10 #include <linux/mutex.h> 11 #include <linux/nd.h> 12 13 extern struct list_head nvdimm_bus_list; 14 extern struct mutex nvdimm_bus_list_mutex; 15 extern int nvdimm_major; 16 extern struct workqueue_struct *nvdimm_wq; 17 18 struct nvdimm_bus { 19 struct nvdimm_bus_descriptor *nd_desc; 20 wait_queue_head_t probe_wait; 21 struct list_head list; 22 struct device dev; 23 int id, probe_active; 24 struct list_head mapping_list; 25 struct mutex reconfig_mutex; 26 struct badrange badrange; 27 }; 28 29 struct nvdimm { 30 unsigned long flags; 31 void *provider_data; 32 unsigned long cmd_mask; 33 struct device dev; 34 atomic_t busy; 35 int id, num_flush; 36 struct resource *flush_wpq; 37 const char *dimm_id; 38 struct { 39 const struct nvdimm_security_ops *ops; 40 enum nvdimm_security_state state; 41 enum nvdimm_security_state ext_state; 42 unsigned int overwrite_tmo; 43 struct kernfs_node *overwrite_state; 44 } sec; 45 struct delayed_work dwork; 46 }; 47 48 static inline enum nvdimm_security_state nvdimm_security_state( 49 struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype) 50 { 51 if (!nvdimm->sec.ops) 52 return -ENXIO; 53 54 return nvdimm->sec.ops->state(nvdimm, ptype); 55 } 56 int nvdimm_security_freeze(struct nvdimm *nvdimm); 57 #if IS_ENABLED(CONFIG_NVDIMM_KEYS) 58 int nvdimm_security_disable(struct nvdimm *nvdimm, unsigned int keyid); 59 int nvdimm_security_update(struct nvdimm *nvdimm, unsigned int keyid, 60 unsigned int new_keyid, 61 enum nvdimm_passphrase_type pass_type); 62 int nvdimm_security_erase(struct nvdimm *nvdimm, unsigned int keyid, 63 enum nvdimm_passphrase_type pass_type); 64 int nvdimm_security_overwrite(struct nvdimm *nvdimm, unsigned int keyid); 65 void nvdimm_security_overwrite_query(struct work_struct *work); 66 #else 67 static inline int nvdimm_security_disable(struct nvdimm *nvdimm, 68 unsigned int keyid) 69 { 70 return -EOPNOTSUPP; 71 } 72 static inline int nvdimm_security_update(struct nvdimm *nvdimm, 73 unsigned int keyid, 74 unsigned int new_keyid, 75 enum nvdimm_passphrase_type pass_type) 76 { 77 return -EOPNOTSUPP; 78 } 79 static inline int nvdimm_security_erase(struct nvdimm *nvdimm, 80 unsigned int keyid, 81 enum nvdimm_passphrase_type pass_type) 82 { 83 return -EOPNOTSUPP; 84 } 85 static inline int nvdimm_security_overwrite(struct nvdimm *nvdimm, 86 unsigned int keyid) 87 { 88 return -EOPNOTSUPP; 89 } 90 static inline void nvdimm_security_overwrite_query(struct work_struct *work) 91 { 92 } 93 #endif 94 95 /** 96 * struct blk_alloc_info - tracking info for BLK dpa scanning 97 * @nd_mapping: blk region mapping boundaries 98 * @available: decremented in alias_dpa_busy as aliased PMEM is scanned 99 * @busy: decremented in blk_dpa_busy to account for ranges already 100 * handled by alias_dpa_busy 101 * @res: alias_dpa_busy interprets this a free space range that needs to 102 * be truncated to the valid BLK allocation starting DPA, blk_dpa_busy 103 * treats it as a busy range that needs the aliased PMEM ranges 104 * truncated. 105 */ 106 struct blk_alloc_info { 107 struct nd_mapping *nd_mapping; 108 resource_size_t available, busy; 109 struct resource *res; 110 }; 111 112 bool is_nvdimm(struct device *dev); 113 bool is_nd_pmem(struct device *dev); 114 bool is_nd_volatile(struct device *dev); 115 bool is_nd_blk(struct device *dev); 116 static inline bool is_nd_region(struct device *dev) 117 { 118 return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev); 119 } 120 static inline bool is_memory(struct device *dev) 121 { 122 return is_nd_pmem(dev) || is_nd_volatile(dev); 123 } 124 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev); 125 int __init nvdimm_bus_init(void); 126 void nvdimm_bus_exit(void); 127 void nvdimm_devs_exit(void); 128 void nd_region_devs_exit(void); 129 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev); 130 struct nd_region; 131 void nd_region_create_ns_seed(struct nd_region *nd_region); 132 void nd_region_create_btt_seed(struct nd_region *nd_region); 133 void nd_region_create_pfn_seed(struct nd_region *nd_region); 134 void nd_region_create_dax_seed(struct nd_region *nd_region); 135 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev); 136 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus); 137 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus); 138 void nd_synchronize(void); 139 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus); 140 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus); 141 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus); 142 void __nd_device_register(struct device *dev); 143 int nd_match_dimm(struct device *dev, void *data); 144 struct nd_label_id; 145 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags); 146 bool nd_is_uuid_unique(struct device *dev, u8 *uuid); 147 struct nd_region; 148 struct nvdimm_drvdata; 149 struct nd_mapping; 150 void nd_mapping_free_labels(struct nd_mapping *nd_mapping); 151 152 int __reserve_free_pmem(struct device *dev, void *data); 153 void release_free_pmem(struct nvdimm_bus *nvdimm_bus, 154 struct nd_mapping *nd_mapping); 155 156 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region, 157 struct nd_mapping *nd_mapping); 158 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region); 159 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region, 160 struct nd_mapping *nd_mapping, resource_size_t *overlap); 161 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region); 162 resource_size_t nd_region_available_dpa(struct nd_region *nd_region); 163 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start, 164 resource_size_t size); 165 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd, 166 struct nd_label_id *label_id); 167 int alias_dpa_busy(struct device *dev, void *data); 168 struct resource *nsblk_add_resource(struct nd_region *nd_region, 169 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk, 170 resource_size_t start); 171 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd); 172 void get_ndd(struct nvdimm_drvdata *ndd); 173 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 174 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 175 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 176 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 177 struct nd_namespace_common **_ndns); 178 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 179 struct nd_namespace_common **_ndns); 180 ssize_t nd_namespace_store(struct device *dev, 181 struct nd_namespace_common **_ndns, const char *buf, 182 size_t len); 183 struct nd_pfn *to_nd_pfn_safe(struct device *dev); 184 #endif /* __ND_CORE_H__ */ 185