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