Commit b37ca87f authored by Johannes Berg's avatar Johannes Berg Committed by Luca Coelho

iwlwifi: fw api: fix various kernel-doc warnings

Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
parent d172a5ef
...@@ -112,15 +112,24 @@ static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version) ...@@ -112,15 +112,24 @@ static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version)
#define IWL_ALWAYS_LONG_GROUP 1 #define IWL_ALWAYS_LONG_GROUP 1
/** /**
* struct iwl_cmd_header * struct iwl_cmd_header - (short) command header format
* *
* This header format appears in the beginning of each command sent from the * This header format appears in the beginning of each command sent from the
* driver, and each response/notification received from uCode. * driver, and each response/notification received from uCode.
*/ */
struct iwl_cmd_header { struct iwl_cmd_header {
u8 cmd; /* Command ID: REPLY_RXON, etc. */ /**
* @cmd: Command ID: REPLY_RXON, etc.
*/
u8 cmd;
/**
* @group_id: group ID, for commands with groups
*/
u8 group_id; u8 group_id;
/* /**
* @sequence:
* Sequence number for the command.
*
* The driver sets up the sequence number to values of its choosing. * The driver sets up the sequence number to values of its choosing.
* uCode does not use this value, but passes it back to the driver * uCode does not use this value, but passes it back to the driver
* when sending the response to each driver-originated command, so * when sending the response to each driver-originated command, so
...@@ -150,6 +159,13 @@ struct iwl_cmd_header { ...@@ -150,6 +159,13 @@ struct iwl_cmd_header {
* driver, and each response/notification received from uCode. * driver, and each response/notification received from uCode.
* this is the wide version that contains more information about the command * this is the wide version that contains more information about the command
* like length, version and command type * like length, version and command type
*
* @cmd: command ID, like in &struct iwl_cmd_header
* @group_id: group ID, like in &struct iwl_cmd_header
* @sequence: sequence, like in &struct iwl_cmd_header
* @length: length of the command
* @reserved: reserved
* @version: command version
*/ */
struct iwl_cmd_header_wide { struct iwl_cmd_header_wide {
u8 cmd; u8 cmd;
......
...@@ -112,7 +112,7 @@ enum iwl_mvm_tx_fifo { ...@@ -112,7 +112,7 @@ enum iwl_mvm_tx_fifo {
}; };
/** /**
* iwl_tx_queue_cfg_actions - TXQ config options * enum iwl_tx_queue_cfg_actions - TXQ config options
* @TX_QUEUE_CFG_ENABLE_QUEUE: enable a queue * @TX_QUEUE_CFG_ENABLE_QUEUE: enable a queue
* @TX_QUEUE_CFG_TFD_SHORT_FORMAT: use short TFD format * @TX_QUEUE_CFG_TFD_SHORT_FORMAT: use short TFD format
*/ */
...@@ -145,6 +145,7 @@ struct iwl_tx_queue_cfg_cmd { ...@@ -145,6 +145,7 @@ struct iwl_tx_queue_cfg_cmd {
* @queue_number: queue number assigned to this RA -TID * @queue_number: queue number assigned to this RA -TID
* @flags: set on failure * @flags: set on failure
* @write_pointer: initial value for write pointer * @write_pointer: initial value for write pointer
* @reserved: reserved
*/ */
struct iwl_tx_queue_cfg_rsp { struct iwl_tx_queue_cfg_rsp {
__le16 queue_number; __le16 queue_number;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment