drivers/nvdimm/nd-core.h

   1 /*
   2  * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  */
  13 #ifndef __ND_CORE_H__
  14 #define __ND_CORE_H__
  15 #include <linux/libnvdimm.h>
  16 #include <linux/device.h>
  17 #include <linux/libnvdimm.h>
  18 #include <linux/sizes.h>
  19 #include <linux/mutex.h>
  20 #include <linux/nd.h>
  21
  22 extern struct list_head nvdimm_bus_list;
  23 extern struct mutex nvdimm_bus_list_mutex;
  24 extern int nvdimm_major;
  25
  26 struct nvdimm_bus {
  27         struct nvdimm_bus_descriptor *nd_desc;
  28         wait_queue_head_t probe_wait;
  29         struct list_head list;
  30         struct device dev;
  31         int id, probe_active;
  32         struct list_head poison_list;
  33         struct list_head mapping_list;
  34         struct mutex reconfig_mutex;
  35 };
  36
  37 struct nvdimm {
  38         unsigned long flags;
  39         void *provider_data;
  40         unsigned long cmd_mask;
  41         struct device dev;
  42         atomic_t busy;
  43         int id, num_flush;
  44         struct resource *flush_wpq;
  45 };
  46
  47 bool is_nvdimm(struct device *dev);
  48 bool is_nd_pmem(struct device *dev);
  49 bool is_nd_blk(struct device *dev);
  50 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
  51 int __init nvdimm_bus_init(void);
  52 void nvdimm_bus_exit(void);
  53 void nvdimm_devs_exit(void);
  54 void nd_region_devs_exit(void);
  55 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
  56 struct nd_region;
  57 void nd_region_create_blk_seed(struct nd_region *nd_region);
  58 void nd_region_create_btt_seed(struct nd_region *nd_region);
  59 void nd_region_create_pfn_seed(struct nd_region *nd_region);
  60 void nd_region_create_dax_seed(struct nd_region *nd_region);
  61 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
  62 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
  63 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
  64 void nd_synchronize(void);
  65 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
  66 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
  67 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
  68 void __nd_device_register(struct device *dev);
  69 int nd_match_dimm(struct device *dev, void *data);
  70 struct nd_label_id;
  71 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
  72 bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
  73 struct nd_region;
  74 struct nvdimm_drvdata;
  75 struct nd_mapping;
  76 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
  77                 struct nd_mapping *nd_mapping, resource_size_t *overlap);
  78 resource_size_t nd_blk_available_dpa(struct nd_mapping *nd_mapping);
  79 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
  80 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
  81                 struct nd_label_id *label_id);
  82 struct nd_mapping;
  83 struct resource *nsblk_add_resource(struct nd_region *nd_region,
  84                 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
  85                 resource_size_t start);
  86 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
  87 void get_ndd(struct nvdimm_drvdata *ndd);
  88 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
  89 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
  90 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
  91 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
  92                 struct nd_namespace_common **_ndns);
  93 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
  94                 struct nd_namespace_common **_ndns);
  95 ssize_t nd_namespace_store(struct device *dev,
  96                 struct nd_namespace_common **_ndns, const char *buf,
  97                 size_t len);
  98 struct nd_pfn *to_nd_pfn_safe(struct device *dev);
  99 #endif /* __ND_CORE_H__ */