1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2023 Linaro Ltd.
7 #include <linux/types.h>
8 #include <linux/atomic.h>
9 #include <linux/bitfield.h>
10 #include <linux/device.h>
11 #include <linux/bug.h>
13 #include <linux/firmware.h>
14 #include <linux/module.h>
16 #include <linux/of_device.h>
17 #include <linux/of_address.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/qcom_scm.h>
20 #include <linux/soc/qcom/mdt_loader.h>
23 #include "ipa_power.h"
25 #include "ipa_endpoint.h"
26 #include "ipa_resource.h"
30 #include "ipa_table.h"
31 #include "ipa_smp2p.h"
32 #include "ipa_modem.h"
34 #include "ipa_interrupt.h"
35 #include "gsi_trans.h"
36 #include "ipa_sysfs.h"
39 * DOC: The IP Accelerator
41 * This driver supports the Qualcomm IP Accelerator (IPA), which is a
42 * networking component found in many Qualcomm SoCs. The IPA is connected
43 * to the application processor (AP), but is also connected (and partially
44 * controlled by) other "execution environments" (EEs), such as a modem.
46 * The IPA is the conduit between the AP and the modem that carries network
47 * traffic. This driver presents a network interface representing the
48 * connection of the modem to external (e.g. LTE) networks.
50 * The IPA provides protocol checksum calculation, offloading this work
51 * from the AP. The IPA offers additional functionality, including routing,
52 * filtering, and NAT support, but that more advanced functionality is not
53 * currently supported. Despite that, some resources--including routing
54 * tables and filter tables--are defined in this driver because they must
55 * be initialized even when the advanced hardware features are not used.
57 * There are two distinct layers that implement the IPA hardware, and this
58 * is reflected in the organization of the driver. The generic software
59 * interface (GSI) is an integral component of the IPA, providing a
60 * well-defined communication layer between the AP subsystem and the IPA
61 * core. The GSI implements a set of "channels" used for communication
62 * between the AP and the IPA.
64 * The IPA layer uses GSI channels to implement its "endpoints". And while
65 * a GSI channel carries data between the AP and the IPA, a pair of IPA
66 * endpoints is used to carry traffic between two EEs. Specifically, the main
67 * modem network interface is implemented by two pairs of endpoints: a TX
68 * endpoint on the AP coupled with an RX endpoint on the modem; and another
69 * RX endpoint on the AP receiving data from a TX endpoint on the modem.
72 /* The name of the GSI firmware file relative to /lib/firmware */
73 #define IPA_FW_PATH_DEFAULT "ipa_fws.mdt"
76 /* Shift of 19.2 MHz timestamp to achieve lower resolution timestamps */
77 #define DPL_TIMESTAMP_SHIFT 14 /* ~1.172 kHz, ~853 usec per tick */
78 #define TAG_TIMESTAMP_SHIFT 14
79 #define NAT_TIMESTAMP_SHIFT 24 /* ~1.144 Hz, ~874 msec per tick */
81 /* Divider for 19.2 MHz crystal oscillator clock to get common timer clock */
82 #define IPA_XO_CLOCK_DIVIDER 192 /* 1 is subtracted where used */
85 * enum ipa_firmware_loader: How GSI firmware gets loaded
87 * @IPA_LOADER_DEFER: System not ready; try again later
88 * @IPA_LOADER_SELF: AP loads GSI firmware
89 * @IPA_LOADER_MODEM: Modem loads GSI firmware, signals when done
90 * @IPA_LOADER_SKIP: Neither AP nor modem need to load GSI firmware
91 * @IPA_LOADER_INVALID: GSI firmware loader specification is invalid
93 enum ipa_firmware_loader {
102 * ipa_setup() - Set up IPA hardware
105 * Perform initialization that requires issuing immediate commands on
106 * the command TX endpoint. If the modem is doing GSI firmware load
107 * and initialization, this function will be called when an SMP2P
108 * interrupt has been signaled by the modem. Otherwise it will be
109 * called from ipa_probe() after GSI firmware has been successfully
110 * loaded, authenticated, and started by Trust Zone.
112 int ipa_setup(struct ipa *ipa)
114 struct ipa_endpoint *exception_endpoint;
115 struct ipa_endpoint *command_endpoint;
116 struct device *dev = &ipa->pdev->dev;
119 ret = gsi_setup(&ipa->gsi);
123 ret = ipa_power_setup(ipa);
125 goto err_gsi_teardown;
127 ipa_endpoint_setup(ipa);
129 /* We need to use the AP command TX endpoint to perform other
130 * initialization, so we enable first.
132 command_endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
133 ret = ipa_endpoint_enable_one(command_endpoint);
135 goto err_endpoint_teardown;
137 ret = ipa_mem_setup(ipa); /* No matching teardown required */
139 goto err_command_disable;
141 ret = ipa_table_setup(ipa); /* No matching teardown required */
143 goto err_command_disable;
145 /* Enable the exception handling endpoint, and tell the hardware
146 * to use it by default.
148 exception_endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
149 ret = ipa_endpoint_enable_one(exception_endpoint);
151 goto err_command_disable;
153 ipa_endpoint_default_route_set(ipa, exception_endpoint->endpoint_id);
155 /* We're all set. Now prepare for communication with the modem */
156 ret = ipa_qmi_setup(ipa);
158 goto err_default_route_clear;
160 ipa->setup_complete = true;
162 dev_info(dev, "IPA driver setup completed successfully\n");
166 err_default_route_clear:
167 ipa_endpoint_default_route_clear(ipa);
168 ipa_endpoint_disable_one(exception_endpoint);
170 ipa_endpoint_disable_one(command_endpoint);
171 err_endpoint_teardown:
172 ipa_endpoint_teardown(ipa);
173 ipa_power_teardown(ipa);
175 gsi_teardown(&ipa->gsi);
181 * ipa_teardown() - Inverse of ipa_setup()
184 static void ipa_teardown(struct ipa *ipa)
186 struct ipa_endpoint *exception_endpoint;
187 struct ipa_endpoint *command_endpoint;
189 /* We're going to tear everything down, as if setup never completed */
190 ipa->setup_complete = false;
192 ipa_qmi_teardown(ipa);
193 ipa_endpoint_default_route_clear(ipa);
194 exception_endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
195 ipa_endpoint_disable_one(exception_endpoint);
196 command_endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
197 ipa_endpoint_disable_one(command_endpoint);
198 ipa_endpoint_teardown(ipa);
199 ipa_power_teardown(ipa);
200 gsi_teardown(&ipa->gsi);
204 ipa_hardware_config_bcr(struct ipa *ipa, const struct ipa_data *data)
206 const struct reg *reg;
209 /* IPA v4.5+ has no backward compatibility register */
210 if (ipa->version >= IPA_VERSION_4_5)
213 reg = ipa_reg(ipa, IPA_BCR);
214 val = data->backward_compat;
215 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
218 static void ipa_hardware_config_tx(struct ipa *ipa)
220 enum ipa_version version = ipa->version;
221 const struct reg *reg;
225 if (version <= IPA_VERSION_4_0 || version >= IPA_VERSION_4_5)
228 /* Disable PA mask to allow HOLB drop */
229 reg = ipa_reg(ipa, IPA_TX_CFG);
230 offset = ipa_reg_offset(reg);
232 val = ioread32(ipa->reg_virt + offset);
234 val &= ~ipa_reg_bit(reg, PA_MASK_EN);
236 iowrite32(val, ipa->reg_virt + offset);
239 static void ipa_hardware_config_clkon(struct ipa *ipa)
241 enum ipa_version version = ipa->version;
242 const struct reg *reg;
245 if (version >= IPA_VERSION_4_5)
248 if (version < IPA_VERSION_4_0 && version != IPA_VERSION_3_1)
251 /* Implement some hardware workarounds */
252 reg = ipa_reg(ipa, CLKON_CFG);
253 if (version == IPA_VERSION_3_1) {
254 /* Disable MISC clock gating */
255 val = ipa_reg_bit(reg, CLKON_MISC);
256 } else { /* IPA v4.0+ */
257 /* Enable open global clocks in the CLKON configuration */
258 val = ipa_reg_bit(reg, CLKON_GLOBAL);
259 val |= ipa_reg_bit(reg, GLOBAL_2X_CLK);
262 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
265 /* Configure bus access behavior for IPA components */
266 static void ipa_hardware_config_comp(struct ipa *ipa)
268 const struct reg *reg;
272 /* Nothing to configure prior to IPA v4.0 */
273 if (ipa->version < IPA_VERSION_4_0)
276 reg = ipa_reg(ipa, COMP_CFG);
277 offset = ipa_reg_offset(reg);
278 val = ioread32(ipa->reg_virt + offset);
280 if (ipa->version == IPA_VERSION_4_0) {
281 val &= ~ipa_reg_bit(reg, IPA_QMB_SELECT_CONS_EN);
282 val &= ~ipa_reg_bit(reg, IPA_QMB_SELECT_PROD_EN);
283 val &= ~ipa_reg_bit(reg, IPA_QMB_SELECT_GLOBAL_EN);
284 } else if (ipa->version < IPA_VERSION_4_5) {
285 val |= ipa_reg_bit(reg, GSI_MULTI_AXI_MASTERS_DIS);
287 /* For IPA v4.5 FULL_FLUSH_WAIT_RS_CLOSURE_EN is 0 */
290 val |= ipa_reg_bit(reg, GSI_MULTI_INORDER_RD_DIS);
291 val |= ipa_reg_bit(reg, GSI_MULTI_INORDER_WR_DIS);
293 iowrite32(val, ipa->reg_virt + offset);
296 /* Configure DDR and (possibly) PCIe max read/write QSB values */
298 ipa_hardware_config_qsb(struct ipa *ipa, const struct ipa_data *data)
300 const struct ipa_qsb_data *data0;
301 const struct ipa_qsb_data *data1;
302 const struct reg *reg;
305 /* QMB 0 represents DDR; QMB 1 (if present) represents PCIe */
306 data0 = &data->qsb_data[IPA_QSB_MASTER_DDR];
307 if (data->qsb_count > 1)
308 data1 = &data->qsb_data[IPA_QSB_MASTER_PCIE];
310 /* Max outstanding write accesses for QSB masters */
311 reg = ipa_reg(ipa, QSB_MAX_WRITES);
313 val = ipa_reg_encode(reg, GEN_QMB_0_MAX_WRITES, data0->max_writes);
314 if (data->qsb_count > 1)
315 val |= ipa_reg_encode(reg, GEN_QMB_1_MAX_WRITES,
318 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
320 /* Max outstanding read accesses for QSB masters */
321 reg = ipa_reg(ipa, QSB_MAX_READS);
323 val = ipa_reg_encode(reg, GEN_QMB_0_MAX_READS, data0->max_reads);
324 if (ipa->version >= IPA_VERSION_4_0)
325 val |= ipa_reg_encode(reg, GEN_QMB_0_MAX_READS_BEATS,
326 data0->max_reads_beats);
327 if (data->qsb_count > 1) {
328 val = ipa_reg_encode(reg, GEN_QMB_1_MAX_READS,
330 if (ipa->version >= IPA_VERSION_4_0)
331 val |= ipa_reg_encode(reg, GEN_QMB_1_MAX_READS_BEATS,
332 data1->max_reads_beats);
335 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
338 /* The internal inactivity timer clock is used for the aggregation timer */
339 #define TIMER_FREQUENCY 32000 /* 32 KHz inactivity timer clock */
341 /* Compute the value to use in the COUNTER_CFG register AGGR_GRANULARITY
342 * field to represent the given number of microseconds. The value is one
343 * less than the number of timer ticks in the requested period. 0 is not
344 * a valid granularity value (so for example @usec must be at least 16 for
345 * a TIMER_FREQUENCY of 32000).
347 static __always_inline u32 ipa_aggr_granularity_val(u32 usec)
349 return DIV_ROUND_CLOSEST(usec * TIMER_FREQUENCY, USEC_PER_SEC) - 1;
352 /* IPA uses unified Qtime starting at IPA v4.5, implementing various
353 * timestamps and timers independent of the IPA core clock rate. The
354 * Qtimer is based on a 56-bit timestamp incremented at each tick of
355 * a 19.2 MHz SoC crystal oscillator (XO clock).
357 * For IPA timestamps (tag, NAT, data path logging) a lower resolution
358 * timestamp is achieved by shifting the Qtimer timestamp value right
359 * some number of bits to produce the low-order bits of the coarser
360 * granularity timestamp.
362 * For timers, a common timer clock is derived from the XO clock using
363 * a divider (we use 192, to produce a 100kHz timer clock). From
364 * this common clock, three "pulse generators" are used to produce
365 * timer ticks at a configurable frequency. IPA timers (such as
366 * those used for aggregation or head-of-line block handling) now
367 * define their period based on one of these pulse generators.
369 static void ipa_qtime_config(struct ipa *ipa)
371 const struct reg *reg;
375 /* Timer clock divider must be disabled when we change the rate */
376 reg = ipa_reg(ipa, TIMERS_XO_CLK_DIV_CFG);
377 iowrite32(0, ipa->reg_virt + ipa_reg_offset(reg));
379 reg = ipa_reg(ipa, QTIME_TIMESTAMP_CFG);
380 /* Set DPL time stamp resolution to use Qtime (instead of 1 msec) */
381 val = ipa_reg_encode(reg, DPL_TIMESTAMP_LSB, DPL_TIMESTAMP_SHIFT);
382 val |= ipa_reg_bit(reg, DPL_TIMESTAMP_SEL);
383 /* Configure tag and NAT Qtime timestamp resolution as well */
384 val = ipa_reg_encode(reg, TAG_TIMESTAMP_LSB, TAG_TIMESTAMP_SHIFT);
385 val = ipa_reg_encode(reg, NAT_TIMESTAMP_LSB, NAT_TIMESTAMP_SHIFT);
387 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
389 /* Set granularity of pulse generators used for other timers */
390 reg = ipa_reg(ipa, TIMERS_PULSE_GRAN_CFG);
391 val = ipa_reg_encode(reg, PULSE_GRAN_0, IPA_GRAN_100_US);
392 val |= ipa_reg_encode(reg, PULSE_GRAN_1, IPA_GRAN_1_MS);
393 if (ipa->version >= IPA_VERSION_5_0) {
394 val |= ipa_reg_encode(reg, PULSE_GRAN_2, IPA_GRAN_10_MS);
395 val |= ipa_reg_encode(reg, PULSE_GRAN_3, IPA_GRAN_10_MS);
397 val |= ipa_reg_encode(reg, PULSE_GRAN_2, IPA_GRAN_1_MS);
400 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
402 /* Actual divider is 1 more than value supplied here */
403 reg = ipa_reg(ipa, TIMERS_XO_CLK_DIV_CFG);
404 offset = ipa_reg_offset(reg);
405 val = ipa_reg_encode(reg, DIV_VALUE, IPA_XO_CLOCK_DIVIDER - 1);
407 iowrite32(val, ipa->reg_virt + offset);
409 /* Divider value is set; re-enable the common timer clock divider */
410 val |= ipa_reg_bit(reg, DIV_ENABLE);
412 iowrite32(val, ipa->reg_virt + offset);
415 /* Before IPA v4.5 timing is controlled by a counter register */
416 static void ipa_hardware_config_counter(struct ipa *ipa)
418 u32 granularity = ipa_aggr_granularity_val(IPA_AGGR_GRANULARITY);
419 const struct reg *reg;
422 reg = ipa_reg(ipa, COUNTER_CFG);
423 /* If defined, EOT_COAL_GRANULARITY is 0 */
424 val = ipa_reg_encode(reg, AGGR_GRANULARITY, granularity);
425 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
428 static void ipa_hardware_config_timing(struct ipa *ipa)
430 if (ipa->version < IPA_VERSION_4_5)
431 ipa_hardware_config_counter(ipa);
433 ipa_qtime_config(ipa);
436 static void ipa_hardware_config_hashing(struct ipa *ipa)
438 const struct reg *reg;
440 /* Other than IPA v4.2, all versions enable "hashing". Starting
441 * with IPA v5.0, the filter and router tables are implemented
442 * differently, but the default configuration enables this feature
443 * (now referred to as "cacheing"), so there's nothing to do here.
445 if (ipa->version != IPA_VERSION_4_2)
448 /* IPA v4.2 does not support hashed tables, so disable them */
449 reg = ipa_reg(ipa, FILT_ROUT_HASH_EN);
451 /* IPV6_ROUTER_HASH, IPV6_FILTER_HASH, IPV4_ROUTER_HASH,
452 * IPV4_FILTER_HASH are all zero.
454 iowrite32(0, ipa->reg_virt + ipa_reg_offset(reg));
457 static void ipa_idle_indication_cfg(struct ipa *ipa,
458 u32 enter_idle_debounce_thresh,
459 bool const_non_idle_enable)
461 const struct reg *reg;
464 if (ipa->version < IPA_VERSION_3_5_1)
467 reg = ipa_reg(ipa, IDLE_INDICATION_CFG);
468 val = ipa_reg_encode(reg, ENTER_IDLE_DEBOUNCE_THRESH,
469 enter_idle_debounce_thresh);
470 if (const_non_idle_enable)
471 val |= ipa_reg_bit(reg, CONST_NON_IDLE_ENABLE);
473 iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg));
477 * ipa_hardware_dcd_config() - Enable dynamic clock division on IPA
480 * Configures when the IPA signals it is idle to the global clock
481 * controller, which can respond by scaling down the clock to save
484 static void ipa_hardware_dcd_config(struct ipa *ipa)
486 /* Recommended values for IPA 3.5 and later according to IPA HPG */
487 ipa_idle_indication_cfg(ipa, 256, false);
490 static void ipa_hardware_dcd_deconfig(struct ipa *ipa)
492 /* Power-on reset values */
493 ipa_idle_indication_cfg(ipa, 0, true);
497 * ipa_hardware_config() - Primitive hardware initialization
499 * @data: IPA configuration data
501 static void ipa_hardware_config(struct ipa *ipa, const struct ipa_data *data)
503 ipa_hardware_config_bcr(ipa, data);
504 ipa_hardware_config_tx(ipa);
505 ipa_hardware_config_clkon(ipa);
506 ipa_hardware_config_comp(ipa);
507 ipa_hardware_config_qsb(ipa, data);
508 ipa_hardware_config_timing(ipa);
509 ipa_hardware_config_hashing(ipa);
510 ipa_hardware_dcd_config(ipa);
514 * ipa_hardware_deconfig() - Inverse of ipa_hardware_config()
517 * This restores the power-on reset values (even if they aren't different)
519 static void ipa_hardware_deconfig(struct ipa *ipa)
521 /* Mostly we just leave things as we set them. */
522 ipa_hardware_dcd_deconfig(ipa);
526 * ipa_config() - Configure IPA hardware
528 * @data: IPA configuration data
530 * Perform initialization requiring IPA power to be enabled.
532 static int ipa_config(struct ipa *ipa, const struct ipa_data *data)
536 ipa_hardware_config(ipa, data);
538 ret = ipa_mem_config(ipa);
540 goto err_hardware_deconfig;
542 ipa->interrupt = ipa_interrupt_config(ipa);
543 if (IS_ERR(ipa->interrupt)) {
544 ret = PTR_ERR(ipa->interrupt);
545 ipa->interrupt = NULL;
546 goto err_mem_deconfig;
551 ret = ipa_endpoint_config(ipa);
553 goto err_uc_deconfig;
555 ipa_table_config(ipa); /* No deconfig required */
557 /* Assign resource limitation to each group; no deconfig required */
558 ret = ipa_resource_config(ipa, data->resource_data);
560 goto err_endpoint_deconfig;
562 ret = ipa_modem_config(ipa);
564 goto err_endpoint_deconfig;
568 err_endpoint_deconfig:
569 ipa_endpoint_deconfig(ipa);
571 ipa_uc_deconfig(ipa);
572 ipa_interrupt_deconfig(ipa->interrupt);
573 ipa->interrupt = NULL;
575 ipa_mem_deconfig(ipa);
576 err_hardware_deconfig:
577 ipa_hardware_deconfig(ipa);
583 * ipa_deconfig() - Inverse of ipa_config()
586 static void ipa_deconfig(struct ipa *ipa)
588 ipa_modem_deconfig(ipa);
589 ipa_endpoint_deconfig(ipa);
590 ipa_uc_deconfig(ipa);
591 ipa_interrupt_deconfig(ipa->interrupt);
592 ipa->interrupt = NULL;
593 ipa_mem_deconfig(ipa);
594 ipa_hardware_deconfig(ipa);
597 static int ipa_firmware_load(struct device *dev)
599 const struct firmware *fw;
600 struct device_node *node;
608 node = of_parse_phandle(dev->of_node, "memory-region", 0);
610 dev_err(dev, "DT error getting \"memory-region\" property\n");
614 ret = of_address_to_resource(node, 0, &res);
617 dev_err(dev, "error %d getting \"memory-region\" resource\n",
622 /* Use name from DTB if specified; use default for *any* error */
623 ret = of_property_read_string(dev->of_node, "firmware-name", &path);
625 dev_dbg(dev, "error %d getting \"firmware-name\" resource\n",
627 path = IPA_FW_PATH_DEFAULT;
630 ret = request_firmware(&fw, path, dev);
632 dev_err(dev, "error %d requesting \"%s\"\n", ret, path);
637 size = (size_t)resource_size(&res);
638 virt = memremap(phys, size, MEMREMAP_WC);
640 dev_err(dev, "unable to remap firmware memory\n");
642 goto out_release_firmware;
645 ret = qcom_mdt_load(dev, fw, path, IPA_PAS_ID, virt, phys, size, NULL);
647 dev_err(dev, "error %d loading \"%s\"\n", ret, path);
648 else if ((ret = qcom_scm_pas_auth_and_reset(IPA_PAS_ID)))
649 dev_err(dev, "error %d authenticating \"%s\"\n", ret, path);
652 out_release_firmware:
653 release_firmware(fw);
658 static const struct of_device_id ipa_match[] = {
660 .compatible = "qcom,msm8998-ipa",
661 .data = &ipa_data_v3_1,
664 .compatible = "qcom,sdm845-ipa",
665 .data = &ipa_data_v3_5_1,
668 .compatible = "qcom,sc7180-ipa",
669 .data = &ipa_data_v4_2,
672 .compatible = "qcom,sdx55-ipa",
673 .data = &ipa_data_v4_5,
676 .compatible = "qcom,sm6350-ipa",
677 .data = &ipa_data_v4_7,
680 .compatible = "qcom,sm8350-ipa",
681 .data = &ipa_data_v4_9,
684 .compatible = "qcom,sc7280-ipa",
685 .data = &ipa_data_v4_11,
689 MODULE_DEVICE_TABLE(of, ipa_match);
691 /* Check things that can be validated at build time. This just
692 * groups these things BUILD_BUG_ON() calls don't clutter the rest
695 static void ipa_validate_build(void)
697 /* At one time we assumed a 64-bit build, allowing some do_div()
698 * calls to be replaced by simple division or modulo operations.
699 * We currently only perform divide and modulo operations on u32,
700 * u16, or size_t objects, and of those only size_t has any chance
701 * of being a 64-bit value. (It should be guaranteed 32 bits wide
702 * on a 32-bit build, but there is no harm in verifying that.)
704 BUILD_BUG_ON(!IS_ENABLED(CONFIG_64BIT) && sizeof(size_t) != 4);
706 /* Code assumes the EE ID for the AP is 0 (zeroed structure field) */
707 BUILD_BUG_ON(GSI_EE_AP != 0);
709 /* There's no point if we have no channels or event rings */
710 BUILD_BUG_ON(!GSI_CHANNEL_COUNT_MAX);
711 BUILD_BUG_ON(!GSI_EVT_RING_COUNT_MAX);
713 /* GSI hardware design limits */
714 BUILD_BUG_ON(GSI_CHANNEL_COUNT_MAX > 32);
715 BUILD_BUG_ON(GSI_EVT_RING_COUNT_MAX > 31);
717 /* The number of TREs in a transaction is limited by the channel's
718 * TLV FIFO size. A transaction structure uses 8-bit fields
719 * to represents the number of TREs it has allocated and used.
721 BUILD_BUG_ON(GSI_TLV_MAX > U8_MAX);
723 /* This is used as a divisor */
724 BUILD_BUG_ON(!IPA_AGGR_GRANULARITY);
726 /* Aggregation granularity value can't be 0, and must fit */
727 BUILD_BUG_ON(!ipa_aggr_granularity_val(IPA_AGGR_GRANULARITY));
730 static enum ipa_firmware_loader ipa_firmware_loader(struct device *dev)
736 /* Look up the old and new properties by name */
737 modem_init = of_property_read_bool(dev->of_node, "modem-init");
738 ret = of_property_read_string(dev->of_node, "qcom,gsi-loader", &str);
740 /* If the new property doesn't exist, it's legacy behavior */
741 if (ret == -EINVAL) {
743 return IPA_LOADER_MODEM;
747 /* Any other error on the new property means it's poorly defined */
749 return IPA_LOADER_INVALID;
751 /* New property value exists; if old one does too, that's invalid */
753 return IPA_LOADER_INVALID;
755 /* Modem loads GSI firmware for "modem" */
756 if (!strcmp(str, "modem"))
757 return IPA_LOADER_MODEM;
759 /* No GSI firmware load is needed for "skip" */
760 if (!strcmp(str, "skip"))
761 return IPA_LOADER_SKIP;
763 /* Any value other than "self" is an error */
764 if (strcmp(str, "self"))
765 return IPA_LOADER_INVALID;
767 /* We need Trust Zone to load firmware; make sure it's available */
768 if (qcom_scm_is_available())
769 return IPA_LOADER_SELF;
771 return IPA_LOADER_DEFER;
775 * ipa_probe() - IPA platform driver probe function
776 * @pdev: Platform device pointer
778 * Return: 0 if successful, or a negative error code (possibly
781 * This is the main entry point for the IPA driver. Initialization proceeds
783 * - The "init" stage involves activities that can be initialized without
784 * access to the IPA hardware.
785 * - The "config" stage requires IPA power to be active so IPA registers
786 * can be accessed, but does not require the use of IPA immediate commands.
787 * - The "setup" stage uses IPA immediate commands, and so requires the GSI
788 * layer to be initialized.
790 * A Boolean Device Tree "modem-init" property determines whether GSI
791 * initialization will be performed by the AP (Trust Zone) or the modem.
792 * If the AP does GSI initialization, the setup phase is entered after
793 * this has completed successfully. Otherwise the modem initializes
794 * the GSI layer and signals it has finished by sending an SMP2P interrupt
795 * to the AP; this triggers the start if IPA setup.
797 static int ipa_probe(struct platform_device *pdev)
799 struct device *dev = &pdev->dev;
800 enum ipa_firmware_loader loader;
801 const struct ipa_data *data;
802 struct ipa_power *power;
806 ipa_validate_build();
808 /* Get configuration data early; needed for power initialization */
809 data = of_device_get_match_data(dev);
811 dev_err(dev, "matched hardware not supported\n");
815 if (!ipa_version_supported(data->version)) {
816 dev_err(dev, "unsupported IPA version %u\n", data->version);
820 if (!data->modem_route_count) {
821 dev_err(dev, "modem_route_count cannot be zero\n");
825 loader = ipa_firmware_loader(dev);
826 if (loader == IPA_LOADER_INVALID)
828 if (loader == IPA_LOADER_DEFER)
829 return -EPROBE_DEFER;
831 /* The clock and interconnects might not be ready when we're
832 * probed, so might return -EPROBE_DEFER.
834 power = ipa_power_init(dev, data->power_data);
836 return PTR_ERR(power);
838 /* No more EPROBE_DEFER. Allocate and initialize the IPA structure */
839 ipa = kzalloc(sizeof(*ipa), GFP_KERNEL);
846 dev_set_drvdata(dev, ipa);
848 ipa->version = data->version;
849 ipa->modem_route_count = data->modem_route_count;
850 init_completion(&ipa->completion);
852 ret = ipa_reg_init(ipa);
856 ret = ipa_mem_init(ipa, data->mem_data);
860 ret = gsi_init(&ipa->gsi, pdev, ipa->version, data->endpoint_count,
861 data->endpoint_data);
865 /* Result is a non-zero mask of endpoints that support filtering */
866 ret = ipa_endpoint_init(ipa, data->endpoint_count, data->endpoint_data);
870 ret = ipa_table_init(ipa);
872 goto err_endpoint_exit;
874 ret = ipa_smp2p_init(ipa, loader == IPA_LOADER_MODEM);
878 /* Power needs to be active for config and setup */
879 ret = pm_runtime_get_sync(dev);
880 if (WARN_ON(ret < 0))
883 ret = ipa_config(ipa, data);
887 dev_info(dev, "IPA driver initialized");
889 /* If the modem is loading GSI firmware, it will trigger a call to
890 * ipa_setup() when it has finished. In that case we're done here.
892 if (loader == IPA_LOADER_MODEM)
895 if (loader == IPA_LOADER_SELF) {
896 /* The AP is loading GSI firmware; do so now */
897 ret = ipa_firmware_load(dev);
900 } /* Otherwise loader == IPA_LOADER_SKIP */
902 /* GSI firmware is loaded; proceed to setup */
903 ret = ipa_setup(ipa);
907 pm_runtime_mark_last_busy(dev);
908 (void)pm_runtime_put_autosuspend(dev);
915 pm_runtime_put_noidle(dev);
920 ipa_endpoint_exit(ipa);
930 ipa_power_exit(power);
935 static int ipa_remove(struct platform_device *pdev)
937 struct ipa *ipa = dev_get_drvdata(&pdev->dev);
938 struct ipa_power *power = ipa->power;
939 struct device *dev = &pdev->dev;
942 /* Prevent the modem from triggering a call to ipa_setup(). This
943 * also ensures a modem-initiated setup that's underway completes.
945 ipa_smp2p_irq_disable_setup(ipa);
947 ret = pm_runtime_get_sync(dev);
948 if (WARN_ON(ret < 0))
951 if (ipa->setup_complete) {
952 ret = ipa_modem_stop(ipa);
953 /* If starting or stopping is in progress, try once more */
955 usleep_range(USEC_PER_MSEC, 2 * USEC_PER_MSEC);
956 ret = ipa_modem_stop(ipa);
966 pm_runtime_put_noidle(dev);
969 ipa_endpoint_exit(ipa);
974 ipa_power_exit(power);
976 dev_info(dev, "IPA driver removed");
981 static void ipa_shutdown(struct platform_device *pdev)
985 ret = ipa_remove(pdev);
987 dev_err(&pdev->dev, "shutdown: remove returned %d\n", ret);
990 static const struct attribute_group *ipa_attribute_groups[] = {
991 &ipa_attribute_group,
992 &ipa_feature_attribute_group,
993 &ipa_endpoint_id_attribute_group,
994 &ipa_modem_attribute_group,
998 static struct platform_driver ipa_driver = {
1000 .remove = ipa_remove,
1001 .shutdown = ipa_shutdown,
1005 .of_match_table = ipa_match,
1006 .dev_groups = ipa_attribute_groups,
1010 module_platform_driver(ipa_driver);
1012 MODULE_LICENSE("GPL v2");
1013 MODULE_DESCRIPTION("Qualcomm IP Accelerator device driver");