]> git.ipfire.org Git - thirdparty/iw.git/blame - iw.h
iw: Make input to mac_addr_n2a() const
[thirdparty/iw.git] / iw.h
CommitLineData
cad53b3f
JB
1#ifndef __IW_H
2#define __IW_H
3
7fabd346 4#include <stdbool.h>
45d543f0 5#include <netlink/netlink.h>
cad53b3f
JB
6#include <netlink/genl/genl.h>
7#include <netlink/genl/family.h>
8#include <netlink/genl/ctrl.h>
a82abc2c 9#include <endian.h>
cad53b3f 10
f408e01b 11#include "nl80211.h"
a82abc2c 12#include "ieee80211.h"
f408e01b 13
3a807325
JB
14/* support for extack if compilation headers are too old */
15#ifndef NETLINK_EXT_ACK
16#define NETLINK_EXT_ACK 11
17enum 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
86da57ad
JB
33#ifndef SOL_NETLINK
34#define SOL_NETLINK 270
35#endif
3a807325 36
3d1e8704 37#define ETH_ALEN 6
386bacb2 38#define VHT_MUMIMO_GROUP_LEN 24
3d1e8704 39
ded667b0
YY
40/* libnl 1.x compatibility code */
41#if !defined(CONFIG_LIBNL20) && !defined(CONFIG_LIBNL30)
57077d64 42# define nl_sock nl_handle
dfd13ee5 43#endif
57077d64
PE
44
45struct nl80211_state {
46 struct nl_sock *nl_sock;
f09cee6d 47 int nl80211_id;
cad53b3f
JB
48};
49
bd396f2a
JB
50enum command_identify_by {
51 CIB_NONE,
52 CIB_PHY,
53 CIB_NETDEV,
290a3dd4 54 CIB_WDEV,
7c37a24d
JB
55};
56
57enum id_input {
58 II_NONE,
59 II_NETDEV,
60 II_PHY_NAME,
61 II_PHY_IDX,
290a3dd4 62 II_WDEV,
bd396f2a 63};
45c7212c 64
b2c4bf45 65#define HANDLER_RET_USAGE 1
94af668b
JB
66#define HANDLER_RET_DONE 3
67
bd396f2a 68struct cmd {
bd396f2a
JB
69 const char *name;
70 const char *args;
01ae06f9 71 const char *help;
bd396f2a
JB
72 const enum nl80211_commands cmd;
73 int nl_msg_flags;
ce5af55c 74 int hidden;
bd396f2a 75 const enum command_identify_by idby;
5e75fd04
JB
76 /*
77 * The handler should return a negative error code,
86a9801f
OO
78 * zero on success, 1 if the arguments were wrong.
79 * Return 2 iff you provide the error message yourself.
5e75fd04 80 */
7c37a24d 81 int (*handler)(struct nl80211_state *state,
bd396f2a 82 struct nl_msg *msg,
05514f95
JB
83 int argc, char **argv,
84 enum id_input id);
1633ddf7 85 const struct cmd *(*selector)(int argc, char **argv);
4698bfc2 86 const struct cmd *parent;
bd396f2a 87};
3d1e8704 88
c1b2b633
SE
89struct chanmode {
90 const char *name;
91 unsigned int width;
92 int freq1_diff;
93 int chantype; /* for older kernel */
94};
95
997c60fd
BB
96struct 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
7d736016 104#define ARRAY_SIZE(ar) (sizeof(ar)/sizeof(ar[0]))
3ff24563 105#define DIV_ROUND_UP(x, y) (((x) + (y - 1)) / (y))
7d736016 106
1633ddf7 107#define __COMMAND(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel)\
78bebb71 108 static struct cmd \
9b92e691
JB
109 __cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden\
110 __attribute__((used)) __attribute__((section("__cmd"))) = { \
9b92e691
JB
111 .name = (_name), \
112 .args = (_args), \
113 .cmd = (_nlcmd), \
114 .nl_msg_flags = (_flags), \
115 .hidden = (_hidden), \
116 .idby = (_idby), \
117 .handler = (_handler), \
01ae06f9 118 .help = (_help), \
4698bfc2 119 .parent = _section, \
1633ddf7
JB
120 .selector = (_sel), \
121 }
122#define __ACMD(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel, _alias)\
123 __COMMAND(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help, _sel);\
124 static const struct cmd *_alias = &__cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden
01ae06f9 125#define COMMAND(section, name, args, cmd, flags, idby, handler, help) \
1633ddf7
JB
126 __COMMAND(&(__section ## _ ## section), name, #name, args, cmd, flags, 0, idby, handler, help, NULL)
127#define COMMAND_ALIAS(section, name, args, cmd, flags, idby, handler, help, selector, alias)\
128 __ACMD(&(__section ## _ ## section), name, #name, args, cmd, flags, 0, idby, handler, help, selector, alias)
01ae06f9 129#define HIDDEN(section, name, args, cmd, flags, idby, handler) \
1633ddf7 130 __COMMAND(&(__section ## _ ## section), name, #name, args, cmd, flags, 1, idby, handler, NULL, NULL)
4698bfc2
JB
131
132#define TOPLEVEL(_name, _args, _nlcmd, _flags, _idby, _handler, _help) \
78bebb71 133 struct cmd \
4698bfc2
JB
134 __section ## _ ## _name \
135 __attribute__((used)) __attribute__((section("__cmd"))) = { \
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#define SECTION(_name) \
78bebb71 145 struct cmd __section ## _ ## _name \
4698bfc2
JB
146 __attribute__((used)) __attribute__((section("__cmd"))) = { \
147 .name = (#_name), \
148 .hidden = 1, \
149 }
150
151#define DECLARE_SECTION(_name) \
78bebb71 152 extern struct cmd __section ## _ ## _name;
14a0380d 153
133b069f 154extern const char iw_version[];
7c37a24d 155
957a0f07
JB
156extern int iw_debug;
157
7c37a24d
JB
158int handle_cmd(struct nl80211_state *state, enum id_input idby,
159 int argc, char **argv);
7fabd346
JB
160
161struct print_event_args {
981b21ad
JB
162 struct timeval ts; /* internal */
163 bool have_ts; /* must be set false */
164 bool frame, time, reltime;
7fabd346
JB
165};
166
72041aa0
JB
167__u32 listen_events(struct nl80211_state *state,
168 const int n_waits, const __u32 *waits);
ee374e4d
JB
169int __prepare_listen_events(struct nl80211_state *state);
170__u32 __do_listen_events(struct nl80211_state *state,
171 const int n_waits, const __u32 *waits,
172 struct print_event_args *args);
7c37a24d 173
34b23014
JB
174int valid_handler(struct nl_msg *msg, void *arg);
175void register_handler(int (*handler)(struct nl_msg *, void *), void *data);
7c37a24d 176
3d1e8704 177int mac_addr_a2n(unsigned char *mac_addr, char *arg);
7f87d3cf 178void mac_addr_n2a(char *mac_addr, const unsigned char *arg);
3ff24563
JB
179int parse_hex_mask(char *hexmask, unsigned char **result, size_t *result_len,
180 unsigned char **mask);
236d4191 181unsigned char *parse_hex(char *hex, size_t *outlen);
3d1e8704 182
51e9bd80 183int parse_keys(struct nl_msg *msg, char **argv, int argc);
997c60fd 184int parse_freqchan(struct chandef *chandef, bool chan, int argc, char **argv, int *parsed);
c37f6c64 185enum nl80211_chan_width str_to_bw(const char *str);
910792c0
THJ
186int parse_txq_stats(char *buf, int buflen, struct nlattr *tid_stats_attr, int header,
187 int tid, const char *indent);
997c60fd 188int put_chandef(struct nl_msg *msg, struct chandef *chandef);
51e9bd80 189
7ddfb679 190void print_ht_mcs(const __u8 *mcs);
0950993f
LR
191void print_ampdu_length(__u8 exponent);
192void print_ampdu_spacing(__u8 spacing);
357c1a5d 193void print_ht_capability(__u16 cap);
54eb1613 194void print_vht_info(__u32 capa, const __u8 *mcs);
deb3501c 195
c5df9eb6 196char *channel_width_name(enum nl80211_chan_width width);
541ef425 197const char *iftype_name(enum nl80211_iftype iftype);
9990c1e9 198const char *command_name(enum nl80211_commands cmd);
58b46da2 199int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
379f8397 200int ieee80211_frequency_to_channel(int freq);
541ef425 201
748f8489
JB
202void print_ssid_escaped(const uint8_t len, const uint8_t *data);
203
57077d64 204int nl_get_multicast_id(struct nl_sock *sock, const char *family, const char *group);
2c61ba61 205
601c6ab2
LR
206char *reg_initiator_to_string(__u8 initiator);
207
27c49ed6 208const char *get_reason_str(uint16_t reason);
22c7d879 209const char *get_status_str(uint16_t status);
27c49ed6 210
febeb0c0
JB
211enum print_ie_type {
212 PRINT_SCAN,
213 PRINT_LINK,
214};
215
216#define BIT(x) (1ULL<<(x))
217
218void print_ies(unsigned char *ie, int ielen, bool unknown,
219 enum print_ie_type ptype);
220
e94f0201 221void parse_bitrate(struct nlattr *bitrate_attr, char *buf, int buflen);
492354de 222void iw_hexdump(const char *prefix, const __u8 *data, size_t len);
4698bfc2 223
c1b2b633
SE
224int get_cf1(const struct chanmode *chanmode, unsigned long freq);
225
9ae0d103
AS
226#define SCHED_SCAN_OPTIONS "[interval <in_msecs> | scan_plans [<interval_secs:iterations>*] <interval_secs>] " \
227 "[delay <in_secs>] [freqs <freq>+] [matches [ssid <ssid>]+]] [active [ssid <ssid>]+|passive] " \
228 "[randomise[=<addr>/<mask>]]"
b1622287
LC
229int parse_sched_scan(struct nl_msg *msg, int *argc, char ***argv);
230
444674c8 231DECLARE_SECTION(switch);
4698bfc2
JB
232DECLARE_SECTION(set);
233DECLARE_SECTION(get);
234
60b6c638
IP
235char *hex2bin(const char *hex, char *buf);
236
cad53b3f 237#endif /* __IW_H */