blob: 8623e57c2ce3c8075133d7e86801296b9447d0d1 [file] [log] [blame]
Dan Williamsb94d5232015-05-19 22:54:31 -04001/*
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>
Dan Williamseaf96152015-05-01 13:11:27 -040017#include <linux/libnvdimm.h>
18#include <linux/sizes.h>
19#include <linux/mutex.h>
Dan Williams1b40e092015-05-01 13:34:01 -040020#include <linux/nd.h>
Dan Williamsb94d5232015-05-19 22:54:31 -040021
Dan Williamse6dfb2d2015-04-25 03:56:17 -040022extern struct list_head nvdimm_bus_list;
23extern struct mutex nvdimm_bus_list_mutex;
Dan Williams62232e452015-06-08 14:27:06 -040024extern int nvdimm_major;
Dan Williamse6dfb2d2015-04-25 03:56:17 -040025
Dan Williamsb94d5232015-05-19 22:54:31 -040026struct nvdimm_bus {
27 struct nvdimm_bus_descriptor *nd_desc;
Dan Williamseaf96152015-05-01 13:11:27 -040028 wait_queue_head_t probe_wait;
Dan Williams45def222015-04-26 19:26:48 -040029 struct list_head list;
Dan Williamsb94d5232015-05-19 22:54:31 -040030 struct device dev;
Dan Williamseaf96152015-05-01 13:11:27 -040031 int id, probe_active;
Vishal Verma0caeef62015-12-24 19:21:43 -070032 struct list_head poison_list;
Dan Williams29b9aa02016-06-06 17:42:38 -070033 struct list_head mapping_list;
Dan Williams3d880022015-05-31 15:02:11 -040034 struct mutex reconfig_mutex;
Dan Williamsb94d5232015-05-19 22:54:31 -040035};
Dan Williams45def222015-04-26 19:26:48 -040036
Dan Williamse6dfb2d2015-04-25 03:56:17 -040037struct nvdimm {
38 unsigned long flags;
39 void *provider_data;
Dan Williamse3654ec2016-04-28 16:17:07 -070040 unsigned long cmd_mask;
Dan Williamse6dfb2d2015-04-25 03:56:17 -040041 struct device dev;
Dan Williamseaf96152015-05-01 13:11:27 -040042 atomic_t busy;
Dan Williamse5ae3b22016-06-07 17:00:04 -070043 int id, num_flush;
44 struct resource *flush_wpq;
Dan Williamse6dfb2d2015-04-25 03:56:17 -040045};
46
Dan Williams762d0672016-10-04 16:09:59 -070047/**
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
Dan Williams3d880022015-05-31 15:02:11 -040064bool is_nvdimm(struct device *dev);
Dan Williams3d880022015-05-31 15:02:11 -040065bool is_nd_pmem(struct device *dev);
Ross Zwisler047fc8a2015-06-25 04:21:02 -040066bool is_nd_blk(struct device *dev);
Dan Williamse6dfb2d2015-04-25 03:56:17 -040067struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
Dan Williams45def222015-04-26 19:26:48 -040068int __init nvdimm_bus_init(void);
Dan Williams4d88a972015-05-31 14:41:48 -040069void nvdimm_bus_exit(void);
Dan Williamsb354aba2016-05-17 20:24:16 -070070void nvdimm_devs_exit(void);
71void nd_region_devs_exit(void);
Dan Williamseaf96152015-05-01 13:11:27 -040072void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
Dan Williams1b40e092015-05-01 13:34:01 -040073struct nd_region;
Dan Williams98a29c392016-09-30 15:28:27 -070074void nd_region_create_ns_seed(struct nd_region *nd_region);
Dan Williams8c2f7e82015-06-25 04:20:04 -040075void nd_region_create_btt_seed(struct nd_region *nd_region);
Dan Williams2dc43332015-12-13 11:41:36 -080076void nd_region_create_pfn_seed(struct nd_region *nd_region);
Dan Williamscd034122016-03-11 10:15:36 -080077void nd_region_create_dax_seed(struct nd_region *nd_region);
Dan Williamseaf96152015-05-01 13:11:27 -040078void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
Dan Williams45def222015-04-26 19:26:48 -040079int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
80void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
Dan Williams4d88a972015-05-31 14:41:48 -040081void nd_synchronize(void);
Dan Williams1f7df6f2015-06-09 20:13:14 -040082int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
83int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
Dan Williamseaf96152015-05-01 13:11:27 -040084int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
Dan Williams8c2f7e82015-06-25 04:20:04 -040085void __nd_device_register(struct device *dev);
Dan Williams1f7df6f2015-06-09 20:13:14 -040086int nd_match_dimm(struct device *dev, void *data);
Dan Williamsbf9bccc2015-06-17 17:14:46 -040087struct nd_label_id;
88char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
89bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
90struct nd_region;
91struct nvdimm_drvdata;
92struct nd_mapping;
Dan Williamsae8219f2016-09-19 16:04:21 -070093void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
Dan Williamsbf9bccc2015-06-17 17:14:46 -040094resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
95 struct nd_mapping *nd_mapping, resource_size_t *overlap);
Dan Williamsa1f3e4d2016-09-30 17:28:58 -070096resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
Dan Williamsbf9bccc2015-06-17 17:14:46 -040097resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
98resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
99 struct nd_label_id *label_id);
Dan Williams762d0672016-10-04 16:09:59 -0700100int alias_dpa_busy(struct device *dev, void *data);
Dan Williams1b40e092015-05-01 13:34:01 -0400101struct resource *nsblk_add_resource(struct nd_region *nd_region,
102 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
103 resource_size_t start);
Dan Williams0ba1c632015-05-30 12:35:36 -0400104int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
Dan Williamsbf9bccc2015-06-17 17:14:46 -0400105void get_ndd(struct nvdimm_drvdata *ndd);
Dan Williams8c2f7e82015-06-25 04:20:04 -0400106resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
Dan Williamse1455742015-07-30 17:57:47 -0400107void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
108void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
109bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
110 struct nd_namespace_common **_ndns);
111bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
112 struct nd_namespace_common **_ndns);
113ssize_t nd_namespace_store(struct device *dev,
114 struct nd_namespace_common **_ndns, const char *buf,
115 size_t len);
Dan Williams03dca342016-05-21 12:22:41 -0700116struct nd_pfn *to_nd_pfn_safe(struct device *dev);
Dan Williamsb94d5232015-05-19 22:54:31 -0400117#endif /* __ND_CORE_H__ */