projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| b94d5230 DW |
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__ | |
| 62232e45 DW |
17 | #include <linux/sizes.h> |
| 18 | #include <linux/types.h> | |
| e6dfb2de DW |
19 | |
| 20 | enum { | |
| 21 | /* when a dimm supports both PMEM and BLK access a label is required */ | |
| 22 | NDD_ALIASING = 1 << 0, | |
| 62232e45 DW |
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, | |
| e6dfb2de DW |
29 | }; |
| 30 | ||
| 45def22c | 31 | extern struct attribute_group nvdimm_bus_attribute_group; |
| 62232e45 | 32 | extern struct attribute_group nvdimm_attribute_group; |
| 4d88a97a | 33 | extern struct attribute_group nd_device_attribute_group; |
| 45def22c | 34 | |
| b94d5230 DW |
35 | struct nvdimm; |
| 36 | struct nvdimm_bus_descriptor; | |
| 37 | typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, | |
| 38 | struct nvdimm *nvdimm, unsigned int cmd, void *buf, | |
| 39 | unsigned int buf_len); | |
| 40 | ||
| 41 | struct nvdimm_bus_descriptor { | |
| 45def22c | 42 | const struct attribute_group **attr_groups; |
| b94d5230 DW |
43 | unsigned long dsm_mask; |
| 44 | char *provider_name; | |
| 45 | ndctl_fn ndctl; | |
| 46 | }; | |
| 47 | ||
| 62232e45 DW |
48 | struct nd_cmd_desc { |
| 49 | int in_num; | |
| 50 | int out_num; | |
| 51 | u32 in_sizes[ND_CMD_MAX_ELEM]; | |
| 52 | int out_sizes[ND_CMD_MAX_ELEM]; | |
| 53 | }; | |
| 54 | ||
| 55 | struct nvdimm_bus; | |
| b94d5230 | 56 | struct device; |
| b94d5230 DW |
57 | struct nvdimm_bus *nvdimm_bus_register(struct device *parent, |
| 58 | struct nvdimm_bus_descriptor *nfit_desc); | |
| 59 | void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); | |
| 45def22c | 60 | struct nvdimm_bus *to_nvdimm_bus(struct device *dev); |
| e6dfb2de | 61 | struct nvdimm *to_nvdimm(struct device *dev); |
| 45def22c | 62 | struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); |
| e6dfb2de DW |
63 | const char *nvdimm_name(struct nvdimm *nvdimm); |
| 64 | void *nvdimm_provider_data(struct nvdimm *nvdimm); | |
| 65 | struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, | |
| 62232e45 DW |
66 | const struct attribute_group **groups, unsigned long flags, |
| 67 | unsigned long *dsm_mask); | |
| 68 | const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); | |
| 69 | const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); | |
| 70 | u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, | |
| 71 | const struct nd_cmd_desc *desc, int idx, void *buf); | |
| 72 | u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, | |
| 73 | const struct nd_cmd_desc *desc, int idx, const u32 *in_field, | |
| 74 | const u32 *out_field); | |
| 4d88a97a | 75 | int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); |
| b94d5230 | 76 | #endif /* __LIBNVDIMM_H__ */ |