VxWorks Reference Manual 5.3 - AMiner

1499 Pages·1998·5.13 MB·English

VxWorks®
Reference Manual
5.3.1
Edition 1
Copyrightª 1984 – 1998 Wind River Systems, Inc.
ALL RIGHTS RESERVED. No part of this publication may be copied in any form, by photocopy,
microfilm, retrieval system, or by any other means now known or hereafter invented without the
prior written permission of Wind River Systems, Inc.
VxWorks, Wind River Systems, the Wind River Systems logo, andwind are registered trademarks of
Wind River Systems, Inc. CrossWind, IxWorks, Tornado, VxMP,VxSim,VxVMI, WindC++,WindConfig,
Wind Foundation Classes, WindNet, WindPower,WindSh, andWindView are trademarks of
WindRiverSystems,Inc.
All other trademarks used in this document are the property of their respective owners.
Corporate Headquarters Europe Japan
Wind River Systems, Inc. Wind River Systems,S.A.R.L. Wind River Systems Japan
1010 Atlantic Avenue 19, Avenue de Norvège Pola Ebisu Bldg. 11F
Alameda, CA 94501-1153 Immeuble B4, Bâtiment 3 3-9-19 Higashi
USA Z.A. de Courtaboeuf 1 Shibuya-ku
91953 Les Ulis Cédex Tokyo 150
FRANCE JAPAN
toll free (US): 800/545-WIND
telephone: [phone] telephone: [phone] telephone: [phone]
facsimile: 510/814-2010 facsimile: 33-1-60-92-63-15 facsimile: 81-3-5467-5877
CUSTOMER SUPPORT
Telephone E-mail Fax
Corporate: 800/872-4977 toll free, U.S. & Canada [email protected] 510/814-2164
510/748-4100 direct
Europe: 33-1-69-07-78-78 [email protected] 33-1-69-07-08-26
Japan: 011-81-3-5467-5900 [email protected] 011-81-3-5467-5877
If you purchased your Wind River Systems product from a distributor, please contact your
distributor to determine how to reach your technical support organization.
Please provide your license number when contacting Customer Support.
VxWorks Reference Manual, 5.3.1
Edition 1
19 Apr 98
Part #: DOC-12068-ZD-00
Contents
1Libraries
This section provides reference entries for VxWorks libraries that are generic to most
targets. Each entry lists the routines found in the library, including a one-line synopsis of
each and a general description of their use.
Libraries that are specific to board support packages (BSPs) are provided in online format
only. However, this section contains entries for the serial, Ethernet, and SCSI drivers
available with VxWorks BSPs, plus a generic entry for the BSP-specific librarysysLib.
2 Subroutines
This section provides reference entries for each of the subroutines found in VxWorks
libraries documented in section 1.
KeywordIndex
This section is a “permuted index” of keywords found in the NAME line of each reference
entry. The keyword for each index item is left-aligned in column 2. The remaining words
in column 1 and 2 show the context for the keyword.
iii

