Parameters

__u32nlmsg_seq

Sequence number of the netlink message

u8nl_client

The index of the netlink client

gfp_tgfp

Indicates how the memory for the request should be allocated

Description

Returns the newly allocated netlink request object if successful,otherwise returns NULL

Parameters

structkref*kref

Holds reference of netlink message request

Parameters

__u32echo_seq

Sequence number of the netlink request to find

Description

Returns the found netlink message request,if not found, returns NULL

Parameters

structiwpm_nlmsg_request*nlmsg_request

Netlink message request to service

Description

Wakes up, after the request is completed or expiredReturns 0 if the request is complete without error

Parameters

void

no arguments

Description

Returns the sequence number for the netlink message.

Parameters

structiwpm_remote_info*reminfo

The remote info to be added

Parameters

u8nl_client

The index of the netlink client

u32reg

The given registration type to compare with

Description

Calliwpm_register_pid() to register a clientReturns true if the client registration matches reg,otherwise returns false

Parameters

u8nl_client

The index of the netlink client

u32reg

Registration type to set

Parameters

u8nl_client

The index of the netlink client

Description

Returns the client registration type

Parameters

u8nl_client

The index of the netlink client

intiwpm_pid

The pid of the user space port mapper

Description

If successful, returns the number of sent mapping info records

Parameters

void

no arguments

Description

Returns 1 if mapping information is available, otherwise returns 0

Parameters

structsockaddr_storage*a_sockaddr

first sockaddr to compare

structsockaddr_storage*b_sockaddr

second sockaddr to compare

Return

0 if they are holding the same ip/tcp address info,otherwise returns 1

Parameters

structnlattr*nltb[]

Holds address of each netlink message attributes

intnla_count

Number of netlink message attributes

Description

Returns error if any of the nla_count attributes is NULL

Parameters

u32nl_op

Netlink message opcode

structnlmsghdr**nlh

Holds address of the netlink message header in skb

intnl_client

The index of the netlink client

Description

Returns the newly allcated skb, or NULL if the tailroom of the skbis insufficient to store the message header and payload

Parameters

structnetlink_callback*cb

Netlink callback structure

intpolicy_max

Maximum attribute type to be expected

conststructnla_policy*nlmsg_policy

Validation policy

structnlattr*nltb[]

Array to store policy_max parsed elements

constchar*msg_type

Type of netlink message

Description

Returns 0 on success or a negative error code

Parameters

structsockaddr_storage*sockaddr

Socket address to print

char*msg

Message to print

Parameters

u8nl_client

The index of the netlink client

intiwpm_pid

The pid of the user space port mapper

u16abi_version

The kernel’s abi_version

Description

Returns 0 on success or a negative error code

Parameters

structib_cq*cq

CQ to process

intbudget

number of CQEs to poll for

Description

This function is used to process all outstanding CQ entries.It does not offload CQ processing to a different context and doesnot ask for completion interrupts from the HCA.Using direct processing on CQ with non IB_POLL_DIRECT type may triggerconcurrent processing.

Note

do not pass -1 asbudget unless it is guaranteed that the numberof completions that will be processed is small.

Parameters

structib_device*dev

device to allocate the CQ for

void*private

driver private data, accessible from cq->cq_context

intnr_cqe

number of CQEs to allocate

intcomp_vector

HCA completion vectors for this CQ

enumib_poll_contextpoll_ctx

context to poll the CQ from.

constchar*caller

module owner name.

Description

This is the proper interface to allocate a CQ for in-kernel users. ACQ allocated with this interface will automatically be polled from thespecified context. The ULP must use wr->wr_cqe instead of wr->wr_idto use this CQ abstraction.

Parameters

structib_device*dev

device to allocate the CQ for

void*private

driver private data, accessible from cq->cq_context

intnr_cqe

number of CQEs to allocate

enumib_poll_contextpoll_ctx

context to poll the CQ from

constchar*caller

module owner name

Description

Attempt to spread ULP Completion Queues over each device’s interruptvectors. A simple best-effort mechanism is used.

Parameters

structib_cq*cq

completion queue to free.

Parameters

structib_device*dev

rdma device

unsignedintnr_cqe

number of needed cqe entries

intcomp_vector_hint

completion vector hint (-1) for the driver to assigna comp vector based on internal counter

enumib_poll_contextpoll_ctx

cq polling context

Description

