gen: Improve header comments, add ability to set Address 3 field for all management frames

1 files changed, 16 insertions, 11 deletions

@@ -22,7 +22,8 @@
  * Set the channel of a libwifi_assoc_resp.
  *
  * @param assoc_resp A libwifi_assoc_resp
- * @param channel The new channel
+ * @param channel    The new channel
+ * @return           Zero on success, or negative error
  */
 int libwifi_set_assoc_resp_channel(struct libwifi_assoc_resp *assoc_resp, uint8_t channel);
 
@@ -30,7 +31,7 @@ int libwifi_set_assoc_resp_channel(struct libwifi_assoc_resp *assoc_resp, uint8_
  * Calculate the length of a given libwifi_assoc_resp
  *
  * @param assoc_resp A libwifi_assoc_resp
- * @return The length of the given assoc_resp
+ * @return           The length of the given assoc_resp, or negative error
  */
 size_t libwifi_get_assoc_resp_length(struct libwifi_assoc_resp *assoc_resp);
 
@@ -40,22 +41,26 @@ size_t libwifi_get_assoc_resp_length(struct libwifi_assoc_resp *assoc_resp);
  * A generated libwifi assoc_resp can be "dumped" into a buffer for packet injection
  * via the libwifi_dump_assoc_resp.
  *
- * @param assoc_resp A libwifi_assoc_resp
- * @param receiver The receiver MAC address, aka address 1
+ * @param assoc_resp  A libwifi_assoc_resp
+ * @param receiver    The receiver MAC address, aka address 1
  * @param transmitter The source MAC address, aka address 2
- * @param channel The desired channel of the assoc_resp
- *
+ * @param address3    The address 3 frame field value, typically the BSSID
+ * @param channel     The desired channel of the assoc_resp
+ * @return            Zero on success, or negative error
  */
-int libwifi_create_assoc_resp(struct libwifi_assoc_resp *assoc_resp, const unsigned char receiver[6],
-                               const unsigned char transmitter[6], uint8_t channel);
+int libwifi_create_assoc_resp(struct libwifi_assoc_resp *assoc_resp,
+                              const unsigned char receiver[6],
+                              const unsigned char transmitter[6],
+                              const unsigned char address3[6],
+                              uint8_t channel);
 
 /**
  * Dump a libwifi_assoc_resp into a raw format for packet injection.
  *
  * @param assoc_resp A libwifi_assoc_resp
- * @param buf The output buffer for the frame data
- * @param buf_len The length of the output buffer
- * @return The length of the dumped assoc_resp
+ * @param buf        The output buffer for the frame data
+ * @param buf_len    The length of the output buffer
+ * @return           The length of the dumped assoc_resp, or negative error
  */
 size_t libwifi_dump_assoc_resp(struct libwifi_assoc_resp *assoc_resp, unsigned char *buf, size_t buf_len);