3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2013, Intel Corporation.
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.
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
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/pci.h>
23 #include <linux/mei_cl_bus.h>
38 struct mei_nfc_reply {
49 struct mei_nfc_if_version {
50 u8 radio_version_sw[3];
52 u8 radio_version_hw[3];
59 struct mei_nfc_connect {
64 struct mei_nfc_connect_resp {
73 struct mei_nfc_hci_hdr {
81 #define MEI_NFC_CMD_MAINTENANCE 0x00
82 #define MEI_NFC_CMD_HCI_SEND 0x01
83 #define MEI_NFC_CMD_HCI_RECV 0x02
85 #define MEI_NFC_SUBCMD_CONNECT 0x00
86 #define MEI_NFC_SUBCMD_IF_VERSION 0x01
88 #define MEI_NFC_HEADER_SIZE 10
90 /** mei_nfc_dev - NFC mei device
92 * @cl: NFC host client
93 * @cl_info: NFC info host client
94 * @init_work: perform connection to the info client
95 * @fw_ivn: NFC Interface Version Number
96 * @vendor_id: NFC manufacturer ID
97 * @radio_type: NFC radio type
101 struct mei_cl *cl_info;
102 struct work_struct init_work;
103 wait_queue_head_t send_wq;
113 static struct mei_nfc_dev nfc_dev;
115 /* UUIDs for NFC F/W clients */
116 const uuid_le mei_nfc_guid = UUID_LE(0x0bb17a78, 0x2a8e, 0x4c50,
117 0x94, 0xd4, 0x50, 0x26,
118 0x67, 0x23, 0x77, 0x5c);
120 static const uuid_le mei_nfc_info_guid = UUID_LE(0xd2de1625, 0x382d, 0x417d,
121 0x48, 0xa4, 0xef, 0xab,
122 0xba, 0x8a, 0x12, 0x06);
125 #define MEI_NFC_VENDOR_INSIDE 0x00
126 #define MEI_NFC_VENDOR_NXP 0x01
129 #define MEI_NFC_VENDOR_INSIDE_UREAD 0x00
130 #define MEI_NFC_VENDOR_NXP_PN544 0x01
132 static void mei_nfc_free(struct mei_nfc_dev *ndev)
135 list_del(&ndev->cl->device_link);
136 mei_cl_unlink(ndev->cl);
141 list_del(&ndev->cl_info->device_link);
142 mei_cl_unlink(ndev->cl_info);
143 kfree(ndev->cl_info);
146 memset(ndev, 0, sizeof(struct mei_nfc_dev));
149 static int mei_nfc_build_bus_name(struct mei_nfc_dev *ndev)
151 struct mei_device *dev;
158 switch (ndev->vendor_id) {
159 case MEI_NFC_VENDOR_INSIDE:
160 switch (ndev->radio_type) {
161 case MEI_NFC_VENDOR_INSIDE_UREAD:
162 ndev->bus_name = "microread";
166 dev_err(&dev->pdev->dev, "Unknown radio type 0x%x\n",
172 case MEI_NFC_VENDOR_NXP:
173 switch (ndev->radio_type) {
174 case MEI_NFC_VENDOR_NXP_PN544:
175 ndev->bus_name = "pn544";
178 dev_err(&dev->pdev->dev, "Unknown radio type 0x%x\n",
185 dev_err(&dev->pdev->dev, "Unknown vendor ID 0x%x\n",
194 static int mei_nfc_connect(struct mei_nfc_dev *ndev)
196 struct mei_device *dev;
198 struct mei_nfc_cmd *cmd, *reply;
199 struct mei_nfc_connect *connect;
200 struct mei_nfc_connect_resp *connect_resp;
201 size_t connect_length, connect_resp_length;
207 connect_length = sizeof(struct mei_nfc_cmd) +
208 sizeof(struct mei_nfc_connect);
210 connect_resp_length = sizeof(struct mei_nfc_cmd) +
211 sizeof(struct mei_nfc_connect_resp);
213 cmd = kzalloc(connect_length, GFP_KERNEL);
216 connect = (struct mei_nfc_connect *)cmd->data;
218 reply = kzalloc(connect_resp_length, GFP_KERNEL);
224 connect_resp = (struct mei_nfc_connect_resp *)reply->data;
226 cmd->command = MEI_NFC_CMD_MAINTENANCE;
228 cmd->sub_command = MEI_NFC_SUBCMD_CONNECT;
229 connect->fw_ivn = ndev->fw_ivn;
230 connect->vendor_id = ndev->vendor_id;
232 ret = __mei_cl_send(cl, (u8 *)cmd, connect_length);
234 dev_err(&dev->pdev->dev, "Could not send connect cmd\n");
238 bytes_recv = __mei_cl_recv(cl, (u8 *)reply, connect_resp_length);
239 if (bytes_recv < 0) {
240 dev_err(&dev->pdev->dev, "Could not read connect response\n");
245 dev_info(&dev->pdev->dev, "IVN 0x%x Vendor ID 0x%x\n",
246 connect_resp->fw_ivn, connect_resp->vendor_id);
248 dev_info(&dev->pdev->dev, "ME FW %d.%d.%d.%d\n",
249 connect_resp->me_major, connect_resp->me_minor,
250 connect_resp->me_hotfix, connect_resp->me_build);
261 static int mei_nfc_if_version(struct mei_nfc_dev *ndev)
263 struct mei_device *dev;
266 struct mei_nfc_cmd cmd;
267 struct mei_nfc_reply *reply = NULL;
268 struct mei_nfc_if_version *version;
269 size_t if_version_length;
275 memset(&cmd, 0, sizeof(struct mei_nfc_cmd));
276 cmd.command = MEI_NFC_CMD_MAINTENANCE;
278 cmd.sub_command = MEI_NFC_SUBCMD_IF_VERSION;
280 ret = __mei_cl_send(cl, (u8 *)&cmd, sizeof(struct mei_nfc_cmd));
282 dev_err(&dev->pdev->dev, "Could not send IF version cmd\n");
286 /* to be sure on the stack we alloc memory */
287 if_version_length = sizeof(struct mei_nfc_reply) +
288 sizeof(struct mei_nfc_if_version);
290 reply = kzalloc(if_version_length, GFP_KERNEL);
294 bytes_recv = __mei_cl_recv(cl, (u8 *)reply, if_version_length);
295 if (bytes_recv < 0 || bytes_recv < sizeof(struct mei_nfc_reply)) {
296 dev_err(&dev->pdev->dev, "Could not read IF version\n");
301 version = (struct mei_nfc_if_version *)reply->data;
303 ndev->fw_ivn = version->fw_ivn;
304 ndev->vendor_id = version->vendor_id;
305 ndev->radio_type = version->radio_type;
312 static int mei_nfc_enable(struct mei_cl_device *cldev)
314 struct mei_device *dev;
315 struct mei_nfc_dev *ndev = &nfc_dev;
320 ret = mei_nfc_connect(ndev);
322 dev_err(&dev->pdev->dev, "Could not connect to NFC");
329 static int mei_nfc_disable(struct mei_cl_device *cldev)
334 static int mei_nfc_send(struct mei_cl_device *cldev, u8 *buf, size_t length)
336 struct mei_device *dev;
337 struct mei_nfc_dev *ndev;
338 struct mei_nfc_hci_hdr *hdr;
342 ndev = (struct mei_nfc_dev *) cldev->priv_data;
346 mei_buf = kzalloc(length + MEI_NFC_HEADER_SIZE, GFP_KERNEL);
350 hdr = (struct mei_nfc_hci_hdr *) mei_buf;
351 hdr->cmd = MEI_NFC_CMD_HCI_SEND;
353 hdr->req_id = ndev->req_id;
355 hdr->data_size = length;
357 memcpy(mei_buf + MEI_NFC_HEADER_SIZE, buf, length);
358 err = __mei_cl_send(ndev->cl, mei_buf, length + MEI_NFC_HEADER_SIZE);
362 if (!wait_event_interruptible_timeout(ndev->send_wq,
363 ndev->recv_req_id == ndev->req_id, HZ)) {
364 dev_err(&dev->pdev->dev, "NFC MEI command timeout\n");
374 static int mei_nfc_recv(struct mei_cl_device *cldev, u8 *buf, size_t length)
376 struct mei_nfc_dev *ndev;
377 struct mei_nfc_hci_hdr *hci_hdr;
380 ndev = (struct mei_nfc_dev *)cldev->priv_data;
382 received_length = __mei_cl_recv(ndev->cl, buf, length);
383 if (received_length < 0)
384 return received_length;
386 hci_hdr = (struct mei_nfc_hci_hdr *) buf;
388 if (hci_hdr->cmd == MEI_NFC_CMD_HCI_SEND) {
389 ndev->recv_req_id = hci_hdr->req_id;
390 wake_up(&ndev->send_wq);
395 return received_length;
398 static struct mei_cl_ops nfc_ops = {
399 .enable = mei_nfc_enable,
400 .disable = mei_nfc_disable,
401 .send = mei_nfc_send,
402 .recv = mei_nfc_recv,
405 static void mei_nfc_init(struct work_struct *work)
407 struct mei_device *dev;
408 struct mei_cl_device *cldev;
409 struct mei_nfc_dev *ndev;
410 struct mei_cl *cl_info;
412 ndev = container_of(work, struct mei_nfc_dev, init_work);
414 cl_info = ndev->cl_info;
417 mutex_lock(&dev->device_lock);
419 if (mei_cl_connect(cl_info, NULL) < 0) {
420 mutex_unlock(&dev->device_lock);
421 dev_err(&dev->pdev->dev,
422 "Could not connect to the NFC INFO ME client");
427 mutex_unlock(&dev->device_lock);
429 if (mei_nfc_if_version(ndev) < 0) {
430 dev_err(&dev->pdev->dev, "Could not get the NFC interface version");
435 dev_info(&dev->pdev->dev,
436 "NFC MEI VERSION: IVN 0x%x Vendor ID 0x%x Type 0x%x\n",
437 ndev->fw_ivn, ndev->vendor_id, ndev->radio_type);
439 mutex_lock(&dev->device_lock);
441 if (mei_cl_disconnect(cl_info) < 0) {
442 mutex_unlock(&dev->device_lock);
443 dev_err(&dev->pdev->dev,
444 "Could not disconnect the NFC INFO ME client");
449 mutex_unlock(&dev->device_lock);
451 if (mei_nfc_build_bus_name(ndev) < 0) {
452 dev_err(&dev->pdev->dev,
453 "Could not build the bus ID name\n");
457 cldev = mei_cl_add_device(dev, mei_nfc_guid, ndev->bus_name, &nfc_ops);
459 dev_err(&dev->pdev->dev,
460 "Could not add the NFC device to the MEI bus\n");
465 cldev->priv_data = ndev;
471 mutex_lock(&dev->device_lock);
473 mutex_unlock(&dev->device_lock);
479 int mei_nfc_host_init(struct mei_device *dev)
481 struct mei_nfc_dev *ndev = &nfc_dev;
482 struct mei_cl *cl_info, *cl = NULL;
485 /* already initialized */
489 ndev->cl_info = mei_cl_allocate(dev);
490 ndev->cl = mei_cl_allocate(dev);
493 cl_info = ndev->cl_info;
495 if (!cl || !cl_info) {
500 /* check for valid client id */
501 i = mei_me_cl_by_uuid(dev, &mei_nfc_info_guid);
503 dev_info(&dev->pdev->dev, "nfc: failed to find the client\n");
508 cl_info->me_client_id = dev->me_clients[i].client_id;
510 ret = mei_cl_link(cl_info, MEI_HOST_CLIENT_ID_ANY);
514 cl_info->device_uuid = mei_nfc_info_guid;
516 list_add_tail(&cl_info->device_link, &dev->device_list);
518 /* check for valid client id */
519 i = mei_me_cl_by_uuid(dev, &mei_nfc_guid);
521 dev_info(&dev->pdev->dev, "nfc: failed to find the client\n");
526 cl->me_client_id = dev->me_clients[i].client_id;
528 ret = mei_cl_link(cl, MEI_HOST_CLIENT_ID_ANY);
532 cl->device_uuid = mei_nfc_guid;
535 list_add_tail(&cl->device_link, &dev->device_list);
539 INIT_WORK(&ndev->init_work, mei_nfc_init);
540 init_waitqueue_head(&ndev->send_wq);
541 schedule_work(&ndev->init_work);
551 void mei_nfc_host_exit(struct mei_device *dev)
553 struct mei_nfc_dev *ndev = &nfc_dev;
554 cancel_work_sync(&ndev->init_work);