platform-intel.h

   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 <asm/types.h>
  20 #include <strings.h>
  21
  22 /* The IMSM Capability (IMSM AHCI and ISCU OROM/EFI variable) Version Table definition */
  23 struct imsm_orom {
  24         __u8 signature[4];
  25         __u8 table_ver_major; /* Currently 2 (can change with future revs) */
  26         __u8 table_ver_minor; /* Currently 2 (can change with future revs) */
  27         __u16 major_ver; /* Example: 8 as in 8.6.0.1020 */
  28         __u16 minor_ver; /* Example: 6 as in 8.6.0.1020 */
  29         __u16 hotfix_ver; /* Example: 0 as in 8.6.0.1020 */
  30         __u16 build; /* Example: 1020 as in 8.6.0.1020 */
  31         __u8 len; /* number of bytes in this entire table */
  32         __u8 checksum; /* checksum of all the bytes in this table */
  33         __u16 rlc; /* RAID Level Capability */
  34         /* we assume the cpu is x86 as the orom should not be found
  35          * anywhere else
  36          */
  37         #define IMSM_OROM_RLC_RAID0 (1 << 0)
  38         #define IMSM_OROM_RLC_RAID1 (1 << 1)
  39         #define IMSM_OROM_RLC_RAID10 (1 << 2)
  40         #define IMSM_OROM_RLC_RAID1E (1 << 3)
  41         #define IMSM_OROM_RLC_RAID5 (1 << 4)
  42         #define IMSM_OROM_RLC_RAID_CNG (1 << 5)
  43         __u16 sss; /* Strip Size Supported */
  44         #define IMSM_OROM_SSS_2kB (1 << 0)
  45         #define IMSM_OROM_SSS_4kB (1 << 1)
  46         #define IMSM_OROM_SSS_8kB (1 << 2)
  47         #define IMSM_OROM_SSS_16kB (1 << 3)
  48         #define IMSM_OROM_SSS_32kB (1 << 4)
  49         #define IMSM_OROM_SSS_64kB (1 << 5)
  50         #define IMSM_OROM_SSS_128kB (1 << 6)
  51         #define IMSM_OROM_SSS_256kB (1 << 7)
  52         #define IMSM_OROM_SSS_512kB (1 << 8)
  53         #define IMSM_OROM_SSS_1MB (1 << 9)
  54         #define IMSM_OROM_SSS_2MB (1 << 10)
  55         #define IMSM_OROM_SSS_4MB (1 << 11)
  56         #define IMSM_OROM_SSS_8MB (1 << 12)
  57         #define IMSM_OROM_SSS_16MB (1 << 13)
  58         #define IMSM_OROM_SSS_32MB (1 << 14)
  59         #define IMSM_OROM_SSS_64MB (1 << 15)
  60         __u16 dpa; /* Disks Per Array supported */
  61         #define IMSM_OROM_DISKS_PER_ARRAY 6
  62         __u16 tds; /* Total Disks Supported */
  63         #define IMSM_OROM_TOTAL_DISKS 6
  64         __u8 vpa; /* # Volumes Per Array supported */
  65         #define IMSM_OROM_VOLUMES_PER_ARRAY 2
  66         __u8 vphba; /* # Volumes Per Host Bus Adapter supported */
  67         #define IMSM_OROM_VOLUMES_PER_HBA 4
  68         /* Attributes supported. This should map to the
  69          * attributes in the MPB. Also, lower 16 bits
  70          * should match/duplicate RLC bits above.
  71          */
  72         __u32 attr;
  73         #define IMSM_OROM_ATTR_RAID0 IMSM_OROM_RLC_RAID0
  74         #define IMSM_OROM_ATTR_RAID1 IMSM_OROM_RLC_RAID1
  75         #define IMSM_OROM_ATTR_RAID10 IMSM_OROM_RLC_RAID10
  76         #define IMSM_OROM_ATTR_RAID1E IMSM_OROM_RLC_RAID1E
  77         #define IMSM_OROM_ATTR_RAID5 IMSM_OROM_RLC_RAID5
  78         #define IMSM_OROM_ATTR_RAID_CNG IMSM_OROM_RLC_RAID_CNG
  79         #define IMSM_OROM_ATTR_2TB (1 << 29)
  80         #define IMSM_OROM_ATTR_PM (1 << 30)
  81         #define IMSM_OROM_ATTR_ChecksumVerify (1 << 31)
  82         __u32 capabilities;
  83         #define IMSM_OROM_CAPABILITIES_Ext_SATA (1 << 0)
  84         #define IMSM_OROM_CAPABILITIES_TurboMemory (1 << 1)
  85         #define IMSM_OROM_CAPABILITIES_HddPassword (1 << 2)
  86         #define IMSM_OROM_CAPABILITIES_DiskCoercion (1 << 3)
  87         __u32 driver_features;
  88         #define IMSM_OROM_CAPABILITIES_HDDUnlock (1 << 0)
  89         #define IMSM_OROM_CAPABILITIES_LEDLoc (1 << 1)
  90         #define IMSM_OROM_CAPABILITIES_EnterpriseSystem (1 << 2)
  91         #define IMSM_OROM_CAPABILITIES_Zpodd (1 << 3)
  92         #define IMSM_OROM_CAPABILITIES_LargeDramCache (1 << 4)
  93         #define IMSM_OROM_CAPABILITIES_Rohi (1 << 5)
  94         #define IMSM_OROM_CAPABILITIES_ReadPatrol (1 << 6)
  95         #define IMSM_OROM_CAPABILITIES_XorHw (1 << 7)
  96 } __attribute__((packed));
  97
  98 static inline int imsm_orom_has_raid0(const struct imsm_orom *orom)
  99 {
 100         return !!(orom->rlc & IMSM_OROM_RLC_RAID0);
 101 }
 102 static inline int imsm_orom_has_raid1(const struct imsm_orom *orom)
 103 {
 104         return !!(orom->rlc & IMSM_OROM_RLC_RAID1);
 105 }
 106 static inline int imsm_orom_has_raid1e(const struct imsm_orom *orom)
 107 {
 108         return !!(orom->rlc & IMSM_OROM_RLC_RAID1E);
 109 }
 110 static inline int imsm_orom_has_raid10(const struct imsm_orom *orom)
 111 {
 112         return !!(orom->rlc & IMSM_OROM_RLC_RAID10);
 113 }
 114 static inline int imsm_orom_has_raid5(const struct imsm_orom *orom)
 115 {
 116         return !!(orom->rlc & IMSM_OROM_RLC_RAID5);
 117 }
 118
 119 /**
 120  * imsm_orom_has_chunk - check if the orom supports the given chunk size
 121  * @orom: orom pointer from find_imsm_orom
 122  * @chunk: chunk size in kibibytes
 123  */
 124 static inline int imsm_orom_has_chunk(const struct imsm_orom *orom, int chunk)
 125 {
 126         int fs = ffs(chunk);
 127
 128         if (!fs)
 129                 return 0;
 130         fs--; /* bit num to bit index */
 131         return !!(orom->sss & (1 << (fs - 1)));
 132 }
 133
 134
 135 /**
 136  * fls - find last (most-significant) bit set
 137  * @x: the word to search
 138  * The funciton is borrowed from Linux kernel code
 139  * include/asm-generic/bitops/fls.h
 140  */
 141 static inline int fls(int x)
 142 {
 143         int r = 32;
 144
 145         if (!x)
 146                 return 0;
 147         if (!(x & 0xffff0000u)) {
 148                 x <<= 16;
 149                 r -= 16;
 150         }
 151         if (!(x & 0xff000000u)) {
 152                 x <<= 8;
 153                 r -= 8;
 154         }
 155         if (!(x & 0xf0000000u)) {
 156                 x <<= 4;
 157                 r -= 4;
 158         }
 159         if (!(x & 0xc0000000u)) {
 160                 x <<= 2;
 161                 r -= 2;
 162         }
 163         if (!(x & 0x80000000u)) {
 164                 x <<= 1;
 165                 r -= 1;
 166         }
 167         return r;
 168 }
 169
 170 /**
 171  * imsm_orom_default_chunk - return the largest chunk size supported via orom
 172  * @orom: orom pointer from find_imsm_orom
 173  */
 174 static inline int imsm_orom_default_chunk(const struct imsm_orom *orom)
 175 {
 176         int fs = fls(orom->sss);
 177
 178         if (!fs)
 179                 return 0;
 180
 181         return min(512, (1 << fs));
 182 }
 183
 184
 185 enum sys_dev_type {
 186         SYS_DEV_UNKNOWN = 0,
 187         SYS_DEV_SAS,
 188         SYS_DEV_SATA,
 189         SYS_DEV_MAX
 190 };
 191
 192
 193 struct sys_dev {
 194         enum sys_dev_type type;
 195         char *path;
 196         char *pci_id;
 197         __u16  dev_id;
 198         struct sys_dev *next;
 199 };
 200
 201 struct efi_guid {
 202         __u8 b[16];
 203 };
 204
 205 static inline char *guid_str(char *buf, struct efi_guid guid)
 206 {
 207         sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 208                      "%02x%02x-%02x%02x%02x%02x%02x%02x",
 209                  guid.b[3], guid.b[2], guid.b[1], guid.b[0],
 210                  guid.b[5], guid.b[4], guid.b[7], guid.b[6],
 211                  guid.b[8], guid.b[9], guid.b[10], guid.b[11],
 212                  guid.b[12], guid.b[13], guid.b[14], guid.b[15]);
 213         return buf;
 214 }
 215
 216 char *diskfd_to_devpath(int fd);
 217 struct sys_dev *find_driver_devices(const char *bus, const char *driver);
 218 struct sys_dev *find_intel_devices(void);
 219 void free_sys_dev(struct sys_dev **list);
 220 const struct imsm_orom *find_imsm_capability(enum sys_dev_type hba_id);
 221 const struct imsm_orom *find_imsm_orom(void);
 222 int disk_attached_to_hba(int fd, const char *hba_path);
 223 char *devt_to_devpath(dev_t dev);
 224 int path_attached_to_hba(const char *disk_path, const char *hba_path);
 225 const char *get_sys_dev_type(enum sys_dev_type);
 226