]> git.ipfire.org Git - thirdparty/mdadm.git/blame - platform-intel.h
mdadm: improve the dlm locking mechanism for clustered raid
[thirdparty/mdadm.git] / platform-intel.h
CommitLineData
b390f610
DW
1/*
2 * Intel(R) Matrix Storage Manager hardware and firmware support routines
3 *
4 * Copyright (C) 2008 Intel Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19#include <asm/types.h>
88c32bb1 20#include <strings.h>
b390f610 21
fc13853f 22/* The IMSM Capability (IMSM AHCI and ISCU OROM/EFI variable) Version Table definition */
b390f610
DW
23struct imsm_orom {
24 __u8 signature[4];
6b781d33 25 #define IMSM_OROM_SIGNATURE "$VER"
614902f6 26 #define IMSM_NVME_OROM_COMPAT_SIGNATURE "$NVM"
b390f610
DW
27 __u8 table_ver_major; /* Currently 2 (can change with future revs) */
28 __u8 table_ver_minor; /* Currently 2 (can change with future revs) */
29 __u16 major_ver; /* Example: 8 as in 8.6.0.1020 */
30 __u16 minor_ver; /* Example: 6 as in 8.6.0.1020 */
31 __u16 hotfix_ver; /* Example: 0 as in 8.6.0.1020 */
32 __u16 build; /* Example: 1020 as in 8.6.0.1020 */
33 __u8 len; /* number of bytes in this entire table */
34 __u8 checksum; /* checksum of all the bytes in this table */
35 __u16 rlc; /* RAID Level Capability */
36 /* we assume the cpu is x86 as the orom should not be found
37 * anywhere else
38 */
39 #define IMSM_OROM_RLC_RAID0 (1 << 0)
40 #define IMSM_OROM_RLC_RAID1 (1 << 1)
41 #define IMSM_OROM_RLC_RAID10 (1 << 2)
42 #define IMSM_OROM_RLC_RAID1E (1 << 3)
43 #define IMSM_OROM_RLC_RAID5 (1 << 4)
44 #define IMSM_OROM_RLC_RAID_CNG (1 << 5)
45 __u16 sss; /* Strip Size Supported */
46 #define IMSM_OROM_SSS_2kB (1 << 0)
47 #define IMSM_OROM_SSS_4kB (1 << 1)
48 #define IMSM_OROM_SSS_8kB (1 << 2)
49 #define IMSM_OROM_SSS_16kB (1 << 3)
50 #define IMSM_OROM_SSS_32kB (1 << 4)
51 #define IMSM_OROM_SSS_64kB (1 << 5)
52 #define IMSM_OROM_SSS_128kB (1 << 6)
53 #define IMSM_OROM_SSS_256kB (1 << 7)
54 #define IMSM_OROM_SSS_512kB (1 << 8)
55 #define IMSM_OROM_SSS_1MB (1 << 9)
56 #define IMSM_OROM_SSS_2MB (1 << 10)
57 #define IMSM_OROM_SSS_4MB (1 << 11)
58 #define IMSM_OROM_SSS_8MB (1 << 12)
59 #define IMSM_OROM_SSS_16MB (1 << 13)
60 #define IMSM_OROM_SSS_32MB (1 << 14)
61 #define IMSM_OROM_SSS_64MB (1 << 15)
62 __u16 dpa; /* Disks Per Array supported */
fc13853f 63 #define IMSM_OROM_DISKS_PER_ARRAY 6
614902f6 64 #define IMSM_OROM_DISKS_PER_ARRAY_NVME 12
b390f610 65 __u16 tds; /* Total Disks Supported */
fc13853f 66 #define IMSM_OROM_TOTAL_DISKS 6
614902f6 67 #define IMSM_OROM_TOTAL_DISKS_NVME 12
b390f610 68 __u8 vpa; /* # Volumes Per Array supported */
fc13853f 69 #define IMSM_OROM_VOLUMES_PER_ARRAY 2
b390f610 70 __u8 vphba; /* # Volumes Per Host Bus Adapter supported */
fc13853f 71 #define IMSM_OROM_VOLUMES_PER_HBA 4
614902f6 72 #define IMSM_OROM_VOLUMES_PER_HBA_NVME 4
b390f610
DW
73 /* Attributes supported. This should map to the
74 * attributes in the MPB. Also, lower 16 bits
75 * should match/duplicate RLC bits above.
76 */
77 __u32 attr;
78 #define IMSM_OROM_ATTR_RAID0 IMSM_OROM_RLC_RAID0
79 #define IMSM_OROM_ATTR_RAID1 IMSM_OROM_RLC_RAID1
80 #define IMSM_OROM_ATTR_RAID10 IMSM_OROM_RLC_RAID10
81 #define IMSM_OROM_ATTR_RAID1E IMSM_OROM_RLC_RAID1E
82 #define IMSM_OROM_ATTR_RAID5 IMSM_OROM_RLC_RAID5
83 #define IMSM_OROM_ATTR_RAID_CNG IMSM_OROM_RLC_RAID_CNG
29cd0821 84 #define IMSM_OROM_ATTR_2TB_DISK (1 << 26)
b390f610
DW
85 #define IMSM_OROM_ATTR_2TB (1 << 29)
86 #define IMSM_OROM_ATTR_PM (1 << 30)
87 #define IMSM_OROM_ATTR_ChecksumVerify (1 << 31)
2a7e6de2
LM
88 __u32 capabilities;
89 #define IMSM_OROM_CAPABILITIES_Ext_SATA (1 << 0)
90 #define IMSM_OROM_CAPABILITIES_TurboMemory (1 << 1)
91 #define IMSM_OROM_CAPABILITIES_HddPassword (1 << 2)
92 #define IMSM_OROM_CAPABILITIES_DiskCoercion (1 << 3)
93 __u32 driver_features;
94 #define IMSM_OROM_CAPABILITIES_HDDUnlock (1 << 0)
95 #define IMSM_OROM_CAPABILITIES_LEDLoc (1 << 1)
96 #define IMSM_OROM_CAPABILITIES_EnterpriseSystem (1 << 2)
97 #define IMSM_OROM_CAPABILITIES_Zpodd (1 << 3)
98 #define IMSM_OROM_CAPABILITIES_LargeDramCache (1 << 4)
99 #define IMSM_OROM_CAPABILITIES_Rohi (1 << 5)
100 #define IMSM_OROM_CAPABILITIES_ReadPatrol (1 << 6)
101 #define IMSM_OROM_CAPABILITIES_XorHw (1 << 7)
32716c51
PB
102 #define IMSM_OROM_CAPABILITIES_SKUMode ((1 << 8)|(1 << 9))
103 #define IMSM_OROM_CAPABILITIES_TPV (1 << 10)
b390f610
DW
104} __attribute__((packed));
105
88c32bb1
DW
106static inline int imsm_orom_has_raid0(const struct imsm_orom *orom)
107{
108 return !!(orom->rlc & IMSM_OROM_RLC_RAID0);
109}
110static inline int imsm_orom_has_raid1(const struct imsm_orom *orom)
111{
112 return !!(orom->rlc & IMSM_OROM_RLC_RAID1);
113}
114static inline int imsm_orom_has_raid1e(const struct imsm_orom *orom)
115{
116 return !!(orom->rlc & IMSM_OROM_RLC_RAID1E);
117}
118static inline int imsm_orom_has_raid10(const struct imsm_orom *orom)
119{
120 return !!(orom->rlc & IMSM_OROM_RLC_RAID10);
121}
122static inline int imsm_orom_has_raid5(const struct imsm_orom *orom)
123{
124 return !!(orom->rlc & IMSM_OROM_RLC_RAID5);
125}
126
127/**
128 * imsm_orom_has_chunk - check if the orom supports the given chunk size
129 * @orom: orom pointer from find_imsm_orom
130 * @chunk: chunk size in kibibytes
131 */
132static inline int imsm_orom_has_chunk(const struct imsm_orom *orom, int chunk)
133{
134 int fs = ffs(chunk);
88c32bb1
DW
135 if (!fs)
136 return 0;
137 fs--; /* bit num to bit index */
70eb8219
HCP
138 if (chunk & (chunk-1))
139 return 0; /* not a power of 2 */
140 return !!(orom->sss & (1 << (fs - 1)));
88c32bb1
DW
141}
142
0bd16cf2
DJ
143/**
144 * fls - find last (most-significant) bit set
145 * @x: the word to search
146 * The funciton is borrowed from Linux kernel code
147 * include/asm-generic/bitops/fls.h
148 */
149static inline int fls(int x)
150{
151 int r = 32;
152
153 if (!x)
154 return 0;
155 if (!(x & 0xffff0000u)) {
156 x <<= 16;
157 r -= 16;
158 }
159 if (!(x & 0xff000000u)) {
160 x <<= 8;
161 r -= 8;
162 }
163 if (!(x & 0xf0000000u)) {
164 x <<= 4;
165 r -= 4;
166 }
167 if (!(x & 0xc0000000u)) {
168 x <<= 2;
169 r -= 2;
170 }
171 if (!(x & 0x80000000u)) {
172 x <<= 1;
173 r -= 1;
174 }
175 return r;
176}
177
0858eccf
AP
178static inline int imsm_orom_is_enterprise(const struct imsm_orom *orom)
179{
180 return !!(orom->driver_features & IMSM_OROM_CAPABILITIES_EnterpriseSystem);
181}
182
183static inline int imsm_orom_is_nvme(const struct imsm_orom *orom)
184{
185 return memcmp(orom->signature, IMSM_NVME_OROM_COMPAT_SIGNATURE,
186 sizeof(orom->signature)) == 0;
187}
188
32716c51
PB
189static inline int imsm_orom_has_tpv_support(const struct imsm_orom *orom)
190{
191 return !!(orom->driver_features & IMSM_OROM_CAPABILITIES_TPV);
192}
193
a8e5382a
LM
194enum sys_dev_type {
195 SYS_DEV_UNKNOWN = 0,
196 SYS_DEV_SAS,
197 SYS_DEV_SATA,
614902f6 198 SYS_DEV_NVME,
60f0f54d 199 SYS_DEV_VMD,
a8e5382a
LM
200 SYS_DEV_MAX
201};
202
b390f610 203struct sys_dev {
a8e5382a 204 enum sys_dev_type type;
b390f610 205 char *path;
a8e5382a 206 char *pci_id;
9c747fa0 207 __u16 dev_id;
6b781d33 208 __u32 class;
b390f610
DW
209 struct sys_dev *next;
210};
211
1a901471
LM
212struct efi_guid {
213 __u8 b[16];
214};
215
0858eccf
AP
216struct devid_list {
217 __u16 devid;
218 struct devid_list *next;
219};
220
221struct orom_entry {
222 struct imsm_orom orom;
223 struct devid_list *devid_list;
60f0f54d 224 enum sys_dev_type type;
5e1d6128 225 struct orom_entry *next;
0858eccf
AP
226};
227
5e1d6128
AP
228extern struct orom_entry *orom_entries;
229
1a901471
LM
230static inline char *guid_str(char *buf, struct efi_guid guid)
231{
7a862a02 232 sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1a901471
LM
233 guid.b[3], guid.b[2], guid.b[1], guid.b[0],
234 guid.b[5], guid.b[4], guid.b[7], guid.b[6],
235 guid.b[8], guid.b[9], guid.b[10], guid.b[11],
236 guid.b[12], guid.b[13], guid.b[14], guid.b[15]);
237 return buf;
238}
239
a8e5382a 240char *diskfd_to_devpath(int fd);
60f0f54d 241__u16 devpath_to_vendor(const char *dev_path);
b390f610 242struct sys_dev *find_driver_devices(const char *bus, const char *driver);
a8e5382a 243struct sys_dev *find_intel_devices(void);
6b781d33 244const struct imsm_orom *find_imsm_capability(struct sys_dev *hba);
b390f610 245const struct imsm_orom *find_imsm_orom(void);
25921536 246int disk_attached_to_hba(int fd, const char *hba_path);
0c21b485 247int devt_attached_to_hba(dev_t dev, const char *hba_path);
25921536
DW
248char *devt_to_devpath(dev_t dev);
249int path_attached_to_hba(const char *disk_path, const char *hba_path);
a8e5382a 250const char *get_sys_dev_type(enum sys_dev_type);
72a45777 251const struct orom_entry *get_orom_entry_by_device_id(__u16 dev_id);
6b781d33 252const struct imsm_orom *get_orom_by_device_id(__u16 device_id);
0858eccf 253struct sys_dev *device_by_id(__u16 device_id);
d3c11416 254struct sys_dev *device_by_id_and_path(__u16 device_id, const char *path);
60f0f54d 255char *vmd_domain_to_controller(struct sys_dev *hba, char *buf);