tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2
3/* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2020 Linaro Ltd.
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
21struct clk;
22struct icc_path;
23struct net_device;
24struct platform_device;
25
26struct ipa_clock;
27struct ipa_smp2p;
28struct ipa_interrupt;
29
30/**
31 * struct ipa - IPA information
32 * @gsi: Embedded GSI structure
33 * @version: IPA hardware version
34 * @pdev: Platform device
35 * @modem_rproc: Remoteproc handle for modem subsystem
36 * @smp2p: SMP2P information
37 * @clock: IPA clocking information
38 * @suspend_ref: Whether clock reference preventing suspend taken
39 * @table_addr: DMA address of filter/route table content
40 * @table_virt: Virtual address of filter/route table content
41 * @interrupt: IPA Interrupt information
42 * @uc_loaded: true after microcontroller has reported it's ready
43 * @reg_addr: DMA address used for IPA register access
44 * @reg_virt: Virtual address used for IPA register access
45 * @mem_addr: DMA address of IPA-local memory space
46 * @mem_virt: Virtual address of IPA-local memory space
47 * @mem_offset: Offset from @mem_virt used for access to IPA memory
48 * @mem_size: Total size (bytes) of memory at @mem_virt
49 * @mem: Array of IPA-local memory region descriptors
50 * @zero_addr: DMA address of preallocated zero-filled memory
51 * @zero_virt: Virtual address of preallocated zero-filled memory
52 * @zero_size: Size (bytes) of preallocated zero-filled memory
53 * @wakeup_source: Wakeup source information
54 * @available: Bit mask indicating endpoints hardware supports
55 * @filter_map: Bit mask indicating endpoints that support filtering
56 * @initialized: Bit mask indicating endpoints initialized
57 * @set_up: Bit mask indicating endpoints set up
58 * @enabled: Bit mask indicating endpoints enabled
59 * @endpoint: Array of endpoint information
60 * @channel_map: Mapping of GSI channel to IPA endpoint
61 * @name_map: Mapping of IPA endpoint name to IPA endpoint
62 * @setup_complete: Flag indicating whether setup stage has completed
63 * @modem_state: State of modem (stopped, running)
64 * @modem_netdev: Network device structure used for modem
65 * @qmi: QMI information
66 */
67struct ipa {
68 struct gsi gsi;
69 enum ipa_version version;
70 struct platform_device *pdev;
71 struct rproc *modem_rproc;
72 struct ipa_smp2p *smp2p;
73 struct ipa_clock *clock;
74 atomic_t suspend_ref;
75
76 dma_addr_t table_addr;
77 __le64 *table_virt;
78
79 struct ipa_interrupt *interrupt;
80 bool uc_loaded;
81
82 dma_addr_t reg_addr;
83 void __iomem *reg_virt;
84
85 dma_addr_t mem_addr;
86 void *mem_virt;
87 u32 mem_offset;
88 u32 mem_size;
89 const struct ipa_mem *mem;
90
91 dma_addr_t zero_addr;
92 void *zero_virt;
93 size_t zero_size;
94
95 struct wakeup_source *wakeup_source;
96
97 /* Bit masks indicating endpoint state */
98 u32 available; /* supported by hardware */
99 u32 filter_map;
100 u32 initialized;
101 u32 set_up;
102 u32 enabled;
103
104 struct ipa_endpoint endpoint[IPA_ENDPOINT_MAX];
105 struct ipa_endpoint *channel_map[GSI_CHANNEL_COUNT_MAX];
106 struct ipa_endpoint *name_map[IPA_ENDPOINT_COUNT];
107
108 bool setup_complete;
109
110 atomic_t modem_state; /* enum ipa_modem_state */
111 struct net_device *modem_netdev;
112 struct ipa_qmi qmi;
113};
114
115/**
116 * ipa_setup() - Perform IPA setup
117 * @ipa: IPA pointer
118 *
119 * IPA initialization is broken into stages: init; config; and setup.
120 * (These have inverses exit, deconfig, and teardown.)
121 *
122 * Activities performed at the init stage can be done without requiring
123 * any access to IPA hardware. Activities performed at the config stage
124 * require the IPA clock to be running, because they involve access
125 * to IPA registers. The setup stage is performed only after the GSI
126 * hardware is ready (more on this below). The setup stage allows
127 * the AP to perform more complex initialization by issuing "immediate
128 * commands" using a special interface to the IPA.
129 *
130 * This function, @ipa_setup(), starts the setup stage.
131 *
132 * In order for the GSI hardware to be functional it needs firmware to be
133 * loaded (in addition to some other low-level initialization). This early
134 * GSI initialization can be done either by Trust Zone on the AP or by the
135 * modem.
136 *
137 * If it's done by Trust Zone, the AP loads the GSI firmware and supplies
138 * it to Trust Zone to verify and install. When this completes, if
139 * verification was successful, the GSI layer is ready and ipa_setup()
140 * implements the setup phase of initialization.
141 *
142 * If the modem performs early GSI initialization, the AP needs to know
143 * when this has occurred. An SMP2P interrupt is used for this purpose,
144 * and receipt of that interrupt triggers the call to ipa_setup().
145 */
146int ipa_setup(struct ipa *ipa);
147
148#endif /* _IPA_H_ */