[thirdparty/mdadm.git] / platform-intel.c

/*
 * Intel(R) Matrix Storage Manager hardware and firmware support routines
 *
 * Copyright (C) 2008 Intel Corporation
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 */
#include "mdadm.h"
#include "platform-intel.h"
#include "probe_roms.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <dirent.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <limits.h>

static int devpath_to_ll(const char *dev_path, const char *entry,
			 unsigned long long *val);

static __u16 devpath_to_vendor(const char *dev_path);

static void free_sys_dev(struct sys_dev **list)
{
	while (*list) {
		struct sys_dev *next = (*list)->next;

		if ((*list)->path)
			free((*list)->path);
		free(*list);
		*list = next;
	}
}

struct sys_dev *find_driver_devices(const char *bus, const char *driver)
{
	/* search sysfs for devices driven by 'driver' */
	char path[292];
	char link[256];
	char *c;
	DIR *driver_dir;
	struct dirent *de;
	struct sys_dev *head = NULL;
	struct sys_dev *list = NULL;
	enum sys_dev_type type;
	unsigned long long dev_id;
	unsigned long long class;

	if (strcmp(driver, "isci") == 0)
		type = SYS_DEV_SAS;
	else if (strcmp(driver, "ahci") == 0)
		type = SYS_DEV_SATA;
	else if (strcmp(driver, "nvme") == 0)
		type = SYS_DEV_NVME;
	else
		type = SYS_DEV_UNKNOWN;

	sprintf(path, "/sys/bus/%s/drivers/%s", bus, driver);
	driver_dir = opendir(path);
	if (!driver_dir)
		return NULL;
	for (de = readdir(driver_dir); de; de = readdir(driver_dir)) {
		int n;

		/* is 'de' a device? check that the 'subsystem' link exists and
		 * that its target matches 'bus'
		 */
		sprintf(path, "/sys/bus/%s/drivers/%s/%s/subsystem",
			bus, driver, de->d_name);
		n = readlink(path, link, sizeof(link));
		if (n < 0 || n >= (int)sizeof(link))
			continue;
		link[n] = '\0';
		c = strrchr(link, '/');
		if (!c)
			continue;
		if (strncmp(bus, c+1, strlen(bus)) != 0)
			continue;

		sprintf(path, "/sys/bus/%s/drivers/%s/%s",
			bus, driver, de->d_name);

		/* if it's not Intel device skip it. */
		if (devpath_to_vendor(path) != 0x8086)
			continue;

		if (devpath_to_ll(path, "device", &dev_id) != 0)
			continue;

		if (devpath_to_ll(path, "class", &class) != 0)
			continue;

		/* start / add list entry */
		if (!head) {
			head = xmalloc(sizeof(*head));
			list = head;
		} else {
			list->next = xmalloc(sizeof(*head));
			list = list->next;
		}

		if (!list) {
			free_sys_dev(&head);
			break;
		}

		list->dev_id = (__u16) dev_id;
		list->class = (__u32) class;
		list->type = type;
		list->path = realpath(path, NULL);
		list->next = NULL;
		if ((list->pci_id = strrchr(list->path, '/')) != NULL)
			list->pci_id++;
	}
	closedir(driver_dir);
	return head;
}

static struct sys_dev *intel_devices=NULL;
static time_t valid_time = 0;

struct sys_dev *device_by_id(__u16 device_id)
{
	struct sys_dev *iter;

	for (iter = intel_devices; iter != NULL; iter = iter->next)
		if (iter->dev_id == device_id)
			return iter;
	return NULL;
}

static int devpath_to_ll(const char *dev_path, const char *entry, unsigned long long *val)
{
	char path[strlen(dev_path) + strlen(entry) + 2];
	int fd;
	int n;

	sprintf(path, "%s/%s", dev_path, entry);

	fd = open(path, O_RDONLY);
	if (fd < 0)
		return -1;
	n = sysfs_fd_get_ll(fd, val);
	close(fd);
	return n;
}

static __u16 devpath_to_vendor(const char *dev_path)
{
	char path[strlen(dev_path) + strlen("/vendor") + 1];
	char vendor[7];
	int fd;
	__u16 id = 0xffff;
	int n;

	sprintf(path, "%s/vendor", dev_path);

	fd = open(path, O_RDONLY);
	if (fd < 0)
		return 0xffff;

	n = read(fd, vendor, sizeof(vendor));
	if (n == sizeof(vendor)) {
		vendor[n - 1] = '\0';
		id = strtoul(vendor, NULL, 16);
	}
	close(fd);

	return id;
}

