1 /*
2 * Copyright (c) 2014,2016 Qualcomm Atheros, Inc.
3 * Copyright (c) 2018-2019, The Linux Foundation. All rights reserved.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
17 #ifndef __WIL_FW_H__
18 #define __WIL_FW_H__
19
20 #define WIL_FW_SIGNATURE (0x36323130) /* '0126' */
21 #define WIL_FW_FMT_VERSION (1) /* format version driver supports */
22
23 enum wil_fw_record_type {
24 wil_fw_type_comment = 1,
25 wil_fw_type_data = 2,
26 wil_fw_type_fill = 3,
27 wil_fw_type_action = 4,
28 wil_fw_type_verify = 5,
29 wil_fw_type_file_header = 6,
30 wil_fw_type_direct_write = 7,
31 wil_fw_type_gateway_data = 8,
32 wil_fw_type_gateway_data4 = 9,
33 };
34
35 struct wil_fw_record_head {
36 __le16 type; /* enum wil_fw_record_type */
37 __le16 flags; /* to be defined */
38 __le32 size; /* whole record, bytes after head */
39 } __packed;
40
41 /* data block. write starting from @addr
42 * data_size inferred from the @head.size. For this case,
43 * data_size = @head.size - offsetof(struct wil_fw_record_data, data)
44 */
45 struct wil_fw_record_data { /* type == wil_fw_type_data */
46 __le32 addr;
47 __le32 data[0]; /* [data_size], see above */
48 } __packed;
49
50 /* fill with constant @value, @size bytes starting from @addr */
51 struct wil_fw_record_fill { /* type == wil_fw_type_fill */
52 __le32 addr;
53 __le32 value;
54 __le32 size;
55 } __packed;
56
57 /* free-form comment
58 * for informational purpose, data_size is @head.size from record header
59 */
60 struct wil_fw_record_comment { /* type == wil_fw_type_comment */
61 u8 data[0]; /* free-form data [data_size], see above */
62 } __packed;
63
64 /* Comment header - common for all comment record types */
65 struct wil_fw_record_comment_hdr {
66 __le32 magic;
67 };
68
69 /* FW capabilities encoded inside a comment record */
70 #define WIL_FW_CAPABILITIES_MAGIC (0xabcddcba)
71 struct wil_fw_record_capabilities { /* type == wil_fw_type_comment */
72 /* identifies capabilities record */
73 struct wil_fw_record_comment_hdr hdr;
74 /* capabilities (variable size), see enum wmi_fw_capability */
75 u8 capabilities[0];
76 } __packed;
77
78 /* FW VIF concurrency encoded inside a comment record
79 * Format is similar to wiphy->iface_combinations
80 */
81 #define WIL_FW_CONCURRENCY_MAGIC (0xfedccdef)
82 #define WIL_FW_CONCURRENCY_REC_VER 1
83 struct wil_fw_concurrency_limit {
84 __le16 max; /* maximum number of interfaces of these types */
85 __le16 types; /* interface types (bit mask of enum nl80211_iftype) */
86 } __packed;
87
88 struct wil_fw_concurrency_combo {
89 u8 n_limits; /* number of wil_fw_concurrency_limit entries */
90 u8 max_interfaces; /* max number of concurrent interfaces allowed */
91 u8 n_diff_channels; /* total number of different channels allowed */
92 u8 same_bi; /* for APs, 1 if all APs must have same BI */
93 /* keep last - concurrency limits, variable size by n_limits */
94 struct wil_fw_concurrency_limit limits[0];
95 } __packed;
96
97 struct wil_fw_record_concurrency { /* type == wil_fw_type_comment */
98 /* identifies concurrency record */
99 __le32 magic;
100 /* structure version, currently always 1 */
101 u8 version;
102 /* maximum number of supported MIDs _in addition_ to MID 0 */
103 u8 n_mids;
104 /* number of concurrency combinations that follow */
105 __le16 n_combos;
106 /* keep last - combinations, variable size by n_combos */
107 struct wil_fw_concurrency_combo combos[0];
108 } __packed;
109
110 /* brd file info encoded inside a comment record */
111 #define WIL_BRD_FILE_MAGIC (0xabcddcbb)
112
113 struct brd_info {
114 __le32 base_addr;
115 __le32 max_size_bytes;
116 } __packed;
117
118 struct wil_fw_record_brd_file { /* type == wil_fw_type_comment */
119 /* identifies brd file record */
120 struct wil_fw_record_comment_hdr hdr;
121 __le32 version;
122 struct brd_info brd_info[0];
123 } __packed;
124
125 /* perform action
126 * data_size = @head.size - offsetof(struct wil_fw_record_action, data)
127 */
128 struct wil_fw_record_action { /* type == wil_fw_type_action */
129 __le32 action; /* action to perform: reset, wait for fw ready etc. */
130 __le32 data[0]; /* action specific, [data_size], see above */
131 } __packed;
132
133 /* data block for struct wil_fw_record_direct_write */
134 struct wil_fw_data_dwrite {
135 __le32 addr;
136 __le32 value;
137 __le32 mask;
138 } __packed;
139
140 /* write @value to the @addr,
141 * preserve original bits accordingly to the @mask
142 * data_size is @head.size where @head is record header
143 */
144 struct wil_fw_record_direct_write { /* type == wil_fw_type_direct_write */
145 struct wil_fw_data_dwrite data[0];
146 } __packed;
147
148 /* verify condition: [@addr] & @mask == @value
149 * if condition not met, firmware download fails
150 */
151 struct wil_fw_record_verify { /* type == wil_fw_verify */
152 __le32 addr; /* read from this address */
153 __le32 value; /* reference value */
154 __le32 mask; /* mask for verification */
155 } __packed;
156
157 /* file header
158 * First record of every file
159 */
160 /* the FW version prefix in the comment */
161 #define WIL_FW_VERSION_PREFIX "FW version: "
162 #define WIL_FW_VERSION_PREFIX_LEN (sizeof(WIL_FW_VERSION_PREFIX) - 1)
163 struct wil_fw_record_file_header {
164 __le32 signature ; /* Wilocity signature */
165 __le32 reserved;
166 __le32 crc; /* crc32 of the following data */
167 __le32 version; /* format version */
168 __le32 data_len; /* total data in file, including this record */
169 u8 comment[32]; /* short description */
170 } __packed;
171
172 /* 1-dword gateway */
173 /* data block for the struct wil_fw_record_gateway_data */
174 struct wil_fw_data_gw {
175 __le32 addr;
176 __le32 value;
177 } __packed;
178
179 /* gateway write block.
180 * write starting address and values from the data buffer
181 * through the gateway
182 * data_size inferred from the @head.size. For this case,
183 * data_size = @head.size - offsetof(struct wil_fw_record_gateway_data, data)
184 */
185 struct wil_fw_record_gateway_data { /* type == wil_fw_type_gateway_data */
186 __le32 gateway_addr_addr;
187 __le32 gateway_value_addr;
188 __le32 gateway_cmd_addr;
189 __le32 gateway_ctrl_address;
190 #define WIL_FW_GW_CTL_BUSY BIT(29) /* gateway busy performing operation */
191 #define WIL_FW_GW_CTL_RUN BIT(30) /* start gateway operation */
192 __le32 command;
193 struct wil_fw_data_gw data[0]; /* total size [data_size], see above */
194 } __packed;
195
196 /* 4-dword gateway */
197 /* data block for the struct wil_fw_record_gateway_data4 */
198 struct wil_fw_data_gw4 {
199 __le32 addr;
200 __le32 value[4];
201 } __packed;
202
203 /* gateway write block.
204 * write starting address and values from the data buffer
205 * through the gateway
206 * data_size inferred from the @head.size. For this case,
207 * data_size = @head.size - offsetof(struct wil_fw_record_gateway_data4, data)
208 */
209 struct wil_fw_record_gateway_data4 { /* type == wil_fw_type_gateway_data4 */
210 __le32 gateway_addr_addr;
211 __le32 gateway_value_addr[4];
212 __le32 gateway_cmd_addr;
213 __le32 gateway_ctrl_address; /* same logic as for 1-dword gw */
214 __le32 command;
215 struct wil_fw_data_gw4 data[0]; /* total size [data_size], see above */
216 } __packed;
217
218 #endif /* __WIL_FW_H__ */