LXR linux/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
  22extern struct list_head nvdimm_bus_list;
  23extern struct mutex nvdimm_bus_list_mutex;
  24extern int nvdimm_major;
  25
  26struct 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 mapping_list;
  33        struct mutex reconfig_mutex;
  34        struct badrange badrange;
  35};
  36
  37struct 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/**
  48 * struct blk_alloc_info - tracking info for BLK dpa scanning
  49 * @nd_mapping: blk region mapping boundaries
  50 * @available: decremented in alias_dpa_busy as aliased PMEM is scanned
  51 * @busy: decremented in blk_dpa_busy to account for ranges already
  52 *        handled by alias_dpa_busy
  53 * @res: alias_dpa_busy interprets this a free space range that needs to
  54 *       be truncated to the valid BLK allocation starting DPA, blk_dpa_busy
  55 *       treats it as a busy range that needs the aliased PMEM ranges
  56 *       truncated.
  57 */
  58struct blk_alloc_info {
  59        struct nd_mapping *nd_mapping;
  60        resource_size_t available, busy;
  61        struct resource *res;
  62};
  63
  64bool is_nvdimm(struct device *dev);
  65bool is_nd_pmem(struct device *dev);
  66bool is_nd_volatile(struct device *dev);
  67bool is_nd_blk(struct device *dev);
  68static inline bool is_nd_region(struct device *dev)
  69{
  70        return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
  71}
  72static inline bool is_memory(struct device *dev)
  73{
  74        return is_nd_pmem(dev) || is_nd_volatile(dev);
  75}
  76struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
  77int __init nvdimm_bus_init(void);
  78void nvdimm_bus_exit(void);
  79void nvdimm_devs_exit(void);
  80void nd_region_devs_exit(void);
  81void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
  82struct nd_region;
  83void nd_region_create_ns_seed(struct nd_region *nd_region);
  84void nd_region_create_btt_seed(struct nd_region *nd_region);
  85void nd_region_create_pfn_seed(struct nd_region *nd_region);
  86void nd_region_create_dax_seed(struct nd_region *nd_region);
  87void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
  88int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
  89void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
  90void nd_synchronize(void);
  91int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
  92int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
  93int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
  94void __nd_device_register(struct device *dev);
  95int nd_match_dimm(struct device *dev, void *data);
  96struct nd_label_id;
  97char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
  98bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
  99struct nd_region;
 100struct nvdimm_drvdata;
 101struct nd_mapping;
 102void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
 103
 104int __reserve_free_pmem(struct device *dev, void *data);
 105void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
 106                       struct nd_mapping *nd_mapping);
 107
 108resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
 109                                           struct nd_mapping *nd_mapping);
 110resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
 111resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
 112                struct nd_mapping *nd_mapping, resource_size_t *overlap);
 113resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
 114resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
 115resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
 116                struct nd_label_id *label_id);
 117int alias_dpa_busy(struct device *dev, void *data);
 118struct resource *nsblk_add_resource(struct nd_region *nd_region,
 119                struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
 120                resource_size_t start);
 121int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
 122void get_ndd(struct nvdimm_drvdata *ndd);
 123resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
 124void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
 125void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
 126bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
 127                struct nd_namespace_common **_ndns);
 128bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
 129                struct nd_namespace_common **_ndns);
 130ssize_t nd_namespace_store(struct device *dev,
 131                struct nd_namespace_common **_ndns, const char *buf,
 132                size_t len);
 133struct nd_pfn *to_nd_pfn_safe(struct device *dev);
 134#endif /* __ND_CORE_H__ */
 135