struct sys_dev *find_intel_devices(void)
{
	struct sys_dev *ahci, *isci, *nvme;

	if (valid_time > time(0) - 10)
		return intel_devices;

	if (intel_devices)
		free_sys_dev(&intel_devices);

	isci = find_driver_devices("pci", "isci");
	ahci = find_driver_devices("pci", "ahci");
	nvme = find_driver_devices("pci", "nvme");

	if (!isci && !ahci) {
		ahci = nvme;
	} else if (!ahci) {
		ahci = isci;
		struct sys_dev *elem = ahci;
		while (elem->next)
			elem = elem->next;
		elem->next = nvme;
	} else {
		struct sys_dev *elem = ahci;
		while (elem->next)
			elem = elem->next;
		elem->next = isci;
		while (elem->next)
			elem = elem->next;
		elem->next = nvme;
	}
	intel_devices = ahci;
	valid_time = time(0);
	return intel_devices;
}

/*
 * PCI Expansion ROM Data Structure Format */
struct pciExpDataStructFormat {
	__u8  ver[4];
	__u16 vendorID;
	__u16 deviceID;
	__u16 devListOffset;
} __attribute__ ((packed));

struct orom_entry *orom_entries;

const struct imsm_orom *get_orom_by_device_id(__u16 dev_id)
{
	struct orom_entry *entry;
	struct devid_list *devid;

	for (entry = orom_entries; entry; entry = entry->next) {
		for (devid = entry->devid_list; devid; devid = devid->next) {
			if (devid->devid == dev_id)
				return &entry->orom;
		}
	}

	return NULL;
}

static struct orom_entry *add_orom(const struct imsm_orom *orom)
{
	struct orom_entry *list;
	struct orom_entry *prev = NULL;

	for (list = orom_entries; list; prev = list, list = list->next)
		;

	list = xmalloc(sizeof(struct orom_entry));
	list->orom = *orom;
	list->devid_list = NULL;
	list->next = NULL;

	if (prev == NULL)
		orom_entries = list;
	else
		prev->next = list;

	return list;
}

static void add_orom_device_id(struct orom_entry *entry, __u16 dev_id)
{
	struct devid_list *list;
	struct devid_list *prev = NULL;

	for (list = entry->devid_list; list; prev = list, list = list->next) {
		if (list->devid == dev_id)
			return;
	}
	list = xmalloc(sizeof(struct devid_list));
	list->devid = dev_id;
	list->next = NULL;

	if (prev == NULL)
		entry->devid_list = list;
	else
		prev->next = list;
}

static int scan(const void *start, const void *end, const void *data)
{
	int offset;
	const struct imsm_orom *imsm_mem = NULL;
	int len = (end - start);
	struct pciExpDataStructFormat *ptr= (struct pciExpDataStructFormat *)data;

	if (data + 0x18 > end) {
		dprintf("cannot find pciExpDataStruct \n");
		return 0;
	}

	dprintf("ptr->vendorID: %lx __le16_to_cpu(ptr->deviceID): %lx \n",
		(ulong) __le16_to_cpu(ptr->vendorID),
		(ulong) __le16_to_cpu(ptr->deviceID));

	if (__le16_to_cpu(ptr->vendorID) != 0x8086)
		return 0;

	for (offset = 0; offset < len; offset += 4) {
		const void *mem = start + offset;

		if ((memcmp(mem, IMSM_OROM_SIGNATURE, 4) == 0)) {
			imsm_mem = mem;
			break;
		}
	}

	if (!imsm_mem)
		return 0;

	struct orom_entry *orom = add_orom(imsm_mem);

	if (ptr->devListOffset) {
		const __u16 *dev_list = (void *)ptr + ptr->devListOffset;
		int i;

		for (i = 0; dev_list[i] != 0; i++)
			add_orom_device_id(orom, dev_list[i]);
	} else {
		add_orom_device_id(orom, __le16_to_cpu(ptr->deviceID));
	}

	return 0;
}

