Commit | Line | Data |
---|---|---|
cdf2e941 AE |
1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | ||
3 | /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved. | |
a4388da5 | 4 | * Copyright (C) 2018-2022 Linaro Ltd. |
cdf2e941 AE |
5 | */ |
6 | #ifndef _IPA_H_ | |
7 | #define _IPA_H_ | |
8 | ||
9 | #include <linux/types.h> | |
10 | #include <linux/device.h> | |
11 | #include <linux/notifier.h> | |
12 | #include <linux/pm_wakeup.h> | |
13 | ||
14 | #include "ipa_version.h" | |
15 | #include "gsi.h" | |
16 | #include "ipa_mem.h" | |
17 | #include "ipa_qmi.h" | |
18 | #include "ipa_endpoint.h" | |
19 | #include "ipa_interrupt.h" | |
20 | ||
21 | struct clk; | |
22 | struct icc_path; | |
23 | struct net_device; | |
24 | struct platform_device; | |
25 | ||
7aa0e8b8 | 26 | struct ipa_power; |
cdf2e941 AE |
27 | struct ipa_smp2p; |
28 | struct ipa_interrupt; | |
29 | ||
30 | /** | |
31 | * struct ipa - IPA information | |
32 | * @gsi: Embedded GSI structure | |
33 | * @version: IPA hardware version | |
34 | * @pdev: Platform device | |
51c48ce2 | 35 | * @completion: Used to signal pipeline clear transfer complete |
862d3f2c AE |
36 | * @nb: Notifier block used for remoteproc SSR |
37 | * @notifier: Remoteproc SSR notifier | |
cdf2e941 | 38 | * @smp2p: SMP2P information |
7aa0e8b8 | 39 | * @power: IPA power information |
cdf2e941 AE |
40 | * @table_addr: DMA address of filter/route table content |
41 | * @table_virt: Virtual address of filter/route table content | |
fc094058 | 42 | * @route_count: Total number of entries in a routing table |
8defab8b | 43 | * @modem_route_count: Number of modem entries in a routing table |
f787d848 | 44 | * @filter_count: Maximum number of entries in a filter table |
cdf2e941 | 45 | * @interrupt: IPA Interrupt information |
7aa0e8b8 | 46 | * @uc_powered: true if power is active by proxy for microcontroller |
cdf2e941 | 47 | * @uc_loaded: true after microcontroller has reported it's ready |
cdf2e941 | 48 | * @reg_virt: Virtual address used for IPA register access |
07f120bc | 49 | * @regs: IPA register definitions |
cdf2e941 AE |
50 | * @mem_addr: DMA address of IPA-local memory space |
51 | * @mem_virt: Virtual address of IPA-local memory space | |
52 | * @mem_offset: Offset from @mem_virt used for access to IPA memory | |
53 | * @mem_size: Total size (bytes) of memory at @mem_virt | |
440c3247 | 54 | * @mem_count: Number of entries in the mem array |
cdf2e941 | 55 | * @mem: Array of IPA-local memory region descriptors |
3e313c3f | 56 | * @imem_iova: I/O virtual address of IPA region in IMEM |
862d3f2c | 57 | * @imem_size: Size of IMEM region |
a0036bb4 | 58 | * @smem_iova: I/O virtual address of IPA region in SMEM |
862d3f2c | 59 | * @smem_size: Size of SMEM region |
cdf2e941 AE |
60 | * @zero_addr: DMA address of preallocated zero-filled memory |
61 | * @zero_virt: Virtual address of preallocated zero-filled memory | |
62 | * @zero_size: Size (bytes) of preallocated zero-filled memory | |
88de7672 AE |
63 | * @endpoint_count: Number of defined bits in most bitmaps below |
64 | * @available_count: Number of defined bits in the available bitmap | |
9a9f5129 | 65 | * @defined: Bitmap of endpoints defined in config data |
88de7672 | 66 | * @available: Bitmap of endpoints supported by hardware |
0f97fbd4 | 67 | * @filtered: Bitmap of endpoints that support filtering |
ae5108e9 | 68 | * @set_up: Bitmap of endpoints that are set up for use |
9b7a0065 | 69 | * @enabled: Bitmap of currently enabled endpoints |
2091c79a | 70 | * @modem_tx_count: Number of defined modem TX endoints |
cdf2e941 AE |
71 | * @endpoint: Array of endpoint information |
72 | * @channel_map: Mapping of GSI channel to IPA endpoint | |
73 | * @name_map: Mapping of IPA endpoint name to IPA endpoint | |
74 | * @setup_complete: Flag indicating whether setup stage has completed | |
75 | * @modem_state: State of modem (stopped, running) | |
76 | * @modem_netdev: Network device structure used for modem | |
77 | * @qmi: QMI information | |
78 | */ | |
79 | struct ipa { | |
80 | struct gsi gsi; | |
81 | enum ipa_version version; | |
82 | struct platform_device *pdev; | |
51c48ce2 | 83 | struct completion completion; |
30eb3fbe AE |
84 | struct notifier_block nb; |
85 | void *notifier; | |
cdf2e941 | 86 | struct ipa_smp2p *smp2p; |
7aa0e8b8 | 87 | struct ipa_power *power; |
cdf2e941 AE |
88 | |
89 | dma_addr_t table_addr; | |
90 | __le64 *table_virt; | |
fc094058 | 91 | u32 route_count; |
8defab8b | 92 | u32 modem_route_count; |
f787d848 | 93 | u32 filter_count; |
cdf2e941 AE |
94 | |
95 | struct ipa_interrupt *interrupt; | |
7aa0e8b8 | 96 | bool uc_powered; |
cdf2e941 AE |
97 | bool uc_loaded; |
98 | ||
cdf2e941 | 99 | void __iomem *reg_virt; |
81772e44 | 100 | const struct regs *regs; |
cdf2e941 AE |
101 | |
102 | dma_addr_t mem_addr; | |
103 | void *mem_virt; | |
104 | u32 mem_offset; | |
105 | u32 mem_size; | |
440c3247 | 106 | u32 mem_count; |
cdf2e941 AE |
107 | const struct ipa_mem *mem; |
108 | ||
3e313c3f AE |
109 | unsigned long imem_iova; |
110 | size_t imem_size; | |
a0036bb4 AE |
111 | |
112 | unsigned long smem_iova; | |
113 | size_t smem_size; | |
3e313c3f | 114 | |
cdf2e941 AE |
115 | dma_addr_t zero_addr; |
116 | void *zero_virt; | |
117 | size_t zero_size; | |
118 | ||
9a9f5129 | 119 | /* Bitmaps indicating endpoint state */ |
b7aaff0b | 120 | u32 endpoint_count; |
88de7672 | 121 | u32 available_count; |
9a9f5129 | 122 | unsigned long *defined; /* Defined in configuration data */ |
88de7672 | 123 | unsigned long *available; /* Supported by hardware */ |
0f97fbd4 | 124 | u64 filtered; /* Support filtering (AP and modem) */ |
ae5108e9 | 125 | unsigned long *set_up; |
9b7a0065 | 126 | unsigned long *enabled; |
cdf2e941 | 127 | |
2091c79a | 128 | u32 modem_tx_count; |
cdf2e941 AE |
129 | struct ipa_endpoint endpoint[IPA_ENDPOINT_MAX]; |
130 | struct ipa_endpoint *channel_map[GSI_CHANNEL_COUNT_MAX]; | |
131 | struct ipa_endpoint *name_map[IPA_ENDPOINT_COUNT]; | |
132 | ||
133 | bool setup_complete; | |
134 | ||
135 | atomic_t modem_state; /* enum ipa_modem_state */ | |
136 | struct net_device *modem_netdev; | |
137 | struct ipa_qmi qmi; | |
138 | }; | |
139 | ||
140 | /** | |
141 | * ipa_setup() - Perform IPA setup | |
142 | * @ipa: IPA pointer | |
143 | * | |
144 | * IPA initialization is broken into stages: init; config; and setup. | |
145 | * (These have inverses exit, deconfig, and teardown.) | |
146 | * | |
147 | * Activities performed at the init stage can be done without requiring | |
148 | * any access to IPA hardware. Activities performed at the config stage | |
7aa0e8b8 AE |
149 | * require IPA power, because they involve access to IPA registers. |
150 | * The setup stage is performed only after the GSI hardware is ready | |
151 | * (more on this below). The setup stage allows the AP to perform | |
152 | * more complex initialization by issuing "immediate commands" using | |
153 | * a special interface to the IPA. | |
cdf2e941 AE |
154 | * |
155 | * This function, @ipa_setup(), starts the setup stage. | |
156 | * | |
157 | * In order for the GSI hardware to be functional it needs firmware to be | |
158 | * loaded (in addition to some other low-level initialization). This early | |
159 | * GSI initialization can be done either by Trust Zone on the AP or by the | |
160 | * modem. | |
161 | * | |
162 | * If it's done by Trust Zone, the AP loads the GSI firmware and supplies | |
163 | * it to Trust Zone to verify and install. When this completes, if | |
164 | * verification was successful, the GSI layer is ready and ipa_setup() | |
165 | * implements the setup phase of initialization. | |
166 | * | |
167 | * If the modem performs early GSI initialization, the AP needs to know | |
168 | * when this has occurred. An SMP2P interrupt is used for this purpose, | |
169 | * and receipt of that interrupt triggers the call to ipa_setup(). | |
170 | */ | |
171 | int ipa_setup(struct ipa *ipa); | |
172 | ||
173 | #endif /* _IPA_H_ */ |