1 // SPDX-License-Identifier: GPL-2.0
3  * ISH-TP client driver for ISH firmware loading
11 #include <linux/intel-ish-client-if.h>
23  * ISH Shim firmware loader reserves 4 Kb buffer in SRAM. The buffer is
25  * firmware loader. Reason for the odd size of 3968 bytes? Each IPC
33  * enum ish_loader_commands -	ISH loader host commands.
34  * LOADER_CMD_XFER_QUERY	Query the Shim firmware loader for
59  * Loader transfer modes:
61  * LOADER_XFER_MODE_ISHTP mode uses the existing ISH-TP mechanism to
63  * The buffer size is limited to 4 Kb by the IPC/ISH-TP protocol for
66  * LOADER_XFER_MODE_DIRECT_DMA - firmware loading is a bit different
70  * this "direct dma" mode, where we do not use ISH-TP for DMA, but
72  * loader (allocate buffer, break in chucks and transfer). This allows
78 /* ISH Transport Loader client unique GUID */
96  * struct loader_msg_hdr - Header for ISH Loader commands.
102  * between Host driver and ISH Shim firmware loader.
135 	u32 max_dma_buf_size; /* only for dma mode, multiples of cacheline */
173  * struct response_info - Encapsulate firmware response related
199  * struct ishtp_cl_data - Encapsulate per ISH-TP Client Data.
228 	 * If set, the flag indicates that we should re-try the
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
246  * Queries the firmware-name device property string.
255 	struct device *devc = ishtp_get_pci_device(client_data->cl_device);  in get_firmware_variant()
257 	rv = device_property_read_string(devc, "firmware-name", &val);  in get_firmware_variant()
260 			"Error: ISH firmware-name device property required\n");  in get_firmware_variant()
284 	struct ishtp_cl *loader_ishtp_cl = client_data->loader_ishtp_cl;  in loader_cl_send()
289 		out_hdr->command & CMD_MASK,  in loader_cl_send()
290 		out_hdr->command & IS_RESPONSE ? 1 : 0,  in loader_cl_send()
291 		out_hdr->status);  in loader_cl_send()
294 	client_data->response.data = in_msg;  in loader_cl_send()
295 	client_data->response.max_size = in_size;  in loader_cl_send()
296 	client_data->response.error = 0;  in loader_cl_send()
297 	client_data->response.received = false;  in loader_cl_send()
306 	wait_event_interruptible_timeout(client_data->response.wait_queue,  in loader_cl_send()
307 					 client_data->response.received,  in loader_cl_send()
309 	if (!client_data->response.received) {  in loader_cl_send()
312 			out_hdr->command & CMD_MASK);  in loader_cl_send()
313 		return -ETIMEDOUT;  in loader_cl_send()
316 	if (client_data->response.error < 0)  in loader_cl_send()
317 		return client_data->response.error;  in loader_cl_send()
319 	return client_data->response.size;  in loader_cl_send()
323  * process_recv() -	Receive and parse incoming packet
334 	size_t data_len = rb_in_proc->buf_idx;  in process_recv()
339 	if (!client_data->response.data) {  in process_recv()
342 		client_data->response.error = -EINVAL;  in process_recv()
346 	if (client_data->response.received) {  in process_recv()
349 		client_data->response.error = -EINVAL;  in process_recv()
356 	if (!rb_in_proc->buffer.data) {  in process_recv()
358 			 "rb_in_proc->buffer.data returned null");  in process_recv()
359 		client_data->response.error = -EBADMSG;  in process_recv()
367 		client_data->response.error = -EMSGSIZE;  in process_recv()
371 	hdr = (struct loader_msg_hdr *)rb_in_proc->buffer.data;  in process_recv()
376 		hdr->command & CMD_MASK,  in process_recv()
377 		hdr->command & IS_RESPONSE ? 1 : 0,  in process_recv()
378 		hdr->status);  in process_recv()
380 	if (((hdr->command & CMD_MASK) != LOADER_CMD_XFER_QUERY) &&  in process_recv()
381 	    ((hdr->command & CMD_MASK) != LOADER_CMD_XFER_FRAGMENT) &&  in process_recv()
382 	    ((hdr->command & CMD_MASK) != LOADER_CMD_START)) {  in process_recv()
385 			hdr->command & CMD_MASK);  in process_recv()
386 		client_data->response.error = -EPROTO;  in process_recv()
390 	if (data_len > client_data->response.max_size) {  in process_recv()
393 			data_len, client_data->response.max_size);  in process_recv()
394 		client_data->response.error = -EMSGSIZE;  in process_recv()
399 	if (!(hdr->command & IS_RESPONSE)) {  in process_recv()
402 		client_data->response.error = -EIO;  in process_recv()
406 	if (hdr->status) {  in process_recv()
408 			"Loader returned status %d\n",  in process_recv()
409 			hdr->status);  in process_recv()
410 		client_data->response.error = -EIO;  in process_recv()
415 	client_data->response.size = data_len;  in process_recv()
421 	memcpy(client_data->response.data,  in process_recv()
422 	       rb_in_proc->buffer.data, data_len);  in process_recv()
425 	client_data->response.received = true;  in process_recv()
433 	wake_up_interruptible(&client_data->response.wait_queue);  in process_recv()
437  * loader_cl_event_cb() - bus driver callback for incoming message
456  * ish_query_loader_prop() -  Query ISH Shim firmware loader
459  * @fw_info:		Loader firmware properties
461  * This function queries the ISH Shim firmware loader for capabilities.
475 	ldr_xfer_query.image_size = fw->size;  in ish_query_loader_prop()
482 		client_data->flag_retry = true;  in ish_query_loader_prop()
492 		client_data->flag_retry = true;  in ish_query_loader_prop()
494 		return -EMSGSIZE;  in ish_query_loader_prop()
500 	/* Loader firmware properties */  in ish_query_loader_prop()
503 		fw_info->ish_fw_version.major,  in ish_query_loader_prop()
504 		fw_info->ish_fw_version.minor,  in ish_query_loader_prop()
505 		fw_info->ish_fw_version.hotfix,  in ish_query_loader_prop()
506 		fw_info->ish_fw_version.build,  in ish_query_loader_prop()
507 		fw_info->protocol_version,  in ish_query_loader_prop()
508 		fw_info->ldr_version.value);  in ish_query_loader_prop()
512 		fw_info->ldr_capability.max_fw_image_size,  in ish_query_loader_prop()
513 		fw_info->ldr_capability.xfer_mode,  in ish_query_loader_prop()
514 		fw_info->ldr_capability.max_dma_buf_size,  in ish_query_loader_prop()
518 	if (fw_info->ldr_capability.max_fw_image_size < fw->size) {  in ish_query_loader_prop()
520 			"ISH firmware size %zu is greater than Shim firmware loader max supported %d\n",  in ish_query_loader_prop()
521 			fw->size,  in ish_query_loader_prop()
522 			fw_info->ldr_capability.max_fw_image_size);  in ish_query_loader_prop()
523 		return -ENOSPC;  in ish_query_loader_prop()
527 	if ((fw_info->ldr_capability.xfer_mode & LOADER_XFER_MODE_DIRECT_DMA) &&  in ish_query_loader_prop()
528 	    (fw_info->ldr_capability.max_dma_buf_size % L1_CACHE_BYTES)) {  in ish_query_loader_prop()
530 			"Shim firmware loader buffer size %d should be multiple of cacheline\n",  in ish_query_loader_prop()
531 			fw_info->ldr_capability.max_dma_buf_size);  in ish_query_loader_prop()
532 		return -EINVAL;  in ish_query_loader_prop()
543  * This function uses ISH-TP to transfer ISH firmware from host to
558 		LOADER_SHIM_IPC_BUF_SIZE - IPC_FRAGMENT_DATA_PREAMBLE;  in ish_fw_xfer_ishtp()
562 		client_data->flag_retry = true;  in ish_fw_xfer_ishtp()
563 		return -ENOMEM;  in ish_fw_xfer_ishtp()
566 	ldr_xfer_ipc_frag->fragment.hdr.command = LOADER_CMD_XFER_FRAGMENT;  in ish_fw_xfer_ishtp()
567 	ldr_xfer_ipc_frag->fragment.xfer_mode = LOADER_XFER_MODE_ISHTP;  in ish_fw_xfer_ishtp()
569 	/* Break the firmware image into fragments and send as ISH-TP payload */  in ish_fw_xfer_ishtp()
571 	while (fragment_offset < fw->size) {  in ish_fw_xfer_ishtp()
572 		if (fragment_offset + payload_max_size < fw->size) {  in ish_fw_xfer_ishtp()
574 			ldr_xfer_ipc_frag->fragment.is_last = 0;  in ish_fw_xfer_ishtp()
576 			fragment_size = fw->size - fragment_offset;  in ish_fw_xfer_ishtp()
577 			ldr_xfer_ipc_frag->fragment.is_last = 1;  in ish_fw_xfer_ishtp()
580 		ldr_xfer_ipc_frag->fragment.offset = fragment_offset;  in ish_fw_xfer_ishtp()
581 		ldr_xfer_ipc_frag->fragment.size = fragment_size;  in ish_fw_xfer_ishtp()
582 		memcpy(ldr_xfer_ipc_frag->data,  in ish_fw_xfer_ishtp()
583 		       &fw->data[fragment_offset],  in ish_fw_xfer_ishtp()
588 			ldr_xfer_ipc_frag->fragment.offset,  in ish_fw_xfer_ishtp()
589 			ldr_xfer_ipc_frag->fragment.size,  in ish_fw_xfer_ishtp()
590 			ldr_xfer_ipc_frag->fragment.is_last);  in ish_fw_xfer_ishtp()
598 			client_data->flag_retry = true;  in ish_fw_xfer_ishtp()
615  * ish_fw_xfer_direct_dma() - Loads ISH firmware using direct dma
618  * @fw_info:		Loader firmware properties
623  * us to overcome the ISH-TP 4 Kb limit, and allows us to DMA
639 	struct device *devc = ishtp_get_pci_device(client_data->cl_device);  in ish_fw_xfer_direct_dma()
649 	payload_max_size = min3(fw->size,  in ish_fw_xfer_direct_dma()
657 	payload_max_size &= ~(L1_CACHE_BYTES - 1);  in ish_fw_xfer_direct_dma()
661 		client_data->flag_retry = true;  in ish_fw_xfer_direct_dma()
662 		return -ENOMEM;  in ish_fw_xfer_direct_dma()
669 		client_data->flag_retry = true;  in ish_fw_xfer_direct_dma()
670 		rv = -ENOMEM;  in ish_fw_xfer_direct_dma()
680 	while (fragment_offset < fw->size) {  in ish_fw_xfer_direct_dma()
681 		if (fragment_offset + payload_max_size < fw->size) {  in ish_fw_xfer_direct_dma()
685 			fragment_size = fw->size - fragment_offset;  in ish_fw_xfer_direct_dma()
691 		memcpy(dma_buf, &fw->data[fragment_offset], fragment_size);  in ish_fw_xfer_direct_dma()
716 			client_data->flag_retry = true;  in ish_fw_xfer_direct_dma()
739  * This function sends message to Shim firmware loader to start
773 	struct ishtp_cl *loader_ishtp_cl = client_data->loader_ishtp_cl;  in load_fw_from_host()
775 	client_data->flag_retry = false;  in load_fw_from_host()
779 		client_data->flag_retry = true;  in load_fw_from_host()
780 		rv = -ENOMEM;  in load_fw_from_host()
793 	/* Step 1: Query Shim firmware loader properties */  in load_fw_from_host()
808 			"No transfer mode selected in firmware\n");  in load_fw_from_host()
809 		rv = -EINVAL;  in load_fw_from_host()
832 	if (client_data->flag_retry &&  in load_fw_from_host()
833 	    client_data->retry_count++ < MAX_LOAD_ATTEMPTS) {  in load_fw_from_host()
855  * loader_init() -	Init function for ISH-TP client
856  * @loader_ishtp_cl:	ISH-TP client instance
886 		rv = -ENOENT;  in loader_init()
902 	ishtp_register_event_cb(client_data->cl_device, loader_cl_event_cb);  in loader_init()
918 	/* Disband and free all Tx and Rx client-level rings */  in loader_deinit()
932 	loader_ishtp_cl = client_data->loader_ishtp_cl;  in reset_handler()
933 	cl_device = client_data->cl_device;  in reset_handler()
946 	client_data->loader_ishtp_cl = loader_ishtp_cl;  in reset_handler()
947 	client_data->cl_device = cl_device;  in reset_handler()
960  * loader_ishtp_cl_probe() - ISH-TP client driver probe
961  * @cl_device:		ISH-TP client device instance
963  * This function gets called on device create on ISH-TP bus
977 		return -ENOMEM;  in loader_ishtp_cl_probe()
981 		return -ENOMEM;  in loader_ishtp_cl_probe()
985 	client_data->loader_ishtp_cl = loader_ishtp_cl;  in loader_ishtp_cl_probe()
986 	client_data->cl_device = cl_device;  in loader_ishtp_cl_probe()
988 	init_waitqueue_head(&client_data->response.wait_queue);  in loader_ishtp_cl_probe()
990 	INIT_WORK(&client_data->work_ishtp_reset,  in loader_ishtp_cl_probe()
992 	INIT_WORK(&client_data->work_fw_load,  in loader_ishtp_cl_probe()
1002 	client_data->retry_count = 0;  in loader_ishtp_cl_probe()
1005 	schedule_work(&client_data->work_fw_load);  in loader_ishtp_cl_probe()
1011  * loader_ishtp_cl_remove() - ISH-TP client driver remove
1012  * @cl_device:		ISH-TP client device instance
1014  * This function gets called on device remove on ISH-TP bus
1031 	cancel_work_sync(&client_data->work_fw_load);  in loader_ishtp_cl_remove()
1032 	cancel_work_sync(&client_data->work_ishtp_reset);  in loader_ishtp_cl_remove()
1040  * loader_ishtp_cl_reset() - ISH-TP client driver reset
1041  * @cl_device:		ISH-TP client device instance
1043  * This function gets called on device reset on ISH-TP bus
1054 	schedule_work(&client_data->work_ishtp_reset);  in loader_ishtp_cl_reset()
1060 	.name = "ish-loader",
1083 MODULE_DESCRIPTION("ISH ISH-TP Host firmware Loader Client Driver");