const struct imsm_orom *imsm_platform_test(struct sys_dev *hba)
{
	struct imsm_orom orom = {
		.signature = IMSM_OROM_SIGNATURE,
		.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
					IMSM_OROM_RLC_RAID10 | IMSM_OROM_RLC_RAID5,
		.sss = IMSM_OROM_SSS_4kB | IMSM_OROM_SSS_8kB |
					IMSM_OROM_SSS_16kB | IMSM_OROM_SSS_32kB |
					IMSM_OROM_SSS_64kB | IMSM_OROM_SSS_128kB |
					IMSM_OROM_SSS_256kB | IMSM_OROM_SSS_512kB |
					IMSM_OROM_SSS_1MB | IMSM_OROM_SSS_2MB,
		.dpa = IMSM_OROM_DISKS_PER_ARRAY,
		.tds = IMSM_OROM_TOTAL_DISKS,
		.vpa = IMSM_OROM_VOLUMES_PER_ARRAY,
		.vphba = IMSM_OROM_VOLUMES_PER_HBA
	};
	orom.attr = orom.rlc | IMSM_OROM_ATTR_ChecksumVerify;

	if (check_env("IMSM_TEST_OROM_NORAID5")) {
		orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
				IMSM_OROM_RLC_RAID10;
	}
	if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba->type == SYS_DEV_SAS)) {
		orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
				IMSM_OROM_RLC_RAID10;
	}
	if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba->type == SYS_DEV_SATA)) {
		orom.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
				IMSM_OROM_RLC_RAID10;
	}

	struct orom_entry *ret = add_orom(&orom);

	add_orom_device_id(ret, hba->dev_id);

	return &ret->orom;
}

static const struct imsm_orom *find_imsm_hba_orom(struct sys_dev *hba)
{
	unsigned long align;

	if (check_env("IMSM_TEST_OROM"))
		return imsm_platform_test(hba);

	/* return empty OROM capabilities in EFI test mode */
	if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
		return NULL;

	find_intel_devices();

	if (intel_devices == NULL)
		return NULL;

	/* scan option-rom memory looking for an imsm signature */
	if (check_env("IMSM_SAFE_OROM_SCAN"))
		align = 2048;
	else
		align = 512;
	if (probe_roms_init(align) != 0)
		return NULL;
	probe_roms();
	/* ignore return value - True is returned if both adapater roms are found */
	scan_adapter_roms(scan);
	probe_roms_exit();

	return get_orom_by_device_id(hba->dev_id);
}

#define GUID_STR_MAX	37  /* according to GUID format:
			     * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */

#define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
((struct efi_guid) \
{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
  (b) & 0xff, ((b) >> 8) & 0xff, \
  (c) & 0xff, ((c) >> 8) & 0xff, \
  (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})

#define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
#define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
#define SCU_PROP "RstScuV"
#define AHCI_PROP "RstSataV"
#define AHCI_SSATA_PROP "RstsSatV"
#define AHCI_CSATA_PROP "RstCSatV"

#define VENDOR_GUID \
	EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)

#define PCI_CLASS_RAID_CNTRL 0x010400

static int read_efi_var(void *buffer, ssize_t buf_size, char *variable_name, struct efi_guid guid)
{
	char path[PATH_MAX];
	char buf[GUID_STR_MAX];
	int fd;
	ssize_t n;

	snprintf(path, PATH_MAX, "%s/%s-%s", SYS_EFIVARS_PATH, variable_name, guid_str(buf, guid));

	fd = open(path, O_RDONLY);
	if (fd < 0)
		return 1;

	/* read the variable attributes and ignore it */
	n = read(fd, buf, sizeof(__u32));
	if (n < 0) {
		close(fd);
		return 1;
	}

	/* read the variable data */
	n = read(fd, buffer, buf_size);
	close(fd);
	if (n < buf_size)
		return 1;

	return 0;
}

static int read_efi_variable(void *buffer, ssize_t buf_size, char *variable_name, struct efi_guid guid)
{
	char path[PATH_MAX];
	char buf[GUID_STR_MAX];
	int dfd;
	ssize_t n, var_data_len;

	/* Try to read the variable using the new efivarfs interface first.
	 * If that fails, fall back to the old sysfs-efivars interface. */
	if (!read_efi_var(buffer, buf_size, variable_name, guid))
		return 0;

	snprintf(path, PATH_MAX, "%s/%s-%s/size", SYS_EFI_VAR_PATH, variable_name, guid_str(buf, guid));

	dprintf("EFI VAR: path=%s\n", path);
	/* get size of variable data */
	dfd = open(path, O_RDONLY);
	if (dfd < 0)
		return 1;

	n = read(dfd, &buf, sizeof(buf));
	close(dfd);
	if (n < 0)
		return 1;
	buf[n] = '\0';

	errno = 0;
	var_data_len = strtoul(buf, NULL, 16);
	if ((errno == ERANGE && (var_data_len == LONG_MAX))
	    || (errno != 0 && var_data_len == 0))
		return 1;

	/* get data */
	snprintf(path, PATH_MAX, "%s/%s-%s/data", SYS_EFI_VAR_PATH, variable_name, guid_str(buf, guid));

	dprintf("EFI VAR: path=%s\n", path);
	dfd = open(path, O_RDONLY);
	if (dfd < 0)
		return 1;

	n = read(dfd, buffer, buf_size);
	close(dfd);
	if (n != var_data_len || n < buf_size) {
		return 1;
	}

	return 0;
}

