include/linux/libnvdimm.h

   1 /*
   2  * libnvdimm - Non-volatile-memory Devices Subsystem
   3  *
   4  * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of version 2 of the GNU General Public License as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  */
  15 #ifndef __LIBNVDIMM_H__
  16 #define __LIBNVDIMM_H__
  17 #include <linux/kernel.h>
  18 #include <linux/sizes.h>
  19 #include <linux/types.h>
  20 #include <linux/uuid.h>
  21 #include <linux/spinlock.h>
  22
  23 struct badrange_entry {
  24         u64 start;
  25         u64 length;
  26         struct list_head list;
  27 };
  28
  29 struct badrange {
  30         struct list_head list;
  31         spinlock_t lock;
  32 };
  33
  34 enum {
  35         /* when a dimm supports both PMEM and BLK access a label is required */
  36         NDD_ALIASING = 0,
  37         /* unarmed memory devices may not persist writes */
  38         NDD_UNARMED = 1,
  39         /* locked memory devices should not be accessed */
  40         NDD_LOCKED = 2,
  41
  42         /* need to set a limit somewhere, but yes, this is likely overkill */
  43         ND_IOCTL_MAX_BUFLEN = SZ_4M,
  44         ND_CMD_MAX_ELEM = 5,
  45         ND_CMD_MAX_ENVELOPE = 256,
  46         ND_MAX_MAPPINGS = 32,
  47
  48         /* region flag indicating to direct-map persistent memory by default */
  49         ND_REGION_PAGEMAP = 0,
  50         /*
  51          * Platform ensures entire CPU store data path is flushed to pmem on
  52          * system power loss.
  53          */
  54         ND_REGION_PERSIST_CACHE = 1,
  55         /*
  56          * Platform provides mechanisms to automatically flush outstanding
  57          * write data from memory controler to pmem on system power loss.
  58          * (ADR)
  59          */
  60         ND_REGION_PERSIST_MEMCTRL = 2,
  61
  62         /* mark newly adjusted resources as requiring a label update */
  63         DPA_RESOURCE_ADJUSTED = 1 << 0,
  64 };
  65
  66 extern struct attribute_group nvdimm_bus_attribute_group;
  67 extern struct attribute_group nvdimm_attribute_group;
  68 extern struct attribute_group nd_device_attribute_group;
  69 extern struct attribute_group nd_numa_attribute_group;
  70 extern struct attribute_group nd_region_attribute_group;
  71 extern struct attribute_group nd_mapping_attribute_group;
  72
  73 struct nvdimm;
  74 struct nvdimm_bus_descriptor;
  75 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
  76                 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
  77                 unsigned int buf_len, int *cmd_rc);
  78
  79 struct nvdimm_bus_descriptor {
  80         const struct attribute_group **attr_groups;
  81         unsigned long bus_dsm_mask;
  82         unsigned long cmd_mask;
  83         struct module *module;
  84         char *provider_name;
  85         ndctl_fn ndctl;
  86         int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
  87         int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
  88                         struct nvdimm *nvdimm, unsigned int cmd);
  89 };
  90
  91 struct nd_cmd_desc {
  92         int in_num;
  93         int out_num;
  94         u32 in_sizes[ND_CMD_MAX_ELEM];
  95         int out_sizes[ND_CMD_MAX_ELEM];
  96 };
  97
  98 struct nd_interleave_set {
  99         /* v1.1 definition of the interleave-set-cookie algorithm */
 100         u64 cookie1;
 101         /* v1.2 definition of the interleave-set-cookie algorithm */
 102         u64 cookie2;
 103         /* compatibility with initial buggy Linux implementation */
 104         u64 altcookie;
 105
 106         guid_t type_guid;
 107 };
 108
 109 struct nd_mapping_desc {
 110         struct nvdimm *nvdimm;
 111         u64 start;
 112         u64 size;
 113         int position;
 114 };
 115
 116 struct nd_region_desc {
 117         struct resource *res;
 118         struct nd_mapping_desc *mapping;
 119         u16 num_mappings;
 120         const struct attribute_group **attr_groups;
 121         struct nd_interleave_set *nd_set;
 122         void *provider_data;
 123         int num_lanes;
 124         int numa_node;
 125         unsigned long flags;
 126 };
 127
 128 struct device;
 129 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
 130                 size_t size, unsigned long flags);
 131 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
 132                 resource_size_t offset, size_t size)
 133 {
 134         return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
 135 }
 136
 137 struct nvdimm_bus;
 138 struct module;
 139 struct device;
 140 struct nd_blk_region;
 141 struct nd_blk_region_desc {
 142         int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 143         int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 144                         void *iobuf, u64 len, int rw);
 145         struct nd_region_desc ndr_desc;
 146 };
 147
 148 static inline struct nd_blk_region_desc *to_blk_region_desc(
 149                 struct nd_region_desc *ndr_desc)
 150 {
 151         return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
 152
 153 }
 154
 155 void badrange_init(struct badrange *badrange);
 156 int badrange_add(struct badrange *badrange, u64 addr, u64 length);
 157 void badrange_forget(struct badrange *badrange, phys_addr_t start,
 158                 unsigned int len);
 159 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
 160                 u64 length);
 161 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
 162                 struct nvdimm_bus_descriptor *nfit_desc);
 163 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
 164 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
 165 struct nvdimm *to_nvdimm(struct device *dev);
 166 struct nd_region *to_nd_region(struct device *dev);
 167 struct nd_blk_region *to_nd_blk_region(struct device *dev);
 168 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
 169 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
 170 const char *nvdimm_name(struct nvdimm *nvdimm);
 171 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
 172 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
 173 void *nvdimm_provider_data(struct nvdimm *nvdimm);
 174 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
 175                 const struct attribute_group **groups, unsigned long flags,
 176                 unsigned long cmd_mask, int num_flush,
 177                 struct resource *flush_wpq);
 178 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
 179 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
 180 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
 181                 const struct nd_cmd_desc *desc, int idx, void *buf);
 182 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
 183                 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
 184                 const u32 *out_field, unsigned long remainder);
 185 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
 186 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
 187                 struct nd_region_desc *ndr_desc);
 188 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
 189                 struct nd_region_desc *ndr_desc);
 190 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
 191                 struct nd_region_desc *ndr_desc);
 192 void *nd_region_provider_data(struct nd_region *nd_region);
 193 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
 194 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
 195 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
 196 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
 197 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
 198 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
 199 u64 nd_fletcher64(void *addr, size_t len, bool le);
 200 void nvdimm_flush(struct nd_region *nd_region);
 201 int nvdimm_has_flush(struct nd_region *nd_region);
 202 int nvdimm_has_cache(struct nd_region *nd_region);
 203
 204 #ifdef CONFIG_ARCH_HAS_PMEM_API
 205 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
 206 void arch_wb_cache_pmem(void *addr, size_t size);
 207 void arch_invalidate_pmem(void *addr, size_t size);
 208 #else
 209 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
 210 static inline void arch_wb_cache_pmem(void *addr, size_t size)
 211 {
 212 }
 213 static inline void arch_invalidate_pmem(void *addr, size_t size)
 214 {
 215 }
 216 #endif
 217
 218 #endif /* __LIBNVDIMM_H__ */