Finds a cq that satisfiescomp_vector_hint andnr_cqe requirements andclaim entries in it for us. In case there is no available cq, allocatea new cq with the requirements and add it to the device pool.IB_POLL_DIRECT cannot be used for shared cqs so it is not a valid valueforpoll_ctx.

Parameters

structib_cq*cq

The CQ to return.

unsignedintnr_cqe

The max number of cqes that the user had requested.

Parameters

structib_cm_id*cm_id

Connection identifier associated with the listen request.

__be64service_id

Service identifier matched against incoming connectionand service ID resolution requests. The service ID should be specifiednetwork-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM willassign a service ID to the caller.

Parameters

structib_device*device

Device associated with the cm_id. All related communication willbe associated with the specified device.

ib_cm_handlercm_handler

Callback invoked to notify the user of CM events.

__be64service_id

Service identifier matched against incoming connectionand service ID resolution requests. The service ID should be specifiednetwork-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM willassign a service ID to the caller.

Description

If there’s an existing ID listening on that same device and service ID,return it.

Callers should call ib_destroy_cm_id when done with the listener ID.

Parameters

structrdma_rw_ctx*ctx

context to initialize

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structscatterlist*sg

scatterlist to READ/WRITE from/to

u32sg_cnt

number of entries insg

u32sg_offset

current byte offset intosg

u64remote_addr

remote address to read/write (relative torkey)

u32rkey

remote key to operate on

enumdma_data_directiondir

DMA_TO_DEVICE for RDMA WRITE,DMA_FROM_DEVICE for RDMA READ

Description

Returns the number of WQEs that will be needed on the workqueue ifsuccessful, or a negative error code.

Parameters

structrdma_rw_ctx*ctx

context to initialize

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structscatterlist*sg

scatterlist to READ/WRITE from/to

u32sg_cnt

number of entries insg

structscatterlist*prot_sg

scatterlist to READ/WRITE protection information from/to

u32prot_sg_cnt

number of entries inprot_sg

structib_sig_attrs*sig_attrs

signature offloading algorithms

u64remote_addr

remote address to read/write (relative torkey)

u32rkey

remote key to operate on

enumdma_data_directiondir

DMA_TO_DEVICE for RDMA WRITE,DMA_FROM_DEVICE for RDMA READ

Description

Returns the number of WQEs that will be needed on the workqueue ifsuccessful, or a negative error code.

Parameters

structrdma_rw_ctx*ctx

context to operate on

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structib_cqe*cqe

completion queue entry for the last WR

structib_send_wr*chain_wr

WR to append to the posted chain

Description

Return the WR chain for the set of RDMA READ/WRITE operations described byctx, as well as any memory registration operations needed. Ifchain_wris non-NULL the WR it points to will be appended to the chain of WRs posted.Ifchain_wr is not setcqe must be set so that the caller gets acompletion notification.

Parameters

structrdma_rw_ctx*ctx

context to operate on

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structib_cqe*cqe

completion queue entry for the last WR

structib_send_wr*chain_wr

WR to append to the posted chain

Description

Post the set of RDMA READ/WRITE operations described byctx, as well asany memory registration operations needed. Ifchain_wr is non-NULL theWR it points to will be appended to the chain of WRs posted. Ifchain_wris not setcqe must be set so that the caller gets a completionnotification.

Parameters

structrdma_rw_ctx*ctx

context to release

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structscatterlist*sg

scatterlist that was used for the READ/WRITE

u32sg_cnt

number of entries insg

enumdma_data_directiondir

DMA_TO_DEVICE for RDMA WRITE,DMA_FROM_DEVICE for RDMA READ

Parameters

structrdma_rw_ctx*ctx

context to release

structib_qp*qp

queue pair to operate on

u32port_num

port num to which the connection is bound

structscatterlist*sg

scatterlist that was used for the READ/WRITE

u32sg_cnt

number of entries insg

structscatterlist*prot_sg

scatterlist that was used for the READ/WRITE of the PI

u32prot_sg_cnt

number of entries inprot_sg

enumdma_data_directiondir

DMA_TO_DEVICE for RDMA WRITE,DMA_FROM_DEVICE for RDMA READ

Parameters

structib_device*device

device handling the connection

u32port_num

port num to which the connection is bound

unsignedintmaxpages

maximum payload pages per rdma_rw_ctx

Description

