1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Copyright (C) 2020-21 Intel Corporation.
4 */
5
6 #include <linux/delay.h>
7 #include <linux/device.h>
8 #include <linux/io.h>
9 #include <linux/io-64-nonatomic-lo-hi.h>
10 #include <linux/slab.h>
11
12 #include "iosm_ipc_mmio.h"
13
14 /* Definition of MMIO offsets
15 * note that MMIO_CI offsets are relative to end of chip info structure
16 */
17
18 /* MMIO chip info size in bytes */
19 #define MMIO_CHIP_INFO_SIZE 60
20
21 /* CP execution stage */
22 #define MMIO_OFFSET_EXECUTION_STAGE 0x00
23
24 /* Boot ROM Chip Info struct */
25 #define MMIO_OFFSET_CHIP_INFO 0x04
26
27 #define MMIO_OFFSET_ROM_EXIT_CODE 0x40
28
29 #define MMIO_OFFSET_PSI_ADDRESS 0x54
30
31 #define MMIO_OFFSET_PSI_SIZE 0x5C
32
33 #define MMIO_OFFSET_IPC_STATUS 0x60
34
35 #define MMIO_OFFSET_CONTEXT_INFO 0x64
36
37 #define MMIO_OFFSET_BASE_ADDR 0x6C
38
39 #define MMIO_OFFSET_END_ADDR 0x74
40
41 #define MMIO_OFFSET_CP_VERSION 0xF0
42
43 #define MMIO_OFFSET_CP_CAPABILITIES 0xF4
44
45 /* Timeout in 50 msec to wait for the modem boot code to write a valid
46 * execution stage into mmio area
47 */
48 #define IPC_MMIO_EXEC_STAGE_TIMEOUT 50
49
50 /* check if exec stage has one of the valid values */
ipc_mmio_is_valid_exec_stage(enum ipc_mem_exec_stage stage)51 static bool ipc_mmio_is_valid_exec_stage(enum ipc_mem_exec_stage stage)
52 {
53 switch (stage) {
54 case IPC_MEM_EXEC_STAGE_BOOT:
55 case IPC_MEM_EXEC_STAGE_PSI:
56 case IPC_MEM_EXEC_STAGE_EBL:
57 case IPC_MEM_EXEC_STAGE_RUN:
58 case IPC_MEM_EXEC_STAGE_CRASH:
59 case IPC_MEM_EXEC_STAGE_CD_READY:
60 return true;
61 default:
62 return false;
63 }
64 }
65
ipc_mmio_update_cp_capability(struct iosm_mmio * ipc_mmio)66 void ipc_mmio_update_cp_capability(struct iosm_mmio *ipc_mmio)
67 {
68 u32 cp_cap;
69 unsigned int ver;
70
71 ver = ipc_mmio_get_cp_version(ipc_mmio);
72 cp_cap = ioread32(ipc_mmio->base + ipc_mmio->offset.cp_capability);
73
74 ipc_mmio->has_mux_lite = (ver >= IOSM_CP_VERSION) &&
75 !(cp_cap & DL_AGGR) && !(cp_cap & UL_AGGR);
76
77 ipc_mmio->has_ul_flow_credit =
78 (ver >= IOSM_CP_VERSION) && (cp_cap & UL_FLOW_CREDIT);
79 }
80
ipc_mmio_init(void __iomem * mmio,struct device * dev)81 struct iosm_mmio *ipc_mmio_init(void __iomem *mmio, struct device *dev)
82 {
83 struct iosm_mmio *ipc_mmio = kzalloc(sizeof(*ipc_mmio), GFP_KERNEL);
84 int retries = IPC_MMIO_EXEC_STAGE_TIMEOUT;
85 enum ipc_mem_exec_stage stage;
86
87 if (!ipc_mmio)
88 return NULL;
89
90 ipc_mmio->dev = dev;
91
92 ipc_mmio->base = mmio;
93
94 ipc_mmio->offset.exec_stage = MMIO_OFFSET_EXECUTION_STAGE;
95
96 /* Check for a valid execution stage to make sure that the boot code
97 * has correctly initialized the MMIO area.
98 */
99 do {
100 stage = ipc_mmio_get_exec_stage(ipc_mmio);
101 if (ipc_mmio_is_valid_exec_stage(stage))
102 break;
103
104 msleep(20);
105 } while (retries-- > 0);
106
107 if (!retries) {
108 dev_err(ipc_mmio->dev, "invalid exec stage %X", stage);
109 goto init_fail;
110 }
111
112 ipc_mmio->offset.chip_info = MMIO_OFFSET_CHIP_INFO;
113
114 /* read chip info size and version from chip info structure */
115 ipc_mmio->chip_info_version =
116 ioread8(ipc_mmio->base + ipc_mmio->offset.chip_info);
117
118 /* Increment of 2 is needed as the size value in the chip info
119 * excludes the version and size field, which are always present
120 */
121 ipc_mmio->chip_info_size =
122 ioread8(ipc_mmio->base + ipc_mmio->offset.chip_info + 1) + 2;
123
124 if (ipc_mmio->chip_info_size != MMIO_CHIP_INFO_SIZE) {
125 dev_err(ipc_mmio->dev, "Unexpected Chip Info");
126 goto init_fail;
127 }
128
129 ipc_mmio->offset.rom_exit_code = MMIO_OFFSET_ROM_EXIT_CODE;
130
131 ipc_mmio->offset.psi_address = MMIO_OFFSET_PSI_ADDRESS;
132 ipc_mmio->offset.psi_size = MMIO_OFFSET_PSI_SIZE;
133 ipc_mmio->offset.ipc_status = MMIO_OFFSET_IPC_STATUS;
134 ipc_mmio->offset.context_info = MMIO_OFFSET_CONTEXT_INFO;
135 ipc_mmio->offset.ap_win_base = MMIO_OFFSET_BASE_ADDR;
136 ipc_mmio->offset.ap_win_end = MMIO_OFFSET_END_ADDR;
137
138 ipc_mmio->offset.cp_version = MMIO_OFFSET_CP_VERSION;
139 ipc_mmio->offset.cp_capability = MMIO_OFFSET_CP_CAPABILITIES;
140
141 return ipc_mmio;
142
143 init_fail:
144 kfree(ipc_mmio);
145 return NULL;
146 }
147
ipc_mmio_get_exec_stage(struct iosm_mmio * ipc_mmio)148 enum ipc_mem_exec_stage ipc_mmio_get_exec_stage(struct iosm_mmio *ipc_mmio)
149 {
150 if (!ipc_mmio)
151 return IPC_MEM_EXEC_STAGE_INVALID;
152
153 return (enum ipc_mem_exec_stage)ioread32(ipc_mmio->base +
154 ipc_mmio->offset.exec_stage);
155 }
156
ipc_mmio_copy_chip_info(struct iosm_mmio * ipc_mmio,void * dest,size_t size)157 void ipc_mmio_copy_chip_info(struct iosm_mmio *ipc_mmio, void *dest,
158 size_t size)
159 {
160 if (ipc_mmio && dest)
161 memcpy_fromio(dest, ipc_mmio->base + ipc_mmio->offset.chip_info,
162 size);
163 }
164
ipc_mmio_get_ipc_state(struct iosm_mmio * ipc_mmio)165 enum ipc_mem_device_ipc_state ipc_mmio_get_ipc_state(struct iosm_mmio *ipc_mmio)
166 {
167 if (!ipc_mmio)
168 return IPC_MEM_DEVICE_IPC_INVALID;
169
170 return (enum ipc_mem_device_ipc_state)ioread32(ipc_mmio->base +
171 ipc_mmio->offset.ipc_status);
172 }
173
ipc_mmio_get_rom_exit_code(struct iosm_mmio * ipc_mmio)174 enum rom_exit_code ipc_mmio_get_rom_exit_code(struct iosm_mmio *ipc_mmio)
175 {
176 if (!ipc_mmio)
177 return IMEM_ROM_EXIT_FAIL;
178
179 return (enum rom_exit_code)ioread32(ipc_mmio->base +
180 ipc_mmio->offset.rom_exit_code);
181 }
182
ipc_mmio_config(struct iosm_mmio * ipc_mmio)183 void ipc_mmio_config(struct iosm_mmio *ipc_mmio)
184 {
185 if (!ipc_mmio)
186 return;
187
188 /* AP memory window (full window is open and active so that modem checks
189 * each AP address) 0 means don't check on modem side.
190 */
191 iowrite64(0, ipc_mmio->base + ipc_mmio->offset.ap_win_base);
192 iowrite64(0, ipc_mmio->base + ipc_mmio->offset.ap_win_end);
193
194 iowrite64(ipc_mmio->context_info_addr,
195 ipc_mmio->base + ipc_mmio->offset.context_info);
196 }
197
ipc_mmio_set_psi_addr_and_size(struct iosm_mmio * ipc_mmio,dma_addr_t addr,u32 size)198 void ipc_mmio_set_psi_addr_and_size(struct iosm_mmio *ipc_mmio, dma_addr_t addr,
199 u32 size)
200 {
201 if (!ipc_mmio)
202 return;
203
204 iowrite64(addr, ipc_mmio->base + ipc_mmio->offset.psi_address);
205 iowrite32(size, ipc_mmio->base + ipc_mmio->offset.psi_size);
206 }
207
ipc_mmio_set_contex_info_addr(struct iosm_mmio * ipc_mmio,phys_addr_t addr)208 void ipc_mmio_set_contex_info_addr(struct iosm_mmio *ipc_mmio, phys_addr_t addr)
209 {
210 if (!ipc_mmio)
211 return;
212
213 /* store context_info address. This will be stored in the mmio area
214 * during IPC_MEM_DEVICE_IPC_INIT state via ipc_mmio_config()
215 */
216 ipc_mmio->context_info_addr = addr;
217 }
218
ipc_mmio_get_cp_version(struct iosm_mmio * ipc_mmio)219 int ipc_mmio_get_cp_version(struct iosm_mmio *ipc_mmio)
220 {
221 if (ipc_mmio)
222 return ioread32(ipc_mmio->base + ipc_mmio->offset.cp_version);
223
224 return -EFAULT;
225 }
226