Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 90793f71 authored by Dennis Dalessandro's avatar Dennis Dalessandro Committed by Doug Ledford
Browse files

IB/rdmavt: Clean up comments and add more documentation 



Add, remove, and otherwise clean up existing comments that are leftover
from the initial code postings of rdmavt. Many of the comments were added
to provide an idea on the direction we were thinking of going. Now that the
design is solidified make a pass over and clean everything up. Also add
details where lacking.

Ensure all non static functions have nano comments.

Reviewed-by: default avatarJubin John <jubin.john@intel.com>
Signed-off-by: default avatarDennis Dalessandro <dennis.dalessandro@intel.com>
Signed-off-by: default avatarDoug Ledford <dledford@redhat.com>
parent 0ec79e87

drivers/infiniband/sw/rdmavt/ah.c

+27 −0
Original line number Diff line number Diff line
@@ -53,6 +53,11 @@ 
 * rvt_check_ah - validate the attributes of AH

 * @ibdev: the ib device

 * @ah_attr: the attributes of the AH

 *

 * If driver supports a more detailed check_ah function call back to it

 * otherwise just check the basics.

 *

 * Return: 0 on success

 */

int rvt_check_ah(struct ib_device *ibdev,

		 struct ib_ah_attr *ah_attr)
@@ -95,6 +100,8 @@ EXPORT_SYMBOL(rvt_check_ah); 
 * @ah_attr: the attributes of the AH

 *

 * This may be called from interrupt context.

 *

 * Return: newly allocated ah

 */

struct ib_ah *rvt_create_ah(struct ib_pd *pd,

			    struct ib_ah_attr *ah_attr)
@@ -129,6 +136,12 @@ struct ib_ah *rvt_create_ah(struct ib_pd *pd, 
	return &ah->ibah;

}



/**

 * rvt_destory_ah - Destory an address handle

 * @ibah: address handle

 *

 * Return: 0 on success

 */

int rvt_destroy_ah(struct ib_ah *ibah)

{

	struct rvt_dev_info *dev = ib_to_rvt(ibah->device);
@@ -147,6 +160,13 @@ int rvt_destroy_ah(struct ib_ah *ibah) 
	return 0;

}



/**

 * rvt_modify_ah - modify an ah with given attrs

 * @ibah: address handle to modify

 * @ah_attr: attrs to apply

 *

 * Return: 0 on success

 */

int rvt_modify_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr)

{

	struct rvt_ah *ah = ibah_to_rvtah(ibah);
@@ -159,6 +179,13 @@ int rvt_modify_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr) 
	return 0;

}



/**

 * rvt_query_ah - return attrs for ah

 * @ibah: address handle to query

 * @ah_attr: return info in this

 *

 * Return: always 0

 */

int rvt_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr)