const struct imsm_orom *find_imsm_efi(struct sys_dev *hba)
{
	struct imsm_orom orom;
	struct orom_entry *ret;
	int err;

	if (check_env("IMSM_TEST_AHCI_EFI") || check_env("IMSM_TEST_SCU_EFI"))
		return imsm_platform_test(hba);

	/* OROM test is set, return that there is no EFI capabilities */
	if (check_env("IMSM_TEST_OROM"))
		return NULL;

	if (hba->type == SYS_DEV_SATA && hba->class != PCI_CLASS_RAID_CNTRL)
		return NULL;

	err = read_efi_variable(&orom, sizeof(orom), hba->type == SYS_DEV_SAS ? SCU_PROP : AHCI_PROP, VENDOR_GUID);

	/* try to read variable for second AHCI controller */
	if (err && hba->type == SYS_DEV_SATA)
		err = read_efi_variable(&orom, sizeof(orom), AHCI_SSATA_PROP, VENDOR_GUID);

	/* try to read variable for combined AHCI controllers */
	if (err && hba->type == SYS_DEV_SATA) {
		static struct orom_entry *csata;

		err = read_efi_variable(&orom, sizeof(orom), AHCI_CSATA_PROP, VENDOR_GUID);
		if (!err) {
			if (!csata)
				csata = add_orom(&orom);
			add_orom_device_id(csata, hba->dev_id);
			return &csata->orom;
		}
	}

	if (err)
		return NULL;

	ret = add_orom(&orom);
	add_orom_device_id(ret, hba->dev_id);

	return &ret->orom;
}

const struct imsm_orom *find_imsm_nvme(struct sys_dev *hba)
{
	static struct orom_entry *nvme_orom;

	if (hba->type != SYS_DEV_NVME)
		return NULL;

	if (!nvme_orom) {
		struct imsm_orom nvme_orom_compat = {
			.signature = IMSM_NVME_OROM_COMPAT_SIGNATURE,
			.rlc = IMSM_OROM_RLC_RAID0 | IMSM_OROM_RLC_RAID1 |
						IMSM_OROM_RLC_RAID10 | IMSM_OROM_RLC_RAID5,
			.sss = IMSM_OROM_SSS_4kB | IMSM_OROM_SSS_8kB |
						IMSM_OROM_SSS_16kB | IMSM_OROM_SSS_32kB |
						IMSM_OROM_SSS_64kB | IMSM_OROM_SSS_128kB,
			.dpa = IMSM_OROM_DISKS_PER_ARRAY_NVME,
			.tds = IMSM_OROM_TOTAL_DISKS_NVME,
			.vpa = IMSM_OROM_VOLUMES_PER_ARRAY,
			.vphba = IMSM_OROM_TOTAL_DISKS_NVME / 2 * IMSM_OROM_VOLUMES_PER_ARRAY,
			.attr = IMSM_OROM_ATTR_2TB | IMSM_OROM_ATTR_2TB_DISK,
			.driver_features = IMSM_OROM_CAPABILITIES_EnterpriseSystem
		};
		nvme_orom = add_orom(&nvme_orom_compat);
	}
	add_orom_device_id(nvme_orom, hba->dev_id);
	return &nvme_orom->orom;
}

const struct imsm_orom *find_imsm_capability(struct sys_dev *hba)
{
	const struct imsm_orom *cap = get_orom_by_device_id(hba->dev_id);

	if (cap)
		return cap;

	if (hba->type == SYS_DEV_NVME)
		return find_imsm_nvme(hba);
	if ((cap = find_imsm_efi(hba)) != NULL)
		return cap;
	if ((cap = find_imsm_hba_orom(hba)) != NULL)
		return cap;

	return NULL;
}