Returns the number of MRs the device requires to movemaxpayloadbytes. The returned value is used during transport creation tocompute max_rdma_ctxts and the size of the transport’s Send andSend Completion Queues.

Parameters

conststructib_device*dev

Pointer to rdma device which needs to be checked

conststructnet*net

Pointer to net namesapce for which access to be checked

Description

When the rdma device is in shared mode, it ignores the net namespace.When the rdma device is exclusive to a net namespace, rdma device netnamespace is checked against the specified one.

Parameters

conststructib_device*dev

Pointer to rdma device whose capability to be checked

Description

Returns true if a rdma device’s owning user namespace has CAP_NET_RAWcapability, otherwise false. When rdma subsystem is in legacy shared network,namespace mode, the default net namespace is considered.

Parameters

structib_device*device

device whose reference to be released

Description

ib_device_put() releases reference to the IB device to allow it to beunregistered and eventually free.

Parameters

constchar*name

The name to look for

enumrdma_driver_iddriver_id

The driver ID that must match (RDMA_DRIVER_UNKNOWN matches all)

Description

Find and hold an ib_device by its name. The caller must callib_device_put() on the returned pointer.

Parameters

size_tsize

size of structure to allocate

structnet*net

network namespace device should be located in, namespacemust stay valid untilib_register_device() is completed.

Description

Low-level drivers should useib_alloc_device() to allocatestructib_device.size is the size of the structure to be allocated,including any private data used by the low-level driver.ib_dealloc_device() must be used to free structures allocated withib_alloc_device().

Parameters

structib_device*device

structure to free

Description

Free a structure allocated withib_alloc_device().

Parameters

structib_device*dev

IB device

unsignedintport

port number whose immutable data to read. It starts with index 1 andvalid upto includingrdma_end_port().

Parameters

structib_device*device

Device to register

constchar*name

unique string device name. This may include a ‘%’ which willcause a unique index to be added to the passed device name.

structdevice*dma_device

pointer to a DMA-capable device. IfNULL, then the IBdevice will be used. In this case the caller should fullysetup the ibdev for DMA. This usually means using dma_virt_ops.

Description

Low-level drivers useib_register_device() to register theirdevices with the IB core. All registered clients will receive acallback for each device that is added.device must be allocatedwithib_alloc_device().

If the driver uses ops.dealloc_driver and calls anyib_unregister_device()asynchronously then the device pointer may become freed as soon as thisfunction returns.

Parameters

structib_device*ib_dev

The device to unregister

Description

Unregister an IB device. All clients will receive a remove callback.

Callers should call this routine only once, and protect against races withregistration. Typically it should only be called as part of a removecallback in an implementation of driver core’sstructdevice_driver andrelated.

If ops.dealloc_driver is used then ib_dev will be freed upon return fromthis function.

Parameters

structib_device*ib_dev

The device to unregister

Description

This is the same asib_unregister_device(), except it includes an internalib_device_put() that should match a ‘get’ obtained by the caller.

It is safe to call this routine concurrently from multiple threads whileholding the ‘get’. When the function returns the device is fullyunregistered.

Drivers using this flow MUST use the driver_unregister callback to clean uptheir resources associated with the device and dealloc it.

Parameters

enumrdma_driver_iddriver_id

The driver to unregister

Description

This implements a fence for device unregistration. It only returns once alldevices associated with the driver_id have fully completed theirunregistration and returned from ib_unregister_device*().

If device’s are not yet unregistered it goes ahead and starts unregisteringthem.

This does not block creation of new devices with the given driver_id, thatis the responsibility of the caller.

Parameters

structib_device*ib_dev

The device to unregister

Description

This schedules an asynchronous unregistration using a WQ for the device. Adriver should use this to avoid holding locks while doing unregistration,such as holding the RTNL lock.

Drivers using this API must use ib_unregister_driver before module unloadto ensure that all scheduled unregistrations have completed.

Parameters

structib_client*client

Client to register

Description

Upper level users of the IB drivers can useib_register_client() toregister callbacks for IB device addition and removal. When an IBdevice is added, each registered client’s add method will be called(in the order the clients were registered), and when a device isremoved, each client’s remove method will be called (in the reverseorder that clients were registered). In addition, whenib_register_client() is called, the client will receive an addcallback for all devices already registered.

Parameters

structib_client*client

Client to unregister

Description

Upper level users useib_unregister_client() to remove their clientregistration. Whenib_unregister_client() is called, the clientwill receive a remove callback for each IB device still registered.

