linux/include/linux/libnvdimm.h
<<
>>
Prefs
   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
  23struct badrange_entry {
  24        u64 start;
  25        u64 length;
  26        struct list_head list;
  27};
  28
  29struct badrange {
  30        struct list_head list;
  31        spinlock_t lock;
  32};
  33
  34enum {
  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        /* memory under security wipes should not be accessed */
  42        NDD_SECURITY_OVERWRITE = 3,
  43        /*  tracking whether or not there is a pending device reference */
  44        NDD_WORK_PENDING = 4,
  45        /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */
  46        NDD_NOBLK = 5,
  47
  48        /* need to set a limit somewhere, but yes, this is likely overkill */
  49        ND_IOCTL_MAX_BUFLEN = SZ_4M,
  50        ND_CMD_MAX_ELEM = 5,
  51        ND_CMD_MAX_ENVELOPE = 256,
  52        ND_MAX_MAPPINGS = 32,
  53
  54        /* region flag indicating to direct-map persistent memory by default */
  55        ND_REGION_PAGEMAP = 0,
  56        /*
  57         * Platform ensures entire CPU store data path is flushed to pmem on
  58         * system power loss.
  59         */
  60        ND_REGION_PERSIST_CACHE = 1,
  61        /*
  62         * Platform provides mechanisms to automatically flush outstanding
  63         * write data from memory controler to pmem on system power loss.
  64         * (ADR)
  65         */
  66        ND_REGION_PERSIST_MEMCTRL = 2,
  67
  68        /* mark newly adjusted resources as requiring a label update */
  69        DPA_RESOURCE_ADJUSTED = 1 << 0,
  70};
  71
  72extern struct attribute_group nvdimm_bus_attribute_group;
  73extern struct attribute_group nvdimm_attribute_group;
  74extern struct attribute_group nd_device_attribute_group;
  75extern struct attribute_group nd_numa_attribute_group;
  76extern struct attribute_group nd_region_attribute_group;
  77extern struct attribute_group nd_mapping_attribute_group;
  78
  79struct nvdimm;
  80struct nvdimm_bus_descriptor;
  81typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
  82                struct nvdimm *nvdimm, unsigned int cmd, void *buf,
  83                unsigned int buf_len, int *cmd_rc);
  84
  85struct device_node;
  86struct nvdimm_bus_descriptor {
  87        const struct attribute_group **attr_groups;
  88        unsigned long bus_dsm_mask;
  89        unsigned long cmd_mask;
  90        struct module *module;
  91        char *provider_name;
  92        struct device_node *of_node;
  93        ndctl_fn ndctl;
  94        int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
  95        int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
  96                        struct nvdimm *nvdimm, unsigned int cmd, void *data);
  97};
  98
  99struct nd_cmd_desc {
 100        int in_num;
 101        int out_num;
 102        u32 in_sizes[ND_CMD_MAX_ELEM];
 103        int out_sizes[ND_CMD_MAX_ELEM];
 104};
 105
 106struct nd_interleave_set {
 107        /* v1.1 definition of the interleave-set-cookie algorithm */
 108        u64 cookie1;
 109        /* v1.2 definition of the interleave-set-cookie algorithm */
 110        u64 cookie2;
 111        /* compatibility with initial buggy Linux implementation */
 112        u64 altcookie;
 113
 114        guid_t type_guid;
 115};
 116
 117struct nd_mapping_desc {
 118        struct nvdimm *nvdimm;
 119        u64 start;
 120        u64 size;
 121        int position;
 122};
 123
 124struct nd_region_desc {
 125        struct resource *res;
 126        struct nd_mapping_desc *mapping;
 127        u16 num_mappings;
 128        const struct attribute_group **attr_groups;
 129        struct nd_interleave_set *nd_set;
 130        void *provider_data;
 131        int num_lanes;
 132        int numa_node;
 133        int target_node;
 134        unsigned long flags;
 135        struct device_node *of_node;
 136};
 137
 138struct device;
 139void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
 140                size_t size, unsigned long flags);
 141static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
 142                resource_size_t offset, size_t size)
 143{
 144        return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
 145}
 146
 147struct nvdimm_bus;
 148struct module;
 149struct device;
 150struct nd_blk_region;
 151struct nd_blk_region_desc {
 152        int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 153        int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 154                        void *iobuf, u64 len, int rw);
 155        struct nd_region_desc ndr_desc;
 156};
 157
 158static inline struct nd_blk_region_desc *to_blk_region_desc(
 159                struct nd_region_desc *ndr_desc)
 160{
 161        return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
 162
 163}
 164
 165enum nvdimm_security_state {
 166        NVDIMM_SECURITY_ERROR = -1,
 167        NVDIMM_SECURITY_DISABLED,
 168        NVDIMM_SECURITY_UNLOCKED,
 169        NVDIMM_SECURITY_LOCKED,
 170        NVDIMM_SECURITY_FROZEN,
 171        NVDIMM_SECURITY_OVERWRITE,
 172};
 173
 174#define NVDIMM_PASSPHRASE_LEN           32
 175#define NVDIMM_KEY_DESC_LEN             22
 176
 177struct nvdimm_key_data {
 178        u8 data[NVDIMM_PASSPHRASE_LEN];
 179};
 180
 181enum nvdimm_passphrase_type {
 182        NVDIMM_USER,
 183        NVDIMM_MASTER,
 184};
 185
 186struct nvdimm_security_ops {
 187        enum nvdimm_security_state (*state)(struct nvdimm *nvdimm,
 188                        enum nvdimm_passphrase_type pass_type);
 189        int (*freeze)(struct nvdimm *nvdimm);
 190        int (*change_key)(struct nvdimm *nvdimm,
 191                        const struct nvdimm_key_data *old_data,
 192                        const struct nvdimm_key_data *new_data,
 193                        enum nvdimm_passphrase_type pass_type);
 194        int (*unlock)(struct nvdimm *nvdimm,
 195                        const struct nvdimm_key_data *key_data);
 196        int (*disable)(struct nvdimm *nvdimm,
 197                        const struct nvdimm_key_data *key_data);
 198        int (*erase)(struct nvdimm *nvdimm,
 199                        const struct nvdimm_key_data *key_data,
 200                        enum nvdimm_passphrase_type pass_type);
 201        int (*overwrite)(struct nvdimm *nvdimm,
 202                        const struct nvdimm_key_data *key_data);
 203        int (*query_overwrite)(struct nvdimm *nvdimm);
 204};
 205
 206void badrange_init(struct badrange *badrange);
 207int badrange_add(struct badrange *badrange, u64 addr, u64 length);
 208void badrange_forget(struct badrange *badrange, phys_addr_t start,
 209                unsigned int len);
 210int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
 211                u64 length);
 212struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
 213                struct nvdimm_bus_descriptor *nfit_desc);
 214void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
 215struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
 216struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
 217struct nvdimm *to_nvdimm(struct device *dev);
 218struct nd_region *to_nd_region(struct device *dev);
 219struct device *nd_region_dev(struct nd_region *nd_region);
 220struct nd_blk_region *to_nd_blk_region(struct device *dev);
 221struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
 222struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
 223const char *nvdimm_name(struct nvdimm *nvdimm);
 224struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
 225unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
 226void *nvdimm_provider_data(struct nvdimm *nvdimm);
 227struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
 228                void *provider_data, const struct attribute_group **groups,
 229                unsigned long flags, unsigned long cmd_mask, int num_flush,
 230                struct resource *flush_wpq, const char *dimm_id,
 231                const struct nvdimm_security_ops *sec_ops);
 232static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
 233                void *provider_data, const struct attribute_group **groups,
 234                unsigned long flags, unsigned long cmd_mask, int num_flush,
 235                struct resource *flush_wpq)
 236{
 237        return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
 238                        cmd_mask, num_flush, flush_wpq, NULL, NULL);
 239}
 240
 241const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
 242const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
 243u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
 244                const struct nd_cmd_desc *desc, int idx, void *buf);
 245u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
 246                const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
 247                const u32 *out_field, unsigned long remainder);
 248int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
 249struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
 250                struct nd_region_desc *ndr_desc);
 251struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
 252                struct nd_region_desc *ndr_desc);
 253struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
 254                struct nd_region_desc *ndr_desc);
 255void *nd_region_provider_data(struct nd_region *nd_region);
 256void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
 257void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
 258struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
 259unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
 260unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
 261void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
 262u64 nd_fletcher64(void *addr, size_t len, bool le);
 263void nvdimm_flush(struct nd_region *nd_region);
 264int nvdimm_has_flush(struct nd_region *nd_region);
 265int nvdimm_has_cache(struct nd_region *nd_region);
 266int nvdimm_in_overwrite(struct nvdimm *nvdimm);
 267
 268static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
 269                unsigned int buf_len, int *cmd_rc)
 270{
 271        struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
 272        struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
 273
 274        return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
 275}
 276
 277#ifdef CONFIG_ARCH_HAS_PMEM_API
 278#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
 279void arch_wb_cache_pmem(void *addr, size_t size);
 280void arch_invalidate_pmem(void *addr, size_t size);
 281#else
 282#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
 283static inline void arch_wb_cache_pmem(void *addr, size_t size)
 284{
 285}
 286static inline void arch_invalidate_pmem(void *addr, size_t size)
 287{
 288}
 289#endif
 290
 291#endif /* __LIBNVDIMM_H__ */
 292