Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 1 | /* |
| 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__ |
Dan Williams | 62232e45 | 2015-06-08 14:27:06 -0400 | [diff] [blame^] | 17 | #include <linux/sizes.h> |
| 18 | #include <linux/types.h> |
Dan Williams | e6dfb2d | 2015-04-25 03:56:17 -0400 | [diff] [blame] | 19 | |
| 20 | enum { |
| 21 | /* when a dimm supports both PMEM and BLK access a label is required */ |
| 22 | NDD_ALIASING = 1 << 0, |
Dan Williams | 62232e45 | 2015-06-08 14:27:06 -0400 | [diff] [blame^] | 23 | |
| 24 | /* need to set a limit somewhere, but yes, this is likely overkill */ |
| 25 | ND_IOCTL_MAX_BUFLEN = SZ_4M, |
| 26 | ND_CMD_MAX_ELEM = 4, |
| 27 | ND_CMD_MAX_ENVELOPE = 16, |
| 28 | ND_CMD_ARS_STATUS_MAX = SZ_4K, |
Dan Williams | e6dfb2d | 2015-04-25 03:56:17 -0400 | [diff] [blame] | 29 | }; |
| 30 | |
Dan Williams | 45def22 | 2015-04-26 19:26:48 -0400 | [diff] [blame] | 31 | extern struct attribute_group nvdimm_bus_attribute_group; |
Dan Williams | 62232e45 | 2015-06-08 14:27:06 -0400 | [diff] [blame^] | 32 | extern struct attribute_group nvdimm_attribute_group; |
Dan Williams | 45def22 | 2015-04-26 19:26:48 -0400 | [diff] [blame] | 33 | |
Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 34 | struct nvdimm; |
| 35 | struct nvdimm_bus_descriptor; |
| 36 | typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, |
| 37 | struct nvdimm *nvdimm, unsigned int cmd, void *buf, |
| 38 | unsigned int buf_len); |
| 39 | |
| 40 | struct nvdimm_bus_descriptor { |
Dan Williams | 45def22 | 2015-04-26 19:26:48 -0400 | [diff] [blame] | 41 | const struct attribute_group **attr_groups; |
Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 42 | unsigned long dsm_mask; |
| 43 | char *provider_name; |
| 44 | ndctl_fn ndctl; |
| 45 | }; |
| 46 | |
Dan Williams | 62232e45 | 2015-06-08 14:27:06 -0400 | [diff] [blame^] | 47 | struct nd_cmd_desc { |
| 48 | int in_num; |
| 49 | int out_num; |
| 50 | u32 in_sizes[ND_CMD_MAX_ELEM]; |
| 51 | int out_sizes[ND_CMD_MAX_ELEM]; |
| 52 | }; |
| 53 | |
| 54 | struct nvdimm_bus; |
Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 55 | struct device; |
Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 56 | struct nvdimm_bus *nvdimm_bus_register(struct device *parent, |
| 57 | struct nvdimm_bus_descriptor *nfit_desc); |
| 58 | void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); |
Dan Williams | 45def22 | 2015-04-26 19:26:48 -0400 | [diff] [blame] | 59 | struct nvdimm_bus *to_nvdimm_bus(struct device *dev); |
Dan Williams | e6dfb2d | 2015-04-25 03:56:17 -0400 | [diff] [blame] | 60 | struct nvdimm *to_nvdimm(struct device *dev); |
Dan Williams | 45def22 | 2015-04-26 19:26:48 -0400 | [diff] [blame] | 61 | struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); |
Dan Williams | e6dfb2d | 2015-04-25 03:56:17 -0400 | [diff] [blame] | 62 | const char *nvdimm_name(struct nvdimm *nvdimm); |
| 63 | void *nvdimm_provider_data(struct nvdimm *nvdimm); |
| 64 | struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, |
Dan Williams | 62232e45 | 2015-06-08 14:27:06 -0400 | [diff] [blame^] | 65 | const struct attribute_group **groups, unsigned long flags, |
| 66 | unsigned long *dsm_mask); |
| 67 | const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); |
| 68 | const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); |
| 69 | u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, |
| 70 | const struct nd_cmd_desc *desc, int idx, void *buf); |
| 71 | u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, |
| 72 | const struct nd_cmd_desc *desc, int idx, const u32 *in_field, |
| 73 | const u32 *out_field); |
Dan Williams | b94d523 | 2015-05-19 22:54:31 -0400 | [diff] [blame] | 74 | #endif /* __LIBNVDIMM_H__ */ |