This is a full fence, once it returns no client callbacks will be called,or are running in another thread.

Parameters

structib_device*device

Device to set context for

structib_client*client

Client to set context for

void*data

Context to set

Description

ib_set_client_data() sets client context data that can be retrieved withib_get_client_data(). This can only be called while the client isregistered to the device, once the ib_clientremove() callback returns thiscannot be called.

Parameters

structib_event_handler*event_handler

Handler to register

Description

ib_register_event_handler() registers an event handler that will becalled back when asynchronous IB events occur (as defined inchapter 11 of the InfiniBand Architecture Specification). Thiscallback occurs in workqueue context.

Parameters

structib_event_handler*event_handler

Handler to unregister

Description

Unregister an event handler registered withib_register_event_handler().

Parameters

structib_device*device

Device to query

u32port_num

Port number to query

structib_port_attr*port_attr

Port attributes

Description

ib_query_port() returns the attributes of a port through theport_attr pointer.

Parameters

structib_device*ib_dev

Device to modify

structnet_device*ndev

net_device to affiliate, may be NULL

u32port

IB port the net_device is connected to

Description

Drivers should use this to link the ib_device to a netdev so the netdevshows up in interfaces like ib_enum_roce_netdev. Only one netdev may beaffiliated with any port.

The caller must ensure that the given ndev is not unregistered orunregistering, and that either the ib_device is unregistered orib_device_set_netdev() is called with NULL when the ndev sends aNETDEV_UNREGISTER event.

Parameters

structib_device*ibdev

IB device

structnet_device*ndev

Network device

u32*port

IB port the net_device is connected to

Parameters

structnet_device*ndev

netdev to locate

enumrdma_driver_iddriver_id

The driver ID that must match (RDMA_DRIVER_UNKNOWN matches all)

Description

Find and hold an ib_device that is associated with a netdev viaib_device_set_netdev(). The caller must callib_device_put() on thereturned pointer.

Parameters

structib_device*device

Device to query

u32port_num

Port number to query

u16index

P_Key table index to query

u16*pkey

Returned P_Key

Description

ib_query_pkey() fetches the specified P_Key table entry.

Parameters

structib_device*device

Device to modify

intdevice_modify_mask

Mask of attributes to change

structib_device_modify*device_modify

New attribute values

Description

ib_modify_device() changes a device’s attributes as specified bythedevice_modify_mask anddevice_modify structure.

Parameters

structib_device*device

The device to modify.

u32port_num

The number of the port to modify.

intport_modify_mask

Mask used to specify which attributes of the portto change.

structib_port_modify*port_modify

New attribute values for the port.

Description

ib_modify_port() changes a port’s attributes as specified by theport_modify_mask andport_modify structure.

Parameters

structib_device*device

The device to query.

unionib_gid*gid

The GID value to search for.

u32*port_num

The port number of the device where the GID value was found.

u16*index

The index into the GID table where the GID was found. Thisparameter may be NULL.

Parameters

structib_device*device

The device to query.

u32port_num

The port number of the device to search for the PKey.

u16pkey

The PKey value to search for.

u16*index

The index into the PKey table where the PKey was found.

Parameters

structib_device*dev

An RDMA device on which the request has been received.

u32port

Port number on the RDMA device.

u16pkey

The Pkey the request came on.

constunionib_gid*gid

A GID that the net_dev uses to communicate.

conststructsockaddr*addr

Contains the IP address that the request specified as itsdestination.

Parameters

structib_device*device

The device on which to allocate the protection domain.

unsignedintflags

protection domain flags

constchar*caller

caller’s build-time module name

Description

A protection domain object provides an association between QPs, sharedreceive queues, address handles, memory regions, and memory windows.

Every PD has a local_dma_lkey which can be used as the lkey value for localmemory operations.

Parameters

structib_pd*pd

The protection domain to deallocate.

structib_udata*udata

Valid user data or NULL for kernel object

Description

It is an error to call this function while any resources in the pd stillexist. The caller is responsible to synchronously destroy them andguarantee no new allocations will happen.

Parameters

structrdma_ah_attr*dest

Pointer to destination ah_attr. Contents of the destinationpointer is assumed to be invalid and attribute are overwritten.

conststructrdma_ah_attr*src

Pointer to source ah_attr.

Parameters

structrdma_ah_attr*old

Pointer to existing ah_attr which needs to be replaced.old is assumed to be valid or zero’d

