]>
Commit | Line | Data |
---|---|---|
3703f53b SP |
1 | /* |
2 | * ISHTP bus driver | |
3 | * | |
4 | * Copyright (c) 2012-2016, Intel Corporation. | |
5 | * | |
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. | |
9 | * | |
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 | |
13 | * more details. | |
14 | */ | |
15 | ||
16 | #include <linux/module.h> | |
17 | #include <linux/init.h> | |
18 | #include <linux/kernel.h> | |
3703f53b SP |
19 | #include <linux/device.h> |
20 | #include <linux/sched.h> | |
21 | #include <linux/slab.h> | |
22 | #include "bus.h" | |
23 | #include "ishtp-dev.h" | |
24 | #include "client.h" | |
25 | #include "hbm.h" | |
26 | ||
27 | static int ishtp_use_dma; | |
28 | module_param_named(ishtp_use_dma, ishtp_use_dma, int, 0600); | |
29 | MODULE_PARM_DESC(ishtp_use_dma, "Use DMA to send messages"); | |
30 | ||
31 | #define to_ishtp_cl_driver(d) container_of(d, struct ishtp_cl_driver, driver) | |
32 | #define to_ishtp_cl_device(d) container_of(d, struct ishtp_cl_device, dev) | |
33 | static bool ishtp_device_ready; | |
34 | ||
35 | /** | |
36 | * ishtp_recv() - process ishtp message | |
37 | * @dev: ishtp device | |
38 | * | |
39 | * If a message with valid header and size is received, then | |
40 | * this function calls appropriate handler. The host or firmware | |
41 | * address is zero, then they are host bus management message, | |
42 | * otherwise they are message fo clients. | |
43 | */ | |
44 | void ishtp_recv(struct ishtp_device *dev) | |
45 | { | |
46 | uint32_t msg_hdr; | |
47 | struct ishtp_msg_hdr *ishtp_hdr; | |
48 | ||
49 | /* Read ISHTP header dword */ | |
50 | msg_hdr = dev->ops->ishtp_read_hdr(dev); | |
51 | if (!msg_hdr) | |
52 | return; | |
53 | ||
54 | dev->ops->sync_fw_clock(dev); | |
55 | ||
56 | ishtp_hdr = (struct ishtp_msg_hdr *)&msg_hdr; | |
57 | dev->ishtp_msg_hdr = msg_hdr; | |
58 | ||
59 | /* Sanity check: ISHTP frag. length in header */ | |
60 | if (ishtp_hdr->length > dev->mtu) { | |
61 | dev_err(dev->devc, | |
62 | "ISHTP hdr - bad length: %u; dropped [%08X]\n", | |
63 | (unsigned int)ishtp_hdr->length, msg_hdr); | |
64 | return; | |
65 | } | |
66 | ||
67 | /* ISHTP bus message */ | |
68 | if (!ishtp_hdr->host_addr && !ishtp_hdr->fw_addr) | |
69 | recv_hbm(dev, ishtp_hdr); | |
70 | /* ISHTP fixed-client message */ | |
71 | else if (!ishtp_hdr->host_addr) | |
72 | recv_fixed_cl_msg(dev, ishtp_hdr); | |
73 | else | |
74 | /* ISHTP client message */ | |
75 | recv_ishtp_cl_msg(dev, ishtp_hdr); | |
76 | } | |
77 | EXPORT_SYMBOL(ishtp_recv); | |
78 | ||
79 | /** | |
80 | * ishtp_send_msg() - Send ishtp message | |
81 | * @dev: ishtp device | |
82 | * @hdr: Message header | |
83 | * @msg: Message contents | |
84 | * @ipc_send_compl: completion callback | |
85 | * @ipc_send_compl_prm: completion callback parameter | |
86 | * | |
87 | * Send a multi fragment message via IPC. After sending the first fragment | |
88 | * the completion callback is called to schedule transmit of next fragment. | |
89 | * | |
90 | * Return: This returns IPC send message status. | |
91 | */ | |
92 | int ishtp_send_msg(struct ishtp_device *dev, struct ishtp_msg_hdr *hdr, | |
93 | void *msg, void(*ipc_send_compl)(void *), | |
94 | void *ipc_send_compl_prm) | |
95 | { | |
96 | unsigned char ipc_msg[IPC_FULL_MSG_SIZE]; | |
97 | uint32_t drbl_val; | |
98 | ||
99 | drbl_val = dev->ops->ipc_get_header(dev, hdr->length + | |
100 | sizeof(struct ishtp_msg_hdr), | |
101 | 1); | |
102 | ||
103 | memcpy(ipc_msg, &drbl_val, sizeof(uint32_t)); | |
104 | memcpy(ipc_msg + sizeof(uint32_t), hdr, sizeof(uint32_t)); | |
105 | memcpy(ipc_msg + 2 * sizeof(uint32_t), msg, hdr->length); | |
106 | return dev->ops->write(dev, ipc_send_compl, ipc_send_compl_prm, | |
107 | ipc_msg, 2 * sizeof(uint32_t) + hdr->length); | |
108 | } | |
109 | ||
110 | /** | |
111 | * ishtp_write_message() - Send ishtp single fragment message | |
112 | * @dev: ishtp device | |
113 | * @hdr: Message header | |
114 | * @buf: message data | |
115 | * | |
116 | * Send a single fragment message via IPC. This returns IPC send message | |
117 | * status. | |
118 | * | |
119 | * Return: This returns IPC send message status. | |
120 | */ | |
121 | int ishtp_write_message(struct ishtp_device *dev, struct ishtp_msg_hdr *hdr, | |
09cc8b36 | 122 | void *buf) |
3703f53b SP |
123 | { |
124 | return ishtp_send_msg(dev, hdr, buf, NULL, NULL); | |
125 | } | |
126 | ||
127 | /** | |
128 | * ishtp_fw_cl_by_uuid() - locate index of fw client | |
129 | * @dev: ishtp device | |
130 | * @uuid: uuid of the client to search | |
131 | * | |
132 | * Search firmware client using UUID. | |
133 | * | |
134 | * Return: fw client index or -ENOENT if not found | |
135 | */ | |
14106501 | 136 | int ishtp_fw_cl_by_uuid(struct ishtp_device *dev, const guid_t *uuid) |
3703f53b | 137 | { |
14106501 | 138 | unsigned int i; |
3703f53b SP |
139 | |
140 | for (i = 0; i < dev->fw_clients_num; ++i) { | |
14106501 AS |
141 | if (guid_equal(uuid, &dev->fw_clients[i].props.protocol_name)) |
142 | return i; | |
3703f53b | 143 | } |
14106501 | 144 | return -ENOENT; |
3703f53b SP |
145 | } |
146 | EXPORT_SYMBOL(ishtp_fw_cl_by_uuid); | |
147 | ||
e625020b EX |
148 | /** |
149 | * ishtp_fw_cl_get_client() - return client information to client | |
150 | * @dev: the ishtp device structure | |
151 | * @uuid: uuid of the client to search | |
152 | * | |
153 | * Search firmware client using UUID and reture related client information. | |
154 | * | |
155 | * Return: pointer of client information on success, NULL on failure. | |
156 | */ | |
157 | struct ishtp_fw_client *ishtp_fw_cl_get_client(struct ishtp_device *dev, | |
14106501 | 158 | const guid_t *uuid) |
e625020b EX |
159 | { |
160 | int i; | |
161 | unsigned long flags; | |
162 | ||
163 | spin_lock_irqsave(&dev->fw_clients_lock, flags); | |
164 | i = ishtp_fw_cl_by_uuid(dev, uuid); | |
165 | spin_unlock_irqrestore(&dev->fw_clients_lock, flags); | |
166 | if (i < 0 || dev->fw_clients[i].props.fixed_address) | |
167 | return NULL; | |
168 | ||
169 | return &dev->fw_clients[i]; | |
170 | } | |
171 | EXPORT_SYMBOL(ishtp_fw_cl_get_client); | |
172 | ||
3703f53b SP |
173 | /** |
174 | * ishtp_fw_cl_by_id() - return index to fw_clients for client_id | |
175 | * @dev: the ishtp device structure | |
176 | * @client_id: fw client id to search | |
177 | * | |
178 | * Search firmware client using client id. | |
179 | * | |
180 | * Return: index on success, -ENOENT on failure. | |
181 | */ | |
182 | int ishtp_fw_cl_by_id(struct ishtp_device *dev, uint8_t client_id) | |
183 | { | |
184 | int i, res = -ENOENT; | |
185 | unsigned long flags; | |
186 | ||
187 | spin_lock_irqsave(&dev->fw_clients_lock, flags); | |
188 | for (i = 0; i < dev->fw_clients_num; i++) { | |
189 | if (dev->fw_clients[i].client_id == client_id) { | |
190 | res = i; | |
191 | break; | |
192 | } | |
193 | } | |
194 | spin_unlock_irqrestore(&dev->fw_clients_lock, flags); | |
195 | ||
196 | return res; | |
197 | } | |
198 | ||
199 | /** | |
200 | * ishtp_cl_device_probe() - Bus probe() callback | |
201 | * @dev: the device structure | |
202 | * | |
203 | * This is a bus probe callback and calls the drive probe function. | |
204 | * | |
205 | * Return: Return value from driver probe() call. | |
206 | */ | |
207 | static int ishtp_cl_device_probe(struct device *dev) | |
208 | { | |
209 | struct ishtp_cl_device *device = to_ishtp_cl_device(dev); | |
210 | struct ishtp_cl_driver *driver; | |
211 | ||
212 | if (!device) | |
213 | return 0; | |
214 | ||
215 | driver = to_ishtp_cl_driver(dev->driver); | |
216 | if (!driver || !driver->probe) | |
217 | return -ENODEV; | |
218 | ||
219 | return driver->probe(device); | |
220 | } | |
221 | ||
6b3f75f7 HL |
222 | /** |
223 | * ishtp_cl_bus_match() - Bus match() callback | |
224 | * @dev: the device structure | |
225 | * @drv: the driver structure | |
226 | * | |
227 | * This is a bus match callback, called when a new ishtp_cl_device is | |
228 | * registered during ishtp bus client enumeration. Use the guid_t in | |
229 | * drv and dev to decide whether they match or not. | |
230 | * | |
231 | * Return: 1 if dev & drv matches, 0 otherwise. | |
232 | */ | |
233 | static int ishtp_cl_bus_match(struct device *dev, struct device_driver *drv) | |
234 | { | |
235 | struct ishtp_cl_device *device = to_ishtp_cl_device(dev); | |
236 | struct ishtp_cl_driver *driver = to_ishtp_cl_driver(drv); | |
237 | ||
238 | return guid_equal(driver->guid, | |
239 | &device->fw_client->props.protocol_name); | |
240 | } | |
241 | ||
3703f53b SP |
242 | /** |
243 | * ishtp_cl_device_remove() - Bus remove() callback | |
244 | * @dev: the device structure | |
245 | * | |
246 | * This is a bus remove callback and calls the drive remove function. | |
247 | * Since the ISH driver model supports only built in, this is | |
248 | * primarily can be called during pci driver init failure. | |
249 | * | |
250 | * Return: Return value from driver remove() call. | |
251 | */ | |
252 | static int ishtp_cl_device_remove(struct device *dev) | |
253 | { | |
254 | struct ishtp_cl_device *device = to_ishtp_cl_device(dev); | |
255 | struct ishtp_cl_driver *driver; | |
256 | ||
257 | if (!device || !dev->driver) | |
258 | return 0; | |
259 | ||
260 | if (device->event_cb) { | |
261 | device->event_cb = NULL; | |
262 | cancel_work_sync(&device->event_work); | |
263 | } | |
264 | ||
265 | driver = to_ishtp_cl_driver(dev->driver); | |
266 | if (!driver->remove) { | |
267 | dev->driver = NULL; | |
268 | ||
269 | return 0; | |
270 | } | |
271 | ||
272 | return driver->remove(device); | |
273 | } | |
274 | ||
275 | /** | |
276 | * ishtp_cl_device_suspend() - Bus suspend callback | |
277 | * @dev: device | |
278 | * | |
279 | * Called during device suspend process. | |
280 | * | |
281 | * Return: Return value from driver suspend() call. | |
282 | */ | |
283 | static int ishtp_cl_device_suspend(struct device *dev) | |
284 | { | |
285 | struct ishtp_cl_device *device = to_ishtp_cl_device(dev); | |
286 | struct ishtp_cl_driver *driver; | |
287 | int ret = 0; | |
288 | ||
289 | if (!device) | |
290 | return 0; | |
291 | ||
292 | driver = to_ishtp_cl_driver(dev->driver); | |
293 | if (driver && driver->driver.pm) { | |
294 | if (driver->driver.pm->suspend) | |
295 | ret = driver->driver.pm->suspend(dev); | |
296 | } | |
297 | ||
298 | return ret; | |
299 | } | |
300 | ||
301 | /** | |
302 | * ishtp_cl_device_resume() - Bus resume callback | |
303 | * @dev: device | |
304 | * | |
305 | * Called during device resume process. | |
306 | * | |
307 | * Return: Return value from driver resume() call. | |
308 | */ | |
309 | static int ishtp_cl_device_resume(struct device *dev) | |
310 | { | |
311 | struct ishtp_cl_device *device = to_ishtp_cl_device(dev); | |
312 | struct ishtp_cl_driver *driver; | |
313 | int ret = 0; | |
314 | ||
315 | if (!device) | |
316 | return 0; | |
317 | ||
318 | /* | |
319 | * When ISH needs hard reset, it is done asynchrnously, hence bus | |
320 | * resume will be called before full ISH resume | |
321 | */ | |
322 | if (device->ishtp_dev->resume_flag) | |
323 | return 0; | |
324 | ||
325 | driver = to_ishtp_cl_driver(dev->driver); | |
326 | if (driver && driver->driver.pm) { | |
327 | if (driver->driver.pm->resume) | |
328 | ret = driver->driver.pm->resume(dev); | |
329 | } | |
330 | ||
331 | return ret; | |
332 | } | |
333 | ||
334 | /** | |
335 | * ishtp_cl_device_reset() - Reset callback | |
336 | * @device: ishtp client device instance | |
337 | * | |
338 | * This is a callback when HW reset is done and the device need | |
339 | * reinit. | |
340 | * | |
341 | * Return: Return value from driver reset() call. | |
342 | */ | |
343 | static int ishtp_cl_device_reset(struct ishtp_cl_device *device) | |
344 | { | |
345 | struct ishtp_cl_driver *driver; | |
346 | int ret = 0; | |
347 | ||
348 | device->event_cb = NULL; | |
349 | cancel_work_sync(&device->event_work); | |
350 | ||
351 | driver = to_ishtp_cl_driver(device->dev.driver); | |
352 | if (driver && driver->reset) | |
353 | ret = driver->reset(device); | |
354 | ||
355 | return ret; | |
356 | } | |
357 | ||
358 | static ssize_t modalias_show(struct device *dev, struct device_attribute *a, | |
359 | char *buf) | |
360 | { | |
361 | int len; | |
362 | ||
363 | len = snprintf(buf, PAGE_SIZE, "ishtp:%s\n", dev_name(dev)); | |
364 | return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len; | |
365 | } | |
480104b7 | 366 | static DEVICE_ATTR_RO(modalias); |
3703f53b | 367 | |
480104b7 GKH |
368 | static struct attribute *ishtp_cl_dev_attrs[] = { |
369 | &dev_attr_modalias.attr, | |
370 | NULL, | |
3703f53b | 371 | }; |
480104b7 | 372 | ATTRIBUTE_GROUPS(ishtp_cl_dev); |
3703f53b SP |
373 | |
374 | static int ishtp_cl_uevent(struct device *dev, struct kobj_uevent_env *env) | |
375 | { | |
376 | if (add_uevent_var(env, "MODALIAS=ishtp:%s", dev_name(dev))) | |
377 | return -ENOMEM; | |
378 | return 0; | |
379 | } | |
380 | ||
381 | static const struct dev_pm_ops ishtp_cl_bus_dev_pm_ops = { | |
382 | /* Suspend callbacks */ | |
383 | .suspend = ishtp_cl_device_suspend, | |
384 | .resume = ishtp_cl_device_resume, | |
385 | /* Hibernate callbacks */ | |
386 | .freeze = ishtp_cl_device_suspend, | |
387 | .thaw = ishtp_cl_device_resume, | |
388 | .restore = ishtp_cl_device_resume, | |
389 | }; | |
390 | ||
391 | static struct bus_type ishtp_cl_bus_type = { | |
392 | .name = "ishtp", | |
480104b7 | 393 | .dev_groups = ishtp_cl_dev_groups, |
3703f53b | 394 | .probe = ishtp_cl_device_probe, |
6b3f75f7 | 395 | .match = ishtp_cl_bus_match, |
3703f53b SP |
396 | .remove = ishtp_cl_device_remove, |
397 | .pm = &ishtp_cl_bus_dev_pm_ops, | |
398 | .uevent = ishtp_cl_uevent, | |
399 | }; | |
400 | ||
401 | static void ishtp_cl_dev_release(struct device *dev) | |
402 | { | |
403 | kfree(to_ishtp_cl_device(dev)); | |
404 | } | |
405 | ||
12be9f7b | 406 | static const struct device_type ishtp_cl_device_type = { |
3703f53b SP |
407 | .release = ishtp_cl_dev_release, |
408 | }; | |
409 | ||
410 | /** | |
411 | * ishtp_bus_add_device() - Function to create device on bus | |
412 | * @dev: ishtp device | |
413 | * @uuid: uuid of the client | |
414 | * @name: Name of the client | |
415 | * | |
416 | * Allocate ISHTP bus client device, attach it to uuid | |
417 | * and register with ISHTP bus. | |
418 | * | |
419 | * Return: ishtp_cl_device pointer or NULL on failure | |
420 | */ | |
421 | static struct ishtp_cl_device *ishtp_bus_add_device(struct ishtp_device *dev, | |
14106501 | 422 | guid_t uuid, char *name) |
3703f53b SP |
423 | { |
424 | struct ishtp_cl_device *device; | |
425 | int status; | |
426 | unsigned long flags; | |
3703f53b SP |
427 | |
428 | spin_lock_irqsave(&dev->device_list_lock, flags); | |
e8c61135 | 429 | list_for_each_entry(device, &dev->device_list, device_link) { |
3703f53b SP |
430 | if (!strcmp(name, dev_name(&device->dev))) { |
431 | device->fw_client = &dev->fw_clients[ | |
432 | dev->fw_client_presentation_num - 1]; | |
433 | spin_unlock_irqrestore(&dev->device_list_lock, flags); | |
434 | ishtp_cl_device_reset(device); | |
435 | return device; | |
436 | } | |
437 | } | |
438 | spin_unlock_irqrestore(&dev->device_list_lock, flags); | |
439 | ||
440 | device = kzalloc(sizeof(struct ishtp_cl_device), GFP_KERNEL); | |
441 | if (!device) | |
442 | return NULL; | |
443 | ||
444 | device->dev.parent = dev->devc; | |
445 | device->dev.bus = &ishtp_cl_bus_type; | |
446 | device->dev.type = &ishtp_cl_device_type; | |
447 | device->ishtp_dev = dev; | |
448 | ||
449 | device->fw_client = | |
450 | &dev->fw_clients[dev->fw_client_presentation_num - 1]; | |
451 | ||
452 | dev_set_name(&device->dev, "%s", name); | |
453 | ||
454 | spin_lock_irqsave(&dev->device_list_lock, flags); | |
455 | list_add_tail(&device->device_link, &dev->device_list); | |
456 | spin_unlock_irqrestore(&dev->device_list_lock, flags); | |
457 | ||
458 | status = device_register(&device->dev); | |
459 | if (status) { | |
460 | spin_lock_irqsave(&dev->device_list_lock, flags); | |
461 | list_del(&device->device_link); | |
462 | spin_unlock_irqrestore(&dev->device_list_lock, flags); | |
463 | dev_err(dev->devc, "Failed to register ISHTP client device\n"); | |
a4eb490a | 464 | put_device(&device->dev); |
3703f53b SP |
465 | return NULL; |
466 | } | |
467 | ||
468 | ishtp_device_ready = true; | |
469 | ||
470 | return device; | |
471 | } | |
472 | ||
473 | /** | |
474 | * ishtp_bus_remove_device() - Function to relase device on bus | |
475 | * @device: client device instance | |
476 | * | |
477 | * This is a counterpart of ishtp_bus_add_device. | |
478 | * Device is unregistered. | |
479 | * the device structure is freed in 'ishtp_cl_dev_release' function | |
480 | * Called only during error in pci driver init path. | |
481 | */ | |
482 | static void ishtp_bus_remove_device(struct ishtp_cl_device *device) | |
483 | { | |
484 | device_unregister(&device->dev); | |
485 | } | |
486 | ||
487 | /** | |
488 | * __ishtp_cl_driver_register() - Client driver register | |
489 | * @driver: the client driver instance | |
490 | * @owner: Owner of this driver module | |
491 | * | |
492 | * Once a client driver is probed, it created a client | |
493 | * instance and registers with the bus. | |
494 | * | |
495 | * Return: Return value of driver_register or -ENODEV if not ready | |
496 | */ | |
497 | int __ishtp_cl_driver_register(struct ishtp_cl_driver *driver, | |
498 | struct module *owner) | |
499 | { | |
500 | int err; | |
501 | ||
502 | if (!ishtp_device_ready) | |
503 | return -ENODEV; | |
504 | ||
505 | driver->driver.name = driver->name; | |
506 | driver->driver.owner = owner; | |
507 | driver->driver.bus = &ishtp_cl_bus_type; | |
508 | ||
509 | err = driver_register(&driver->driver); | |
510 | if (err) | |
511 | return err; | |
512 | ||
513 | return 0; | |
514 | } | |
515 | EXPORT_SYMBOL(__ishtp_cl_driver_register); | |
516 | ||
517 | /** | |
518 | * ishtp_cl_driver_unregister() - Client driver unregister | |
519 | * @driver: the client driver instance | |
520 | * | |
521 | * Unregister client during device removal process. | |
522 | */ | |
523 | void ishtp_cl_driver_unregister(struct ishtp_cl_driver *driver) | |
524 | { | |
525 | driver_unregister(&driver->driver); | |
526 | } | |
527 | EXPORT_SYMBOL(ishtp_cl_driver_unregister); | |
528 | ||
529 | /** | |
530 | * ishtp_bus_event_work() - event work function | |
531 | * @work: work struct pointer | |
532 | * | |
533 | * Once an event is received for a client this work | |
534 | * function is called. If the device has registered a | |
535 | * callback then the callback is called. | |
536 | */ | |
537 | static void ishtp_bus_event_work(struct work_struct *work) | |
538 | { | |
539 | struct ishtp_cl_device *device; | |
540 | ||
541 | device = container_of(work, struct ishtp_cl_device, event_work); | |
542 | ||
543 | if (device->event_cb) | |
544 | device->event_cb(device); | |
545 | } | |
546 | ||
547 | /** | |
548 | * ishtp_cl_bus_rx_event() - schedule event work | |
549 | * @device: client device instance | |
550 | * | |
551 | * Once an event is received for a client this schedules | |
552 | * a work function to process. | |
553 | */ | |
554 | void ishtp_cl_bus_rx_event(struct ishtp_cl_device *device) | |
555 | { | |
556 | if (!device || !device->event_cb) | |
557 | return; | |
558 | ||
559 | if (device->event_cb) | |
560 | schedule_work(&device->event_work); | |
561 | } | |
562 | ||
563 | /** | |
564 | * ishtp_register_event_cb() - Register callback | |
565 | * @device: client device instance | |
566 | * @event_cb: Event processor for an client | |
567 | * | |
568 | * Register a callback for events, called from client driver | |
569 | * | |
570 | * Return: Return 0 or -EALREADY if already registered | |
571 | */ | |
572 | int ishtp_register_event_cb(struct ishtp_cl_device *device, | |
573 | void (*event_cb)(struct ishtp_cl_device *)) | |
574 | { | |
575 | if (device->event_cb) | |
576 | return -EALREADY; | |
577 | ||
578 | device->event_cb = event_cb; | |
579 | INIT_WORK(&device->event_work, ishtp_bus_event_work); | |
580 | ||
581 | return 0; | |
582 | } | |
583 | EXPORT_SYMBOL(ishtp_register_event_cb); | |
584 | ||
585 | /** | |
586 | * ishtp_get_device() - update usage count for the device | |
587 | * @cl_device: client device instance | |
588 | * | |
589 | * Increment the usage count. The device can't be deleted | |
590 | */ | |
591 | void ishtp_get_device(struct ishtp_cl_device *cl_device) | |
592 | { | |
593 | cl_device->reference_count++; | |
594 | } | |
595 | EXPORT_SYMBOL(ishtp_get_device); | |
596 | ||
597 | /** | |
598 | * ishtp_put_device() - decrement usage count for the device | |
599 | * @cl_device: client device instance | |
600 | * | |
601 | * Decrement the usage count. The device can be deleted is count = 0 | |
602 | */ | |
603 | void ishtp_put_device(struct ishtp_cl_device *cl_device) | |
604 | { | |
605 | cl_device->reference_count--; | |
606 | } | |
607 | EXPORT_SYMBOL(ishtp_put_device); | |
608 | ||
d0b41230 EX |
609 | /** |
610 | * ishtp_set_drvdata() - set client driver data | |
611 | * @cl_device: client device instance | |
612 | * @data: driver data need to be set | |
613 | * | |
614 | * Set client driver data to cl_device->driver_data. | |
615 | */ | |
616 | void ishtp_set_drvdata(struct ishtp_cl_device *cl_device, void *data) | |
617 | { | |
618 | cl_device->driver_data = data; | |
619 | } | |
620 | EXPORT_SYMBOL(ishtp_set_drvdata); | |
621 | ||
622 | /** | |
623 | * ishtp_get_drvdata() - get client driver data | |
624 | * @cl_device: client device instance | |
625 | * | |
626 | * Get client driver data from cl_device->driver_data. | |
627 | * | |
628 | * Return: pointer of driver data | |
629 | */ | |
630 | void *ishtp_get_drvdata(struct ishtp_cl_device *cl_device) | |
631 | { | |
632 | return cl_device->driver_data; | |
633 | } | |
634 | EXPORT_SYMBOL(ishtp_get_drvdata); | |
635 | ||
3703f53b SP |
636 | /** |
637 | * ishtp_bus_new_client() - Create a new client | |
638 | * @dev: ISHTP device instance | |
639 | * | |
640 | * Once bus protocol enumerates a client, this is called | |
641 | * to add a device for the client. | |
642 | * | |
643 | * Return: 0 on success or error code on failure | |
644 | */ | |
645 | int ishtp_bus_new_client(struct ishtp_device *dev) | |
646 | { | |
647 | int i; | |
648 | char *dev_name; | |
649 | struct ishtp_cl_device *cl_device; | |
14106501 | 650 | guid_t device_uuid; |
3703f53b SP |
651 | |
652 | /* | |
653 | * For all reported clients, create an unconnected client and add its | |
654 | * device to ISHTP bus. | |
655 | * If appropriate driver has loaded, this will trigger its probe(). | |
656 | * Otherwise, probe() will be called when driver is loaded | |
657 | */ | |
658 | i = dev->fw_client_presentation_num - 1; | |
659 | device_uuid = dev->fw_clients[i].props.protocol_name; | |
14106501 | 660 | dev_name = kasprintf(GFP_KERNEL, "{%pUL}", &device_uuid); |
3703f53b SP |
661 | if (!dev_name) |
662 | return -ENOMEM; | |
663 | ||
664 | cl_device = ishtp_bus_add_device(dev, device_uuid, dev_name); | |
665 | if (!cl_device) { | |
666 | kfree(dev_name); | |
667 | return -ENOENT; | |
668 | } | |
669 | ||
670 | kfree(dev_name); | |
671 | ||
672 | return 0; | |
673 | } | |
674 | ||
675 | /** | |
676 | * ishtp_cl_device_bind() - bind a device | |
677 | * @cl: ishtp client device | |
678 | * | |
679 | * Binds connected ishtp_cl to ISHTP bus device | |
680 | * | |
681 | * Return: 0 on success or fault code | |
682 | */ | |
683 | int ishtp_cl_device_bind(struct ishtp_cl *cl) | |
684 | { | |
685 | struct ishtp_cl_device *cl_device; | |
686 | unsigned long flags; | |
687 | int rv; | |
688 | ||
689 | if (!cl->fw_client_id || cl->state != ISHTP_CL_CONNECTED) | |
690 | return -EFAULT; | |
691 | ||
692 | rv = -ENOENT; | |
693 | spin_lock_irqsave(&cl->dev->device_list_lock, flags); | |
694 | list_for_each_entry(cl_device, &cl->dev->device_list, | |
695 | device_link) { | |
0d28f494 HL |
696 | if (cl_device->fw_client && |
697 | cl_device->fw_client->client_id == cl->fw_client_id) { | |
3703f53b SP |
698 | cl->device = cl_device; |
699 | rv = 0; | |
700 | break; | |
701 | } | |
702 | } | |
703 | spin_unlock_irqrestore(&cl->dev->device_list_lock, flags); | |
704 | return rv; | |
705 | } | |
706 | ||
707 | /** | |
708 | * ishtp_bus_remove_all_clients() - Remove all clients | |
709 | * @ishtp_dev: ishtp device | |
710 | * @warm_reset: Reset due to FW reset dure to errors or S3 suspend | |
711 | * | |
712 | * This is part of reset/remove flow. This function the main processing | |
713 | * only targets error processing, if the FW has forced reset or | |
714 | * error to remove connected clients. When warm reset the client devices are | |
715 | * not removed. | |
716 | */ | |
717 | void ishtp_bus_remove_all_clients(struct ishtp_device *ishtp_dev, | |
718 | bool warm_reset) | |
719 | { | |
720 | struct ishtp_cl_device *cl_device, *n; | |
721 | struct ishtp_cl *cl; | |
722 | unsigned long flags; | |
723 | ||
724 | spin_lock_irqsave(&ishtp_dev->cl_list_lock, flags); | |
725 | list_for_each_entry(cl, &ishtp_dev->cl_list, link) { | |
726 | cl->state = ISHTP_CL_DISCONNECTED; | |
727 | ||
728 | /* | |
729 | * Wake any pending process. The waiter would check dev->state | |
730 | * and determine that it's not enabled already, | |
731 | * and will return error to its caller | |
732 | */ | |
733 | wake_up_interruptible(&cl->wait_ctrl_res); | |
734 | ||
735 | /* Disband any pending read/write requests and free rb */ | |
736 | ishtp_cl_flush_queues(cl); | |
737 | ||
738 | /* Remove all free and in_process rings, both Rx and Tx */ | |
739 | ishtp_cl_free_rx_ring(cl); | |
740 | ishtp_cl_free_tx_ring(cl); | |
741 | ||
742 | /* | |
743 | * Free client and ISHTP bus client device structures | |
744 | * don't free host client because it is part of the OS fd | |
745 | * structure | |
746 | */ | |
747 | } | |
748 | spin_unlock_irqrestore(&ishtp_dev->cl_list_lock, flags); | |
749 | ||
750 | /* Release DMA buffers for client messages */ | |
751 | ishtp_cl_free_dma_buf(ishtp_dev); | |
752 | ||
753 | /* remove bus clients */ | |
754 | spin_lock_irqsave(&ishtp_dev->device_list_lock, flags); | |
755 | list_for_each_entry_safe(cl_device, n, &ishtp_dev->device_list, | |
756 | device_link) { | |
0d28f494 | 757 | cl_device->fw_client = NULL; |
3703f53b SP |
758 | if (warm_reset && cl_device->reference_count) |
759 | continue; | |
760 | ||
761 | list_del(&cl_device->device_link); | |
762 | spin_unlock_irqrestore(&ishtp_dev->device_list_lock, flags); | |
763 | ishtp_bus_remove_device(cl_device); | |
764 | spin_lock_irqsave(&ishtp_dev->device_list_lock, flags); | |
765 | } | |
766 | spin_unlock_irqrestore(&ishtp_dev->device_list_lock, flags); | |
767 | ||
768 | /* Free all client structures */ | |
769 | spin_lock_irqsave(&ishtp_dev->fw_clients_lock, flags); | |
770 | kfree(ishtp_dev->fw_clients); | |
771 | ishtp_dev->fw_clients = NULL; | |
772 | ishtp_dev->fw_clients_num = 0; | |
773 | ishtp_dev->fw_client_presentation_num = 0; | |
774 | ishtp_dev->fw_client_index = 0; | |
775 | bitmap_zero(ishtp_dev->fw_clients_map, ISHTP_CLIENTS_MAX); | |
776 | spin_unlock_irqrestore(&ishtp_dev->fw_clients_lock, flags); | |
777 | } | |
778 | EXPORT_SYMBOL(ishtp_bus_remove_all_clients); | |
779 | ||
780 | /** | |
781 | * ishtp_reset_handler() - IPC reset handler | |
782 | * @dev: ishtp device | |
783 | * | |
784 | * ISHTP Handler for IPC_RESET notification | |
785 | */ | |
786 | void ishtp_reset_handler(struct ishtp_device *dev) | |
787 | { | |
788 | unsigned long flags; | |
789 | ||
790 | /* Handle FW-initiated reset */ | |
791 | dev->dev_state = ISHTP_DEV_RESETTING; | |
792 | ||
793 | /* Clear BH processing queue - no further HBMs */ | |
794 | spin_lock_irqsave(&dev->rd_msg_spinlock, flags); | |
795 | dev->rd_msg_fifo_head = dev->rd_msg_fifo_tail = 0; | |
796 | spin_unlock_irqrestore(&dev->rd_msg_spinlock, flags); | |
797 | ||
798 | /* Handle ISH FW reset against upper layers */ | |
799 | ishtp_bus_remove_all_clients(dev, true); | |
800 | } | |
801 | EXPORT_SYMBOL(ishtp_reset_handler); | |
802 | ||
803 | /** | |
804 | * ishtp_reset_compl_handler() - Reset completion handler | |
805 | * @dev: ishtp device | |
806 | * | |
807 | * ISHTP handler for IPC_RESET sequence completion to start | |
808 | * host message bus start protocol sequence. | |
809 | */ | |
810 | void ishtp_reset_compl_handler(struct ishtp_device *dev) | |
811 | { | |
812 | dev->dev_state = ISHTP_DEV_INIT_CLIENTS; | |
813 | dev->hbm_state = ISHTP_HBM_START; | |
814 | ishtp_hbm_start_req(dev); | |
815 | } | |
816 | EXPORT_SYMBOL(ishtp_reset_compl_handler); | |
817 | ||
818 | /** | |
819 | * ishtp_use_dma_transfer() - Function to use DMA | |
820 | * | |
821 | * This interface is used to enable usage of DMA | |
822 | * | |
823 | * Return non zero if DMA can be enabled | |
824 | */ | |
825 | int ishtp_use_dma_transfer(void) | |
826 | { | |
827 | return ishtp_use_dma; | |
828 | } | |
829 | ||
830 | /** | |
831 | * ishtp_bus_register() - Function to register bus | |
832 | * | |
833 | * This register ishtp bus | |
834 | * | |
835 | * Return: Return output of bus_register | |
836 | */ | |
837 | static int __init ishtp_bus_register(void) | |
838 | { | |
839 | return bus_register(&ishtp_cl_bus_type); | |
840 | } | |
841 | ||
842 | /** | |
843 | * ishtp_bus_unregister() - Function to unregister bus | |
844 | * | |
845 | * This unregister ishtp bus | |
846 | */ | |
847 | static void __exit ishtp_bus_unregister(void) | |
848 | { | |
849 | bus_unregister(&ishtp_cl_bus_type); | |
850 | } | |
851 | ||
852 | module_init(ishtp_bus_register); | |
853 | module_exit(ishtp_bus_unregister); | |
854 | ||
855 | MODULE_LICENSE("GPL"); |