projects/linux·blob master · refs

368 lines · 8.6 KiB

1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2016, Linaro Ltd.
4 * Copyright (c) 2015, Sony Mobile Communications Inc.
5 */
6#include <linux/cleanup.h>
7#include <linux/firmware.h>
8#include <linux/module.h>
9#include <linux/slab.h>
10#include <linux/io.h>
11#include <linux/of.h>
12#include <linux/of_platform.h>
13#include <linux/platform_device.h>
14#include <linux/rpmsg.h>
15#include <linux/soc/qcom/wcnss_ctrl.h>
16
17#define WCNSS_REQUEST_TIMEOUT (5 * HZ)
18#define WCNSS_CBC_TIMEOUT (10 * HZ)
19
20#define WCNSS_ACK_DONE_BOOTING 1
21#define WCNSS_ACK_COLD_BOOTING 2
22
23#define NV_FRAGMENT_SIZE 3072
24#define NVBIN_FILE "wlan/prima/WCNSS_qcom_wlan_nv.bin"
25
26/**
27 * struct wcnss_ctrl - driver context
28 * @dev: device handle
29 * @channel: SMD channel handle
30 * @ack: completion for outstanding requests
31 * @cbc: completion for cbc complete indication
32 * @ack_status: status of the outstanding request
33 * @probe_work: worker for uploading nv binary
34 */
35struct wcnss_ctrl {
36 struct device *dev;
37 struct rpmsg_endpoint *channel;
38
39 struct completion ack;
40 struct completion cbc;
41 int ack_status;
42
43 struct work_struct probe_work;
44};
45
46/* message types */
47enum {
48 WCNSS_VERSION_REQ = 0x01000000,
49 WCNSS_VERSION_RESP,
50 WCNSS_DOWNLOAD_NV_REQ,
51 WCNSS_DOWNLOAD_NV_RESP,
52 WCNSS_UPLOAD_CAL_REQ,
53 WCNSS_UPLOAD_CAL_RESP,
54 WCNSS_DOWNLOAD_CAL_REQ,
55 WCNSS_DOWNLOAD_CAL_RESP,
56 WCNSS_VBAT_LEVEL_IND,
57 WCNSS_BUILD_VERSION_REQ,
58 WCNSS_BUILD_VERSION_RESP,
59 WCNSS_PM_CONFIG_REQ,
60 WCNSS_CBC_COMPLETE_IND,
61};
62
63/**
64 * struct wcnss_msg_hdr - common packet header for requests and responses
65 * @type: packet message type
66 * @len: total length of the packet, including this header
67 */
68struct wcnss_msg_hdr {
69 u32 type;
70 u32 len;
71} __packed;
72
73/*
74 * struct wcnss_version_resp - version request response
75 */
76struct wcnss_version_resp {
77 struct wcnss_msg_hdr hdr;
78 u8 major;
79 u8 minor;
80 u8 version;
81 u8 revision;
82} __packed;
83
84/**
85 * struct wcnss_download_nv_req - firmware fragment request
86 * @hdr: common packet wcnss_msg_hdr header
87 * @seq: sequence number of this fragment
88 * @last: boolean indicator of this being the last fragment of the binary
89 * @frag_size: length of this fragment
90 * @fragment: fragment data
91 */
92struct wcnss_download_nv_req {
93 struct wcnss_msg_hdr hdr;
94 u16 seq;
95 u16 last;
96 u32 frag_size;
97 u8 fragment[] __counted_by(frag_size);
98} __packed;
99
100/**
101 * struct wcnss_download_nv_resp - firmware download response
102 * @hdr: common packet wcnss_msg_hdr header
103 * @status: boolean to indicate success of the download
104 */
105struct wcnss_download_nv_resp {
106 struct wcnss_msg_hdr hdr;
107 u8 status;
108} __packed;
109
110/**
111 * wcnss_ctrl_smd_callback() - handler from SMD responses
112 * @rpdev: remote processor message device pointer
113 * @data: pointer to the incoming data packet
114 * @count: size of the incoming data packet
115 * @priv: unused
116 * @addr: unused
117 *
118 * Handles any incoming packets from the remote WCNSS_CTRL service.
119 */
120static int wcnss_ctrl_smd_callback(struct rpmsg_device *rpdev,
121 void *data,
122 int count,
123 void *priv,
124 u32 addr)
125{
126 struct wcnss_ctrl *wcnss = dev_get_drvdata(&rpdev->dev);
127 const struct wcnss_download_nv_resp *nvresp;
128 const struct wcnss_version_resp *version;
129 const struct wcnss_msg_hdr *hdr = data;
130
131 switch (hdr->type) {
132 case WCNSS_VERSION_RESP:
133 if (count != sizeof(*version)) {
134 dev_err(wcnss->dev,
135 "invalid size of version response\n");
136 break;
137 }
138
139 version = data;
140 dev_info(wcnss->dev, "WCNSS Version %d.%d %d.%d\n",
141 version->major, version->minor,
142 version->version, version->revision);
143
144 complete(&wcnss->ack);
145 break;
146 case WCNSS_DOWNLOAD_NV_RESP:
147 if (count != sizeof(*nvresp)) {
148 dev_err(wcnss->dev,
149 "invalid size of download response\n");
150 break;
151 }
152
153 nvresp = data;
154 wcnss->ack_status = nvresp->status;
155 complete(&wcnss->ack);
156 break;
157 case WCNSS_CBC_COMPLETE_IND:
158 dev_dbg(wcnss->dev, "cold boot complete\n");
159 complete(&wcnss->cbc);
160 break;
161 default:
162 dev_info(wcnss->dev, "unknown message type %d\n", hdr->type);
163 break;
164 }
165
166 return 0;
167}
168
169/**
170 * wcnss_request_version() - send a version request to WCNSS
171 * @wcnss: wcnss ctrl driver context
172 */
173static int wcnss_request_version(struct wcnss_ctrl *wcnss)
174{
175 struct wcnss_msg_hdr msg;
176 int ret;
177
178 msg.type = WCNSS_VERSION_REQ;
179 msg.len = sizeof(msg);
180 ret = rpmsg_send(wcnss->channel, &msg, sizeof(msg));
181 if (ret < 0)
182 return ret;
183
184 ret = wait_for_completion_timeout(&wcnss->ack, WCNSS_CBC_TIMEOUT);
185 if (!ret) {
186 dev_err(wcnss->dev, "timeout waiting for version response\n");
187 return -ETIMEDOUT;
188 }
189
190 return 0;
191}
192
193/**
194 * wcnss_download_nv() - send nv binary to WCNSS
195 * @wcnss: wcnss_ctrl state handle
196 * @expect_cbc: indicator to caller that an cbc event is expected
197 *
198 * Returns 0 on success. Negative errno on failure.
199 */
200static int wcnss_download_nv(struct wcnss_ctrl *wcnss, bool *expect_cbc)
201{
202 const struct firmware *fw;
203 struct device *dev = wcnss->dev;
204 struct wcnss_download_nv_req *req;
205 const char *nvbin = NVBIN_FILE;
206 const void *data;
207 ssize_t left;
208 int ret;
209
210 ret = of_property_read_string(dev->of_node, "firmware-name", &nvbin);
211 if (ret < 0 && ret != -EINVAL)
212 return ret;
213
214 ret = request_firmware(&fw, nvbin, dev);
215 if (ret < 0) {
216 dev_err(dev, "Failed to load nv file %s: %d\n", nvbin, ret);
217 return ret;
218 }
219
220 data = fw->data;
221 left = fw->size;
222
223 req = kzalloc_flex(*req, fragment, NV_FRAGMENT_SIZE);
224 if (!req) {
225 ret = -ENOMEM;
226 goto release_fw;
227 }
228
229 req->frag_size = NV_FRAGMENT_SIZE;
230 req->hdr.type = WCNSS_DOWNLOAD_NV_REQ;
231 req->hdr.len = struct_size(req, fragment, NV_FRAGMENT_SIZE);
232
233 req->last = 0;
234
235 req->seq = 0;
236 do {
237 if (left <= NV_FRAGMENT_SIZE) {
238 req->last = 1;
239 req->frag_size = left;
240 req->hdr.len = sizeof(*req) + left;
241 }
242
243 memcpy(req->fragment, data, req->frag_size);
244
245 ret = rpmsg_send(wcnss->channel, req, req->hdr.len);
246 if (ret < 0) {
247 dev_err(dev, "failed to send smd packet\n");
248 goto release_req;
249 }
250
251 /* Increment for next fragment */
252 req->seq++;
253
254 data += NV_FRAGMENT_SIZE;
255 left -= NV_FRAGMENT_SIZE;
256 } while (left > 0);
257
258 ret = wait_for_completion_timeout(&wcnss->ack, WCNSS_REQUEST_TIMEOUT);
259 if (!ret) {
260 dev_err(dev, "timeout waiting for nv upload ack\n");
261 ret = -ETIMEDOUT;
262 } else {
263 *expect_cbc = wcnss->ack_status == WCNSS_ACK_COLD_BOOTING;
264 ret = 0;
265 }
266
267release_req:
268 kfree(req);
269release_fw:
270 release_firmware(fw);
271
272 return ret;
273}
274
275/**
276 * qcom_wcnss_open_channel() - open additional SMD channel to WCNSS
277 * @wcnss: wcnss handle, retrieved from drvdata
278 * @name: SMD channel name
279 * @cb: callback to handle incoming data on the channel
280 * @priv: private data for use in the call-back
281 */
282struct rpmsg_endpoint *qcom_wcnss_open_channel(void *wcnss, const char *name, rpmsg_rx_cb_t cb, void *priv)
283{
284 struct rpmsg_channel_info chinfo;
285 struct wcnss_ctrl *_wcnss = wcnss;
286
287 strscpy(chinfo.name, name, sizeof(chinfo.name));
288 chinfo.src = RPMSG_ADDR_ANY;
289 chinfo.dst = RPMSG_ADDR_ANY;
290
291 return rpmsg_create_ept(_wcnss->channel->rpdev, cb, priv, chinfo);
292}
293EXPORT_SYMBOL_GPL(qcom_wcnss_open_channel);
294
295static void wcnss_async_probe(struct work_struct *work)
296{
297 struct wcnss_ctrl *wcnss = container_of(work, struct wcnss_ctrl, probe_work);
298 bool expect_cbc;
299 int ret;
300
301 ret = wcnss_request_version(wcnss);
302 if (ret < 0)
303 return;
304
305 ret = wcnss_download_nv(wcnss, &expect_cbc);
306 if (ret < 0)
307 return;
308
309 /* Wait for pending cold boot completion if indicated by the nv downloader */
310 if (expect_cbc) {
311 ret = wait_for_completion_timeout(&wcnss->cbc, WCNSS_REQUEST_TIMEOUT);
312 if (!ret)
313 dev_err(wcnss->dev, "expected cold boot completion\n");
314 }
315
316 of_platform_populate(wcnss->dev->of_node, NULL, NULL, wcnss->dev);
317}
318
319static int wcnss_ctrl_probe(struct rpmsg_device *rpdev)
320{
321 struct wcnss_ctrl *wcnss;
322
323 wcnss = devm_kzalloc(&rpdev->dev, sizeof(*wcnss), GFP_KERNEL);
324 if (!wcnss)
325 return -ENOMEM;
326
327 wcnss->dev = &rpdev->dev;
328 wcnss->channel = rpdev->ept;
329
330 init_completion(&wcnss->ack);
331 init_completion(&wcnss->cbc);
332 INIT_WORK(&wcnss->probe_work, wcnss_async_probe);
333
334 dev_set_drvdata(&rpdev->dev, wcnss);
335
336 schedule_work(&wcnss->probe_work);
337
338 return 0;
339}
340
341static void wcnss_ctrl_remove(struct rpmsg_device *rpdev)
342{
343 struct wcnss_ctrl *wcnss = dev_get_drvdata(&rpdev->dev);
344
345 cancel_work_sync(&wcnss->probe_work);
346 of_platform_depopulate(&rpdev->dev);
347}
348
349static const struct of_device_id wcnss_ctrl_of_match[] = {
350 { .compatible = "qcom,wcnss", },
351 {}
352};
353MODULE_DEVICE_TABLE(of, wcnss_ctrl_of_match);
354
355static struct rpmsg_driver wcnss_ctrl_driver = {
356 .probe = wcnss_ctrl_probe,
357 .remove = wcnss_ctrl_remove,
358 .callback = wcnss_ctrl_smd_callback,
359 .drv = {
360 .name = "qcom_wcnss_ctrl",
361 .of_match_table = wcnss_ctrl_of_match,
362 },
363};
364
365module_rpmsg_driver(wcnss_ctrl_driver);
366
367MODULE_DESCRIPTION("Qualcomm WCNSS control driver");
368MODULE_LICENSE("GPL v2");