conststructrdma_ah_attr*new

Pointer to the new ah_attr.

Description

rdma_replace_ah_attr() first releases any reference in the old ah_attr ifold the ah_attr is valid; after that it copies the new attribute and holdsthe reference to the replaced ah_attr.

Parameters

structrdma_ah_attr*dest

Pointer to destination ah_attr to copy to.dest is assumed to be valid or zero’d

structrdma_ah_attr*src

Pointer to the new ah_attr.

Description

rdma_move_ah_attr() first releases any reference in the destination ah_attrif it is valid. This also transfers ownership of internal references fromsrc to dest, making src invalid in the process. No new reference of the srcah_attr is taken.

Parameters

structib_pd*pd

The protection domain associated with the address handle.

structrdma_ah_attr*ah_attr

The attributes of the address vector.

u32flags

Create address handle flags (seeenumrdma_create_ah_flags).

Description

It returns 0 on success and returns appropriate error code on error.The address handle is used to reference a local or global destinationin all UD QP post sends.

Parameters

structib_pd*pd

The protection domain associated with the address handle.

structrdma_ah_attr*ah_attr

The attributes of the address vector.

structib_udata*udata

pointer to user’s input output buffer information need byprovider driver.

Description

It returns 0 on success and returns appropriate error code on error.The address handle is used to reference a local or global destinationin all UD QP post sends.

Parameters

structrdma_ah_attr*attr

Pointer to AH attribute structure

unionib_gid*dgid

Destination GID

u32flow_label

Flow label

u8hop_limit

Hop limit

u8traffic_class

traffic class

conststructib_gid_attr*sgid_attr

Pointer to SGID attribute

Description

This takes ownership of the sgid_attr reference. The caller must ensurerdma_destroy_ah_attr() is called before destroying the rdma_ah_attr aftercalling this function.

Parameters

structrdma_ah_attr*ah_attr

Pointer to ah attribute

Description

Release reference to the SGID attribute of the ah attribute if it isnon NULL. It is safe to call this multiple times, and safe to call it ona zero initialized ah_attr.

Parameters

structib_pd*pd

The protection domain associated with the SRQ.

structib_srq_init_attr*srq_init_attr

A list of initial attributes required to create theSRQ. If SRQ creation succeeds, then the attributes are updated tothe actual capabilities of the created SRQ.

structib_usrq_object*uobject

uobject pointer if this is not a kernel SRQ

structib_udata*udata

udata pointer if this is not a kernel SRQ

Description

srq_attr->max_wr and srq_attr->max_sge are read the determine therequested size of the SRQ, and set to the actual values allocatedon return. Ifib_create_srq() succeeds, then max_wr and max_sgewill always be at least as large as the requested values.

Parameters

structib_device*dev

IB device

structib_pd*pd

The protection domain associated with the QP.

structib_qp_init_attr*attr

A list of initial attributes required to create theQP. If QP creation succeeds, then the attributes are updated tothe actual capabilities of the created QP.

structib_udata*udata

User data

structib_uqp_object*uobj

uverbs obect

constchar*caller

caller’s build-time module name

Parameters

structib_qp*ib_qp

The QP to modify.

structib_qp_attr*attr

On input, specifies the QP attributes to modify. On output,the current values of selected QP attributes are returned.

intattr_mask

A bit-mask used to specify which attributes of the QPare being modified.

structib_udata*udata

pointer to user’s input output buffer informationare being modified.It returns 0 on success and returns appropriate error code on error.

Parameters

structib_pd*pd

protection domain associated with the region

enumib_mr_typemr_type

memory region type

u32max_num_sg

maximum sg entries available for registration.

Notes

Memory registeration page/sg lists must not exceed max_num_sg.For mr_type IB_MR_TYPE_MEM_REG, the total length cannot exceedmax_num_sg * used_page_size.

Parameters

structib_pd*pd

protection domain associated with the region

u32max_num_data_sg

maximum data sg entries available for registration

u32max_num_meta_sg

maximum metadata sg entries available forregistration

Notes

Memory registration page/sg lists must not exceed max_num_sg,also the integrity page/sg lists must not exceed max_num_meta_sg.

Parameters

structib_device*device

The device on which to allocate the XRC domain.

structinode*inode

inode to connect XRCD

structib_udata*udata

Valid user data or NULL for kernel object

Parameters

structib_xrcd*xrcd

