LXR linux/include/linux/libnvdimm.h

   1/* SPDX-License-Identifier: GPL-2.0-only */
   2/*
   3 * libnvdimm - Non-volatile-memory Devices Subsystem
   4 *
   5 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   6 */
   7#ifndef __LIBNVDIMM_H__
   8#define __LIBNVDIMM_H__
   9#include <linux/kernel.h>
  10#include <linux/sizes.h>
  11#include <linux/types.h>
  12#include <linux/uuid.h>
  13#include <linux/spinlock.h>
  14
  15struct badrange_entry {
  16        u64 start;
  17        u64 length;
  18        struct list_head list;
  19};
  20
  21struct badrange {
  22        struct list_head list;
  23        spinlock_t lock;
  24};
  25
  26enum {
  27        /* when a dimm supports both PMEM and BLK access a label is required */
  28        NDD_ALIASING = 0,
  29        /* unarmed memory devices may not persist writes */
  30        NDD_UNARMED = 1,
  31        /* locked memory devices should not be accessed */
  32        NDD_LOCKED = 2,
  33        /* memory under security wipes should not be accessed */
  34        NDD_SECURITY_OVERWRITE = 3,
  35        /*  tracking whether or not there is a pending device reference */
  36        NDD_WORK_PENDING = 4,
  37        /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */
  38        NDD_NOBLK = 5,
  39
  40        /* need to set a limit somewhere, but yes, this is likely overkill */
  41        ND_IOCTL_MAX_BUFLEN = SZ_4M,
  42        ND_CMD_MAX_ELEM = 5,
  43        ND_CMD_MAX_ENVELOPE = 256,
  44        ND_MAX_MAPPINGS = 32,
  45
  46        /* region flag indicating to direct-map persistent memory by default */
  47        ND_REGION_PAGEMAP = 0,
  48        /*
  49         * Platform ensures entire CPU store data path is flushed to pmem on
  50         * system power loss.
  51         */
  52        ND_REGION_PERSIST_CACHE = 1,
  53        /*
  54         * Platform provides mechanisms to automatically flush outstanding
  55         * write data from memory controler to pmem on system power loss.
  56         * (ADR)
  57         */
  58        ND_REGION_PERSIST_MEMCTRL = 2,
  59
  60        /* mark newly adjusted resources as requiring a label update */
  61        DPA_RESOURCE_ADJUSTED = 1 << 0,
  62};
  63
  64extern struct attribute_group nvdimm_bus_attribute_group;
  65extern struct attribute_group nvdimm_attribute_group;
  66extern struct attribute_group nd_device_attribute_group;
  67extern struct attribute_group nd_numa_attribute_group;
  68extern struct attribute_group nd_region_attribute_group;
  69extern struct attribute_group nd_mapping_attribute_group;
  70
  71struct nvdimm;
  72struct nvdimm_bus_descriptor;
  73typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
  74                struct nvdimm *nvdimm, unsigned int cmd, void *buf,
  75                unsigned int buf_len, int *cmd_rc);
  76
  77struct device_node;
  78struct nvdimm_bus_descriptor {
  79        const struct attribute_group **attr_groups;
  80        unsigned long bus_dsm_mask;
  81        unsigned long cmd_mask;
  82        struct module *module;
  83        char *provider_name;
  84        struct device_node *of_node;
  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, void *data);
  89};
  90
  91struct 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
  98struct 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
 109struct nd_mapping_desc {
 110        struct nvdimm *nvdimm;
 111        u64 start;
 112        u64 size;
 113        int position;
 114};
 115
 116struct 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        int target_node;
 126        unsigned long flags;
 127        struct device_node *of_node;
 128};
 129
 130struct device;
 131void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
 132                size_t size, unsigned long flags);
 133static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
 134                resource_size_t offset, size_t size)
 135{
 136        return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
 137}
 138
 139struct nvdimm_bus;
 140struct module;
 141struct device;
 142struct nd_blk_region;
 143struct nd_blk_region_desc {
 144        int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 145        int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 146                        void *iobuf, u64 len, int rw);
 147        struct nd_region_desc ndr_desc;
 148};
 149
 150static inline struct nd_blk_region_desc *to_blk_region_desc(
 151                struct nd_region_desc *ndr_desc)
 152{
 153        return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
 154
 155}
 156
 157enum nvdimm_security_state {
 158        NVDIMM_SECURITY_ERROR = -1,
 159        NVDIMM_SECURITY_DISABLED,
 160        NVDIMM_SECURITY_UNLOCKED,
 161        NVDIMM_SECURITY_LOCKED,
 162        NVDIMM_SECURITY_FROZEN,
 163        NVDIMM_SECURITY_OVERWRITE,
 164};
 165
 166#define NVDIMM_PASSPHRASE_LEN           32
 167#define NVDIMM_KEY_DESC_LEN             22
 168
 169struct nvdimm_key_data {
 170        u8 data[NVDIMM_PASSPHRASE_LEN];
 171};
 172
 173enum nvdimm_passphrase_type {
 174        NVDIMM_USER,
 175        NVDIMM_MASTER,
 176};
 177
 178struct nvdimm_security_ops {
 179        enum nvdimm_security_state (*state)(struct nvdimm *nvdimm,
 180                        enum nvdimm_passphrase_type pass_type);
 181        int (*freeze)(struct nvdimm *nvdimm);
 182        int (*change_key)(struct nvdimm *nvdimm,
 183                        const struct nvdimm_key_data *old_data,
 184                        const struct nvdimm_key_data *new_data,
 185                        enum nvdimm_passphrase_type pass_type);
 186        int (*unlock)(struct nvdimm *nvdimm,
 187                        const struct nvdimm_key_data *key_data);
 188        int (*disable)(struct nvdimm *nvdimm,
 189                        const struct nvdimm_key_data *key_data);
 190        int (*erase)(struct nvdimm *nvdimm,
 191                        const struct nvdimm_key_data *key_data,
 192                        enum nvdimm_passphrase_type pass_type);
 193        int (*overwrite)(struct nvdimm *nvdimm,
 194                        const struct nvdimm_key_data *key_data);
 195        int (*query_overwrite)(struct nvdimm *nvdimm);
 196};
 197
 198void badrange_init(struct badrange *badrange);
 199int badrange_add(struct badrange *badrange, u64 addr, u64 length);
 200void badrange_forget(struct badrange *badrange, phys_addr_t start,
 201                unsigned int len);
 202int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
 203                u64 length);
 204struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
 205                struct nvdimm_bus_descriptor *nfit_desc);
 206void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
 207struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
 208struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
 209struct nvdimm *to_nvdimm(struct device *dev);
 210struct nd_region *to_nd_region(struct device *dev);
 211struct device *nd_region_dev(struct nd_region *nd_region);
 212struct nd_blk_region *to_nd_blk_region(struct device *dev);
 213struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
 214struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
 215const char *nvdimm_name(struct nvdimm *nvdimm);
 216struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
 217unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
 218void *nvdimm_provider_data(struct nvdimm *nvdimm);
 219struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
 220                void *provider_data, const struct attribute_group **groups,
 221                unsigned long flags, unsigned long cmd_mask, int num_flush,
 222                struct resource *flush_wpq, const char *dimm_id,
 223                const struct nvdimm_security_ops *sec_ops);
 224static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
 225                void *provider_data, const struct attribute_group **groups,
 226                unsigned long flags, unsigned long cmd_mask, int num_flush,
 227                struct resource *flush_wpq)
 228{
 229        return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
 230                        cmd_mask, num_flush, flush_wpq, NULL, NULL);
 231}
 232
 233const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
 234const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
 235u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
 236                const struct nd_cmd_desc *desc, int idx, void *buf);
 237u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
 238                const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
 239                const u32 *out_field, unsigned long remainder);
 240int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
 241struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
 242                struct nd_region_desc *ndr_desc);
 243struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
 244                struct nd_region_desc *ndr_desc);
 245struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
 246                struct nd_region_desc *ndr_desc);
 247void *nd_region_provider_data(struct nd_region *nd_region);
 248void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
 249void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
 250struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
 251unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
 252unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
 253void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
 254u64 nd_fletcher64(void *addr, size_t len, bool le);
 255void nvdimm_flush(struct nd_region *nd_region);
 256int nvdimm_has_flush(struct nd_region *nd_region);
 257int nvdimm_has_cache(struct nd_region *nd_region);
 258int nvdimm_in_overwrite(struct nvdimm *nvdimm);
 259
 260static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
 261                unsigned int buf_len, int *cmd_rc)
 262{
 263        struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
 264        struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
 265
 266        return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
 267}
 268
 269#ifdef CONFIG_ARCH_HAS_PMEM_API
 270#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
 271void arch_wb_cache_pmem(void *addr, size_t size);
 272void arch_invalidate_pmem(void *addr, size_t size);
 273#else
 274#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
 275static inline void arch_wb_cache_pmem(void *addr, size_t size)
 276{
 277}
 278static inline void arch_invalidate_pmem(void *addr, size_t size)
 279{
 280}
 281#endif
 282
 283#endif /* __LIBNVDIMM_H__ */
 284