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 struct sys_dev
*device_by_id_and_path(__u16 device_id
, const char *path
)
192 struct sys_dev
*iter
;
194 for (iter
= intel_devices
; iter
!= NULL
; iter
= iter
->next
)
195 if ((iter
->dev_id
== device_id
) && strstr(iter
->path
, path
))
200 static int devpath_to_ll(const char *dev_path
, const char *entry
, unsigned long long *val
)
202 char path
[strlen(dev_path
) + strlen(entry
) + 2];
206 sprintf(path
, "%s/%s", dev_path
, entry
);
208 fd
= open(path
, O_RDONLY
);
211 n
= sysfs_fd_get_ll(fd
, val
);
216 __u16
devpath_to_vendor(const char *dev_path
)
218 char path
[strlen(dev_path
) + strlen("/vendor") + 1];
224 sprintf(path
, "%s/vendor", dev_path
);
226 fd
= open(path
, O_RDONLY
);
230 n
= read(fd
, vendor
, sizeof(vendor
));
231 if (n
== sizeof(vendor
)) {
232 vendor
[n
- 1] = '\0';
233 id
= strtoul(vendor
, NULL
, 16);
240 struct sys_dev
*find_intel_devices(void)
242 struct sys_dev
*ahci
, *isci
, *nvme
;
244 if (valid_time
> time(0) - 10)
245 return intel_devices
;
248 free_sys_dev(&intel_devices
);
250 isci
= find_driver_devices("pci", "isci");
251 ahci
= find_driver_devices("pci", "ahci");
252 /* Searching for NVMe will return list of NVMe and VMD controllers */
253 nvme
= find_driver_devices("pci", "nvme");
255 if (!isci
&& !ahci
) {
259 struct sys_dev
*elem
= ahci
;
264 struct sys_dev
*elem
= ahci
;
272 intel_devices
= ahci
;
273 valid_time
= time(0);
274 return intel_devices
;
278 * PCI Expansion ROM Data Structure Format */
279 struct pciExpDataStructFormat
{
284 __u16 pciDataStructLen
;
285 __u8 pciDataStructRev
;
286 } __attribute__ ((packed
));
288 struct orom_entry
*orom_entries
;
290 const struct orom_entry
*get_orom_entry_by_device_id(__u16 dev_id
)
292 struct orom_entry
*entry
;
293 struct devid_list
*devid
;
295 for (entry
= orom_entries
; entry
; entry
= entry
->next
) {
296 for (devid
= entry
->devid_list
; devid
; devid
= devid
->next
) {
297 if (devid
->devid
== dev_id
)
305 const struct imsm_orom
*get_orom_by_device_id(__u16 dev_id
)
307 const struct orom_entry
*entry
= get_orom_entry_by_device_id(dev_id
);
315 static struct orom_entry
*add_orom(const struct imsm_orom
*orom
)
317 struct orom_entry
*list
;
318 struct orom_entry
*prev
= NULL
;
320 for (list
= orom_entries
; list
; prev
= list
, list
= list
->next
)
323 list
= xmalloc(sizeof(struct orom_entry
));
325 list
->devid_list
= NULL
;
336 static void add_orom_device_id(struct orom_entry
*entry
, __u16 dev_id
)
338 struct devid_list
*list
;
339 struct devid_list
*prev
= NULL
;
341 for (list
= entry
->devid_list
; list
; prev
= list
, list
= list
->next
) {
342 if (list
->devid
== dev_id
)
345 list
= xmalloc(sizeof(struct devid_list
));
346 list
->devid
= dev_id
;
350 entry
->devid_list
= list
;
355 static int scan(const void *start
, const void *end
, const void *data
)
358 const struct imsm_orom
*imsm_mem
= NULL
;
359 int len
= (end
- start
);
360 struct pciExpDataStructFormat
*ptr
= (struct pciExpDataStructFormat
*)data
;
362 if (data
+ 0x18 > end
) {
363 dprintf("cannot find pciExpDataStruct \n");
367 dprintf("ptr->vendorID: %lx __le16_to_cpu(ptr->deviceID): %lx \n",
368 (ulong
) __le16_to_cpu(ptr
->vendorID
),
369 (ulong
) __le16_to_cpu(ptr
->deviceID
));
371 if (__le16_to_cpu(ptr
->vendorID
) != 0x8086)
374 if (get_orom_by_device_id(ptr
->deviceID
))
377 for (offset
= 0; offset
< len
; offset
+= 4) {
378 const void *mem
= start
+ offset
;
380 if ((memcmp(mem
, IMSM_OROM_SIGNATURE
, 4) == 0)) {
389 struct orom_entry
*orom
= add_orom(imsm_mem
);
391 /* only PciDataStructure with revision 3 and above supports devices list. */
392 if (ptr
->pciDataStructRev
>= 3 && ptr
->devListOffset
) {
393 const __u16
*dev_list
= (void *)ptr
+ ptr
->devListOffset
;
396 for (i
= 0; dev_list
[i
] != 0; i
++)
397 add_orom_device_id(orom
, dev_list
[i
]);
399 add_orom_device_id(orom
, __le16_to_cpu(ptr
->deviceID
));
405 const struct imsm_orom
*imsm_platform_test(struct sys_dev
*hba
)
407 struct imsm_orom orom
= {
408 .signature
= IMSM_OROM_SIGNATURE
,
409 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
410 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
411 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
412 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
413 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
|
414 IMSM_OROM_SSS_256kB
| IMSM_OROM_SSS_512kB
|
415 IMSM_OROM_SSS_1MB
| IMSM_OROM_SSS_2MB
,
416 .dpa
= IMSM_OROM_DISKS_PER_ARRAY
,
417 .tds
= IMSM_OROM_TOTAL_DISKS
,
418 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
419 .vphba
= IMSM_OROM_VOLUMES_PER_HBA
421 orom
.attr
= orom
.rlc
| IMSM_OROM_ATTR_ChecksumVerify
;
423 if (check_env("IMSM_TEST_OROM_NORAID5")) {
424 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
425 IMSM_OROM_RLC_RAID10
;
427 if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba
->type
== SYS_DEV_SAS
)) {
428 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
429 IMSM_OROM_RLC_RAID10
;
431 if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba
->type
== SYS_DEV_SATA
)) {
432 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
433 IMSM_OROM_RLC_RAID10
;
436 struct orom_entry
*ret
= add_orom(&orom
);
438 add_orom_device_id(ret
, hba
->dev_id
);
443 static const struct imsm_orom
*find_imsm_hba_orom(struct sys_dev
*hba
)
447 if (check_env("IMSM_TEST_OROM"))
448 return imsm_platform_test(hba
);
450 /* return empty OROM capabilities in EFI test mode */
451 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
454 find_intel_devices();
456 if (intel_devices
== NULL
)
459 /* scan option-rom memory looking for an imsm signature */
460 if (check_env("IMSM_SAFE_OROM_SCAN"))
464 if (probe_roms_init(align
) != 0)
467 /* ignore return value - True is returned if both adapater roms are found */
468 scan_adapter_roms(scan
);
471 return get_orom_by_device_id(hba
->dev_id
);
474 #define GUID_STR_MAX 37 /* according to GUID format:
475 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
477 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
479 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
480 (b) & 0xff, ((b) >> 8) & 0xff, \
481 (c) & 0xff, ((c) >> 8) & 0xff, \
482 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
484 #define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
485 #define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
486 #define SCU_PROP "RstScuV"
487 #define AHCI_PROP "RstSataV"
488 #define AHCI_SSATA_PROP "RstsSatV"
489 #define AHCI_CSATA_PROP "RstCSatV"
490 #define VMD_PROP "RstUefiV"
492 #define VENDOR_GUID \
493 EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)
495 #define PCI_CLASS_RAID_CNTRL 0x010400
497 static int read_efi_var(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
500 char buf
[GUID_STR_MAX
];
504 snprintf(path
, PATH_MAX
, "%s/%s-%s", SYS_EFIVARS_PATH
, variable_name
, guid_str(buf
, guid
));
506 fd
= open(path
, O_RDONLY
);
510 /* read the variable attributes and ignore it */
511 n
= read(fd
, buf
, sizeof(__u32
));
517 /* read the variable data */
518 n
= read(fd
, buffer
, buf_size
);
526 static int read_efi_variable(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
529 char buf
[GUID_STR_MAX
];
531 ssize_t n
, var_data_len
;
533 /* Try to read the variable using the new efivarfs interface first.
534 * If that fails, fall back to the old sysfs-efivars interface. */
535 if (!read_efi_var(buffer
, buf_size
, variable_name
, guid
))
538 snprintf(path
, PATH_MAX
, "%s/%s-%s/size", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
540 dprintf("EFI VAR: path=%s\n", path
);
541 /* get size of variable data */
542 dfd
= open(path
, O_RDONLY
);
546 n
= read(dfd
, &buf
, sizeof(buf
));
553 var_data_len
= strtoul(buf
, NULL
, 16);
554 if ((errno
== ERANGE
&& (var_data_len
== LONG_MAX
)) ||
555 (errno
!= 0 && var_data_len
== 0))
559 snprintf(path
, PATH_MAX
, "%s/%s-%s/data", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
561 dprintf("EFI VAR: path=%s\n", path
);
562 dfd
= open(path
, O_RDONLY
);
566 n
= read(dfd
, buffer
, buf_size
);
568 if (n
!= var_data_len
|| n
< buf_size
) {
575 const struct imsm_orom
*find_imsm_efi(struct sys_dev
*hba
)
577 struct imsm_orom orom
;
578 struct orom_entry
*ret
;
581 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
582 return imsm_platform_test(hba
);
584 /* OROM test is set, return that there is no EFI capabilities */
585 if (check_env("IMSM_TEST_OROM"))
588 if (hba
->type
== SYS_DEV_SATA
&& hba
->class != PCI_CLASS_RAID_CNTRL
)
591 err
= read_efi_variable(&orom
, sizeof(orom
), hba
->type
== SYS_DEV_SAS
? SCU_PROP
: AHCI_PROP
, VENDOR_GUID
);
593 /* try to read variable for second AHCI controller */
594 if (err
&& hba
->type
== SYS_DEV_SATA
)
595 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_SSATA_PROP
, VENDOR_GUID
);
597 /* try to read variable for combined AHCI controllers */
598 if (err
&& hba
->type
== SYS_DEV_SATA
) {
599 static struct orom_entry
*csata
;
601 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_CSATA_PROP
, VENDOR_GUID
);
604 csata
= add_orom(&orom
);
605 add_orom_device_id(csata
, hba
->dev_id
);
606 csata
->type
= hba
->type
;
611 if (hba
->type
== SYS_DEV_VMD
) {
612 err
= read_efi_variable(&orom
, sizeof(orom
), VMD_PROP
, VENDOR_GUID
);
618 ret
= add_orom(&orom
);
619 add_orom_device_id(ret
, hba
->dev_id
);
620 ret
->type
= hba
->type
;
625 const struct imsm_orom
*find_imsm_nvme(struct sys_dev
*hba
)
627 static struct orom_entry
*nvme_orom
;
629 if (hba
->type
!= SYS_DEV_NVME
)
633 struct imsm_orom nvme_orom_compat
= {
634 .signature
= IMSM_NVME_OROM_COMPAT_SIGNATURE
,
635 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
636 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
637 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
638 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
639 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
,
640 .dpa
= IMSM_OROM_DISKS_PER_ARRAY_NVME
,
641 .tds
= IMSM_OROM_TOTAL_DISKS_NVME
,
642 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
643 .vphba
= IMSM_OROM_TOTAL_DISKS_NVME
/ 2 * IMSM_OROM_VOLUMES_PER_ARRAY
,
644 .attr
= IMSM_OROM_ATTR_2TB
| IMSM_OROM_ATTR_2TB_DISK
,
645 .driver_features
= IMSM_OROM_CAPABILITIES_EnterpriseSystem
647 nvme_orom
= add_orom(&nvme_orom_compat
);
649 add_orom_device_id(nvme_orom
, hba
->dev_id
);
650 nvme_orom
->type
= SYS_DEV_NVME
;
651 return &nvme_orom
->orom
;
654 const struct imsm_orom
*find_imsm_capability(struct sys_dev
*hba
)
656 const struct imsm_orom
*cap
= get_orom_by_device_id(hba
->dev_id
);
661 if (hba
->type
== SYS_DEV_NVME
)
662 return find_imsm_nvme(hba
);
663 if ((cap
= find_imsm_efi(hba
)) != NULL
)
665 if ((cap
= find_imsm_hba_orom(hba
)) != NULL
)
671 char *devt_to_devpath(dev_t dev
)
675 sprintf(device
, "/sys/dev/block/%d:%d/device", major(dev
), minor(dev
));
676 return realpath(device
, NULL
);
679 char *diskfd_to_devpath(int fd
)
681 /* return the device path for a disk, return NULL on error or fd
682 * refers to a partition
686 if (fstat(fd
, &st
) != 0)
688 if (!S_ISBLK(st
.st_mode
))
691 return devt_to_devpath(st
.st_rdev
);
694 int path_attached_to_hba(const char *disk_path
, const char *hba_path
)
698 if (check_env("IMSM_TEST_AHCI_DEV") ||
699 check_env("IMSM_TEST_SCU_DEV")) {
703 if (!disk_path
|| !hba_path
)
705 dprintf("hba: %s - disk: %s\n", hba_path
, disk_path
);
706 if (strncmp(disk_path
, hba_path
, strlen(hba_path
)) == 0)
714 int devt_attached_to_hba(dev_t dev
, const char *hba_path
)
716 char *disk_path
= devt_to_devpath(dev
);
717 int rc
= path_attached_to_hba(disk_path
, hba_path
);
725 int disk_attached_to_hba(int fd
, const char *hba_path
)
727 char *disk_path
= diskfd_to_devpath(fd
);
728 int rc
= path_attached_to_hba(disk_path
, hba_path
);
736 char *vmd_domain_to_controller(struct sys_dev
*hba
, char *buf
)
745 if (hba
->type
!= SYS_DEV_VMD
)
748 dir
= opendir("/sys/bus/pci/drivers/vmd");
752 for (ent
= readdir(dir
); ent
; ent
= readdir(dir
)) {
753 sprintf(path
, "/sys/bus/pci/drivers/vmd/%s/domain/device",
756 if (!realpath(path
, buf
))
759 if (strncmp(buf
, hba
->path
, strlen(buf
)) == 0) {
760 sprintf(path
, "/sys/bus/pci/drivers/vmd/%s", ent
->d_name
);
762 return realpath(path
, buf
);