The XRC domain to deallocate.

structib_udata*udata

Valid user data or NULL for kernel object

Parameters

structib_pd*pd

The protection domain associated with the WQ.

structib_wq_init_attr*wq_attr

A list of initial attributes required to create theWQ. If WQ creation succeeds, then the attributes are updated tothe actual capabilities of the created WQ.

Description

wq_attr->max_wr and wq_attr->max_sge determinethe requested size of the WQ, and set to the actual values allocatedon return.Ifib_create_wq() succeeds, then max_wr and max_sge will always beat least as large as the requested values.

Parameters

structib_wq*wq

The WQ to destroy.

structib_udata*udata

Valid user data

Parameters

structib_mr*mr

memory region

structscatterlist*data_sg

dma mapped scatterlist for data

intdata_sg_nents

number of entries in data_sg

unsignedint*data_sg_offset

offset in bytes into data_sg

structscatterlist*meta_sg

dma mapped scatterlist for metadata

intmeta_sg_nents

number of entries in meta_sg

unsignedint*meta_sg_offset

offset in bytes into meta_sg

unsignedintpage_size

page vector desired page size

Description

Constraints:- The MR must be allocated with type IB_MR_TYPE_INTEGRITY.

After this completes successfully, the memory regionis ready for registration.

Return

0 on success.

Parameters

structib_mr*mr

memory region

structscatterlist*sg

dma mapped scatterlist

intsg_nents

number of entries in sg

unsignedint*sg_offset

offset in bytes into sg

unsignedintpage_size

page vector desired page size

Description

Constraints:

• The first sg element is allowed to have an offset.

• Each sg element must either be aligned to page_size or virtuallycontiguous to the previous element. In case an sg element has anon-contiguous offset, the mapping prefix will not include it.

• The last sg element is allowed to have length less than page_size.

• If sg_nents total byte length exceeds the mr max_num_sge * page_sizethen only max_num_sg entries will be mapped.

• If the MR was allocated with type IB_MR_TYPE_SG_GAPS, none of theseconstraints holds and the page_size argument is ignored.

Returns the number of sg elements that were mapped to the memory region.

After this completes successfully, the memory regionis ready for registration.

Parameters

structib_mr*mr

memory region

structscatterlist*sgl

dma mapped scatterlist

intsg_nents

number of entries in sg

unsignedint*sg_offset_p

IN	start offset in bytes into sg
OUT	offset in bytes for element n of the sg of the firstbyte that has not been processed where n is the returnvalue of this function.

int(*set_page)(structib_mr*,u64)

driver page assignment function pointer

Description

Core service helper for drivers to convert the largestprefix of given sg list to a page vector. The sg listprefix converted is the prefix that meet the requirementsof ib_map_mr_sg.

Returns the number of sg elements that were assigned toa page vector.

Parameters

structib_qp*qp

queue pair to drain

Description

If the device has a provider-specific drain function, thencall that. Otherwise call the generic drain function__ib_drain_sq().

The caller must:

ensure there is room in the CQ and SQ for the drain work request andcompletion.

allocate the CQ usingib_alloc_cq().

ensure that there are no other contexts that are posting WRs concurrently.Otherwise the drain is not guaranteed.

Parameters

structib_qp*qp

queue pair to drain

Description

If the device has a provider-specific drain function, thencall that. Otherwise call the generic drain function__ib_drain_rq().

The caller must:

ensure there is room in the CQ and RQ for the drain work request andcompletion.

allocate the CQ usingib_alloc_cq().

ensure that there are no other contexts that are posting WRs concurrently.Otherwise the drain is not guaranteed.

Parameters

structib_qp*qp

queue pair to drain

Description

The caller must:

ensure there is room in the CQ(s), SQ, and RQ for drain work requestsand completions.

allocate the CQs usingib_alloc_cq().

ensure that there are no other contexts that are posting WRs concurrently.Otherwise the drain is not guaranteed.

Parameters

conststructrdma_stat_desc*descs

array of static descriptors

intnum_counters

number of elements in array

unsignedlonglifespan

milliseconds between updates

Parameters

structrdma_hw_stats*stats

statistics to release

Parameters

conststructib_field*desc

Array of structure field descriptions

intdesc_len

Number of entries indesc

void*structure

Structure to pack from

void*buf

Buffer to pack into

Description

ib_pack() packs a list of structure fields into a buffer,controlled by the array of fields indesc.

