VxWorksReference 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 theprior written permission of Wind River Systems, Inc.

VxWorks, Wind River Systems, the Wind River Systems logo, and wind are registered trademarks ofWind River Systems, Inc. CrossWind, IxWorks, Tornado, VxMP, VxSim, VxVMI, WindC++, WindConfig,Wind Foundation Classes, WindNet, WindPower, WindSh, and WindView are trademarks ofWind River Systems, Inc.

All other trademarks used in this document are the property of their respective owners.

Corporate HeadquartersWind River Systems, Inc.1010 Atlantic AvenueAlameda, CA 94501-1153USA

toll free (US): 800/545-WINDtelephone: 510/748-4100facsimile: 510/814-2010

EuropeWind River Systems, S.A.R.L.19, Avenue de NorvgeImmeuble B4, Btiment 3Z.A. de Courtaboeuf 191953 Les Ulis CdexFRANCE

telephone: 33-1-60-92-63-00facsimile: 33-1-60-92-63-15

JapanWind River Systems JapanPola Ebisu Bldg. 11F3-9-19 HigashiShibuya-kuTokyo 150JAPAN

telephone: 81-3-5467-5900facsimile: 81-3-5467-5877

VxWorks Reference Manual, 5.3.1Edition 119 Apr 98Part #: DOC-12068-ZD-00

CUSTOMER SUPPORT

Telephone E-mail Fax

Corporate: 800/872-4977 toll free, U.S. & Canada510/748-4100 direct

support@wrs.com 510/814-2164

Europe: 33-1-69-07-78-78 support@wrsec.fr 33-1-69-07-08-26

Japan: 011-81-3-5467-5900 support@kk.wrs.com 011-81-3-5467-5877

If you purchased your Wind River Systems product from a distributor, please contact yourdistributor to determine how to reach your technical support organization.

Please provide your license number when contacting Customer Support.

Contents

1 Libraries

This section provides reference entries for VxWorks libraries that are generic to mosttargets. Each entry lists the routines found in the library, including a one-line synopsis ofeach and a general description of their use.

Libraries that are specific to board support packages (BSPs) are provided in online formatonly. However, this section contains entries for the serial, Ethernet, and SCSI driversavailable with VxWorks BSPs, plus a generic entry for the BSP-specific library sysLib.

2 Subroutines

This section provides reference entries for each of the subroutines found in VxWorkslibraries documented in section 1.

Keyword Index

This section is a permuted index of keywords found in the NAME line of each referenceentry. The keyword for each index item is left-aligned in column 2. The remaining wordsin column 1 and 2 show the context for the keyword.

iii

1Libraries

aioPxLib synchronous I/O (AIO) library (POSIX) .................................................................. 1-1aioPxShow asynchronous I/O (AIO) show library ..................................................................... 1-5aioSysDrv AIO system driver ....................................................................................................... 1-6ansiAssert ANSI assert documentation ....................................................................................... 1-6ansiCtype ANSI ctype documentation ........................................................................................ 1-7ansiLocale ANSI locale documentation ....................................................................................... 1-8ansiMath ANSI math documentation ........................................................................................ 1-9ansiSetjmp ANSI setjmp documentation ...................................................................................... 1-11ansiStdarg ANSI stdarg documentation ...................................................................................... 1-12ansiStdio ANSI stdio documentation ......................................................................................... 1-13ansiStdlib ANSI stdlib documentation ........................................................................................ 1-19ansiString ANSI string documentation ....................................................................................... 1-22ansiTime ANSI time documentation .......................................................................................... 1-24arpLib Address Resolution Protocol (ARP) table manipulation library .......................... 1-26ataDrv ATA/IDE (LOCAL and PCMCIA) disk device driver ........................................... 1-27ataShow ATA/IDE (LOCAL and PCMCIA) disk device driver show routine .................. 1-29autopushLib WindNet STREAMS autopush facility (STREAMS Opt.) ...................................... 1-29bALib buffer manipulation library SPARC assembly language routines ....................... 1-30bLib buffer manipulation library ........................................................................................ 1-31bootConfig system configuration module for boot ROMs ......................................................... 1-32bootInit ROM initialization module ......................................................................................... 1-33bootLib boot ROM subroutine library ..................................................................................... 1-34bootpLib BOOTP client library ................................................................................................... 1-36cacheArchLib 68K cache management library .................................................................................. 1-37cacheCy604Lib Cypress CY7C604/605 SPARC cache management library .................................. 1-38cacheI960CxALib I960Cx cache management assembly routines ........................................................ 1-39cacheI960CxLib I960Cx cache management library ............................................................................ 1-40cacheI960JxALib I960Jx cache management assembly routines .......................................................... 1-40cacheI960JxLib I960Jx cache management library .............................................................................. 1-42cacheLib cache management library .......................................................................................... 1-42

1 - i

VxWorks Reference Manual, 5.3.1

cacheMb930Lib Fujitsu MB86930 (SPARClite) cache management library .................................... 1-52cacheMicroSparcLib microSPARC cache management library ................................................................. 1-52cacheR33kLib MIPS R33000 cache management library ................................................................. 1-53cacheR3kALib MIPS R3000 cache management assembly routines ............................................... 1-54cacheR3kLib MIPS R3000 cache management library ................................................................... 1-54cacheR4kLib MIPS R4000 cache management library ................................................................... 1-55cacheSun4Lib Sun-4 cache management library .............................................................................. 1-55cacheTiTms390Lib TI TMS390 SuperSPARC cache management library ............................................ 1-56cd2400Sio CL-CD2400 MPCC serial driver ................................................................................ 1-58cisLib PCMCIA CIS library ................................................................................................... 1-59cisShow PCMCIA CIS show library ......................................................................................... 1-60clockLib clock library (POSIX) ................................................................................................... 1-60connLib target-host connection library (WindView) ............................................................. 1-61cplusLib basic run-time support for C++ ................................................................................. 1-62dbgArchLib architecture-dependent debugger library ................................................................ 1-63dbgLib debugging facilities ..................................................................................................... 1-66dirLib directory handling library (POSIX) .......................................................................... 1-69dlpiLib Data Link Provider Interface (DLPI) Library (STREAMS Opt.) ........................... 1-72dosFsLib MS-DOS media-compatible file system library ................................................... 1-73envLib environment variable library ..................................................................................... 1-87errnoLib error status library ....................................................................................................... 1-88etherLib Ethernet raw I/O routines and hooks ...................................................................... 1-90evbNs16550Sio NS16550 serial driver for the IBM PPC403GA evaluation .................................... 1-92evtBufferLib event buffer manipulation library (WindView) ...................................................... 1-93excArchLib architecture-specific exception-handling facilities ................................................. 1-93excLib generic exception handling facilities ........................................................................ 1-94fioLib formatted I/O library ................................................................................................. 1-96floatLib floating-point formatting a