ib_verbs.h 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460
  1. /*
  2. * Copyright (c) 2004 Mellanox Technologies Ltd. All rights reserved.
  3. * Copyright (c) 2004 Infinicon Corporation. All rights reserved.
  4. * Copyright (c) 2004 Intel Corporation. All rights reserved.
  5. * Copyright (c) 2004 Topspin Corporation. All rights reserved.
  6. * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
  7. * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
  8. * Copyright (c) 2005 Cisco Systems. All rights reserved.
  9. *
  10. * This software is available to you under a choice of one of two
  11. * licenses. You may choose to be licensed under the terms of the GNU
  12. * General Public License (GPL) Version 2, available from the file
  13. * COPYING in the main directory of this source tree, or the
  14. * OpenIB.org BSD license below:
  15. *
  16. * Redistribution and use in source and binary forms, with or
  17. * without modification, are permitted provided that the following
  18. * conditions are met:
  19. *
  20. * - Redistributions of source code must retain the above
  21. * copyright notice, this list of conditions and the following
  22. * disclaimer.
  23. *
  24. * - Redistributions in binary form must reproduce the above
  25. * copyright notice, this list of conditions and the following
  26. * disclaimer in the documentation and/or other materials
  27. * provided with the distribution.
  28. *
  29. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  33. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  34. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  35. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  36. * SOFTWARE.
  37. *
  38. * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
  39. */
  40. #if !defined(IB_VERBS_H)
  41. #define IB_VERBS_H
  42. #include <linux/types.h>
  43. #include <linux/device.h>
  44. #include <asm/atomic.h>
  45. #include <asm/scatterlist.h>
  46. #include <asm/uaccess.h>
  47. union ib_gid {
  48. u8 raw[16];
  49. struct {
  50. __be64 subnet_prefix;
  51. __be64 interface_id;
  52. } global;
  53. };
  54. enum ib_node_type {
  55. IB_NODE_CA = 1,
  56. IB_NODE_SWITCH,
  57. IB_NODE_ROUTER
  58. };
  59. enum ib_device_cap_flags {
  60. IB_DEVICE_RESIZE_MAX_WR = 1,
  61. IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
  62. IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
  63. IB_DEVICE_RAW_MULTI = (1<<3),
  64. IB_DEVICE_AUTO_PATH_MIG = (1<<4),
  65. IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
  66. IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
  67. IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
  68. IB_DEVICE_SHUTDOWN_PORT = (1<<8),
  69. IB_DEVICE_INIT_TYPE = (1<<9),
  70. IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
  71. IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
  72. IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
  73. IB_DEVICE_SRQ_RESIZE = (1<<13),
  74. IB_DEVICE_N_NOTIFY_CQ = (1<<14),
  75. };
  76. enum ib_atomic_cap {
  77. IB_ATOMIC_NONE,
  78. IB_ATOMIC_HCA,
  79. IB_ATOMIC_GLOB
  80. };
  81. struct ib_device_attr {
  82. u64 fw_ver;
  83. __be64 sys_image_guid;
  84. u64 max_mr_size;
  85. u64 page_size_cap;
  86. u32 vendor_id;
  87. u32 vendor_part_id;
  88. u32 hw_ver;
  89. int max_qp;
  90. int max_qp_wr;
  91. int device_cap_flags;
  92. int max_sge;
  93. int max_sge_rd;
  94. int max_cq;
  95. int max_cqe;
  96. int max_mr;
  97. int max_pd;
  98. int max_qp_rd_atom;
  99. int max_ee_rd_atom;
  100. int max_res_rd_atom;
  101. int max_qp_init_rd_atom;
  102. int max_ee_init_rd_atom;
  103. enum ib_atomic_cap atomic_cap;
  104. int max_ee;
  105. int max_rdd;
  106. int max_mw;
  107. int max_raw_ipv6_qp;
  108. int max_raw_ethy_qp;
  109. int max_mcast_grp;
  110. int max_mcast_qp_attach;
  111. int max_total_mcast_qp_attach;
  112. int max_ah;
  113. int max_fmr;
  114. int max_map_per_fmr;
  115. int max_srq;
  116. int max_srq_wr;
  117. int max_srq_sge;
  118. u16 max_pkeys;
  119. u8 local_ca_ack_delay;
  120. };
  121. enum ib_mtu {
  122. IB_MTU_256 = 1,
  123. IB_MTU_512 = 2,
  124. IB_MTU_1024 = 3,
  125. IB_MTU_2048 = 4,
  126. IB_MTU_4096 = 5
  127. };
  128. static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
  129. {
  130. switch (mtu) {
  131. case IB_MTU_256: return 256;
  132. case IB_MTU_512: return 512;
  133. case IB_MTU_1024: return 1024;
  134. case IB_MTU_2048: return 2048;
  135. case IB_MTU_4096: return 4096;
  136. default: return -1;
  137. }
  138. }
  139. enum ib_port_state {
  140. IB_PORT_NOP = 0,
  141. IB_PORT_DOWN = 1,
  142. IB_PORT_INIT = 2,
  143. IB_PORT_ARMED = 3,
  144. IB_PORT_ACTIVE = 4,
  145. IB_PORT_ACTIVE_DEFER = 5
  146. };
  147. enum ib_port_cap_flags {
  148. IB_PORT_SM = 1 << 1,
  149. IB_PORT_NOTICE_SUP = 1 << 2,
  150. IB_PORT_TRAP_SUP = 1 << 3,
  151. IB_PORT_OPT_IPD_SUP = 1 << 4,
  152. IB_PORT_AUTO_MIGR_SUP = 1 << 5,
  153. IB_PORT_SL_MAP_SUP = 1 << 6,
  154. IB_PORT_MKEY_NVRAM = 1 << 7,
  155. IB_PORT_PKEY_NVRAM = 1 << 8,
  156. IB_PORT_LED_INFO_SUP = 1 << 9,
  157. IB_PORT_SM_DISABLED = 1 << 10,
  158. IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
  159. IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
  160. IB_PORT_CM_SUP = 1 << 16,
  161. IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
  162. IB_PORT_REINIT_SUP = 1 << 18,
  163. IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
  164. IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
  165. IB_PORT_DR_NOTICE_SUP = 1 << 21,
  166. IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
  167. IB_PORT_BOOT_MGMT_SUP = 1 << 23,
  168. IB_PORT_LINK_LATENCY_SUP = 1 << 24,
  169. IB_PORT_CLIENT_REG_SUP = 1 << 25
  170. };
  171. enum ib_port_width {
  172. IB_WIDTH_1X = 1,
  173. IB_WIDTH_4X = 2,
  174. IB_WIDTH_8X = 4,
  175. IB_WIDTH_12X = 8
  176. };
  177. static inline int ib_width_enum_to_int(enum ib_port_width width)
  178. {
  179. switch (width) {
  180. case IB_WIDTH_1X: return 1;
  181. case IB_WIDTH_4X: return 4;
  182. case IB_WIDTH_8X: return 8;
  183. case IB_WIDTH_12X: return 12;
  184. default: return -1;
  185. }
  186. }
  187. struct ib_port_attr {
  188. enum ib_port_state state;
  189. enum ib_mtu max_mtu;
  190. enum ib_mtu active_mtu;
  191. int gid_tbl_len;
  192. u32 port_cap_flags;
  193. u32 max_msg_sz;
  194. u32 bad_pkey_cntr;
  195. u32 qkey_viol_cntr;
  196. u16 pkey_tbl_len;
  197. u16 lid;
  198. u16 sm_lid;
  199. u8 lmc;
  200. u8 max_vl_num;
  201. u8 sm_sl;
  202. u8 subnet_timeout;
  203. u8 init_type_reply;
  204. u8 active_width;
  205. u8 active_speed;
  206. u8 phys_state;
  207. };
  208. enum ib_device_modify_flags {
  209. IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1
  210. };
  211. struct ib_device_modify {
  212. u64 sys_image_guid;
  213. };
  214. enum ib_port_modify_flags {
  215. IB_PORT_SHUTDOWN = 1,
  216. IB_PORT_INIT_TYPE = (1<<2),
  217. IB_PORT_RESET_QKEY_CNTR = (1<<3)
  218. };
  219. struct ib_port_modify {
  220. u32 set_port_cap_mask;
  221. u32 clr_port_cap_mask;
  222. u8 init_type;
  223. };
  224. enum ib_event_type {
  225. IB_EVENT_CQ_ERR,
  226. IB_EVENT_QP_FATAL,
  227. IB_EVENT_QP_REQ_ERR,
  228. IB_EVENT_QP_ACCESS_ERR,
  229. IB_EVENT_COMM_EST,
  230. IB_EVENT_SQ_DRAINED,
  231. IB_EVENT_PATH_MIG,
  232. IB_EVENT_PATH_MIG_ERR,
  233. IB_EVENT_DEVICE_FATAL,
  234. IB_EVENT_PORT_ACTIVE,
  235. IB_EVENT_PORT_ERR,
  236. IB_EVENT_LID_CHANGE,
  237. IB_EVENT_PKEY_CHANGE,
  238. IB_EVENT_SM_CHANGE,
  239. IB_EVENT_SRQ_ERR,
  240. IB_EVENT_SRQ_LIMIT_REACHED,
  241. IB_EVENT_QP_LAST_WQE_REACHED
  242. };
  243. struct ib_event {
  244. struct ib_device *device;
  245. union {
  246. struct ib_cq *cq;
  247. struct ib_qp *qp;
  248. struct ib_srq *srq;
  249. u8 port_num;
  250. } element;
  251. enum ib_event_type event;
  252. };
  253. struct ib_event_handler {
  254. struct ib_device *device;
  255. void (*handler)(struct ib_event_handler *, struct ib_event *);
  256. struct list_head list;
  257. };
  258. #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
  259. do { \
  260. (_ptr)->device = _device; \
  261. (_ptr)->handler = _handler; \
  262. INIT_LIST_HEAD(&(_ptr)->list); \
  263. } while (0)
  264. struct ib_global_route {
  265. union ib_gid dgid;
  266. u32 flow_label;
  267. u8 sgid_index;
  268. u8 hop_limit;
  269. u8 traffic_class;
  270. };
  271. struct ib_grh {
  272. __be32 version_tclass_flow;
  273. __be16 paylen;
  274. u8 next_hdr;
  275. u8 hop_limit;
  276. union ib_gid sgid;
  277. union ib_gid dgid;
  278. };
  279. enum {
  280. IB_MULTICAST_QPN = 0xffffff
  281. };
  282. #define IB_LID_PERMISSIVE __constant_htons(0xFFFF)
  283. enum ib_ah_flags {
  284. IB_AH_GRH = 1
  285. };
  286. struct ib_ah_attr {
  287. struct ib_global_route grh;
  288. u16 dlid;
  289. u8 sl;
  290. u8 src_path_bits;
  291. u8 static_rate;
  292. u8 ah_flags;
  293. u8 port_num;
  294. };
  295. enum ib_wc_status {
  296. IB_WC_SUCCESS,
  297. IB_WC_LOC_LEN_ERR,
  298. IB_WC_LOC_QP_OP_ERR,
  299. IB_WC_LOC_EEC_OP_ERR,
  300. IB_WC_LOC_PROT_ERR,
  301. IB_WC_WR_FLUSH_ERR,
  302. IB_WC_MW_BIND_ERR,
  303. IB_WC_BAD_RESP_ERR,
  304. IB_WC_LOC_ACCESS_ERR,
  305. IB_WC_REM_INV_REQ_ERR,
  306. IB_WC_REM_ACCESS_ERR,
  307. IB_WC_REM_OP_ERR,
  308. IB_WC_RETRY_EXC_ERR,
  309. IB_WC_RNR_RETRY_EXC_ERR,
  310. IB_WC_LOC_RDD_VIOL_ERR,
  311. IB_WC_REM_INV_RD_REQ_ERR,
  312. IB_WC_REM_ABORT_ERR,
  313. IB_WC_INV_EECN_ERR,
  314. IB_WC_INV_EEC_STATE_ERR,
  315. IB_WC_FATAL_ERR,
  316. IB_WC_RESP_TIMEOUT_ERR,
  317. IB_WC_GENERAL_ERR
  318. };
  319. enum ib_wc_opcode {
  320. IB_WC_SEND,
  321. IB_WC_RDMA_WRITE,
  322. IB_WC_RDMA_READ,
  323. IB_WC_COMP_SWAP,
  324. IB_WC_FETCH_ADD,
  325. IB_WC_BIND_MW,
  326. /*
  327. * Set value of IB_WC_RECV so consumers can test if a completion is a
  328. * receive by testing (opcode & IB_WC_RECV).
  329. */
  330. IB_WC_RECV = 1 << 7,
  331. IB_WC_RECV_RDMA_WITH_IMM
  332. };
  333. enum ib_wc_flags {
  334. IB_WC_GRH = 1,
  335. IB_WC_WITH_IMM = (1<<1)
  336. };
  337. struct ib_wc {
  338. u64 wr_id;
  339. enum ib_wc_status status;
  340. enum ib_wc_opcode opcode;
  341. u32 vendor_err;
  342. u32 byte_len;
  343. __be32 imm_data;
  344. u32 qp_num;
  345. u32 src_qp;
  346. int wc_flags;
  347. u16 pkey_index;
  348. u16 slid;
  349. u8 sl;
  350. u8 dlid_path_bits;
  351. u8 port_num; /* valid only for DR SMPs on switches */
  352. };
  353. enum ib_cq_notify {
  354. IB_CQ_SOLICITED,
  355. IB_CQ_NEXT_COMP
  356. };
  357. enum ib_srq_attr_mask {
  358. IB_SRQ_MAX_WR = 1 << 0,
  359. IB_SRQ_LIMIT = 1 << 1,
  360. };
  361. struct ib_srq_attr {
  362. u32 max_wr;
  363. u32 max_sge;
  364. u32 srq_limit;
  365. };
  366. struct ib_srq_init_attr {
  367. void (*event_handler)(struct ib_event *, void *);
  368. void *srq_context;
  369. struct ib_srq_attr attr;
  370. };
  371. struct ib_qp_cap {
  372. u32 max_send_wr;
  373. u32 max_recv_wr;
  374. u32 max_send_sge;
  375. u32 max_recv_sge;
  376. u32 max_inline_data;
  377. };
  378. enum ib_sig_type {
  379. IB_SIGNAL_ALL_WR,
  380. IB_SIGNAL_REQ_WR
  381. };
  382. enum ib_qp_type {
  383. /*
  384. * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
  385. * here (and in that order) since the MAD layer uses them as
  386. * indices into a 2-entry table.
  387. */
  388. IB_QPT_SMI,
  389. IB_QPT_GSI,
  390. IB_QPT_RC,
  391. IB_QPT_UC,
  392. IB_QPT_UD,
  393. IB_QPT_RAW_IPV6,
  394. IB_QPT_RAW_ETY
  395. };
  396. struct ib_qp_init_attr {
  397. void (*event_handler)(struct ib_event *, void *);
  398. void *qp_context;
  399. struct ib_cq *send_cq;
  400. struct ib_cq *recv_cq;
  401. struct ib_srq *srq;
  402. struct ib_qp_cap cap;
  403. enum ib_sig_type sq_sig_type;
  404. enum ib_qp_type qp_type;
  405. u8 port_num; /* special QP types only */
  406. };
  407. enum ib_rnr_timeout {
  408. IB_RNR_TIMER_655_36 = 0,
  409. IB_RNR_TIMER_000_01 = 1,
  410. IB_RNR_TIMER_000_02 = 2,
  411. IB_RNR_TIMER_000_03 = 3,
  412. IB_RNR_TIMER_000_04 = 4,
  413. IB_RNR_TIMER_000_06 = 5,
  414. IB_RNR_TIMER_000_08 = 6,
  415. IB_RNR_TIMER_000_12 = 7,
  416. IB_RNR_TIMER_000_16 = 8,
  417. IB_RNR_TIMER_000_24 = 9,
  418. IB_RNR_TIMER_000_32 = 10,
  419. IB_RNR_TIMER_000_48 = 11,
  420. IB_RNR_TIMER_000_64 = 12,
  421. IB_RNR_TIMER_000_96 = 13,
  422. IB_RNR_TIMER_001_28 = 14,
  423. IB_RNR_TIMER_001_92 = 15,
  424. IB_RNR_TIMER_002_56 = 16,
  425. IB_RNR_TIMER_003_84 = 17,
  426. IB_RNR_TIMER_005_12 = 18,
  427. IB_RNR_TIMER_007_68 = 19,
  428. IB_RNR_TIMER_010_24 = 20,
  429. IB_RNR_TIMER_015_36 = 21,
  430. IB_RNR_TIMER_020_48 = 22,
  431. IB_RNR_TIMER_030_72 = 23,
  432. IB_RNR_TIMER_040_96 = 24,
  433. IB_RNR_TIMER_061_44 = 25,
  434. IB_RNR_TIMER_081_92 = 26,
  435. IB_RNR_TIMER_122_88 = 27,
  436. IB_RNR_TIMER_163_84 = 28,
  437. IB_RNR_TIMER_245_76 = 29,
  438. IB_RNR_TIMER_327_68 = 30,
  439. IB_RNR_TIMER_491_52 = 31
  440. };
  441. enum ib_qp_attr_mask {
  442. IB_QP_STATE = 1,
  443. IB_QP_CUR_STATE = (1<<1),
  444. IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
  445. IB_QP_ACCESS_FLAGS = (1<<3),
  446. IB_QP_PKEY_INDEX = (1<<4),
  447. IB_QP_PORT = (1<<5),
  448. IB_QP_QKEY = (1<<6),
  449. IB_QP_AV = (1<<7),
  450. IB_QP_PATH_MTU = (1<<8),
  451. IB_QP_TIMEOUT = (1<<9),
  452. IB_QP_RETRY_CNT = (1<<10),
  453. IB_QP_RNR_RETRY = (1<<11),
  454. IB_QP_RQ_PSN = (1<<12),
  455. IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
  456. IB_QP_ALT_PATH = (1<<14),
  457. IB_QP_MIN_RNR_TIMER = (1<<15),
  458. IB_QP_SQ_PSN = (1<<16),
  459. IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
  460. IB_QP_PATH_MIG_STATE = (1<<18),
  461. IB_QP_CAP = (1<<19),
  462. IB_QP_DEST_QPN = (1<<20)
  463. };
  464. enum ib_qp_state {
  465. IB_QPS_RESET,
  466. IB_QPS_INIT,
  467. IB_QPS_RTR,
  468. IB_QPS_RTS,
  469. IB_QPS_SQD,
  470. IB_QPS_SQE,
  471. IB_QPS_ERR
  472. };
  473. enum ib_mig_state {
  474. IB_MIG_MIGRATED,
  475. IB_MIG_REARM,
  476. IB_MIG_ARMED
  477. };
  478. struct ib_qp_attr {
  479. enum ib_qp_state qp_state;
  480. enum ib_qp_state cur_qp_state;
  481. enum ib_mtu path_mtu;
  482. enum ib_mig_state path_mig_state;
  483. u32 qkey;
  484. u32 rq_psn;
  485. u32 sq_psn;
  486. u32 dest_qp_num;
  487. int qp_access_flags;
  488. struct ib_qp_cap cap;
  489. struct ib_ah_attr ah_attr;
  490. struct ib_ah_attr alt_ah_attr;
  491. u16 pkey_index;
  492. u16 alt_pkey_index;
  493. u8 en_sqd_async_notify;
  494. u8 sq_draining;
  495. u8 max_rd_atomic;
  496. u8 max_dest_rd_atomic;
  497. u8 min_rnr_timer;
  498. u8 port_num;
  499. u8 timeout;
  500. u8 retry_cnt;
  501. u8 rnr_retry;
  502. u8 alt_port_num;
  503. u8 alt_timeout;
  504. };
  505. enum ib_wr_opcode {
  506. IB_WR_RDMA_WRITE,
  507. IB_WR_RDMA_WRITE_WITH_IMM,
  508. IB_WR_SEND,
  509. IB_WR_SEND_WITH_IMM,
  510. IB_WR_RDMA_READ,
  511. IB_WR_ATOMIC_CMP_AND_SWP,
  512. IB_WR_ATOMIC_FETCH_AND_ADD
  513. };
  514. enum ib_send_flags {
  515. IB_SEND_FENCE = 1,
  516. IB_SEND_SIGNALED = (1<<1),
  517. IB_SEND_SOLICITED = (1<<2),
  518. IB_SEND_INLINE = (1<<3)
  519. };
  520. struct ib_sge {
  521. u64 addr;
  522. u32 length;
  523. u32 lkey;
  524. };
  525. struct ib_send_wr {
  526. struct ib_send_wr *next;
  527. u64 wr_id;
  528. struct ib_sge *sg_list;
  529. int num_sge;
  530. enum ib_wr_opcode opcode;
  531. int send_flags;
  532. __be32 imm_data;
  533. union {
  534. struct {
  535. u64 remote_addr;
  536. u32 rkey;
  537. } rdma;
  538. struct {
  539. u64 remote_addr;
  540. u64 compare_add;
  541. u64 swap;
  542. u32 rkey;
  543. } atomic;
  544. struct {
  545. struct ib_ah *ah;
  546. u32 remote_qpn;
  547. u32 remote_qkey;
  548. u16 pkey_index; /* valid for GSI only */
  549. u8 port_num; /* valid for DR SMPs on switch only */
  550. } ud;
  551. } wr;
  552. };
  553. struct ib_recv_wr {
  554. struct ib_recv_wr *next;
  555. u64 wr_id;
  556. struct ib_sge *sg_list;
  557. int num_sge;
  558. };
  559. enum ib_access_flags {
  560. IB_ACCESS_LOCAL_WRITE = 1,
  561. IB_ACCESS_REMOTE_WRITE = (1<<1),
  562. IB_ACCESS_REMOTE_READ = (1<<2),
  563. IB_ACCESS_REMOTE_ATOMIC = (1<<3),
  564. IB_ACCESS_MW_BIND = (1<<4)
  565. };
  566. struct ib_phys_buf {
  567. u64 addr;
  568. u64 size;
  569. };
  570. struct ib_mr_attr {
  571. struct ib_pd *pd;
  572. u64 device_virt_addr;
  573. u64 size;
  574. int mr_access_flags;
  575. u32 lkey;
  576. u32 rkey;
  577. };
  578. enum ib_mr_rereg_flags {
  579. IB_MR_REREG_TRANS = 1,
  580. IB_MR_REREG_PD = (1<<1),
  581. IB_MR_REREG_ACCESS = (1<<2)
  582. };
  583. struct ib_mw_bind {
  584. struct ib_mr *mr;
  585. u64 wr_id;
  586. u64 addr;
  587. u32 length;
  588. int send_flags;
  589. int mw_access_flags;
  590. };
  591. struct ib_fmr_attr {
  592. int max_pages;
  593. int max_maps;
  594. u8 page_size;
  595. };
  596. struct ib_ucontext {
  597. struct ib_device *device;
  598. struct list_head pd_list;
  599. struct list_head mr_list;
  600. struct list_head mw_list;
  601. struct list_head cq_list;
  602. struct list_head qp_list;
  603. struct list_head srq_list;
  604. struct list_head ah_list;
  605. };
  606. struct ib_uobject {
  607. u64 user_handle; /* handle given to us by userspace */
  608. struct ib_ucontext *context; /* associated user context */
  609. struct list_head list; /* link to context's list */
  610. u32 id; /* index into kernel idr */
  611. };
  612. struct ib_umem {
  613. unsigned long user_base;
  614. unsigned long virt_base;
  615. size_t length;
  616. int offset;
  617. int page_size;
  618. int writable;
  619. struct list_head chunk_list;
  620. };
  621. struct ib_umem_chunk {
  622. struct list_head list;
  623. int nents;
  624. int nmap;
  625. struct scatterlist page_list[0];
  626. };
  627. struct ib_udata {
  628. void __user *inbuf;
  629. void __user *outbuf;
  630. size_t inlen;
  631. size_t outlen;
  632. };
  633. #define IB_UMEM_MAX_PAGE_CHUNK \
  634. ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) / \
  635. ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] - \
  636. (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
  637. struct ib_umem_object {
  638. struct ib_uobject uobject;
  639. struct ib_umem umem;
  640. };
  641. struct ib_pd {
  642. struct ib_device *device;
  643. struct ib_uobject *uobject;
  644. atomic_t usecnt; /* count all resources */
  645. };
  646. struct ib_ah {
  647. struct ib_device *device;
  648. struct ib_pd *pd;
  649. struct ib_uobject *uobject;
  650. };
  651. typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
  652. struct ib_cq {
  653. struct ib_device *device;
  654. struct ib_uobject *uobject;
  655. ib_comp_handler comp_handler;
  656. void (*event_handler)(struct ib_event *, void *);
  657. void * cq_context;
  658. int cqe;
  659. atomic_t usecnt; /* count number of work queues */
  660. };
  661. struct ib_srq {
  662. struct ib_device *device;
  663. struct ib_pd *pd;
  664. struct ib_uobject *uobject;
  665. void (*event_handler)(struct ib_event *, void *);
  666. void *srq_context;
  667. atomic_t usecnt;
  668. };
  669. struct ib_qp {
  670. struct ib_device *device;
  671. struct ib_pd *pd;
  672. struct ib_cq *send_cq;
  673. struct ib_cq *recv_cq;
  674. struct ib_srq *srq;
  675. struct ib_uobject *uobject;
  676. void (*event_handler)(struct ib_event *, void *);
  677. void *qp_context;
  678. u32 qp_num;
  679. enum ib_qp_type qp_type;
  680. };
  681. struct ib_mr {
  682. struct ib_device *device;
  683. struct ib_pd *pd;
  684. struct ib_uobject *uobject;
  685. u32 lkey;
  686. u32 rkey;
  687. atomic_t usecnt; /* count number of MWs */
  688. };
  689. struct ib_mw {
  690. struct ib_device *device;
  691. struct ib_pd *pd;
  692. struct ib_uobject *uobject;
  693. u32 rkey;
  694. };
  695. struct ib_fmr {
  696. struct ib_device *device;
  697. struct ib_pd *pd;
  698. struct list_head list;
  699. u32 lkey;
  700. u32 rkey;
  701. };
  702. struct ib_mad;
  703. struct ib_grh;
  704. enum ib_process_mad_flags {
  705. IB_MAD_IGNORE_MKEY = 1,
  706. IB_MAD_IGNORE_BKEY = 2,
  707. IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
  708. };
  709. enum ib_mad_result {
  710. IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
  711. IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
  712. IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
  713. IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
  714. };
  715. #define IB_DEVICE_NAME_MAX 64
  716. struct ib_cache {
  717. rwlock_t lock;
  718. struct ib_event_handler event_handler;
  719. struct ib_pkey_cache **pkey_cache;
  720. struct ib_gid_cache **gid_cache;
  721. };
  722. struct ib_device {
  723. struct device *dma_device;
  724. char name[IB_DEVICE_NAME_MAX];
  725. struct list_head event_handler_list;
  726. spinlock_t event_handler_lock;
  727. struct list_head core_list;
  728. struct list_head client_data_list;
  729. spinlock_t client_data_lock;
  730. struct ib_cache cache;
  731. u32 flags;
  732. int (*query_device)(struct ib_device *device,
  733. struct ib_device_attr *device_attr);
  734. int (*query_port)(struct ib_device *device,
  735. u8 port_num,
  736. struct ib_port_attr *port_attr);
  737. int (*query_gid)(struct ib_device *device,
  738. u8 port_num, int index,
  739. union ib_gid *gid);
  740. int (*query_pkey)(struct ib_device *device,
  741. u8 port_num, u16 index, u16 *pkey);
  742. int (*modify_device)(struct ib_device *device,
  743. int device_modify_mask,
  744. struct ib_device_modify *device_modify);
  745. int (*modify_port)(struct ib_device *device,
  746. u8 port_num, int port_modify_mask,
  747. struct ib_port_modify *port_modify);
  748. struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
  749. struct ib_udata *udata);
  750. int (*dealloc_ucontext)(struct ib_ucontext *context);
  751. int (*mmap)(struct ib_ucontext *context,
  752. struct vm_area_struct *vma);
  753. struct ib_pd * (*alloc_pd)(struct ib_device *device,
  754. struct ib_ucontext *context,
  755. struct ib_udata *udata);
  756. int (*dealloc_pd)(struct ib_pd *pd);
  757. struct ib_ah * (*create_ah)(struct ib_pd *pd,
  758. struct ib_ah_attr *ah_attr);
  759. int (*modify_ah)(struct ib_ah *ah,
  760. struct ib_ah_attr *ah_attr);
  761. int (*query_ah)(struct ib_ah *ah,
  762. struct ib_ah_attr *ah_attr);
  763. int (*destroy_ah)(struct ib_ah *ah);
  764. struct ib_srq * (*create_srq)(struct ib_pd *pd,
  765. struct ib_srq_init_attr *srq_init_attr,
  766. struct ib_udata *udata);
  767. int (*modify_srq)(struct ib_srq *srq,
  768. struct ib_srq_attr *srq_attr,
  769. enum ib_srq_attr_mask srq_attr_mask);
  770. int (*query_srq)(struct ib_srq *srq,
  771. struct ib_srq_attr *srq_attr);
  772. int (*destroy_srq)(struct ib_srq *srq);
  773. int (*post_srq_recv)(struct ib_srq *srq,
  774. struct ib_recv_wr *recv_wr,
  775. struct ib_recv_wr **bad_recv_wr);
  776. struct ib_qp * (*create_qp)(struct ib_pd *pd,
  777. struct ib_qp_init_attr *qp_init_attr,
  778. struct ib_udata *udata);
  779. int (*modify_qp)(struct ib_qp *qp,
  780. struct ib_qp_attr *qp_attr,
  781. int qp_attr_mask);
  782. int (*query_qp)(struct ib_qp *qp,
  783. struct ib_qp_attr *qp_attr,
  784. int qp_attr_mask,
  785. struct ib_qp_init_attr *qp_init_attr);
  786. int (*destroy_qp)(struct ib_qp *qp);
  787. int (*post_send)(struct ib_qp *qp,
  788. struct ib_send_wr *send_wr,
  789. struct ib_send_wr **bad_send_wr);
  790. int (*post_recv)(struct ib_qp *qp,
  791. struct ib_recv_wr *recv_wr,
  792. struct ib_recv_wr **bad_recv_wr);
  793. struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
  794. struct ib_ucontext *context,
  795. struct ib_udata *udata);
  796. int (*destroy_cq)(struct ib_cq *cq);
  797. int (*resize_cq)(struct ib_cq *cq, int cqe);
  798. int (*poll_cq)(struct ib_cq *cq, int num_entries,
  799. struct ib_wc *wc);
  800. int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
  801. int (*req_notify_cq)(struct ib_cq *cq,
  802. enum ib_cq_notify cq_notify);
  803. int (*req_ncomp_notif)(struct ib_cq *cq,
  804. int wc_cnt);
  805. struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
  806. int mr_access_flags);
  807. struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
  808. struct ib_phys_buf *phys_buf_array,
  809. int num_phys_buf,
  810. int mr_access_flags,
  811. u64 *iova_start);
  812. struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
  813. struct ib_umem *region,
  814. int mr_access_flags,
  815. struct ib_udata *udata);
  816. int (*query_mr)(struct ib_mr *mr,
  817. struct ib_mr_attr *mr_attr);
  818. int (*dereg_mr)(struct ib_mr *mr);
  819. int (*rereg_phys_mr)(struct ib_mr *mr,
  820. int mr_rereg_mask,
  821. struct ib_pd *pd,
  822. struct ib_phys_buf *phys_buf_array,
  823. int num_phys_buf,
  824. int mr_access_flags,
  825. u64 *iova_start);
  826. struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
  827. int (*bind_mw)(struct ib_qp *qp,
  828. struct ib_mw *mw,
  829. struct ib_mw_bind *mw_bind);
  830. int (*dealloc_mw)(struct ib_mw *mw);
  831. struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
  832. int mr_access_flags,
  833. struct ib_fmr_attr *fmr_attr);
  834. int (*map_phys_fmr)(struct ib_fmr *fmr,
  835. u64 *page_list, int list_len,
  836. u64 iova);
  837. int (*unmap_fmr)(struct list_head *fmr_list);
  838. int (*dealloc_fmr)(struct ib_fmr *fmr);
  839. int (*attach_mcast)(struct ib_qp *qp,
  840. union ib_gid *gid,
  841. u16 lid);
  842. int (*detach_mcast)(struct ib_qp *qp,
  843. union ib_gid *gid,
  844. u16 lid);
  845. int (*process_mad)(struct ib_device *device,
  846. int process_mad_flags,
  847. u8 port_num,
  848. struct ib_wc *in_wc,
  849. struct ib_grh *in_grh,
  850. struct ib_mad *in_mad,
  851. struct ib_mad *out_mad);
  852. struct module *owner;
  853. struct class_device class_dev;
  854. struct kobject ports_parent;
  855. struct list_head port_list;
  856. enum {
  857. IB_DEV_UNINITIALIZED,
  858. IB_DEV_REGISTERED,
  859. IB_DEV_UNREGISTERED
  860. } reg_state;
  861. u64 uverbs_cmd_mask;
  862. int uverbs_abi_ver;
  863. __be64 node_guid;
  864. u8 node_type;
  865. u8 phys_port_cnt;
  866. };
  867. struct ib_client {
  868. char *name;
  869. void (*add) (struct ib_device *);
  870. void (*remove)(struct ib_device *);
  871. struct list_head list;
  872. };
  873. struct ib_device *ib_alloc_device(size_t size);
  874. void ib_dealloc_device(struct ib_device *device);
  875. int ib_register_device (struct ib_device *device);
  876. void ib_unregister_device(struct ib_device *device);
  877. int ib_register_client (struct ib_client *client);
  878. void ib_unregister_client(struct ib_client *client);
  879. void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
  880. void ib_set_client_data(struct ib_device *device, struct ib_client *client,
  881. void *data);
  882. static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
  883. {
  884. return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
  885. }
  886. static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
  887. {
  888. return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
  889. }
  890. int ib_register_event_handler (struct ib_event_handler *event_handler);
  891. int ib_unregister_event_handler(struct ib_event_handler *event_handler);
  892. void ib_dispatch_event(struct ib_event *event);
  893. int ib_query_device(struct ib_device *device,
  894. struct ib_device_attr *device_attr);
  895. int ib_query_port(struct ib_device *device,
  896. u8 port_num, struct ib_port_attr *port_attr);
  897. int ib_query_gid(struct ib_device *device,
  898. u8 port_num, int index, union ib_gid *gid);
  899. int ib_query_pkey(struct ib_device *device,
  900. u8 port_num, u16 index, u16 *pkey);
  901. int ib_modify_device(struct ib_device *device,
  902. int device_modify_mask,
  903. struct ib_device_modify *device_modify);
  904. int ib_modify_port(struct ib_device *device,
  905. u8 port_num, int port_modify_mask,
  906. struct ib_port_modify *port_modify);
  907. /**
  908. * ib_alloc_pd - Allocates an unused protection domain.
  909. * @device: The device on which to allocate the protection domain.
  910. *
  911. * A protection domain object provides an association between QPs, shared
  912. * receive queues, address handles, memory regions, and memory windows.
  913. */
  914. struct ib_pd *ib_alloc_pd(struct ib_device *device);
  915. /**
  916. * ib_dealloc_pd - Deallocates a protection domain.
  917. * @pd: The protection domain to deallocate.
  918. */
  919. int ib_dealloc_pd(struct ib_pd *pd);
  920. /**
  921. * ib_create_ah - Creates an address handle for the given address vector.
  922. * @pd: The protection domain associated with the address handle.
  923. * @ah_attr: The attributes of the address vector.
  924. *
  925. * The address handle is used to reference a local or global destination
  926. * in all UD QP post sends.
  927. */
  928. struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
  929. /**
  930. * ib_create_ah_from_wc - Creates an address handle associated with the
  931. * sender of the specified work completion.
  932. * @pd: The protection domain associated with the address handle.
  933. * @wc: Work completion information associated with a received message.
  934. * @grh: References the received global route header. This parameter is
  935. * ignored unless the work completion indicates that the GRH is valid.
  936. * @port_num: The outbound port number to associate with the address.
  937. *
  938. * The address handle is used to reference a local or global destination
  939. * in all UD QP post sends.
  940. */
  941. struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
  942. struct ib_grh *grh, u8 port_num);
  943. /**
  944. * ib_modify_ah - Modifies the address vector associated with an address
  945. * handle.
  946. * @ah: The address handle to modify.
  947. * @ah_attr: The new address vector attributes to associate with the
  948. * address handle.
  949. */
  950. int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
  951. /**
  952. * ib_query_ah - Queries the address vector associated with an address
  953. * handle.
  954. * @ah: The address handle to query.
  955. * @ah_attr: The address vector attributes associated with the address
  956. * handle.
  957. */
  958. int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
  959. /**
  960. * ib_destroy_ah - Destroys an address handle.
  961. * @ah: The address handle to destroy.
  962. */
  963. int ib_destroy_ah(struct ib_ah *ah);
  964. /**
  965. * ib_create_srq - Creates a SRQ associated with the specified protection
  966. * domain.
  967. * @pd: The protection domain associated with the SRQ.
  968. * @srq_init_attr: A list of initial attributes required to create the SRQ.
  969. *
  970. * srq_attr->max_wr and srq_attr->max_sge are read the determine the
  971. * requested size of the SRQ, and set to the actual values allocated
  972. * on return. If ib_create_srq() succeeds, then max_wr and max_sge
  973. * will always be at least as large as the requested values.
  974. */
  975. struct ib_srq *ib_create_srq(struct ib_pd *pd,
  976. struct ib_srq_init_attr *srq_init_attr);
  977. /**
  978. * ib_modify_srq - Modifies the attributes for the specified SRQ.
  979. * @srq: The SRQ to modify.
  980. * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
  981. * the current values of selected SRQ attributes are returned.
  982. * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
  983. * are being modified.
  984. *
  985. * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
  986. * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
  987. * the number of receives queued drops below the limit.
  988. */
  989. int ib_modify_srq(struct ib_srq *srq,
  990. struct ib_srq_attr *srq_attr,
  991. enum ib_srq_attr_mask srq_attr_mask);
  992. /**
  993. * ib_query_srq - Returns the attribute list and current values for the
  994. * specified SRQ.
  995. * @srq: The SRQ to query.
  996. * @srq_attr: The attributes of the specified SRQ.
  997. */
  998. int ib_query_srq(struct ib_srq *srq,
  999. struct ib_srq_attr *srq_attr);
  1000. /**
  1001. * ib_destroy_srq - Destroys the specified SRQ.
  1002. * @srq: The SRQ to destroy.
  1003. */
  1004. int ib_destroy_srq(struct ib_srq *srq);
  1005. /**
  1006. * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
  1007. * @srq: The SRQ to post the work request on.
  1008. * @recv_wr: A list of work requests to post on the receive queue.
  1009. * @bad_recv_wr: On an immediate failure, this parameter will reference
  1010. * the work request that failed to be posted on the QP.
  1011. */
  1012. static inline int ib_post_srq_recv(struct ib_srq *srq,
  1013. struct ib_recv_wr *recv_wr,
  1014. struct ib_recv_wr **bad_recv_wr)
  1015. {
  1016. return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
  1017. }
  1018. /**
  1019. * ib_create_qp - Creates a QP associated with the specified protection
  1020. * domain.
  1021. * @pd: The protection domain associated with the QP.
  1022. * @qp_init_attr: A list of initial attributes required to create the QP.
  1023. */
  1024. struct ib_qp *ib_create_qp(struct ib_pd *pd,
  1025. struct ib_qp_init_attr *qp_init_attr);
  1026. /**
  1027. * ib_modify_qp - Modifies the attributes for the specified QP and then
  1028. * transitions the QP to the given state.
  1029. * @qp: The QP to modify.
  1030. * @qp_attr: On input, specifies the QP attributes to modify. On output,
  1031. * the current values of selected QP attributes are returned.
  1032. * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
  1033. * are being modified.
  1034. */
  1035. int ib_modify_qp(struct ib_qp *qp,
  1036. struct ib_qp_attr *qp_attr,
  1037. int qp_attr_mask);
  1038. /**
  1039. * ib_query_qp - Returns the attribute list and current values for the
  1040. * specified QP.
  1041. * @qp: The QP to query.
  1042. * @qp_attr: The attributes of the specified QP.
  1043. * @qp_attr_mask: A bit-mask used to select specific attributes to query.
  1044. * @qp_init_attr: Additional attributes of the selected QP.
  1045. *
  1046. * The qp_attr_mask may be used to limit the query to gathering only the
  1047. * selected attributes.
  1048. */
  1049. int ib_query_qp(struct ib_qp *qp,
  1050. struct ib_qp_attr *qp_attr,
  1051. int qp_attr_mask,
  1052. struct ib_qp_init_attr *qp_init_attr);
  1053. /**
  1054. * ib_destroy_qp - Destroys the specified QP.
  1055. * @qp: The QP to destroy.
  1056. */
  1057. int ib_destroy_qp(struct ib_qp *qp);
  1058. /**
  1059. * ib_post_send - Posts a list of work requests to the send queue of
  1060. * the specified QP.
  1061. * @qp: The QP to post the work request on.
  1062. * @send_wr: A list of work requests to post on the send queue.
  1063. * @bad_send_wr: On an immediate failure, this parameter will reference
  1064. * the work request that failed to be posted on the QP.
  1065. */
  1066. static inline int ib_post_send(struct ib_qp *qp,
  1067. struct ib_send_wr *send_wr,
  1068. struct ib_send_wr **bad_send_wr)
  1069. {
  1070. return qp->device->post_send(qp, send_wr, bad_send_wr);
  1071. }
  1072. /**
  1073. * ib_post_recv - Posts a list of work requests to the receive queue of
  1074. * the specified QP.
  1075. * @qp: The QP to post the work request on.
  1076. * @recv_wr: A list of work requests to post on the receive queue.
  1077. * @bad_recv_wr: On an immediate failure, this parameter will reference
  1078. * the work request that failed to be posted on the QP.
  1079. */
  1080. static inline int ib_post_recv(struct ib_qp *qp,
  1081. struct ib_recv_wr *recv_wr,
  1082. struct ib_recv_wr **bad_recv_wr)
  1083. {
  1084. return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
  1085. }
  1086. /**
  1087. * ib_create_cq - Creates a CQ on the specified device.
  1088. * @device: The device on which to create the CQ.
  1089. * @comp_handler: A user-specified callback that is invoked when a
  1090. * completion event occurs on the CQ.
  1091. * @event_handler: A user-specified callback that is invoked when an
  1092. * asynchronous event not associated with a completion occurs on the CQ.
  1093. * @cq_context: Context associated with the CQ returned to the user via
  1094. * the associated completion and event handlers.
  1095. * @cqe: The minimum size of the CQ.
  1096. *
  1097. * Users can examine the cq structure to determine the actual CQ size.
  1098. */
  1099. struct ib_cq *ib_create_cq(struct ib_device *device,
  1100. ib_comp_handler comp_handler,
  1101. void (*event_handler)(struct ib_event *, void *),
  1102. void *cq_context, int cqe);
  1103. /**
  1104. * ib_resize_cq - Modifies the capacity of the CQ.
  1105. * @cq: The CQ to resize.
  1106. * @cqe: The minimum size of the CQ.
  1107. *
  1108. * Users can examine the cq structure to determine the actual CQ size.
  1109. */
  1110. int ib_resize_cq(struct ib_cq *cq, int cqe);
  1111. /**
  1112. * ib_destroy_cq - Destroys the specified CQ.
  1113. * @cq: The CQ to destroy.
  1114. */
  1115. int ib_destroy_cq(struct ib_cq *cq);
  1116. /**
  1117. * ib_poll_cq - poll a CQ for completion(s)
  1118. * @cq:the CQ being polled
  1119. * @num_entries:maximum number of completions to return
  1120. * @wc:array of at least @num_entries &struct ib_wc where completions
  1121. * will be returned
  1122. *
  1123. * Poll a CQ for (possibly multiple) completions. If the return value
  1124. * is < 0, an error occurred. If the return value is >= 0, it is the
  1125. * number of completions returned. If the return value is
  1126. * non-negative and < num_entries, then the CQ was emptied.
  1127. */
  1128. static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
  1129. struct ib_wc *wc)
  1130. {
  1131. return cq->device->poll_cq(cq, num_entries, wc);
  1132. }
  1133. /**
  1134. * ib_peek_cq - Returns the number of unreaped completions currently
  1135. * on the specified CQ.
  1136. * @cq: The CQ to peek.
  1137. * @wc_cnt: A minimum number of unreaped completions to check for.
  1138. *
  1139. * If the number of unreaped completions is greater than or equal to wc_cnt,
  1140. * this function returns wc_cnt, otherwise, it returns the actual number of
  1141. * unreaped completions.
  1142. */
  1143. int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
  1144. /**
  1145. * ib_req_notify_cq - Request completion notification on a CQ.
  1146. * @cq: The CQ to generate an event for.
  1147. * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
  1148. * occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
  1149. * notification will occur on the next completion.
  1150. */
  1151. static inline int ib_req_notify_cq(struct ib_cq *cq,
  1152. enum ib_cq_notify cq_notify)
  1153. {
  1154. return cq->device->req_notify_cq(cq, cq_notify);
  1155. }
  1156. /**
  1157. * ib_req_ncomp_notif - Request completion notification when there are
  1158. * at least the specified number of unreaped completions on the CQ.
  1159. * @cq: The CQ to generate an event for.
  1160. * @wc_cnt: The number of unreaped completions that should be on the
  1161. * CQ before an event is generated.
  1162. */
  1163. static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
  1164. {
  1165. return cq->device->req_ncomp_notif ?
  1166. cq->device->req_ncomp_notif(cq, wc_cnt) :
  1167. -ENOSYS;
  1168. }
  1169. /**
  1170. * ib_get_dma_mr - Returns a memory region for system memory that is
  1171. * usable for DMA.
  1172. * @pd: The protection domain associated with the memory region.
  1173. * @mr_access_flags: Specifies the memory access rights.
  1174. */
  1175. struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
  1176. /**
  1177. * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
  1178. * by an HCA.
  1179. * @pd: The protection domain associated assigned to the registered region.
  1180. * @phys_buf_array: Specifies a list of physical buffers to use in the
  1181. * memory region.
  1182. * @num_phys_buf: Specifies the size of the phys_buf_array.
  1183. * @mr_access_flags: Specifies the memory access rights.
  1184. * @iova_start: The offset of the region's starting I/O virtual address.
  1185. */
  1186. struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
  1187. struct ib_phys_buf *phys_buf_array,
  1188. int num_phys_buf,
  1189. int mr_access_flags,
  1190. u64 *iova_start);
  1191. /**
  1192. * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
  1193. * Conceptually, this call performs the functions deregister memory region
  1194. * followed by register physical memory region. Where possible,
  1195. * resources are reused instead of deallocated and reallocated.
  1196. * @mr: The memory region to modify.
  1197. * @mr_rereg_mask: A bit-mask used to indicate which of the following
  1198. * properties of the memory region are being modified.
  1199. * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
  1200. * the new protection domain to associated with the memory region,
  1201. * otherwise, this parameter is ignored.
  1202. * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
  1203. * field specifies a list of physical buffers to use in the new
  1204. * translation, otherwise, this parameter is ignored.
  1205. * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
  1206. * field specifies the size of the phys_buf_array, otherwise, this
  1207. * parameter is ignored.
  1208. * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
  1209. * field specifies the new memory access rights, otherwise, this
  1210. * parameter is ignored.
  1211. * @iova_start: The offset of the region's starting I/O virtual address.
  1212. */
  1213. int ib_rereg_phys_mr(struct ib_mr *mr,
  1214. int mr_rereg_mask,
  1215. struct ib_pd *pd,
  1216. struct ib_phys_buf *phys_buf_array,
  1217. int num_phys_buf,
  1218. int mr_access_flags,
  1219. u64 *iova_start);
  1220. /**
  1221. * ib_query_mr - Retrieves information about a specific memory region.
  1222. * @mr: The memory region to retrieve information about.
  1223. * @mr_attr: The attributes of the specified memory region.
  1224. */
  1225. int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
  1226. /**
  1227. * ib_dereg_mr - Deregisters a memory region and removes it from the
  1228. * HCA translation table.
  1229. * @mr: The memory region to deregister.
  1230. */
  1231. int ib_dereg_mr(struct ib_mr *mr);
  1232. /**
  1233. * ib_alloc_mw - Allocates a memory window.
  1234. * @pd: The protection domain associated with the memory window.
  1235. */
  1236. struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
  1237. /**
  1238. * ib_bind_mw - Posts a work request to the send queue of the specified
  1239. * QP, which binds the memory window to the given address range and
  1240. * remote access attributes.
  1241. * @qp: QP to post the bind work request on.
  1242. * @mw: The memory window to bind.
  1243. * @mw_bind: Specifies information about the memory window, including
  1244. * its address range, remote access rights, and associated memory region.
  1245. */
  1246. static inline int ib_bind_mw(struct ib_qp *qp,
  1247. struct ib_mw *mw,
  1248. struct ib_mw_bind *mw_bind)
  1249. {
  1250. /* XXX reference counting in corresponding MR? */
  1251. return mw->device->bind_mw ?
  1252. mw->device->bind_mw(qp, mw, mw_bind) :
  1253. -ENOSYS;
  1254. }
  1255. /**
  1256. * ib_dealloc_mw - Deallocates a memory window.
  1257. * @mw: The memory window to deallocate.
  1258. */
  1259. int ib_dealloc_mw(struct ib_mw *mw);
  1260. /**
  1261. * ib_alloc_fmr - Allocates a unmapped fast memory region.
  1262. * @pd: The protection domain associated with the unmapped region.
  1263. * @mr_access_flags: Specifies the memory access rights.
  1264. * @fmr_attr: Attributes of the unmapped region.
  1265. *
  1266. * A fast memory region must be mapped before it can be used as part of
  1267. * a work request.
  1268. */
  1269. struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
  1270. int mr_access_flags,
  1271. struct ib_fmr_attr *fmr_attr);
  1272. /**
  1273. * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
  1274. * @fmr: The fast memory region to associate with the pages.
  1275. * @page_list: An array of physical pages to map to the fast memory region.
  1276. * @list_len: The number of pages in page_list.
  1277. * @iova: The I/O virtual address to use with the mapped region.
  1278. */
  1279. static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
  1280. u64 *page_list, int list_len,
  1281. u64 iova)
  1282. {
  1283. return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
  1284. }
  1285. /**
  1286. * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
  1287. * @fmr_list: A linked list of fast memory regions to unmap.
  1288. */
  1289. int ib_unmap_fmr(struct list_head *fmr_list);
  1290. /**
  1291. * ib_dealloc_fmr - Deallocates a fast memory region.
  1292. * @fmr: The fast memory region to deallocate.
  1293. */
  1294. int ib_dealloc_fmr(struct ib_fmr *fmr);
  1295. /**
  1296. * ib_attach_mcast - Attaches the specified QP to a multicast group.
  1297. * @qp: QP to attach to the multicast group. The QP must be type
  1298. * IB_QPT_UD.
  1299. * @gid: Multicast group GID.
  1300. * @lid: Multicast group LID in host byte order.
  1301. *
  1302. * In order to send and receive multicast packets, subnet
  1303. * administration must have created the multicast group and configured
  1304. * the fabric appropriately. The port associated with the specified
  1305. * QP must also be a member of the multicast group.
  1306. */
  1307. int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
  1308. /**
  1309. * ib_detach_mcast - Detaches the specified QP from a multicast group.
  1310. * @qp: QP to detach from the multicast group.
  1311. * @gid: Multicast group GID.
  1312. * @lid: Multicast group LID in host byte order.
  1313. */
  1314. int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
  1315. #endif /* IB_VERBS_H */