Lines Matching +full:ipa +full:- +full:ap +full:- +full:to +full:- +full:modem
1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2013-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2022 Linaro Ltd.
13 #include "ipa.h"
21 * DOC: AP/Modem QMI Handshake
23 * The AP and modem perform a "handshake" at initialization time to ensure
24 * both sides know when everything is ready to begin operating. The AP
26 * using a service on the modem, and server to service modem requests (and
27 * to supply an indication message from the AP). Once the handshake is
28 * complete, the AP and modem may begin IPA operation. This occurs
29 * only when the AP IPA driver, modem IPA driver, and IPA microcontroller
32 * The QMI service on the modem expects to receive an INIT_DRIVER request from
33 * the AP, which contains parameters used by the modem during initialization.
34 * The AP sends this request as soon as it is knows the modem side service
35 * is available. The modem responds to this request, and if this response
36 * contains a success result, the AP knows the modem IPA driver is ready.
38 * The modem is responsible for loading firmware on the IPA microcontroller.
39 * This occurs only during the initial modem boot. The modem sends a
40 * separate DRIVER_INIT_COMPLETE request to the AP to report that the
41 * microcontroller is ready. The AP may assume the microcontroller is
42 * ready and remain so (even if the modem reboots) once it has received
43 * and responded to this request.
46 * on the initial modem boot, but optional (but in practice does occur) on
47 * subsequent boots. The modem expects to receive a final INIT_COMPLETE
48 * indication message from the AP when it is about to begin its normal
49 * operation. The AP will only send this message after it has received
50 * and responded to an INDICATION_REGISTER request from the modem.
53 * - Whenever the AP learns the modem has booted and its IPA QMI service
54 * is available, it sends an INIT_DRIVER request to the modem. The
55 * modem supplies a success response when it is ready to operate.
56 * - On the initial boot, the modem sets up the IPA microcontroller, and
57 * sends a DRIVER_INIT_COMPLETE request to the AP when this is done.
58 * - When the modem is ready to receive an INIT_COMPLETE indication from
59 * the AP, it sends an INDICATION_REGISTER request to the AP.
60 * - On the initial modem boot, everything is ready when:
61 * - AP has received a success response from its INIT_DRIVER request
62 * - AP has responded to a DRIVER_INIT_COMPLETE request
63 * - AP has responded to an INDICATION_REGISTER request from the modem
64 * - AP has sent an INIT_COMPLETE indication to the modem
65 * - On subsequent modem boots, everything is ready when:
66 * - AP has received a success response from its INIT_DRIVER request
67 * - AP has responded to a DRIVER_INIT_COMPLETE request
68 * - The INDICATION_REGISTER request and INIT_COMPLETE indication are
69 * optional for non-initial modem boots, and have no bearing on the
83 /* Send an INIT_COMPLETE indication message to the modem */
86 struct ipa *ipa = container_of(ipa_qmi, struct ipa, qmi); in ipa_server_init_complete() local
87 struct qmi_handle *qmi = &ipa_qmi->server_handle; in ipa_server_init_complete()
88 struct sockaddr_qrtr *sq = &ipa_qmi->modem_sq; in ipa_server_init_complete()
99 dev_err(&ipa->pdev->dev, in ipa_server_init_complete()
102 ipa_qmi->indication_sent = true; in ipa_server_init_complete()
108 if (!ipa_qmi->indication_requested) in ipa_qmi_indication()
111 if (ipa_qmi->indication_sent) in ipa_qmi_indication()
117 /* Determine whether everything is ready to start normal operation.
118 * We know everything (else) is ready when we know the IPA driver on
119 * the modem is ready, and the microcontroller is ready.
121 * When the modem boots (or reboots), the handshake sequence starts
122 * with the AP sending the modem an INIT_DRIVER request. Within
124 * initial boot, non-zero (true) for a subsequent (SSR) boot.
128 struct ipa *ipa; in ipa_qmi_ready() local
131 /* We aren't ready until the modem and microcontroller are */ in ipa_qmi_ready()
132 if (!ipa_qmi->modem_ready || !ipa_qmi->uc_ready) in ipa_qmi_ready()
138 /* The initial boot requires us to send the indication. */ in ipa_qmi_ready()
139 if (ipa_qmi->initial_boot) { in ipa_qmi_ready()
140 if (!ipa_qmi->indication_sent) in ipa_qmi_ready()
143 /* The initial modem boot completed successfully */ in ipa_qmi_ready()
144 ipa_qmi->initial_boot = false; in ipa_qmi_ready()
148 ipa = container_of(ipa_qmi, struct ipa, qmi); in ipa_qmi_ready()
149 ret = ipa_modem_start(ipa); in ipa_qmi_ready()
151 dev_err(&ipa->pdev->dev, "error %d starting modem\n", ret); in ipa_qmi_ready()
154 /* All QMI clients from the modem node are gone (modem shut down or crashed). */
161 /* The modem client and server go away at the same time */ in ipa_server_bye()
162 memset(&ipa_qmi->modem_sq, 0, sizeof(ipa_qmi->modem_sq)); in ipa_server_bye()
164 /* initial_boot doesn't change when modem reboots */ in ipa_server_bye()
165 /* uc_ready doesn't change when modem reboots */ in ipa_server_bye()
166 ipa_qmi->modem_ready = false; in ipa_server_bye()
167 ipa_qmi->indication_requested = false; in ipa_server_bye()
168 ipa_qmi->indication_sent = false; in ipa_server_bye()
175 /* Callback function to handle an INDICATION_REGISTER request message from the
176 * modem. This informs the AP that the modem is now ready to receive the
186 struct ipa *ipa; in ipa_server_indication_register() local
190 ipa = container_of(ipa_qmi, struct ipa, qmi); in ipa_server_indication_register()
199 ipa_qmi->indication_requested = true; in ipa_server_indication_register()
202 dev_err(&ipa->pdev->dev, in ipa_server_indication_register()
207 /* Respond to a DRIVER_INIT_COMPLETE request message from the modem. */
215 struct ipa *ipa; in ipa_server_driver_init_complete() local
219 ipa = container_of(ipa_qmi, struct ipa, qmi); in ipa_server_driver_init_complete()
228 ipa_qmi->uc_ready = true; in ipa_server_driver_init_complete()
231 dev_err(&ipa->pdev->dev, in ipa_server_driver_init_complete()
236 /* The server handles two request message types sent by the modem. */
255 /* Handle an INIT_DRIVER response message from the modem. */
260 txn->result = 0; /* IPA_QMI_INIT_DRIVER request was successful */ in ipa_client_init_driver()
261 complete(&txn->completion); in ipa_client_init_driver()
264 /* The client handles one response message type sent by the modem. */
276 /* Return a pointer to an init modem driver request structure, which contains
277 * configuration parameters for the modem. The modem may be started multiple
286 struct ipa *ipa = container_of(ipa_qmi, struct ipa, qmi); in init_modem_driver_req() local
292 req.skip_uc_load = ipa->uc_loaded ? 1 : 0; in init_modem_driver_req()
294 /* We only have to initialize most of it once */ in init_modem_driver_req()
301 mem = ipa_mem_find(ipa, IPA_MEM_MODEM_HEADER); in init_modem_driver_req()
302 if (mem->size) { in init_modem_driver_req()
304 req.hdr_tbl_info.start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
305 req.hdr_tbl_info.end = req.hdr_tbl_info.start + mem->size - 1; in init_modem_driver_req()
308 mem = ipa_mem_find(ipa, IPA_MEM_V4_ROUTE); in init_modem_driver_req()
310 req.v4_route_tbl_info.start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
311 req.v4_route_tbl_info.end = IPA_ROUTE_MODEM_COUNT - 1; in init_modem_driver_req()
313 mem = ipa_mem_find(ipa, IPA_MEM_V6_ROUTE); in init_modem_driver_req()
315 req.v6_route_tbl_info.start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
316 req.v6_route_tbl_info.end = IPA_ROUTE_MODEM_COUNT - 1; in init_modem_driver_req()
318 mem = ipa_mem_find(ipa, IPA_MEM_V4_FILTER); in init_modem_driver_req()
320 req.v4_filter_tbl_start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
322 mem = ipa_mem_find(ipa, IPA_MEM_V6_FILTER); in init_modem_driver_req()
324 req.v6_filter_tbl_start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
326 mem = ipa_mem_find(ipa, IPA_MEM_MODEM); in init_modem_driver_req()
327 if (mem->size) { in init_modem_driver_req()
329 req.modem_mem_info.start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
330 req.modem_mem_info.size = mem->size; in init_modem_driver_req()
335 ipa->name_map[IPA_ENDPOINT_AP_MODEM_RX]->endpoint_id; in init_modem_driver_req()
339 mem = ipa_mem_find(ipa, IPA_MEM_MODEM_PROC_CTX); in init_modem_driver_req()
340 if (mem->size) { in init_modem_driver_req()
343 ipa->mem_offset + mem->offset; in init_modem_driver_req()
345 req.hdr_proc_ctx_tbl_info.start + mem->size - 1; in init_modem_driver_req()
348 /* Nothing to report for the compression table (zip_tbl_info) */ in init_modem_driver_req()
350 mem = ipa_mem_find(ipa, IPA_MEM_V4_ROUTE_HASHED); in init_modem_driver_req()
351 if (mem->size) { in init_modem_driver_req()
354 ipa->mem_offset + mem->offset; in init_modem_driver_req()
355 req.v4_hash_route_tbl_info.end = IPA_ROUTE_MODEM_COUNT - 1; in init_modem_driver_req()
358 mem = ipa_mem_find(ipa, IPA_MEM_V6_ROUTE_HASHED); in init_modem_driver_req()
359 if (mem->size) { in init_modem_driver_req()
362 ipa->mem_offset + mem->offset; in init_modem_driver_req()
363 req.v6_hash_route_tbl_info.end = IPA_ROUTE_MODEM_COUNT - 1; in init_modem_driver_req()
366 mem = ipa_mem_find(ipa, IPA_MEM_V4_FILTER_HASHED); in init_modem_driver_req()
367 if (mem->size) { in init_modem_driver_req()
369 req.v4_hash_filter_tbl_start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
372 mem = ipa_mem_find(ipa, IPA_MEM_V6_FILTER_HASHED); in init_modem_driver_req()
373 if (mem->size) { in init_modem_driver_req()
375 req.v6_hash_filter_tbl_start = ipa->mem_offset + mem->offset; in init_modem_driver_req()
378 /* The stats fields are only valid for IPA v4.0+ */ in init_modem_driver_req()
379 if (ipa->version >= IPA_VERSION_4_0) { in init_modem_driver_req()
380 mem = ipa_mem_find(ipa, IPA_MEM_STATS_QUOTA_MODEM); in init_modem_driver_req()
381 if (mem->size) { in init_modem_driver_req()
384 ipa->mem_offset + mem->offset; in init_modem_driver_req()
386 req.hw_stats_quota_size = ipa->mem_offset + mem->size; in init_modem_driver_req()
390 mem = ipa_mem_find(ipa, IPA_MEM_STATS_DROP); in init_modem_driver_req()
391 if (mem && mem->size) { in init_modem_driver_req()
394 ipa->mem_offset + mem->offset; in init_modem_driver_req()
396 req.hw_stats_drop_size = ipa->mem_offset + mem->size; in init_modem_driver_req()
403 /* Send an INIT_DRIVER request to the modem, and wait for it to complete. */
412 struct ipa *ipa; in ipa_client_init_driver_work() local
416 qmi = &ipa_qmi->client_handle; in ipa_client_init_driver_work()
418 ipa = container_of(ipa_qmi, struct ipa, qmi); in ipa_client_init_driver_work()
419 dev = &ipa->pdev->dev; in ipa_client_init_driver_work()
429 ret = qmi_send_request(qmi, &ipa_qmi->modem_sq, &txn, in ipa_client_init_driver_work()
438 ipa_qmi->modem_ready = true; in ipa_client_init_driver_work()
441 /* If any error occurs we need to cancel the transaction */ in ipa_client_init_driver_work()
446 /* The modem server is now available. We will send an INIT_DRIVER request
447 * to the modem, but can't wait for it to complete in this callback thread.
448 * Schedule a worker on the global workqueue to do that for us.
457 ipa_qmi->modem_sq.sq_family = AF_QIPCRTR; in ipa_client_new_server()
458 ipa_qmi->modem_sq.sq_node = svc->node; in ipa_client_new_server()
459 ipa_qmi->modem_sq.sq_port = svc->port; in ipa_client_new_server()
461 schedule_work(&ipa_qmi->init_driver_work); in ipa_client_new_server()
471 int ipa_qmi_setup(struct ipa *ipa) in ipa_qmi_setup() argument
473 struct ipa_qmi *ipa_qmi = &ipa->qmi; in ipa_qmi_setup()
476 ipa_qmi->initial_boot = true; in ipa_qmi_setup()
478 /* The server handle is used to handle the DRIVER_INIT_COMPLETE in ipa_qmi_setup()
479 * request on the first modem boot. It also receives the in ipa_qmi_setup()
484 ret = qmi_handle_init(&ipa_qmi->server_handle, in ipa_qmi_setup()
490 ret = qmi_add_server(&ipa_qmi->server_handle, IPA_HOST_SERVICE_SVC_ID, in ipa_qmi_setup()
496 * to the modem, and receiving its response message. in ipa_qmi_setup()
498 ret = qmi_handle_init(&ipa_qmi->client_handle, in ipa_qmi_setup()
505 INIT_WORK(&ipa_qmi->init_driver_work, ipa_client_init_driver_work); in ipa_qmi_setup()
507 ret = qmi_add_lookup(&ipa_qmi->client_handle, IPA_MODEM_SERVICE_SVC_ID, in ipa_qmi_setup()
516 qmi_handle_release(&ipa_qmi->client_handle); in ipa_qmi_setup()
517 memset(&ipa_qmi->client_handle, 0, sizeof(ipa_qmi->client_handle)); in ipa_qmi_setup()
520 qmi_handle_release(&ipa_qmi->server_handle); in ipa_qmi_setup()
521 memset(&ipa_qmi->server_handle, 0, sizeof(ipa_qmi->server_handle)); in ipa_qmi_setup()
526 /* Tear down IPA QMI handles */
527 void ipa_qmi_teardown(struct ipa *ipa) in ipa_qmi_teardown() argument
529 cancel_work_sync(&ipa->qmi.init_driver_work); in ipa_qmi_teardown()
531 qmi_handle_release(&ipa->qmi.client_handle); in ipa_qmi_teardown()
532 memset(&ipa->qmi.client_handle, 0, sizeof(ipa->qmi.client_handle)); in ipa_qmi_teardown()
534 qmi_handle_release(&ipa->qmi.server_handle); in ipa_qmi_teardown()
535 memset(&ipa->qmi.server_handle, 0, sizeof(ipa->qmi.server_handle)); in ipa_qmi_teardown()