1 /*
2  * Copyright (c) 2015 Qualcomm Atheros, Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include "wil6210.h"
18 #include <linux/devcoredump.h>
19 
20 static int wil_fw_get_crash_dump_bounds(struct wil6210_priv *wil,
21 					u32 *out_dump_size, u32 *out_host_min)
22 {
23 	int i;
24 	const struct fw_map *map;
25 	u32 host_min, host_max, tmp_max;
26 
27 	if (!out_dump_size)
28 		return -EINVAL;
29 
30 	/* calculate the total size of the unpacked crash dump */
31 	BUILD_BUG_ON(ARRAY_SIZE(fw_mapping) == 0);
32 	map = &fw_mapping[0];
33 	host_min = map->host;
34 	host_max = map->host + (map->to - map->from);
35 
36 	for (i = 1; i < ARRAY_SIZE(fw_mapping); i++) {
37 		map = &fw_mapping[i];
38 
39 		if (!map->fw)
40 			continue;
41 
42 		if (map->host < host_min)
43 			host_min = map->host;
44 
45 		tmp_max = map->host + (map->to - map->from);
46 		if (tmp_max > host_max)
47 			host_max = tmp_max;
48 	}
49 
50 	*out_dump_size = host_max - host_min;
51 	if (out_host_min)
52 		*out_host_min = host_min;
53 
54 	return 0;
55 }
56 
57 int wil_fw_copy_crash_dump(struct wil6210_priv *wil, void *dest, u32 size)
58 {
59 	int i;
60 	const struct fw_map *map;
61 	void *data;
62 	u32 host_min, dump_size, offset, len;
63 
64 	if (wil_fw_get_crash_dump_bounds(wil, &dump_size, &host_min)) {
65 		wil_err(wil, "%s: fail to obtain crash dump size\n", __func__);
66 		return -EINVAL;
67 	}
68 
69 	if (dump_size > size) {
70 		wil_err(wil, "%s: not enough space for dump. Need %d have %d\n",
71 			__func__, dump_size, size);
72 		return -EINVAL;
73 	}
74 
75 	/* copy to crash dump area */
76 	for (i = 0; i < ARRAY_SIZE(fw_mapping); i++) {
77 		map = &fw_mapping[i];
78 
79 		if (!map->fw)
80 			continue;
81 
82 		data = (void * __force)wil->csr + HOSTADDR(map->host);
83 		len = map->to - map->from;
84 		offset = map->host - host_min;
85 
86 		wil_dbg_misc(wil, "%s() - dump %s, size %d, offset %d\n",
87 			     __func__, fw_mapping[i].name, len, offset);
88 
89 		wil_memcpy_fromio_32((void * __force)(dest + offset),
90 				     (const void __iomem * __force)data, len);
91 	}
92 
93 	return 0;
94 }
95 
96 void wil_fw_core_dump(struct wil6210_priv *wil)
97 {
98 	void *fw_dump_data;
99 	u32 fw_dump_size;
100 
101 	if (wil_fw_get_crash_dump_bounds(wil, &fw_dump_size, NULL)) {
102 		wil_err(wil, "%s: fail to get fw dump size\n", __func__);
103 		return;
104 	}
105 
106 	fw_dump_data = vzalloc(fw_dump_size);
107 	if (!fw_dump_data)
108 		return;
109 
110 	if (wil_fw_copy_crash_dump(wil, fw_dump_data, fw_dump_size)) {
111 		vfree(fw_dump_data);
112 		return;
113 	}
114 	/* fw_dump_data will be free in device coredump release function
115 	 * after 5 min
116 	 */
117 	dev_coredumpv(wil_to_dev(wil), fw_dump_data, fw_dump_size, GFP_KERNEL);
118 	wil_info(wil, "%s: fw core dumped, size %d bytes\n", __func__,
119 		 fw_dump_size);
120 }
121