2 * Intel(R) Matrix Storage Manager hardware and firmware support routines
4 * Copyright (C) 2008 Intel Corporation
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.
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
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.
20 #include "platform-intel.h"
21 #include "probe_roms.h"
29 #include <sys/types.h>
33 static int devpath_to_ll(const char *dev_path
, const char *entry
,
34 unsigned long long *val
);
36 static void free_sys_dev(struct sys_dev
**list
)
39 struct sys_dev
*next
= (*list
)->next
;
48 struct sys_dev
*find_driver_devices(const char *bus
, const char *driver
)
50 /* search sysfs for devices driven by 'driver' */
56 struct sys_dev
*head
= NULL
;
57 struct sys_dev
*list
= NULL
;
58 struct sys_dev
*vmd
= NULL
;
59 enum sys_dev_type type
;
60 unsigned long long dev_id
;
61 unsigned long long class;
63 if (strcmp(driver
, "isci") == 0)
65 else if (strcmp(driver
, "ahci") == 0)
67 else if (strcmp(driver
, "nvme") == 0) {
68 /* if looking for nvme devs, first look for vmd */
69 vmd
= find_driver_devices("pci", "vmd");
71 } else if (strcmp(driver
, "vmd") == 0)
74 type
= SYS_DEV_UNKNOWN
;
76 sprintf(path
, "/sys/bus/%s/drivers/%s", bus
, driver
);
77 driver_dir
= opendir(path
);
83 for (de
= readdir(driver_dir
); de
; de
= readdir(driver_dir
)) {
87 /* is 'de' a device? check that the 'subsystem' link exists and
88 * that its target matches 'bus'
90 sprintf(path
, "/sys/bus/%s/drivers/%s/%s/subsystem",
91 bus
, driver
, de
->d_name
);
92 n
= readlink(path
, link
, sizeof(link
));
93 if (n
< 0 || n
>= (int)sizeof(link
))
96 c
= strrchr(link
, '/');
99 if (strncmp(bus
, c
+1, strlen(bus
)) != 0)
102 sprintf(path
, "/sys/bus/%s/drivers/%s/%s",
103 bus
, driver
, de
->d_name
);
105 /* if searching for nvme - skip vmd connected one */
106 if (type
== SYS_DEV_NVME
) {
108 char *rp
= realpath(path
, NULL
);
109 for (dev
= vmd
; dev
; dev
= dev
->next
) {
110 if ((strncmp(dev
->path
, rp
, strlen(dev
->path
)) == 0))
116 /* if it's not Intel device or mark as VMD connected - skip it. */
117 if (devpath_to_vendor(path
) != 0x8086 || skip
== 1)
120 if (devpath_to_ll(path
, "device", &dev_id
) != 0)
123 if (devpath_to_ll(path
, "class", &class) != 0)
127 * Each VMD device (domain) adds separate PCI bus, it is better
128 * to store path as a path to that bus (easier further
129 * determination which NVMe dev is connected to this particular
132 if (type
== SYS_DEV_VMD
) {
133 sprintf(path
, "/sys/bus/%s/drivers/%s/%s/domain/device",
134 bus
, driver
, de
->d_name
);
136 p
= realpath(path
, NULL
);
138 pr_err("Unable to get real path for '%s'\n", path
);
142 /* start / add list entry */
144 head
= xmalloc(sizeof(*head
));
147 list
->next
= xmalloc(sizeof(*head
));
156 list
->dev_id
= (__u16
) dev_id
;
157 list
->class = (__u32
) class;
162 if ((list
->pci_id
= strrchr(list
->path
, '/')) != NULL
)
165 closedir(driver_dir
);
177 static struct sys_dev
*intel_devices
=NULL
;
178 static time_t valid_time
= 0;
180 struct sys_dev
*device_by_id(__u16 device_id
)
182 struct sys_dev
*iter
;
184 for (iter
= intel_devices
; iter
!= NULL
; iter
= iter
->next
)
185 if (iter
->dev_id
== device_id
)
190 static int devpath_to_ll(const char *dev_path
, const char *entry
, unsigned long long *val
)
192 char path
[strlen(dev_path
) + strlen(entry
) + 2];
196 sprintf(path
, "%s/%s", dev_path
, entry
);
198 fd
= open(path
, O_RDONLY
);
201 n
= sysfs_fd_get_ll(fd
, val
);
206 __u16
devpath_to_vendor(const char *dev_path
)
208 char path
[strlen(dev_path
) + strlen("/vendor") + 1];
214 sprintf(path
, "%s/vendor", dev_path
);
216 fd
= open(path
, O_RDONLY
);
220 n
= read(fd
, vendor
, sizeof(vendor
));
221 if (n
== sizeof(vendor
)) {
222 vendor
[n
- 1] = '\0';
223 id
= strtoul(vendor
, NULL
, 16);
230 struct sys_dev
*find_intel_devices(void)
232 struct sys_dev
*ahci
, *isci
, *nvme
;
234 if (valid_time
> time(0) - 10)
235 return intel_devices
;
238 free_sys_dev(&intel_devices
);
240 isci
= find_driver_devices("pci", "isci");
241 ahci
= find_driver_devices("pci", "ahci");
242 /* Searching for NVMe will return list of NVMe and VMD controllers */
243 nvme
= find_driver_devices("pci", "nvme");
245 if (!isci
&& !ahci
) {
249 struct sys_dev
*elem
= ahci
;
254 struct sys_dev
*elem
= ahci
;
262 intel_devices
= ahci
;
263 valid_time
= time(0);
264 return intel_devices
;
268 * PCI Expansion ROM Data Structure Format */
269 struct pciExpDataStructFormat
{
274 __u16 pciDataStructLen
;
275 __u8 pciDataStructRev
;
276 } __attribute__ ((packed
));
278 struct orom_entry
*orom_entries
;
280 const struct orom_entry
*get_orom_entry_by_device_id(__u16 dev_id
)
282 struct orom_entry
*entry
;
283 struct devid_list
*devid
;
285 for (entry
= orom_entries
; entry
; entry
= entry
->next
) {
286 for (devid
= entry
->devid_list
; devid
; devid
= devid
->next
) {
287 if (devid
->devid
== dev_id
)
295 const struct imsm_orom
*get_orom_by_device_id(__u16 dev_id
)
297 const struct orom_entry
*entry
= get_orom_entry_by_device_id(dev_id
);
305 static struct orom_entry
*add_orom(const struct imsm_orom
*orom
)
307 struct orom_entry
*list
;
308 struct orom_entry
*prev
= NULL
;
310 for (list
= orom_entries
; list
; prev
= list
, list
= list
->next
)
313 list
= xmalloc(sizeof(struct orom_entry
));
315 list
->devid_list
= NULL
;
326 static void add_orom_device_id(struct orom_entry
*entry
, __u16 dev_id
)
328 struct devid_list
*list
;
329 struct devid_list
*prev
= NULL
;
331 for (list
= entry
->devid_list
; list
; prev
= list
, list
= list
->next
) {
332 if (list
->devid
== dev_id
)
335 list
= xmalloc(sizeof(struct devid_list
));
336 list
->devid
= dev_id
;
340 entry
->devid_list
= list
;
345 static int scan(const void *start
, const void *end
, const void *data
)
348 const struct imsm_orom
*imsm_mem
= NULL
;
349 int len
= (end
- start
);
350 struct pciExpDataStructFormat
*ptr
= (struct pciExpDataStructFormat
*)data
;
352 if (data
+ 0x18 > end
) {
353 dprintf("cannot find pciExpDataStruct \n");
357 dprintf("ptr->vendorID: %lx __le16_to_cpu(ptr->deviceID): %lx \n",
358 (ulong
) __le16_to_cpu(ptr
->vendorID
),
359 (ulong
) __le16_to_cpu(ptr
->deviceID
));
361 if (__le16_to_cpu(ptr
->vendorID
) != 0x8086)
364 for (offset
= 0; offset
< len
; offset
+= 4) {
365 const void *mem
= start
+ offset
;
367 if ((memcmp(mem
, IMSM_OROM_SIGNATURE
, 4) == 0)) {
376 struct orom_entry
*orom
= add_orom(imsm_mem
);
378 /* only PciDataStructure with revision 3 and above supports devices list. */
379 if (ptr
->pciDataStructRev
>= 3 && ptr
->devListOffset
) {
380 const __u16
*dev_list
= (void *)ptr
+ ptr
->devListOffset
;
383 for (i
= 0; dev_list
[i
] != 0; i
++)
384 add_orom_device_id(orom
, dev_list
[i
]);
386 add_orom_device_id(orom
, __le16_to_cpu(ptr
->deviceID
));
392 const struct imsm_orom
*imsm_platform_test(struct sys_dev
*hba
)
394 struct imsm_orom orom
= {
395 .signature
= IMSM_OROM_SIGNATURE
,
396 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
397 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
398 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
399 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
400 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
|
401 IMSM_OROM_SSS_256kB
| IMSM_OROM_SSS_512kB
|
402 IMSM_OROM_SSS_1MB
| IMSM_OROM_SSS_2MB
,
403 .dpa
= IMSM_OROM_DISKS_PER_ARRAY
,
404 .tds
= IMSM_OROM_TOTAL_DISKS
,
405 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
406 .vphba
= IMSM_OROM_VOLUMES_PER_HBA
408 orom
.attr
= orom
.rlc
| IMSM_OROM_ATTR_ChecksumVerify
;
410 if (check_env("IMSM_TEST_OROM_NORAID5")) {
411 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
412 IMSM_OROM_RLC_RAID10
;
414 if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba
->type
== SYS_DEV_SAS
)) {
415 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
416 IMSM_OROM_RLC_RAID10
;
418 if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba
->type
== SYS_DEV_SATA
)) {
419 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
420 IMSM_OROM_RLC_RAID10
;
423 struct orom_entry
*ret
= add_orom(&orom
);
425 add_orom_device_id(ret
, hba
->dev_id
);
430 static const struct imsm_orom
*find_imsm_hba_orom(struct sys_dev
*hba
)
434 if (check_env("IMSM_TEST_OROM"))
435 return imsm_platform_test(hba
);
437 /* return empty OROM capabilities in EFI test mode */
438 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
441 find_intel_devices();
443 if (intel_devices
== NULL
)
446 /* scan option-rom memory looking for an imsm signature */
447 if (check_env("IMSM_SAFE_OROM_SCAN"))
451 if (probe_roms_init(align
) != 0)
454 /* ignore return value - True is returned if both adapater roms are found */
455 scan_adapter_roms(scan
);
458 return get_orom_by_device_id(hba
->dev_id
);
461 #define GUID_STR_MAX 37 /* according to GUID format:
462 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
464 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
466 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
467 (b) & 0xff, ((b) >> 8) & 0xff, \
468 (c) & 0xff, ((c) >> 8) & 0xff, \
469 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
471 #define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
472 #define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
473 #define SCU_PROP "RstScuV"
474 #define AHCI_PROP "RstSataV"
475 #define AHCI_SSATA_PROP "RstsSatV"
476 #define AHCI_CSATA_PROP "RstCSatV"
477 #define VMD_PROP "RstUefiV"
479 #define VENDOR_GUID \
480 EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)
482 #define PCI_CLASS_RAID_CNTRL 0x010400
484 static int read_efi_var(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
487 char buf
[GUID_STR_MAX
];
491 snprintf(path
, PATH_MAX
, "%s/%s-%s", SYS_EFIVARS_PATH
, variable_name
, guid_str(buf
, guid
));
493 fd
= open(path
, O_RDONLY
);
497 /* read the variable attributes and ignore it */
498 n
= read(fd
, buf
, sizeof(__u32
));
504 /* read the variable data */
505 n
= read(fd
, buffer
, buf_size
);
513 static int read_efi_variable(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
516 char buf
[GUID_STR_MAX
];
518 ssize_t n
, var_data_len
;
520 /* Try to read the variable using the new efivarfs interface first.
521 * If that fails, fall back to the old sysfs-efivars interface. */
522 if (!read_efi_var(buffer
, buf_size
, variable_name
, guid
))
525 snprintf(path
, PATH_MAX
, "%s/%s-%s/size", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
527 dprintf("EFI VAR: path=%s\n", path
);
528 /* get size of variable data */
529 dfd
= open(path
, O_RDONLY
);
533 n
= read(dfd
, &buf
, sizeof(buf
));
540 var_data_len
= strtoul(buf
, NULL
, 16);
541 if ((errno
== ERANGE
&& (var_data_len
== LONG_MAX
))
542 || (errno
!= 0 && var_data_len
== 0))
546 snprintf(path
, PATH_MAX
, "%s/%s-%s/data", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
548 dprintf("EFI VAR: path=%s\n", path
);
549 dfd
= open(path
, O_RDONLY
);
553 n
= read(dfd
, buffer
, buf_size
);
555 if (n
!= var_data_len
|| n
< buf_size
) {
562 const struct imsm_orom
*find_imsm_efi(struct sys_dev
*hba
)
564 struct imsm_orom orom
;
565 struct orom_entry
*ret
;
568 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
569 return imsm_platform_test(hba
);
571 /* OROM test is set, return that there is no EFI capabilities */
572 if (check_env("IMSM_TEST_OROM"))
575 if (hba
->type
== SYS_DEV_SATA
&& hba
->class != PCI_CLASS_RAID_CNTRL
)
578 err
= read_efi_variable(&orom
, sizeof(orom
), hba
->type
== SYS_DEV_SAS
? SCU_PROP
: AHCI_PROP
, VENDOR_GUID
);
580 /* try to read variable for second AHCI controller */
581 if (err
&& hba
->type
== SYS_DEV_SATA
)
582 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_SSATA_PROP
, VENDOR_GUID
);
584 /* try to read variable for combined AHCI controllers */
585 if (err
&& hba
->type
== SYS_DEV_SATA
) {
586 static struct orom_entry
*csata
;
588 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_CSATA_PROP
, VENDOR_GUID
);
591 csata
= add_orom(&orom
);
592 add_orom_device_id(csata
, hba
->dev_id
);
593 csata
->type
= hba
->type
;
598 if (hba
->type
== SYS_DEV_VMD
) {
599 err
= read_efi_variable(&orom
, sizeof(orom
), VMD_PROP
, VENDOR_GUID
);
605 ret
= add_orom(&orom
);
606 add_orom_device_id(ret
, hba
->dev_id
);
607 ret
->type
= hba
->type
;
612 const struct imsm_orom
*find_imsm_nvme(struct sys_dev
*hba
)
614 static struct orom_entry
*nvme_orom
;
616 if (hba
->type
!= SYS_DEV_NVME
)
620 struct imsm_orom nvme_orom_compat
= {
621 .signature
= IMSM_NVME_OROM_COMPAT_SIGNATURE
,
622 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
623 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
624 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
625 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
626 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
,
627 .dpa
= IMSM_OROM_DISKS_PER_ARRAY_NVME
,
628 .tds
= IMSM_OROM_TOTAL_DISKS_NVME
,
629 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
630 .vphba
= IMSM_OROM_TOTAL_DISKS_NVME
/ 2 * IMSM_OROM_VOLUMES_PER_ARRAY
,
631 .attr
= IMSM_OROM_ATTR_2TB
| IMSM_OROM_ATTR_2TB_DISK
,
632 .driver_features
= IMSM_OROM_CAPABILITIES_EnterpriseSystem
634 nvme_orom
= add_orom(&nvme_orom_compat
);
636 add_orom_device_id(nvme_orom
, hba
->dev_id
);
637 nvme_orom
->type
= SYS_DEV_NVME
;
638 return &nvme_orom
->orom
;
641 const struct imsm_orom
*find_imsm_capability(struct sys_dev
*hba
)
643 const struct imsm_orom
*cap
= get_orom_by_device_id(hba
->dev_id
);
648 if (hba
->type
== SYS_DEV_NVME
)
649 return find_imsm_nvme(hba
);
650 if ((cap
= find_imsm_efi(hba
)) != NULL
)
652 if ((cap
= find_imsm_hba_orom(hba
)) != NULL
)
658 char *devt_to_devpath(dev_t dev
)
662 sprintf(device
, "/sys/dev/block/%d:%d/device", major(dev
), minor(dev
));
663 return realpath(device
, NULL
);
666 char *diskfd_to_devpath(int fd
)
668 /* return the device path for a disk, return NULL on error or fd
669 * refers to a partition
673 if (fstat(fd
, &st
) != 0)
675 if (!S_ISBLK(st
.st_mode
))
678 return devt_to_devpath(st
.st_rdev
);
681 int path_attached_to_hba(const char *disk_path
, const char *hba_path
)
685 if (check_env("IMSM_TEST_AHCI_DEV") ||
686 check_env("IMSM_TEST_SCU_DEV")) {
690 if (!disk_path
|| !hba_path
)
692 dprintf("hba: %s - disk: %s\n", hba_path
, disk_path
);
693 if (strncmp(disk_path
, hba_path
, strlen(hba_path
)) == 0)
701 int devt_attached_to_hba(dev_t dev
, const char *hba_path
)
703 char *disk_path
= devt_to_devpath(dev
);
704 int rc
= path_attached_to_hba(disk_path
, hba_path
);
712 int disk_attached_to_hba(int fd
, const char *hba_path
)
714 char *disk_path
= diskfd_to_devpath(fd
);
715 int rc
= path_attached_to_hba(disk_path
, hba_path
);
723 char *vmd_domain_to_controller(struct sys_dev
*hba
, char *buf
)
732 if (hba
->type
!= SYS_DEV_VMD
)
735 dir
= opendir("/sys/bus/pci/drivers/vmd");
739 for (ent
= readdir(dir
); ent
; ent
= readdir(dir
)) {
740 sprintf(path
, "/sys/bus/pci/drivers/vmd/%s/domain/device",
743 if (!realpath(path
, buf
))
746 if (strncmp(buf
, hba
->path
, strlen(buf
)) == 0) {
747 sprintf(path
, "/sys/bus/pci/drivers/vmd/%s", ent
->d_name
);
749 return realpath(path
, buf
);