1 From d09ae51a4b676151edaf572bcd5f272b5532639f Mon Sep 17 00:00:00 2001
2 From: Arend Van Spriel <arend.vanspriel@broadcom.com>
3 Date: Thu, 22 Mar 2018 21:28:26 +0100
4 Subject: [PATCH] brcmfmac: pass struct in brcmf_fw_get_firmwares()
6 Make the function brcmf_fw_get_firmwares() a bit more easy to extend
7 using a structure to pass the request parameters.
9 Reviewed-by: Hante Meuleman <hante.meuleman@broadcom.com>
10 Reviewed-by: Pieter-Paul Giesberts <pieter-paul.giesberts@broadcom.com>
11 Reviewed-by: Franky Lin <franky.lin@broadcom.com>
12 Signed-off-by: Arend van Spriel <arend.vanspriel@broadcom.com>
13 Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
15 .../broadcom/brcm80211/brcmfmac/firmware.c | 175 ++++++++++++++-------
16 .../broadcom/brcm80211/brcmfmac/firmware.h | 43 +++--
17 .../wireless/broadcom/brcm80211/brcmfmac/pcie.c | 38 ++++-
18 .../wireless/broadcom/brcm80211/brcmfmac/sdio.c | 32 +++-
19 .../net/wireless/broadcom/brcm80211/brcmfmac/usb.c | 43 ++++-
20 5 files changed, 245 insertions(+), 86 deletions(-)
22 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/firmware.c
23 +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/firmware.c
24 @@ -438,18 +438,31 @@ void brcmf_fw_nvram_free(void *nvram)
29 - const struct firmware *code;
30 - const char *nvram_name;
33 - void (*done)(struct device *dev, int err, const struct firmware *fw,
34 - void *nvram_image, u32 nvram_len);
35 + struct brcmf_fw_request *req;
37 + void (*done)(struct device *dev, int err, struct brcmf_fw_request *req);
40 +static void brcmf_fw_request_done(const struct firmware *fw, void *ctx);
42 +static void brcmf_fw_free_request(struct brcmf_fw_request *req)
44 + struct brcmf_fw_item *item;
47 + for (i = 0, item = &req->items[0]; i < req->n_items; i++, item++) {
48 + if (item->type == BRCMF_FW_TYPE_BINARY)
49 + release_firmware(item->binary);
50 + else if (item->type == BRCMF_FW_TYPE_NVRAM)
51 + brcmf_fw_nvram_free(item->nv_data.data);
56 static void brcmf_fw_request_nvram_done(const struct firmware *fw, void *ctx)
58 struct brcmf_fw *fwctx = ctx;
59 + struct brcmf_fw_item *cur;
63 @@ -457,83 +470,150 @@ static void brcmf_fw_request_nvram_done(
66 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
68 + cur = &fwctx->req->items[fwctx->curpos];
71 data = (u8 *)fw->data;
75 data = bcm47xx_nvram_get_contents(&data_len);
76 - if (!data && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
77 + if (!data && !(cur->flags & BRCMF_FW_REQF_OPTIONAL))
83 nvram = brcmf_fw_nvram_strip(data, data_len, &nvram_length,
84 - fwctx->domain_nr, fwctx->bus_nr);
85 + fwctx->req->domain_nr,
86 + fwctx->req->bus_nr);
89 bcm47xx_nvram_release_contents(data);
91 - if (!nvram && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
92 + if (!nvram && !(cur->flags & BRCMF_FW_REQF_OPTIONAL))
95 - fwctx->done(fwctx->dev, 0, fwctx->code, nvram, nvram_length);
97 + brcmf_dbg(TRACE, "nvram %p len %d\n", nvram, nvram_length);
98 + cur->nv_data.data = nvram;
99 + cur->nv_data.len = nvram_length;
103 brcmf_dbg(TRACE, "failed: dev=%s\n", dev_name(fwctx->dev));
104 - release_firmware(fwctx->code);
105 - fwctx->done(fwctx->dev, -ENOENT, NULL, NULL, 0);
106 + fwctx->done(fwctx->dev, -ENOENT, NULL);
107 + brcmf_fw_free_request(fwctx->req);
111 -static void brcmf_fw_request_code_done(const struct firmware *fw, void *ctx)
112 +static int brcmf_fw_request_next_item(struct brcmf_fw *fwctx, bool async)
114 + struct brcmf_fw_item *cur;
115 + const struct firmware *fw = NULL;
118 + cur = &fwctx->req->items[fwctx->curpos];
120 + brcmf_dbg(TRACE, "%srequest for %s\n", async ? "async " : "",
124 + ret = request_firmware_nowait(THIS_MODULE, true, cur->path,
125 + fwctx->dev, GFP_KERNEL, fwctx,
126 + brcmf_fw_request_done);
128 + ret = request_firmware(&fw, cur->path, fwctx->dev);
131 + brcmf_fw_request_done(NULL, fwctx);
132 + } else if (!async && fw) {
133 + brcmf_dbg(TRACE, "firmware %s %sfound\n", cur->path,
135 + if (cur->type == BRCMF_FW_TYPE_BINARY)
137 + else if (cur->type == BRCMF_FW_TYPE_NVRAM)
138 + brcmf_fw_request_nvram_done(fw, fwctx);
140 + release_firmware(fw);
147 +static void brcmf_fw_request_done(const struct firmware *fw, void *ctx)
149 struct brcmf_fw *fwctx = ctx;
150 + struct brcmf_fw_item *cur;
153 - brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
155 + cur = &fwctx->req->items[fwctx->curpos];
157 + brcmf_dbg(TRACE, "enter: firmware %s %sfound\n", cur->path,
161 + if (cur->type == BRCMF_FW_TYPE_BINARY)
163 + else if (cur->type == BRCMF_FW_TYPE_NVRAM)
164 + brcmf_fw_request_nvram_done(fw, fwctx);
166 + release_firmware(fw);
167 + } else if (cur->type == BRCMF_FW_TYPE_NVRAM) {
168 + brcmf_fw_request_nvram_done(NULL, fwctx);
169 + } else if (!(cur->flags & BRCMF_FW_REQF_OPTIONAL)) {
173 - /* only requested code so done here */
174 - if (!(fwctx->flags & BRCMF_FW_REQUEST_NVRAM))
178 - ret = request_firmware_nowait(THIS_MODULE, true, fwctx->nvram_name,
179 - fwctx->dev, GFP_KERNEL, fwctx,
180 - brcmf_fw_request_nvram_done);
182 - /* pass NULL to nvram callback for bcm47xx fallback */
184 - brcmf_fw_request_nvram_done(NULL, fwctx);
186 + if (++fwctx->curpos == fwctx->req->n_items) {
191 + ret = brcmf_fw_request_next_item(fwctx, false);
192 + } while (ret == -EAGAIN);
197 - brcmf_dbg(TRACE, "failed: dev=%s\n", dev_name(fwctx->dev));
198 + brcmf_dbg(TRACE, "failed err=%d: dev=%s, fw=%s\n", ret,
199 + dev_name(fwctx->dev), cur->path);
200 + brcmf_fw_free_request(fwctx->req);
203 - fwctx->done(fwctx->dev, ret, fw, NULL, 0);
204 + fwctx->done(fwctx->dev, ret, fwctx->req);
208 -int brcmf_fw_get_firmwares_pcie(struct device *dev, u16 flags,
209 - const char *code, const char *nvram,
210 - void (*fw_cb)(struct device *dev, int err,
211 - const struct firmware *fw,
212 - void *nvram_image, u32 nvram_len),
213 - u16 domain_nr, u16 bus_nr)
214 +static bool brcmf_fw_request_is_valid(struct brcmf_fw_request *req)
216 + struct brcmf_fw_item *item;
222 + for (i = 0, item = &req->items[0]; i < req->n_items; i++, item++) {
229 +int brcmf_fw_get_firmwares(struct device *dev, struct brcmf_fw_request *req,
230 + void (*fw_cb)(struct device *dev, int err,
231 + struct brcmf_fw_request *req))
233 struct brcmf_fw *fwctx;
235 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(dev));
236 - if (!fw_cb || !code)
240 - if ((flags & BRCMF_FW_REQUEST_NVRAM) && !nvram)
241 + if (!brcmf_fw_request_is_valid(req))
244 fwctx = kzalloc(sizeof(*fwctx), GFP_KERNEL);
245 @@ -541,26 +621,11 @@ int brcmf_fw_get_firmwares_pcie(struct d
249 - fwctx->flags = flags;
252 - if (flags & BRCMF_FW_REQUEST_NVRAM)
253 - fwctx->nvram_name = nvram;
254 - fwctx->domain_nr = domain_nr;
255 - fwctx->bus_nr = bus_nr;
257 - return request_firmware_nowait(THIS_MODULE, true, code, dev,
259 - brcmf_fw_request_code_done);
262 -int brcmf_fw_get_firmwares(struct device *dev, u16 flags,
263 - const char *code, const char *nvram,
264 - void (*fw_cb)(struct device *dev, int err,
265 - const struct firmware *fw,
266 - void *nvram_image, u32 nvram_len))
268 - return brcmf_fw_get_firmwares_pcie(dev, flags, code, nvram, fw_cb, 0,
270 + brcmf_fw_request_next_item(fwctx, true);
274 static void brcmf_fw_get_full_name(char fw_name[BRCMF_FW_NAME_LEN],
275 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/firmware.h
276 +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/firmware.h
278 #ifndef BRCMFMAC_FIRMWARE_H
279 #define BRCMFMAC_FIRMWARE_H
281 -#define BRCMF_FW_REQUEST 0x000F
282 -#define BRCMF_FW_REQUEST_NVRAM 0x0001
283 -#define BRCMF_FW_REQ_FLAGS 0x00F0
284 -#define BRCMF_FW_REQ_NV_OPTIONAL 0x0010
285 +#define BRCMF_FW_REQF_OPTIONAL 0x0001
287 #define BRCMF_FW_NAME_LEN 320
289 @@ -54,21 +51,39 @@ int brcmf_fw_map_chip_to_name(u32 chip,
290 u32 table_size, char fw_name[BRCMF_FW_NAME_LEN],
291 char nvram_name[BRCMF_FW_NAME_LEN]);
292 void brcmf_fw_nvram_free(void *nvram);
294 +enum brcmf_fw_type {
295 + BRCMF_FW_TYPE_BINARY,
296 + BRCMF_FW_TYPE_NVRAM
299 +struct brcmf_fw_item {
301 + enum brcmf_fw_type type;
304 + const struct firmware *binary;
312 +struct brcmf_fw_request {
316 + struct brcmf_fw_item items[0];
320 * Request firmware(s) asynchronously. When the asynchronous request
321 * fails it will not use the callback, but call device_release_driver()
322 * instead which will call the driver .remove() callback.
324 -int brcmf_fw_get_firmwares_pcie(struct device *dev, u16 flags,
325 - const char *code, const char *nvram,
326 - void (*fw_cb)(struct device *dev, int err,
327 - const struct firmware *fw,
328 - void *nvram_image, u32 nvram_len),
329 - u16 domain_nr, u16 bus_nr);
330 -int brcmf_fw_get_firmwares(struct device *dev, u16 flags,
331 - const char *code, const char *nvram,
332 +int brcmf_fw_get_firmwares(struct device *dev, struct brcmf_fw_request *req,
333 void (*fw_cb)(struct device *dev, int err,
334 - const struct firmware *fw,
335 - void *nvram_image, u32 nvram_len));
336 + struct brcmf_fw_request *req));
338 #endif /* BRCMFMAC_FIRMWARE_H */
339 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c
340 +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c
341 @@ -1651,15 +1651,19 @@ static const struct brcmf_buscore_ops br
342 .write32 = brcmf_pcie_buscore_write32,
345 +#define BRCMF_PCIE_FW_CODE 0
346 +#define BRCMF_PCIE_FW_NVRAM 1
348 static void brcmf_pcie_setup(struct device *dev, int ret,
349 - const struct firmware *fw,
350 - void *nvram, u32 nvram_len)
351 + struct brcmf_fw_request *fwreq)
353 + const struct firmware *fw;
355 struct brcmf_bus *bus;
356 struct brcmf_pciedev *pcie_bus_dev;
357 struct brcmf_pciedev_info *devinfo;
358 struct brcmf_commonring **flowrings;
362 /* check firmware loading result */
364 @@ -1670,6 +1674,11 @@ static void brcmf_pcie_setup(struct devi
365 devinfo = pcie_bus_dev->devinfo;
366 brcmf_pcie_attach(devinfo);
368 + fw = fwreq->items[BRCMF_PCIE_FW_CODE].binary;
369 + nvram = fwreq->items[BRCMF_PCIE_FW_NVRAM].nv_data.data;
370 + nvram_len = fwreq->items[BRCMF_PCIE_FW_NVRAM].nv_data.len;
373 /* Some of the firmwares have the size of the memory of the device
374 * defined inside the firmware. This is because part of the memory in
375 * the device is shared and the devision is determined by FW. Parse
376 @@ -1730,6 +1739,7 @@ static int
377 brcmf_pcie_probe(struct pci_dev *pdev, const struct pci_device_id *id)
380 + struct brcmf_fw_request *fwreq;
381 struct brcmf_pciedev_info *devinfo;
382 struct brcmf_pciedev *pcie_bus_dev;
383 struct brcmf_bus *bus;
384 @@ -1800,12 +1810,26 @@ brcmf_pcie_probe(struct pci_dev *pdev, c
388 - ret = brcmf_fw_get_firmwares_pcie(bus->dev, BRCMF_FW_REQUEST_NVRAM |
389 - BRCMF_FW_REQ_NV_OPTIONAL,
390 - devinfo->fw_name, devinfo->nvram_name,
391 - brcmf_pcie_setup, domain_nr, bus_nr);
392 + fwreq = kzalloc(sizeof(*fwreq) + 2 * sizeof(struct brcmf_fw_item),
399 + fwreq->items[BRCMF_PCIE_FW_CODE].path = devinfo->fw_name;
400 + fwreq->items[BRCMF_PCIE_FW_CODE].type = BRCMF_FW_TYPE_BINARY;
401 + fwreq->items[BRCMF_PCIE_FW_NVRAM].path = devinfo->nvram_name;
402 + fwreq->items[BRCMF_PCIE_FW_NVRAM].type = BRCMF_FW_TYPE_NVRAM;
403 + fwreq->items[BRCMF_PCIE_FW_NVRAM].flags = BRCMF_FW_REQF_OPTIONAL;
404 + fwreq->n_items = 2;
405 + fwreq->domain_nr = domain_nr;
406 + fwreq->bus_nr = bus_nr;
407 + ret = brcmf_fw_get_firmwares(bus->dev, fwreq, brcmf_pcie_setup);
415 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c
416 +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/sdio.c
417 @@ -4031,14 +4031,19 @@ static const struct brcmf_bus_ops brcmf_
418 .get_fwname = brcmf_sdio_get_fwname,
421 +#define BRCMF_SDIO_FW_CODE 0
422 +#define BRCMF_SDIO_FW_NVRAM 1
424 static void brcmf_sdio_firmware_callback(struct device *dev, int err,
425 - const struct firmware *code,
426 - void *nvram, u32 nvram_len)
427 + struct brcmf_fw_request *fwreq)
429 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
430 struct brcmf_sdio_dev *sdiod = bus_if->bus_priv.sdio;
431 struct brcmf_sdio *bus = sdiod->bus;
432 struct brcmf_core *core = bus->sdio_core;
433 + const struct firmware *code;
438 brcmf_dbg(TRACE, "Enter: dev=%s, err=%d\n", dev_name(dev), err);
439 @@ -4046,6 +4051,11 @@ static void brcmf_sdio_firmware_callback
443 + code = fwreq->items[BRCMF_SDIO_FW_CODE].binary;
444 + nvram = fwreq->items[BRCMF_SDIO_FW_NVRAM].nv_data.data;
445 + nvram_len = fwreq->items[BRCMF_SDIO_FW_NVRAM].nv_data.len;
448 /* try to download image and nvram to the dongle */
449 bus->alp_only = true;
450 err = brcmf_sdio_download_firmware(bus, code, nvram, nvram_len);
451 @@ -4150,6 +4160,7 @@ struct brcmf_sdio *brcmf_sdio_probe(stru
453 struct brcmf_sdio *bus;
454 struct workqueue_struct *wq;
455 + struct brcmf_fw_request *fwreq;
457 brcmf_dbg(TRACE, "Enter\n");
459 @@ -4240,11 +4251,24 @@ struct brcmf_sdio *brcmf_sdio_probe(stru
463 - ret = brcmf_fw_get_firmwares(sdiodev->dev, BRCMF_FW_REQUEST_NVRAM,
464 - sdiodev->fw_name, sdiodev->nvram_name,
465 + fwreq = kzalloc(sizeof(fwreq) + 2 * sizeof(struct brcmf_fw_item),
472 + fwreq->items[BRCMF_SDIO_FW_CODE].path = sdiodev->fw_name;
473 + fwreq->items[BRCMF_SDIO_FW_CODE].type = BRCMF_FW_TYPE_BINARY;
474 + fwreq->items[BRCMF_SDIO_FW_NVRAM].path = sdiodev->nvram_name;
475 + fwreq->items[BRCMF_SDIO_FW_NVRAM].type = BRCMF_FW_TYPE_NVRAM;
476 + fwreq->n_items = 2;
478 + ret = brcmf_fw_get_firmwares(sdiodev->dev, fwreq,
479 brcmf_sdio_firmware_callback);
481 brcmf_err("async firmware request failed: %d\n", ret);
486 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/usb.c
487 +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/usb.c
488 @@ -1155,18 +1155,23 @@ static const struct brcmf_bus_ops brcmf_
489 .get_fwname = brcmf_usb_get_fwname,
492 +#define BRCMF_USB_FW_CODE 0
494 static void brcmf_usb_probe_phase2(struct device *dev, int ret,
495 - const struct firmware *fw,
496 - void *nvram, u32 nvlen)
497 + struct brcmf_fw_request *fwreq)
499 struct brcmf_bus *bus = dev_get_drvdata(dev);
500 struct brcmf_usbdev_info *devinfo = bus->bus_priv.usb->devinfo;
501 + const struct firmware *fw;
506 brcmf_dbg(USB, "Start fw downloading\n");
508 + fw = fwreq->items[BRCMF_USB_FW_CODE].binary;
511 ret = check_file(fw->data);
513 brcmf_err("invalid firmware\n");
514 @@ -1200,6 +1205,7 @@ static int brcmf_usb_probe_cb(struct brc
515 struct brcmf_bus *bus = NULL;
516 struct brcmf_usbdev *bus_pub = NULL;
517 struct device *dev = devinfo->dev;
518 + struct brcmf_fw_request *fwreq;
521 brcmf_dbg(USB, "Enter\n");
522 @@ -1250,11 +1256,22 @@ static int brcmf_usb_probe_cb(struct brc
526 + fwreq = kzalloc(sizeof(*fwreq) + sizeof(struct brcmf_fw_item),
533 + fwreq->items[BRCMF_USB_FW_CODE].path = devinfo->fw_name;
534 + fwreq->items[BRCMF_USB_FW_CODE].type = BRCMF_FW_TYPE_BINARY;
535 + fwreq->n_items = 1;
537 /* request firmware here */
538 - ret = brcmf_fw_get_firmwares(dev, 0, devinfo->fw_name, NULL,
539 - brcmf_usb_probe_phase2);
540 + ret = brcmf_fw_get_firmwares(dev, fwreq, brcmf_usb_probe_phase2);
542 brcmf_err("firmware request failed: %d\n", ret);
547 @@ -1447,11 +1464,25 @@ static int brcmf_usb_reset_resume(struct
549 struct usb_device *usb = interface_to_usbdev(intf);
550 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
551 + struct brcmf_fw_request *fwreq;
554 brcmf_dbg(USB, "Enter\n");
556 - return brcmf_fw_get_firmwares(&usb->dev, 0, devinfo->fw_name, NULL,
557 - brcmf_usb_probe_phase2);
558 + fwreq = kzalloc(sizeof(*fwreq) + sizeof(struct brcmf_fw_item),
563 + fwreq->items[BRCMF_USB_FW_CODE].path = devinfo->fw_name;
564 + fwreq->items[BRCMF_USB_FW_CODE].type = BRCMF_FW_TYPE_BINARY;
565 + fwreq->n_items = 1;
567 + ret = brcmf_fw_get_firmwares(&usb->dev, fwreq, brcmf_usb_probe_phase2);
574 #define BRCMF_USB_DEVICE(dev_id) \