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 __u16
devpath_to_vendor(const char *dev_path
);
38 static void free_sys_dev(struct sys_dev
**list
)
41 struct sys_dev
*next
= (*list
)->next
;
50 struct sys_dev
*find_driver_devices(const char *bus
, const char *driver
)
52 /* search sysfs for devices driven by 'driver' */
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;
64 if (strcmp(driver
, "isci") == 0)
66 else if (strcmp(driver
, "ahci") == 0)
68 else if (strcmp(driver
, "nvme") == 0)
71 type
= SYS_DEV_UNKNOWN
;
73 sprintf(path
, "/sys/bus/%s/drivers/%s", bus
, driver
);
74 driver_dir
= opendir(path
);
77 for (de
= readdir(driver_dir
); de
; de
= readdir(driver_dir
)) {
80 /* is 'de' a device? check that the 'subsystem' link exists and
81 * that its target matches 'bus'
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
))
89 c
= strrchr(link
, '/');
92 if (strncmp(bus
, c
+1, strlen(bus
)) != 0)
95 sprintf(path
, "/sys/bus/%s/drivers/%s/%s",
96 bus
, driver
, de
->d_name
);
98 /* if it's not Intel device skip it. */
99 if (devpath_to_vendor(path
) != 0x8086)
102 if (devpath_to_ll(path
, "device", &dev_id
) != 0)
105 if (devpath_to_ll(path
, "class", &class) != 0)
108 /* start / add list entry */
110 head
= xmalloc(sizeof(*head
));
113 list
->next
= xmalloc(sizeof(*head
));
122 list
->dev_id
= (__u16
) dev_id
;
123 list
->class = (__u32
) class;
125 list
->path
= realpath(path
, NULL
);
127 if ((list
->pci_id
= strrchr(list
->path
, '/')) != NULL
)
130 closedir(driver_dir
);
134 static struct sys_dev
*intel_devices
=NULL
;
135 static time_t valid_time
= 0;
137 struct sys_dev
*device_by_id(__u16 device_id
)
139 struct sys_dev
*iter
;
141 for (iter
= intel_devices
; iter
!= NULL
; iter
= iter
->next
)
142 if (iter
->dev_id
== device_id
)
147 static int devpath_to_ll(const char *dev_path
, const char *entry
, unsigned long long *val
)
149 char path
[strlen(dev_path
) + strlen(entry
) + 2];
153 sprintf(path
, "%s/%s", dev_path
, entry
);
155 fd
= open(path
, O_RDONLY
);
158 n
= sysfs_fd_get_ll(fd
, val
);
163 static __u16
devpath_to_vendor(const char *dev_path
)
165 char path
[strlen(dev_path
) + strlen("/vendor") + 1];
171 sprintf(path
, "%s/vendor", dev_path
);
173 fd
= open(path
, O_RDONLY
);
177 n
= read(fd
, vendor
, sizeof(vendor
));
178 if (n
== sizeof(vendor
)) {
179 vendor
[n
- 1] = '\0';
180 id
= strtoul(vendor
, NULL
, 16);
187 struct sys_dev
*find_intel_devices(void)
189 struct sys_dev
*ahci
, *isci
, *nvme
;
191 if (valid_time
> time(0) - 10)
192 return intel_devices
;
195 free_sys_dev(&intel_devices
);
197 isci
= find_driver_devices("pci", "isci");
198 ahci
= find_driver_devices("pci", "ahci");
199 nvme
= find_driver_devices("pci", "nvme");
201 if (!isci
&& !ahci
) {
205 struct sys_dev
*elem
= ahci
;
210 struct sys_dev
*elem
= ahci
;
218 intel_devices
= ahci
;
219 valid_time
= time(0);
220 return intel_devices
;
224 * PCI Expansion ROM Data Structure Format */
225 struct pciExpDataStructFormat
{
230 __u16 pciDataStructLen
;
231 __u8 pciDataStructRev
;
232 } __attribute__ ((packed
));
234 struct orom_entry
*orom_entries
;
236 const struct imsm_orom
*get_orom_by_device_id(__u16 dev_id
)
238 struct orom_entry
*entry
;
239 struct devid_list
*devid
;
241 for (entry
= orom_entries
; entry
; entry
= entry
->next
) {
242 for (devid
= entry
->devid_list
; devid
; devid
= devid
->next
) {
243 if (devid
->devid
== dev_id
)
251 static struct orom_entry
*add_orom(const struct imsm_orom
*orom
)
253 struct orom_entry
*list
;
254 struct orom_entry
*prev
= NULL
;
256 for (list
= orom_entries
; list
; prev
= list
, list
= list
->next
)
259 list
= xmalloc(sizeof(struct orom_entry
));
261 list
->devid_list
= NULL
;
272 static void add_orom_device_id(struct orom_entry
*entry
, __u16 dev_id
)
274 struct devid_list
*list
;
275 struct devid_list
*prev
= NULL
;
277 for (list
= entry
->devid_list
; list
; prev
= list
, list
= list
->next
) {
278 if (list
->devid
== dev_id
)
281 list
= xmalloc(sizeof(struct devid_list
));
282 list
->devid
= dev_id
;
286 entry
->devid_list
= list
;
291 static int scan(const void *start
, const void *end
, const void *data
)
294 const struct imsm_orom
*imsm_mem
= NULL
;
295 int len
= (end
- start
);
296 struct pciExpDataStructFormat
*ptr
= (struct pciExpDataStructFormat
*)data
;
298 if (data
+ 0x18 > end
) {
299 dprintf("cannot find pciExpDataStruct \n");
303 dprintf("ptr->vendorID: %lx __le16_to_cpu(ptr->deviceID): %lx \n",
304 (ulong
) __le16_to_cpu(ptr
->vendorID
),
305 (ulong
) __le16_to_cpu(ptr
->deviceID
));
307 if (__le16_to_cpu(ptr
->vendorID
) != 0x8086)
310 for (offset
= 0; offset
< len
; offset
+= 4) {
311 const void *mem
= start
+ offset
;
313 if ((memcmp(mem
, IMSM_OROM_SIGNATURE
, 4) == 0)) {
322 struct orom_entry
*orom
= add_orom(imsm_mem
);
324 /* only PciDataStructure with revision 3 and above supports devices list. */
325 if (ptr
->pciDataStructRev
>= 3 && ptr
->devListOffset
) {
326 const __u16
*dev_list
= (void *)ptr
+ ptr
->devListOffset
;
329 for (i
= 0; dev_list
[i
] != 0; i
++)
330 add_orom_device_id(orom
, dev_list
[i
]);
332 add_orom_device_id(orom
, __le16_to_cpu(ptr
->deviceID
));
338 const struct imsm_orom
*imsm_platform_test(struct sys_dev
*hba
)
340 struct imsm_orom orom
= {
341 .signature
= IMSM_OROM_SIGNATURE
,
342 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
343 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
344 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
345 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
346 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
|
347 IMSM_OROM_SSS_256kB
| IMSM_OROM_SSS_512kB
|
348 IMSM_OROM_SSS_1MB
| IMSM_OROM_SSS_2MB
,
349 .dpa
= IMSM_OROM_DISKS_PER_ARRAY
,
350 .tds
= IMSM_OROM_TOTAL_DISKS
,
351 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
352 .vphba
= IMSM_OROM_VOLUMES_PER_HBA
354 orom
.attr
= orom
.rlc
| IMSM_OROM_ATTR_ChecksumVerify
;
356 if (check_env("IMSM_TEST_OROM_NORAID5")) {
357 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
358 IMSM_OROM_RLC_RAID10
;
360 if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba
->type
== SYS_DEV_SAS
)) {
361 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
362 IMSM_OROM_RLC_RAID10
;
364 if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba
->type
== SYS_DEV_SATA
)) {
365 orom
.rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
366 IMSM_OROM_RLC_RAID10
;
369 struct orom_entry
*ret
= add_orom(&orom
);
371 add_orom_device_id(ret
, hba
->dev_id
);
376 static const struct imsm_orom
*find_imsm_hba_orom(struct sys_dev
*hba
)
380 if (check_env("IMSM_TEST_OROM"))
381 return imsm_platform_test(hba
);
383 /* return empty OROM capabilities in EFI test mode */
384 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
387 find_intel_devices();
389 if (intel_devices
== NULL
)
392 /* scan option-rom memory looking for an imsm signature */
393 if (check_env("IMSM_SAFE_OROM_SCAN"))
397 if (probe_roms_init(align
) != 0)
400 /* ignore return value - True is returned if both adapater roms are found */
401 scan_adapter_roms(scan
);
404 return get_orom_by_device_id(hba
->dev_id
);
407 #define GUID_STR_MAX 37 /* according to GUID format:
408 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
410 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
412 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
413 (b) & 0xff, ((b) >> 8) & 0xff, \
414 (c) & 0xff, ((c) >> 8) & 0xff, \
415 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
417 #define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
418 #define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
419 #define SCU_PROP "RstScuV"
420 #define AHCI_PROP "RstSataV"
421 #define AHCI_SSATA_PROP "RstsSatV"
422 #define AHCI_CSATA_PROP "RstCSatV"
424 #define VENDOR_GUID \
425 EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)
427 #define PCI_CLASS_RAID_CNTRL 0x010400
429 static int read_efi_var(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
432 char buf
[GUID_STR_MAX
];
436 snprintf(path
, PATH_MAX
, "%s/%s-%s", SYS_EFIVARS_PATH
, variable_name
, guid_str(buf
, guid
));
438 fd
= open(path
, O_RDONLY
);
442 /* read the variable attributes and ignore it */
443 n
= read(fd
, buf
, sizeof(__u32
));
449 /* read the variable data */
450 n
= read(fd
, buffer
, buf_size
);
458 static int read_efi_variable(void *buffer
, ssize_t buf_size
, char *variable_name
, struct efi_guid guid
)
461 char buf
[GUID_STR_MAX
];
463 ssize_t n
, var_data_len
;
465 /* Try to read the variable using the new efivarfs interface first.
466 * If that fails, fall back to the old sysfs-efivars interface. */
467 if (!read_efi_var(buffer
, buf_size
, variable_name
, guid
))
470 snprintf(path
, PATH_MAX
, "%s/%s-%s/size", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
472 dprintf("EFI VAR: path=%s\n", path
);
473 /* get size of variable data */
474 dfd
= open(path
, O_RDONLY
);
478 n
= read(dfd
, &buf
, sizeof(buf
));
485 var_data_len
= strtoul(buf
, NULL
, 16);
486 if ((errno
== ERANGE
&& (var_data_len
== LONG_MAX
))
487 || (errno
!= 0 && var_data_len
== 0))
491 snprintf(path
, PATH_MAX
, "%s/%s-%s/data", SYS_EFI_VAR_PATH
, variable_name
, guid_str(buf
, guid
));
493 dprintf("EFI VAR: path=%s\n", path
);
494 dfd
= open(path
, O_RDONLY
);
498 n
= read(dfd
, buffer
, buf_size
);
500 if (n
!= var_data_len
|| n
< buf_size
) {
507 const struct imsm_orom
*find_imsm_efi(struct sys_dev
*hba
)
509 struct imsm_orom orom
;
510 struct orom_entry
*ret
;
513 if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
514 return imsm_platform_test(hba
);
516 /* OROM test is set, return that there is no EFI capabilities */
517 if (check_env("IMSM_TEST_OROM"))
520 if (hba
->type
== SYS_DEV_SATA
&& hba
->class != PCI_CLASS_RAID_CNTRL
)
523 err
= read_efi_variable(&orom
, sizeof(orom
), hba
->type
== SYS_DEV_SAS
? SCU_PROP
: AHCI_PROP
, VENDOR_GUID
);
525 /* try to read variable for second AHCI controller */
526 if (err
&& hba
->type
== SYS_DEV_SATA
)
527 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_SSATA_PROP
, VENDOR_GUID
);
529 /* try to read variable for combined AHCI controllers */
530 if (err
&& hba
->type
== SYS_DEV_SATA
) {
531 static struct orom_entry
*csata
;
533 err
= read_efi_variable(&orom
, sizeof(orom
), AHCI_CSATA_PROP
, VENDOR_GUID
);
536 csata
= add_orom(&orom
);
537 add_orom_device_id(csata
, hba
->dev_id
);
545 ret
= add_orom(&orom
);
546 add_orom_device_id(ret
, hba
->dev_id
);
551 const struct imsm_orom
*find_imsm_nvme(struct sys_dev
*hba
)
553 static struct orom_entry
*nvme_orom
;
555 if (hba
->type
!= SYS_DEV_NVME
)
559 struct imsm_orom nvme_orom_compat
= {
560 .signature
= IMSM_NVME_OROM_COMPAT_SIGNATURE
,
561 .rlc
= IMSM_OROM_RLC_RAID0
| IMSM_OROM_RLC_RAID1
|
562 IMSM_OROM_RLC_RAID10
| IMSM_OROM_RLC_RAID5
,
563 .sss
= IMSM_OROM_SSS_4kB
| IMSM_OROM_SSS_8kB
|
564 IMSM_OROM_SSS_16kB
| IMSM_OROM_SSS_32kB
|
565 IMSM_OROM_SSS_64kB
| IMSM_OROM_SSS_128kB
,
566 .dpa
= IMSM_OROM_DISKS_PER_ARRAY_NVME
,
567 .tds
= IMSM_OROM_TOTAL_DISKS_NVME
,
568 .vpa
= IMSM_OROM_VOLUMES_PER_ARRAY
,
569 .vphba
= IMSM_OROM_TOTAL_DISKS_NVME
/ 2 * IMSM_OROM_VOLUMES_PER_ARRAY
,
570 .attr
= IMSM_OROM_ATTR_2TB
| IMSM_OROM_ATTR_2TB_DISK
,
571 .driver_features
= IMSM_OROM_CAPABILITIES_EnterpriseSystem
573 nvme_orom
= add_orom(&nvme_orom_compat
);
575 add_orom_device_id(nvme_orom
, hba
->dev_id
);
576 return &nvme_orom
->orom
;
579 const struct imsm_orom
*find_imsm_capability(struct sys_dev
*hba
)
581 const struct imsm_orom
*cap
= get_orom_by_device_id(hba
->dev_id
);
586 if (hba
->type
== SYS_DEV_NVME
)
587 return find_imsm_nvme(hba
);
588 if ((cap
= find_imsm_efi(hba
)) != NULL
)
590 if ((cap
= find_imsm_hba_orom(hba
)) != NULL
)
596 char *devt_to_devpath(dev_t dev
)
600 sprintf(device
, "/sys/dev/block/%d:%d/device", major(dev
), minor(dev
));
601 return realpath(device
, NULL
);
604 char *diskfd_to_devpath(int fd
)
606 /* return the device path for a disk, return NULL on error or fd
607 * refers to a partition
611 if (fstat(fd
, &st
) != 0)
613 if (!S_ISBLK(st
.st_mode
))
616 return devt_to_devpath(st
.st_rdev
);
619 int path_attached_to_hba(const char *disk_path
, const char *hba_path
)
623 if (check_env("IMSM_TEST_AHCI_DEV") ||
624 check_env("IMSM_TEST_SCU_DEV")) {
628 if (!disk_path
|| !hba_path
)
630 dprintf("hba: %s - disk: %s\n", hba_path
, disk_path
);
631 if (strncmp(disk_path
, hba_path
, strlen(hba_path
)) == 0)
639 int devt_attached_to_hba(dev_t dev
, const char *hba_path
)
641 char *disk_path
= devt_to_devpath(dev
);
642 int rc
= path_attached_to_hba(disk_path
, hba_path
);
650 int disk_attached_to_hba(int fd
, const char *hba_path
)
652 char *disk_path
= diskfd_to_devpath(fd
);
653 int rc
= path_attached_to_hba(disk_path
, hba_path
);