char *devt_to_devpath(dev_t dev)
{
	char device[46];

	sprintf(device, "/sys/dev/block/%d:%d/device", major(dev), minor(dev));
	return realpath(device, NULL);
}

char *diskfd_to_devpath(int fd)
{
	/* return the device path for a disk, return NULL on error or fd
	 * refers to a partition
	 */
	struct stat st;

	if (fstat(fd, &st) != 0)
		return NULL;
	if (!S_ISBLK(st.st_mode))
		return NULL;

	return devt_to_devpath(st.st_rdev);
}

int path_attached_to_hba(const char *disk_path, const char *hba_path)
{
	int rc;

	if (check_env("IMSM_TEST_AHCI_DEV") ||
	    check_env("IMSM_TEST_SCU_DEV")) {
		return 1;
	}

	if (!disk_path || !hba_path)
		return 0;
	dprintf("hba: %s - disk: %s\n", hba_path, disk_path);
	if (strncmp(disk_path, hba_path, strlen(hba_path)) == 0)
		rc = 1;
	else
		rc = 0;

	return rc;
}

int devt_attached_to_hba(dev_t dev, const char *hba_path)
{
	char *disk_path = devt_to_devpath(dev);
	int rc = path_attached_to_hba(disk_path, hba_path);

	if (disk_path)
		free(disk_path);

	return rc;
}

int disk_attached_to_hba(int fd, const char *hba_path)
{
	char *disk_path = diskfd_to_devpath(fd);
	int rc = path_attached_to_hba(disk_path, hba_path);

	if (disk_path)
		free(disk_path);

	return rc;
}
Commit	Line	Data
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 "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>
fc13853f LM	31	#include <limits.h>
fc13853f LM	32
9c747fa0 LM	33	static int devpath_to_ll(const char dev_path, const char entry,
	34	unsigned long long *val);
	35
fc13853f	36	static __u16 devpath_to_vendor(const char *dev_path);
b390f610	37
9bc4ae77	38	static void free_sys_dev(struct sys_dev **list)
b390f610 DW	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' */
5dbb8c8d	53	char path[292];
b390f610 DW	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;
a8e5382a	60	enum sys_dev_type type;
9c747fa0	61	unsigned long long dev_id;
6b781d33	62	unsigned long long class;
a8e5382a LM	63
	64	if (strcmp(driver, "isci") == 0)
	65	type = SYS_DEV_SAS;
	66	else if (strcmp(driver, "ahci") == 0)
	67	type = SYS_DEV_SATA;
614902f6 PB	68	else if (strcmp(driver, "nvme") == 0)
614902f6 PB	69	type = SYS_DEV_NVME;
a8e5382a LM	70	else
a8e5382a LM	71	type = SYS_DEV_UNKNOWN;
b390f610 DW	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)) {
5a1920f2 AW	78	int n;
5a1920f2 AW	79
b390f610 DW	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);
5a1920f2	85	n = readlink(path, link, sizeof(link));
f21e18ca	86	if (n < 0 \|\| n >= (int)sizeof(link))
b390f610	87	continue;
5a1920f2	88	link[n] = '\0';
b390f610 DW	89	c = strrchr(link, '/');
	90	if (!c)
	91	continue;
	92	if (strncmp(bus, c+1, strlen(bus)) != 0)
	93	continue;
	94
a8e5382a LM	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
9c747fa0 LM	102	if (devpath_to_ll(path, "device", &dev_id) != 0)
	103	continue;
	104
6b781d33 AP	105	if (devpath_to_ll(path, "class", &class) != 0)
	106	continue;
	107
b390f610 DW	108	/* start / add list entry */
b390f610 DW	109	if (!head) {
503975b9	110	head = xmalloc(sizeof(*head));
b390f610 DW	111	list = head;
b390f610 DW	112	} else {
503975b9	113	list->next = xmalloc(sizeof(*head));
b390f610 DW	114	list = list->next;
	115	}
	116
	117	if (!list) {
	118	free_sys_dev(&head);
	119	break;
	120	}
	121
9c747fa0	122	list->dev_id = (__u16) dev_id;
6b781d33	123	list->class = (__u32) class;
a8e5382a	124	list->type = type;
e3635eee	125	list->path = realpath(path, NULL);
b390f610	126	list->next = NULL;
a8e5382a LM	127	if ((list->pci_id = strrchr(list->path, '/')) != NULL)
a8e5382a LM	128	list->pci_id++;
b390f610	129	}
2a17c77b	130	closedir(driver_dir);
b390f610 DW	131	return head;
	132	}
	133
