blob: b519e137b9b7d98ab44aa1409510ad35e841c10f [file] [log] [blame]
Dan Williamsb94d5232015-05-19 22:54:31 -04001/*
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__
Ross Zwisler047fc8a2015-06-25 04:21:02 -040017#include <linux/kernel.h>
Dan Williams62232e452015-06-08 14:27:06 -040018#include <linux/sizes.h>
19#include <linux/types.h>
Dan Williamse6dfb2d2015-04-25 03:56:17 -040020
21enum {
22 /* when a dimm supports both PMEM and BLK access a label is required */
23 NDD_ALIASING = 1 << 0,
Dan Williams58138822015-06-23 20:08:34 -040024 /* unarmed memory devices may not persist writes */
25 NDD_UNARMED = 1 << 1,
Dan Williams62232e452015-06-08 14:27:06 -040026
27 /* need to set a limit somewhere, but yes, this is likely overkill */
28 ND_IOCTL_MAX_BUFLEN = SZ_4M,
Dan Williams4577b062016-02-17 13:08:58 -080029 ND_CMD_MAX_ELEM = 5,
Jerry Hoemann40abf9b2016-04-11 15:02:28 -070030 ND_CMD_MAX_ENVELOPE = 256,
Dan Williams1f7df6f2015-06-09 20:13:14 -040031 ND_MAX_MAPPINGS = 32,
Dan Williams1b40e092015-05-01 13:34:01 -040032
Dan Williams004f1af2015-08-24 19:20:23 -040033 /* region flag indicating to direct-map persistent memory by default */
34 ND_REGION_PAGEMAP = 0,
35
Dan Williams1b40e092015-05-01 13:34:01 -040036 /* mark newly adjusted resources as requiring a label update */
37 DPA_RESOURCE_ADJUSTED = 1 << 0,
Dan Williamse6dfb2d2015-04-25 03:56:17 -040038};
39
Dan Williams45def222015-04-26 19:26:48 -040040extern struct attribute_group nvdimm_bus_attribute_group;
Dan Williams62232e452015-06-08 14:27:06 -040041extern struct attribute_group nvdimm_attribute_group;
Dan Williams4d88a972015-05-31 14:41:48 -040042extern struct attribute_group nd_device_attribute_group;
Toshi Kani74ae66c2015-06-19 12:18:34 -060043extern struct attribute_group nd_numa_attribute_group;
Dan Williams1f7df6f2015-06-09 20:13:14 -040044extern struct attribute_group nd_region_attribute_group;
45extern struct attribute_group nd_mapping_attribute_group;
Dan Williams45def222015-04-26 19:26:48 -040046
Dan Williamsb94d5232015-05-19 22:54:31 -040047struct nvdimm;
48struct nvdimm_bus_descriptor;
49typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
50 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
Dan Williamsaef25332016-02-12 17:01:11 -080051 unsigned int buf_len, int *cmd_rc);
Dan Williamsb94d5232015-05-19 22:54:31 -040052
Dan Williamsbf9bccc2015-06-17 17:14:46 -040053struct nd_namespace_label;
54struct nvdimm_drvdata;
Dan Williamse5ae3b22016-06-07 17:00:04 -070055
Dan Williams1f7df6f2015-06-09 20:13:14 -040056struct nd_mapping {
57 struct nvdimm *nvdimm;
Dan Williamsbf9bccc2015-06-17 17:14:46 -040058 struct nd_namespace_label **labels;
Dan Williams1f7df6f2015-06-09 20:13:14 -040059 u64 start;
60 u64 size;
Dan Williamsbf9bccc2015-06-17 17:14:46 -040061 /*
62 * @ndd is for private use at region enable / disable time for
63 * get_ndd() + put_ndd(), all other nd_mapping to ndd
64 * conversions use to_ndd() which respects enabled state of the
65 * nvdimm.
66 */
67 struct nvdimm_drvdata *ndd;
Dan Williams1f7df6f2015-06-09 20:13:14 -040068};
69
Dan Williamsb94d5232015-05-19 22:54:31 -040070struct nvdimm_bus_descriptor {
Dan Williams45def222015-04-26 19:26:48 -040071 const struct attribute_group **attr_groups;
Dan Williamse3654ec2016-04-28 16:17:07 -070072 unsigned long cmd_mask;
Dan Williamsbc9775d2016-07-21 20:03:19 -070073 struct module *module;
Dan Williamsb94d5232015-05-19 22:54:31 -040074 char *provider_name;
75 ndctl_fn ndctl;
Dan Williams7ae0fa432016-02-19 12:16:34 -080076 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
Dan Williams87bf5722016-02-22 21:50:31 -080077 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
78 struct nvdimm *nvdimm, unsigned int cmd);
Dan Williamsb94d5232015-05-19 22:54:31 -040079};
80
Dan Williams62232e452015-06-08 14:27:06 -040081struct nd_cmd_desc {
82 int in_num;
83 int out_num;
84 u32 in_sizes[ND_CMD_MAX_ELEM];
85 int out_sizes[ND_CMD_MAX_ELEM];
86};
87
Dan Williamseaf96152015-05-01 13:11:27 -040088struct nd_interleave_set {
89 u64 cookie;
90};
91
Dan Williams1f7df6f2015-06-09 20:13:14 -040092struct nd_region_desc {
93 struct resource *res;
94 struct nd_mapping *nd_mapping;
95 u16 num_mappings;
96 const struct attribute_group **attr_groups;
Dan Williamseaf96152015-05-01 13:11:27 -040097 struct nd_interleave_set *nd_set;
Dan Williams1f7df6f2015-06-09 20:13:14 -040098 void *provider_data;
Vishal Verma5212e112015-06-25 04:20:32 -040099 int num_lanes;
Toshi Kani41d7a6d2015-06-19 12:18:33 -0600100 int numa_node;
Dan Williams004f1af2015-08-24 19:20:23 -0400101 unsigned long flags;
Dan Williams1f7df6f2015-06-09 20:13:14 -0400102};
103
Dan Williams29b9aa02016-06-06 17:42:38 -0700104struct device;
105void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
106 size_t size, unsigned long flags);
107static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
108 resource_size_t offset, size_t size)
109{
110 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
111}
112
Dan Williams62232e452015-06-08 14:27:06 -0400113struct nvdimm_bus;
Dan Williams3d880022015-05-31 15:02:11 -0400114struct module;
Ross Zwisler047fc8a2015-06-25 04:21:02 -0400115struct device;
116struct nd_blk_region;
117struct nd_blk_region_desc {
118 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
Ross Zwisler047fc8a2015-06-25 04:21:02 -0400119 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
120 void *iobuf, u64 len, int rw);
121 struct nd_region_desc ndr_desc;
122};
123
124static inline struct nd_blk_region_desc *to_blk_region_desc(
125 struct nd_region_desc *ndr_desc)
126{
127 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
128
129}
130
Vishal Verma0caeef62015-12-24 19:21:43 -0700131int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
Dan Williamsbc9775d2016-07-21 20:03:19 -0700132struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
133 struct nvdimm_bus_descriptor *nfit_desc);
Dan Williamsb94d5232015-05-19 22:54:31 -0400134void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
Dan Williams45def222015-04-26 19:26:48 -0400135struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400136struct nvdimm *to_nvdimm(struct device *dev);
Dan Williams1f7df6f2015-06-09 20:13:14 -0400137struct nd_region *to_nd_region(struct device *dev);
Ross Zwisler047fc8a2015-06-25 04:21:02 -0400138struct nd_blk_region *to_nd_blk_region(struct device *dev);
Dan Williams45def222015-04-26 19:26:48 -0400139struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
Vishal Verma37b137f2016-07-23 21:51:42 -0700140struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400141const char *nvdimm_name(struct nvdimm *nvdimm);
Dan Williamse3654ec2016-04-28 16:17:07 -0700142unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400143void *nvdimm_provider_data(struct nvdimm *nvdimm);
144struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
Dan Williams62232e452015-06-08 14:27:06 -0400145 const struct attribute_group **groups, unsigned long flags,
Dan Williamse5ae3b22016-06-07 17:00:04 -0700146 unsigned long cmd_mask, int num_flush,
147 struct resource *flush_wpq);
Dan Williams62232e452015-06-08 14:27:06 -0400148const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
149const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
150u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
151 const struct nd_cmd_desc *desc, int idx, void *buf);
152u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
153 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
154 const u32 *out_field);
Dan Williams4d88a972015-05-31 14:41:48 -0400155int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
Dan Williams1f7df6f2015-06-09 20:13:14 -0400156struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
157 struct nd_region_desc *ndr_desc);
158struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
159 struct nd_region_desc *ndr_desc);
160struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
161 struct nd_region_desc *ndr_desc);
Ross Zwisler047fc8a2015-06-25 04:21:02 -0400162void *nd_region_provider_data(struct nd_region *nd_region);
163void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
164void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
165struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
166unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
167void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
Dan Williamseaf96152015-05-01 13:11:27 -0400168u64 nd_fletcher64(void *addr, size_t len, bool le);
Dan Williamsf284a4f2016-07-07 19:44:50 -0700169void nvdimm_flush(struct nd_region *nd_region);
170int nvdimm_has_flush(struct nd_region *nd_region);
Dan Williamsb94d5232015-05-19 22:54:31 -0400171#endif /* __LIBNVDIMM_H__ */