xref: /wlan-driver/qca-wifi-host-cmn/qdf/linux/src/qdf_file.c (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018-2019, 2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name #include <linux/firmware.h>
21*5113495bSYour Name #include "qdf_file.h"
22*5113495bSYour Name #include "qdf_mem.h"
23*5113495bSYour Name #include "qdf_module.h"
24*5113495bSYour Name #include "qdf_status.h"
25*5113495bSYour Name #include "qdf_trace.h"
26*5113495bSYour Name #include "qdf_types.h"
27*5113495bSYour Name 
28*5113495bSYour Name #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 18, 0))
29*5113495bSYour Name static inline
qdf_firmware_request_nowarn(const struct firmware ** fw,const char * name,struct device * device)30*5113495bSYour Name int qdf_firmware_request_nowarn(const struct firmware **fw,
31*5113495bSYour Name 				const char *name,
32*5113495bSYour Name 				struct device *device)
33*5113495bSYour Name {
34*5113495bSYour Name 	return firmware_request_nowarn(fw, name, device);
35*5113495bSYour Name }
36*5113495bSYour Name #else
37*5113495bSYour Name static inline
qdf_firmware_request_nowarn(const struct firmware ** fw,const char * name,struct device * device)38*5113495bSYour Name int qdf_firmware_request_nowarn(const struct firmware **fw,
39*5113495bSYour Name 				const char *name,
40*5113495bSYour Name 				struct device *device)
41*5113495bSYour Name {
42*5113495bSYour Name 	return request_firmware(fw, name, device);
43*5113495bSYour Name }
44*5113495bSYour Name #endif
45*5113495bSYour Name 
46*5113495bSYour Name 
qdf_file_read(const char * path,char ** out_buf)47*5113495bSYour Name QDF_STATUS qdf_file_read(const char *path, char **out_buf)
48*5113495bSYour Name {
49*5113495bSYour Name 	int errno;
50*5113495bSYour Name 	const struct firmware *fw;
51*5113495bSYour Name 	char *buf;
52*5113495bSYour Name 
53*5113495bSYour Name 	*out_buf = NULL;
54*5113495bSYour Name 
55*5113495bSYour Name 	errno = qdf_firmware_request_nowarn(&fw, path, NULL);
56*5113495bSYour Name 	if (errno) {
57*5113495bSYour Name 		qdf_err("Failed to read file %s", path);
58*5113495bSYour Name 		return QDF_STATUS_E_FAILURE;
59*5113495bSYour Name 	}
60*5113495bSYour Name 
61*5113495bSYour Name 	/* qdf_mem_malloc zeros new memory; +1 size ensures null-termination */
62*5113495bSYour Name 	buf = qdf_mem_malloc(fw->size + 1);
63*5113495bSYour Name 	if (!buf) {
64*5113495bSYour Name 		release_firmware(fw);
65*5113495bSYour Name 		return QDF_STATUS_E_NOMEM;
66*5113495bSYour Name 	}
67*5113495bSYour Name 
68*5113495bSYour Name 	qdf_mem_copy(buf, fw->data, fw->size);
69*5113495bSYour Name 	release_firmware(fw);
70*5113495bSYour Name 	*out_buf = buf;
71*5113495bSYour Name 
72*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
73*5113495bSYour Name }
74*5113495bSYour Name qdf_export_symbol(qdf_file_read);
75*5113495bSYour Name 
qdf_file_buf_free(char * file_buf)76*5113495bSYour Name void qdf_file_buf_free(char *file_buf)
77*5113495bSYour Name {
78*5113495bSYour Name 	QDF_BUG(file_buf);
79*5113495bSYour Name 	if (!file_buf)
80*5113495bSYour Name 		return;
81*5113495bSYour Name 
82*5113495bSYour Name 	qdf_mem_free(file_buf);
83*5113495bSYour Name }
84*5113495bSYour Name qdf_export_symbol(qdf_file_buf_free);
85*5113495bSYour Name 
86*5113495bSYour Name #ifdef QCA_WIFI_MODULE_PARAMS_FROM_INI
qdf_module_param_file_read(const char * path,char ** out_buf)87*5113495bSYour Name QDF_STATUS qdf_module_param_file_read(const char *path, char **out_buf)
88*5113495bSYour Name {
89*5113495bSYour Name 	int errno;
90*5113495bSYour Name 	const struct firmware *fw;
91*5113495bSYour Name 	char *buf;
92*5113495bSYour Name 
93*5113495bSYour Name 	*out_buf = NULL;
94*5113495bSYour Name 	errno = qdf_firmware_request_nowarn(&fw, path, NULL);
95*5113495bSYour Name 	if (errno) {
96*5113495bSYour Name 		qdf_err("Failed to read file %s", path);
97*5113495bSYour Name 		return QDF_STATUS_E_FAILURE;
98*5113495bSYour Name 	}
99*5113495bSYour Name 
100*5113495bSYour Name 	/* qdf_untracked_mem_malloc zeros new memory; +1 size
101*5113495bSYour Name 	 * ensures null-termination
102*5113495bSYour Name 	 */
103*5113495bSYour Name 	buf = qdf_untracked_mem_malloc(fw->size + 1);
104*5113495bSYour Name 	if (!buf) {
105*5113495bSYour Name 		release_firmware(fw);
106*5113495bSYour Name 		return QDF_STATUS_E_NOMEM;
107*5113495bSYour Name 	}
108*5113495bSYour Name 
109*5113495bSYour Name 	qdf_mem_copy(buf, fw->data, fw->size);
110*5113495bSYour Name 	release_firmware(fw);
111*5113495bSYour Name 	*out_buf = buf;
112*5113495bSYour Name 
113*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
114*5113495bSYour Name }
115*5113495bSYour Name 
qdf_module_param_file_free(char * file_buf)116*5113495bSYour Name void qdf_module_param_file_free(char *file_buf)
117*5113495bSYour Name {
118*5113495bSYour Name 	QDF_BUG(file_buf);
119*5113495bSYour Name 	if (!file_buf)
120*5113495bSYour Name 		return;
121*5113495bSYour Name 
122*5113495bSYour Name 	qdf_untracked_mem_free(file_buf);
123*5113495bSYour Name }
124*5113495bSYour Name #endif
125*5113495bSYour Name 
qdf_file_read_bytes(const char * path,char ** out_buf,unsigned int * out_buff_size)126*5113495bSYour Name QDF_STATUS qdf_file_read_bytes(const char *path, char **out_buf,
127*5113495bSYour Name 			       unsigned int *out_buff_size)
128*5113495bSYour Name {
129*5113495bSYour Name 	int errno;
130*5113495bSYour Name 	const struct firmware *fw;
131*5113495bSYour Name 	char *buf;
132*5113495bSYour Name 
133*5113495bSYour Name 	*out_buf = NULL;
134*5113495bSYour Name 
135*5113495bSYour Name 	errno = qdf_firmware_request_nowarn(&fw, path, NULL);
136*5113495bSYour Name 	if (errno) {
137*5113495bSYour Name 		qdf_err("Failed to read file %s", path);
138*5113495bSYour Name 		return QDF_STATUS_E_FAILURE;
139*5113495bSYour Name 	}
140*5113495bSYour Name 
141*5113495bSYour Name 	buf = qdf_mem_malloc(fw->size);
142*5113495bSYour Name 	if (!buf) {
143*5113495bSYour Name 		release_firmware(fw);
144*5113495bSYour Name 		return QDF_STATUS_E_NOMEM;
145*5113495bSYour Name 	}
146*5113495bSYour Name 
147*5113495bSYour Name 	qdf_mem_copy(buf, fw->data, fw->size);
148*5113495bSYour Name 	*out_buff_size = fw->size;
149*5113495bSYour Name 	*out_buf = buf;
150*5113495bSYour Name 	release_firmware(fw);
151*5113495bSYour Name 
152*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
153*5113495bSYour Name }
154*5113495bSYour Name 
155*5113495bSYour Name qdf_export_symbol(qdf_file_read_bytes);
156