9c747fa0	134	static struct sys_dev *intel_devices=NULL;
9bc4ae77	135	static time_t valid_time = 0;
9c747fa0	136
0858eccf AP	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
9c747fa0 LM	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
fc13853f	163	static __u16 devpath_to_vendor(const char *dev_path)
b390f610 DW	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
a8e5382a	187	struct sys_dev *find_intel_devices(void)
b390f610	188	{
614902f6	189	struct sys_dev ahci, isci, *nvme;
a8e5382a	190
9bc4ae77 N	191	if (valid_time > time(0) - 10)
	192	return intel_devices;
	193
	194	if (intel_devices)
	195	free_sys_dev(&intel_devices);
	196
a8e5382a LM	197	isci = find_driver_devices("pci", "isci");
a8e5382a LM	198	ahci = find_driver_devices("pci", "ahci");
614902f6	199	nvme = find_driver_devices("pci", "nvme");
a8e5382a	200
614902f6 PB	201	if (!isci && !ahci) {
	202	ahci = nvme;
	203	} else if (!ahci) {
a8e5382a	204	ahci = isci;
614902f6 PB	205	struct sys_dev *elem = ahci;
	206	while (elem->next)
	207	elem = elem->next;
	208	elem->next = nvme;
a8e5382a LM	209	} else {
	210	struct sys_dev *elem = ahci;
	211	while (elem->next)
	212	elem = elem->next;
	213	elem->next = isci;
614902f6 PB	214	while (elem->next)
	215	elem = elem->next;
	216	elem->next = nvme;
a8e5382a	217	}
9bc4ae77 N	218	intel_devices = ahci;
	219	valid_time = time(0);
	220	return intel_devices;
b390f610 DW	221	}
b390f610 DW	222
3c8bfb5d	223	/*
fc13853f	224	* PCI Expansion ROM Data Structure Format */
3c8bfb5d LM	225	struct pciExpDataStructFormat {
	226	__u8 ver[4];
	227	__u16 vendorID;
	228	__u16 deviceID;
6b781d33	229	__u16 devListOffset;
3c8bfb5d LM	230	} __attribute__ ((packed));
3c8bfb5d LM	231
5e1d6128	232	struct orom_entry *orom_entries;
0858eccf	233
6b781d33 AP	234	const struct imsm_orom *get_orom_by_device_id(__u16 dev_id)
6b781d33 AP	235	{
5e1d6128 AP	236	struct orom_entry *entry;
5e1d6128 AP	237	struct devid_list *devid;
6b781d33	238
5e1d6128 AP	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;
6b781d33 AP	243	}
6b781d33 AP	244	}
5e1d6128	245
6b781d33 AP	246	return NULL;
	247	}
	248
5e1d6128	249	static struct orom_entry add_orom(const struct imsm_orom orom)
6b781d33	250	{
5e1d6128 AP	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;
6b781d33 AP	268	}
6b781d33 AP	269
5e1d6128	270	static void add_orom_device_id(struct orom_entry *entry, __u16 dev_id)
6b781d33	271	{
6b781d33 AP	272	struct devid_list *list;
	273	struct devid_list *prev = NULL;
	274
5e1d6128 AP	275	for (list = entry->devid_list; list; prev = list, list = list->next) {
5e1d6128 AP	276	if (list->devid == dev_id)
6b781d33	277	return;
6b781d33	278	}
5e1d6128 AP	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;
6b781d33	287	}
fc13853f	288
3c8bfb5d	289	static int scan(const void start, const void end, const void *data)
b390f610 DW	290	{
b390f610 DW	291	int offset;
6b781d33	292	const struct imsm_orom *imsm_mem = NULL;
b390f610	293	int len = (end - start);
3c8bfb5d LM	294	struct pciExpDataStructFormat ptr= (struct pciExpDataStructFormat )data;
3c8bfb5d LM	295
9c747fa0 LM	296	if (data + 0x18 > end) {
	297	dprintf("cannot find pciExpDataStruct \n");
	298	return 0;
	299	}
	300
3c8bfb5d LM	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
6b781d33	305	if (__le16_to_cpu(ptr->vendorID) != 0x8086)
3c8bfb5d	306	return 0;
b390f610 DW	307
b390f610 DW	308	for (offset = 0; offset < len; offset += 4) {
6b781d33 AP	309	const void *mem = start + offset;
	310
	311	if ((memcmp(mem, IMSM_OROM_SIGNATURE, 4) == 0)) {
	312	imsm_mem = mem;
	313	break;
b390f610 DW	314	}
b390f610 DW	315	}
6b781d33 AP	316
	317	if (!imsm_mem)
	318	return 0;
	319
5e1d6128	320	struct orom_entry *orom = add_orom(imsm_mem);
6b781d33 AP	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
b390f610 DW	332	return 0;
	333	}
	334
