bus-fixup.c 9.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
 * Copyright (c) 2003-2013, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#include <linux/kernel.h>
S
Samuel Ortiz 已提交
18
#include <linux/sched.h>
19 20 21
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/device.h>
22
#include <linux/slab.h>
23
#include <linux/uuid.h>
24

25 26 27 28 29
#include <linux/mei_cl_bus.h>

#include "mei_dev.h"
#include "client.h"

30 31 32
#define MEI_UUID_NFC_INFO UUID_LE(0xd2de1625, 0x382d, 0x417d, \
			0x48, 0xa4, 0xef, 0xab, 0xba, 0x8a, 0x12, 0x06)

33 34
#define MEI_UUID_ANY NULL_UUID_LE

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * number_of_connections - determine whether an client be on the bus
 *    according number of connections
 *    We support only clients:
 *       1. with single connection
 *       2. and fixed clients (max_number_of_connections == 0)
 *
 * @cldev: me clients device
 */
static void number_of_connections(struct mei_cl_device *cldev)
{
	dev_dbg(&cldev->dev, "running hook %s on %pUl\n",
			__func__, mei_me_cl_uuid(cldev->me_cl));

	if (cldev->me_cl->props.max_number_of_connections > 1)
		cldev->do_match = 0;
}

53 54 55 56 57 58 59 60 61 62 63 64
/**
 * blacklist - blacklist a client from the bus
 *
 * @cldev: me clients device
 */
static void blacklist(struct mei_cl_device *cldev)
{
	dev_dbg(&cldev->dev, "running hook %s on %pUl\n",
			__func__, mei_me_cl_uuid(cldev->me_cl));
	cldev->do_match = 0;
}

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
struct mei_nfc_cmd {
	u8 command;
	u8 status;
	u16 req_id;
	u32 reserved;
	u16 data_size;
	u8 sub_command;
	u8 data[];
} __packed;

struct mei_nfc_reply {
	u8 command;
	u8 status;
	u16 req_id;
	u32 reserved;
	u16 data_size;
	u8 sub_command;
	u8 reply_status;
	u8 data[];
} __packed;

struct mei_nfc_if_version {
	u8 radio_version_sw[3];
	u8 reserved[3];
	u8 radio_version_hw[3];
	u8 i2c_addr;
	u8 fw_ivn;
	u8 vendor_id;
	u8 radio_type;
} __packed;

struct mei_nfc_connect {
	u8 fw_ivn;
	u8 vendor_id;
} __packed;

struct mei_nfc_connect_resp {
	u8 fw_ivn;
	u8 vendor_id;
	u16 me_major;
	u16 me_minor;
	u16 me_hotfix;
	u16 me_build;
} __packed;

struct mei_nfc_hci_hdr {
	u8 cmd;
	u8 status;
	u16 req_id;
	u32 reserved;
	u16 data_size;
} __packed;

#define MEI_NFC_CMD_MAINTENANCE 0x00
#define MEI_NFC_CMD_HCI_SEND 0x01
#define MEI_NFC_CMD_HCI_RECV 0x02

#define MEI_NFC_SUBCMD_CONNECT    0x00
#define MEI_NFC_SUBCMD_IF_VERSION 0x01

#define MEI_NFC_HEADER_SIZE 10

127 128
/**
 * struct mei_nfc_dev - NFC mei device
129
 *
130
 * @me_cl: NFC me client
131 132 133
 * @cl: NFC host client
 * @cl_info: NFC info host client
 * @init_work: perform connection to the info client
134
 * @fw_ivn: NFC Interface Version Number
135 136
 * @vendor_id: NFC manufacturer ID
 * @radio_type: NFC radio type
A
Alexander Usyskin 已提交
137 138
 * @bus_name: bus name
 *
139 140
 */
