]> git.ipfire.org Git - thirdparty/mdadm.git/blob - platform-intel.c
imsm: simplified multiple OROMs support
[thirdparty/mdadm.git] / platform-intel.c
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 "mdadm.h"
20 #include "platform-intel.h"
21 #include "probe_roms.h"
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <unistd.h>
26 #include <dirent.h>
27 #include <fcntl.h>
28 #include <sys/mman.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <limits.h>
32
33 static int devpath_to_ll(const char *dev_path, const char *entry,
34 unsigned long long *val);
35
36 static __u16 devpath_to_vendor(const char *dev_path);
37
38 static void free_sys_dev(struct sys_dev **list)
39 {
40 while (*list) {
41 struct sys_dev *next = (*list)->next;
42
43 if ((*list)->path)
44 free((*list)->path);
45 free(*list);
46 *list = next;
47 }
48 }
49
50 struct sys_dev *find_driver_devices(const char *bus, const char *driver)
51 {
52 /* search sysfs for devices driven by 'driver' */
53 char path[292];
54 char link[256];
55 char *c;
56 DIR *driver_dir;
57 struct dirent *de;
58 struct sys_dev *head = NULL;
59 struct sys_dev *list = NULL;
60 enum sys_dev_type type;
61 unsigned long long dev_id;
62 unsigned long long class;
63
64 if (strcmp(driver, "isci") == 0)
65 type = SYS_DEV_SAS;
66 else if (strcmp(driver, "ahci") == 0)
67 type = SYS_DEV_SATA;
68 else if (strcmp(driver, "nvme") == 0)
69 type = SYS_DEV_NVME;
70 else
71 type = SYS_DEV_UNKNOWN;
72
73 sprintf(path, "/sys/bus/%s/drivers/%s", bus, driver);
74 driver_dir = opendir(path);
75 if (!driver_dir)
76 return NULL;
77 for (de = readdir(driver_dir); de; de = readdir(driver_dir)) {
78 int n;
79
80 /* is 'de' a device? check that the 'subsystem' link exists and
81 * that its target matches 'bus'
82 */
83 sprintf(path, "/sys/bus/%s/drivers/%s/%s/subsystem",
84 bus, driver, de->d_name);
85 n = readlink(path, link, sizeof(link));
86 if (n < 0 || n >= (int)sizeof(link))
87 continue;
88 link[n] = '\0';
89 c = strrchr(link, '/');
90 if (!c)
91 continue;
92 if (strncmp(bus, c+1, strlen(bus)) != 0)
93 continue;
94
95 sprintf(path, "/sys/bus/%s/drivers/%s/%s",
96 bus, driver, de->d_name);
97
98 /* if it's not Intel device skip it. */
99 if (devpath_to_vendor(path) != 0x8086)
100 continue;
101
102 if (devpath_to_ll(path, "device", &dev_id) != 0)
103 continue;
104
105 if (devpath_to_ll(path, "class", &class) != 0)
106 continue;
107
108 /* start / add list entry */
109 if (!head) {
110 head = xmalloc(sizeof(*head));
111 list = head;
112 } else {
113 list->next = xmalloc(sizeof(*head));
114 list = list->next;
115 }
116
117 if (!list) {
118 free_sys_dev(&head);
119 break;
120 }
121
122 list->dev_id = (__u16) dev_id;
123 list->class = (__u32) class;
124 list->type = type;
125 list->path = realpath(path, NULL);
126 list->next = NULL;
127 if ((list->pci_id = strrchr(list->path, '/')) != NULL)
128 list->pci_id++;
129 }
130 closedir(driver_dir);
131 return head;
132 }
133
134 static struct sys_dev *intel_devices=NULL;
135 static time_t valid_time = 0;
136
137 struct sys_dev *device_by_id(__u16 device_id)
138 {
139 struct sys_dev *iter;
140
141 for (iter = intel_devices; iter != NULL; iter = iter->next)
142 if (iter->dev_id == device_id)
143 return iter;
144 return NULL;
145 }
146
147 static int devpath_to_ll(const char *dev_path, const char *entry, unsigned long long *val)
148 {
149 char path[strlen(dev_path) + strlen(entry) + 2];
150 int fd;
151 int n;
152
153 sprintf(path, "%s/%s", dev_path, entry);
154
155 fd = open(path, O_RDONLY);
156 if (fd < 0)
157 return -1;
158 n = sysfs_fd_get_ll(fd, val);
159 close(fd);
160 return n;
161 }
162
163 static __u16 devpath_to_vendor(const char *dev_path)
164 {
165 char path[strlen(dev_path) + strlen("/vendor") + 1];
166 char vendor[7];
167 int fd;
168 __u16 id = 0xffff;
169 int n;
170
171 sprintf(path, "%s/vendor", dev_path);
172
173 fd = open(path, O_RDONLY);
174 if (fd < 0)
175 return 0xffff;
176
177 n = read(fd, vendor, sizeof(vendor));
178 if (n == sizeof(vendor)) {
179 vendor[n - 1] = '\0';
180 id = strtoul(vendor, NULL, 16);
181 }
182 close(fd);
183
184 return id;
185 }
186
187 struct sys_dev *find_intel_devices(void)
188 {
189 struct sys_dev *ahci, *isci, *nvme;
190
191 if (valid_time > time(0) - 10)
192 return intel_devices;
193
194 if (intel_devices)
195 free_sys_dev(&intel_devices);
196
197 isci = find_driver_devices("pci", "isci");
198 ahci = find_driver_devices("pci", "ahci");
199 nvme = find_driver_devices("pci", "nvme");
200
201 if (!isci && !ahci) {
202 ahci = nvme;
203 } else if (!ahci) {
204 ahci = isci;
205 struct sys_dev *elem = ahci;
206 while (elem->next)
207 elem = elem->next;
208 elem->next = nvme;
209 } else {
210 struct sys_dev *elem = ahci;
211 while (elem->next)
212 elem = elem->next;
213 elem->next = isci;
214 while (elem->next)
215 elem = elem->next;
216 elem->next = nvme;
217 }
218 intel_devices = ahci;
219 valid_time = time(0);
220 return intel_devices;
221 }
222
223 /*
224 * PCI Expansion ROM Data Structure Format */
225 struct pciExpDataStructFormat {
226 __u8 ver[4];
227 __u16 vendorID;
228 __u16 deviceID;
229 __u16 devListOffset;
230 } __attribute__ ((packed));
231
232 struct orom_entry *orom_entries;
233
234 const struct imsm_orom *get_orom_by_device_id(__u16 dev_id)
235 {
236 struct orom_entry *entry;
237 struct devid_list *devid;
238
239 for (entry = orom_entries; entry; entry = entry->next) {
240 for (devid = entry->devid_list; devid; devid = devid->next) {
241 if (devid->devid == dev_id)
242 return &entry->orom;
243 }
244 }
245
246 return NULL;
247 }
248
249 static struct orom_entry *add_orom(const struct imsm_orom *orom)
250 {
251 struct orom_entry *list;
252 struct orom_entry *prev = NULL;
253
254 for (list = orom_entries; list; prev = list, list = list->next)
255 ;
256
257 list = xmalloc(sizeof(struct orom_entry));
258 list->orom = *orom;
259 list->devid_list = NULL;
260 list->next = NULL;
261
262 if (prev == NULL)
263 orom_entries = list;
264 else
265 prev->next = list;
266
267 return list;
268 }
269
270 static void add_orom_device_id(struct orom_entry *entry, __u16 dev_id)
271 {
272 struct devid_list *list;
273 struct devid_list *prev = NULL;
274
275 for (list = entry->devid_list; list; prev = list, list = list->next) {
276 if (list->devid == dev_id)
277 return;
278 }
279 list = xmalloc(sizeof(struct devid_list));
280 list->devid = dev_id;
281 list->next = NULL;
282
283 if (prev == NULL)
284 entry->devid_list = list;
285 else
286 prev->next = list;
287 }
288
289 static int scan(const void *start, const void *end, const void *data)
290 {
291 int offset;
292 const struct imsm_orom *imsm_mem = NULL;
293 int len = (end - start);
294 struct pciExpDataStructFormat *ptr= (struct pciExpDataStructFormat *)data;
295
296 if (data + 0x18 > end) {
297 dprintf("cannot find pciExpDataStruct \n");
298 return 0;
299 }
300
301 dprintf("ptr->vendorID: %lx __le16_to_cpu(ptr->deviceID): %lx \n",
302 (ulong) __le16_to_cpu(ptr->vendorID),
303 (ulong) __le16_to_cpu(ptr->deviceID));
304
305 if (__le16_to_cpu(ptr->vendorID) != 0x8086)
306 return 0;
307
308 for (offset = 0; offset < len; offset += 4) {
309 const void *mem = start + offset;
310
311 if ((memcmp(mem, IMSM_OROM_SIGNATURE, 4) == 0)) {
312 imsm_mem = mem;
313 break;
314 }
315 }
316
317 if (!imsm_mem)
318 return 0;
319
320 struct orom_entry *orom = add_orom(imsm_mem);
321
322 if (ptr->devListOffset) {
323 const __u16 *dev_list = (void *)ptr + ptr->devListOffset;
324 int i;
325
326 for (i = 0; dev_list[i] != 0; i++)
327 add_orom_device_id(orom, dev_list[i]);
328 } else {
329 add_orom_device_id(orom, __le16_to_cpu(ptr->deviceID));
330 }
331
332 return 0;
333 }
334
335 const struct imsm_orom *imsm_platform_test(struct sys_dev *hba)
336 {
337 struct imsm_orom orom = {
338 .signature = IMSM_OROM_SIGNATURE,
339 .rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
340 IMSM_OROM_RLC_RAID10 | IMSM_OROM_RLC_RAID5,
341 .sss = IMSM_OROM_SSS_4kB | IMSM_OROM_SSS_8kB |
342 IMSM_OROM_SSS_16kB | IMSM_OROM_SSS_32kB |
343 IMSM_OROM_SSS_64kB | IMSM_OROM_SSS_128kB |
344 IMSM_OROM_SSS_256kB | IMSM_OROM_SSS_512kB |
345 IMSM_OROM_SSS_1MB | IMSM_OROM_SSS_2MB,
346 .dpa = IMSM_OROM_DISKS_PER_ARRAY,
347 .tds = IMSM_OROM_TOTAL_DISKS,
348 .vpa = IMSM_OROM_VOLUMES_PER_ARRAY,
349 .vphba = IMSM_OROM_VOLUMES_PER_HBA
350 };
351 orom.attr = orom.rlc | IMSM_OROM_ATTR_ChecksumVerify;
352
353 if (check_env("IMSM_TEST_OROM_NORAID5")) {
354 orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
355 IMSM_OROM_RLC_RAID10;
356 }
357 if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba->type == SYS_DEV_SAS)) {
358 orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
359 IMSM_OROM_RLC_RAID10;
360 }
361 if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba->type == SYS_DEV_SATA)) {
362 orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
363 IMSM_OROM_RLC_RAID10;
364 }
365
366 struct orom_entry *ret = add_orom(&orom);
367
368 add_orom_device_id(ret, hba->dev_id);
369
370 return &ret->orom;
371 }
372
373 static const struct imsm_orom *find_imsm_hba_orom(struct sys_dev *hba)
374 {
375 unsigned long align;
376
377 if (check_env("IMSM_TEST_OROM"))
378 return imsm_platform_test(hba);
379
380 /* return empty OROM capabilities in EFI test mode */
381 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
382 return NULL;
383
384 find_intel_devices();
385
386 if (intel_devices == NULL)
387 return NULL;
388
389 /* scan option-rom memory looking for an imsm signature */
390 if (check_env("IMSM_SAFE_OROM_SCAN"))
391 align = 2048;
392 else
393 align = 512;
394 if (probe_roms_init(align) != 0)
395 return NULL;
396 probe_roms();
397 /* ignore return value - True is returned if both adapater roms are found */
398 scan_adapter_roms(scan);
399 probe_roms_exit();
400
401 return get_orom_by_device_id(hba->dev_id);
402 }
403
404 #define GUID_STR_MAX 37 /* according to GUID format:
405 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
406
407 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
408 ((struct efi_guid) \
409 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
410 (b) & 0xff, ((b) >> 8) & 0xff, \
411 (c) & 0xff, ((c) >> 8) & 0xff, \
412 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
413
414 #define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
415 #define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
416 #define SCU_PROP "RstScuV"
417 #define AHCI_PROP "RstSataV"
418 #define AHCI_SSATA_PROP "RstsSatV"
419 #define AHCI_CSATA_PROP "RstCSatV"
420
421 #define VENDOR_GUID \
422 EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)
423
424 #define PCI_CLASS_RAID_CNTRL 0x010400
425
426 static int read_efi_var(void *buffer, ssize_t buf_size, char *variable_name, struct efi_guid guid)
427 {
428 char path[PATH_MAX];
429 char buf[GUID_STR_MAX];
430 int fd;
431 ssize_t n;
432
433 snprintf(path, PATH_MAX, "%s/%s-%s", SYS_EFIVARS_PATH, variable_name, guid_str(buf, guid));
434
435 fd = open(path, O_RDONLY);
436 if (fd < 0)
437 return 1;
438
439 /* read the variable attributes and ignore it */
440 n = read(fd, buf, sizeof(__u32));
441 if (n < 0) {
442 close(fd);
443 return 1;
444 }
445
446 /* read the variable data */
447 n = read(fd, buffer, buf_size);
448 close(fd);
449 if (n < buf_size)
450 return 1;
451
452 return 0;
453 }
454
455 static int read_efi_variable(void *buffer, ssize_t buf_size, char *variable_name, struct efi_guid guid)
456 {
457 char path[PATH_MAX];
458 char buf[GUID_STR_MAX];
459 int dfd;
460 ssize_t n, var_data_len;
461
462 /* Try to read the variable using the new efivarfs interface first.
463 * If that fails, fall back to the old sysfs-efivars interface. */
464 if (!read_efi_var(buffer, buf_size, variable_name, guid))
465 return 0;
466
467 snprintf(path, PATH_MAX, "%s/%s-%s/size", SYS_EFI_VAR_PATH, variable_name, guid_str(buf, guid));
468
469 dprintf("EFI VAR: path=%s\n", path);
470 /* get size of variable data */
471 dfd = open(path, O_RDONLY);
472 if (dfd < 0)
473 return 1;
474
475 n = read(dfd, &buf, sizeof(buf));
476 close(dfd);
477 if (n < 0)
478 return 1;
479 buf[n] = '\0';
480
481 errno = 0;
482 var_data_len = strtoul(buf, NULL, 16);
483 if ((errno == ERANGE && (var_data_len == LONG_MAX))
484 || (errno != 0 && var_data_len == 0))
485 return 1;
486
487 /* get data */
488 snprintf(path, PATH_MAX, "%s/%s-%s/data", SYS_EFI_VAR_PATH, variable_name, guid_str(buf, guid));
489
490 dprintf("EFI VAR: path=%s\n", path);
491 dfd = open(path, O_RDONLY);
492 if (dfd < 0)
493 return 1;
494
495 n = read(dfd, buffer, buf_size);
496 close(dfd);
497 if (n != var_data_len || n < buf_size) {
498 return 1;
499 }
500
501 return 0;
502 }
503
504 const struct imsm_orom *find_imsm_efi(struct sys_dev *hba)
505 {
506 struct imsm_orom orom;
507 struct orom_entry *ret;
508 int err;
509
510 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
511 return imsm_platform_test(hba);
512
513 /* OROM test is set, return that there is no EFI capabilities */
514 if (check_env("IMSM_TEST_OROM"))
515 return NULL;
516
517 if (hba->type == SYS_DEV_SATA && hba->class != PCI_CLASS_RAID_CNTRL)
518 return NULL;
519
520 err = read_efi_variable(&orom, sizeof(orom), hba->type == SYS_DEV_SAS ? SCU_PROP : AHCI_PROP, VENDOR_GUID);
521
522 /* try to read variable for second AHCI controller */
523 if (err && hba->type == SYS_DEV_SATA)
524 err = read_efi_variable(&orom, sizeof(orom), AHCI_SSATA_PROP, VENDOR_GUID);
525
526 /* try to read variable for combined AHCI controllers */
527 if (err && hba->type == SYS_DEV_SATA) {
528 static struct orom_entry *csata;
529
530 err = read_efi_variable(&orom, sizeof(orom), AHCI_CSATA_PROP, VENDOR_GUID);
531 if (!err) {
532 if (!csata)
533 csata = add_orom(&orom);
534 add_orom_device_id(csata, hba->dev_id);
535 return &csata->orom;
536 }
537 }
538
539 if (err)
540 return NULL;
541
542 ret = add_orom(&orom);
543 add_orom_device_id(ret, hba->dev_id);
544
545 return &ret->orom;
546 }
547
548 const struct imsm_orom *find_imsm_nvme(struct sys_dev *hba)
549 {
550 static struct orom_entry *nvme_orom;
551
552 if (hba->type != SYS_DEV_NVME)
553 return NULL;
554
555 if (!nvme_orom) {
556 struct imsm_orom nvme_orom_compat = {
557 .signature = IMSM_NVME_OROM_COMPAT_SIGNATURE,
558 .rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
559 IMSM_OROM_RLC_RAID10 | IMSM_OROM_RLC_RAID5,
560 .sss = IMSM_OROM_SSS_4kB | IMSM_OROM_SSS_8kB |
561 IMSM_OROM_SSS_16kB | IMSM_OROM_SSS_32kB |
562 IMSM_OROM_SSS_64kB | IMSM_OROM_SSS_128kB,
563 .dpa = IMSM_OROM_DISKS_PER_ARRAY_NVME,
564 .tds = IMSM_OROM_TOTAL_DISKS_NVME,
565 .vpa = IMSM_OROM_VOLUMES_PER_ARRAY,
566 .vphba = IMSM_OROM_TOTAL_DISKS_NVME / 2 * IMSM_OROM_VOLUMES_PER_ARRAY,
567 .attr = IMSM_OROM_ATTR_2TB | IMSM_OROM_ATTR_2TB_DISK,
568 .driver_features = IMSM_OROM_CAPABILITIES_EnterpriseSystem
569 };
570 nvme_orom = add_orom(&nvme_orom_compat);
571 }
572 add_orom_device_id(nvme_orom, hba->dev_id);
573 return &nvme_orom->orom;
574 }
575
576 const struct imsm_orom *find_imsm_capability(struct sys_dev *hba)
577 {
578 const struct imsm_orom *cap = get_orom_by_device_id(hba->dev_id);
579
580 if (cap)
581 return cap;
582
583 if (hba->type == SYS_DEV_NVME)
584 return find_imsm_nvme(hba);
585 if ((cap = find_imsm_efi(hba)) != NULL)
586 return cap;
587 if ((cap = find_imsm_hba_orom(hba)) != NULL)
588 return cap;
589
590 return NULL;
591 }
592
593 char *devt_to_devpath(dev_t dev)
594 {
595 char device[46];
596
597 sprintf(device, "/sys/dev/block/%d:%d/device", major(dev), minor(dev));
598 return realpath(device, NULL);
599 }
600
601 char *diskfd_to_devpath(int fd)
602 {
603 /* return the device path for a disk, return NULL on error or fd
604 * refers to a partition
605 */
606 struct stat st;
607
608 if (fstat(fd, &st) != 0)
609 return NULL;
610 if (!S_ISBLK(st.st_mode))
611 return NULL;
612
613 return devt_to_devpath(st.st_rdev);
614 }
615
616 int path_attached_to_hba(const char *disk_path, const char *hba_path)
617 {
618 int rc;
619
620 if (check_env("IMSM_TEST_AHCI_DEV") ||
621 check_env("IMSM_TEST_SCU_DEV")) {
622 return 1;
623 }
624
625 if (!disk_path || !hba_path)
626 return 0;
627 dprintf("hba: %s - disk: %s\n", hba_path, disk_path);
628 if (strncmp(disk_path, hba_path, strlen(hba_path)) == 0)
629 rc = 1;
630 else
631 rc = 0;
632
633 return rc;
634 }
635
636 int devt_attached_to_hba(dev_t dev, const char *hba_path)
637 {
638 char *disk_path = devt_to_devpath(dev);
639 int rc = path_attached_to_hba(disk_path, hba_path);
640
641 if (disk_path)
642 free(disk_path);
643
644 return rc;
645 }
646
647 int disk_attached_to_hba(int fd, const char *hba_path)
648 {
649 char *disk_path = diskfd_to_devpath(fd);
650 int rc = path_attached_to_hba(disk_path, hba_path);
651
652 if (disk_path)
653 free(disk_path);
654
655 return rc;
656 }