6b781d33	335	const struct imsm_orom imsm_platform_test(struct sys_dev hba)
fc13853f	336	{
6b781d33 AP	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;
fc13853f LM	352
fc13853f LM	353	if (check_env("IMSM_TEST_OROM_NORAID5")) {
6b781d33	354	orom.rlc = IMSM_OROM_RLC_RAID0 \| IMSM_OROM_RLC_RAID1 \|
fc13853f LM	355	IMSM_OROM_RLC_RAID10;
fc13853f LM	356	}
6b781d33 AP	357	if (check_env("IMSM_TEST_AHCI_EFI_NORAID5") && (hba->type == SYS_DEV_SAS)) {
6b781d33 AP	358	orom.rlc = IMSM_OROM_RLC_RAID0 \| IMSM_OROM_RLC_RAID1 \|
fc13853f LM	359	IMSM_OROM_RLC_RAID10;
fc13853f LM	360	}
6b781d33 AP	361	if (check_env("IMSM_TEST_SCU_EFI_NORAID5") && (hba->type == SYS_DEV_SATA)) {
6b781d33 AP	362	orom.rlc = IMSM_OROM_RLC_RAID0 \| IMSM_OROM_RLC_RAID1 \|
fc13853f	363	IMSM_OROM_RLC_RAID10;
cceebc67 DW	364	}
cceebc67 DW	365
5e1d6128	366	struct orom_entry *ret = add_orom(&orom);
6b781d33 AP	367
	368	add_orom_device_id(ret, hba->dev_id);
	369
5e1d6128	370	return &ret->orom;
fc13853f LM	371	}
fc13853f LM	372
6b781d33	373	static const struct imsm_orom find_imsm_hba_orom(struct sys_dev hba)
fc13853f LM	374	{
	375	unsigned long align;
	376
6b781d33 AP	377	if (check_env("IMSM_TEST_OROM"))
6b781d33 AP	378	return imsm_platform_test(hba);
fc13853f	379
fc13853f	380	/* return empty OROM capabilities in EFI test mode */
6b781d33	381	if (check_env("IMSM_TEST_AHCI_EFI") \|\| check_env("IMSM_TEST_SCU_EFI"))
fc13853f LM	382	return NULL;
fc13853f LM	383
9bc4ae77	384	find_intel_devices();
9c747fa0 LM	385
9c747fa0 LM	386	if (intel_devices == NULL)
b390f610 DW	387	return NULL;
	388
	389	/* scan option-rom memory looking for an imsm signature */
969c2555 DW	390	if (check_env("IMSM_SAFE_OROM_SCAN"))
	391	align = 2048;
	392	else
	393	align = 512;
	394	if (probe_roms_init(align) != 0)
b390f610 DW	395	return NULL;
b390f610 DW	396	probe_roms();
9c747fa0	397	/* ignore return value - True is returned if both adapater roms are found */
fc13853f	398	scan_adapter_roms(scan);
b390f610 DW	399	probe_roms_exit();
b390f610 DW	400
6b781d33	401	return get_orom_by_device_id(hba->dev_id);
fc13853f LM	402	}
fc13853f LM	403
1a901471 LM	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) }})
fc13853f	413
5a6baf66	414	#define SYS_EFI_VAR_PATH "/sys/firmware/efi/vars"
88605db9	415	#define SYS_EFIVARS_PATH "/sys/firmware/efi/efivars"
5a6baf66 LM	416	#define SCU_PROP "RstScuV"
5a6baf66 LM	417	#define AHCI_PROP "RstSataV"
81188ef8 AP	418	#define AHCI_SSATA_PROP "RstsSatV"
81188ef8 AP	419	#define AHCI_CSATA_PROP "RstCSatV"
5a6baf66 LM	420
	421	#define VENDOR_GUID \
	422	EFI_GUID(0x193dfefa, 0xa445, 0x4302, 0x99, 0xd8, 0xef, 0x3a, 0xad, 0x1a, 0x04, 0xc6)
	423
