1 /* 2 * 3 * Intel Management Engine Interface (Intel MEI) Linux driver 4 * Copyright (c) 2003-2013, 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 */ 16 17 #include <linux/kernel.h> 18 #include <linux/sched.h> 19 #include <linux/module.h> 20 #include <linux/moduleparam.h> 21 #include <linux/device.h> 22 #include <linux/slab.h> 23 #include <linux/uuid.h> 24 25 #include <linux/mei_cl_bus.h> 26 27 #include "mei_dev.h" 28 #include "client.h" 29 30 #define MEI_UUID_NFC_INFO UUID_LE(0xd2de1625, 0x382d, 0x417d, \ 31 0x48, 0xa4, 0xef, 0xab, 0xba, 0x8a, 0x12, 0x06) 32 33 static const uuid_le mei_nfc_info_guid = MEI_UUID_NFC_INFO; 34 35 #define MEI_UUID_NFC_HCI UUID_LE(0x0bb17a78, 0x2a8e, 0x4c50, \ 36 0x94, 0xd4, 0x50, 0x26, 0x67, 0x23, 0x77, 0x5c) 37 38 #define MEI_UUID_WD UUID_LE(0x05B79A6F, 0x4628, 0x4D7F, \ 39 0x89, 0x9D, 0xA9, 0x15, 0x14, 0xCB, 0x32, 0xAB) 40 41 #define MEI_UUID_MKHIF_FIX UUID_LE(0x55213584, 0x9a29, 0x4916, \ 42 0xba, 0xdf, 0xf, 0xb7, 0xed, 0x68, 0x2a, 0xeb) 43 44 #define MEI_UUID_ANY NULL_UUID_LE 45 46 /** 47 * number_of_connections - determine whether an client be on the bus 48 * according number of connections 49 * We support only clients: 50 * 1. with single connection 51 * 2. and fixed clients (max_number_of_connections == 0) 52 * 53 * @cldev: me clients device 54 */ 55 static void number_of_connections(struct mei_cl_device *cldev) 56 { 57 dev_dbg(&cldev->dev, "running hook %s\n", __func__); 58 59 if (cldev->me_cl->props.max_number_of_connections > 1) 60 cldev->do_match = 0; 61 } 62 63 /** 64 * blacklist - blacklist a client from the bus 65 * 66 * @cldev: me clients device 67 */ 68 static void blacklist(struct mei_cl_device *cldev) 69 { 70 dev_dbg(&cldev->dev, "running hook %s\n", __func__); 71 72 cldev->do_match = 0; 73 } 74 75 #define OSTYPE_LINUX 2 76 struct mei_os_ver { 77 __le16 build; 78 __le16 reserved1; 79 u8 os_type; 80 u8 major; 81 u8 minor; 82 u8 reserved2; 83 } __packed; 84 85 #define MKHI_FEATURE_PTT 0x10 86 87 struct mkhi_rule_id { 88 __le16 rule_type; 89 u8 feature_id; 90 u8 reserved; 91 } __packed; 92 93 struct mkhi_fwcaps { 94 struct mkhi_rule_id id; 95 u8 len; 96 u8 data[0]; 97 } __packed; 98 99 #define MKHI_FWCAPS_GROUP_ID 0x3 100 #define MKHI_FWCAPS_SET_OS_VER_APP_RULE_CMD 6 101 struct mkhi_msg_hdr { 102 u8 group_id; 103 u8 command; 104 u8 reserved; 105 u8 result; 106 } __packed; 107 108 struct mkhi_msg { 109 struct mkhi_msg_hdr hdr; 110 u8 data[0]; 111 } __packed; 112 113 static int mei_osver(struct mei_cl_device *cldev) 114 { 115 int ret; 116 const size_t size = sizeof(struct mkhi_msg_hdr) + 117 sizeof(struct mkhi_fwcaps) + 118 sizeof(struct mei_os_ver); 119 size_t length = 8; 120 char buf[size]; 121 struct mkhi_msg *req; 122 struct mkhi_fwcaps *fwcaps; 123 struct mei_os_ver *os_ver; 124 unsigned int mode = MEI_CL_IO_TX_BLOCKING | MEI_CL_IO_TX_INTERNAL; 125 126 memset(buf, 0, size); 127 128 req = (struct mkhi_msg *)buf; 129 req->hdr.group_id = MKHI_FWCAPS_GROUP_ID; 130 req->hdr.command = MKHI_FWCAPS_SET_OS_VER_APP_RULE_CMD; 131 132 fwcaps = (struct mkhi_fwcaps *)req->data; 133 134 fwcaps->id.rule_type = 0x0; 135 fwcaps->id.feature_id = MKHI_FEATURE_PTT; 136 fwcaps->len = sizeof(*os_ver); 137 os_ver = (struct mei_os_ver *)fwcaps->data; 138 os_ver->os_type = OSTYPE_LINUX; 139 140 ret = __mei_cl_send(cldev->cl, buf, size, mode); 141 if (ret < 0) 142 return ret; 143 144 ret = __mei_cl_recv(cldev->cl, buf, length, 0); 145 if (ret < 0) 146 return ret; 147 148 return 0; 149 } 150 151 static void mei_mkhi_fix(struct mei_cl_device *cldev) 152 { 153 int ret; 154 155 if (!cldev->bus->hbm_f_os_supported) 156 return; 157 158 ret = mei_cldev_enable(cldev); 159 if (ret) 160 return; 161 162 ret = mei_osver(cldev); 163 if (ret) 164 dev_err(&cldev->dev, "OS version command failed %d\n", ret); 165 166 mei_cldev_disable(cldev); 167 } 168 169 /** 170 * mei_wd - wd client on the bus, change protocol version 171 * as the API has changed. 172 * 173 * @cldev: me clients device 174 */ 175 #if IS_ENABLED(CONFIG_INTEL_MEI_ME) 176 #include <linux/pci.h> 177 #include "hw-me-regs.h" 178 static void mei_wd(struct mei_cl_device *cldev) 179 { 180 struct pci_dev *pdev = to_pci_dev(cldev->dev.parent); 181 182 dev_dbg(&cldev->dev, "running hook %s\n", __func__); 183 if (pdev->device == MEI_DEV_ID_WPT_LP || 184 pdev->device == MEI_DEV_ID_SPT || 185 pdev->device == MEI_DEV_ID_SPT_H) 186 cldev->me_cl->props.protocol_version = 0x2; 187 188 cldev->do_match = 1; 189 } 190 #else 191 static inline void mei_wd(struct mei_cl_device *cldev) {} 192 #endif /* CONFIG_INTEL_MEI_ME */ 193 194 struct mei_nfc_cmd { 195 u8 command; 196 u8 status; 197 u16 req_id; 198 u32 reserved; 199 u16 data_size; 200 u8 sub_command; 201 u8 data[]; 202 } __packed; 203 204 struct mei_nfc_reply { 205 u8 command; 206 u8 status; 207 u16 req_id; 208 u32 reserved; 209 u16 data_size; 210 u8 sub_command; 211 u8 reply_status; 212 u8 data[]; 213 } __packed; 214 215 struct mei_nfc_if_version { 216 u8 radio_version_sw[3]; 217 u8 reserved[3]; 218 u8 radio_version_hw[3]; 219 u8 i2c_addr; 220 u8 fw_ivn; 221 u8 vendor_id; 222 u8 radio_type; 223 } __packed; 224 225 226 #define MEI_NFC_CMD_MAINTENANCE 0x00 227 #define MEI_NFC_SUBCMD_IF_VERSION 0x01 228 229 /* Vendors */ 230 #define MEI_NFC_VENDOR_INSIDE 0x00 231 #define MEI_NFC_VENDOR_NXP 0x01 232 233 /* Radio types */ 234 #define MEI_NFC_VENDOR_INSIDE_UREAD 0x00 235 #define MEI_NFC_VENDOR_NXP_PN544 0x01 236 237 /** 238 * mei_nfc_if_version - get NFC interface version 239 * 240 * @cl: host client (nfc info) 241 * @ver: NFC interface version to be filled in 242 * 243 * Return: 0 on success; < 0 otherwise 244 */ 245 static int mei_nfc_if_version(struct mei_cl *cl, 246 struct mei_nfc_if_version *ver) 247 { 248 struct mei_device *bus; 249 struct mei_nfc_cmd cmd = { 250 .command = MEI_NFC_CMD_MAINTENANCE, 251 .data_size = 1, 252 .sub_command = MEI_NFC_SUBCMD_IF_VERSION, 253 }; 254 struct mei_nfc_reply *reply = NULL; 255 size_t if_version_length; 256 int bytes_recv, ret; 257 258 bus = cl->dev; 259 260 WARN_ON(mutex_is_locked(&bus->device_lock)); 261 262 ret = __mei_cl_send(cl, (u8 *)&cmd, sizeof(struct mei_nfc_cmd), 263 MEI_CL_IO_TX_BLOCKING); 264 if (ret < 0) { 265 dev_err(bus->dev, "Could not send IF version cmd\n"); 266 return ret; 267 } 268 269 /* to be sure on the stack we alloc memory */ 270 if_version_length = sizeof(struct mei_nfc_reply) + 271 sizeof(struct mei_nfc_if_version); 272 273 reply = kzalloc(if_version_length, GFP_KERNEL); 274 if (!reply) 275 return -ENOMEM; 276 277 ret = 0; 278 bytes_recv = __mei_cl_recv(cl, (u8 *)reply, if_version_length, 0); 279 if (bytes_recv < if_version_length) { 280 dev_err(bus->dev, "Could not read IF version\n"); 281 ret = -EIO; 282 goto err; 283 } 284 285 memcpy(ver, reply->data, sizeof(struct mei_nfc_if_version)); 286 287 dev_info(bus->dev, "NFC MEI VERSION: IVN 0x%x Vendor ID 0x%x Type 0x%x\n", 288 ver->fw_ivn, ver->vendor_id, ver->radio_type); 289 290 err: 291 kfree(reply); 292 return ret; 293 } 294 295 /** 296 * mei_nfc_radio_name - derive nfc radio name from the interface version 297 * 298 * @ver: NFC radio version 299 * 300 * Return: radio name string 301 */ 302 static const char *mei_nfc_radio_name(struct mei_nfc_if_version *ver) 303 { 304 305 if (ver->vendor_id == MEI_NFC_VENDOR_INSIDE) { 306 if (ver->radio_type == MEI_NFC_VENDOR_INSIDE_UREAD) 307 return "microread"; 308 } 309 310 if (ver->vendor_id == MEI_NFC_VENDOR_NXP) { 311 if (ver->radio_type == MEI_NFC_VENDOR_NXP_PN544) 312 return "pn544"; 313 } 314 315 return NULL; 316 } 317 318 /** 319 * mei_nfc - The nfc fixup function. The function retrieves nfc radio 320 * name and set is as device attribute so we can load 321 * the proper device driver for it 322 * 323 * @cldev: me client device (nfc) 324 */ 325 static void mei_nfc(struct mei_cl_device *cldev) 326 { 327 struct mei_device *bus; 328 struct mei_cl *cl; 329 struct mei_me_client *me_cl = NULL; 330 struct mei_nfc_if_version ver; 331 const char *radio_name = NULL; 332 int ret; 333 334 bus = cldev->bus; 335 336 dev_dbg(&cldev->dev, "running hook %s\n", __func__); 337 338 mutex_lock(&bus->device_lock); 339 /* we need to connect to INFO GUID */ 340 cl = mei_cl_alloc_linked(bus); 341 if (IS_ERR(cl)) { 342 ret = PTR_ERR(cl); 343 cl = NULL; 344 dev_err(bus->dev, "nfc hook alloc failed %d\n", ret); 345 goto out; 346 } 347 348 me_cl = mei_me_cl_by_uuid(bus, &mei_nfc_info_guid); 349 if (!me_cl) { 350 ret = -ENOTTY; 351 dev_err(bus->dev, "Cannot find nfc info %d\n", ret); 352 goto out; 353 } 354 355 ret = mei_cl_connect(cl, me_cl, NULL); 356 if (ret < 0) { 357 dev_err(&cldev->dev, "Can't connect to the NFC INFO ME ret = %d\n", 358 ret); 359 goto out; 360 } 361 362 mutex_unlock(&bus->device_lock); 363 364 ret = mei_nfc_if_version(cl, &ver); 365 if (ret) 366 goto disconnect; 367 368 radio_name = mei_nfc_radio_name(&ver); 369 370 if (!radio_name) { 371 ret = -ENOENT; 372 dev_err(&cldev->dev, "Can't get the NFC interface version ret = %d\n", 373 ret); 374 goto disconnect; 375 } 376 377 dev_dbg(bus->dev, "nfc radio %s\n", radio_name); 378 strlcpy(cldev->name, radio_name, sizeof(cldev->name)); 379 380 disconnect: 381 mutex_lock(&bus->device_lock); 382 if (mei_cl_disconnect(cl) < 0) 383 dev_err(bus->dev, "Can't disconnect the NFC INFO ME\n"); 384 385 mei_cl_flush_queues(cl, NULL); 386 387 out: 388 mei_cl_unlink(cl); 389 mutex_unlock(&bus->device_lock); 390 mei_me_cl_put(me_cl); 391 kfree(cl); 392 393 if (ret) 394 cldev->do_match = 0; 395 396 dev_dbg(bus->dev, "end of fixup match = %d\n", cldev->do_match); 397 } 398 399 #define MEI_FIXUP(_uuid, _hook) { _uuid, _hook } 400 401 static struct mei_fixup { 402 403 const uuid_le uuid; 404 void (*hook)(struct mei_cl_device *cldev); 405 } mei_fixups[] = { 406 MEI_FIXUP(MEI_UUID_ANY, number_of_connections), 407 MEI_FIXUP(MEI_UUID_NFC_INFO, blacklist), 408 MEI_FIXUP(MEI_UUID_NFC_HCI, mei_nfc), 409 MEI_FIXUP(MEI_UUID_WD, mei_wd), 410 MEI_FIXUP(MEI_UUID_MKHIF_FIX, mei_mkhi_fix), 411 }; 412 413 /** 414 * mei_cldev_fixup - run fixup handlers 415 * 416 * @cldev: me client device 417 */ 418 void mei_cl_bus_dev_fixup(struct mei_cl_device *cldev) 419 { 420 struct mei_fixup *f; 421 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl); 422 int i; 423 424 for (i = 0; i < ARRAY_SIZE(mei_fixups); i++) { 425 426 f = &mei_fixups[i]; 427 if (uuid_le_cmp(f->uuid, MEI_UUID_ANY) == 0 || 428 uuid_le_cmp(f->uuid, *uuid) == 0) 429 f->hook(cldev); 430 } 431 } 432 433