Parameters

conststructib_field*desc

Array of structure field descriptions

intdesc_len

Number of entries indesc

void*buf

Buffer to unpack from

void*structure

Structure to unpack into

Description

ib_pack() unpacks a list of structure fields from a buffer,controlled by the array of fields indesc.

Parameters

intid

ID of query to cancel

structib_sa_query*query

query pointer to cancel

Description

Try to cancel an SA query. If the id and query don’t match up orthe query has already completed, nothing is done. Otherwise thequery is canceled and will complete with a status of -EINTR.

Parameters

structib_device*device

Device associated ah attributes initialization.

u32port_num

Port on the specified device.

structsa_path_rec*rec

path record entry to use for ah attributes initialization.

structrdma_ah_attr*ah_attr

address handle attributes to initialization from path record.

conststructib_gid_attr*gid_attr

SGID attribute to consider during initialization.

Description

Whenib_init_ah_attr_from_path() returns success,(a) for IB link layer it optionally contains a reference to SGID attributewhen GRH is present for IB link layer.(b) for RoCE link layer it contains a reference to SGID attribute.User must invokerdma_destroy_ah_attr() to release reference to SGIDattributes which are initialized usingib_init_ah_attr_from_path().

Parameters

structib_sa_client*client

SA client

structib_device*device

device to send query on

u32port_num

port number to send query on

structsa_path_rec*rec

Path Record to send in query

ib_sa_comp_maskcomp_mask

component mask to send in query

unsignedlongtimeout_ms

time to wait for response

gfp_tgfp_mask

GFP mask to use for internal allocations

void(*callback)(intstatus,structsa_path_rec*resp,unsignedintnum_paths,void*context)

function called when query completes, times out or iscanceled

void*context

opaque user context passed to callback

structib_sa_query**sa_query

query context, used to cancel query

Description

Send a Path Record Get query to the SA to look up a path. Thecallback function will be called when the query completes (orfails); status is 0 for a successful response, -EINTR if the queryis canceled, -ETIMEDOUT is the query timed out, or -EIO if an erroroccurred sending the query. The resp parameter of the callback isonly valid if status is 0.

If the return value ofib_sa_path_rec_get() is negative, it is anerror code. Otherwise it is a query ID that can be used to cancelthe query.

Parameters

structib_sa_client*client

SA client

structib_device*device

device to send query on

u32port_num

port number to send query on

structsa_service_rec*rec

Service Record to send in query

ib_sa_comp_maskcomp_mask

component mask to send in query

unsignedlongtimeout_ms

time to wait for response

gfp_tgfp_mask

GFP mask to use for internal allocations

void(*callback)(intstatus,structsa_service_rec*resp,unsignedintnum_services,void*context)

function called when query completes, times out or iscanceled

void*context

opaque user context passed to callback

structib_sa_query**sa_query

query context, used to cancel query

Description

Send a Service Record Get query to the SA to look up a path. Thecallback function will be called when the query completes (orfails); status is 0 for a successful response, -EINTR if the queryis canceled, -ETIMEDOUT is the query timed out, or -EIO if an erroroccurred sending the query. The resp parameter of the callback isonly valid if status is 0.

If the return value ofib_sa_service_rec_get() is negative, it is anerror code. Otherwise it is a query ID that can be used to cancelthe query.

Parameters

intpayload_bytes

Length of packet payload

intlrh_present

specify if LRH is present

inteth_present

specify if Eth header is present

intvlan_present

packet is tagged vlan

intgrh_present

GRH flag (if non-zero, GRH will be included)

intip_version

if non-zero, IP header, V4 or V6, will be included

intudp_present

if non-zero, UDP header will be included

intimmediate_present

specify if immediate data is present

structib_ud_header*header

Structure to initialize

Parameters

structib_ud_header*header

UD header struct

void*buf

Buffer to pack into

Description

ib_ud_header_pack() packs the UD header structureheader into wireformat in the bufferbuf.

Parameters

structib_umem*umem

umem struct

unsignedlongpgsz_bitmap

bitmap of HW supported page sizes

unsignedlongvirt

IOVA

Description

This helper is intended for HW that support multiple pagesizes but can do only a single page size in an MR.

Returns 0 if the umem requires page sizes not supported bythe driver to be mapped. Drivers always supporting PAGE_SIZEor smaller will never see a 0 result.

Parameters

structib_device*device

