LXR linux/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
  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
  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
  66extern struct attribute_group nvdimm_bus_attribute_group;
  67extern struct attribute_group nvdimm_attribute_group;
  68extern struct attribute_group nd_device_attribute_group;
  69extern struct attribute_group nd_numa_attribute_group;
  70extern struct attribute_group nd_region_attribute_group;
  71extern struct attribute_group nd_mapping_attribute_group;
  72
  73struct nvdimm;
  74struct nvdimm_bus_descriptor;
  75typedef 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
  79struct device_node;
  80struct nvdimm_bus_descriptor {
  81        const struct attribute_group **attr_groups;
  82        unsigned long bus_dsm_mask;
  83        unsigned long cmd_mask;
  84        struct module *module;
  85        char *provider_name;
  86        struct device_node *of_node;
  87        ndctl_fn ndctl;
  88        int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
  89        int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
  90                        struct nvdimm *nvdimm, unsigned int cmd);
  91};
  92
  93struct nd_cmd_desc {
  94        int in_num;
  95        int out_num;
  96        u32 in_sizes[ND_CMD_MAX_ELEM];
  97        int out_sizes[ND_CMD_MAX_ELEM];
  98};
  99
 100struct nd_interleave_set {
 101        /* v1.1 definition of the interleave-set-cookie algorithm */
 102        u64 cookie1;
 103        /* v1.2 definition of the interleave-set-cookie algorithm */
 104        u64 cookie2;
 105        /* compatibility with initial buggy Linux implementation */
 106        u64 altcookie;
 107
 108        guid_t type_guid;
 109};
 110
 111struct nd_mapping_desc {
 112        struct nvdimm *nvdimm;
 113        u64 start;
 114        u64 size;
 115        int position;
 116};
 117
 118struct nd_region_desc {
 119        struct resource *res;
 120        struct nd_mapping_desc *mapping;
 121        u16 num_mappings;
 122        const struct attribute_group **attr_groups;
 123        struct nd_interleave_set *nd_set;
 124        void *provider_data;
 125        int num_lanes;
 126        int numa_node;
 127        unsigned long flags;
 128        struct device_node *of_node;
 129};
 130
 131struct device;
 132void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
 133                size_t size, unsigned long flags);
 134static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
 135                resource_size_t offset, size_t size)
 136{
 137        return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
 138}
 139
 140struct nvdimm_bus;
 141struct module;
 142struct device;
 143struct nd_blk_region;
 144struct nd_blk_region_desc {
 145        int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 146        int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 147                        void *iobuf, u64 len, int rw);
 148        struct nd_region_desc ndr_desc;
 149};
 150
 151static inline struct nd_blk_region_desc *to_blk_region_desc(
 152                struct nd_region_desc *ndr_desc)
 153{
 154        return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
 155
 156}
 157
 158void badrange_init(struct badrange *badrange);
 159int badrange_add(struct badrange *badrange, u64 addr, u64 length);
 160void badrange_forget(struct badrange *badrange, phys_addr_t start,
 161                unsigned int len);
 162int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
 163                u64 length);
 164struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
 165                struct nvdimm_bus_descriptor *nfit_desc);
 166void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
 167struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
 168struct nvdimm *to_nvdimm(struct device *dev);
 169struct nd_region *to_nd_region(struct device *dev);
 170struct device *nd_region_dev(struct nd_region *nd_region);
 171struct nd_blk_region *to_nd_blk_region(struct device *dev);
 172struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
 173struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
 174const char *nvdimm_name(struct nvdimm *nvdimm);
 175struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
 176unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
 177void *nvdimm_provider_data(struct nvdimm *nvdimm);
 178struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
 179                const struct attribute_group **groups, unsigned long flags,
 180                unsigned long cmd_mask, int num_flush,
 181                struct resource *flush_wpq);
 182const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
 183const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
 184u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
 185                const struct nd_cmd_desc *desc, int idx, void *buf);
 186u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
 187                const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
 188                const u32 *out_field, unsigned long remainder);
 189int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
 190struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
 191                struct nd_region_desc *ndr_desc);
 192struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
 193                struct nd_region_desc *ndr_desc);
 194struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
 195                struct nd_region_desc *ndr_desc);
 196void *nd_region_provider_data(struct nd_region *nd_region);
 197void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
 198void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
 199struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
 200unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
 201unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
 202void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
 203u64 nd_fletcher64(void *addr, size_t len, bool le);
 204void nvdimm_flush(struct nd_region *nd_region);
 205int nvdimm_has_flush(struct nd_region *nd_region);
 206int nvdimm_has_cache(struct nd_region *nd_region);
 207
 208#ifdef CONFIG_ARCH_HAS_PMEM_API
 209#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
 210void arch_wb_cache_pmem(void *addr, size_t size);
 211void arch_invalidate_pmem(void *addr, size_t size);
 212#else
 213#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
 214static inline void arch_wb_cache_pmem(void *addr, size_t size)
 215{
 216}
 217static inline void arch_invalidate_pmem(void *addr, size_t size)
 218{
 219}
 220#endif
 221
 222#endif /* __LIBNVDIMM_H__ */
 223