6b781d33	424	#define PCI_CLASS_RAID_CNTRL 0x010400
5a6baf66	425
88605db9 AP	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)
5a6baf66	456	{
5a6baf66 LM	457	char path[PATH_MAX];
5a6baf66 LM	458	char buf[GUID_STR_MAX];
aae4c111 HCP	459	int dfd;
	460	ssize_t n, var_data_len;
	461
88605db9 AP	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
aae4c111 HCP	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))
5d500228	484	\|\| (errno != 0 && var_data_len == 0))
aae4c111 HCP	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	}
5a6baf66	503
6b781d33	504	const struct imsm_orom find_imsm_efi(struct sys_dev hba)
aae4c111	505	{
6b781d33	506	struct imsm_orom orom;
5e1d6128	507	struct orom_entry *ret;
81188ef8	508	int err;
5a6baf66	509
6b781d33 AP	510	if (check_env("IMSM_TEST_AHCI_EFI") \|\| check_env("IMSM_TEST_SCU_EFI"))
6b781d33 AP	511	return imsm_platform_test(hba);
5a6baf66	512
5a6baf66	513	/* OROM test is set, return that there is no EFI capabilities */
aae4c111	514	if (check_env("IMSM_TEST_OROM"))
5a6baf66	515	return NULL;
5a6baf66	516
6b781d33	517	if (hba->type == SYS_DEV_SATA && hba->class != PCI_CLASS_RAID_CNTRL)
5a6baf66	518	return NULL;
aae4c111	519
81188ef8 AP	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) {
5e1d6128	528	static struct orom_entry *csata;
81188ef8 AP	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);
5e1d6128	535	return &csata->orom;
81188ef8 AP	536	}
	537	}
	538
	539	if (err)
6b781d33	540	return NULL;
5a6baf66	541
6b781d33 AP	542	ret = add_orom(&orom);
	543	add_orom_device_id(ret, hba->dev_id);
	544
5e1d6128	545	return &ret->orom;
fc13853f LM	546	}
fc13853f LM	547
614902f6 PB	548	const struct imsm_orom find_imsm_nvme(struct sys_dev hba)
614902f6 PB	549	{
5e1d6128	550	static struct orom_entry *nvme_orom;
614902f6 PB	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,
0858eccf	568	.driver_features = IMSM_OROM_CAPABILITIES_EnterpriseSystem
614902f6 PB	569	};
	570	nvme_orom = add_orom(&nvme_orom_compat);
	571	}
	572	add_orom_device_id(nvme_orom, hba->dev_id);
5e1d6128	573	return &nvme_orom->orom;
614902f6 PB	574	}
614902f6 PB	575
6b781d33	576	const struct imsm_orom find_imsm_capability(struct sys_dev hba)
fc13853f	577	{
6b781d33 AP	578	const struct imsm_orom *cap = get_orom_by_device_id(hba->dev_id);
	579
	580	if (cap)
	581	return cap;
fc13853f	582
614902f6 PB	583	if (hba->type == SYS_DEV_NVME)
614902f6 PB	584	return find_imsm_nvme(hba);
6b781d33	585	if ((cap = find_imsm_efi(hba)) != NULL)
5a6baf66	586	return cap;
6b781d33	587	if ((cap = find_imsm_hba_orom(hba)) != NULL)
fc13853f	588	return cap;
614902f6	589
b390f610 DW	590	return NULL;
b390f610 DW	591	}
25921536 DW	592
	593	char *devt_to_devpath(dev_t dev)
	594	{
37f0e1e0	595	char device[46];
25921536 DW	596
25921536 DW	597	sprintf(device, "/sys/dev/block/%d:%d/device", major(dev), minor(dev));
e3635eee	598	return realpath(device, NULL);
25921536 DW	599	}
25921536 DW	600
a8e5382a	601	char *diskfd_to_devpath(int fd)
25921536 DW	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
fc13853f LM	620	if (check_env("IMSM_TEST_AHCI_DEV") \|\|
	621	check_env("IMSM_TEST_SCU_DEV")) {
	622	return 1;
	623	}
	624
25921536 DW	625	if (!disk_path \|\| !hba_path)
25921536 DW	626	return 0;
a8e5382a	627	dprintf("hba: %s - disk: %s\n", hba_path, disk_path);
25921536 DW	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	}