struct mei_nfc_dev {
141
	struct mei_me_client *me_cl;
142 143 144 145 146 147
	struct mei_cl *cl;
	struct mei_cl *cl_info;
	struct work_struct init_work;
	u8 fw_ivn;
	u8 vendor_id;
	u8 radio_type;
148
	char *bus_name;
149 150 151 152 153 154 155
};

/* UUIDs for NFC F/W clients */
const uuid_le mei_nfc_guid = UUID_LE(0x0bb17a78, 0x2a8e, 0x4c50,
				     0x94, 0xd4, 0x50, 0x26,
				     0x67, 0x23, 0x77, 0x5c);

156
static const uuid_le mei_nfc_info_guid = MEI_UUID_NFC_INFO;
157

158 159 160 161 162 163 164 165
/* Vendors */
#define MEI_NFC_VENDOR_INSIDE 0x00
#define MEI_NFC_VENDOR_NXP    0x01

/* Radio types */
#define MEI_NFC_VENDOR_INSIDE_UREAD 0x00
#define MEI_NFC_VENDOR_NXP_PN544    0x01

166 167
static void mei_nfc_free(struct mei_nfc_dev *ndev)
{
168 169 170
	if (!ndev)
		return;

171 172 173 174 175 176 177 178 179 180 181
	if (ndev->cl) {
		list_del(&ndev->cl->device_link);
		mei_cl_unlink(ndev->cl);
		kfree(ndev->cl);
	}

	if (ndev->cl_info) {
		list_del(&ndev->cl_info->device_link);
		mei_cl_unlink(ndev->cl_info);
		kfree(ndev->cl_info);
	}
T
Tomas Winkler 已提交
182

183
	mei_me_cl_put(ndev->me_cl);
184
	kfree(ndev);
185 186
}

187 188
static int mei_nfc_build_bus_name(struct mei_nfc_dev *ndev)
{
189
	struct mei_device *bus;
190 191 192 193

	if (!ndev->cl)
		return -ENODEV;

194
	bus = ndev->cl->dev;
195 196 197 198 199 200 201 202 203

	switch (ndev->vendor_id) {
	case MEI_NFC_VENDOR_INSIDE:
		switch (ndev->radio_type) {
		case MEI_NFC_VENDOR_INSIDE_UREAD:
			ndev->bus_name = "microread";
			return 0;

		default:
204
			dev_err(bus->dev, "Unknown radio type 0x%x\n",
205 206 207 208 209 210 211 212 213 214 215
				ndev->radio_type);

			return -EINVAL;
		}

	case MEI_NFC_VENDOR_NXP:
		switch (ndev->radio_type) {
		case MEI_NFC_VENDOR_NXP_PN544:
			ndev->bus_name = "pn544";
			return 0;
		default:
216
			dev_err(bus->dev, "Unknown radio type 0x%x\n",
217 218 219 220 221 222
				ndev->radio_type);

			return -EINVAL;
		}

	default:
223
		dev_err(bus->dev, "Unknown vendor ID 0x%x\n",
224 225 226 227 228 229 230 231
			ndev->vendor_id);

		return -EINVAL;
	}

	return 0;
}

