1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2013-2022, Intel Corporation. All rights reserved. 4 * Intel Management Engine Interface (Intel MEI) Linux driver 5 */ 6 7 #include <linux/kernel.h> 8 #include <linux/sched.h> 9 #include <linux/module.h> 10 #include <linux/device.h> 11 #include <linux/slab.h> 12 #include <linux/uuid.h> 13 14 #include <linux/mei_cl_bus.h> 15 16 #include "mei_dev.h" 17 #include "client.h" 18 #include "mkhi.h" 19 20 #define MEI_UUID_NFC_INFO UUID_LE(0xd2de1625, 0x382d, 0x417d, \ 21 0x48, 0xa4, 0xef, 0xab, 0xba, 0x8a, 0x12, 0x06) 22 23 static const uuid_le mei_nfc_info_guid = MEI_UUID_NFC_INFO; 24 25 #define MEI_UUID_NFC_HCI UUID_LE(0x0bb17a78, 0x2a8e, 0x4c50, \ 26 0x94, 0xd4, 0x50, 0x26, 0x67, 0x23, 0x77, 0x5c) 27 28 #define MEI_UUID_WD UUID_LE(0x05B79A6F, 0x4628, 0x4D7F, \ 29 0x89, 0x9D, 0xA9, 0x15, 0x14, 0xCB, 0x32, 0xAB) 30 31 #define MEI_UUID_MKHIF_FIX UUID_LE(0x55213584, 0x9a29, 0x4916, \ 32 0xba, 0xdf, 0xf, 0xb7, 0xed, 0x68, 0x2a, 0xeb) 33 34 #define MEI_UUID_IGSC_MKHI UUID_LE(0xE2C2AFA2, 0x3817, 0x4D19, \ 35 0x9D, 0x95, 0x06, 0xB1, 0x6B, 0x58, 0x8A, 0x5D) 36 37 #define MEI_UUID_IGSC_MKHI_FIX UUID_LE(0x46E0C1FB, 0xA546, 0x414F, \ 38 0x91, 0x70, 0xB7, 0xF4, 0x6D, 0x57, 0xB4, 0xAD) 39 40 #define MEI_UUID_HDCP UUID_LE(0xB638AB7E, 0x94E2, 0x4EA2, \ 41 0xA5, 0x52, 0xD1, 0xC5, 0x4B, 0x62, 0x7F, 0x04) 42 43 #define MEI_UUID_PAVP UUID_LE(0xfbf6fcf1, 0x96cf, 0x4e2e, 0xA6, \ 44 0xa6, 0x1b, 0xab, 0x8c, 0xbe, 0x36, 0xb1) 45 46 #define MEI_UUID_ANY NULL_UUID_LE 47 48 /** 49 * number_of_connections - determine whether an client be on the bus 50 * according number of connections 51 * We support only clients: 52 * 1. with single connection 53 * 2. and fixed clients (max_number_of_connections == 0) 54 * 55 * @cldev: me clients device 56 */ 57 static void number_of_connections(struct mei_cl_device *cldev) 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 cldev->do_match = 0; 71 } 72 73 /** 74 * whitelist - forcefully whitelist client 75 * 76 * @cldev: me clients device 77 */ 78 static void whitelist(struct mei_cl_device *cldev) 79 { 80 cldev->do_match = 1; 81 } 82 83 #define OSTYPE_LINUX 2 84 struct mei_os_ver { 85 __le16 build; 86 __le16 reserved1; 87 u8 os_type; 88 u8 major; 89 u8 minor; 90 u8 reserved2; 91 } __packed; 92 93 struct mkhi_fw_ver_block { 94 u16 minor; 95 u8 major; 96 u8 platform; 97 u16 buildno; 98 u16 hotfix; 99 } __packed; 100 101 struct mkhi_fw_ver { 102 struct mkhi_fw_ver_block ver[MEI_MAX_FW_VER_BLOCKS]; 103 } __packed; 104 105 #define MKHI_OSVER_BUF_LEN (sizeof(struct mkhi_msg_hdr) + \ 106 sizeof(struct mkhi_fwcaps) + \ 107 sizeof(struct mei_os_ver)) 108 static int mei_osver(struct mei_cl_device *cldev) 109 { 110 const size_t size = MKHI_OSVER_BUF_LEN; 111 char buf[MKHI_OSVER_BUF_LEN]; 112 struct mkhi_msg *req; 113 struct mkhi_fwcaps *fwcaps; 114 struct mei_os_ver *os_ver; 115 unsigned int mode = MEI_CL_IO_TX_BLOCKING | MEI_CL_IO_TX_INTERNAL; 116 117 memset(buf, 0, size); 118 119 req = (struct mkhi_msg *)buf; 120 req->hdr.group_id = MKHI_FWCAPS_GROUP_ID; 121 req->hdr.command = MKHI_FWCAPS_SET_OS_VER_APP_RULE_CMD; 122 123 fwcaps = (struct mkhi_fwcaps *)req->data; 124 125 fwcaps->id.rule_type = 0x0; 126 fwcaps->id.feature_id = MKHI_FEATURE_PTT; 127 fwcaps->len = sizeof(*os_ver); 128 os_ver = (struct mei_os_ver *)fwcaps->data; 129 os_ver->os_type = OSTYPE_LINUX; 130 131 return __mei_cl_send(cldev->cl, buf, size, 0, mode); 132 } 133 134 #define MKHI_FWVER_BUF_LEN (sizeof(struct mkhi_msg_hdr) + \ 135 sizeof(struct mkhi_fw_ver)) 136 #define MKHI_FWVER_LEN(__num) (sizeof(struct mkhi_msg_hdr) + \ 137 sizeof(struct mkhi_fw_ver_block) * (__num)) 138 static int mei_fwver(struct mei_cl_device *cldev) 139 { 140 char buf[MKHI_FWVER_BUF_LEN]; 141 struct mkhi_msg req; 142 struct mkhi_msg *rsp; 143 struct mkhi_fw_ver *fwver; 144 int bytes_recv, ret, i; 145 146 memset(buf, 0, sizeof(buf)); 147 148 req.hdr.group_id = MKHI_GEN_GROUP_ID; 149 req.hdr.command = MKHI_GEN_GET_FW_VERSION_CMD; 150 151 ret = __mei_cl_send(cldev->cl, (u8 *)&req, sizeof(req), 0, 152 MEI_CL_IO_TX_BLOCKING); 153 if (ret < 0) { 154 dev_err(&cldev->dev, "Could not send ReqFWVersion cmd\n"); 155 return ret; 156 } 157 158 ret = 0; 159 bytes_recv = __mei_cl_recv(cldev->cl, buf, sizeof(buf), NULL, 0, 160 cldev->bus->timeouts.mkhi_recv); 161 if (bytes_recv < 0 || (size_t)bytes_recv < MKHI_FWVER_LEN(1)) { 162 /* 163 * Should be at least one version block, 164 * error out if nothing found 165 */ 166 dev_err(&cldev->dev, "Could not read FW version\n"); 167 return -EIO; 168 } 169 170 rsp = (struct mkhi_msg *)buf; 171 fwver = (struct mkhi_fw_ver *)rsp->data; 172 memset(cldev->bus->fw_ver, 0, sizeof(cldev->bus->fw_ver)); 173 for (i = 0; i < MEI_MAX_FW_VER_BLOCKS; i++) { 174 if ((size_t)bytes_recv < MKHI_FWVER_LEN(i + 1)) 175 break; 176 dev_dbg(&cldev->dev, "FW version%d %d:%d.%d.%d.%d\n", 177 i, fwver->ver[i].platform, 178 fwver->ver[i].major, fwver->ver[i].minor, 179 fwver->ver[i].hotfix, fwver->ver[i].buildno); 180 181 cldev->bus->fw_ver[i].platform = fwver->ver[i].platform; 182 cldev->bus->fw_ver[i].major = fwver->ver[i].major; 183 cldev->bus->fw_ver[i].minor = fwver->ver[i].minor; 184 cldev->bus->fw_ver[i].hotfix = fwver->ver[i].hotfix; 185 cldev->bus->fw_ver[i].buildno = fwver->ver[i].buildno; 186 } 187 188 return ret; 189 } 190 191 static int mei_gfx_memory_ready(struct mei_cl_device *cldev) 192 { 193 struct mkhi_gfx_mem_ready req = {0}; 194 unsigned int mode = MEI_CL_IO_TX_INTERNAL; 195 196 req.hdr.group_id = MKHI_GROUP_ID_GFX; 197 req.hdr.command = MKHI_GFX_MEMORY_READY_CMD_REQ; 198 req.flags = MKHI_GFX_MEM_READY_PXP_ALLOWED; 199 200 dev_dbg(&cldev->dev, "Sending memory ready command\n"); 201 return __mei_cl_send(cldev->cl, (u8 *)&req, sizeof(req), 0, mode); 202 } 203 204 static void mei_mkhi_fix(struct mei_cl_device *cldev) 205 { 206 int ret; 207 208 /* No need to enable the client if nothing is needed from it */ 209 if (!cldev->bus->fw_f_fw_ver_supported && 210 !cldev->bus->hbm_f_os_supported) 211 return; 212 213 ret = mei_cldev_enable(cldev); 214 if (ret) 215 return; 216 217 if (cldev->bus->fw_f_fw_ver_supported) { 218 ret = mei_fwver(cldev); 219 if (ret < 0) 220 dev_err(&cldev->dev, "FW version command failed %d\n", 221 ret); 222 } 223 224 if (cldev->bus->hbm_f_os_supported) { 225 ret = mei_osver(cldev); 226 if (ret < 0) 227 dev_err(&cldev->dev, "OS version command failed %d\n", 228 ret); 229 } 230 mei_cldev_disable(cldev); 231 } 232 233 static void mei_gsc_mkhi_ver(struct mei_cl_device *cldev) 234 { 235 int ret; 236 237 /* No need to enable the client if nothing is needed from it */ 238 if (!cldev->bus->fw_f_fw_ver_supported) 239 return; 240 241 ret = mei_cldev_enable(cldev); 242 if (ret) 243 return; 244 245 ret = mei_fwver(cldev); 246 if (ret < 0) 247 dev_err(&cldev->dev, "FW version command failed %d\n", ret); 248 mei_cldev_disable(cldev); 249 } 250 251 static void mei_gsc_mkhi_fix_ver(struct mei_cl_device *cldev) 252 { 253 int ret; 254 255 /* No need to enable the client if nothing is needed from it */ 256 if (!cldev->bus->fw_f_fw_ver_supported && 257 cldev->bus->pxp_mode != MEI_DEV_PXP_INIT) 258 return; 259 260 ret = mei_cldev_enable(cldev); 261 if (ret) 262 return; 263 264 if (cldev->bus->pxp_mode == MEI_DEV_PXP_INIT) { 265 ret = mei_gfx_memory_ready(cldev); 266 if (ret < 0) 267 dev_err(&cldev->dev, "memory ready command failed %d\n", ret); 268 else 269 dev_dbg(&cldev->dev, "memory ready command sent\n"); 270 /* we go to reset after that */ 271 cldev->bus->pxp_mode = MEI_DEV_PXP_SETUP; 272 goto out; 273 } 274 275 ret = mei_fwver(cldev); 276 if (ret < 0) 277 dev_err(&cldev->dev, "FW version command failed %d\n", 278 ret); 279 out: 280 mei_cldev_disable(cldev); 281 } 282 283 /** 284 * mei_wd - wd client on the bus, change protocol version 285 * as the API has changed. 286 * 287 * @cldev: me clients device 288 */ 289 #if IS_ENABLED(CONFIG_INTEL_MEI_ME) 290 #include <linux/pci.h> 291 #include "hw-me-regs.h" 292 static void mei_wd(struct mei_cl_device *cldev) 293 { 294 struct pci_dev *pdev = to_pci_dev(cldev->dev.parent); 295 296 if (pdev->device == MEI_DEV_ID_WPT_LP || 297 pdev->device == MEI_DEV_ID_SPT || 298 pdev->device == MEI_DEV_ID_SPT_H) 299 cldev->me_cl->props.protocol_version = 0x2; 300 301 cldev->do_match = 1; 302 } 303 #else 304 static inline void mei_wd(struct mei_cl_device *cldev) {} 305 #endif /* CONFIG_INTEL_MEI_ME */ 306 307 struct mei_nfc_cmd { 308 u8 command; 309 u8 status; 310 u16 req_id; 311 u32 reserved; 312 u16 data_size; 313 u8 sub_command; 314 u8 data[]; 315 } __packed; 316 317 struct mei_nfc_reply { 318 u8 command; 319 u8 status; 320 u16 req_id; 321 u32 reserved; 322 u16 data_size; 323 u8 sub_command; 324 u8 reply_status; 325 u8 data[]; 326 } __packed; 327 328 struct mei_nfc_if_version { 329 u8 radio_version_sw[3]; 330 u8 reserved[3]; 331 u8 radio_version_hw[3]; 332 u8 i2c_addr; 333 u8 fw_ivn; 334 u8 vendor_id; 335 u8 radio_type; 336 } __packed; 337 338 339 #define MEI_NFC_CMD_MAINTENANCE 0x00 340 #define MEI_NFC_SUBCMD_IF_VERSION 0x01 341 342 /* Vendors */ 343 #define MEI_NFC_VENDOR_INSIDE 0x00 344 #define MEI_NFC_VENDOR_NXP 0x01 345 346 /* Radio types */ 347 #define MEI_NFC_VENDOR_INSIDE_UREAD 0x00 348 #define MEI_NFC_VENDOR_NXP_PN544 0x01 349 350 /** 351 * mei_nfc_if_version - get NFC interface version 352 * 353 * @cl: host client (nfc info) 354 * @ver: NFC interface version to be filled in 355 * 356 * Return: 0 on success; < 0 otherwise 357 */ 358 static int mei_nfc_if_version(struct mei_cl *cl, 359 struct mei_nfc_if_version *ver) 360 { 361 struct mei_device *bus; 362 struct mei_nfc_cmd cmd = { 363 .command = MEI_NFC_CMD_MAINTENANCE, 364 .data_size = 1, 365 .sub_command = MEI_NFC_SUBCMD_IF_VERSION, 366 }; 367 struct mei_nfc_reply *reply = NULL; 368 size_t if_version_length; 369 u8 vtag; 370 int bytes_recv, ret; 371 372 bus = cl->dev; 373 374 WARN_ON(mutex_is_locked(&bus->device_lock)); 375 376 ret = __mei_cl_send(cl, (u8 *)&cmd, sizeof(cmd), 0, 377 MEI_CL_IO_TX_BLOCKING); 378 if (ret < 0) { 379 dev_err(bus->dev, "Could not send IF version cmd\n"); 380 return ret; 381 } 382 383 /* to be sure on the stack we alloc memory */ 384 if_version_length = sizeof(*reply) + sizeof(*ver); 385 386 reply = kzalloc(if_version_length, GFP_KERNEL); 387 if (!reply) 388 return -ENOMEM; 389 390 ret = 0; 391 bytes_recv = __mei_cl_recv(cl, (u8 *)reply, if_version_length, &vtag, 392 0, 0); 393 if (bytes_recv < 0 || (size_t)bytes_recv < if_version_length) { 394 dev_err(bus->dev, "Could not read IF version\n"); 395 ret = -EIO; 396 goto err; 397 } 398 399 memcpy(ver, reply->data, sizeof(*ver)); 400 401 dev_info(bus->dev, "NFC MEI VERSION: IVN 0x%x Vendor ID 0x%x Type 0x%x\n", 402 ver->fw_ivn, ver->vendor_id, ver->radio_type); 403 404 err: 405 kfree(reply); 406 return ret; 407 } 408 409 /** 410 * mei_nfc_radio_name - derive nfc radio name from the interface version 411 * 412 * @ver: NFC radio version 413 * 414 * Return: radio name string 415 */ 416 static const char *mei_nfc_radio_name(struct mei_nfc_if_version *ver) 417 { 418 419 if (ver->vendor_id == MEI_NFC_VENDOR_INSIDE) { 420 if (ver->radio_type == MEI_NFC_VENDOR_INSIDE_UREAD) 421 return "microread"; 422 } 423 424 if (ver->vendor_id == MEI_NFC_VENDOR_NXP) { 425 if (ver->radio_type == MEI_NFC_VENDOR_NXP_PN544) 426 return "pn544"; 427 } 428 429 return NULL; 430 } 431 432 /** 433 * mei_nfc - The nfc fixup function. The function retrieves nfc radio 434 * name and set is as device attribute so we can load 435 * the proper device driver for it 436 * 437 * @cldev: me client device (nfc) 438 */ 439 static void mei_nfc(struct mei_cl_device *cldev) 440 { 441 struct mei_device *bus; 442 struct mei_cl *cl; 443 struct mei_me_client *me_cl = NULL; 444 struct mei_nfc_if_version ver; 445 const char *radio_name = NULL; 446 int ret; 447 448 bus = cldev->bus; 449 450 mutex_lock(&bus->device_lock); 451 /* we need to connect to INFO GUID */ 452 cl = mei_cl_alloc_linked(bus); 453 if (IS_ERR(cl)) { 454 ret = PTR_ERR(cl); 455 cl = NULL; 456 dev_err(bus->dev, "nfc hook alloc failed %d\n", ret); 457 goto out; 458 } 459 460 me_cl = mei_me_cl_by_uuid(bus, &mei_nfc_info_guid); 461 if (!me_cl) { 462 ret = -ENOTTY; 463 dev_err(bus->dev, "Cannot find nfc info %d\n", ret); 464 goto out; 465 } 466 467 ret = mei_cl_connect(cl, me_cl, NULL); 468 if (ret < 0) { 469 dev_err(&cldev->dev, "Can't connect to the NFC INFO ME ret = %d\n", 470 ret); 471 goto out; 472 } 473 474 mutex_unlock(&bus->device_lock); 475 476 ret = mei_nfc_if_version(cl, &ver); 477 if (ret) 478 goto disconnect; 479 480 radio_name = mei_nfc_radio_name(&ver); 481 482 if (!radio_name) { 483 ret = -ENOENT; 484 dev_err(&cldev->dev, "Can't get the NFC interface version ret = %d\n", 485 ret); 486 goto disconnect; 487 } 488 489 dev_dbg(bus->dev, "nfc radio %s\n", radio_name); 490 strscpy(cldev->name, radio_name, sizeof(cldev->name)); 491 492 disconnect: 493 mutex_lock(&bus->device_lock); 494 if (mei_cl_disconnect(cl) < 0) 495 dev_err(bus->dev, "Can't disconnect the NFC INFO ME\n"); 496 497 mei_cl_flush_queues(cl, NULL); 498 499 out: 500 mei_cl_unlink(cl); 501 mutex_unlock(&bus->device_lock); 502 mei_me_cl_put(me_cl); 503 kfree(cl); 504 505 if (ret) 506 cldev->do_match = 0; 507 508 dev_dbg(bus->dev, "end of fixup match = %d\n", cldev->do_match); 509 } 510 511 /** 512 * vt_support - enable on bus clients with vtag support 513 * 514 * @cldev: me clients device 515 */ 516 static void vt_support(struct mei_cl_device *cldev) 517 { 518 if (cldev->me_cl->props.vt_supported == 1) 519 cldev->do_match = 1; 520 } 521 522 /** 523 * pxp_is_ready - enable bus client if pxp is ready 524 * 525 * @cldev: me clients device 526 */ 527 static void pxp_is_ready(struct mei_cl_device *cldev) 528 { 529 struct mei_device *bus = cldev->bus; 530 531 switch (bus->pxp_mode) { 532 case MEI_DEV_PXP_READY: 533 case MEI_DEV_PXP_DEFAULT: 534 cldev->do_match = 1; 535 break; 536 default: 537 cldev->do_match = 0; 538 break; 539 } 540 } 541 542 #define MEI_FIXUP(_uuid, _hook) { _uuid, _hook } 543 544 static struct mei_fixup { 545 546 const uuid_le uuid; 547 void (*hook)(struct mei_cl_device *cldev); 548 } mei_fixups[] = { 549 MEI_FIXUP(MEI_UUID_ANY, number_of_connections), 550 MEI_FIXUP(MEI_UUID_NFC_INFO, blacklist), 551 MEI_FIXUP(MEI_UUID_NFC_HCI, mei_nfc), 552 MEI_FIXUP(MEI_UUID_WD, mei_wd), 553 MEI_FIXUP(MEI_UUID_MKHIF_FIX, mei_mkhi_fix), 554 MEI_FIXUP(MEI_UUID_IGSC_MKHI, mei_gsc_mkhi_ver), 555 MEI_FIXUP(MEI_UUID_IGSC_MKHI_FIX, mei_gsc_mkhi_fix_ver), 556 MEI_FIXUP(MEI_UUID_HDCP, whitelist), 557 MEI_FIXUP(MEI_UUID_ANY, vt_support), 558 MEI_FIXUP(MEI_UUID_PAVP, pxp_is_ready), 559 }; 560 561 /** 562 * mei_cl_bus_dev_fixup - run fixup handlers 563 * 564 * @cldev: me client device 565 */ 566 void mei_cl_bus_dev_fixup(struct mei_cl_device *cldev) 567 { 568 struct mei_fixup *f; 569 const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl); 570 size_t i; 571 572 for (i = 0; i < ARRAY_SIZE(mei_fixups); i++) { 573 574 f = &mei_fixups[i]; 575 if (uuid_le_cmp(f->uuid, MEI_UUID_ANY) == 0 || 576 uuid_le_cmp(f->uuid, *uuid) == 0) 577 f->hook(cldev); 578 } 579 } 580 581