1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2020 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/remoteproc.h>
19 #include <linux/qcom_scm.h>
20 #include <linux/soc/qcom/mdt_loader.h>
23 #include "ipa_clock.h"
25 #include "ipa_endpoint.h"
29 #include "ipa_table.h"
30 #include "ipa_modem.h"
32 #include "ipa_interrupt.h"
33 #include "gsi_trans.h"
36 * DOC: The IP Accelerator
38 * This driver supports the Qualcomm IP Accelerator (IPA), which is a
39 * networking component found in many Qualcomm SoCs. The IPA is connected
40 * to the application processor (AP), but is also connected (and partially
41 * controlled by) other "execution environments" (EEs), such as a modem.
43 * The IPA is the conduit between the AP and the modem that carries network
44 * traffic. This driver presents a network interface representing the
45 * connection of the modem to external (e.g. LTE) networks.
47 * The IPA provides protocol checksum calculation, offloading this work
48 * from the AP. The IPA offers additional functionality, including routing,
49 * filtering, and NAT support, but that more advanced functionality is not
50 * currently supported. Despite that, some resources--including routing
51 * tables and filter tables--are defined in this driver because they must
52 * be initialized even when the advanced hardware features are not used.
54 * There are two distinct layers that implement the IPA hardware, and this
55 * is reflected in the organization of the driver. The generic software
56 * interface (GSI) is an integral component of the IPA, providing a
57 * well-defined communication layer between the AP subsystem and the IPA
58 * core. The GSI implements a set of "channels" used for communication
59 * between the AP and the IPA.
61 * The IPA layer uses GSI channels to implement its "endpoints". And while
62 * a GSI channel carries data between the AP and the IPA, a pair of IPA
63 * endpoints is used to carry traffic between two EEs. Specifically, the main
64 * modem network interface is implemented by two pairs of endpoints: a TX
65 * endpoint on the AP coupled with an RX endpoint on the modem; and another
66 * RX endpoint on the AP receiving data from a TX endpoint on the modem.
69 /* The name of the GSI firmware file relative to /lib/firmware */
70 #define IPA_FWS_PATH "/*(DEBLOBBED)*/"
74 * ipa_suspend_handler() - Handle the suspend IPA interrupt
76 * @irq_id: IPA interrupt type (unused)
78 * If an RX endpoint is in suspend state, and the IPA has a packet
79 * destined for that endpoint, the IPA generates a SUSPEND interrupt
80 * to inform the AP that it should resume the endpoint. If we get
81 * one of these interrupts we just resume everything.
83 static void ipa_suspend_handler(struct ipa *ipa, enum ipa_irq_id irq_id)
85 /* Just report the event, and let system resume handle the rest.
86 * More than one endpoint could signal this; if so, ignore
89 if (!test_and_set_bit(IPA_FLAG_RESUMED, ipa->flags))
90 pm_wakeup_dev_event(&ipa->pdev->dev, 0, true);
92 /* Acknowledge/clear the suspend interrupt on all endpoints */
93 ipa_interrupt_suspend_clear_all(ipa->interrupt);
97 * ipa_setup() - Set up IPA hardware
100 * Perform initialization that requires issuing immediate commands on
101 * the command TX endpoint. If the modem is doing GSI firmware load
102 * and initialization, this function will be called when an SMP2P
103 * interrupt has been signaled by the modem. Otherwise it will be
104 * called from ipa_probe() after GSI firmware has been successfully
105 * loaded, authenticated, and started by Trust Zone.
107 int ipa_setup(struct ipa *ipa)
109 struct ipa_endpoint *exception_endpoint;
110 struct ipa_endpoint *command_endpoint;
111 struct device *dev = &ipa->pdev->dev;
114 /* Setup for IPA v3.5.1 has some slight differences */
115 ret = gsi_setup(&ipa->gsi, ipa->version == IPA_VERSION_3_5_1);
119 ipa->interrupt = ipa_interrupt_setup(ipa);
120 if (IS_ERR(ipa->interrupt)) {
121 ret = PTR_ERR(ipa->interrupt);
122 goto err_gsi_teardown;
124 ipa_interrupt_add(ipa->interrupt, IPA_IRQ_TX_SUSPEND,
125 ipa_suspend_handler);
129 ret = device_init_wakeup(dev, true);
131 goto err_uc_teardown;
133 ipa_endpoint_setup(ipa);
135 /* We need to use the AP command TX endpoint to perform other
136 * initialization, so we enable first.
138 command_endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
139 ret = ipa_endpoint_enable_one(command_endpoint);
141 goto err_endpoint_teardown;
143 ret = ipa_mem_setup(ipa);
145 goto err_command_disable;
147 ret = ipa_table_setup(ipa);
149 goto err_mem_teardown;
151 /* Enable the exception handling endpoint, and tell the hardware
152 * to use it by default.
154 exception_endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
155 ret = ipa_endpoint_enable_one(exception_endpoint);
157 goto err_table_teardown;
159 ipa_endpoint_default_route_set(ipa, exception_endpoint->endpoint_id);
161 /* We're all set. Now prepare for communication with the modem */
162 ret = ipa_modem_setup(ipa);
164 goto err_default_route_clear;
166 ipa->setup_complete = true;
168 dev_info(dev, "IPA driver setup completed successfully\n");
172 err_default_route_clear:
173 ipa_endpoint_default_route_clear(ipa);
174 ipa_endpoint_disable_one(exception_endpoint);
176 ipa_table_teardown(ipa);
178 ipa_mem_teardown(ipa);
180 ipa_endpoint_disable_one(command_endpoint);
181 err_endpoint_teardown:
182 ipa_endpoint_teardown(ipa);
183 (void)device_init_wakeup(dev, false);
185 ipa_uc_teardown(ipa);
186 ipa_interrupt_remove(ipa->interrupt, IPA_IRQ_TX_SUSPEND);
187 ipa_interrupt_teardown(ipa->interrupt);
189 gsi_teardown(&ipa->gsi);
195 * ipa_teardown() - Inverse of ipa_setup()
198 static void ipa_teardown(struct ipa *ipa)
200 struct ipa_endpoint *exception_endpoint;
201 struct ipa_endpoint *command_endpoint;
203 ipa_modem_teardown(ipa);
204 ipa_endpoint_default_route_clear(ipa);
205 exception_endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
206 ipa_endpoint_disable_one(exception_endpoint);
207 ipa_table_teardown(ipa);
208 ipa_mem_teardown(ipa);
209 command_endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
210 ipa_endpoint_disable_one(command_endpoint);
211 ipa_endpoint_teardown(ipa);
212 (void)device_init_wakeup(&ipa->pdev->dev, false);
213 ipa_uc_teardown(ipa);
214 ipa_interrupt_remove(ipa->interrupt, IPA_IRQ_TX_SUSPEND);
215 ipa_interrupt_teardown(ipa->interrupt);
216 gsi_teardown(&ipa->gsi);
219 /* Configure QMB Core Master Port selection */
220 static void ipa_hardware_config_comp(struct ipa *ipa)
224 /* Nothing to configure for IPA v3.5.1 */
225 if (ipa->version == IPA_VERSION_3_5_1)
228 val = ioread32(ipa->reg_virt + IPA_REG_COMP_CFG_OFFSET);
230 if (ipa->version == IPA_VERSION_4_0) {
231 val &= ~IPA_QMB_SELECT_CONS_EN_FMASK;
232 val &= ~IPA_QMB_SELECT_PROD_EN_FMASK;
233 val &= ~IPA_QMB_SELECT_GLOBAL_EN_FMASK;
235 val |= GSI_MULTI_AXI_MASTERS_DIS_FMASK;
238 val |= GSI_MULTI_INORDER_RD_DIS_FMASK;
239 val |= GSI_MULTI_INORDER_WR_DIS_FMASK;
241 iowrite32(val, ipa->reg_virt + IPA_REG_COMP_CFG_OFFSET);
244 /* Configure DDR and PCIe max read/write QSB values */
245 static void ipa_hardware_config_qsb(struct ipa *ipa)
249 /* QMB_0 represents DDR; QMB_1 represents PCIe (not present in 4.2) */
250 val = u32_encode_bits(8, GEN_QMB_0_MAX_WRITES_FMASK);
251 if (ipa->version == IPA_VERSION_4_2)
252 val |= u32_encode_bits(0, GEN_QMB_1_MAX_WRITES_FMASK);
254 val |= u32_encode_bits(4, GEN_QMB_1_MAX_WRITES_FMASK);
255 iowrite32(val, ipa->reg_virt + IPA_REG_QSB_MAX_WRITES_OFFSET);
257 if (ipa->version == IPA_VERSION_3_5_1) {
258 val = u32_encode_bits(8, GEN_QMB_0_MAX_READS_FMASK);
259 val |= u32_encode_bits(12, GEN_QMB_1_MAX_READS_FMASK);
261 val = u32_encode_bits(12, GEN_QMB_0_MAX_READS_FMASK);
262 if (ipa->version == IPA_VERSION_4_2)
263 val |= u32_encode_bits(0, GEN_QMB_1_MAX_READS_FMASK);
265 val |= u32_encode_bits(12, GEN_QMB_1_MAX_READS_FMASK);
266 /* GEN_QMB_0_MAX_READS_BEATS is 0 */
267 /* GEN_QMB_1_MAX_READS_BEATS is 0 */
269 iowrite32(val, ipa->reg_virt + IPA_REG_QSB_MAX_READS_OFFSET);
272 static void ipa_idle_indication_cfg(struct ipa *ipa,
273 u32 enter_idle_debounce_thresh,
274 bool const_non_idle_enable)
279 val = u32_encode_bits(enter_idle_debounce_thresh,
280 ENTER_IDLE_DEBOUNCE_THRESH_FMASK);
281 if (const_non_idle_enable)
282 val |= CONST_NON_IDLE_ENABLE_FMASK;
284 offset = ipa_reg_idle_indication_cfg_offset(ipa->version);
285 iowrite32(val, ipa->reg_virt + offset);
289 * ipa_hardware_dcd_config() - Enable dynamic clock division on IPA
292 * Configures when the IPA signals it is idle to the global clock
293 * controller, which can respond by scalling down the clock to
296 static void ipa_hardware_dcd_config(struct ipa *ipa)
298 /* Recommended values for IPA 3.5 according to IPA HPG */
299 ipa_idle_indication_cfg(ipa, 256, false);
302 static void ipa_hardware_dcd_deconfig(struct ipa *ipa)
304 /* Power-on reset values */
305 ipa_idle_indication_cfg(ipa, 0, true);
309 * ipa_hardware_config() - Primitive hardware initialization
312 static void ipa_hardware_config(struct ipa *ipa)
317 /* Fill in backward-compatibility register, based on version */
318 val = ipa_reg_bcr_val(ipa->version);
319 iowrite32(val, ipa->reg_virt + IPA_REG_BCR_OFFSET);
321 if (ipa->version != IPA_VERSION_3_5_1) {
322 /* Enable open global clocks (hardware workaround) */
324 val |= GLOBAL_2X_CLK_FMASK;
325 iowrite32(val, ipa->reg_virt + IPA_REG_CLKON_CFG_OFFSET);
327 /* Disable PA mask to allow HOLB drop (hardware workaround) */
328 val = ioread32(ipa->reg_virt + IPA_REG_TX_CFG_OFFSET);
330 iowrite32(val, ipa->reg_virt + IPA_REG_TX_CFG_OFFSET);
333 ipa_hardware_config_comp(ipa);
335 /* Configure system bus limits */
336 ipa_hardware_config_qsb(ipa);
338 /* Configure aggregation granularity */
339 val = ioread32(ipa->reg_virt + IPA_REG_COUNTER_CFG_OFFSET);
340 granularity = ipa_aggr_granularity_val(IPA_AGGR_GRANULARITY);
341 val = u32_encode_bits(granularity, AGGR_GRANULARITY);
342 iowrite32(val, ipa->reg_virt + IPA_REG_COUNTER_CFG_OFFSET);
344 /* Disable hashed IPv4 and IPv6 routing and filtering for IPA v4.2 */
345 if (ipa->version == IPA_VERSION_4_2)
346 iowrite32(0, ipa->reg_virt + IPA_REG_FILT_ROUT_HASH_EN_OFFSET);
348 /* Enable dynamic clock division */
349 ipa_hardware_dcd_config(ipa);
353 * ipa_hardware_deconfig() - Inverse of ipa_hardware_config()
356 * This restores the power-on reset values (even if they aren't different)
358 static void ipa_hardware_deconfig(struct ipa *ipa)
360 /* Mostly we just leave things as we set them. */
361 ipa_hardware_dcd_deconfig(ipa);
364 #ifdef IPA_VALIDATION
366 /* # IPA resources used based on version (see IPA_RESOURCE_GROUP_COUNT) */
367 static int ipa_resource_group_count(struct ipa *ipa)
369 switch (ipa->version) {
370 case IPA_VERSION_3_5_1:
373 case IPA_VERSION_4_0:
374 case IPA_VERSION_4_1:
377 case IPA_VERSION_4_2:
385 static bool ipa_resource_limits_valid(struct ipa *ipa,
386 const struct ipa_resource_data *data)
388 u32 group_count = ipa_resource_group_count(ipa);
395 /* Return an error if a non-zero resource group limit is specified
396 * for a resource not supported by hardware.
398 for (i = 0; i < data->resource_src_count; i++) {
399 const struct ipa_resource_src *resource;
401 resource = &data->resource_src[i];
402 for (j = group_count; j < IPA_RESOURCE_GROUP_COUNT; j++)
403 if (resource->limits[j].min || resource->limits[j].max)
407 for (i = 0; i < data->resource_dst_count; i++) {
408 const struct ipa_resource_dst *resource;
410 resource = &data->resource_dst[i];
411 for (j = group_count; j < IPA_RESOURCE_GROUP_COUNT; j++)
412 if (resource->limits[j].min || resource->limits[j].max)
419 #else /* !IPA_VALIDATION */
421 static bool ipa_resource_limits_valid(struct ipa *ipa,
422 const struct ipa_resource_data *data)
427 #endif /* !IPA_VALIDATION */
430 ipa_resource_config_common(struct ipa *ipa, u32 offset,
431 const struct ipa_resource_limits *xlimits,
432 const struct ipa_resource_limits *ylimits)
436 val = u32_encode_bits(xlimits->min, X_MIN_LIM_FMASK);
437 val |= u32_encode_bits(xlimits->max, X_MAX_LIM_FMASK);
438 val |= u32_encode_bits(ylimits->min, Y_MIN_LIM_FMASK);
439 val |= u32_encode_bits(ylimits->max, Y_MAX_LIM_FMASK);
441 iowrite32(val, ipa->reg_virt + offset);
444 static void ipa_resource_config_src_01(struct ipa *ipa,
445 const struct ipa_resource_src *resource)
447 u32 offset = IPA_REG_SRC_RSRC_GRP_01_RSRC_TYPE_N_OFFSET(resource->type);
449 ipa_resource_config_common(ipa, offset,
450 &resource->limits[0], &resource->limits[1]);
453 static void ipa_resource_config_src_23(struct ipa *ipa,
454 const struct ipa_resource_src *resource)
456 u32 offset = IPA_REG_SRC_RSRC_GRP_23_RSRC_TYPE_N_OFFSET(resource->type);
458 ipa_resource_config_common(ipa, offset,
459 &resource->limits[2], &resource->limits[3]);
462 static void ipa_resource_config_dst_01(struct ipa *ipa,
463 const struct ipa_resource_dst *resource)
465 u32 offset = IPA_REG_DST_RSRC_GRP_01_RSRC_TYPE_N_OFFSET(resource->type);
467 ipa_resource_config_common(ipa, offset,
468 &resource->limits[0], &resource->limits[1]);
471 static void ipa_resource_config_dst_23(struct ipa *ipa,
472 const struct ipa_resource_dst *resource)
474 u32 offset = IPA_REG_DST_RSRC_GRP_23_RSRC_TYPE_N_OFFSET(resource->type);
476 ipa_resource_config_common(ipa, offset,
477 &resource->limits[2], &resource->limits[3]);
481 ipa_resource_config(struct ipa *ipa, const struct ipa_resource_data *data)
485 if (!ipa_resource_limits_valid(ipa, data))
488 for (i = 0; i < data->resource_src_count; i++) {
489 ipa_resource_config_src_01(ipa, &data->resource_src[i]);
490 ipa_resource_config_src_23(ipa, &data->resource_src[i]);
493 for (i = 0; i < data->resource_dst_count; i++) {
494 ipa_resource_config_dst_01(ipa, &data->resource_dst[i]);
495 ipa_resource_config_dst_23(ipa, &data->resource_dst[i]);
501 static void ipa_resource_deconfig(struct ipa *ipa)
507 * ipa_config() - Configure IPA hardware
509 * @data: IPA configuration data
511 * Perform initialization requiring IPA clock to be enabled.
513 static int ipa_config(struct ipa *ipa, const struct ipa_data *data)
517 /* Get a clock reference to allow initialization. This reference
518 * is held after initialization completes, and won't get dropped
519 * unless/until a system suspend request arrives.
523 ipa_hardware_config(ipa);
525 ret = ipa_endpoint_config(ipa);
527 goto err_hardware_deconfig;
529 ret = ipa_mem_config(ipa);
531 goto err_endpoint_deconfig;
533 ipa_table_config(ipa);
535 /* Assign resource limitation to each group */
536 ret = ipa_resource_config(ipa, data->resource_data);
538 goto err_table_deconfig;
540 ret = ipa_modem_config(ipa);
542 goto err_resource_deconfig;
546 err_resource_deconfig:
547 ipa_resource_deconfig(ipa);
549 ipa_table_deconfig(ipa);
550 ipa_mem_deconfig(ipa);
551 err_endpoint_deconfig:
552 ipa_endpoint_deconfig(ipa);
553 err_hardware_deconfig:
554 ipa_hardware_deconfig(ipa);
561 * ipa_deconfig() - Inverse of ipa_config()
564 static void ipa_deconfig(struct ipa *ipa)
566 ipa_modem_deconfig(ipa);
567 ipa_resource_deconfig(ipa);
568 ipa_table_deconfig(ipa);
569 ipa_mem_deconfig(ipa);
570 ipa_endpoint_deconfig(ipa);
571 ipa_hardware_deconfig(ipa);
575 static int ipa_firmware_load(struct device *dev)
577 const struct firmware *fw;
578 struct device_node *node;
585 node = of_parse_phandle(dev->of_node, "memory-region", 0);
587 dev_err(dev, "DT error getting \"memory-region\" property\n");
591 ret = of_address_to_resource(node, 0, &res);
594 dev_err(dev, "error %d getting \"memory-region\" resource\n",
599 ret = reject_firmware(&fw, IPA_FWS_PATH, dev);
601 dev_err(dev, "error %d requesting \"%s\"\n", ret, IPA_FWS_PATH);
606 size = (size_t)resource_size(&res);
607 virt = memremap(phys, size, MEMREMAP_WC);
609 dev_err(dev, "unable to remap firmware memory\n");
611 goto out_release_firmware;
614 ret = qcom_mdt_load(dev, fw, IPA_FWS_PATH, IPA_PAS_ID,
615 virt, phys, size, NULL);
617 dev_err(dev, "error %d loading \"%s\"\n", ret, IPA_FWS_PATH);
618 else if ((ret = qcom_scm_pas_auth_and_reset(IPA_PAS_ID)))
619 dev_err(dev, "error %d authenticating \"%s\"\n", ret,
623 out_release_firmware:
624 release_firmware(fw);
629 static const struct of_device_id ipa_match[] = {
631 .compatible = "qcom,sdm845-ipa",
632 .data = &ipa_data_sdm845,
635 .compatible = "qcom,sc7180-ipa",
636 .data = &ipa_data_sc7180,
640 MODULE_DEVICE_TABLE(of, ipa_match);
642 static phandle of_property_read_phandle(const struct device_node *np,
645 struct property *prop;
648 prop = of_find_property(np, name, &len);
649 if (!prop || len != sizeof(__be32))
652 return be32_to_cpup(prop->value);
655 /* Check things that can be validated at build time. This just
656 * groups these things BUILD_BUG_ON() calls don't clutter the rest
659 static void ipa_validate_build(void)
662 /* We assume we're working on 64-bit hardware */
663 BUILD_BUG_ON(!IS_ENABLED(CONFIG_64BIT));
665 /* Code assumes the EE ID for the AP is 0 (zeroed structure field) */
666 BUILD_BUG_ON(GSI_EE_AP != 0);
668 /* There's no point if we have no channels or event rings */
669 BUILD_BUG_ON(!GSI_CHANNEL_COUNT_MAX);
670 BUILD_BUG_ON(!GSI_EVT_RING_COUNT_MAX);
672 /* GSI hardware design limits */
673 BUILD_BUG_ON(GSI_CHANNEL_COUNT_MAX > 32);
674 BUILD_BUG_ON(GSI_EVT_RING_COUNT_MAX > 31);
676 /* The number of TREs in a transaction is limited by the channel's
677 * TLV FIFO size. A transaction structure uses 8-bit fields
678 * to represents the number of TREs it has allocated and used.
680 BUILD_BUG_ON(GSI_TLV_MAX > U8_MAX);
682 /* Exceeding 128 bytes makes the transaction pool *much* larger */
683 BUILD_BUG_ON(sizeof(struct gsi_trans) > 128);
685 /* This is used as a divisor */
686 BUILD_BUG_ON(!IPA_AGGR_GRANULARITY);
688 /* Aggregation granularity value can't be 0, and must fit */
689 BUILD_BUG_ON(!ipa_aggr_granularity_val(IPA_AGGR_GRANULARITY));
690 BUILD_BUG_ON(ipa_aggr_granularity_val(IPA_AGGR_GRANULARITY) >
691 field_max(AGGR_GRANULARITY));
692 #endif /* IPA_VALIDATE */
696 * ipa_probe() - IPA platform driver probe function
697 * @pdev: Platform device pointer
699 * Return: 0 if successful, or a negative error code (possibly
702 * This is the main entry point for the IPA driver. Initialization proceeds
704 * - The "init" stage involves activities that can be initialized without
705 * access to the IPA hardware.
706 * - The "config" stage requires the IPA clock to be active so IPA registers
707 * can be accessed, but does not require the use of IPA immediate commands.
708 * - The "setup" stage uses IPA immediate commands, and so requires the GSI
709 * layer to be initialized.
711 * A Boolean Device Tree "modem-init" property determines whether GSI
712 * initialization will be performed by the AP (Trust Zone) or the modem.
713 * If the AP does GSI initialization, the setup phase is entered after
714 * this has completed successfully. Otherwise the modem initializes
715 * the GSI layer and signals it has finished by sending an SMP2P interrupt
716 * to the AP; this triggers the start if IPA setup.
718 static int ipa_probe(struct platform_device *pdev)
720 struct device *dev = &pdev->dev;
721 const struct ipa_data *data;
722 struct ipa_clock *clock;
731 ipa_validate_build();
733 /* If we need Trust Zone, make sure it's available */
734 modem_init = of_property_read_bool(dev->of_node, "modem-init");
736 if (!qcom_scm_is_available())
737 return -EPROBE_DEFER;
739 /* We rely on remoteproc to tell us about modem state changes */
740 ph = of_property_read_phandle(dev->of_node, "modem-remoteproc");
742 dev_err(dev, "DT missing \"modem-remoteproc\" property\n");
746 rproc = rproc_get_by_phandle(ph);
748 return -EPROBE_DEFER;
750 /* The clock and interconnects might not be ready when we're
751 * probed, so might return -EPROBE_DEFER.
753 clock = ipa_clock_init(dev);
755 ret = PTR_ERR(clock);
759 /* No more EPROBE_DEFER. Get our configuration data */
760 data = of_device_get_match_data(dev);
762 /* This is really IPA_VALIDATE (should never happen) */
763 dev_err(dev, "matched hardware not supported\n");
768 /* Allocate and initialize the IPA structure */
769 ipa = kzalloc(sizeof(*ipa), GFP_KERNEL);
776 dev_set_drvdata(dev, ipa);
777 ipa->modem_rproc = rproc;
779 ipa->version = data->version;
781 ret = ipa_reg_init(ipa);
785 ret = ipa_mem_init(ipa, data->mem_data);
789 /* GSI v2.0+ (IPA v4.0+) uses prefetch for the command channel */
790 prefetch = ipa->version != IPA_VERSION_3_5_1;
791 /* IPA v4.2 requires the AP to allocate channels for the modem */
792 modem_alloc = ipa->version == IPA_VERSION_4_2;
794 ret = gsi_init(&ipa->gsi, pdev, prefetch, data->endpoint_count,
795 data->endpoint_data, modem_alloc);
799 /* Result is a non-zero mask endpoints that support filtering */
800 ipa->filter_map = ipa_endpoint_init(ipa, data->endpoint_count,
801 data->endpoint_data);
802 if (!ipa->filter_map) {
807 ret = ipa_table_init(ipa);
809 goto err_endpoint_exit;
811 ret = ipa_modem_init(ipa, modem_init);
815 ret = ipa_config(ipa, data);
819 dev_info(dev, "IPA driver initialized");
821 /* If the modem is doing early initialization, it will trigger a
822 * call to ipa_setup() call when it has finished. In that case
828 /* Otherwise we need to load the firmware and have Trust Zone validate
829 * and install it. If that succeeds we can proceed with setup.
831 ret = ipa_firmware_load(dev);
835 ret = ipa_setup(ipa);
848 ipa_endpoint_exit(ipa);
858 ipa_clock_exit(clock);
865 static int ipa_remove(struct platform_device *pdev)
867 struct ipa *ipa = dev_get_drvdata(&pdev->dev);
868 struct rproc *rproc = ipa->modem_rproc;
869 struct ipa_clock *clock = ipa->clock;
872 if (ipa->setup_complete) {
873 ret = ipa_modem_stop(ipa);
883 ipa_endpoint_exit(ipa);
888 ipa_clock_exit(clock);
895 * ipa_suspend() - Power management system suspend callback
896 * @dev: IPA device structure
898 * Return: Always returns zero
900 * Called by the PM framework when a system suspend operation is invoked.
901 * Suspends endpoints and releases the clock reference held to keep
902 * the IPA clock running until this point.
904 static int ipa_suspend(struct device *dev)
906 struct ipa *ipa = dev_get_drvdata(dev);
908 /* When a suspended RX endpoint has a packet ready to receive, we
909 * get an IPA SUSPEND interrupt. We trigger a system resume in
910 * that case, but only on the first such interrupt since suspend.
912 __clear_bit(IPA_FLAG_RESUMED, ipa->flags);
914 ipa_endpoint_suspend(ipa);
922 * ipa_resume() - Power management system resume callback
923 * @dev: IPA device structure
925 * Return: Always returns 0
927 * Called by the PM framework when a system resume operation is invoked.
928 * Takes an IPA clock reference to keep the clock running until suspend,
929 * and resumes endpoints.
931 static int ipa_resume(struct device *dev)
933 struct ipa *ipa = dev_get_drvdata(dev);
935 /* This clock reference will keep the IPA out of suspend
936 * until we get a power management suspend request.
940 ipa_endpoint_resume(ipa);
945 static const struct dev_pm_ops ipa_pm_ops = {
946 .suspend = ipa_suspend,
947 .resume = ipa_resume,
950 static struct platform_driver ipa_driver = {
952 .remove = ipa_remove,
956 .of_match_table = ipa_match,
960 module_platform_driver(ipa_driver);
962 MODULE_LICENSE("GPL v2");
963 MODULE_DESCRIPTION("Qualcomm IP Accelerator device driver");