232 233
static int mei_nfc_if_version(struct mei_nfc_dev *ndev)
{
234
	struct mei_device *bus;
235 236 237 238 239 240 241 242 243
	struct mei_cl *cl;

	struct mei_nfc_cmd cmd;
	struct mei_nfc_reply *reply = NULL;
	struct mei_nfc_if_version *version;
	size_t if_version_length;
	int bytes_recv, ret;

	cl = ndev->cl_info;
244
	bus = cl->dev;
245 246 247 248 249 250

	memset(&cmd, 0, sizeof(struct mei_nfc_cmd));
	cmd.command = MEI_NFC_CMD_MAINTENANCE;
	cmd.data_size = 1;
	cmd.sub_command = MEI_NFC_SUBCMD_IF_VERSION;

251
	ret = __mei_cl_send(cl, (u8 *)&cmd, sizeof(struct mei_nfc_cmd), 1);
252
	if (ret < 0) {
253
		dev_err(bus->dev, "Could not send IF version cmd\n");
254 255 256 257 258 259 260 261 262 263 264 265 266
		return ret;
	}

	/* to be sure on the stack we alloc memory */
	if_version_length = sizeof(struct mei_nfc_reply) +
		sizeof(struct mei_nfc_if_version);

	reply = kzalloc(if_version_length, GFP_KERNEL);
	if (!reply)
		return -ENOMEM;

	bytes_recv = __mei_cl_recv(cl, (u8 *)reply, if_version_length);
	if (bytes_recv < 0 || bytes_recv < sizeof(struct mei_nfc_reply)) {
267
		dev_err(bus->dev, "Could not read IF version\n");
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
		ret = -EIO;
		goto err;
	}

	version = (struct mei_nfc_if_version *)reply->data;

	ndev->fw_ivn = version->fw_ivn;
	ndev->vendor_id = version->vendor_id;
	ndev->radio_type = version->radio_type;

err:
	kfree(reply);
	return ret;
}

static void mei_nfc_init(struct work_struct *work)
{
285
	struct mei_device *bus;
286
	struct mei_cl_device *cldev;
287 288
	struct mei_nfc_dev *ndev;
	struct mei_cl *cl_info;
289
	struct mei_me_client *me_cl_info;
290 291 292 293

	ndev = container_of(work, struct mei_nfc_dev, init_work);

	cl_info = ndev->cl_info;
294
	bus = cl_info->dev;
295

296
	mutex_lock(&bus->device_lock);
297

298
	/* check for valid client id */
299
	me_cl_info = mei_me_cl_by_uuid(bus, &mei_nfc_info_guid);
300
	if (!me_cl_info) {
301 302
		mutex_unlock(&bus->device_lock);
		dev_info(bus->dev, "nfc: failed to find the info client\n");
303 304 305 306 307
		goto err;
	}

	if (mei_cl_connect(cl_info, me_cl_info, NULL) < 0) {
		mei_me_cl_put(me_cl_info);
308 309
		mutex_unlock(&bus->device_lock);
		dev_err(bus->dev, "Could not connect to the NFC INFO ME client");
310 311 312

		goto err;
	}
313
	mei_me_cl_put(me_cl_info);
314
	mutex_unlock(&bus->device_lock);
315 316

	if (mei_nfc_if_version(ndev) < 0) {
317
		dev_err(bus->dev, "Could not get the NFC interface version");
318 319 320 321

		goto err;
	}

322
	dev_info(bus->dev, "NFC MEI VERSION: IVN 0x%x Vendor ID 0x%x Type 0x%x\n",
323 324
		ndev->fw_ivn, ndev->vendor_id, ndev->radio_type);

325
	mutex_lock(&bus->device_lock);
326 327

	if (mei_cl_disconnect(cl_info) < 0) {
328 329
		mutex_unlock(&bus->device_lock);
		dev_err(bus->dev, "Could not disconnect the NFC INFO ME client");
330 331 332 333

		goto err;
	}

334
	mutex_unlock(&bus->device_lock);
335

336
	if (mei_nfc_build_bus_name(ndev) < 0) {
337
		dev_err(bus->dev, "Could not build the bus ID name\n");
338 339 340
		return;
	}

341
	cldev = mei_cl_add_device(bus, ndev->me_cl, ndev->cl,
342
				  ndev->bus_name);
343
	if (!cldev) {
344
		dev_err(bus->dev, "Could not add the NFC device to the MEI bus\n");
345 346 347 348 349 350 351

		goto err;
	}

	cldev->priv_data = ndev;


352 353 354
	return;

err:
355
	mutex_lock(&bus->device_lock);
356
	mei_nfc_free(ndev);
357
	mutex_unlock(&bus->device_lock);
358 359 360 361

}


