]> git.ipfire.org Git - thirdparty/iw.git/blob - iw.h
update nl80211.h
[thirdparty/iw.git] / iw.h
1 #ifndef __IW_H
2 #define __IW_H
3
4 #include <stdbool.h>
5 #include <netlink/netlink.h>
6 #include <netlink/genl/genl.h>
7 #include <netlink/genl/family.h>
8 #include <netlink/genl/ctrl.h>
9 #include <endian.h>
10
11 #include "nl80211.h"
12 #include "ieee80211.h"
13
14 /* support for extack if compilation headers are too old */
15 #ifndef NETLINK_EXT_ACK
16 #define NETLINK_EXT_ACK 11
17 enum nlmsgerr_attrs {
18 NLMSGERR_ATTR_UNUSED,
19 NLMSGERR_ATTR_MSG,
20 NLMSGERR_ATTR_OFFS,
21 NLMSGERR_ATTR_COOKIE,
22
23 __NLMSGERR_ATTR_MAX,
24 NLMSGERR_ATTR_MAX = __NLMSGERR_ATTR_MAX - 1
25 };
26 #endif
27 #ifndef NLM_F_CAPPED
28 #define NLM_F_CAPPED 0x100
29 #endif
30 #ifndef NLM_F_ACK_TLVS
31 #define NLM_F_ACK_TLVS 0x200
32 #endif
33 #ifndef SOL_NETLINK
34 #define SOL_NETLINK 270
35 #endif
36
37 #define ETH_ALEN 6
38 #define VHT_MUMIMO_GROUP_LEN 24
39
40 /* libnl 1.x compatibility code */
41 #if !defined(CONFIG_LIBNL20) && !defined(CONFIG_LIBNL30)
42 # define nl_sock nl_handle
43 #endif
44
45 struct nl80211_state {
46 struct nl_sock *nl_sock;
47 int nl80211_id;
48 };
49
50 enum command_identify_by {
51 CIB_NONE,
52 CIB_PHY,
53 CIB_NETDEV,
54 CIB_WDEV,
55 };
56
57 enum id_input {
58 II_NONE,
59 II_NETDEV,
60 II_PHY_NAME,
61 II_PHY_IDX,
62 II_WDEV,
63 };
64
65 #define HANDLER_RET_USAGE 1
66 #define HANDLER_RET_DONE 3
67
68 struct cmd {
69 const char *name;
70 const char *args;
71 const char *help;
72 const enum nl80211_commands cmd;
73 int nl_msg_flags;
74 int hidden;
75 const enum command_identify_by idby;
76 /*
77 * The handler should return a negative error code,
78 * zero on success, 1 if the arguments were wrong.
79 * Return 2 iff you provide the error message yourself.
80 */
81 int (*handler)(struct nl80211_state *state,
82 struct nl_msg *msg,
83 int argc, char **argv,
84 enum id_input id);
85 const struct cmd *(*selector)(int argc, char **argv);
86 const struct cmd *parent;
87 };
88
89 struct chanmode {
90 const char *name;
91 unsigned int width;
92 int freq1_diff;
93 int chantype; /* for older kernel */
94 };
95
96 struct chandef {
97 enum nl80211_chan_width width;
98
99 unsigned int control_freq;
100 unsigned int center_freq1;
101 unsigned int center_freq2;
102 };
103
104 #define ARRAY_SIZE(ar) (sizeof(ar)/sizeof(ar[0]))
105 #define DIV_ROUND_UP(x, y) (((x) + (y - 1)) / (y))
106
107 #define __COMMAND(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel)\
108 static struct cmd \
109 __cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden = {\
110 .name = (_name), \
111 .args = (_args), \
112 .cmd = (_nlcmd), \
113 .nl_msg_flags = (_flags), \
114 .hidden = (_hidden), \
115 .idby = (_idby), \
116 .handler = (_handler), \
117 .help = (_help), \
118 .parent = _section, \
119 .selector = (_sel), \
120 }; \
121 static struct cmd *__cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden ## _p \
122 __attribute__((used,section("__cmd"))) = \
123 &__cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden
124 #define __ACMD(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel, _alias)\
125 __COMMAND(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel);\
126 static const struct cmd *_alias = &__cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden
127 #define COMMAND(section, name, args, cmd, flags, idby, handler, help) \
128 __COMMAND(&(__section ## _ ## section), name, #name, args, cmd, flags, 0, idby, handler, help, NULL)
129 #define COMMAND_ALIAS(section, name, args, cmd, flags, idby, handler, help, selector, alias)\
130 __ACMD(&(__section ## _ ## section), name, #name, args, cmd, flags, 0, idby, handler, help, selector, alias)
131 #define HIDDEN(section, name, args, cmd, flags, idby, handler) \
132 __COMMAND(&(__section ## _ ## section), name, #name, args, cmd, flags, 1, idby, handler, NULL, NULL)
133
134 #define TOPLEVEL(_name, _args, _nlcmd, _flags, _idby, _handler, _help) \
135 struct cmd __section ## _ ## _name = { \
136 .name = (#_name), \
137 .args = (_args), \
138 .cmd = (_nlcmd), \
139 .nl_msg_flags = (_flags), \
140 .idby = (_idby), \
141 .handler = (_handler), \
142 .help = (_help), \
143 }; \
144 static struct cmd *__section ## _ ## _name ## _p \
145 __attribute__((used,section("__cmd"))) = &__section ## _ ## _name
146
147 #define SECTION(_name) \
148 struct cmd __section ## _ ## _name = { \
149 .name = (#_name), \
150 .hidden = 1, \
151 }; \
152 static struct cmd *__section ## _ ## _name ## _p \
153 __attribute__((used,section("__cmd"))) = &__section ## _ ## _name
154
155 #define DECLARE_SECTION(_name) \
156 extern struct cmd __section ## _ ## _name;
157
158 extern const char iw_version[];
159
160 extern int iw_debug;
161
162 int handle_cmd(struct nl80211_state *state, enum id_input idby,
163 int argc, char **argv);
164
165 struct print_event_args {
166 struct timeval ts; /* internal */
167 bool have_ts; /* must be set false */
168 bool frame, time, reltime;
169 };
170
171 __u32 listen_events(struct nl80211_state *state,
172 const int n_waits, const __u32 *waits);
173 int __prepare_listen_events(struct nl80211_state *state);
174 __u32 __do_listen_events(struct nl80211_state *state,
175 const int n_waits, const __u32 *waits,
176 const int n_prints, const __u32 *prints,
177 struct print_event_args *args);
178
179 int valid_handler(struct nl_msg *msg, void *arg);
180 void register_handler(int (*handler)(struct nl_msg *, void *), void *data);
181
182 int mac_addr_a2n(unsigned char *mac_addr, char *arg);
183 void mac_addr_n2a(char *mac_addr, const unsigned char *arg);
184 int parse_hex_mask(char *hexmask, unsigned char **result, size_t *result_len,
185 unsigned char **mask);
186 unsigned char *parse_hex(char *hex, size_t *outlen);
187
188 int parse_keys(struct nl_msg *msg, char **argv[], int *argc);
189 int parse_freqchan(struct chandef *chandef, bool chan, int argc, char **argv, int *parsed);
190 enum nl80211_chan_width str_to_bw(const char *str);
191 int parse_txq_stats(char *buf, int buflen, struct nlattr *tid_stats_attr, int header,
192 int tid, const char *indent);
193 int put_chandef(struct nl_msg *msg, struct chandef *chandef);
194
195 void print_ht_mcs(const __u8 *mcs);
196 void print_ampdu_length(__u8 exponent);
197 void print_ampdu_spacing(__u8 spacing);
198 void print_ht_capability(__u16 cap);
199 void print_vht_info(__u32 capa, const __u8 *mcs);
200 void print_he_info(struct nlattr *nl_iftype);
201
202 char *channel_width_name(enum nl80211_chan_width width);
203 const char *iftype_name(enum nl80211_iftype iftype);
204 const char *command_name(enum nl80211_commands cmd);
205 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
206 int ieee80211_frequency_to_channel(int freq);
207
208 void print_ssid_escaped(const uint8_t len, const uint8_t *data);
209
210 int nl_get_multicast_id(struct nl_sock *sock, const char *family, const char *group);
211
212 char *reg_initiator_to_string(__u8 initiator);
213
214 const char *get_reason_str(uint16_t reason);
215 const char *get_status_str(uint16_t status);
216
217 enum print_ie_type {
218 PRINT_SCAN,
219 PRINT_LINK,
220 };
221
222 #define BIT(x) (1ULL<<(x))
223
224 void print_ies(unsigned char *ie, int ielen, bool unknown,
225 enum print_ie_type ptype);
226
227 void parse_bitrate(struct nlattr *bitrate_attr, char *buf, int buflen);
228 void iw_hexdump(const char *prefix, const __u8 *data, size_t len);
229
230 int get_cf1(const struct chanmode *chanmode, unsigned long freq);
231
232 int parse_random_mac_addr(struct nl_msg *msg, char *addrs);
233
234 #define SCHED_SCAN_OPTIONS "[interval <in_msecs> | scan_plans [<interval_secs:iterations>*] <interval_secs>] " \
235 "[delay <in_secs>] [freqs <freq>+] [matches [ssid <ssid>]+]] [active [ssid <ssid>]+|passive] " \
236 "[randomise[=<addr>/<mask>]]"
237 int parse_sched_scan(struct nl_msg *msg, int *argc, char ***argv);
238
239 DECLARE_SECTION(switch);
240 DECLARE_SECTION(set);
241 DECLARE_SECTION(get);
242
243 void nan_bf(uint8_t idx, uint8_t *bf, uint16_t bf_len, const uint8_t *buf,
244 size_t len);
245
246 char *hex2bin(const char *hex, char *buf);
247
248 #endif /* __IW_H */