1
Libraries
aioPxLib –synchronous I/O (AIO) library (POSIX) .................................................................. 1-1
aioPxShow –asynchronous I/O (AIO) show library ..................................................................... 1-5
aioSysDrv –AIO system driver ....................................................................................................... 1-6
ansiAssert –ANSI assert documentation ....................................................................................... 1-6
ansiCtype –ANSI ctype documentation ........................................................................................ 1-7
ansiLocale –ANSI locale documentation ....................................................................................... 1-8
ansiMath –ANSI math documentation ........................................................................................ 1-9
ansiSetjmp –ANSI setjmp documentation...................................................................................... 1-11
ansiStdarg –ANSI stdarg documentation ...................................................................................... 1-12
ansiStdio –ANSI stdio documentation......................................................................................... 1-13
ansiStdlib –ANSI stdlib documentation........................................................................................ 1-19
ansiString –ANSI string documentation ....................................................................................... 1-22
ansiTime –ANSI time documentation.......................................................................................... 1-24
arpLib –Address Resolution Protocol (ARP) table manipulation library .......................... 1-26
ataDrv –ATA/IDE (LOCAL and PCMCIA) disk device driver........................................... 1-27
ataShow –ATA/IDE (LOCAL and PCMCIA) disk device driver show routine .................. 1-29
autopushLib –WindNet STREAMS autopush facility (STREAMS Opt.) ...................................... 1-29
bALib –buffer manipulation library SPARC assembly language routines ....................... 1-30
bLib –buffer manipulation library........................................................................................ 1-31
bootConfig –system configuration module for boot ROMs ......................................................... 1-32
bootInit –ROM initialization module......................................................................................... 1-33
bootLib –boot ROM subroutine library..................................................................................... 1-34
bootpLib –BOOTP client library ................................................................................................... 1-36
cacheArchLib –68K cache management library.................................................................................. 1-37
cacheCy604Lib –Cypress CY7C604/605 SPARC cache management library .................................. 1-38
cacheI960CxALib –I960Cx cache management assembly routines ........................................................ 1-39
cacheI960CxLib –I960Cx cache management library ............................................................................ 1-40
cacheI960JxALib –I960Jx cache management assembly routines.......................................................... 1-40
cacheI960JxLib –I960Jx cache management library.............................................................................. 1-42
cacheLib –cache management library.......................................................................................... 1-42
1 - i
VxWorks Reference Manual, 5.3.1
cacheMb930Lib –Fujitsu MB86930 (SPARClite) cache management library .................................... 1-52
cacheMicroSparcLib –microSPARC cache management library................................................................. 1-52
cacheR33kLib –MIPS R33000 cache management library................................................................. 1-53
cacheR3kALib –MIPS R3000 cache management assembly routines............................................... 1-54
cacheR3kLib –MIPS R3000 cache management library................................................................... 1-54
cacheR4kLib –MIPS R4000 cache management library................................................................... 1-55
cacheSun4Lib –Sun-4 cache management library .............................................................................. 1-55
cacheTiTms390Lib –TI TMS390 SuperSPARC cache management library ............................................ 1-56
cd2400Sio –CL-CD2400 MPCC serial driver ................................................................................ 1-58
cisLib –PCMCIA CIS library ................................................................................................... 1-59
cisShow –PCMCIA CIS show library......................................................................................... 1-60
clockLib –clock library (POSIX)................................................................................................... 1-60
connLib –target-host connection library (WindView)............................................................. 1-61
cplusLib –basic run-time support for C++................................................................................. 1-62
dbgArchLib –architecture-dependent debugger library................................................................ 1-63
dbgLib –debugging facilities ..................................................................................................... 1-66
dirLib –directory handling library (POSIX) .......................................................................... 1-69
dlpiLib –Data Link Provider Interface (DLPI) Library (STREAMS Opt.) ........................... 1-72
dosFsLib –MS-DOS® media-compatible file system library ................................................... 1-73
envLib –environment variable library ..................................................................................... 1-87
errnoLib –error status library....................................................................................................... 1-88
etherLib –Ethernet raw I/O routines and hooks ...................................................................... 1-90
evbNs16550Sio –NS16550 serial driver for the IBM PPC403GA evaluation .................................... 1-92
evtBufferLib –event buffer manipulation library (WindView)...................................................... 1-93
excArchLib –architecture-specific exception-handling facilities ................................................. 1-93
excLib –generic exception handling facilities ........................................................................ 1-94
fioLib –formatted I/O library ................................................................................................. 1-96
floatLib –floating-point formatting and scanning library ...................................................... 1-97
fppArchLib –architecture-dependent floating-point coprocessor support ................................ 1-98
fppLib –floating-point coprocessor support library.............................................................. 1-99
fppShow –floating-point show routines ..................................................................................... 1-100
ftpdLib –File Transfer Protocol (FTP) server ........................................................................... 1-100
ftpLib –File Transfer Protocol (FTP) library .......................................................................... 1-102
hostLib –host table subroutine library...................................................................................... 1-104
i8250Sio –I8250 serial driver ........................................................................................................ 1-105
ideDrv –IDE disk device driver ................................................................................................ 1-105
ifLib –network interface library............................................................................................ 1-106
if_bp –original VxWorks (and SunOS) backplane network interface driver.................. 1-108
if_cpm –Motorola CPM core network interface driver ......................................................... 1-110
if_dc –DEC 21040 PCI Ethernet LAN network-interface driver ...................................... 1-113
if_eex –Intel EtherExpress 16 network interface driver ...................................................... 1-116
if_ei –Intel 82596 Ethernet network interface driver......................................................... 1-118
if_eitp –Intel 82596 Ethernet network interface driver for the TP41V ............................... 1-121
if_elc –SMC 8013WC Ethernet network interface driver ................................................... 1-121
if_elt –3Com 3C509 Ethernet network interface driver ..................................................... 1-122
1 - ii
1. Libraries
if_ene –Novell/Eagle NE2000 network interface driver ..................................................... 1-124
1
if_enp –CMC ENP 10/L Ethernet network interface driver................................................ 1-125
if_ex –Excelan EXOS 201/202/302 Ethernet network interface driver ........................... 1-127
if_fei –Intel 82557 Ethernet network interface driver ......................................................... 1-130
if_fn –Fujitsu MB86960 NICE Ethernet network interface driver.................................... 1-132
if_ln –AMD Am7990 LANCE Ethernet driver ................................................................... 1-134
if_loop –software loopback network interface driver............................................................ 1-137
if_mbc –Motorola 68EN302 network-interface driver........................................................... 1-138
if_nic –National Semiconductor SNIC Chip (for HKV30) network interface driver...... 1-140
if_qu –Motorola MC68EN360 QUICC network interface driver ...................................... 1-142
if_sl –Serial Line IP (SLIP) network interface driver......................................................... 1-145
if_sm –shared memory backplane network interface driver ............................................. 1-147
if_sn –National Semiconductor DP83932B SONIC Ethernet network interface driver 1-148
if_ulip –network interface driver for User Level IP (VxSim) ............................................... 1-150
if_ultra –SMC Elite Ultra Ethernet network interface driver ................................................ 1-152
inetLib –Internet address manipulation routines ................................................................... 1-152
inflateLib –inflate code using public domain zlib functions ..................................................... 1-154
intArchLib –architecture-dependent interrupt library ................................................................. 1-155
intLib –architecture-independent interrupt subroutine library ......................................... 1-157
ioLib –I/O interface library .................................................................................................... 1-158
ioMmuMicroSparcLib–microSparc I/II I/O DMA library .......................................................................... 1-160
iosLib –I/O system library ....................................................................................................... 1-161
iosShow –I/O system show routines .......................................................................................... 1-162
kernelLib –VxWorks kernel library............................................................................................... 1-162
ledLib –line-editing library ....................................................................................................... 1-164
loadLib –object module loader ................................................................................................... 1-166
loginLib –user login/password subroutine library.................................................................. 1-167
logLib –message logging library .............................................................................................. 1-169
lptDrv –parallel chip device driver for the IBM-PC LPT...................................................... 1-171
lstLib –doubly linked list subroutine library ........................................................................ 1-172
m2IcmpLib –MIB-II ICMP-group API for SNMP Agents ............................................................. 1-175
m2IfLib –MIB-II interface-group API for SNMP agents ......................................................... 1-176
m2IpLib –MIB-II IP-group API for SNMP agents..................................................................... 1-177
m2Lib –MIB-II API library for SNMP agents......................................................................... 1-180
m2SysLib –MIB-II system-group API for SNMP agents ............................................................ 1-183
m2TcpLib –MIB-II TCP-group API for SNMP agents................................................................. 1-184
m2UdpLib –MIB-II UDP-group API for SNMP agents ................................................................ 1-186
m68302Sio –Motorola MC68302 bimodal tty driver..................................................................... 1-188
m68332Sio –Motorola MC68332 tty driver..................................................................................... 1-189
m68360Sio –Motorola MC68360 SCC UART serial driver........................................................... 1-189
m68562Sio –MC68562 DUSCC serial driver .................................................................................. 1-190
m68681Sio –M68681 serial communications driver...................................................................... 1-191
m68901Sio –MC68901 MFP tty driver ............................................................................................ 1-194
mathALib –C interface library to high-level math functions ..................................................... 1-194
mathHardLib –hardware floating-point math library....................................................................... 1-199
1 - iii
VxWorks Reference Manual, 5.3.1
mathSoftLib –high-level floating-point emulation library............................................................. 1-200
mb86940Sio –MB 86940 UART tty driver......................................................................................... 1-200
mb87030Lib –Fujitsu MB87030 SCSI Protocol Controller (SPC) library ...................................... 1-201
memDrv –pseudo memory device driver .................................................................................. 1-202
memLib –full-featured memory partition manager................................................................. 1-202
memPartLib –core memory partition manager ............................................................................... 1-205
memShow –memory show routines............................................................................................... 1-206
mmanPxLib –memory management library (POSIX)..................................................................... 1-207
mmuL64862Lib –LSI Logic L64862 MBus-to-SBus Interface: I/O DMA library (SPARC).............. 1-208
mmuSparcILib –ROM MMU initialization (SPARC) .......................................................................... 1-208
moduleLib –object module management library .......................................................................... 1-209
mountLib –Mount protocol library ............................................................................................... 1-211
mqPxLib –message queue library (POSIX)................................................................................. 1-213
mqPxShow –POSIX message queue show...................................................................................... 1-214
msgQLib –message queue library ................................................................................................ 1-214
msgQShow –message queue show routines ................................................................................... 1-216
msgQSmLib –shared memory message queue library (VxMP Opt.)............................................ 1-217
ncr5390Lib –NCR5390 SCSI-Bus Interface Controller library (SBIC)......................................... 1-218
ncr5390Lib1 –NCR 53C90 Advanced SCSI Controller (ASC) library (SCSI-1) ........................... 1-218
ncr5390Lib2 –NCR 53C90 Advanced SCSI Controller (ASC) library (SCSI-2) ........................... 1-219
ncr710Lib –NCR 53C710 SCSI I/O Processor (SIOP) library (SCSI-1) ..................................... 1-220
ncr710Lib2 –NCR 53C710 SCSI I/O Processor (SIOP) library (SCSI-2) ..................................... 1-221
ncr810Lib –NCR 53C8xx PCI SCSI I/O Processor (SIOP) library (SCSI-2) ............................. 1-222
nec765Fd –NEC 765 floppy disk device driver........................................................................... 1-223
netDrv –network remote file I/O driver ................................................................................. 1-224
netLib –network interface library............................................................................................ 1-226
netShow –network information display routines ..................................................................... 1-226
nfsdLib –Network File System (NFS) server library............................................................... 1-228
nfsDrv –Network File System (NFS) I/O driver.................................................................... 1-230
nfsLib –Network File System (NFS) library........................................................................... 1-233
ns16550Sio –NS 16550 UART tty driver ......................................................................................... 1-234
passFsLib –pass-through (to UNIX) file system library (VxSim).............................................. 1-235
pccardLib –PC CARD enabler library ........................................................................................... 1-236
pcic –Intel 82365SL PCMCIA host bus adaptor chip library........................................... 1-237
pcicShow –Intel 82365SL PCMCIA host bus adaptor chip show library ................................ 1-238
pcmciaLib –generic PCMCIA event-handling facilities .............................................................. 1-238
pcmciaShow –PCMCIA show library ................................................................................................ 1-239
pingLib –Packet InterNet Grouper (PING) library ................................................................. 1-240
pipeDrv –pipe I/O driver ............................................................................................................ 1-240
ppc403Sio –ppc403GA serial driver............................................................................................... 1-243
ppc860Sio –Motorola MPC800 SMC UART serial driver ........................................................... 1-244
pppHookLib –PPP hook library.......................................................................................................... 1-244
pppLib –Point-to-Point Protocol library .................................................................................. 1-245
pppSecretLib –PPP authentication secrets library ............................................................................ 1-247
pppShow –Point-to-Point Protocol show routines ..................................................................... 1-248
1 - iv
1. Libraries
proxyArpLib –proxy Address Resolution Protocol (ARP) library ................................................. 1-249
1
proxyLib –proxy Address Resolution Protocol (ARP) client library....................................... 1-250
ptyDrv –pseudo-terminal driver ............................................................................................... 1-251
ramDrv –RAM disk driver .......................................................................................................... 1-252
rawFsLib –raw block device file system library ......................................................................... 1-253
rebootLib –reboot support library ................................................................................................. 1-257
remLib –remote command library ............................................................................................ 1-258
rlogLib –remote login library ..................................................................................................... 1-259
rngLib –ring buffer subroutine library .................................................................................... 1-260
routeLib –network route manipulation library ......................................................................... 1-261
rpcLib –Remote Procedure Call (RPC) support library ........................................................ 1-262
rt11FsLib –RT-11 media-compatible file system library ............................................................ 1-263
schedPxLib –scheduling library (POSIX)......................................................................................... 1-268
scsi1Lib –Small Computer System Interface (SCSI) library (SCSI-1)..................................... 1-270
scsi2Lib –Small Computer System Interface (SCSI) library (SCSI-2)..................................... 1-273
scsiCommonLib –SCSI library common commands for all devices (SCSI-2) ..................................... 1-280
scsiCtrlLib –SCSI thread-level controller library (SCSI-2) ........................................................... 1-281
scsiDirectLib –SCSI library for direct access devices (SCSI-2) ........................................................ 1-282
scsiLib –Small Computer System Interface (SCSI) library .................................................... 1-283
scsiMgrLib –SCSI manager library (SCSI-2) ................................................................................... 1-285
scsiSeqLib –SCSI sequential access device library (SCSI-2) ........................................................ 1-286
selectLib –UNIX BSD 4.3 select library........................................................................................ 1-288
semBLib –binary semaphore library ........................................................................................... 1-290
semCLib –counting semaphore library ....................................................................................... 1-292
semLib –general semaphore library.......................................................................................... 1-293
semMLib –mutual-exclusion semaphore library ........................................................................ 1-295
semOLib –release 4.x binary semaphore library ........................................................................ 1-298
semPxLib –semaphore synchronization library (POSIX) ........................................................... 1-298
semPxShow –POSIX semaphore show library................................................................................. 1-300
semShow –semaphore show routines........................................................................................... 1-301
semSmLib –shared memory semaphore library (VxMP Opt.) ................................................... 1-301
shellLib –shell execution routines .............................................................................................. 1-303
sigLib –software signal facility library ................................................................................... 1-304
smMemLib –shared memory management library (VxMP Opt.)................................................ 1-311
smMemShow –shared memory management show routines (VxMP Opt.) .................................. 1-314
smNameLib –shared memory objects name database library (VxMP Opt.) ............................... 1-314
smNameShow –shared memory objects name database show routines (VxMP Opt.) .................. 1-317
smNetLib –VxWorks interface to the shared memory network (backplane) driver .............. 1-317
smNetShow –shared memory network driver show routines ...................................................... 1-318
smObjLib –shared memory objects library (VxMP Opt.)........................................................... 1-319
smObjShow –shared memory objects show routines (VxMP Opt.).............................................. 1-322
snmpAuxLib –utility routines for object identifiers.......................................................................... 1-322
snmpBindLib –routines for binding values to variables in SNMP packets ................................... 1-323
snmpdLib –entry points to the SNMP v1/v2c agent................................................................... 1-324
snmpEbufLib –extended-buffer manipulation functions ................................................................. 1-325
1 - v
VxWorks Reference Manual, 5.3.1
snmpIoLib –default transport routines for SNMP........................................................................ 1-326
snmpProcLib –manipulate variable-bindings in an SNMP packet ................................................ 1-327
sockLib –generic socket library .................................................................................................. 1-330
spyLib –spy CPU activity library ............................................................................................. 1-332
sramDrv –PCMCIA SRAM device driver .................................................................................. 1-333
straceLib –WindNet STREAMS message trace utility (STREAMS Opt.) ............................... 1-334
strerrLib –WindNet STREAMS error messages trace utility (STREAMS Opt.).................... 1-335
strmLib –driver for the WindNet STREAMS I/O system (STREAMS Opt.)....................... 1-335
strmShow –library for STREAMS debugging (STREAMS Opt.) ............................................... 1-336
strmSockLib –interface to STREAMS sockets (STREAMS Opt.) ................................................... 1-337
symLib –symbol table subroutine library ................................................................................ 1-338
symSyncLib –host/target symbol table synchronization .............................................................. 1-340
sysLib –system-dependent library .......................................................................................... 1-342
tapeFsLib –tape sequential device file system library................................................................ 1-346
taskArchLib –architecture-specific task management routines .................................................... 1-350
taskHookLib –task hook library.......................................................................................................... 1-351
taskHookShow –task hook show routines............................................................................................. 1-352
taskInfo –task information library.............................................................................................. 1-353
taskLib –task management library............................................................................................ 1-354
taskShow –task show routines....................................................................................................... 1-358
taskVarLib –task variables support library.................................................................................... 1-359
tcic –Databook TCIC/2 PCMCIA host bus adaptor chip driver ................................... 1-360
tcicShow –Databook TCIC/2 PCMCIA host bus adaptor chip show library........................ 1-360
telnetLib –telnet server library ..................................................................................................... 1-360
tftpdLib –Trivial File Transfer Protocol server library ............................................................ 1-361
tftpLib –Trivial File Transfer Protocol (TFTP) client library ................................................ 1-362
tickLib –clock tick support library ........................................................................................... 1-365
timerLib –timer library (POSIX) .................................................................................................. 1-366
timexLib –execution timer facilities............................................................................................. 1-367
ttyDrv –provide terminal device access to serial channels .................................................. 1-369
tyLib –tty driver support library ........................................................................................... 1-370
unixDrv –UNIX-file disk driver (VxSim)................................................................................... 1-375
unldLib –object module unloading library............................................................................... 1-378
usrConfig –user-defined system configuration library .............................................................. 1-379
usrLib –user interface subroutine library ............................................................................... 1-380
vmBaseLib –base virtual memory support library ....................................................................... 1-385
vmLib –architecture-independent virtual memory support library (VxVMI Opt.)......... 1-386
vmShow –virtual memory show routines (VxVMI Opt.) ........................................................ 1-389
vxLib –miscellaneous support routines ................................................................................ 1-389
vxwLoadLib –object module class (WFC Opt.) ................................................................................ 1-390
vxwLstLib –simple linked list class (WFC Opt.)........................................................................... 1-392
vxwMemPartLib –memory partition classes (WFC Opt.) ...................................................................... 1-395
vxwMsgQLib –message queue classes (WFC Opt.)........................................................................... 1-396
vxwRngLib –ring buffer class (WFC Opt.) ...................................................................................... 1-398
vxwSemLib –semaphore classes (WFC Opt.).................................................................................. 1-399
1 - vi