ibis(1) - f34

1IBIS(1)             IB MANAGEMENT IN-BAND SERVICES PACKAGE             IBIS(1)
2
3
4

NAME

6       ibis - IB management Inband Services - an extended TCL shell
7

SYNOPSYS

9       ibis [-port_num <port number to attach to>]
10

DESCRIPTION

12       ibis is a TCL shell extended with interface for sending and receiving
13       IB management datagrams (MADS).  To use this shell you will write TCL
14       code that excersizes the regular TCL command and the special API pro‐
15       vided by this extension. Interactive use is also possible and is
16       greatly enhanced if tclreadline package is available on the machine.
17
18       The following sub sections provide detailed definition for the API and
19       global objects defined by the extension. The different MADs APIs are
20       group by the management class.
21

IBIS Constants

23       These constants are provided by IBIS:
24
25       Log Verbosity Flags
26
27       [ Constant : int  ] $IBIS_LOG_NONE = 0x00
28       [ Constant : int  ] $IBIS_LOG_ERROR = 0x01
29       [ Constant : int  ] $IBIS_LOG_INFO = 0x02
30       [ Constant : int  ] $IBIS_LOG_VERBOSE = 0x04
31       [ Constant : int  ] $IBIS_LOG_DEBUG = 0x08
32       [ Constant : int  ] $IBIS_LOG_FUNCS = 0x10
33       [ Constant : int  ] $IBIS_LOG_FRAMES = 0x20
34

IBIS Functions

36       This section provide the details about the functions IBIS exposes.
37       They all return 0 on succes.
38
39       [return list] ibis_get_local_ports_info
40           Return the list of available IB ports with GUID, LID, state and
41           port number.
42
43       [ returns int  ] ibis_init
44           Initialize ibis object
45
46       [ returns int  ] ibis_set_verbosity level
47           Change the log verbosity
48
49       [ returns int  ] ibis_set_port guid
50           Set the port IBIS is attached to and initialize all sub packages.
51           Must be called once during ibis operation.
52
53       [ returns new_uint64_t  ] ibis_get_port
54           Provide the GUID of the port IBIS is attached to
55
56       [ returns int  ] ibis_set_transaction_timeout timeout_ms
57           Set the transaction time out in [msec]
58
59       [ returns int  ] ibis_exit
60           Exit IBIS.
61
62       [ returns int  ] ibis_puts verbosity msg
63           Appends a message to the OpenSM log
64
65       IBIS Options Object
66
67           The IBIS options are available through the predefined object:
68           ibis_opts.  It can be manipulated using the standard Tcl methods:
69           cget and configure.  Examples:
70
71              ibis_opts cget -force_log_flush
72
73              ibis_opts configure -force_log_flush TRUE
74
75           The following are the different options that can be configured:
76
77       [ Member data: returns boolean_t * ] -single_thread
78           Run single threaded
79
80       [ Member data: returns boolean_t * ] -force_log_flush
81           If TRUE - forces flash after each log message (TRUE).
82
83       [ Member data: returns uint8_t * ] -log_flags
84           The log levels to be used
85
86       [ Member data: returns char * ] -log_file
87           The name of the log file to be used.Must be configured before
88           ibis_init is used to make an affect
89
90       [ Member data: returns uint64_t * ] -sm_key
91           The SM_Key to be used when sending SubnetMgt and SubnetAdmin MADs
92
93       [ Member data: returns uint64_t * ] -m_key
94           The M_Key to be used when sending SubnetMgt
95
96       [ Member data: returns uint64_t * ] -v_key
97           The Vendor Key to be used when sending Vendor Specific MADs.
98

IBPM

100       IBPM stands for IB Performance Monitoring MADs. IB provides standard
101       facilities for tracking statistics on every port.
102
103       This section provide the details about the functions IBPM exposes.
104       They all return 0 on succes.
105
106       [ returns int  ] pmMultiMaxGet
107           Obtain the maximal number of parallel queries that can be sent
108
109       [ returns int  ] pmGetPortCounters lid port_select
110           Send a "PortCounters" query to teh given LID and port
111
112       [ returns int  ] pmGetPortCountersMulti num lid_list port_select_list
113           Send a batch of "PortCounters" queries to the given list of LIDs
114           and ports.  num - defines the number of elements in each list.
115
116       [ returns int  ] pmGetExtPortCountersMulti num lid_list
117       port_select_list
118           Send a batch of "ExtendedPortCounters" queries to the given list of
119           LIDs and ports.  num - defines the number of elements in each list.
120
121       [ returns int  ] pmClrAllCounters lid port_select
122           Sends a command to "clear all counters" on the given LID and port
123
124       [ returns int  ] pmClrAllCountersMulti num lid_list port_select_list
125           Send a batch of "clear all counters" commands to the given list of
126           LIDs and ports.  num - defines the number of elements in each list.
127

IBSAC