IB device to connect UMEM

unsignedlongaddr

userspace virtual address to start at

size_tsize

length of region to pin

intaccess

IB_ACCESS_xxx flags for memory being pinned

Parameters

structib_umem*umem

umemstructto release

Parameters

structib_device*device

IB device to create UMEM

intaccess

ib_reg_mr access flags

Description

Implicit ODP umems do not have a VA range and do not have any page lists.They exist only to hold the per_mm reference to help the driver createchildren umems.

Parameters

structib_umem_odp*root

The parent umem enclosing the child. This must be allocated usingib_alloc_implicit_odp_umem()

unsignedlongaddr

The starting userspace VA

size_tsize

The length of the userspace VA

conststructmmu_interval_notifier_ops*ops

MMU interval ops, currently onlyinvalidate

Parameters

structib_device*device

IB devicestructto get UMEM

unsignedlongaddr

userspace virtual address to start at

size_tsize

length of region to pin

intaccess

IB_ACCESS_xxx flags for memory being pinned

conststructmmu_interval_notifier_ops*ops

MMU interval ops, currently onlyinvalidate

Description

The driver should use when the access flags indicate ODP memory. It avoidspinning, instead, stores the mm for future page fault handling inconjunction with MMU notifiers.

Parameters

structib_umem_odp*umem_odp

the umem to map and pin

u64user_virt

the address from which we need to map.

u64bcnt

the minimal number of bytes to pin and map. The mapping might bebigger due to alignment, and may also be smaller in case of an errorpinning or mapping a page. The actual pages mapped is returned inthe return value.

u64access_mask

bit mask of the requested access permissions for the givenrange.

boolfault

is faulting required for the given range

Description

Maps the range passed in the argument to DMA addresses.Upon success the ODP MR will be locked to let caller complete its devicepage table update.

Returns the number of pages mapped in success, negative error codefor failure.

Parameters

structrvt_qp*qp

the queue pair where the work request comes from

structib_mr*ibmr

the memory region to be registered

u32key

updated key for this memory region

intaccess

access flags for this memory region

Description

Returns 0 on success.

Parameters

structrvt_qp*qp

queue pair associated with the invalidate op

u32rkey

rkey to invalidate

Description

Returns 0 on success.

Parameters

structrvt_lkey_table*rkt

table containing lkey to check SGE against

structrvt_pd*pd

protection domain

structrvt_sge*isge

outgoing internal SGE

structrvt_sge*last_sge

last outgoing SGE written

structib_sge*sge

SGE to check

intacc

access flags

Description

Check the IB SGE for validity and initialize our internal versionof it.

Increments the reference count when a new sge is stored.

Return

0 if compressed, 1 if added , otherwise returns -errno.

Parameters

structrvt_qp*qp

qp for validation

structrvt_sge*sge

SGE state

u32len

length of data

u64vaddr

virtual address to place data

u32rkey

rkey to check

intacc

access flags

Return

1 if successful, otherwise 0.

Description

increments the reference count upon success

Parameters

structrvt_qp*qp

the queue pair to compute the AETH for

Description

Returns the AETH.

Parameters

structrvt_qp*qp

the qp who’s send work queue to flush

u32aeth

the Acknowledge Extended Transport Header

Description

The QP s_lock should be held.

Parameters

structrvt_sge_state*ss

the sge state pointer

structrvt_swqe*wqe

the wqe to rewind

u32len

the data length from the start of the wqe in bytes

Description

Returns the remaining data length.

Parameters

structib_device*ibdev

the ib device

structrdma_ah_attr*ah_attr

the attributes of the AH

Description

If driver supports a more detailed check_ah function call back to itotherwise just check the basics.

Return

0 on success

Parameters

size_tsize

how big of a structure to allocate

intnports

number of ports to allocate array slots for

Description

Use IB core device alloc to allocate space for the rdi which is assumed to beinside of the ib_device. Any extra space that drivers require should beincluded in size.

We also allocate a port array based on the number of ports.

Return

pointer to allocated rdi

Parameters

structrvt_dev_info*rdi

structure to free

Description

Free a structure allocated withrvt_alloc_device()

Parameters

structrvt_dev_info*rdi

main dev structure for all of rdmavt operations

Description

It is up to drivers to allocate the rdi and fill in the appropriateinformation.

Return

0 on success otherwise an errno.

Parameters

structrvt_dev_info*rdi

rvt dev struct