]> git.ipfire.org Git - thirdparty/iw.git/blob - iw.h
add ability to document commands, document event/help
[thirdparty/iw.git] / iw.h
1 #ifndef __IW_H
2 #define __IW_H
3
4 #include <netlink/netlink.h>
5 #include <netlink/genl/genl.h>
6 #include <netlink/genl/family.h>
7 #include <netlink/genl/ctrl.h>
8
9 #include "nl80211.h"
10
11 #define ETH_ALEN 6
12
13 #ifndef CONFIG_LIBNL20
14 # define nl_sock nl_handle
15 #endif
16
17 struct nl80211_state {
18 struct nl_sock *nl_sock;
19 struct nl_cache *nl_cache;
20 struct genl_family *nl80211;
21 };
22
23 enum command_identify_by {
24 CIB_NONE,
25 CIB_PHY,
26 CIB_NETDEV,
27 };
28
29 enum id_input {
30 II_NONE,
31 II_NETDEV,
32 II_PHY_NAME,
33 II_PHY_IDX,
34 };
35
36 struct cmd {
37 const char *section;
38 const char *name;
39 const char *args;
40 const char *help;
41 const enum nl80211_commands cmd;
42 int nl_msg_flags;
43 int hidden;
44 const enum command_identify_by idby;
45 /*
46 * The handler should return a negative error code,
47 * zero on success, 1 if the arguments were wrong
48 * and the usage message should and 2 otherwise.
49 */
50 int (*handler)(struct nl80211_state *state,
51 struct nl_cb *cb,
52 struct nl_msg *msg,
53 int argc, char **argv);
54 };
55
56 #define ARRAY_SIZE(ar) (sizeof(ar)/sizeof(ar[0]))
57
58 #define __COMMAND(_section, _symname, _name, _args, _nlcmd, _flags, _hidden, _idby, _handler, _help)\
59 static const struct cmd \
60 __cmd ## _ ## _symname ## _ ## _handler ## _ ## _nlcmd ## _ ## _idby ## _ ## _hidden\
61 __attribute__((used)) __attribute__((section("__cmd"))) = { \
62 .section = (_section), \
63 .name = (_name), \
64 .args = (_args), \
65 .cmd = (_nlcmd), \
66 .nl_msg_flags = (_flags), \
67 .hidden = (_hidden), \
68 .idby = (_idby), \
69 .handler = (_handler), \
70 .help = (_help), \
71 }
72 #define COMMAND(section, name, args, cmd, flags, idby, handler, help) \
73 __COMMAND(#section, name, #name, args, cmd, flags, 0, idby, handler, help)
74 #define HIDDEN(section, name, args, cmd, flags, idby, handler) \
75 __COMMAND(#section, name, #name, args, cmd, flags, 1, idby, handler, NULL)
76 #define TOPLEVEL(name, args, cmd, flags, idby, handler, help) \
77 __COMMAND(NULL, name, #name, args, cmd, flags, 0, idby, handler, help)
78 extern struct cmd __start___cmd;
79 extern struct cmd __stop___cmd;
80
81 extern const char iw_version[];
82
83 extern int iw_debug;
84
85 int handle_cmd(struct nl80211_state *state, enum id_input idby,
86 int argc, char **argv);
87 __u32 listen_events(struct nl80211_state *state,
88 const int n_waits, const __u32 *waits);
89
90
91 int mac_addr_a2n(unsigned char *mac_addr, char *arg);
92 int mac_addr_n2a(char *mac_addr, unsigned char *arg);
93
94 const char *iftype_name(enum nl80211_iftype iftype);
95 int ieee80211_channel_to_frequency(int chan);
96 int ieee80211_frequency_to_channel(int freq);
97
98 int nl_get_multicast_id(struct nl_sock *sock, const char *family, const char *group);
99
100 char *reg_initiator_to_string(__u8 initiator);
101
102 const char *get_reason_str(uint16_t reason);
103 const char *get_status_str(uint16_t status);
104
105 #endif /* __IW_H */