129       IBSAC stands for IB Subnet Administrator (SA) Client. It provide means
130       to query the SA for information about the various objects it manages
131
132       The following sections describe the concepts behind the SAC interface
133       and then provides detailed description of each attribute that can be
134       queried.
135
136       IBSAC Objects
137
138           IBSAC uses predefined global objects to facilitate SA Queries.
139           Such objects are named sac<Attribute>Query. Each such object
140           exposes a standard set of methods:
141
142       dump
143           dump out all fields and values for the obejct
144
145       cget -<field>:
146           obtain the value of the given field
147
148       configure -<field> <value>:
149           set the field value
150
151       get <comp mask>:
152           query the SA for one record using the component mask and field val‐
153           ues as set on the query object
154
155       getTable <comp mask>:
156           query the SA for all records matching component mask and field val‐
157           ues as set on the query object
158
159           Some SA maintained objects support the "set" and "delete" methods.
160           In that case the following methods are made available on the corre‐
161           sponding query object:
162
163       set <comp mask>:
164           send a set method to the SA with the component mask and field val‐
165           ues as set on the query object
166
167       delete <comp mask>:
168           send a delete method to the SA with the component mask and field
169           values as set on the query object
170
171       Returned Objects
172
173       This section describes the values returned from the get/get‐
174       Table/set/delete methods of the query objects:
175
176       Each query returns a list (or one) identifiers (pointers) for objects.
177       There identifiers are formatted according to the type of object they
178       point to using the following prefixes:
179
180       Queries embedding Subnet Management Attributes:
181
182       ni:<idx>   = node info
183       nr:<idx>   = node info record (SA RID + node info)
184       pi:<idx>   = port info
185       pir:<idx>  = port info record (SA RID + port info)
186       smi:<idx>  = SM info
187       smir:<idx> = SM info record (SA RID + SM info)
188       swi:<idx>  = switch info
189       swir:<idx> = switch info record (SA RID + switch info)
190       slvt:<idx> = SL to VL table
191       slvr:<idx> = SL to VL table Record (SA RID + SL to VL table)
192       pkt:<idx>  = PKey table
193       pkr:<idx>  = PKey table record (SA RID + PKey table)
194           Queries of non embedded attributes:
195
196       link:<idx> = link record
197       path:<idx> = path record
198       lft:<idx>  = Linear forwarding table
199       mcm:<idx>  = Multicast Member Record
200       cpi:<idx>  = SA Class Port Info
201       info:<idx> = Inform info (registration of event forwarding)
202       svc:<idx>  = Service Record
203       vlarb:<idx>= VL Arbitration table record
204
205       NODE INFO RECORD
206
207           Component mask bits:
208
209       [ Constant : int  ] $IB_NR_COMPMASK_LID = 0x1
210       [ Constant : int  ] $IB_NR_COMPMASK_RESERVED1 = 0x2
211       [ Constant : int  ] $IB_NR_COMPMASK_BASEVERSION = 0x4
212       [ Constant : int  ] $IB_NR_COMPMASK_CLASSVERSION = 0x8
213       [ Constant : int  ] $IB_NR_COMPMASK_NODETYPE = 0x10
214       [ Constant : int  ] $IB_NR_COMPMASK_NUMPORTS = 0x20
215       [ Constant : int  ] $IB_NR_COMPMASK_SYSIMAGEGUID = 0x40
216       [ Constant : int  ] $IB_NR_COMPMASK_NODEGUID = 0x80
217       [ Constant : int  ] $IB_NR_COMPMASK_PORTGUID = 0x100
218       [ Constant : int  ] $IB_NR_COMPMASK_PARTCAP = 0x200
219       [ Constant : int  ] $IB_NR_COMPMASK_DEVID = 0x400
220       [ Constant : int  ] $IB_NR_COMPMASK_REV = 0x800
221       [ Constant : int  ] $IB_NR_COMPMASK_PORTNUM = 0x1000
222       [ Constant : int  ] $IB_NR_COMPMASK_VENDID = 0x2000
223       [ Constant : int  ] $IB_NR_COMPMASK_NODEDESC = 0x4000
224           ----
225
226           class sacNodeInfo
227
228           Fields:
229
230       [ Member data: returns uint8_t * ] -base_version
231       [ Member data: returns uint8_t * ] -class_version
232       [ Member data: returns uint8_t * ] -node_type
233       [ Member data: returns uint8_t * ] -num_ports
234       [ Member data: returns ib_net64_t * ] -sys_guid
235       [ Member data: returns ib_net64_t * ] -node_guid
236       [ Member data: returns ib_net64_t * ] -port_guid
237       [ Member data: returns ib_net16_t * ] -partition_cap
238       [ Member data: returns ib_net16_t * ] -device_id
239       [ Member data: returns ib_net32_t * ] -revision
240       [ Member data: returns ib_net32_t * ] -port_num_vendor_id
241       [ Member : returns void  ] delete
242           ----
243
244           class sacNodeRec
245
246           RID Fields:
247
248       [ Member data: returns ib_net16_t * ] -lid
249       [ Member data: returns sacNodeInfo * ] -node_info
250       [ Member data: returns ib_node_desc_t * ] -node_desc
251           Methods:
252
253       [ Member : returns char * ] get comp_mask
254       [ Member : returns char * ] getTable comp_mask
255       [ Member : returns void  ] delete
256
257       PORT INFO RECORD
258
259           Component mask bits:
260
261       [ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1
262       [ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2
263       [ Constant : char * ] $IB_PIR_COMPMASK_RESV1 = 0x4
264       [ Constant : char * ] $IB_PIR_COMPMASK_MKEY = 0x8
265       [ Constant : int  ] $IB_PIR_COMPMASK_GIDPRE = 0x10
266       [ Constant : int  ] $IB_PIR_COMPMASK_BASELID = 0x20
267       [ Constant : int  ] $IB_PIR_COMPMASK_SMLID = 0x40
268       [ Constant : int  ] $IB_PIR_COMPMASK_CAPMASK = 0x80
269       [ Constant : int  ] $IB_PIR_COMPMASK_DIAGCODE = 0x100
270       [ Constant : int  ] $IB_PIR_COMPMASK_MKEYLEASEPRD = 0x200
271       [ Constant : int  ] $IB_PIR_COMPMASK_LOCALPORTNUM = 0x400
272       [ Constant : int  ] $IB_PIR_COMPMASK_LNKWIDTHSUPPORT = 0x800
273       [ Constant : int  ] $IB_PIR_COMPMASK_LNKWIDTHACTIVE = 0x1000
274       [ Constant : int  ] $IB_PIR_COMPMASK_LINKWIDTHENABLED = 0x2000
275       [ Constant : int  ] $IB_PIR_COMPMASK_LNKSPEEDSUPPORT = 0x4000
276       [ Constant : int  ] $IB_PIR_COMPMASK_PORTSTATE = 0x10000
277       [ Constant : int  ] $IB_PIR_COMPMASK_PORTPHYSTATE = 0x20000
278       [ Constant : int  ] $IB_PIR_COMPMASK_LINKDWNDFLTSTATE = 0x40000
279       [ Constant : int  ] $IB_PIR_COMPMASK_MKEYPROTBITS = 0x80000
280       [ Constant : int  ] $IB_PIR_COMPMASK_LMC = 0x100000
281       [ Constant : int  ] $IB_PIR_COMPMASK_LINKSPEEDACTIVE = 0x200000
282       [ Constant : int  ] $IB_PIR_COMPMASK_LINKSPEEDENABLE = 0x400000
283       [ Constant : int  ] $IB_PIR_COMPMASK_NEIGHBORMTU = 0x800000
284       [ Constant : int  ] $IB_PIR_COMPMASK_MASTERSMSL = 0x1000000
285       [ Constant : int  ] $IB_PIR_COMPMASK_VLCAP = 0x2000000
286       [ Constant : int  ] $IB_PIR_COMPMASK_INITTYPE = 0x4000000
287       [ Constant : int  ] $IB_PIR_COMPMASK_VLHIGHLIMIT = 0x8000000
288       [ Constant : int  ] $IB_PIR_COMPMASK_VLARBHIGHCAP = 0x10000000
289       [ Constant : int  ] $IB_PIR_COMPMASK_VLARBLOWCAP = 0x20000000
290       [ Constant : int  ] $IB_PIR_COMPMASK_INITTYPEREPLY = 0x40000000
291       [ Constant : int  ] $IB_PIR_COMPMASK_MTUCAP = 0x80000000
292       [ Constant : char * ] $IB_PIR_COMPMASK_VLSTALLCNT = 0x100000000
293       [ Constant : char * ] $IB_PIR_COMPMASK_HOQLIFE = 0x200000000
294       [ Constant : char * ] $IB_PIR_COMPMASK_OPVLS = 0x400000000
295       [ Constant : char * ] $IB_PIR_COMPMASK_PARENFIN = 0x800000000
296       [ Constant : char * ] $IB_PIR_COMPMASK_PARENFOUT = 0x1000000000
297       [ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWIN = 0x2000000000
298       [ Constant : char * ] $IB_PIR_COMPMASK_FILTERRAWOUT = 0x4000000000
299       [ Constant : char * ] $IB_PIR_COMPMASK_MKEYVIO = 0x8000000000
300       [ Constant : char * ] $IB_PIR_COMPMASK_PKEYVIO = 0x10000000000
301       [ Constant : char * ] $IB_PIR_COMPMASK_QKEYVIO = 0x20000000000
302       [ Constant : char * ] $IB_PIR_COMPMASK_GUIDCAP = 0x40000000000
303       [ Constant : char * ] $IB_PIR_COMPMASK_RESV2 = 0x80000000000
304       [ Constant : char * ] $IB_PIR_COMPMASK_SUBNTO = 0x100000000000
305       [ Constant : char * ] $IB_PIR_COMPMASK_RESV3 = 0x200000000000
306       [ Constant : char * ] $IB_PIR_COMPMASK_RESPTIME = 0x400000000000
307       [ Constant : char * ] $IB_PIR_COMPMASK_LOCALPHYERR = 0x800000000000
308       [ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000
309           ----
310
311           class sacPortInfo
312
313           Fields:
314
315       [ Member data: returns ib_net64_t * ] -m_key
316       [ Member data: returns ib_net64_t * ] -subnet_prefix
317       [ Member data: returns ib_net16_t * ] -base_lid
318       [ Member data: returns ib_net16_t * ] -master_sm_base_lid
319       [ Member data: returns ib_net32_t * ] -capability_mask
320       [ Member data: returns ib_net16_t * ] -diag_code
321       [ Member data: returns ib_net16_t * ] -m_key_lease_period
322       [ Member data: returns uint8_t * ] -local_port_num
323       [ Member data: returns uint8_t * ] -link_width_enabled
324       [ Member data: returns uint8_t * ] -link_width_supported
325       [ Member data: returns uint8_t * ] -link_width_active
326       [ Member data: returns uint8_t * ] -state_info1
327           LinkSpeedSupported and PortState
328
329       [ Member data: returns uint8_t * ] -state_info2
330           PortPhysState and LinkDownDefaultState
331
332       [ Member data: returns uint8_t * ] -mkey_lmc
333       [ Member data: returns uint8_t * ] -link_speed
334           LinkSpeedEnabled and LinkSpeedActive
335
336       [ Member data: returns uint8_t * ] -mtu_smsl
337       [ Member data: returns uint8_t * ] -vl_cap
338           VlCap and InitType
339
340       [ Member data: returns uint8_t * ] -vl_high_limit
341       [ Member data: returns uint8_t * ] -vl_arb_high_cap
342       [ Member data: returns uint8_t * ] -vl_arb_low_cap
343       [ Member data: returns uint8_t * ] -mtu_cap
344       [ Member data: returns uint8_t * ] -vl_stall_life
345       [ Member data: returns uint8_t * ] -vl_enforce
346       [ Member data: returns ib_net16_t * ] -m_key_violations
347       [ Member data: returns ib_net16_t * ] -p_key_violations
348       [ Member data: returns ib_net16_t * ] -q_key_violations
349       [ Member data: returns uint8_t * ] -guid_cap
350       [ Member data: returns uint8_t * ] -subnet_timeout
351       [ Member data: returns uint8_t * ] -resp_time_value
352       [ Member data: returns uint8_t * ] -error_threshold
353       [ Member : returns void  ] delete
354           ----
355
356           class sacPortRec
357
358           RID Fields:
359
360       [ Member data: returns ib_net16_t * ] -lid
361       [ Member data: returns uint8_t * ] -port_num
362       [ Member data: returns sacPortInfo * ] -port_info
363           Methods:
364
365       [ Member : returns char * ] get comp_mask
366       [ Member : returns char * ] getTable comp_mask
367       [ Member : returns void  ] delete
368
369       SM INFO RECORD
370
371           Component mask bits:
372
373       [ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1
374       [ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2
375       [ Constant : char * ] $IB_SMR_COMPMASK_SM_KEY = 0x4
376       [ Constant : char * ] $IB_SMR_COMPMASK_ACT_COUNT = 0x8
377       [ Constant : int  ] $IB_SMR_COMPMASK_STATE = 0x10
378       [ Constant : int  ] $IB_SMR_COMPMASK_PRI = 0x20
379           ----
380
381           class sacSmInfo
382
383           Fields:
384
385       [ Member data: returns ib_net64_t * ] -guid
386       [ Member data: returns ib_net64_t * ] -sm_key
387       [ Member data: returns ib_net32_t * ] -act_count
388       [ Member data: returns uint8_t * ] -pri_state
389       [ Member : returns void  ] delete
390           ----
391
392           class sacSmRec
393
394           RID Fields:
395
396       [ Member data: returns ib_net16_t * ] -lid
397       [ Member data: returns sacSmInfo * ] -sm_info
398           Methods:
399
400       [ Member : returns char * ] get comp_mask
401       [ Member : returns char * ] getTable comp_mask
402       [ Member : returns void  ] delete
403
404       SWITCH INFO RECORD
405
406           Component mask bits:
407
408       [ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1
409       [ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2
410       [ Constant : char * ] $IB_SWR_COMPMASK_RAND_CAP = 0x4
411       [ Constant : char * ] $IB_SWR_COMPMASK_MCAST_CAP = 0x8
412       [ Constant : char * ] $IB_SWR_COMPMASK_LIN_TOP = 0x10
413       [ Constant : char * ] $IB_SWR_COMPMASK_DEF_PORT = 0x20
414       [ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_PRI = 0x40
415       [ Constant : char * ] $IB_SWR_COMPMASK_DEF_MCAST_NOT = 0x80
416       [ Constant : char * ] $IB_SWR_COMPMASK_STATE = 0x100
417       [ Constant : char * ] $IB_SWR_COMPMASK_LIFE = 0x200
418       [ Constant : char * ] $IB_SWR_COMPMASK_LMC = 0x400
419       [ Constant : char * ] $IB_SWR_COMPMASK_ENFORCE_CAP = 0x800
420       [ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000
421           ----
422
423           class sacSwInfo
424
425           Fields:
426
427       [ Member data: returns ib_net16_t * ] -lin_cap
428       [ Member data: returns ib_net16_t * ] -rand_cap
429       [ Member data: returns ib_net16_t * ] -mcast_cap
430       [ Member data: returns ib_net16_t * ] -lin_top
431       [ Member data: returns uint8_t * ] -def_port
432       [ Member data: returns uint8_t * ] -def_mcast_pri_port
433       [ Member data: returns uint8_t * ] -def_mcast_not_port
434       [ Member data: returns uint8_t * ] -life_state
435       [ Member data: returns ib_net16_t * ] -lids_per_port
436       [ Member data: returns ib_net16_t * ] -enforce_cap
437       [ Member data: returns uint8_t * ] -flags
438       [ Member : returns void  ] delete
439           ----
440
441           class sacSwRec
442
443           RID Fields:
444
445       [ Member data: returns ib_net16_t * ] -lid
446       [ Member data: returns sacSwInfo * ] -switch_info
447           Methods:
448
449       [ Member : returns char * ] get comp_mask
450       [ Member : returns char * ] getTable comp_mask
451       [ Member : returns void  ] delete
452
453       LINK RECORD
454
455           Component mask bits:
456
457       [ Constant : int  ] $IB_LR_COMPMASK_FROM_LID = 0x1
458       [ Constant : int  ] $IB_LR_COMPMASK_FROM_PORT = 0x2
459       [ Constant : int  ] $IB_LR_COMPMASK_TO_PORT = 0x4
460       [ Constant : int  ] $IB_LR_COMPMASK_TO_LID = 0x8
461           ----
462
463           class sacLinkRec
464
465           Fields:
466
467       [ Member data: returns ib_net16_t * ] -from_lid
468       [ Member data: returns uint8_t * ] -from_port_num
469       [ Member data: returns uint8_t * ] -to_port_num
470       [ Member data: returns ib_net16_t * ] -to_lid
471           Methods:
472
473       [ Member : returns char * ] get comp_mask
474       [ Member : returns char * ] getTable comp_mask
475       [ Member : returns void  ] delete
476
477       PATH RECORD
478
479           Component mask bits:
480
481       [ Constant : int  ] $IB_PR_COMPMASK_DGID = 0x4
482       [ Constant : int  ] $IB_PR_COMPMASK_SGID = 0x8
483       [ Constant : int  ] $IB_PR_COMPMASK_DLID = 0x10
484       [ Constant : int  ] $IB_PR_COMPMASK_SLID = 0x20
485       [ Constant : int  ] $IB_PR_COMPMASK_RAWTRAFIC = 0x40
486       [ Constant : int  ] $IB_PR_COMPMASK_RESV0 = 0x80
487       [ Constant : int  ] $IB_PR_COMPMASK_FLOWLABEL = 0x100
488       [ Constant : int  ] $IB_PR_COMPMASK_HOPLIMIT = 0x200
489       [ Constant : int  ] $IB_PR_COMPMASK_TCLASS = 0x400
490       [ Constant : int  ] $IB_PR_COMPMASK_REVERSIBLE = 0x800
491       [ Constant : int  ] $IB_PR_COMPMASK_NUMBPATH = 0x1000
492       [ Constant : int  ] $IB_PR_COMPMASK_PKEY = 0x2000
493       [ Constant : int  ] $IB_PR_COMPMASK_RESV1 = 0x4000
494       [ Constant : int  ] $IB_PR_COMPMASK_SL = 0x8000
495       [ Constant : int  ] $IB_PR_COMPMASK_MTUSELEC = 0x10000
496       [ Constant : int  ] $IB_PR_COMPMASK_MTU = 0x20000
497       [ Constant : int  ] $IB_PR_COMPMASK_RATESELEC = 0x40000
498       [ Constant : int  ] $IB_PR_COMPMASK_RATE = 0x80000
499       [ Constant : int  ] $IB_PR_COMPMASK_PKTLIFETIMESELEC = 0x100000
500       [ Constant : int  ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000
501           ----
502
503           class sacPathRec
504
505           Fields:
506
507       [ Member data: returns ib_gid_t * ] -dgid
508       [ Member data: returns ib_gid_t * ] -sgid
509       [ Member data: returns ib_net16_t * ] -dlid
510       [ Member data: returns ib_net16_t * ] -slid
511       [ Member data: returns ib_net32_t * ] -hop_flow_raw
512       [ Member data: returns uint8_t * ] -tclass
513       [ Member data: returns uint8_t * ] -num_path
514       [ Member data: returns ib_net16_t * ] -pkey
515       [ Member data: returns ib_net16_t * ] -sl
516       [ Member data: returns uint8_t * ] -mtu
517       [ Member data: returns uint8_t * ] -rate
518       [ Member data: returns uint8_t * ] -pkt_life
519       [ Member data: returns uint8_t * ] -preference
520           Methds:
521
522       [ Member : returns char * ] get comp_mask
523       [ Member : returns char * ] getTable comp_mask
524       [ Member : returns void  ] delete
525
526       LINEAR FORWARDING TABLE
527
528           Component mask bits:
529
530       [ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1
531       [ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2
532           ----
533
534           class sacLFTRec
535
536           Fields:
537
538       [ Member data: returns ib_net16_t * ] -lid
539       [ Member data: returns ib_net16_t * ] -block_num
540       [ Member data: returns ib_lft_t * ] -lft
541           Methods:
542
543       [ Member : returns char * ] get comp_mask
544       [ Member : returns char * ] getTable comp_mask
545       [ Member : returns void  ] delete
546
547       MULTICAST MEMBER RECORD
548
549           Component mask bits:
550
551       [ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1
552       [ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1
553       [ Constant : char * ] $IB_MCR_COMPMASK_PORT_GID = 0x2
554       [ Constant : char * ] $IB_MCR_COMPMASK_QKEY = 0x4
555       [ Constant : char * ] $IB_MCR_COMPMASK_MLID = 0x8
556       [ Constant : char * ] $IB_MCR_COMPMASK_MTU_SEL = 0x10
557       [ Constant : char * ] $IB_MCR_COMPMASK_MTU = 0x20
558       [ Constant : char * ] $IB_MCR_COMPMASK_TCLASS = 0x40
559       [ Constant : char * ] $IB_MCR_COMPMASK_PKEY = 0x80
560       [ Constant : char * ] $IB_MCR_COMPMASK_RATE_SEL = 0x100
561       [ Constant : char * ] $IB_MCR_COMPMASK_RATE = 0x200
562       [ Constant : char * ] $IB_MCR_COMPMASK_LIFE_SEL = 0x400
563       [ Constant : char * ] $IB_MCR_COMPMASK_LIFE = 0x800
564       [ Constant : char * ] $IB_MCR_COMPMASK_SL = 0x1000
565       [ Constant : char * ] $IB_MCR_COMPMASK_FLOW = 0x2000
566       [ Constant : char * ] $IB_MCR_COMPMASK_HOP = 0x4000
567       [ Constant : char * ] $IB_MCR_COMPMASK_SCOPE = 0x8000
568       [ Constant : char * ] $IB_MCR_COMPMASK_JOIN_STATE = 0x10000
569       [ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000
570           ----
571
572           class sacMCMRec
573
574           Fields:
575
576       [ Member data: returns ib_gid_t * ] -mgid
577       [ Member data: returns ib_gid_t * ] -port_gid
578       [ Member data: returns ib_net32_t * ] -qkey
579       [ Member data: returns ib_net16_t * ] -mlid
580       [ Member data: returns uint8_t * ] -mtu
581       [ Member data: returns uint8_t * ] -tclass
582       [ Member data: returns ib_net16_t * ] -pkey
583       [ Member data: returns uint8_t * ] -rate
584       [ Member data: returns uint8_t * ] -pkt_life
585       [ Member data: returns ib_net32_t * ] -sl_flow_hop
586       [ Member data: returns uint8_t * ] -scope_state
587           Methods:
588
589       [ Member : returns char * ] get comp_mask
590       [ Member : returns char * ] getTable comp_mask
591       [ Member : returns char * ] set comp_mask
592       [ Member : returns char * ] del comp_mask
593       [ Member : returns int  ] proxy_join_get
594           Instead of simple field cget
595
596       [ Member : returns void  ] proxy_join_set proxy_join
597           Instead of simple field configure
598
599       [ Member : returns void  ] obj_delete
600           Delete the object
601
602       SA CLASS PORT INFO
603
604           ----
605
606           class sacClassPortInfo
607
608           Fields:
609
610       [ Member data: returns uint8_t * ] -base_ver
611       [ Member data: returns uint8_t * ] -class_ver
612       [ Member data: returns ib_net16_t * ] -cap_mask
613       [ Member data: returns ib_net32_t * ] -resp_time_val
614       [ Member data: returns ib_gid_t * ] -redir_gid
615       [ Member data: returns ib_net32_t * ] -redir_tc_sl_fl
616       [ Member data: returns ib_net16_t * ] -redir_lid
617       [ Member data: returns ib_net16_t * ] -redir_pkey
618       [ Member data: returns ib_net32_t * ] -redir_qp
619       [ Member data: returns ib_net32_t * ] -redir_qkey
620       [ Member data: returns ib_gid_t * ] -trap_gid
621       [ Member data: returns ib_net32_t * ] -trap_tc_sl_fl
622       [ Member data: returns ib_net16_t * ] -trap_lid
623       [ Member data: returns ib_net16_t * ] -trap_pkey
624       [ Member data: returns ib_net32_t * ] -trap_hop_qp
625       [ Member data: returns ib_net32_t * ] -trap_qkey
626           Methods:
627
628       [ Member : returns char * ] get
629       [ Member : returns void  ] delete
630
631       INFORM INFO RECORD
632
633           The inform Info is built with heirarchy of objects. So several
634           classes are defined.
635
636           ----
637
638           class sacInformInfo
639
640           Fields:
641
642       [ Member data: returns ib_gid_t * ] -gid
643       [ Member data: returns ib_net16_t * ] -lid_range_begin
644       [ Member data: returns ib_net16_t * ] -lid_range_end
645       [ Member data: returns ib_net16_t * ] -reserved1
646       [ Member data: returns uint8_t * ] -is_generic
647       [ Member data: returns uint8_t * ] -subscribe
648       [ Member data: returns ib_net16_t * ] -trap_type
649       [ Member data: returns sacInformInfo_g_or_v * ] -g_or_v
650           Methods:
651
652       [ Member : returns char * ] set
653       [ Member : returns void  ] delete
654           ----
655
656           class sacInformInfo_g_or_v
657
658           Fields:
659
660       [ Member data: returns sacInformInfo_g_or_v_generic * ] -generic
661       [ Member data: returns sacInformInfo_g_or_v_vend * ] -vend
662           ----
663
664           class sacInformInfo_g_or_v_generic
665
666           Fields:
667
668       [ Member data: returns ib_net16_t * ] -trap_num
669       [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
670       [ Member data: returns uint8_t * ] -reserved2
671       [ Member data: returns uint8_t * ] -node_type_msb
672       [ Member data: returns ib_net16_t * ] -node_type_lsb
673           ----
674
675           class sacInformInfo_g_or_v_vend
676
677           Fields:
678
679       [ Member data: returns ib_net16_t * ] -dev_id
680       [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
681       [ Member data: returns uint8_t * ] -reserved2
682       [ Member data: returns uint8_t * ] -vendor_id_msb
683       [ Member data: returns ib_net16_t * ] -vendor_id_lsb
684
685       SERVICE RECORD
686
687           Component mask bits:
688
689       [ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1
690       [ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1
691       [ Constant : char * ] $IB_SR_COMPMASK_SPKEY = 0x2
692       [ Constant : char * ] $IB_SR_COMPMASK_RES1 = 0x4
693       [ Constant : char * ] $IB_SR_COMPMASK_SLEASE = 0x8
694       [ Constant : char * ] $IB_SR_COMPMASK_SKEY = 0x10
695       [ Constant : char * ] $IB_SR_COMPMASK_SNAME = 0x20
696       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_0 = 0x40
697       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_1 = 0x80
698       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_2 = 0x100
699       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_3 = 0x200
700       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_4 = 0x400
701       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_5 = 0x800
702       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_6 = 0x1000
703       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_7 = 0x2000
704       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_8 = 0x4000
705       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_9 = 0x8000
706       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_10 = 0x10000
707       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_11 = 0x20000
708       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_12 = 0x40000
709       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_13 = 0x80000
710       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_14 = 0x100000
711       [ Constant : char * ] $IB_SR_COMPMASK_SDATA8_15 = 0x200000
712       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_0 = 0x400000
713       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_1 = 0x800000
714       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_2 = 0x1000000
715       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_3 = 0x2000000
716       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_4 = 0x4000000
717       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_5 = 0x8000000
718       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_6 = 0x10000000
719       [ Constant : char * ] $IB_SR_COMPMASK_SDATA16_7 = 0x20000000
720       [ Constant : char * ] $IB_SR_COMPMASK_SDATA32_0 = 0x40000000
721       [ Constant : char * ] $IB_SR_COMPMASK_SDATA32_1 = 0x80000000
722       [ Constant : char * ] $IB_SR_COMPMASK_SDATA32_2 = 0x100000000
723       [ Constant : char * ] $IB_SR_COMPMASK_SDATA32_3 = 0x200000000
724       [ Constant : char * ] $IB_SR_COMPMASK_SDATA64_0 = 0x400000000
725       [ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000
726           ----
727
728           class sacServiceRec
729
730           Fields:
731
732       [ Member data: returns ib_net64_t * ] -service_id
733       [ Member data: returns ib_gid_t * ] -service_gid
734       [ Member data: returns ib_net16_t * ] -service_pkey
735       [ Member data: returns ib_net16_t * ] -resv
736       [ Member data: returns ib_net32_t * ] -service_lease
737       [ Member data: returns uint8_array_t * ] -service_key
738       [ Member data: returns ib_svc_name_t * ] -service_name
739       [ Member data: returns uint8_array_t * ] -service_data8
740       [ Member data: returns ib_net16_array_t * ] -service_data16
741       [ Member data: returns ib_net32_array_t * ] -service_data32
742       [ Member data: returns ib_net64_array_t * ] -service_data64
743           Methods:
744
745       [ Member : returns char * ] get comp_mask
746       [ Member : returns char * ] set comp_mask
747       [ Member : returns char * ] getTable comp_mask
748       [ Member : returns char * ] delete comp_mask
749       [ Member : returns void  ] obj_delete
750
751       SL to VL TABLE RECORD
752
753           Component mask bits:
754
755       [ Constant : char * ] $IB_SLVL_COMPMASK_LID = 0x1
756       [ Constant : char * ] $IB_SLVL_COMPMASK_IN_PORT = 0x2
757       [ Constant : char * ] $IB_SLVL_COMPMASK_OUT_PORT = 0x4
758           ----
759
760           class sacSlVlTbl
761
762       [ Member data: returns uint8_array_t * ] -raw_vl_by_sl
763           ----
764
765           class sacSlVlRec
766
767           RID Fields:
768
769       [ Member data: returns ib_net16_t * ] -lid
770           for CA: lid of port, for switch lid of port 0
771
772       [ Member data: returns uint8_t * ] -in_port_num
773           reserved for CA's
774
775       [ Member data: returns uint8_t * ] -out_port_num
776           reserved for CA's
777
778       [ Member data: returns uint32_t * ] -resv
779       [ Member data: returns sacSlVlTbl * ] -slvl_tbl
780           Methods:
781
782       [ Member : returns char * ] get comp_mask
783       [ Member : returns char * ] getTable comp_mask
784       [ Member : returns void  ] delete
785
786       VL ARBITRATION TABLE RECORD
787
788           Component mask bits:
789
790       [ Constant : char * ] $IB_VLA_COMPMASK_LID = 0x1
791       [ Constant : char * ] $IB_VLA_COMPMASK_OUT_PORT = 0x2
792       [ Constant : char * ] $IB_VLA_COMPMASK_BLOCK = 0x4
793           ----
794
795           class sacVlArbRec
796
797           Fields:
798
799       [ Member data: returns ib_net16_t * ] -lid
800           for CA: lid of port, for switch lid of port 0
801
802       [ Member data: returns uint8_t * ] -port_num
803       [ Member data: returns uint8_t * ] -block_num
804       [ Member data: returns uint32_t * ] -reserved
805       [ Member data: returns sac_vl_arb_tbl_t * ] -vl_arb_tbl
806           Methods:
807
808       [ Member : returns char * ] get comp_mask
809       [ Member : returns char * ] getTable comp_mask
810       [ Member : returns void  ] delete
811
812       PKEY TABLE RECORD
813
814           Component mask bits:
815
816       [ Constant : char * ] $IB_PKEY_COMPMASK_LID = 0x1
817       [ Constant : char * ] $IB_PKEY_COMPMASK_BLOCK = 0x2
818       [ Constant : char * ] $IB_PKEY_COMPMASK_PORT = 0x4
819           ----
820
821           class sacPKeyTbl
822
823           Fields:
824
825       [ Member data: returns ib_net16_array_t * ] -pkey_entry
826           ----
827
828           class sacPKeyRec
829
830           RID Fields:
831
832       [ Member data: returns ib_net16_t * ] -lid
833           for CA: lid of port, for switch lid of port 0
834
835       [ Member data: returns uint16_t * ] -block_num
836       [ Member data: returns uint8_t * ] -port_num
837           for switch: port number, for CA: reserved
838
839       [ Member data: returns uint8_t * ] -reserved1
840       [ Member data: returns uint16_t * ] -reserved2
841       [ Member data: returns sacPKeyTbl * ] -pkey_tbl
842           Methods:
843
844       [ Member : returns char * ] get comp_mask
845       [ Member : returns char * ] getTable comp_mask
846       [ Member : returns void  ] delete
847

Subnet Management MADs (SMPs)

849       The SM interface supports sending Subnet Management Packets to the fab‐
850       ric devices. The specific attributes that can be access is provided in
851       detail in each sub section below.
852
853       A set of object types is defined. The user can allocate a new attribute
854       object. Then the object can be set using configure or the direct manip‐
855       ulation methods.  Extra methods are provided for each object: =item
856       setByDr <dr> <attrMod>
857
858       Set the attribute on the object accessible by the given directed route.
859       A directed route is a list of port numbers to go out from.
860
861       getByDr <dr> <attrMod>
862           Get the attribute value by traversing a directed route.
863
864           setByLid <lid> <attrMod>
865
866           Set the attribute on the object accessible by the given LID
867
868           getByLid <lid> <attrMod>
869
870           get the attribute on the object accessible by the given LID
871
872       class smNodeInfo
873
874           Fields:
875
876       [ Member data: returns uint8_t * ] -base_version
877       [ Member data: returns uint8_t * ] -class_version
878       [ Member data: returns uint8_t * ] -node_type
879       [ Member data: returns uint8_t * ] -num_ports
880       [ Member data: returns ib_net64_t * ] -sys_guid
881       [ Member data: returns ib_net64_t * ] -node_guid
882       [ Member data: returns ib_net64_t * ] -port_guid
883       [ Member data: returns ib_net16_t * ] -partition_cap
884       [ Member data: returns ib_net16_t * ] -device_id
885       [ Member data: returns ib_net32_t * ] -revision
886       [ Member data: returns ib_net32_t * ] -port_num_vendor_id
887           Methods:
888
889       [ Member : returns int  ] getByDr dr
890       [ Member : returns int  ] setByDr dr
891       [ Member : returns int  ] getByLid lid
892       [ Member : returns int  ] setByLid lid
893

class smPortInfo

895       Fields:
896
897       [ Member data: returns ib_net64_t * ] -m_key
898       [ Member data: returns ib_net64_t * ] -subnet_prefix
899       [ Member data: returns ib_net16_t * ] -base_lid
900       [ Member data: returns ib_net16_t * ] -master_sm_base_lid
901       [ Member data: returns ib_net32_t * ] -capability_mask
902       [ Member data: returns ib_net16_t * ] -diag_code
903       [ Member data: returns ib_net16_t * ] -m_key_lease_period
904       [ Member data: returns uint8_t * ] -local_port_num
905       [ Member data: returns uint8_t * ] -link_width_enabled
906       [ Member data: returns uint8_t * ] -link_width_supported
907       [ Member data: returns uint8_t * ] -link_width_active
908       [ Member data: returns uint8_t * ] -state_info1
909           LinkSpeedSupported and PortState
910
911       [ Member data: returns uint8_t * ] -state_info2
912           PortPhysState and LinkDownDefaultState
913
914       [ Member data: returns uint8_t * ] -mkey_lmc
915       [ Member data: returns uint8_t * ] -link_speed
916           LinkSpeedEnabled and LinkSpeedActive
917
918       [ Member data: returns uint8_t * ] -mtu_smsl
919       [ Member data: returns uint8_t * ] -vl_cap
920           VlCap and InitType
921
922       [ Member data: returns uint8_t * ] -vl_high_limit
923       [ Member data: returns uint8_t * ] -vl_arb_high_cap
924       [ Member data: returns uint8_t * ] -vl_arb_low_cap
925       [ Member data: returns uint8_t * ] -mtu_cap
926       [ Member data: returns uint8_t * ] -vl_stall_life
927       [ Member data: returns uint8_t * ] -vl_enforce
928       [ Member data: returns ib_net16_t * ] -m_key_violations
929       [ Member data: returns ib_net16_t * ] -p_key_violations
930       [ Member data: returns ib_net16_t * ] -q_key_violations
931       [ Member data: returns uint8_t * ] -guid_cap
932       [ Member data: returns uint8_t * ] -subnet_timeout
933       [ Member data: returns uint8_t * ] -resp_time_value
934       [ Member data: returns uint8_t * ] -error_threshold
935           Methods:
936
937       [ Member : returns int  ] getByDr dr portNum
938       [ Member : returns int  ] setByDr dr portNum
939       [ Member : returns int  ] getByLid lid portNum
940       [ Member : returns int  ] setByLid lid portNum
941
942       class smSwInfo
943
944       [ Member data: returns ib_net16_t * ] -lin_cap
945       [ Member data: returns ib_net16_t * ] -rand_cap
946       [ Member data: returns ib_net16_t * ] -mcast_cap
947       [ Member data: returns ib_net16_t * ] -lin_top
948       [ Member data: returns uint8_t * ] -def_port
949       [ Member data: returns uint8_t * ] -def_mcast_pri_port
950       [ Member data: returns uint8_t * ] -def_mcast_not_port
951       [ Member data: returns uint8_t * ] -life_state
952       [ Member data: returns ib_net16_t * ] -lids_per_port
953       [ Member data: returns ib_net16_t * ] -enforce_cap
954       [ Member data: returns uint8_t * ] -flags
955       [ Member : returns int  ] getByDr dr
956       [ Member : returns int  ] setByDr dr
957       [ Member : returns int  ] getByLid lid
958       [ Member : returns int  ] setByLid lid
959
960       class smLftBlock
961
962       [ Member data: returns uint8_array_t * ] -lft
963       [ Member : returns int  ] getByDr dr blockNum
964       [ Member : returns int  ] setByDr dr blockNum
965       [ Member : returns int  ] getByLid lid blockNum
966       [ Member : returns int  ] setByLid lid blockNum
967
968       class smMftBlock
969
970       [ Member data: returns ib_net16_array_t * ] -mft
971       [ Member : returns int  ] getByDr dr startLid startPort
972       [ Member : returns int  ] setByDr dr startLid startPort
973       [ Member : returns int  ] getByLid lid startLid startPort
974       [ Member : returns int  ] setByLid lid startLid startPort
975
976       class smGuidInfo
977
978       [ Member data: returns ib_net64_array_t * ] -guid
979       [ Member : returns int  ] getByDr dr blockNum
980       [ Member : returns int  ] setByDr dr blockNum
981       [ Member : returns int  ] getByLid lid blockNum
982       [ Member : returns int  ] setByLid lid blockNum
983
984       class smPkeyTable
985
986       [ Member data: returns ib_net16_array_t * ] -pkey_entry
987       [ Member : returns int  ] getByDr dr portNum blockNum
988       [ Member : returns int  ] setByDr dr portNum blockNum
989       [ Member : returns int  ] getByLid lid portNum blockNum
990       [ Member : returns int  ] setByLid lid portNum blockNum
991
992       class smSlVlTable
993
994       [ Member data: returns uint8_array_t * ] -raw_vl_by_sl
995       [ Member : returns int  ] getByDr dr inPortNum outPortNum
996       [ Member : returns int  ] setByDr dr inPortNum outPortNum
997       [ Member : returns int  ] getByLid lid inPortNum outPortNum
998       [ Member : returns int  ] setByLid lid inPortNum outPortNum
999
1000       class smVlArbTable
1001
1002       [ Member data: returns ib_vl_arb_element_t * ] -vl_entry
1003       [ Member : returns int  ] getByDr dr portNum block
1004       [ Member : returns int  ] setByDr dr portNum block
1005       [ Member : returns int  ] getByLid lid portNum block
1006       [ Member : returns int  ] setByLid lid portNum block
1007
1008       class smNodeDesc
1009
1010       [ Member data: returns ibsm_node_desc_str_t * ] -description
1011       [ Member : returns int  ] getByDr dr
1012       [ Member : returns int  ] setByDr dr
1013       [ Member : returns int  ] getByLid lid
1014       [ Member : returns int  ] setByLid lid
1015
1016       class smSMInfo
1017
1018       [ Member data: returns ib_net64_t * ] -guid
1019       [ Member data: returns ib_net64_t * ] -sm_key
1020       [ Member data: returns ib_net32_t * ] -act_count
1021       [ Member data: returns uint8_t * ] -pri_state
1022       [ Member : returns int  ] getByDr dr
1023       [ Member : returns int  ] setByDr dr
1024       [ Member : returns int  ] getByLid lid
1025       [ Member : returns int  ] setByLid lid
1026
1027       class smNotice
1028
1029           The NOTICE attribute is built out of several sub objects
1030
1031       [ Member data: returns uint8_t * ] -generic_type
1032       [ Member data: returns ib_net16_t * ] -issuer_lid
1033       [ Member data: returns ib_net16_t * ] -toggle_count
1034       [ Member data: returns ib_gid_t * ] -issuer_gid
1035       [ Member data: returns smNotice_g_or_v * ] -g_or_v
1036       [ Member data: returns smNotice_data_details * ] -data_details
1037       [ Member : returns int  ] trapByDr dr
1038       [ Member : returns int  ] trapByLid lid
1039           ----
1040
1041           class smNotice_g_or_v
1042
1043       [ Member data: returns smNotice_g_or_v_generic * ] -generic
1044       [ Member data: returns smNotice_g_or_v_vend * ] -vend
1045           ----
1046
1047           class smNotice_data_details
1048
1049       [ Member data: returns smNotice_data_details_raw_data * ] -raw_data
1050       [ Member data: returns smNotice_data_details_ntc_64_67 * ] -ntc_64_67
1051       [ Member data: returns smNotice_data_details_ntc_128 * ] -ntc_128
1052       [ Member data: returns smNotice_data_details_ntc_129_131 * ]
1053       -ntc_129_131
1054       [ Member data: returns smNotice_data_details_ntc_144 * ] -ntc_144
1055       [ Member data: returns smNotice_data_details_ntc_145 * ] -ntc_145
1056       [ Member data: returns smNotice_data_details_ntc_256 * ] -ntc_256
1057       [ Member data: returns smNotice_data_details_ntc_257_258 * ]
1058       -ntc_257_258
1059       [ Member data: returns smNotice_data_details_ntc_259 * ] -ntc_259
1060           ----
1061
1062           class smNotice_g_or_v_generic
1063
1064       [ Member data: returns uint8_t * ] -prod_type_msb
1065       [ Member data: returns ib_net16_t * ] -prod_type_lsb
1066       [ Member data: returns ib_net16_t * ] -trap_num
1067           ----
1068
1069           class smNotice_g_or_v_vend
1070
1071       [ Member data: returns uint8_t * ] -vend_id_msb
1072       [ Member data: returns ib_net16_t * ] -vend_id_lsb
1073       [ Member data: returns ib_net16_t * ] -dev_id
1074           ----
1075
1076           class smNotice_data_details_raw_data
1077
1078       [ Member data: returns uint8_array_t * ] -details
1079           ----
1080
1081           class smNotice_data_details_ntc_64_67
1082
1083       [ Member data: returns uint8_array_t * ] -res
1084       [ Member data: returns ib_gid_t * ] -gid
1085           the Node or Multicast Group that came in/out
1086
1087           ----
1088
1089           class smNotice_data_details_ntc_128
1090
1091       [ Member data: returns ib_net16_t * ] -sw_lid
1092           the sw lid of which link state changed
1093
1094           ----
1095
1096           class smNotice_data_details_ntc_129_131
1097
1098       [ Member data: returns ib_net16_t * ] -pad
1099       [ Member data: returns ib_net16_t * ] -lid
1100           lid and port number of the violation
1101
1102       [ Member data: returns uint8_t * ] -port_num
1103           ----
1104
1105           class smNotice_data_details_ntc_144
1106
1107       [ Member data: returns ib_net16_t * ] -pad1
1108       [ Member data: returns ib_net16_t * ] -lid
1109           lid where capability mask changed
1110
1111       [ Member data: returns ib_net16_t * ] -pad2
1112       [ Member data: returns ib_net32_t * ] -new_cap_mask
1113           new capability mask
1114
1115           ----
1116
1117           class smNotice_data_details_ntc_145
1118
1119       [ Member data: returns ib_net16_t * ] -pad1
1120       [ Member data: returns ib_net16_t * ] -lid
1121           lid where sys guid changed
1122
1123       [ Member data: returns ib_net16_t * ] -pad2
1124       [ Member data: returns ib_net64_t * ] -new_sys_guid
1125           new system image guid
1126
1127           ----
1128
1129           class smNotice_data_details_ntc_256
1130
1131       [ Member data: returns ib_net16_t * ] -pad1
1132       [ Member data: returns ib_net16_t * ] -lid
1133       [ Member data: returns ib_net16_t * ] -pad2
1134       [ Member data: returns uint8_t * ] -method
1135       [ Member data: returns uint8_t * ] -pad3
1136       [ Member data: returns ib_net16_t * ] -attr_id
1137       [ Member data: returns ib_net32_t * ] -attr_mod
1138       [ Member data: returns ib_net64_t * ] -mkey
1139       [ Member data: returns uint8_t * ] -dr_slid
1140       [ Member data: returns uint8_t * ] -dr_trunc_hop
1141       [ Member data: returns uint8_array_t * ] -dr_rtn_path
1142           ----
1143
1144           class smNotice_data_details_ntc_257_258
1145
1146       [ Member data: returns ib_net16_t * ] -pad1
1147       [ Member data: returns ib_net16_t * ] -lid1
1148       [ Member data: returns ib_net16_t * ] -lid2
1149       [ Member data: returns ib_net32_t * ] -key
1150       [ Member data: returns uint8_t * ] -sl
1151       [ Member data: returns ib_net32_t * ] -qp1
1152       [ Member data: returns ib_net32_t * ] -qp2
1153       [ Member data: returns ib_gid_t * ] -gid1
1154       [ Member data: returns ib_gid_t * ] -gid2
1155           ----
1156
1157           class smNotice_data_details_ntc_259
1158
1159       [ Member data: returns ib_net16_t * ] -data_valid
1160       [ Member data: returns ib_net16_t * ] -lid1
1161       [ Member data: returns ib_net16_t * ] -lid2
1162       [ Member data: returns ib_net32_t * ] -key
1163       [ Member data: returns uint8_t * ] -sl
1164       [ Member data: returns ib_net32_t * ] -qp1
1165       [ Member data: returns uint8_t * ] -qp2_msb
1166       [ Member data: returns ib_net16_t * ] -qp2_lsb
1167       [ Member data: returns ib_gid_t * ] -gid1
1168       [ Member data: returns ib_gid_t * ] -gid2
1169       [ Member data: returns ib_net16_t * ] -sw_lid
1170       [ Member data: returns uint8_t * ] -port_no
1171

IBCR Functions

1173       Provides vendor specific access to the device internal coniguration
1174       space
1175
1176       This section provide the details about the functions IBCR exposes.
1177       They all return 0 on succes.
1178
1179       [ returns int  ] crMultiMaxGet
1180       [ returns int  ] crRead lid address
1181       [ returns int  ] crWrite lid data address
1182       [ returns int  ] crReadMulti num lid_list address
1183       [ returns int  ] crWriteMulti num lid_list data address
1184

IB Vendor Specific Functions

1186       IBVS stands for Vendor Specific MADs.
1187
1188       This section provide the details about the functions IBVS exposes.
1189       They all return 0 on succes.
1190
1191       [ returns int  ] vsMultiMaxGet
1192       [ returns int  ] vsCpuRead lid size cpu_traget_size address
1193       [ returns int  ] vsCpuWrite lid size cpu_traget_size data address
1194       [ returns int  ] vsI2cRead lid port_num device_id size address
1195       [ returns int  ] vsI2cWrite lid port_num device_id size address data
1196       [ returns int  ] vsI2cReadMulti num lid_list port_num device_id size
1197       address
1198       [ returns int  ] vsI2cWriteMulti num lid_list port_num device_id size
1199       address data
1200       [ returns int  ] vsGpioRead lid
1201       [ returns int  ] vsGpioWrite lid gpio_mask gpio_data
1202       [ returns int  ] vsSWReset num lid_list
1203       [ returns int  ] vsFlashStartMulti num lid_list last size address data
1204       [ returns int  ] vsFlashStopMulti num lid_list force
1205       [ returns int  ] vsFlashSetBankMulti num lid_list address
1206       [ returns int  ] vsFlashEraseSectorMulti num lid_list address
1207       [ returns int  ] vsFlashReadSectorMulti num lid_list size address
1208       [ returns int  ] vsFlashWriteSectorMulti num lid_list size address data
1209       [ returns int  ] vsMirrorRead lid
1210       [ returns int  ] vsMirrorWrite lid rx_mirror tx_mirror
1211

IBBBM Functions

1213       This section provide the details about the functions IBBBM exposes.
1214       They all return 0 on succes.
1215
1216       [ returns int  ] bbmVpdRead lid vpd_device_selector bytes_num offset
1217       [ returns int  ] bbmVpdWrite lid vpd_device_selector bytes_num offset
1218       p_data
1219       [ returns int  ] bbmVSDRead lid
1220       [ returns int  ] bbmBSNRead lid
1221       [ returns int  ] bbmModRead lid
1222       [ returns int  ] bbmChaRead lid
1223       [ returns int  ] bbmFWVerRead lid
1224

AUTHOR

1226       Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
1227
1228
1229
1230IBIS 1.0                          2008-06-16                           IBIS(1)