[PATCH] scsi: cxgb3i: move docs to functions documented

[PATCH] scsi: cxgb3i: move docs to functions documented

[Konstantin Kharlamov]

Move documentation for push_tx_frames near the push_tx_frames function,
and likewise for release_offload_resources.

Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>
---
 drivers/scsi/cxgbi/cxgb3i/cxgb3i.c | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c b/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
index 524cdbcd29aa..6c6b301cb5ec 100644
--- a/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
+++ b/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
@@ -375,6 +375,11 @@ static inline void make_tx_data_wr(struct cxgbi_sock *csk, struct sk_buff *skb,
 	}
 }
 
+static void arp_failure_skb_discard(struct t3cdev *dev, struct sk_buff *skb)
+{
+	kfree_skb(skb);
+}
+
 /**
  * push_tx_frames -- start transmit
  * @c3cn: the offloaded connection
@@ -385,12 +390,6 @@ static inline void make_tx_data_wr(struct cxgbi_sock *csk, struct sk_buff *skb,
  * connection's lock held.  Returns the amount of send buffer space that was
  * freed as a result of sending queued data to T3.
  */
-
-static void arp_failure_skb_discard(struct t3cdev *dev, struct sk_buff *skb)
-{
-	kfree_skb(skb);
-}
-
 static int push_tx_frames(struct cxgbi_sock *csk, int req_completion)
 {
 	int total_size = 0;
@@ -886,11 +885,6 @@ static int alloc_cpls(struct cxgbi_sock *csk)
 	return -ENOMEM;
 }
 
-/**
- * release_offload_resources - release offload resource
- * @c3cn: the offloaded iscsi tcp connection.
- * Release resources held by an offload connection (TID, L2T entry, etc.)
- */
 static void l2t_put(struct cxgbi_sock *csk)
 {
 	struct t3cdev *t3dev = (struct t3cdev *)csk->cdev->lldev;
@@ -902,6 +896,11 @@ static void l2t_put(struct cxgbi_sock *csk)
 	}
 }
 
+/**
+ * release_offload_resources - release offload resource
+ * @c3cn: the offloaded iscsi tcp connection.
+ * Release resources held by an offload connection (TID, L2T entry, etc.)
+ */
 static void release_offload_resources(struct cxgbi_sock *csk)
 {
 	struct t3cdev *t3dev = (struct t3cdev *)csk->cdev->lldev;
-- 
2.26.0

Re: [PATCH] scsi: cxgb3i: move docs to functions documented

[Jakub Kicinski]

On Fri, 10 Apr 2020 20:07:32 +0300 Konstantin Kharlamov wrote:
> Move documentation for push_tx_frames near the push_tx_frames function,
> and likewise for release_offload_resources.
> 
> Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>

While at this could you also update the name of the parameter?
s/c3cn/csk/.

> +/**
> + * release_offload_resources - release offload resource
> + * @c3cn: the offloaded iscsi tcp connection.
> + * Release resources held by an offload connection (TID, L2T entry, etc.)
> + */
>  static void release_offload_resources(struct cxgbi_sock *csk)

Re: [PATCH] scsi: cxgb3i: move docs to functions documented

[Konstantin Kharlamov]

Thanks, good point! On my way.

On 11.04.2020 04:42, Jakub Kicinski wrote:
> On Fri, 10 Apr 2020 20:07:32 +0300 Konstantin Kharlamov wrote:
>> Move documentation for push_tx_frames near the push_tx_frames function,
>> and likewise for release_offload_resources.
>>
>> Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>
> 
> While at this could you also update the name of the parameter?
> s/c3cn/csk/.
> 
>> +/**
>> + * release_offload_resources - release offload resource
>> + * @c3cn: the offloaded iscsi tcp connection.
>> + * Release resources held by an offload connection (TID, L2T entry, etc.)
>> + */
>>   static void release_offload_resources(struct cxgbi_sock *csk)

[PATCH v2] scsi: cxgb3i: fix documentation for two functions

[Konstantin Kharlamov]

Move documentation for push_tx_frames near the push_tx_frames function,
and likewise for release_offload_resources.

And while at it, fix parameter name s/c3cn/csk in the docs.

Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>
---

v2: Jakub Kicinski: fix parameter name s/c3cn/csk

 drivers/scsi/cxgbi/cxgb3i/cxgb3i.c | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c b/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
index 524cdbcd29aa..92e163decafd 100644
--- a/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
+++ b/drivers/scsi/cxgbi/cxgb3i/cxgb3i.c
@@ -375,9 +375,14 @@ static inline void make_tx_data_wr(struct cxgbi_sock *csk, struct sk_buff *skb,
 	}
 }
 
+static void arp_failure_skb_discard(struct t3cdev *dev, struct sk_buff *skb)
+{
+	kfree_skb(skb);
+}
+
 /**
  * push_tx_frames -- start transmit
- * @c3cn: the offloaded connection
+ * @csk: the offloaded connection
  * @req_completion: request wr_ack or not
  *
  * Prepends TX_DATA_WR or CPL_CLOSE_CON_REQ headers to buffers waiting in a
@@ -385,12 +390,6 @@ static inline void make_tx_data_wr(struct cxgbi_sock *csk, struct sk_buff *skb,
  * connection's lock held.  Returns the amount of send buffer space that was
  * freed as a result of sending queued data to T3.
  */
-
-static void arp_failure_skb_discard(struct t3cdev *dev, struct sk_buff *skb)
-{
-	kfree_skb(skb);
-}
-
 static int push_tx_frames(struct cxgbi_sock *csk, int req_completion)
 {
 	int total_size = 0;
@@ -886,11 +885,6 @@ static int alloc_cpls(struct cxgbi_sock *csk)
 	return -ENOMEM;
 }
 
-/**
- * release_offload_resources - release offload resource
- * @c3cn: the offloaded iscsi tcp connection.
- * Release resources held by an offload connection (TID, L2T entry, etc.)
- */
 static void l2t_put(struct cxgbi_sock *csk)
 {
 	struct t3cdev *t3dev = (struct t3cdev *)csk->cdev->lldev;
@@ -902,6 +896,11 @@ static void l2t_put(struct cxgbi_sock *csk)
 	}
 }
 
+/**
+ * release_offload_resources - release offload resource
+ * @csk: the offloaded iscsi tcp connection.
+ * Release resources held by an offload connection (TID, L2T entry, etc.)
+ */
 static void release_offload_resources(struct cxgbi_sock *csk)
 {
 	struct t3cdev *t3dev = (struct t3cdev *)csk->cdev->lldev;
-- 
2.26.0