drivers/misc/mei/bus-fixup.c

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