linux/drivers/net/wireless/ath/wil6210/fw_inc.c

// SPDX-License-Identifier: ISC
/*
 * Copyright (c) 2014-2017 Qualcomm Atheros, Inc.
 * Copyright (c) 2018-2019, The Linux Foundation. All rights reserved.
 */

/* Algorithmic part of the firmware download.
 * To be included in the container file providing framework
 */

#define wil_err_fw(wil, fmt, arg...) …
#define wil_dbg_fw(wil, fmt, arg...) …
#define wil_hex_dump_fw(prefix_str, prefix_type, rowsize,		\
			groupsize, buf, len, ascii) …

static bool wil_fw_addr_check(struct wil6210_priv *wil,
			      void __iomem **ioaddr, __le32 val,
			      u32 size, const char *msg)
{ … }

/**
 * wil_fw_verify - verify firmware file validity
 *
 * perform various checks for the firmware file header.
 * records are not validated.
 *
 * Return file size or negative error
 */
static int wil_fw_verify(struct wil6210_priv *wil, const u8 *data, size_t size)
{ … }

static int fw_ignore_section(struct wil6210_priv *wil, const void *data,
			     size_t size)
{ … }

static int
fw_handle_capabilities(struct wil6210_priv *wil, const void *data,
		       size_t size)
{ … }

static int
fw_handle_brd_file(struct wil6210_priv *wil, const void *data,
		   size_t size)
{ … }

static int
fw_handle_concurrency(struct wil6210_priv *wil, const void *data,
		      size_t size)
{ … }

static int
fw_handle_comment(struct wil6210_priv *wil, const void *data,
		  size_t size)
{ … }

static int __fw_handle_data(struct wil6210_priv *wil, const void *data,
			    size_t size, __le32 addr)
{ … }

static int fw_handle_data(struct wil6210_priv *wil, const void *data,
			  size_t size)
{ … }

static int fw_handle_fill(struct wil6210_priv *wil, const void *data,
			  size_t size)
{ … }

static int fw_handle_file_header(struct wil6210_priv *wil, const void *data,
				 size_t size)
{ … }

static int fw_handle_direct_write(struct wil6210_priv *wil, const void *data,
				  size_t size)
{ … }

static int gw_write(struct wil6210_priv *wil, void __iomem *gwa_addr,
		    void __iomem *gwa_cmd, void __iomem *gwa_ctl, u32 gw_cmd,
		    u32 a)
{ … }

static int fw_handle_gateway_data(struct wil6210_priv *wil, const void *data,
				  size_t size)
{ … }

static int fw_handle_gateway_data4(struct wil6210_priv *wil, const void *data,
				   size_t size)
{ … }

static const struct { … } wil_fw_handlers[] = …;

static int wil_fw_handle_record(struct wil6210_priv *wil, int type,
				const void *data, size_t size, bool load)
{ … }

/**
 * wil_fw_process - process section from FW file
 * if load is true: Load the FW and uCode code and data to the
 * corresponding device memory regions,
 * otherwise only parse and look for capabilities
 *
 * Return error code
 */
static int wil_fw_process(struct wil6210_priv *wil, const void *data,
			  size_t size, bool load)
{ … }

/**
 * wil_request_firmware - Request firmware
 *
 * Request firmware image from the file
 * If load is true, load firmware to device, otherwise
 * only parse and extract capabilities
 *
 * Return error code
 */
int wil_request_firmware(struct wil6210_priv *wil, const char *name,
			 bool load)
{ … }

/**
 * wil_brd_process - process section from BRD file
 *
 * Return error code
 */
static int wil_brd_process(struct wil6210_priv *wil, const void *data,
			   size_t size)
{ … }

/**
 * wil_request_board - Request board file
 *
 * Request board image from the file
 * board file address and max size are read from FW file
 * during initialization.
 * brd file shall include one header and one data section.
 *
 * Return error code
 */
int wil_request_board(struct wil6210_priv *wil, const char *name)
{ … }

/**
 * wil_fw_verify_file_exists - checks if firmware file exist
 *
 * @wil: driver context
 * @name: firmware file name
 *
 * return value - boolean, true for success, false for failure
 */
bool wil_fw_verify_file_exists(struct wil6210_priv *wil, const char *name)
{ … }