Commit 6612b498 authored by Parav Pandit's avatar Parav Pandit Committed by Jason Gunthorpe
Browse files

IB/core: Fix comments of GID query functions 



Exported symbol's comments should be with function definition and not in
the header file. Therefore comments of ib_find_cached_gid() and
ib_find_cached_gid_by_port() functions are moved closer to their
definitions.

The function name in then comment is different than the actual function
name, fix it to be same as ib_cache_gid_find_by_filter().

Also current comment section of ib_find_cached_gid_by_port() contains the
desciption of ib_find_cached_gid(), fix that as well.

Reviewed-by: default avatarDaniel Jurgens <danielj@mellanox.com>
Signed-off-by: default avatarParav Pandit <parav@mellanox.com>
Signed-off-by: default avatarLeon Romanovsky <leonro@mellanox.com>
Signed-off-by: default avatarJason Gunthorpe <jgg@mellanox.com>
parent eeea6953

drivers/infiniband/core/cache.c

+29 −2
Original line number Diff line number Diff line
@@ -492,6 +492,19 @@ static int ib_cache_gid_find(struct ib_device *ib_dev, 
					mask, port, index);

}



/**

 * ib_find_cached_gid_by_port - Returns the GID table index where a specified

 * GID value occurs. It searches for the specified GID value in the local

 * software cache.

 * @device: The device to query.

 * @gid: The GID value to search for.

 * @gid_type: The GID type to search for.

 * @port_num: The port number of the device where the GID value should be

 *   searched.

 * @ndev: In RoCE, the net device of the device. Null means ignore.

 * @index: The index into the cached GID table where the GID was found. This

 *   parameter may be NULL.

 */

int ib_find_cached_gid_by_port(struct ib_device *ib_dev,

			       const union ib_gid *gid,

			       enum ib_gid_type gid_type,
@@ -528,7 +541,7 @@ int ib_find_cached_gid_by_port(struct ib_device *ib_dev, 
EXPORT_SYMBOL(ib_find_cached_gid_by_port);



/**

 * ib_find_gid_by_filter - Returns the GID table index where a specified

 * ib_cache_gid_find_by_filter - Returns the GID table index where a specified

 * GID value occurs

 * @device: The device to query.

 * @gid: The GID value to search for.
@@ -848,6 +861,20 @@ int ib_get_cached_gid(struct ib_device *device, 
}

EXPORT_SYMBOL(ib_get_cached_gid);



/**

 * ib_find_cached_gid - Returns the port number and GID table index where

 *   a specified GID value occurs.

 * @device: The device to query.

 * @gid: The GID value to search for.

 * @gid_type: The GID type to search for.

 * @ndev: In RoCE, the net device of the device. NULL means ignore.

 * @port_num: The port number of the device where the GID value was found.

 * @index: The index into the cached GID table where the GID was found.  This

 *   parameter may be NULL.

 *

 * ib_find_cached_gid() searches for the specified GID value in

 * the local software cache.

 */

int ib_find_cached_gid(struct ib_device *device,

		       const union ib_gid *gid,

		       enum ib_gid_type gid_type,

include/rdma/ib_cache.h

+0 −29
Original line number Diff line number Diff line
@@ -55,20 +55,6 @@ int ib_get_cached_gid(struct ib_device *device, 
		      union ib_gid        *gid,

		      struct ib_gid_attr  *attr);



/**

 * ib_find_cached_gid - Returns the port number and GID table index where

 *   a specified GID value occurs.

 * @device: The device to query.

 * @gid: The GID value to search for.

 * @gid_type: The GID type to search for.

 * @ndev: In RoCE, the net device of the device. NULL means ignore.

 * @port_num: The port number of the device where the GID value was found.

 * @index: The index into the cached GID table where the GID was found.  This

 *   parameter may be NULL.

 *

 * ib_find_cached_gid() searches for the specified GID value in

 * the local software cache.

 */

int ib_find_cached_gid(struct ib_device *device,

		       const union ib_gid *gid,

		       enum ib_gid_type gid_type,
@@ -76,21 +62,6 @@ int ib_find_cached_gid(struct ib_device *device, 
		       u8               *port_num,

		       u16              *index);



/**

 * ib_find_cached_gid_by_port - Returns the GID table index where a specified

 * GID value occurs

 * @device: The device to query.

 * @gid: The GID value to search for.

 * @gid_type: The GID type to search for.

 * @port_num: The port number of the device where the GID value sould be

 *   searched.

 * @ndev: In RoCE, the net device of the device. Null means ignore.

 * @index: The index into the cached GID table where the GID was found.  This

 *   parameter may be NULL.

 *

 * ib_find_cached_gid() searches for the specified GID value in

 * the local software cache.

 */

int ib_find_cached_gid_by_port(struct ib_device *device,

			       const union ib_gid *gid,

			       enum ib_gid_type gid_type,

CRA Git | Maintained and supported by SUSTech CRA and CCSE