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