{

	struct rvt_ah *ah = ibah_to_rvtah(ibah);

drivers/infiniband/sw/rdmavt/cq.c

+20 −10
Original line number Diff line number Diff line
@@ -173,10 +173,10 @@ static void send_complete(struct kthread_work *work) 
 * @context: unused by the QLogic_IB driver

 * @udata: user data for libibverbs.so

 *

 * Returns a pointer to the completion queue or negative errno values

 * for failure.

 *

 * Called by ib_create_cq() in the generic verbs code.

 *

 * Return: pointer to the completion queue or negative errno values

 * for failure.

 */

struct ib_cq *rvt_create_cq(struct ib_device *ibdev,

			    const struct ib_cq_init_attr *attr,
@@ -286,9 +286,9 @@ struct ib_cq *rvt_create_cq(struct ib_device *ibdev, 
 * rvt_destroy_cq - destroy a completion queue

 * @ibcq: the completion queue to destroy.

 *

 * Returns 0 for success.

 *

 * Called by ib_destroy_cq() in the generic verbs code.

 *

 * Return: always 0

 */

int rvt_destroy_cq(struct ib_cq *ibcq)

{
@@ -313,10 +313,10 @@ int rvt_destroy_cq(struct ib_cq *ibcq) 
 * @ibcq: the completion queue

 * @notify_flags: the type of notification to request

 *

 * Returns 0 for success.

 *

 * This may be called from interrupt context.  Also called by

 * ib_req_notify_cq() in the generic verbs code.

 *

 * Return: 0 for success.

 */

int rvt_req_notify_cq(struct ib_cq *ibcq, enum ib_cq_notify_flags notify_flags)

{
@@ -345,7 +345,7 @@ int rvt_req_notify_cq(struct ib_cq *ibcq, enum ib_cq_notify_flags notify_flags) 
 * rvt_resize_cq - change the size of the CQ

 * @ibcq: the completion queue

 *

 * Returns 0 for success.

 * Return: 0 for success.

 */

int rvt_resize_cq(struct ib_cq *ibcq, int cqe, struct ib_udata *udata)

{
@@ -456,10 +456,10 @@ int rvt_resize_cq(struct ib_cq *ibcq, int cqe, struct ib_udata *udata) 
 * @num_entries: the maximum number of entries to return

 * @entry: pointer to array where work completions are placed

 *

 * Returns the number of completion entries polled.

 *

 * This may be called from interrupt context.  Also called by ib_poll_cq()

 * in the generic verbs code.

 *

 * Return: the number of completion entries polled.

 */

int rvt_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *entry)

{
@@ -496,6 +496,12 @@ int rvt_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *entry) 
	return npolled;

}



/**

 * rvt_driver_cq_init - Init cq resources on behalf of driver

 * @rdi: rvt dev structure

 *

 * Return: 0 on success

 */

int rvt_driver_cq_init(struct rvt_dev_info *rdi)

{

	int ret = 0;
@@ -530,6 +536,10 @@ int rvt_driver_cq_init(struct rvt_dev_info *rdi) 
	return ret;

}



/**

 * rvt_cq_exit - tear down cq reources

 * @rdi: rvt dev structure

 */

void rvt_cq_exit(struct rvt_dev_info *rdi)

{

	struct kthread_worker *worker;

drivers/infiniband/sw/rdmavt/mad.c

+20 −10
Original line number Diff line number Diff line
@@ -59,14 +59,13 @@ 
 * @in_mad: the incoming MAD

 * @out_mad: any outgoing MAD reply

 *

 * Returns IB_MAD_RESULT_SUCCESS if this is a MAD that we are not

 * interested in processing.

 *

 * Note that the verbs framework has already done the MAD sanity checks,

 * and hop count/pointer updating for IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE

 * MADs.

 *

 * This is called by the ib_mad module.

 *

 * Return: IB_MAD_RESULT_SUCCESS or error

 */

int rvt_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num,

		    const struct ib_wc *in_wc, const struct ib_grh *in_grh,
@@ -75,13 +74,10 @@ int rvt_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num, 
		    u16 *out_mad_pkey_index)

{

	/*

	 * Drivers will need to provide a number of things. For exmaple counters

	 * will need to be maintained by the driver but shoud live in the rvt

	 * structure. More study will be needed to finalize the interface

	 * between drivers and rvt for mad packets.

	 *

	 *VT-DRIVER-API: ????

	 *

	 * MAD processing is quite different between hfi1 and qib. Therfore this

	 * is expected to be provided by the driver. Other drivers in the future

	 * may chose to implement this but it should not be made into a

	 * requirement.

	 */

	if (ibport_num_to_idx(ibdev, port_num) < 0)

		return -EINVAL;
@@ -95,6 +91,14 @@ static void rvt_send_mad_handler(struct ib_mad_agent *agent, 
	ib_free_send_mad(mad_send_wc->send_buf);

}



/**

 * rvt_create_mad_agents - create mad agents

 * @rdi: rvt dev struct

 *

 * If driver needs to be notified of mad agent creation then call back

 *

 * Return 0 on success

 */

int rvt_create_mad_agents(struct rvt_dev_info *rdi)

{

	struct ib_mad_agent *agent;
@@ -136,6 +140,12 @@ int rvt_create_mad_agents(struct rvt_dev_info *rdi) 
	return ret;

}



/**

 * rvt_free_mad_agents - free up mad agents

 * @rdi: rvt dev struct

 *

 * If driver needs notification of mad agent removal make the call back

 */

void rvt_free_mad_agents(struct rvt_dev_info *rdi)

{

	struct ib_mad_agent *agent;

drivers/infiniband/sw/rdmavt/mcast.c

+31 −3
Original line number Diff line number Diff line
@@ -53,6 +53,12 @@ 


#include "mcast.h"



/**

 * rvt_driver_mcast - init resources for multicast

 * @rdi: rvt dev struct

 *

 * This is per device that registers with rdmavt

 */

void rvt_driver_mcast_init(struct rvt_dev_info *rdi)

{

	/*
@@ -130,9 +136,9 @@ static void rvt_mcast_free(struct rvt_mcast *mcast) 
 * @ibp: the IB port structure

 * @mgid: the multicast GID to search for

 *

 * Returns NULL if not found.

 *

 * The caller is responsible for decrementing the reference count if found.

 *

 * Return: NULL if not found.

 */

struct rvt_mcast *rvt_mcast_find(struct rvt_ibport *ibp, union ib_gid *mgid)

{
@@ -170,7 +176,7 @@ EXPORT_SYMBOL(rvt_mcast_find); 
 * @mcast: the mcast GID table

 * @mqp: the QP to attach

 *

 * Return zero if both were added.  Return EEXIST if the GID was already in

 * Return: zero if both were added.  Return EEXIST if the GID was already in

 * the table but the QP was added.  Return ESRCH if the QP was already

 * attached and neither structure was added.

 */
@@ -247,6 +253,14 @@ static int rvt_mcast_add(struct rvt_dev_info *rdi, struct rvt_ibport *ibp, 
	return ret;

}



/**

 * rvt_attach_mcast - attach a qp to a multicast group

 * @ibqp: Infiniband qp

 * @igd: multicast guid

 * @lid: multicast lid

 *

 * Return: 0 on success

 */

int rvt_attach_mcast(struct ib_qp *ibqp, union ib_gid *gid, u16 lid)

{

	struct rvt_qp *qp = ibqp_to_rvtqp(ibqp);
@@ -298,6 +312,14 @@ int rvt_attach_mcast(struct ib_qp *ibqp, union ib_gid *gid, u16 lid) 
	return ret;

}



/**

 * rvt_detach_mcast - remove a qp from a multicast group

 * @ibqp: Infiniband qp

 * @igd: multicast guid

 * @lid: multicast lid

 *

 * Return: 0 on success

 */

int rvt_detach_mcast(struct ib_qp *ibqp, union ib_gid *gid, u16 lid)

{

	struct rvt_qp *qp = ibqp_to_rvtqp(ibqp);
@@ -377,6 +399,12 @@ int rvt_detach_mcast(struct ib_qp *ibqp, union ib_gid *gid, u16 lid) 
	return 0;

}



/**

 *rvt_mast_tree_empty - determine if any qps are attached to any mcast group

 *@rdi: rvt dev struct

 *

 * Return: in use count

 */

int rvt_mcast_tree_empty(struct rvt_dev_info *rdi)

{

	int i;

drivers/infiniband/sw/rdmavt/mmap.c

+21 −7
Original line number Diff line number Diff line
@@ -51,6 +51,10 @@ 
#include <asm/pgtable.h>

#include "mmap.h"



/**

 * rvt_mmap_init - init link list and lock for mem map

 * @rdi: rvt dev struct

 */

void rvt_mmap_init(struct rvt_dev_info *rdi)

{

	INIT_LIST_HEAD(&rdi->pending_mmaps);
@@ -78,10 +82,6 @@ void rvt_release_mmap_info(struct kref *ref) 
}

EXPORT_SYMBOL(rvt_release_mmap_info);



/*

 * open and close keep track of how many times the CQ is mapped,

 * to avoid releasing it.

 */

static void rvt_vma_open(struct vm_area_struct *vma)

{

	struct rvt_mmap_info *ip = vma->vm_private_data;
@@ -105,7 +105,8 @@ static const struct vm_operations_struct rvt_vm_ops = { 
 * rvt_mmap - create a new mmap region

 * @context: the IB user context of the process making the mmap() call

 * @vma: the VMA to be initialized

 * Return zero if the mmap is OK. Otherwise, return an errno.

 *

 * Return: zero if the mmap is OK. Otherwise, return an errno.

 */

int rvt_mmap(struct ib_ucontext *context, struct vm_area_struct *vma)

{
@@ -147,8 +148,14 @@ int rvt_mmap(struct ib_ucontext *context, struct vm_area_struct *vma) 
}

EXPORT_SYMBOL(rvt_mmap);



/*

 * Allocate information for hfi1_mmap

/**

 * rvt_create_mmap_info - allocate information for hfi1_mmap

 * @rdi: rvt dev struct

 * @size: size in bytes to map

 * @context: user context

 * @obj: opaque pointer to a cq, wq etc

 *

 * Return: rvt_mmap struct on success

 */

struct rvt_mmap_info *rvt_create_mmap_info(struct rvt_dev_info *rdi,

					   u32 size,
@@ -180,6 +187,13 @@ struct rvt_mmap_info *rvt_create_mmap_info(struct rvt_dev_info *rdi, 
}

EXPORT_SYMBOL(rvt_create_mmap_info);



/**

 * rvt_update_mmap_info - update a mem map

 * @rdi: rvt dev struct

 * @ip: mmap info pointer

 * @size: size to grow by

 * @obj: opaque pointer to cq, wq, etc.

 */

void rvt_update_mmap_info(struct rvt_dev_info *rdi, struct rvt_mmap_info *ip,

			  u32 size, void *obj)

{