227 lines
6.4 KiB
C
227 lines
6.4 KiB
C
|
/* SPDX-License-Identifier: GPL-2.0-only */
|
||
|
|
/*
|
||
|
|
* Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
|
||
|
|
*/
|
||
|
|
#ifndef __LABEL_H__
|
||
|
|
#define __LABEL_H__
|
||
|
|
|
||
|
|
#include <linux/ndctl.h>
|
||
|
|
#include <linux/sizes.h>
|
||
|
|
#include <linux/uuid.h>
|
||
|
|
#include <linux/io.h>
|
||
|
|
|
||
|
|
enum {
|
||
|
|
NSINDEX_SIG_LEN = 16,
|
||
|
|
NSINDEX_ALIGN = 256,
|
||
|
|
NSINDEX_SEQ_MASK = 0x3,
|
||
|
|
NSLABEL_UUID_LEN = 16,
|
||
|
|
NSLABEL_NAME_LEN = 64,
|
||
|
|
NSLABEL_FLAG_ROLABEL = 0x1, /* read-only label */
|
||
|
|
NSLABEL_FLAG_LOCAL = 0x2, /* DIMM-local namespace */
|
||
|
|
NSLABEL_FLAG_BTT = 0x4, /* namespace contains a BTT */
|
||
|
|
NSLABEL_FLAG_UPDATING = 0x8, /* label being updated */
|
||
|
|
BTT_ALIGN = 4096, /* all btt structures */
|
||
|
|
BTTINFO_SIG_LEN = 16,
|
||
|
|
BTTINFO_UUID_LEN = 16,
|
||
|
|
BTTINFO_FLAG_ERROR = 0x1, /* error state (read-only) */
|
||
|
|
BTTINFO_MAJOR_VERSION = 1,
|
||
|
|
ND_LABEL_MIN_SIZE = 256 * 4, /* see sizeof_namespace_index() */
|
||
|
|
ND_LABEL_ID_SIZE = 50,
|
||
|
|
ND_NSINDEX_INIT = 0x1,
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct nd_namespace_index - label set superblock
|
||
|
|
* @sig: NAMESPACE_INDEX\0
|
||
|
|
* @flags: placeholder
|
||
|
|
* @labelsize: log2 size (v1 labels 128 bytes v2 labels 256 bytes)
|
||
|
|
* @seq: sequence number for this index
|
||
|
|
* @myoff: offset of this index in label area
|
||
|
|
* @mysize: size of this index struct
|
||
|
|
* @otheroff: offset of other index
|
||
|
|
* @labeloff: offset of first label slot
|
||
|
|
* @nslot: total number of label slots
|
||
|
|
* @major: label area major version
|
||
|
|
* @minor: label area minor version
|
||
|
|
* @checksum: fletcher64 of all fields
|
||
|
|
* @free: bitmap, nlabel bits
|
||
|
|
*
|
||
|
|
* The size of free[] is rounded up so the total struct size is a
|
||
|
|
* multiple of NSINDEX_ALIGN bytes. Any bits this allocates beyond
|
||
|
|
* nlabel bits must be zero.
|
||
|
|
*/
|
||
|
|
struct nd_namespace_index {
|
||
|
|
u8 sig[NSINDEX_SIG_LEN];
|
||
|
|
u8 flags[3];
|
||
|
|
u8 labelsize;
|
||
|
|
__le32 seq;
|
||
|
|
__le64 myoff;
|
||
|
|
__le64 mysize;
|
||
|
|
__le64 otheroff;
|
||
|
|
__le64 labeloff;
|
||
|
|
__le32 nslot;
|
||
|
|
__le16 major;
|
||
|
|
__le16 minor;
|
||
|
|
__le64 checksum;
|
||
|
|
u8 free[];
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct cxl_region_label - CXL 2.0 Table 211
|
||
|
|
* @type: uuid identifying this label format (region)
|
||
|
|
* @uuid: uuid for the region this label describes
|
||
|
|
* @flags: NSLABEL_FLAG_UPDATING (all other flags reserved)
|
||
|
|
* @nlabel: 1 per interleave-way in the region
|
||
|
|
* @position: this label's position in the set
|
||
|
|
* @dpa: start address in device-local capacity for this label
|
||
|
|
* @rawsize: size of this label's contribution to region
|
||
|
|
* @hpa: mandatory system physical address to map this region
|
||
|
|
* @slot: slot id of this label in label area
|
||
|
|
* @ig: interleave granularity (1 << @ig) * 256 bytes
|
||
|
|
* @align: alignment in SZ_256M blocks
|
||
|
|
* @reserved: reserved
|
||
|
|
* @checksum: fletcher64 sum of this label
|
||
|
|
*/
|
||
|
|
struct cxl_region_label {
|
||
|
|
u8 type[NSLABEL_UUID_LEN];
|
||
|
|
u8 uuid[NSLABEL_UUID_LEN];
|
||
|
|
__le32 flags;
|
||
|
|
__le16 nlabel;
|
||
|
|
__le16 position;
|
||
|
|
__le64 dpa;
|
||
|
|
__le64 rawsize;
|
||
|
|
__le64 hpa;
|
||
|
|
__le32 slot;
|
||
|
|
__le32 ig;
|
||
|
|
__le32 align;
|
||
|
|
u8 reserved[0xac];
|
||
|
|
__le64 checksum;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct nvdimm_efi_label - namespace superblock
|
||
|
|
* @uuid: UUID per RFC 4122
|
||
|
|
* @name: optional name (NULL-terminated)
|
||
|
|
* @flags: see NSLABEL_FLAG_*
|
||
|
|
* @nlabel: num labels to describe this ns
|
||
|
|
* @position: labels position in set
|
||
|
|
* @isetcookie: interleave set cookie
|
||
|
|
* @lbasize: LBA size in bytes or 0 for pmem
|
||
|
|
* @dpa: DPA of NVM range on this DIMM
|
||
|
|
* @rawsize: size of namespace
|
||
|
|
* @slot: slot of this label in label area
|
||
|
|
* @align: physical address alignment of the namespace
|
||
|
|
* @reserved: reserved
|
||
|
|
* @type_guid: copy of struct acpi_nfit_system_address.range_guid
|
||
|
|
* @abstraction_guid: personality id (btt, btt2, fsdax, devdax....)
|
||
|
|
* @reserved2: reserved
|
||
|
|
* @checksum: fletcher64 sum of this object
|
||
|
|
*/
|
||
|
|
struct nvdimm_efi_label {
|
||
|
|
u8 uuid[NSLABEL_UUID_LEN];
|
||
|
|
u8 name[NSLABEL_NAME_LEN];
|
||
|
|
__le32 flags;
|
||
|
|
__le16 nlabel;
|
||
|
|
__le16 position;
|
||
|
|
__le64 isetcookie;
|
||
|
|
__le64 lbasize;
|
||
|
|
__le64 dpa;
|
||
|
|
__le64 rawsize;
|
||
|
|
__le32 slot;
|
||
|
|
/*
|
||
|
|
* Accessing fields past this point should be gated by a
|
||
|
|
* efi_namespace_label_has() check.
|
||
|
|
*/
|
||
|
|
u8 align;
|
||
|
|
u8 reserved[3];
|
||
|
|
guid_t type_guid;
|
||
|
|
guid_t abstraction_guid;
|
||
|
|
u8 reserved2[88];
|
||
|
|
__le64 checksum;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct nvdimm_cxl_label - CXL 2.0 Table 212
|
||
|
|
* @type: uuid identifying this label format (namespace)
|
||
|
|
* @uuid: uuid for the namespace this label describes
|
||
|
|
* @name: friendly name for the namespace
|
||
|
|
* @flags: NSLABEL_FLAG_UPDATING (all other flags reserved)
|
||
|
|
* @nrange: discontiguous namespace support
|
||
|
|
* @position: this label's position in the set
|
||
|
|
* @dpa: start address in device-local capacity for this label
|
||
|
|
* @rawsize: size of this label's contribution to namespace
|
||
|
|
* @slot: slot id of this label in label area
|
||
|
|
* @align: alignment in SZ_256M blocks
|
||
|
|
* @region_uuid: host interleave set identifier
|
||
|
|
* @abstraction_uuid: personality driver for this namespace
|
||
|
|
* @lbasize: address geometry for disk-like personalities
|
||
|
|
* @reserved: reserved
|
||
|
|
* @checksum: fletcher64 sum of this label
|
||
|
|
*/
|
||
|
|
struct nvdimm_cxl_label {
|
||
|
|
u8 type[NSLABEL_UUID_LEN];
|
||
|
|
u8 uuid[NSLABEL_UUID_LEN];
|
||
|
|
u8 name[NSLABEL_NAME_LEN];
|
||
|
|
__le32 flags;
|
||
|
|
__le16 nrange;
|
||
|
|
__le16 position;
|
||
|
|
__le64 dpa;
|
||
|
|
__le64 rawsize;
|
||
|
|
__le32 slot;
|
||
|
|
__le32 align;
|
||
|
|
u8 region_uuid[16];
|
||
|
|
u8 abstraction_uuid[16];
|
||
|
|
__le16 lbasize;
|
||
|
|
u8 reserved[0x56];
|
||
|
|
__le64 checksum;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct nd_namespace_label {
|
||
|
|
union {
|
||
|
|
struct nvdimm_cxl_label cxl;
|
||
|
|
struct nvdimm_efi_label efi;
|
||
|
|
};
|
||
|
|
};
|
||
|
|
|
||
|
|
#define NVDIMM_BTT_GUID "8aed63a2-29a2-4c66-8b12-f05d15d3922a"
|
||
|
|
#define NVDIMM_BTT2_GUID "18633bfc-1735-4217-8ac9-17239282d3f8"
|
||
|
|
#define NVDIMM_PFN_GUID "266400ba-fb9f-4677-bcb0-968f11d0d225"
|
||
|
|
#define NVDIMM_DAX_GUID "97a86d9c-3cdd-4eda-986f-5068b4f80088"
|
||
|
|
|
||
|
|
#define CXL_REGION_UUID "529d7c61-da07-47c4-a93f-ecdf2c06f444"
|
||
|
|
#define CXL_NAMESPACE_UUID "68bb2c0a-5a77-4937-9f85-3caf41a0f93c"
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct nd_label_id - identifier string for dpa allocation
|
||
|
|
* @id: "pmem-<namespace uuid>"
|
||
|
|
*/
|
||
|
|
struct nd_label_id {
|
||
|
|
char id[ND_LABEL_ID_SIZE];
|
||
|
|
};
|
||
|
|
|
||
|
|
/*
|
||
|
|
* If the 'best' index is invalid, so is the 'next' index. Otherwise,
|
||
|
|
* the next index is MOD(index+1, 2)
|
||
|
|
*/
|
||
|
|
static inline int nd_label_next_nsindex(int index)
|
||
|
|
{
|
||
|
|
if (index < 0)
|
||
|
|
return -1;
|
||
|
|
|
||
|
|
return (index + 1) % 2;
|
||
|
|
}
|
||
|
|
|
||
|
|
struct nvdimm_drvdata;
|
||
|
|
int nd_label_data_init(struct nvdimm_drvdata *ndd);
|
||
|
|
size_t sizeof_namespace_index(struct nvdimm_drvdata *ndd);
|
||
|
|
int nd_label_active_count(struct nvdimm_drvdata *ndd);
|
||
|
|
struct nd_namespace_label *nd_label_active(struct nvdimm_drvdata *ndd, int n);
|
||
|
|
u32 nd_label_alloc_slot(struct nvdimm_drvdata *ndd);
|
||
|
|
bool nd_label_free_slot(struct nvdimm_drvdata *ndd, u32 slot);
|
||
|
|
u32 nd_label_nfree(struct nvdimm_drvdata *ndd);
|
||
|
|
struct nd_region;
|
||
|
|
struct nd_namespace_pmem;
|
||
|
|
int nd_pmem_namespace_label_update(struct nd_region *nd_region,
|
||
|
|
struct nd_namespace_pmem *nspm, resource_size_t size);
|
||
|
|
#endif /* __LABEL_H__ */
|