drivers/misc/mei/bus-fixup.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2013-2023, 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
  13 #include <linux/mei.h>
  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_info(&cldev->dev, "Could not send ReqFWVersion cmd ret = %d\n", ret);
 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_info(&cldev->dev, "Could not read FW version ret = %d\n", bytes_recv);
 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 #define GFX_MEMORY_READY_TIMEOUT 200 /* timeout in milliseconds */
 192
 193 static int mei_gfx_memory_ready(struct mei_cl_device *cldev)
 194 {
 195         struct mkhi_gfx_mem_ready req = {0};
 196         unsigned int mode = MEI_CL_IO_TX_INTERNAL | MEI_CL_IO_TX_BLOCKING;
 197
 198         req.hdr.group_id = MKHI_GROUP_ID_GFX;
 199         req.hdr.command = MKHI_GFX_MEMORY_READY_CMD_REQ;
 200         req.flags = MKHI_GFX_MEM_READY_PXP_ALLOWED;
 201
 202         dev_dbg(&cldev->dev, "Sending memory ready command\n");
 203         return __mei_cl_send_timeout(cldev->cl, (u8 *)&req, sizeof(req), 0,
 204                                      mode, GFX_MEMORY_READY_TIMEOUT);
 205 }
 206
 207 static void mei_mkhi_fix(struct mei_cl_device *cldev)
 208 {
 209         int ret;
 210
 211         /* No need to enable the client if nothing is needed from it */
 212         if (!cldev->bus->fw_f_fw_ver_supported &&
 213             !cldev->bus->hbm_f_os_supported)
 214                 return;
 215
 216         ret = mei_cldev_enable(cldev);
 217         if (ret)
 218                 return;
 219
 220         if (cldev->bus->fw_f_fw_ver_supported) {
 221                 ret = mei_fwver(cldev);
 222                 if (ret < 0)
 223                         dev_info(&cldev->dev, "FW version command failed %d\n",
 224                                  ret);
 225         }
 226
 227         if (cldev->bus->hbm_f_os_supported) {
 228                 ret = mei_osver(cldev);
 229                 if (ret < 0)
 230                         dev_info(&cldev->dev, "OS version command failed %d\n",
 231                                  ret);
 232         }
 233         mei_cldev_disable(cldev);
 234 }
 235
 236 static void mei_gsc_mkhi_ver(struct mei_cl_device *cldev)
 237 {
 238         int ret;
 239
 240         /* No need to enable the client if nothing is needed from it */
 241         if (!cldev->bus->fw_f_fw_ver_supported)
 242                 return;
 243
 244         ret = mei_cldev_enable(cldev);
 245         if (ret)
 246                 return;
 247
 248         ret = mei_fwver(cldev);
 249         if (ret < 0)
 250                 dev_info(&cldev->dev, "FW version command failed %d\n", ret);
 251         mei_cldev_disable(cldev);
 252 }
 253
 254 static void mei_gsc_mkhi_fix_ver(struct mei_cl_device *cldev)
 255 {
 256         int ret;
 257
 258         /* No need to enable the client if nothing is needed from it */
 259         if (!cldev->bus->fw_f_fw_ver_supported &&
 260             cldev->bus->pxp_mode != MEI_DEV_PXP_INIT)
 261                 return;
 262
 263         ret = mei_cldev_enable(cldev);
 264         if (ret)
 265                 return;
 266
 267         if (cldev->bus->pxp_mode == MEI_DEV_PXP_INIT) {
 268                 ret = mei_gfx_memory_ready(cldev);
 269                 if (ret < 0) {
 270                         dev_err(&cldev->dev, "memory ready command failed %d\n", ret);
 271                 } else {
 272                         dev_dbg(&cldev->dev, "memory ready command sent\n");
 273                         cldev->bus->pxp_mode = MEI_DEV_PXP_SETUP;
 274                 }
 275                 /* we go to reset after that */
 276                 goto out;
 277         }
 278
 279         ret = mei_fwver(cldev);
 280         if (ret < 0)
 281                 dev_info(&cldev->dev, "FW version command failed %d\n",
 282                          ret);
 283 out:
 284         mei_cldev_disable(cldev);
 285 }
 286
 287 /**
 288  * mei_wd - wd client on the bus, change protocol version
 289  *   as the API has changed.
 290  *
 291  * @cldev: me clients device
 292  */
 293 #if IS_ENABLED(CONFIG_INTEL_MEI_ME)
 294 #include <linux/pci.h>
 295 #include "hw-me-regs.h"
 296 static void mei_wd(struct mei_cl_device *cldev)
 297 {
 298         struct pci_dev *pdev = to_pci_dev(cldev->dev.parent);
 299
 300         if (pdev->device == MEI_DEV_ID_WPT_LP ||
 301             pdev->device == MEI_DEV_ID_SPT ||
 302             pdev->device == MEI_DEV_ID_SPT_H)
 303                 cldev->me_cl->props.protocol_version = 0x2;
 304
 305         cldev->do_match = 1;
 306 }
 307 #else
 308 static inline void mei_wd(struct mei_cl_device *cldev) {}
 309 #endif /* CONFIG_INTEL_MEI_ME */
 310
 311 struct mei_nfc_cmd {
 312         u8 command;
 313         u8 status;
 314         u16 req_id;
 315         u32 reserved;
 316         u16 data_size;
 317         u8 sub_command;
 318         u8 data[];
 319 } __packed;
 320
 321 struct mei_nfc_reply {
 322         u8 command;
 323         u8 status;
 324         u16 req_id;
 325         u32 reserved;
 326         u16 data_size;
 327         u8 sub_command;
 328         u8 reply_status;
 329         u8 data[];
 330 } __packed;
 331
 332 struct mei_nfc_if_version {
 333         u8 radio_version_sw[3];
 334         u8 reserved[3];
 335         u8 radio_version_hw[3];
 336         u8 i2c_addr;
 337         u8 fw_ivn;
 338         u8 vendor_id;
 339         u8 radio_type;
 340 } __packed;
 341
 342
 343 #define MEI_NFC_CMD_MAINTENANCE 0x00
 344 #define MEI_NFC_SUBCMD_IF_VERSION 0x01
 345
 346 /* Vendors */
 347 #define MEI_NFC_VENDOR_INSIDE 0x00
 348 #define MEI_NFC_VENDOR_NXP    0x01
 349
 350 /* Radio types */
 351 #define MEI_NFC_VENDOR_INSIDE_UREAD 0x00
 352 #define MEI_NFC_VENDOR_NXP_PN544    0x01
 353
 354 /**
 355  * mei_nfc_if_version - get NFC interface version
 356  *
 357  * @cl: host client (nfc info)
 358  * @ver: NFC interface version to be filled in
 359  *
 360  * Return: 0 on success; < 0 otherwise
 361  */
 362 static int mei_nfc_if_version(struct mei_cl *cl,
 363                               struct mei_nfc_if_version *ver)
 364 {
 365         struct mei_device *bus;
 366         struct mei_nfc_cmd cmd = {
 367                 .command = MEI_NFC_CMD_MAINTENANCE,
 368                 .data_size = 1,
 369                 .sub_command = MEI_NFC_SUBCMD_IF_VERSION,
 370         };
 371         struct mei_nfc_reply *reply = NULL;
 372         size_t if_version_length;
 373         u8 vtag;
 374         int bytes_recv, ret;
 375
 376         bus = cl->dev;
 377
 378         WARN_ON(mutex_is_locked(&bus->device_lock));
 379
 380         ret = __mei_cl_send(cl, (u8 *)&cmd, sizeof(cmd), 0,
 381                             MEI_CL_IO_TX_BLOCKING);
 382         if (ret < 0) {
 383                 dev_err(bus->dev, "Could not send IF version cmd ret = %d\n", ret);
 384                 return ret;
 385         }
 386
 387         /* to be sure on the stack we alloc memory */
 388         if_version_length = sizeof(*reply) + sizeof(*ver);
 389
 390         reply = kzalloc(if_version_length, GFP_KERNEL);
 391         if (!reply)
 392                 return -ENOMEM;
 393
 394         ret = 0;
 395         bytes_recv = __mei_cl_recv(cl, (u8 *)reply, if_version_length, &vtag,
 396                                    0, 0);
 397         if (bytes_recv < 0 || (size_t)bytes_recv < if_version_length) {
 398                 dev_err(bus->dev, "Could not read IF version ret = %d\n", bytes_recv);
 399                 ret = -EIO;
 400                 goto err;
 401         }
 402
 403         memcpy(ver, reply->data, sizeof(*ver));
 404
 405         dev_info(bus->dev, "NFC MEI VERSION: IVN 0x%x Vendor ID 0x%x Type 0x%x\n",
 406                  ver->fw_ivn, ver->vendor_id, ver->radio_type);
 407
 408 err:
 409         kfree(reply);
 410         return ret;
 411 }
 412
 413 /**
 414  * mei_nfc_radio_name - derive nfc radio name from the interface version
 415  *
 416  * @ver: NFC radio version
 417  *
 418  * Return: radio name string
 419  */
 420 static const char *mei_nfc_radio_name(struct mei_nfc_if_version *ver)
 421 {
 422
 423         if (ver->vendor_id == MEI_NFC_VENDOR_INSIDE) {
 424                 if (ver->radio_type == MEI_NFC_VENDOR_INSIDE_UREAD)
 425                         return "microread";
 426         }
 427
 428         if (ver->vendor_id == MEI_NFC_VENDOR_NXP) {
 429                 if (ver->radio_type == MEI_NFC_VENDOR_NXP_PN544)
 430                         return "pn544";
 431         }
 432
 433         return NULL;
 434 }
 435
 436 /**
 437  * mei_nfc - The nfc fixup function. The function retrieves nfc radio
 438  *    name and set is as device attribute so we can load
 439  *    the proper device driver for it
 440  *
 441  * @cldev: me client device (nfc)
 442  */
 443 static void mei_nfc(struct mei_cl_device *cldev)
 444 {
 445         struct mei_device *bus;
 446         struct mei_cl *cl;
 447         struct mei_me_client *me_cl = NULL;
 448         struct mei_nfc_if_version ver;
 449         const char *radio_name = NULL;
 450         int ret;
 451
 452         bus = cldev->bus;
 453
 454         mutex_lock(&bus->device_lock);
 455         /* we need to connect to INFO GUID */
 456         cl = mei_cl_alloc_linked(bus);
 457         if (IS_ERR(cl)) {
 458                 ret = PTR_ERR(cl);
 459                 cl = NULL;
 460                 dev_err(bus->dev, "nfc hook alloc failed %d\n", ret);
 461                 goto out;
 462         }
 463
 464         me_cl = mei_me_cl_by_uuid(bus, &mei_nfc_info_guid);
 465         if (!me_cl) {
 466                 ret = -ENOTTY;
 467                 dev_err(bus->dev, "Cannot find nfc info %d\n", ret);
 468                 goto out;
 469         }
 470
 471         ret = mei_cl_connect(cl, me_cl, NULL);
 472         if (ret < 0) {
 473                 dev_err(&cldev->dev, "Can't connect to the NFC INFO ME ret = %d\n",
 474                         ret);
 475                 goto out;
 476         }
 477
 478         mutex_unlock(&bus->device_lock);
 479
 480         ret = mei_nfc_if_version(cl, &ver);
 481         if (ret)
 482                 goto disconnect;
 483
 484         radio_name = mei_nfc_radio_name(&ver);
 485
 486         if (!radio_name) {
 487                 ret = -ENOENT;
 488                 dev_err(&cldev->dev, "Can't get the NFC interface version ret = %d\n",
 489                         ret);
 490                 goto disconnect;
 491         }
 492
 493         dev_dbg(bus->dev, "nfc radio %s\n", radio_name);
 494         strscpy(cldev->name, radio_name, sizeof(cldev->name));
 495
 496 disconnect:
 497         mutex_lock(&bus->device_lock);
 498         if (mei_cl_disconnect(cl) < 0)
 499                 dev_err(bus->dev, "Can't disconnect the NFC INFO ME\n");
 500
 501         mei_cl_flush_queues(cl, NULL);
 502
 503 out:
 504         mei_cl_unlink(cl);
 505         mutex_unlock(&bus->device_lock);
 506         mei_me_cl_put(me_cl);
 507         kfree(cl);
 508
 509         if (ret)
 510                 cldev->do_match = 0;
 511
 512         dev_dbg(bus->dev, "end of fixup match = %d\n", cldev->do_match);
 513 }
 514
 515 /**
 516  * vt_support - enable on bus clients with vtag support
 517  *
 518  * @cldev: me clients device
 519  */
 520 static void vt_support(struct mei_cl_device *cldev)
 521 {
 522         if (cldev->me_cl->props.vt_supported == 1)
 523                 cldev->do_match = 1;
 524 }
 525
 526 /**
 527  * pxp_is_ready - enable bus client if pxp is ready
 528  *
 529  * @cldev: me clients device
 530  */
 531 static void pxp_is_ready(struct mei_cl_device *cldev)
 532 {
 533         struct mei_device *bus = cldev->bus;
 534
 535         switch (bus->pxp_mode) {
 536         case MEI_DEV_PXP_READY:
 537         case MEI_DEV_PXP_DEFAULT:
 538                 cldev->do_match = 1;
 539         break;
 540         default:
 541                 cldev->do_match = 0;
 542         break;
 543         }
 544 }
 545
 546 #define MEI_FIXUP(_uuid, _hook) { _uuid, _hook }
 547
 548 static struct mei_fixup {
 549
 550         const uuid_le uuid;
 551         void (*hook)(struct mei_cl_device *cldev);
 552 } mei_fixups[] = {
 553         MEI_FIXUP(MEI_UUID_ANY, number_of_connections),
 554         MEI_FIXUP(MEI_UUID_NFC_INFO, blacklist),
 555         MEI_FIXUP(MEI_UUID_NFC_HCI, mei_nfc),
 556         MEI_FIXUP(MEI_UUID_WD, mei_wd),
 557         MEI_FIXUP(MEI_UUID_MKHIF_FIX, mei_mkhi_fix),
 558         MEI_FIXUP(MEI_UUID_IGSC_MKHI, mei_gsc_mkhi_ver),
 559         MEI_FIXUP(MEI_UUID_IGSC_MKHI_FIX, mei_gsc_mkhi_fix_ver),
 560         MEI_FIXUP(MEI_UUID_HDCP, whitelist),
 561         MEI_FIXUP(MEI_UUID_ANY, vt_support),
 562         MEI_FIXUP(MEI_UUID_PAVP, pxp_is_ready),
 563 };
 564
 565 /**
 566  * mei_cl_bus_dev_fixup - run fixup handlers
 567  *
 568  * @cldev: me client device
 569  */
 570 void mei_cl_bus_dev_fixup(struct mei_cl_device *cldev)
 571 {
 572         struct mei_fixup *f;
 573         const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
 574         size_t i;
 575
 576         for (i = 0; i < ARRAY_SIZE(mei_fixups); i++) {
 577
 578                 f = &mei_fixups[i];
 579                 if (uuid_le_cmp(f->uuid, MEI_UUID_ANY) == 0 ||
 580                     uuid_le_cmp(f->uuid, *uuid) == 0)
 581                         f->hook(cldev);
 582         }
 583 }
 584