2 * Copyright (c) 2014-2016, Intel Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU Lesser General Public License,
6 * version 2.1, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT ANY
9 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
16 #include <linux/types.h>
23 #define ND_SMART_HEALTH_VALID (1 << 0)
24 #define ND_SMART_SPARES_VALID (1 << 1)
25 #define ND_SMART_USED_VALID (1 << 2)
26 #define ND_SMART_TEMP_VALID (1 << 3)
27 #define ND_SMART_CTEMP_VALID (1 << 4)
28 #define ND_SMART_ALARM_VALID (1 << 9)
29 #define ND_SMART_SHUTDOWN_VALID (1 << 10)
30 #define ND_SMART_VENDOR_VALID (1 << 11)
31 #define ND_SMART_SPARE_TRIP (1 << 0)
32 #define ND_SMART_TEMP_TRIP (1 << 1)
33 #define ND_SMART_CTEMP_TRIP (1 << 2)
34 #define ND_SMART_NON_CRITICAL_HEALTH (1 << 0)
35 #define ND_SMART_CRITICAL_HEALTH (1 << 1)
36 #define ND_SMART_FATAL_HEALTH (1 << 2)
38 struct nd_smart_payload {
46 __u16 ctrl_temperature;
53 struct nd_cmd_smart_threshold {
58 struct nd_smart_threshold_payload {
66 struct nd_cmd_dimm_flags {
71 struct nd_cmd_get_config_size {
77 struct nd_cmd_get_config_data_hdr {
84 struct nd_cmd_set_config_hdr {
90 struct nd_cmd_vendor_hdr {
96 struct nd_cmd_vendor_tail {
102 struct nd_cmd_ars_cap {
107 __u32 clear_err_unit;
111 struct nd_cmd_ars_start {
121 struct nd_cmd_ars_status {
126 __u64 restart_address;
127 __u64 restart_length;
131 struct nd_ars_record {
136 } __packed records[0];
139 struct nd_cmd_clear_error {
148 ND_CMD_IMPLEMENTED = 0,
152 ND_CMD_ARS_START = 2,
153 ND_CMD_ARS_STATUS = 3,
154 ND_CMD_CLEAR_ERROR = 4,
156 /* per-dimm commands */
158 ND_CMD_SMART_THRESHOLD = 2,
159 ND_CMD_DIMM_FLAGS = 3,
160 ND_CMD_GET_CONFIG_SIZE = 4,
161 ND_CMD_GET_CONFIG_DATA = 5,
162 ND_CMD_SET_CONFIG_DATA = 6,
163 ND_CMD_VENDOR_EFFECT_LOG_SIZE = 7,
164 ND_CMD_VENDOR_EFFECT_LOG = 8,
171 ND_ARS_PERSISTENT = 2,
174 static inline const char *nvdimm_bus_cmd_name(unsigned cmd)
176 static const char * const names[] = {
177 [ND_CMD_ARS_CAP] = "ars_cap",
178 [ND_CMD_ARS_START] = "ars_start",
179 [ND_CMD_ARS_STATUS] = "ars_status",
180 [ND_CMD_CLEAR_ERROR] = "clear_error",
183 if (cmd < ARRAY_SIZE(names) && names[cmd])
188 static inline const char *nvdimm_cmd_name(unsigned cmd)
190 static const char * const names[] = {
191 [ND_CMD_SMART] = "smart",
192 [ND_CMD_SMART_THRESHOLD] = "smart_thresh",
193 [ND_CMD_DIMM_FLAGS] = "flags",
194 [ND_CMD_GET_CONFIG_SIZE] = "get_size",
195 [ND_CMD_GET_CONFIG_DATA] = "get_data",
196 [ND_CMD_SET_CONFIG_DATA] = "set_data",
197 [ND_CMD_VENDOR_EFFECT_LOG_SIZE] = "effect_size",
198 [ND_CMD_VENDOR_EFFECT_LOG] = "effect_log",
199 [ND_CMD_VENDOR] = "vendor",
200 [ND_CMD_CALL] = "cmd_call",
203 if (cmd < ARRAY_SIZE(names) && names[cmd])
210 #define ND_IOCTL_SMART _IOWR(ND_IOCTL, ND_CMD_SMART,\
213 #define ND_IOCTL_SMART_THRESHOLD _IOWR(ND_IOCTL, ND_CMD_SMART_THRESHOLD,\
214 struct nd_cmd_smart_threshold)
216 #define ND_IOCTL_DIMM_FLAGS _IOWR(ND_IOCTL, ND_CMD_DIMM_FLAGS,\
217 struct nd_cmd_dimm_flags)
219 #define ND_IOCTL_GET_CONFIG_SIZE _IOWR(ND_IOCTL, ND_CMD_GET_CONFIG_SIZE,\
220 struct nd_cmd_get_config_size)
222 #define ND_IOCTL_GET_CONFIG_DATA _IOWR(ND_IOCTL, ND_CMD_GET_CONFIG_DATA,\
223 struct nd_cmd_get_config_data_hdr)
225 #define ND_IOCTL_SET_CONFIG_DATA _IOWR(ND_IOCTL, ND_CMD_SET_CONFIG_DATA,\
226 struct nd_cmd_set_config_hdr)
228 #define ND_IOCTL_VENDOR _IOWR(ND_IOCTL, ND_CMD_VENDOR,\
229 struct nd_cmd_vendor_hdr)
231 #define ND_IOCTL_ARS_CAP _IOWR(ND_IOCTL, ND_CMD_ARS_CAP,\
232 struct nd_cmd_ars_cap)
234 #define ND_IOCTL_ARS_START _IOWR(ND_IOCTL, ND_CMD_ARS_START,\
235 struct nd_cmd_ars_start)
237 #define ND_IOCTL_ARS_STATUS _IOWR(ND_IOCTL, ND_CMD_ARS_STATUS,\
238 struct nd_cmd_ars_status)
240 #define ND_IOCTL_CLEAR_ERROR _IOWR(ND_IOCTL, ND_CMD_CLEAR_ERROR,\
241 struct nd_cmd_clear_error)
243 #define ND_DEVICE_DIMM 1 /* nd_dimm: container for "config data" */
244 #define ND_DEVICE_REGION_PMEM 2 /* nd_region: (parent of PMEM namespaces) */
245 #define ND_DEVICE_REGION_BLK 3 /* nd_region: (parent of BLK namespaces) */
246 #define ND_DEVICE_NAMESPACE_IO 4 /* legacy persistent memory */
247 #define ND_DEVICE_NAMESPACE_PMEM 5 /* PMEM namespace (may alias with BLK) */
248 #define ND_DEVICE_NAMESPACE_BLK 6 /* BLK namespace (may alias with PMEM) */
249 #define ND_DEVICE_DAX_PMEM 7 /* Device DAX interface to pmem */
251 enum nd_driver_flags {
252 ND_DRIVER_DIMM = 1 << ND_DEVICE_DIMM,
253 ND_DRIVER_REGION_PMEM = 1 << ND_DEVICE_REGION_PMEM,
254 ND_DRIVER_REGION_BLK = 1 << ND_DEVICE_REGION_BLK,
255 ND_DRIVER_NAMESPACE_IO = 1 << ND_DEVICE_NAMESPACE_IO,
256 ND_DRIVER_NAMESPACE_PMEM = 1 << ND_DEVICE_NAMESPACE_PMEM,
257 ND_DRIVER_NAMESPACE_BLK = 1 << ND_DEVICE_NAMESPACE_BLK,
258 ND_DRIVER_DAX_PMEM = 1 << ND_DEVICE_DAX_PMEM,
262 ND_MIN_NAMESPACE_SIZE = 0x00400000,
266 ARS_STATUS_MASK = 0x0000FFFF,
267 ARS_EXT_STATUS_SHIFT = 16,
273 * is a wrapper to a quasi pass thru interface for invoking firmware
274 * associated with nvdimms.
278 * nd_family corresponds to the firmware (e.g. DSM) interface.
280 * nd_command are the function index advertised by the firmware.
282 * nd_size_in is the size of the input parameters being passed to firmware
286 * nd_fw_size is the size of the data firmware wants to return for
287 * the call. If nd_fw_size is greater than size of nd_size_out, only
288 * the first nd_size_out bytes are returned.
292 __u64 nd_family; /* family of commands */
294 __u32 nd_size_in; /* INPUT: size of input args */
295 __u32 nd_size_out; /* INPUT: size of payload */
296 __u32 nd_reserved2[9]; /* reserved must be zero */
297 __u32 nd_fw_size; /* OUTPUT: size fw wants to return */
298 unsigned char nd_payload[]; /* Contents of call */
301 /* These NVDIMM families represent pre-standardization command sets */
302 #define NVDIMM_FAMILY_INTEL 0
303 #define NVDIMM_FAMILY_HPE1 1
304 #define NVDIMM_FAMILY_HPE2 2
305 #define NVDIMM_FAMILY_MSFT 3
307 #define ND_IOCTL_CALL _IOWR(ND_IOCTL, ND_CMD_CALL,\
310 #endif /* __NDCTL_H__ */