362
int mei_nfc_host_init(struct mei_device *bus, struct mei_me_client *me_cl)
363
{
364
	struct mei_nfc_dev *ndev;
365
	struct mei_cl *cl_info, *cl;
366
	int ret;
367

368 369 370 371

	/* in case of internal reset bail out
	 * as the device is already setup
	 */
372
	cl = mei_cl_bus_find_cl_by_uuid(bus, mei_nfc_guid);
373
	if (cl)
374 375
		return 0;

376 377 378 379 380 381
	ndev = kzalloc(sizeof(struct mei_nfc_dev), GFP_KERNEL);
	if (!ndev) {
		ret = -ENOMEM;
		goto err;
	}

382 383 384
	ndev->me_cl = mei_me_cl_get(me_cl);
	if (!ndev->me_cl) {
		ret = -ENODEV;
385 386 387
		goto err;
	}

388
	cl_info = mei_cl_alloc_linked(bus, MEI_HOST_CLIENT_ID_ANY);
389 390 391 392 393
	if (IS_ERR(cl_info)) {
		ret = PTR_ERR(cl_info);
		goto err;
	}

394
	list_add_tail(&cl_info->device_link, &bus->device_list);
395

396 397
	ndev->cl_info = cl_info;

398
	cl = mei_cl_alloc_linked(bus, MEI_HOST_CLIENT_ID_ANY);
399 400 401 402 403
	if (IS_ERR(cl)) {
		ret = PTR_ERR(cl);
		goto err;
	}

404
	list_add_tail(&cl->device_link, &bus->device_list);
405

406 407
	ndev->cl = cl;

408 409 410 411 412 413 414 415 416 417 418
	INIT_WORK(&ndev->init_work, mei_nfc_init);
	schedule_work(&ndev->init_work);

	return 0;

err:
	mei_nfc_free(ndev);

	return ret;
}

419
void mei_nfc_host_exit(struct mei_device *bus)
420
{
421 422 423 424
	struct mei_nfc_dev *ndev;
	struct mei_cl *cl;
	struct mei_cl_device *cldev;

425
	cl = mei_cl_bus_find_cl_by_uuid(bus, mei_nfc_guid);
426 427 428
	if (!cl)
		return;

429
	cldev = cl->cldev;
430 431
	if (!cldev)
		return;
432

433 434 435 436 437 438 439 440 441 442
	ndev = (struct mei_nfc_dev *)cldev->priv_data;
	if (ndev)
		cancel_work_sync(&ndev->init_work);

	cldev->priv_data = NULL;

	/* Need to remove the device here
	 * since mei_nfc_free will unlink the clients
	 */
	mei_cl_remove_device(cldev);
443

444
	mutex_lock(&bus->device_lock);
445
	mei_nfc_free(ndev);
446
	mutex_unlock(&bus->device_lock);
447
}
T
Tomas Winkler 已提交
448

449 450 451 452 453 454
#define MEI_FIXUP(_uuid, _hook) { _uuid, _hook }

static struct mei_fixup {

	const uuid_le uuid;
	void (*hook)(struct mei_cl_device *cldev);
455
} mei_fixups[] = {
456
	MEI_FIXUP(MEI_UUID_ANY, number_of_connections),
457 458
	MEI_FIXUP(MEI_UUID_NFC_INFO, blacklist),
};
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478

/**
 * mei_cl_dev_fixup - run fixup handlers
 *
 * @cldev: me client device
 */
void mei_cl_dev_fixup(struct mei_cl_device *cldev)
{
	struct mei_fixup *f;
	const uuid_le *uuid = mei_me_cl_uuid(cldev->me_cl);
	int i;

	for (i = 0; i < ARRAY_SIZE(mei_fixups); i++) {

		f = &mei_fixups[i];
		if (uuid_le_cmp(f->uuid, MEI_UUID_ANY) == 0 ||
		    uuid_le_cmp(f->uuid, *uuid) == 0)
			f->hook(cldev);
	}
}
479