net/ipa/ipa.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2018-2022 Linaro Ltd.
31  * struct ipa - IPA information
33  * @version:		IPA hardware version
35  * @completion:		Used to signal pipeline clear transfer complete
39  * @power:		IPA power information
43  * @modem_route_count:	Number of modem entries in a routing table
45  * @interrupt:		IPA Interrupt information
48  * @reg_virt:		Virtual address used for IPA register access
49  * @regs:		IPA register definitions
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
55  * @mem:		Array of IPA-local memory region descriptors
56  * @imem_iova:		I/O virtual address of IPA region in IMEM
58  * @smem_iova:		I/O virtual address of IPA region in SMEM
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
70  * @modem_tx_count:	Number of defined modem TX endoints
72  * @channel_map:	Mapping of GSI channel to IPA endpoint
73  * @name_map:		Mapping of IPA endpoint name to IPA endpoint
75  * @modem_state:	State of modem (stopped, running)
76  * @modem_netdev:	Network device structure used for modem
79 struct ipa {  struct
124 	u64 filtered;			/* Support filtering (AP and modem) */
141  * ipa_setup() - Perform IPA setup
142  * @ipa:		IPA pointer  argument
144  * IPA initialization is broken into stages:  init; config; and setup.
148  * any access to IPA hardware.  Activities performed at the config stage
149  * require IPA power, because they involve access to IPA registers.
151  * (more on this below).  The setup stage allows the AP to perform
153  * a special interface to the IPA.
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.
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
167  * If the modem performs early GSI initialization, the AP needs to know
169  * and receipt of that interrupt triggers the call to ipa_setup().
171 int ipa_setup(struct ipa *ipa);