1/*-
2 * Copyright (c) 2017 The FreeBSD Foundation
3 * All rights reserved.
4 * Copyright (c) 2018, 2019 Intel Corporation
5 *
6 * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
7 * under sponsorship from the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33#ifndef __DEV_NVDIMM_VAR_H__
34#define	__DEV_NVDIMM_VAR_H__
35
36#define NVDIMM_INDEX_BLOCK_SIGNATURE "NAMESPACE_INDEX"
37
38struct nvdimm_label_index {
39	char		signature[16];
40	uint8_t		flags[3];
41	uint8_t		label_size;
42	uint32_t	seq;
43	uint64_t	this_offset;
44	uint64_t	this_size;
45	uint64_t	other_offset;
46	uint64_t	label_offset;
47	uint32_t	slot_cnt;
48	uint16_t	rev_major;
49	uint16_t	rev_minor;
50	uint64_t	checksum;
51	uint8_t		free[0];
52};
53
54struct nvdimm_label {
55	struct uuid	uuid;
56	char		name[64];
57	uint32_t	flags;
58	uint16_t	nlabel;
59	uint16_t	position;
60	uint64_t	set_cookie;
61	uint64_t	lba_size;
62	uint64_t	dimm_phys_addr;
63	uint64_t	raw_size;
64	uint32_t	slot;
65	uint8_t		alignment;
66	uint8_t		reserved[3];
67	struct uuid	type_guid;
68	struct uuid	address_abstraction_guid;
69	uint8_t		reserved1[88];
70	uint64_t	checksum;
71};
72
73struct nvdimm_label_entry {
74	SLIST_ENTRY(nvdimm_label_entry) link;
75	struct nvdimm_label	label;
76};
77
78_Static_assert(sizeof(struct nvdimm_label_index) == 72, "Incorrect layout");
79_Static_assert(sizeof(struct nvdimm_label) == 256, "Incorrect layout");
80
81typedef uint32_t nfit_handle_t;
82
83enum nvdimm_root_ivar {
84	NVDIMM_ROOT_IVAR_ACPI_HANDLE,
85	NVDIMM_ROOT_IVAR_DEVICE_HANDLE,
86	NVDIMM_ROOT_IVAR_MAX,
87};
88__BUS_ACCESSOR(nvdimm_root, acpi_handle, NVDIMM_ROOT, ACPI_HANDLE, ACPI_HANDLE)
89__BUS_ACCESSOR(nvdimm_root, device_handle, NVDIMM_ROOT, DEVICE_HANDLE,
90    nfit_handle_t)
91
92struct nvdimm_root_dev {
93	SLIST_HEAD(, SPA_mapping) spas;
94};
95
96struct nvdimm_dev {
97	device_t	nv_dev;
98	nfit_handle_t	nv_handle;
99	uint64_t	**nv_flush_addr;
100	char		*nv_flags_str;
101	int		nv_flush_addr_cnt;
102	uint32_t	label_area_size;
103	uint32_t	max_label_xfer;
104	struct nvdimm_label_index *label_index;
105	SLIST_HEAD(, nvdimm_label_entry) labels;
106};
107
108enum SPA_mapping_type {
109	SPA_TYPE_VOLATILE_MEMORY	= 0,
110	SPA_TYPE_PERSISTENT_MEMORY	= 1,
111	SPA_TYPE_CONTROL_REGION		= 2,
112	SPA_TYPE_DATA_REGION		= 3,
113	SPA_TYPE_VOLATILE_VIRTUAL_DISK	= 4,
114	SPA_TYPE_VOLATILE_VIRTUAL_CD	= 5,
115	SPA_TYPE_PERSISTENT_VIRTUAL_DISK= 6,
116	SPA_TYPE_PERSISTENT_VIRTUAL_CD	= 7,
117	SPA_TYPE_UNKNOWN		= 127,
118};
119
120struct nvdimm_spa_dev {
121	int			spa_domain;
122	uint64_t		spa_phys_base;
123	uint64_t		spa_len;
124	uint64_t		spa_efi_mem_flags;
125	void			*spa_kva;
126	struct vm_object	*spa_obj;
127	struct cdev		*spa_dev;
128	struct g_geom		*spa_g;
129};
130
131struct g_spa {
132	struct nvdimm_spa_dev	*dev;
133	struct g_provider	*spa_p;
134	struct bio_queue_head	spa_g_queue;
135	struct mtx		spa_g_mtx;
136	struct mtx		spa_g_stat_mtx;
137	struct devstat		*spa_g_devstat;
138	struct proc		*spa_g_proc;
139	bool			spa_g_proc_run;
140	bool			spa_g_proc_exiting;
141};
142
143struct nvdimm_namespace {
144	SLIST_ENTRY(nvdimm_namespace) link;
145	struct SPA_mapping	*spa;
146	struct nvdimm_spa_dev	dev;
147};
148
149struct SPA_mapping {
150	SLIST_ENTRY(SPA_mapping) link;
151	enum SPA_mapping_type	spa_type;
152	int			spa_nfit_idx;
153	struct nvdimm_spa_dev	dev;
154	SLIST_HEAD(, nvdimm_namespace) namespaces;
155};
156
157MALLOC_DECLARE(M_NVDIMM);
158
159void acpi_nfit_get_dimm_ids(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t **listp,
160    int *countp);
161void acpi_nfit_get_spa_range(ACPI_TABLE_NFIT *nfitbl, uint16_t range_index,
162    ACPI_NFIT_SYSTEM_ADDRESS **spa);
163void acpi_nfit_get_spa_ranges(ACPI_TABLE_NFIT *nfitbl,
164    ACPI_NFIT_SYSTEM_ADDRESS ***listp, int *countp);
165void acpi_nfit_get_region_mappings_by_spa_range(ACPI_TABLE_NFIT *nfitbl,
166    uint16_t spa_range_index, ACPI_NFIT_MEMORY_MAP ***listp, int *countp);
167void acpi_nfit_get_control_region(ACPI_TABLE_NFIT *nfitbl,
168    uint16_t control_region_index, ACPI_NFIT_CONTROL_REGION **out);
169void acpi_nfit_get_flush_addrs(ACPI_TABLE_NFIT *nfitbl, nfit_handle_t dimm,
170    uint64_t ***listp, int *countp);
171void acpi_nfit_get_memory_maps_by_dimm(ACPI_TABLE_NFIT *nfitbl,
172    nfit_handle_t dimm, ACPI_NFIT_MEMORY_MAP ***listp, int *countp);
173enum SPA_mapping_type nvdimm_spa_type_from_uuid(struct uuid *);
174struct nvdimm_dev *nvdimm_find_by_handle(nfit_handle_t nv_handle);
175int nvdimm_spa_init(struct SPA_mapping *spa, ACPI_NFIT_SYSTEM_ADDRESS *nfitaddr,
176    enum SPA_mapping_type spa_type);
177void nvdimm_spa_fini(struct SPA_mapping *spa);
178int nvdimm_spa_dev_init(struct nvdimm_spa_dev *dev, const char *name);
179void nvdimm_spa_dev_fini(struct nvdimm_spa_dev *dev);
180int nvdimm_create_namespaces(struct SPA_mapping *spa, ACPI_TABLE_NFIT *nfitbl);
181void nvdimm_destroy_namespaces(struct SPA_mapping *spa);
182
183#endif		/* __DEV_NVDIMM_VAR_H__ */
184