1 // SPDX-License-Identifier: GPL-2.0
3 * ISH-TP client driver for ISH firmware loading
5 * Copyright (c) 2019, Intel Corporation.
8 #include <linux/firmware.h>
9 #include <linux/module.h>
10 #include <linux/pci.h>
11 #include <linux/intel-ish-client-if.h>
12 #include <linux/property.h>
13 #include <asm/cacheflush.h>
15 /* Number of times we attempt to load the firmware before giving up */
16 #define MAX_LOAD_ATTEMPTS 3
18 /* ISH TX/RX ring buffer pool size */
19 #define LOADER_CL_RX_RING_SIZE 1
20 #define LOADER_CL_TX_RING_SIZE 1
23 * ISH Shim firmware loader reserves 4 Kb buffer in SRAM. The buffer is
24 * used to temporarily hold the data transferred from host to Shim
25 * firmware loader. Reason for the odd size of 3968 bytes? Each IPC
26 * transfer is 128 bytes (= 4 bytes header + 124 bytes payload). So the
27 * 4 Kb buffer can hold maximum of 32 IPC transfers, which means we can
28 * have a max payload of 3968 bytes (= 32 x 124 payload).
30 #define LOADER_SHIM_IPC_BUF_SIZE 3968
33 * enum ish_loader_commands - ISH loader host commands.
34 * LOADER_CMD_XFER_QUERY Query the Shim firmware loader for
36 * LOADER_CMD_XFER_FRAGMENT Transfer one firmware image fragment at a
37 * time. The command may be executed
38 * multiple times until the entire firmware
39 * image is downloaded to SRAM.
40 * LOADER_CMD_START Start executing the main firmware.
42 enum ish_loader_commands {
43 LOADER_CMD_XFER_QUERY = 0,
44 LOADER_CMD_XFER_FRAGMENT,
48 /* Command bit mask */
49 #define CMD_MASK GENMASK(6, 0)
50 #define IS_RESPONSE BIT(7)
53 * ISH firmware max delay for one transmit failure is 1 Hz,
54 * and firmware will retry 2 times, so 3 Hz is used for timeout.
56 #define ISHTP_SEND_TIMEOUT (3 * HZ)
59 * Loader transfer modes:
61 * LOADER_XFER_MODE_ISHTP mode uses the existing ISH-TP mechanism to
62 * transfer data. This may use IPC or DMA if supported in firmware.
63 * The buffer size is limited to 4 Kb by the IPC/ISH-TP protocol for
64 * both IPC & DMA (legacy).
66 * LOADER_XFER_MODE_DIRECT_DMA - firmware loading is a bit different
67 * from the sensor data streaming. Here we download a large (300+ Kb)
68 * image directly to ISH SRAM memory. There is limited benefit of
69 * DMA'ing 300 Kb image in 4 Kb chucks limit. Hence, we introduce
70 * this "direct dma" mode, where we do not use ISH-TP for DMA, but
71 * instead manage the DMA directly in kernel driver and Shim firmware
72 * loader (allocate buffer, break in chucks and transfer). This allows
73 * to overcome 4 Kb limit, and optimize the data flow path in firmware.
75 #define LOADER_XFER_MODE_DIRECT_DMA BIT(0)
76 #define LOADER_XFER_MODE_ISHTP BIT(1)
78 /* ISH Transport Loader client unique GUID */
79 static const guid_t loader_ishtp_guid =
80 GUID_INIT(0xc804d06a, 0x55bd, 0x4ea7,
81 0xad, 0xed, 0x1e, 0x31, 0x22, 0x8c, 0x76, 0xdc);
83 #define FILENAME_SIZE 256
86 * The firmware loading latency will be minimum if we can DMA the
87 * entire ISH firmware image in one go. This requires that we allocate
88 * a large DMA buffer in kernel, which could be problematic on some
89 * platforms. So here we limit the DMA buffer size via a module_param.
90 * We default to 4 pages, but a customer can set it to higher limit if
91 * deemed appropriate for his platform.
93 static int dma_buf_size_limit = 4 * PAGE_SIZE;
96 * struct loader_msg_hdr - Header for ISH Loader commands.
97 * @command: LOADER_CMD* commands. Bit 7 is the response.
98 * @status: Command response status. Non 0, is error
101 * This structure is used as header for every command/data sent/received
102 * between Host driver and ISH Shim firmware loader.
104 struct loader_msg_hdr {
110 struct loader_xfer_query {
111 struct loader_msg_hdr hdr;
115 struct ish_fw_version {
122 union loader_version {
132 struct loader_capability {
133 u32 max_fw_image_size;
135 u32 max_dma_buf_size; /* only for dma mode, multiples of cacheline */
138 struct shim_fw_info {
139 struct ish_fw_version ish_fw_version;
140 u32 protocol_version;
141 union loader_version ldr_version;
142 struct loader_capability ldr_capability;
145 struct loader_xfer_query_response {
146 struct loader_msg_hdr hdr;
147 struct shim_fw_info fw_info;
150 struct loader_xfer_fragment {
151 struct loader_msg_hdr hdr;
158 struct loader_xfer_ipc_fragment {
159 struct loader_xfer_fragment fragment;
160 u8 data[] ____cacheline_aligned; /* variable length payload here */
163 struct loader_xfer_dma_fragment {
164 struct loader_xfer_fragment fragment;
168 struct loader_start {
169 struct loader_msg_hdr hdr;
173 * struct response_info - Encapsulate firmware response related
174 * information for passing between function
175 * loader_cl_send() and process_recv() callback.
176 * @data Copy the data received from firmware here.
177 * @max_size Max size allocated for the @data buffer. If the
178 * received data exceeds this value, we log an
180 * @size Actual size of data received from firmware.
181 * @error Returns 0 for success, negative error code for a
182 * failure in function process_recv().
183 * @received Set to true on receiving a valid firmware
184 * response to host command
185 * @wait_queue Wait queue for Host firmware loading where the
186 * client sends message to ISH firmware and waits
189 struct response_info {
195 wait_queue_head_t wait_queue;
199 * struct ishtp_cl_data - Encapsulate per ISH-TP Client Data.
200 * @work_ishtp_reset: Work queue for reset handling.
201 * @work_fw_load: Work queue for host firmware loading.
202 * @flag_retry Flag for indicating host firmware loading should
204 * @retry_count Count the number of retries.
206 * This structure is used to store data per client.
208 struct ishtp_cl_data {
209 struct ishtp_cl *loader_ishtp_cl;
210 struct ishtp_cl_device *cl_device;
213 * Used for passing firmware response information between
214 * loader_cl_send() and process_recv() callback.
216 struct response_info response;
218 struct work_struct work_ishtp_reset;
219 struct work_struct work_fw_load;
222 * In certain failure scenrios, it makes sense to reset the ISH
223 * subsystem and retry Host firmware loading (e.g. bad message
224 * packet, ENOMEM, etc.). On the other hand, failures due to
225 * protocol mismatch, etc., are not recoverable. We do not
228 * If set, the flag indicates that we should re-try the
229 * particular failure.
235 #define IPC_FRAGMENT_DATA_PREAMBLE \
236 offsetof(struct loader_xfer_ipc_fragment, data)
238 #define cl_data_to_dev(client_data) ishtp_device((client_data)->cl_device)
241 * get_firmware_variant() - Gets the filename of firmware image to be
242 * loaded based on platform variant.
243 * @client_data Client data instance.
244 * @filename Returns firmware filename.
246 * Queries the firmware-name device property string.
248 * Return: 0 for success, negative error code for failure.
250 static int get_firmware_variant(struct ishtp_cl_data *client_data,
255 struct device *devc = ishtp_get_pci_device(client_data->cl_device);
257 rv = device_property_read_string(devc, "firmware-name", &val);
260 "Error: ISH firmware-name device property required\n");
263 return snprintf(filename, FILENAME_SIZE, "/*(DEBLOBBED)*/", val);
267 * loader_cl_send() Send message from host to firmware
268 * @client_data: Client data instance
269 * @out_msg Message buffer to be sent to firmware
270 * @out_size Size of out going message
271 * @in_msg Message buffer where the incoming data copied.
272 * This buffer is allocated by calling
273 * @in_size Max size of incoming message
275 * Return: Number of bytes copied in the in_msg on success, negative
276 * error code on failure.
278 static int loader_cl_send(struct ishtp_cl_data *client_data,
279 u8 *out_msg, size_t out_size,
280 u8 *in_msg, size_t in_size)
283 struct loader_msg_hdr *out_hdr = (struct loader_msg_hdr *)out_msg;
284 struct ishtp_cl *loader_ishtp_cl = client_data->loader_ishtp_cl;
286 dev_dbg(cl_data_to_dev(client_data),
287 "%s: command=%02lx is_response=%u status=%02x\n",
289 out_hdr->command & CMD_MASK,
290 out_hdr->command & IS_RESPONSE ? 1 : 0,
293 /* Setup in coming buffer & size */
294 client_data->response.data = in_msg;
295 client_data->response.max_size = in_size;
296 client_data->response.error = 0;
297 client_data->response.received = false;
299 rv = ishtp_cl_send(loader_ishtp_cl, out_msg, out_size);
301 dev_err(cl_data_to_dev(client_data),
302 "ishtp_cl_send error %d\n", rv);
306 wait_event_interruptible_timeout(client_data->response.wait_queue,
307 client_data->response.received,
309 if (!client_data->response.received) {
310 dev_err(cl_data_to_dev(client_data),
311 "Timed out for response to command=%02lx",
312 out_hdr->command & CMD_MASK);
316 if (client_data->response.error < 0)
317 return client_data->response.error;
319 return client_data->response.size;
323 * process_recv() - Receive and parse incoming packet
324 * @loader_ishtp_cl: Client instance to get stats
325 * @rb_in_proc: ISH received message buffer
327 * Parse the incoming packet. If it is a response packet then it will
328 * update received and wake up the caller waiting to for the response.
330 static void process_recv(struct ishtp_cl *loader_ishtp_cl,
331 struct ishtp_cl_rb *rb_in_proc)
333 struct loader_msg_hdr *hdr;
334 size_t data_len = rb_in_proc->buf_idx;
335 struct ishtp_cl_data *client_data =
336 ishtp_get_client_data(loader_ishtp_cl);
339 if (!client_data->response.data) {
340 dev_err(cl_data_to_dev(client_data),
341 "Receiving buffer is null. Should be allocated by calling function\n");
342 client_data->response.error = -EINVAL;
346 if (client_data->response.received) {
347 dev_err(cl_data_to_dev(client_data),
348 "Previous firmware message not yet processed\n");
349 client_data->response.error = -EINVAL;
353 * All firmware messages have a header. Check buffer size
354 * before accessing elements inside.
356 if (!rb_in_proc->buffer.data) {
357 dev_warn(cl_data_to_dev(client_data),
358 "rb_in_proc->buffer.data returned null");
359 client_data->response.error = -EBADMSG;
363 if (data_len < sizeof(struct loader_msg_hdr)) {
364 dev_err(cl_data_to_dev(client_data),
365 "data size %zu is less than header %zu\n",
366 data_len, sizeof(struct loader_msg_hdr));
367 client_data->response.error = -EMSGSIZE;
371 hdr = (struct loader_msg_hdr *)rb_in_proc->buffer.data;
373 dev_dbg(cl_data_to_dev(client_data),
374 "%s: command=%02lx is_response=%u status=%02x\n",
376 hdr->command & CMD_MASK,
377 hdr->command & IS_RESPONSE ? 1 : 0,
380 if (((hdr->command & CMD_MASK) != LOADER_CMD_XFER_QUERY) &&
381 ((hdr->command & CMD_MASK) != LOADER_CMD_XFER_FRAGMENT) &&
382 ((hdr->command & CMD_MASK) != LOADER_CMD_START)) {
383 dev_err(cl_data_to_dev(client_data),
384 "Invalid command=%02lx\n",
385 hdr->command & CMD_MASK);
386 client_data->response.error = -EPROTO;
390 if (data_len > client_data->response.max_size) {
391 dev_err(cl_data_to_dev(client_data),
392 "Received buffer size %zu is larger than allocated buffer %zu\n",
393 data_len, client_data->response.max_size);
394 client_data->response.error = -EMSGSIZE;
398 /* We expect only "response" messages from firmware */
399 if (!(hdr->command & IS_RESPONSE)) {
400 dev_err(cl_data_to_dev(client_data),
401 "Invalid response to command\n");
402 client_data->response.error = -EIO;
407 dev_err(cl_data_to_dev(client_data),
408 "Loader returned status %d\n",
410 client_data->response.error = -EIO;
414 /* Update the actual received buffer size */
415 client_data->response.size = data_len;
418 * Copy the buffer received in firmware response for the
421 memcpy(client_data->response.data,
422 rb_in_proc->buffer.data, data_len);
424 /* Set flag before waking up the caller */
425 client_data->response.received = true;
428 /* Free the buffer */
429 ishtp_cl_io_rb_recycle(rb_in_proc);
432 /* Wake the calling thread */
433 wake_up_interruptible(&client_data->response.wait_queue);
437 * loader_cl_event_cb() - bus driver callback for incoming message
438 * @device: Pointer to the ishtp client device for which this
439 * message is targeted
441 * Remove the packet from the list and process the message by calling
444 static void loader_cl_event_cb(struct ishtp_cl_device *cl_device)
446 struct ishtp_cl_rb *rb_in_proc;
447 struct ishtp_cl *loader_ishtp_cl = ishtp_get_drvdata(cl_device);
449 while ((rb_in_proc = ishtp_cl_rx_get_rb(loader_ishtp_cl)) != NULL) {
450 /* Process the data packet from firmware */
451 process_recv(loader_ishtp_cl, rb_in_proc);
456 * ish_query_loader_prop() - Query ISH Shim firmware loader
457 * @client_data: Client data instance
458 * @fw: Poiner to firmware data struct in host memory
459 * @fw_info: Loader firmware properties
461 * This function queries the ISH Shim firmware loader for capabilities.
463 * Return: 0 for success, negative error code for failure.
465 static int ish_query_loader_prop(struct ishtp_cl_data *client_data,
466 const struct firmware *fw,
467 struct shim_fw_info *fw_info)
470 struct loader_xfer_query ldr_xfer_query;
471 struct loader_xfer_query_response ldr_xfer_query_resp;
473 memset(&ldr_xfer_query, 0, sizeof(ldr_xfer_query));
474 ldr_xfer_query.hdr.command = LOADER_CMD_XFER_QUERY;
475 ldr_xfer_query.image_size = fw->size;
476 rv = loader_cl_send(client_data,
477 (u8 *)&ldr_xfer_query,
478 sizeof(ldr_xfer_query),
479 (u8 *)&ldr_xfer_query_resp,
480 sizeof(ldr_xfer_query_resp));
482 client_data->flag_retry = true;
483 *fw_info = (struct shim_fw_info){};
487 /* On success, the return value is the received buffer size */
488 if (rv != sizeof(struct loader_xfer_query_response)) {
489 dev_err(cl_data_to_dev(client_data),
490 "data size %d is not equal to size of loader_xfer_query_response %zu\n",
491 rv, sizeof(struct loader_xfer_query_response));
492 client_data->flag_retry = true;
493 *fw_info = (struct shim_fw_info){};
497 /* Save fw_info for use outside this function */
498 *fw_info = ldr_xfer_query_resp.fw_info;
500 /* Loader firmware properties */
501 dev_dbg(cl_data_to_dev(client_data),
502 "ish_fw_version: major=%d minor=%d hotfix=%d build=%d protocol_version=0x%x loader_version=%d\n",
503 fw_info->ish_fw_version.major,
504 fw_info->ish_fw_version.minor,
505 fw_info->ish_fw_version.hotfix,
506 fw_info->ish_fw_version.build,
507 fw_info->protocol_version,
508 fw_info->ldr_version.value);
510 dev_dbg(cl_data_to_dev(client_data),
511 "loader_capability: max_fw_image_size=0x%x xfer_mode=%d max_dma_buf_size=0x%x dma_buf_size_limit=0x%x\n",
512 fw_info->ldr_capability.max_fw_image_size,
513 fw_info->ldr_capability.xfer_mode,
514 fw_info->ldr_capability.max_dma_buf_size,
518 if (fw_info->ldr_capability.max_fw_image_size < fw->size) {
519 dev_err(cl_data_to_dev(client_data),
520 "ISH firmware size %zu is greater than Shim firmware loader max supported %d\n",
522 fw_info->ldr_capability.max_fw_image_size);
526 /* For DMA the buffer size should be multiple of cacheline size */
527 if ((fw_info->ldr_capability.xfer_mode & LOADER_XFER_MODE_DIRECT_DMA) &&
528 (fw_info->ldr_capability.max_dma_buf_size % L1_CACHE_BYTES)) {
529 dev_err(cl_data_to_dev(client_data),
530 "Shim firmware loader buffer size %d should be multiple of cacheline\n",
531 fw_info->ldr_capability.max_dma_buf_size);
539 * ish_fw_xfer_ishtp() Loads ISH firmware using ishtp interface
540 * @client_data: Client data instance
541 * @fw: Pointer to firmware data struct in host memory
543 * This function uses ISH-TP to transfer ISH firmware from host to
544 * ISH SRAM. Lower layers may use IPC or DMA depending on firmware
547 * Return: 0 for success, negative error code for failure.
549 static int ish_fw_xfer_ishtp(struct ishtp_cl_data *client_data,
550 const struct firmware *fw)
553 u32 fragment_offset, fragment_size, payload_max_size;
554 struct loader_xfer_ipc_fragment *ldr_xfer_ipc_frag;
555 struct loader_msg_hdr ldr_xfer_ipc_ack;
558 LOADER_SHIM_IPC_BUF_SIZE - IPC_FRAGMENT_DATA_PREAMBLE;
560 ldr_xfer_ipc_frag = kzalloc(LOADER_SHIM_IPC_BUF_SIZE, GFP_KERNEL);
561 if (!ldr_xfer_ipc_frag) {
562 client_data->flag_retry = true;
566 ldr_xfer_ipc_frag->fragment.hdr.command = LOADER_CMD_XFER_FRAGMENT;
567 ldr_xfer_ipc_frag->fragment.xfer_mode = LOADER_XFER_MODE_ISHTP;
569 /* Break the firmware image into fragments and send as ISH-TP payload */
571 while (fragment_offset < fw->size) {
572 if (fragment_offset + payload_max_size < fw->size) {
573 fragment_size = payload_max_size;
574 ldr_xfer_ipc_frag->fragment.is_last = 0;
576 fragment_size = fw->size - fragment_offset;
577 ldr_xfer_ipc_frag->fragment.is_last = 1;
580 ldr_xfer_ipc_frag->fragment.offset = fragment_offset;
581 ldr_xfer_ipc_frag->fragment.size = fragment_size;
582 memcpy(ldr_xfer_ipc_frag->data,
583 &fw->data[fragment_offset],
586 dev_dbg(cl_data_to_dev(client_data),
587 "xfer_mode=ipc offset=0x%08x size=0x%08x is_last=%d\n",
588 ldr_xfer_ipc_frag->fragment.offset,
589 ldr_xfer_ipc_frag->fragment.size,
590 ldr_xfer_ipc_frag->fragment.is_last);
592 rv = loader_cl_send(client_data,
593 (u8 *)ldr_xfer_ipc_frag,
594 IPC_FRAGMENT_DATA_PREAMBLE + fragment_size,
595 (u8 *)&ldr_xfer_ipc_ack,
596 sizeof(ldr_xfer_ipc_ack));
598 client_data->flag_retry = true;
599 goto end_err_resp_buf_release;
602 fragment_offset += fragment_size;
605 kfree(ldr_xfer_ipc_frag);
608 end_err_resp_buf_release:
609 /* Free ISH buffer if not done already, in error case */
610 kfree(ldr_xfer_ipc_frag);
615 * ish_fw_xfer_direct_dma() - Loads ISH firmware using direct dma
616 * @client_data: Client data instance
617 * @fw: Pointer to firmware data struct in host memory
618 * @fw_info: Loader firmware properties
620 * Host firmware load is a unique case where we need to download
621 * a large firmware image (200+ Kb). This function implements
622 * direct DMA transfer in kernel and ISH firmware. This allows
623 * us to overcome the ISH-TP 4 Kb limit, and allows us to DMA
624 * directly to ISH UMA at location of choice.
625 * Function depends on corresponding support in ISH firmware.
627 * Return: 0 for success, negative error code for failure.
629 static int ish_fw_xfer_direct_dma(struct ishtp_cl_data *client_data,
630 const struct firmware *fw,
631 const struct shim_fw_info fw_info)
635 dma_addr_t dma_buf_phy;
636 u32 fragment_offset, fragment_size, payload_max_size;
637 struct loader_msg_hdr ldr_xfer_dma_frag_ack;
638 struct loader_xfer_dma_fragment ldr_xfer_dma_frag;
639 struct device *devc = ishtp_get_pci_device(client_data->cl_device);
640 u32 shim_fw_buf_size =
641 fw_info.ldr_capability.max_dma_buf_size;
644 * payload_max_size should be set to minimum of
645 * (1) Size of firmware to be loaded,
646 * (2) Max DMA buffer size supported by Shim firmware,
647 * (3) DMA buffer size limit set by boot_param dma_buf_size_limit.
649 payload_max_size = min3(fw->size,
650 (size_t)shim_fw_buf_size,
651 (size_t)dma_buf_size_limit);
654 * Buffer size should be multiple of cacheline size
655 * if it's not, select the previous cacheline boundary.
657 payload_max_size &= ~(L1_CACHE_BYTES - 1);
659 dma_buf = dma_alloc_coherent(devc, payload_max_size, &dma_buf_phy, GFP_KERNEL);
661 client_data->flag_retry = true;
665 ldr_xfer_dma_frag.fragment.hdr.command = LOADER_CMD_XFER_FRAGMENT;
666 ldr_xfer_dma_frag.fragment.xfer_mode = LOADER_XFER_MODE_DIRECT_DMA;
667 ldr_xfer_dma_frag.ddr_phys_addr = (u64)dma_buf_phy;
669 /* Send the firmware image in chucks of payload_max_size */
671 while (fragment_offset < fw->size) {
672 if (fragment_offset + payload_max_size < fw->size) {
673 fragment_size = payload_max_size;
674 ldr_xfer_dma_frag.fragment.is_last = 0;
676 fragment_size = fw->size - fragment_offset;
677 ldr_xfer_dma_frag.fragment.is_last = 1;
680 ldr_xfer_dma_frag.fragment.offset = fragment_offset;
681 ldr_xfer_dma_frag.fragment.size = fragment_size;
682 memcpy(dma_buf, &fw->data[fragment_offset], fragment_size);
684 /* Flush cache to be sure the data is in main memory. */
685 clflush_cache_range(dma_buf, payload_max_size);
687 dev_dbg(cl_data_to_dev(client_data),
688 "xfer_mode=dma offset=0x%08x size=0x%x is_last=%d ddr_phys_addr=0x%016llx\n",
689 ldr_xfer_dma_frag.fragment.offset,
690 ldr_xfer_dma_frag.fragment.size,
691 ldr_xfer_dma_frag.fragment.is_last,
692 ldr_xfer_dma_frag.ddr_phys_addr);
694 rv = loader_cl_send(client_data,
695 (u8 *)&ldr_xfer_dma_frag,
696 sizeof(ldr_xfer_dma_frag),
697 (u8 *)&ldr_xfer_dma_frag_ack,
698 sizeof(ldr_xfer_dma_frag_ack));
700 client_data->flag_retry = true;
701 goto end_err_resp_buf_release;
704 fragment_offset += fragment_size;
707 end_err_resp_buf_release:
708 dma_free_coherent(devc, payload_max_size, dma_buf, dma_buf_phy);
713 * ish_fw_start() Start executing ISH main firmware
714 * @client_data: client data instance
716 * This function sends message to Shim firmware loader to start
717 * the execution of ISH main firmware.
719 * Return: 0 for success, negative error code for failure.
721 static int ish_fw_start(struct ishtp_cl_data *client_data)
723 struct loader_start ldr_start;
724 struct loader_msg_hdr ldr_start_ack;
726 memset(&ldr_start, 0, sizeof(ldr_start));
727 ldr_start.hdr.command = LOADER_CMD_START;
728 return loader_cl_send(client_data,
731 (u8 *)&ldr_start_ack,
732 sizeof(ldr_start_ack));
736 * load_fw_from_host() Loads ISH firmware from host
737 * @client_data: Client data instance
739 * This function loads the ISH firmware to ISH SRAM and starts execution
741 * Return: 0 for success, negative error code for failure.
743 static int load_fw_from_host(struct ishtp_cl_data *client_data)
748 const struct firmware *fw;
749 struct shim_fw_info fw_info;
750 struct ishtp_cl *loader_ishtp_cl = client_data->loader_ishtp_cl;
752 client_data->flag_retry = false;
754 filename = kzalloc(FILENAME_SIZE, GFP_KERNEL);
756 client_data->flag_retry = true;
761 /* Get filename of the ISH firmware to be loaded */
762 rv = get_firmware_variant(client_data, filename);
764 goto end_err_filename_buf_release;
766 rv = reject_firmware(&fw, filename, cl_data_to_dev(client_data));
768 goto end_err_filename_buf_release;
770 /* Step 1: Query Shim firmware loader properties */
772 rv = ish_query_loader_prop(client_data, fw, &fw_info);
774 goto end_err_fw_release;
776 /* Step 2: Send the main firmware image to be loaded, to ISH SRAM */
778 xfer_mode = fw_info.ldr_capability.xfer_mode;
779 if (xfer_mode & LOADER_XFER_MODE_DIRECT_DMA) {
780 rv = ish_fw_xfer_direct_dma(client_data, fw, fw_info);
781 } else if (xfer_mode & LOADER_XFER_MODE_ISHTP) {
782 rv = ish_fw_xfer_ishtp(client_data, fw);
784 dev_err(cl_data_to_dev(client_data),
785 "No transfer mode selected in firmware\n");
789 goto end_err_fw_release;
791 /* Step 3: Start ISH main firmware exeuction */
793 rv = ish_fw_start(client_data);
795 goto end_err_fw_release;
797 release_firmware(fw);
798 dev_info(cl_data_to_dev(client_data), "ISH firmware %s loaded\n",
804 release_firmware(fw);
805 end_err_filename_buf_release:
808 /* Keep a count of retries, and give up after 3 attempts */
809 if (client_data->flag_retry &&
810 client_data->retry_count++ < MAX_LOAD_ATTEMPTS) {
811 dev_warn(cl_data_to_dev(client_data),
812 "ISH host firmware load failed %d. Resetting ISH, and trying again..\n",
814 ish_hw_reset(ishtp_get_ishtp_device(loader_ishtp_cl));
816 dev_err(cl_data_to_dev(client_data),
817 "ISH host firmware load failed %d\n", rv);
822 static void load_fw_from_host_handler(struct work_struct *work)
824 struct ishtp_cl_data *client_data;
826 client_data = container_of(work, struct ishtp_cl_data,
828 load_fw_from_host(client_data);
832 * loader_init() - Init function for ISH-TP client
833 * @loader_ishtp_cl: ISH-TP client instance
834 * @reset: true if called for init after reset
836 * Return: 0 for success, negative error code for failure
838 static int loader_init(struct ishtp_cl *loader_ishtp_cl, int reset)
841 struct ishtp_fw_client *fw_client;
842 struct ishtp_cl_data *client_data =
843 ishtp_get_client_data(loader_ishtp_cl);
845 dev_dbg(cl_data_to_dev(client_data), "reset flag: %d\n", reset);
847 rv = ishtp_cl_link(loader_ishtp_cl);
849 dev_err(cl_data_to_dev(client_data), "ishtp_cl_link failed\n");
853 /* Connect to firmware client */
854 ishtp_set_tx_ring_size(loader_ishtp_cl, LOADER_CL_TX_RING_SIZE);
855 ishtp_set_rx_ring_size(loader_ishtp_cl, LOADER_CL_RX_RING_SIZE);
858 ishtp_fw_cl_get_client(ishtp_get_ishtp_device(loader_ishtp_cl),
861 dev_err(cl_data_to_dev(client_data),
862 "ISH client uuid not found\n");
867 ishtp_cl_set_fw_client_id(loader_ishtp_cl,
868 ishtp_get_fw_client_id(fw_client));
869 ishtp_set_connection_state(loader_ishtp_cl, ISHTP_CL_CONNECTING);
871 rv = ishtp_cl_connect(loader_ishtp_cl);
873 dev_err(cl_data_to_dev(client_data), "Client connect fail\n");
877 dev_dbg(cl_data_to_dev(client_data), "Client connected\n");
879 ishtp_register_event_cb(client_data->cl_device, loader_cl_event_cb);
884 ishtp_cl_unlink(loader_ishtp_cl);
888 static void loader_deinit(struct ishtp_cl *loader_ishtp_cl)
890 ishtp_set_connection_state(loader_ishtp_cl, ISHTP_CL_DISCONNECTING);
891 ishtp_cl_disconnect(loader_ishtp_cl);
892 ishtp_cl_unlink(loader_ishtp_cl);
893 ishtp_cl_flush_queues(loader_ishtp_cl);
895 /* Disband and free all Tx and Rx client-level rings */
896 ishtp_cl_free(loader_ishtp_cl);
899 static void reset_handler(struct work_struct *work)
902 struct ishtp_cl_data *client_data;
903 struct ishtp_cl *loader_ishtp_cl;
904 struct ishtp_cl_device *cl_device;
906 client_data = container_of(work, struct ishtp_cl_data,
909 loader_ishtp_cl = client_data->loader_ishtp_cl;
910 cl_device = client_data->cl_device;
912 /* Unlink, flush queues & start again */
913 ishtp_cl_unlink(loader_ishtp_cl);
914 ishtp_cl_flush_queues(loader_ishtp_cl);
915 ishtp_cl_free(loader_ishtp_cl);
917 loader_ishtp_cl = ishtp_cl_allocate(cl_device);
918 if (!loader_ishtp_cl)
921 ishtp_set_drvdata(cl_device, loader_ishtp_cl);
922 ishtp_set_client_data(loader_ishtp_cl, client_data);
923 client_data->loader_ishtp_cl = loader_ishtp_cl;
924 client_data->cl_device = cl_device;
926 rv = loader_init(loader_ishtp_cl, 1);
928 dev_err(ishtp_device(cl_device), "Reset Failed\n");
932 /* ISH firmware loading from host */
933 load_fw_from_host(client_data);
937 * loader_ishtp_cl_probe() - ISH-TP client driver probe
938 * @cl_device: ISH-TP client device instance
940 * This function gets called on device create on ISH-TP bus
942 * Return: 0 for success, negative error code for failure
944 static int loader_ishtp_cl_probe(struct ishtp_cl_device *cl_device)
946 struct ishtp_cl *loader_ishtp_cl;
947 struct ishtp_cl_data *client_data;
950 client_data = devm_kzalloc(ishtp_device(cl_device),
951 sizeof(*client_data),
956 loader_ishtp_cl = ishtp_cl_allocate(cl_device);
957 if (!loader_ishtp_cl)
960 ishtp_set_drvdata(cl_device, loader_ishtp_cl);
961 ishtp_set_client_data(loader_ishtp_cl, client_data);
962 client_data->loader_ishtp_cl = loader_ishtp_cl;
963 client_data->cl_device = cl_device;
965 init_waitqueue_head(&client_data->response.wait_queue);
967 INIT_WORK(&client_data->work_ishtp_reset,
969 INIT_WORK(&client_data->work_fw_load,
970 load_fw_from_host_handler);
972 rv = loader_init(loader_ishtp_cl, 0);
974 ishtp_cl_free(loader_ishtp_cl);
977 ishtp_get_device(cl_device);
979 client_data->retry_count = 0;
981 /* ISH firmware loading from host */
982 schedule_work(&client_data->work_fw_load);
988 * loader_ishtp_cl_remove() - ISH-TP client driver remove
989 * @cl_device: ISH-TP client device instance
991 * This function gets called on device remove on ISH-TP bus
995 static int loader_ishtp_cl_remove(struct ishtp_cl_device *cl_device)
997 struct ishtp_cl_data *client_data;
998 struct ishtp_cl *loader_ishtp_cl = ishtp_get_drvdata(cl_device);
1000 client_data = ishtp_get_client_data(loader_ishtp_cl);
1003 * The sequence of the following two cancel_work_sync() is
1004 * important. The work_fw_load can in turn schedue
1005 * work_ishtp_reset, so first cancel work_fw_load then
1006 * cancel work_ishtp_reset.
1008 cancel_work_sync(&client_data->work_fw_load);
1009 cancel_work_sync(&client_data->work_ishtp_reset);
1010 loader_deinit(loader_ishtp_cl);
1011 ishtp_put_device(cl_device);
1017 * loader_ishtp_cl_reset() - ISH-TP client driver reset
1018 * @cl_device: ISH-TP client device instance
1020 * This function gets called on device reset on ISH-TP bus
1024 static int loader_ishtp_cl_reset(struct ishtp_cl_device *cl_device)
1026 struct ishtp_cl_data *client_data;
1027 struct ishtp_cl *loader_ishtp_cl = ishtp_get_drvdata(cl_device);
1029 client_data = ishtp_get_client_data(loader_ishtp_cl);
1031 schedule_work(&client_data->work_ishtp_reset);
1036 static struct ishtp_cl_driver loader_ishtp_cl_driver = {
1037 .name = "ish-loader",
1038 .guid = &loader_ishtp_guid,
1039 .probe = loader_ishtp_cl_probe,
1040 .remove = loader_ishtp_cl_remove,
1041 .reset = loader_ishtp_cl_reset,
1044 static int __init ish_loader_init(void)
1046 return ishtp_cl_driver_register(&loader_ishtp_cl_driver, THIS_MODULE);
1049 static void __exit ish_loader_exit(void)
1051 ishtp_cl_driver_unregister(&loader_ishtp_cl_driver);
1054 late_initcall(ish_loader_init);
1055 module_exit(ish_loader_exit);
1057 module_param(dma_buf_size_limit, int, 0644);
1058 MODULE_PARM_DESC(dma_buf_size_limit, "Limit the DMA buf size to this value in bytes");
1060 MODULE_DESCRIPTION("ISH ISH-TP Host firmware Loader Client Driver");
1061 MODULE_AUTHOR("Rushikesh S Kadam <rushikesh.s.kadam@intel.com>");
1063 MODULE_LICENSE("GPL v2");
1064 MODULE_ALIAS("ishtp:*");