2015-06-01 02:41:48 +08:00
|
|
|
/*
|
|
|
|
|
* Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of version 2 of the GNU General Public License as
|
|
|
|
|
* published by the Free Software Foundation.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful, but
|
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* General Public License for more details.
|
|
|
|
|
*/
|
|
|
|
|
#ifndef __ND_H__
|
|
|
|
|
#define __ND_H__
|
libnvdimm, nfit: regions (block-data-window, persistent memory, volatile memory)
A "region" device represents the maximum capacity of a BLK range (mmio
block-data-window(s)), or a PMEM range (DAX-capable persistent memory or
volatile memory), without regard for aliasing. Aliasing, in the
dimm-local address space (DPA), is resolved by metadata on a dimm to
designate which exclusive interface will access the aliased DPA ranges.
Support for the per-dimm metadata/label arrvies is in a subsequent
patch.
The name format of "region" devices is "regionN" where, like dimms, N is
a global ida index assigned at discovery time. This id is not reliable
across reboots nor in the presence of hotplug. Look to attributes of
the region or static id-data of the sub-namespace to generate a
persistent name. However, if the platform configuration does not change
it is reasonable to expect the same region id to be assigned at the next
boot.
"region"s have 2 generic attributes "size", and "mapping"s where:
- size: the BLK accessible capacity or the span of the
system physical address range in the case of PMEM.
- mappingN: a tuple describing a dimm's contribution to the region's
capacity in the format (<nmemX>,<dpa>,<size>). For a PMEM-region
there will be at least one mapping per dimm in the interleave set. For
a BLK-region there is only "mapping0" listing the starting DPA of the
BLK-region and the available DPA capacity of that space (matches "size"
above).
The max number of mappings per "region" is hard coded per the
constraints of sysfs attribute groups. That said the number of mappings
per region should never exceed the maximum number of possible dimms in
the system. If the current number turns out to not be enough then the
"mappings" attribute clarifies how many there are supposed to be. "32
should be enough for anybody...".
Cc: Neil Brown <neilb@suse.de>
Cc: <linux-acpi@vger.kernel.org>
Cc: Greg KH <gregkh@linuxfoundation.org>
Cc: Robert Moore <robert.moore@intel.com>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: Christoph Hellwig <hch@lst.de>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Tested-by: Toshi Kani <toshi.kani@hp.com>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
2015-06-10 08:13:14 +08:00
|
|
|
#include <linux/libnvdimm.h>
|
2015-06-01 02:41:48 +08:00
|
|
|
#include <linux/device.h>
|
|
|
|
|
#include <linux/mutex.h>
|
|
|
|
|
#include <linux/ndctl.h>
|
|
|
|
|
|
|
|
|
|
struct nvdimm_drvdata {
|
|
|
|
|
struct device *dev;
|
|
|
|
|
struct nd_cmd_get_config_size nsarea;
|
|
|
|
|
void *data;
|
|
|
|
|
};
|
|
|
|
|
|
2015-06-01 03:02:11 +08:00
|
|
|
struct nd_region_namespaces {
|
|
|
|
|
int count;
|
|
|
|
|
int active;
|
|
|
|
|
};
|
|
|
|
|
|
libnvdimm, nfit: regions (block-data-window, persistent memory, volatile memory)
A "region" device represents the maximum capacity of a BLK range (mmio
block-data-window(s)), or a PMEM range (DAX-capable persistent memory or
volatile memory), without regard for aliasing. Aliasing, in the
dimm-local address space (DPA), is resolved by metadata on a dimm to
designate which exclusive interface will access the aliased DPA ranges.
Support for the per-dimm metadata/label arrvies is in a subsequent
patch.
The name format of "region" devices is "regionN" where, like dimms, N is
a global ida index assigned at discovery time. This id is not reliable
across reboots nor in the presence of hotplug. Look to attributes of
the region or static id-data of the sub-namespace to generate a
persistent name. However, if the platform configuration does not change
it is reasonable to expect the same region id to be assigned at the next
boot.
"region"s have 2 generic attributes "size", and "mapping"s where:
- size: the BLK accessible capacity or the span of the
system physical address range in the case of PMEM.
- mappingN: a tuple describing a dimm's contribution to the region's
capacity in the format (<nmemX>,<dpa>,<size>). For a PMEM-region
there will be at least one mapping per dimm in the interleave set. For
a BLK-region there is only "mapping0" listing the starting DPA of the
BLK-region and the available DPA capacity of that space (matches "size"
above).
The max number of mappings per "region" is hard coded per the
constraints of sysfs attribute groups. That said the number of mappings
per region should never exceed the maximum number of possible dimms in
the system. If the current number turns out to not be enough then the
"mappings" attribute clarifies how many there are supposed to be. "32
should be enough for anybody...".
Cc: Neil Brown <neilb@suse.de>
Cc: <linux-acpi@vger.kernel.org>
Cc: Greg KH <gregkh@linuxfoundation.org>
Cc: Robert Moore <robert.moore@intel.com>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: Christoph Hellwig <hch@lst.de>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Tested-by: Toshi Kani <toshi.kani@hp.com>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
2015-06-10 08:13:14 +08:00
|
|
|
struct nd_region {
|
|
|
|
|
struct device dev;
|
|
|
|
|
u16 ndr_mappings;
|
|
|
|
|
u64 ndr_size;
|
|
|
|
|
u64 ndr_start;
|
|
|
|
|
int id;
|
|
|
|
|
void *provider_data;
|
|
|
|
|
struct nd_mapping mapping[0];
|
|
|
|
|
};
|
|
|
|
|
|
2015-06-01 02:41:48 +08:00
|
|
|
enum nd_async_mode {
|
|
|
|
|
ND_SYNC,
|
|
|
|
|
ND_ASYNC,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
void nd_device_register(struct device *dev);
|
|
|
|
|
void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
|
|
|
|
|
int __init nvdimm_init(void);
|
2015-06-01 03:02:11 +08:00
|
|
|
int __init nd_region_init(void);
|
2015-06-01 02:41:48 +08:00
|
|
|
void nvdimm_exit(void);
|
2015-06-01 03:02:11 +08:00
|
|
|
void nd_region_exit(void);
|
2015-06-01 02:41:48 +08:00
|
|
|
int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
|
|
|
|
|
int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
|
2015-06-01 03:02:11 +08:00
|
|
|
struct nd_region *to_nd_region(struct device *dev);
|
|
|
|
|
int nd_region_to_nstype(struct nd_region *nd_region);
|
|
|
|
|
int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
|
|
|
|
|
void nvdimm_bus_lock(struct device *dev);
|
|
|
|
|
void nvdimm_bus_unlock(struct device *dev);
|
|
|
|
|
bool is_nvdimm_bus_locked(struct device *dev);
|
2015-06-01 02:41:48 +08:00
|
|
|
#endif /* __ND_H__ */
|