1 files changed, 39 insertions, 2 deletions

@@ -20,11 +20,48 @@
 #include "../../core/frame/management/common.h"
 #include "../../core/frame/management/reassoc_request.h"
 
-int libwifi_create_reassoc_req(struct libwifi_reassoc_req *reassoc_req, const unsigned char receiver[6],
-                               const unsigned char transmitter[6], const unsigned char current_ap[6],
+/**
+ * Create a new libwifi reassociation request
+ *
+ * @param reassoc_req   A new libwifi_reassoc_req struct
+ * @param receiver      The receiver MAC address
+ * @param transmitter   The transmitter MAC address
+ * @param address3      The address 3 frame field value, typically the BSSID
+ * @param current_ap    The current AP BSSID
+ * @param ssid          The desired BSS SSID
+ * @param channel       The desired channel
+ * @return              Zero on success, or negative error
+ */
+int libwifi_create_reassoc_req(struct libwifi_reassoc_req *reassoc_req,
+                               const unsigned char receiver[6],
+                               const unsigned char transmitter[6],
+                               const unsigned char address3[6],
+                               const unsigned char current_ap[6],
                                const char *ssid, uint8_t channel);
+
+/**
+ * Get the length of a given libwifi_reassoc_req
+ *
+ * @param reassoc_req A libwifi_reassoc_req struct
+ * @return            The length of the given libwifi_reassoc_req, or negative error
+ */
 size_t libwifi_get_reassoc_req_length(struct libwifi_reassoc_req *reassoc_req);
+
+/**
+ * Dump a libwifi_reassoc_req into a raw format for packet injection.
+ *
+ * @param reassoc_req A libwifi_reassoc_req struct
+ * @param buf         The buffer to dump into
+ * @param buf_len     The length of the supplied buffer
+ * @return            The amount of bytes dumped, or negative error
+ */
 size_t libwifi_dump_reassoc_req(struct libwifi_reassoc_req *reassoc_req, unsigned char *buf, size_t buf_len);
+
+/**
+ * Free any memory claimed by a libwifi_reassoc_req back to the system.
+ *
+ * @param reassoc_req A libwifi_reassoc_req
+ */
 void libwifi_free_reassoc_req(struct libwifi_reassoc_req *reassoc_req);
 
 #endif /* LIBWIFI_GEN_REASSOCREQUEST_H */