Commit b1b6c110 authored by Luo bin's avatar Luo bin Committed by David S. Miller

hinic: improve the comments of function header

Fix the warnings about function header comments when building hinic
driver with "W=1" option.
Signed-off-by: default avatarLuo bin <luobin9@huawei.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 6d772f32
...@@ -784,7 +784,7 @@ static void free_cmdq(struct hinic_cmdq *cmdq) ...@@ -784,7 +784,7 @@ static void free_cmdq(struct hinic_cmdq *cmdq)
* init_cmdqs_ctxt - write the cmdq ctxt to HW after init all cmdq * init_cmdqs_ctxt - write the cmdq ctxt to HW after init all cmdq
* @hwdev: the NIC HW device * @hwdev: the NIC HW device
* @cmdqs: cmdqs to write the ctxts for * @cmdqs: cmdqs to write the ctxts for
* &db_area: db_area for all the cmdqs * @db_area: db_area for all the cmdqs
* *
* Return 0 - Success, negative - Failure * Return 0 - Success, negative - Failure
**/ **/
......
...@@ -437,6 +437,8 @@ static int get_base_qpn(struct hinic_hwdev *hwdev, u16 *base_qpn) ...@@ -437,6 +437,8 @@ static int get_base_qpn(struct hinic_hwdev *hwdev, u16 *base_qpn)
/** /**
* hinic_hwdev_ifup - Preparing the HW for passing IO * hinic_hwdev_ifup - Preparing the HW for passing IO
* @hwdev: the NIC HW device * @hwdev: the NIC HW device
* @sq_depth: the send queue depth
* @rq_depth: the receive queue depth
* *
* Return 0 - Success, negative - Failure * Return 0 - Success, negative - Failure
**/ **/
...@@ -582,6 +584,7 @@ void hinic_hwdev_cb_unregister(struct hinic_hwdev *hwdev, ...@@ -582,6 +584,7 @@ void hinic_hwdev_cb_unregister(struct hinic_hwdev *hwdev,
/** /**
* nic_mgmt_msg_handler - nic mgmt event handler * nic_mgmt_msg_handler - nic mgmt event handler
* @handle: private data for the handler * @handle: private data for the handler
* @cmd: message command
* @buf_in: input buffer * @buf_in: input buffer
* @in_size: input size * @in_size: input size
* @buf_out: output buffer * @buf_out: output buffer
...@@ -909,6 +912,7 @@ int hinic_set_interrupt_cfg(struct hinic_hwdev *hwdev, ...@@ -909,6 +912,7 @@ int hinic_set_interrupt_cfg(struct hinic_hwdev *hwdev,
/** /**
* hinic_init_hwdev - Initialize the NIC HW * hinic_init_hwdev - Initialize the NIC HW
* @pdev: the NIC pci device * @pdev: the NIC pci device
* @devlink: the poniter of hinic devlink
* *
* Return initialized NIC HW device * Return initialized NIC HW device
* *
...@@ -1121,7 +1125,7 @@ int hinic_hwdev_msix_cnt_set(struct hinic_hwdev *hwdev, u16 msix_index) ...@@ -1121,7 +1125,7 @@ int hinic_hwdev_msix_cnt_set(struct hinic_hwdev *hwdev, u16 msix_index)
* @msix_index: msix_index * @msix_index: msix_index
* @pending_limit: the maximum pending interrupt events (unit 8) * @pending_limit: the maximum pending interrupt events (unit 8)
* @coalesc_timer: coalesc period for interrupt (unit 8 us) * @coalesc_timer: coalesc period for interrupt (unit 8 us)
* @lli_timer: replenishing period for low latency credit (unit 8 us) * @lli_timer_cfg: replenishing period for low latency credit (unit 8 us)
* @lli_credit_limit: maximum credits for low latency msix messages (unit 8) * @lli_credit_limit: maximum credits for low latency msix messages (unit 8)
* @resend_timer: maximum wait for resending msix (unit coalesc period) * @resend_timer: maximum wait for resending msix (unit coalesc period)
* *
......
...@@ -188,6 +188,7 @@ static u8 eq_cons_idx_checksum_set(u32 val) ...@@ -188,6 +188,7 @@ static u8 eq_cons_idx_checksum_set(u32 val)
/** /**
* eq_update_ci - update the HW cons idx of event queue * eq_update_ci - update the HW cons idx of event queue
* @eq: the event queue to update the cons idx for * @eq: the event queue to update the cons idx for
* @arm_state: the arm bit value of eq's interrupt
**/ **/
static void eq_update_ci(struct hinic_eq *eq, u32 arm_state) static void eq_update_ci(struct hinic_eq *eq, u32 arm_state)
{ {
...@@ -368,7 +369,7 @@ static void eq_irq_work(struct work_struct *work) ...@@ -368,7 +369,7 @@ static void eq_irq_work(struct work_struct *work)
/** /**
* ceq_tasklet - the tasklet of the EQ that received the event * ceq_tasklet - the tasklet of the EQ that received the event
* @ceq_data: the eq * @t: the tasklet struct pointer
**/ **/
static void ceq_tasklet(struct tasklet_struct *t) static void ceq_tasklet(struct tasklet_struct *t)
{ {
......
...@@ -230,6 +230,7 @@ static int wait_hwif_ready(struct hinic_hwif *hwif) ...@@ -230,6 +230,7 @@ static int wait_hwif_ready(struct hinic_hwif *hwif)
* @hwif: the HW interface of a pci function device * @hwif: the HW interface of a pci function device
* @attr0: the first attribute that was read from the hw * @attr0: the first attribute that was read from the hw
* @attr1: the second attribute that was read from the hw * @attr1: the second attribute that was read from the hw
* @attr2: the third attribute that was read from the hw
**/ **/
static void set_hwif_attr(struct hinic_hwif *hwif, u32 attr0, u32 attr1, static void set_hwif_attr(struct hinic_hwif *hwif, u32 attr0, u32 attr1,
u32 attr2) u32 attr2)
......
...@@ -238,6 +238,7 @@ static int send_msg_to_mgmt(struct hinic_pf_to_mgmt *pf_to_mgmt, ...@@ -238,6 +238,7 @@ static int send_msg_to_mgmt(struct hinic_pf_to_mgmt *pf_to_mgmt,
* @out_size: response length * @out_size: response length
* @direction: the direction of the original message * @direction: the direction of the original message
* @resp_msg_id: msg id to response for * @resp_msg_id: msg id to response for
* @timeout: time-out period of waiting for response
* *
* Return 0 - Success, negative - Failure * Return 0 - Success, negative - Failure
**/ **/
......
...@@ -990,7 +990,7 @@ static void hinic_refresh_nic_cfg(struct hinic_dev *nic_dev) ...@@ -990,7 +990,7 @@ static void hinic_refresh_nic_cfg(struct hinic_dev *nic_dev)
* @handle: nic device for the handler * @handle: nic device for the handler
* @buf_in: input buffer * @buf_in: input buffer
* @in_size: input size * @in_size: input size
* @buf_in: output buffer * @buf_out: output buffer
* @out_size: returned output size * @out_size: returned output size
* *
* Return 0 - Success, negative - Failure * Return 0 - Success, negative - Failure
......
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