download.oracle.com · 2012. 7. 18. ·...

996
man pages section 7: Device and Network Interfaces Part No: 816–5177–17 August 2011

Transcript of download.oracle.com · 2012. 7. 18. ·...

  • man pages section 7: Device and NetworkInterfaces

    Part No: 816–5177–17August 2011

  • Copyright © 2011, Oracle and/or its affiliates. All rights reserved.

    License Restrictions Warranty/Consequential Damages Disclaimer

    This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectualproperty laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software,unless required by law for interoperability, is prohibited.

    Warranty Disclaimer

    The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

    Restricted Rights Notice

    If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice isapplicable:

    U.S. GOVERNMENT RIGHTS

    Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or"commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication,disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extentapplicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

    Hazardous Applications Notice

    This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherentlydangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shallbe responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim anyliability for any damages caused by use of this software or hardware in dangerous applications.

    Trademark Notice

    Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

    Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registeredtrademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced MicroDevices. UNIX is a registered trademark of The Open Group in the United States and other countries.

    Third Party Content, Products, and Services Disclaimer

    This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation andits affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporationand its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

    111219@25097

  • Contents

    Preface ...................................................................................................................................................13

    Introduction .........................................................................................................................................17Intro(7) ................................................................................................................................................ 18

    Device and Network Interfaces .........................................................................................................21aac(7D) ................................................................................................................................................. 22adp(7D) ................................................................................................................................................. 23adpu320(7D) ........................................................................................................................................ 25afb(7d) .................................................................................................................................................. 27agpgart_io(7I) .................................................................................................................................... 28ahci(7D) ............................................................................................................................................... 39amd8111s(7D) ...................................................................................................................................... 41amr(7D) ................................................................................................................................................. 42arp(7P) .................................................................................................................................................. 43ast(7D) ................................................................................................................................................. 47asy(7D) ................................................................................................................................................. 48ata(7D) ................................................................................................................................................. 51audio1575(7D) .................................................................................................................................... 56audio(7I) .............................................................................................................................................. 59audio810(7D) ...................................................................................................................................... 71audiocs(7D) ........................................................................................................................................ 74audioens(7D) ...................................................................................................................................... 77audiohd(7D) ........................................................................................................................................ 81audioixp(7D) ...................................................................................................................................... 84audio_support(7I) ............................................................................................................................. 87audiots(7D) ........................................................................................................................................ 89

    3

  • audiovia823x(7D) .............................................................................................................................. 92av1394(7D) .......................................................................................................................................... 95bbc_beep(7D) ...................................................................................................................................... 96bcm_sata(7D) ...................................................................................................................................... 97bd(7M) .................................................................................................................................................. 98bge(7D) ............................................................................................................................................... 100bmc(7D) ............................................................................................................................................... 104bnx(7D) ............................................................................................................................................... 106bpp(7D) ............................................................................................................................................... 110bscv(7D) ............................................................................................................................................. 115bufmod(7M) ........................................................................................................................................ 116cadp160(7D) ...................................................................................................................................... 120cadp(7D) ............................................................................................................................................. 121cdio(7I) .............................................................................................................................................. 125ce(7D) ................................................................................................................................................. 133cgsix(7D) ........................................................................................................................................... 137chxge(7D) ........................................................................................................................................... 138cmdk(7D) ............................................................................................................................................. 139connld(7M) ........................................................................................................................................ 141console(7D) ...................................................................................................................................... 143cpqary3(7D) ...................................................................................................................................... 144cpr(7) .................................................................................................................................................. 146cpuid(7D) ........................................................................................................................................... 148ctfs(7FS) ........................................................................................................................................... 151ctsmc(7D) ........................................................................................................................................... 152cvc(7D) ............................................................................................................................................... 153cvcredir(7D) .................................................................................................................................... 154dad(7D) ............................................................................................................................................... 155daplt(7D) ........................................................................................................................................... 158dbri(7D) ............................................................................................................................................. 159dca(7D) ............................................................................................................................................... 164dcam1394(7D) .................................................................................................................................... 166dcfs(7FS) ........................................................................................................................................... 175devfs(7FS) ......................................................................................................................................... 176devinfo(7D) ...................................................................................................................................... 177dkio(7I) .............................................................................................................................................. 178

    Contents

    man pages section 7: Device and Network Interfaces • August 20114

  • dlcosmk(7ipp) .................................................................................................................................... 190dlpi(7P) ............................................................................................................................................. 191dm2s(7D) ............................................................................................................................................. 198dmfe(7D) ............................................................................................................................................. 199dnet(7D) ............................................................................................................................................. 201dr(7d) .................................................................................................................................................. 203dscpmk(7ipp) ...................................................................................................................................... 204dtrace(7D) ........................................................................................................................................ 205e1000g(7D) ........................................................................................................................................ 206ecpp(7D) ............................................................................................................................................. 211ehci(7D) ............................................................................................................................................. 217elxl(7D) ............................................................................................................................................. 221emlxs(7D) ........................................................................................................................................... 224eri(7D) ............................................................................................................................................... 225esp(7D) ............................................................................................................................................... 229fas(7D) ............................................................................................................................................... 236fasttrap(7D) .................................................................................................................................... 244fbio(7I) .............................................................................................................................................. 245fbt(7D) ............................................................................................................................................... 247fcip(7D) ............................................................................................................................................. 248fcp(7D) ............................................................................................................................................... 251fctl(7D) ............................................................................................................................................. 252fd(7D) ................................................................................................................................................. 253fdio(7I) .............................................................................................................................................. 258ffb(7D) ............................................................................................................................................... 262flowacct(7ipp) .................................................................................................................................. 263fp(7d) .................................................................................................................................................. 264FSS(7) .................................................................................................................................................. 266ge(7D) ................................................................................................................................................. 269gld(7D) ............................................................................................................................................... 273glm(7D) ............................................................................................................................................... 282gpio_87317(7D) ................................................................................................................................ 288grbeep(7d) ......................................................................................................................................... 289hci1394(7D) ...................................................................................................................................... 290hdio(7I) .............................................................................................................................................. 291hermon(7D) ........................................................................................................................................ 293

    Contents

    5

  • hid(7D) ............................................................................................................................................... 295hme(7D) ............................................................................................................................................... 297hpfc(7D) ............................................................................................................................................. 302hsfs(7FS) ........................................................................................................................................... 304hubd(7D) ............................................................................................................................................. 307hxge(7D) ............................................................................................................................................. 310i2o_bs(7D) ........................................................................................................................................ 313i2o_scsi(7D) .................................................................................................................................... 315ib(7D) ................................................................................................................................................. 316ibcm(7D) ............................................................................................................................................. 319ibd(7D) ............................................................................................................................................... 320ibdm(7D) ............................................................................................................................................. 324ibmf(7) ................................................................................................................................................ 325ibtl(7D) ............................................................................................................................................. 326icmp6(7P) ........................................................................................................................................... 327icmp(7P) ............................................................................................................................................. 329idn(7d) ................................................................................................................................................ 331ieee1394(7D) .................................................................................................................................... 334ifb(7d) ................................................................................................................................................ 336ifp(7D) ............................................................................................................................................... 337if_tcp(7P) ......................................................................................................................................... 341igb(7D) ............................................................................................................................................... 350imraid_sas(7D) ................................................................................................................................ 353inet6(7P) ........................................................................................................................................... 355inet(7P) ............................................................................................................................................. 360ip6(7P) ................................................................................................................................................ 363ip(7P) .................................................................................................................................................. 371ipge(7D) ............................................................................................................................................. 378ipgpc(7ipp) ........................................................................................................................................ 382ipmi(7D) ............................................................................................................................................. 384ipnat(7I) ............................................................................................................................................ 388ipqos(7ipp) ........................................................................................................................................ 394iprb(7D) ............................................................................................................................................. 396ipsec(7P) ........................................................................................................................................... 399ipsecah(7P) ....................................................................................................................................... 403ipsecesp(7P) ..................................................................................................................................... 404

    Contents

    man pages section 7: Device and Network Interfaces • August 20116

  • iscsi(7D) ........................................................................................................................................... 405isdnio(7I) .......................................................................................................................................... 406iser(7D) ............................................................................................................................................. 421isp(7D) ............................................................................................................................................... 422ixgb(7d) .............................................................................................................................................. 428ixgbe(7D) ........................................................................................................................................... 430jfb(7D) ............................................................................................................................................... 432jfca(7D) ............................................................................................................................................. 433kb(7M) ................................................................................................................................................ 434kdmouse(7D) ...................................................................................................................................... 443kfb(7D) ............................................................................................................................................... 444kmdb(7d) .............................................................................................................................................. 445kstat(7D) ........................................................................................................................................... 446ksyms(7D) ........................................................................................................................................... 447ldterm(7M) ........................................................................................................................................ 449llc1(7D) ............................................................................................................................................. 452llc2(7D) ............................................................................................................................................. 455lockstat(7D) .................................................................................................................................... 462lofi(7D) ............................................................................................................................................. 463lofs(7FS) ........................................................................................................................................... 464log(7D) ............................................................................................................................................... 466logi(7D) ............................................................................................................................................. 470lsimega(7D) ...................................................................................................................................... 471lx_systrace(7D) .............................................................................................................................. 472m64(7D) ............................................................................................................................................... 473marvell88sx(7D) .............................................................................................................................. 474mc-opl(7D) ........................................................................................................................................ 478mcxe(7D) ............................................................................................................................................. 479md(7D) ................................................................................................................................................. 481mediator(7D) .................................................................................................................................... 485mega_sas(7D) .................................................................................................................................... 488mem(7D) ............................................................................................................................................... 489mhd(7i) ................................................................................................................................................. 490mixer(7I) ............................................................................................................................................ 495mpt(7D) ............................................................................................................................................... 506mpt_sas(7D) ...................................................................................................................................... 512

    Contents

    7

  • mr_sas(7D) ........................................................................................................................................ 514msglog(7D) ........................................................................................................................................ 516msm(7D) ............................................................................................................................................... 517mt(7D) ................................................................................................................................................. 518mtio(7I) .............................................................................................................................................. 519n2cp(7d) .............................................................................................................................................. 533n2rng(7d) ........................................................................................................................................... 535ncp(7D) ............................................................................................................................................... 537ncrs(7D) ............................................................................................................................................. 539nfb(7D) ............................................................................................................................................... 546nge(7D) ............................................................................................................................................... 547npe(7D) ............................................................................................................................................... 551ntwdt(7D) ........................................................................................................................................... 552ntxn(7D) ............................................................................................................................................. 553null(7D) ............................................................................................................................................. 555nulldriver(7D) ................................................................................................................................ 556nv_sata(7D) ...................................................................................................................................... 557nxge(7D) ............................................................................................................................................. 558objfs(7FS) ......................................................................................................................................... 561oce(7D) ............................................................................................................................................... 562ocf_ibutton(7D) .............................................................................................................................. 563ohci(7D) ............................................................................................................................................. 564openprom(7D) .................................................................................................................................... 566oplkmdrv(7D) .................................................................................................................................... 572oplmsu(7D) ........................................................................................................................................ 573oplpanel(7D) .................................................................................................................................... 574pcata(7D) ........................................................................................................................................... 575pcelx(7D) ........................................................................................................................................... 577pcfs(7FS) ........................................................................................................................................... 579pcic(7D) ............................................................................................................................................. 584pcicmu(7D) ........................................................................................................................................ 585pcie_pci(7D) .................................................................................................................................... 586pckt(7M) ............................................................................................................................................ 587pcmcia(7D) ........................................................................................................................................ 588pcmem(7D) ........................................................................................................................................... 589pcn(7D) ............................................................................................................................................... 590

    Contents

    man pages section 7: Device and Network Interfaces • August 20118

  • pcram(7D) ........................................................................................................................................... 592pcscsi(7D) ........................................................................................................................................ 595pcser(7D) ........................................................................................................................................... 596pfb(7D) ............................................................................................................................................... 598pf_key(7P) ......................................................................................................................................... 599pfmod(7M) .......................................................................................................................................... 612physmem(7D) ...................................................................................................................................... 616pipemod(7M) ...................................................................................................................................... 617pm(7D) ................................................................................................................................................. 618poll(7d) .............................................................................................................................................. 624prnio(7I) ............................................................................................................................................ 630profile(7D) ...................................................................................................................................... 635ptem(7M) ............................................................................................................................................ 636ptm(7D) ............................................................................................................................................... 637pts(7D) ............................................................................................................................................... 639pty(7D) ............................................................................................................................................... 641qfe(7d) ................................................................................................................................................ 644qlc(7D) ............................................................................................................................................... 648qlcnic(7D) ........................................................................................................................................ 650qlge(7D) ............................................................................................................................................. 652quotactl(7I) ...................................................................................................................................... 653qus(7D) ............................................................................................................................................... 655ramdisk(7D) ...................................................................................................................................... 662random(7D) ........................................................................................................................................ 664rarp(7P) ............................................................................................................................................. 666rge(7D) ............................................................................................................................................... 667route(7P) ........................................................................................................................................... 669routing(7P) ....................................................................................................................................... 674rtls(7D) ............................................................................................................................................. 676sad(7D) ............................................................................................................................................... 678sata(7D) ............................................................................................................................................. 681sbpro(7D) ........................................................................................................................................... 684scfd(7D) ............................................................................................................................................. 688scmi2c(7d) ......................................................................................................................................... 689scsa1394(7D) .................................................................................................................................... 690scsa2usb(7D) .................................................................................................................................... 693

    Contents

    9

  • scsi_vhci(7D) .................................................................................................................................. 698sctp(7P) ............................................................................................................................................. 701scu(7D) ............................................................................................................................................... 707sd(7D) ................................................................................................................................................. 709SDC(7) .................................................................................................................................................. 716sdp(7D) ............................................................................................................................................... 717sdt(7D) ............................................................................................................................................... 720se(7D) ................................................................................................................................................. 721se_hdlc(7D) ...................................................................................................................................... 725ses(7D) ............................................................................................................................................... 728sesio(7I) ............................................................................................................................................ 730sf(7D) ................................................................................................................................................. 732sgen(7D) ............................................................................................................................................. 735sharefs(7FS) ..................................................................................................................................... 741si3124(7D) ........................................................................................................................................ 742sip(7P) ................................................................................................................................................ 743sk98sol(7D) ...................................................................................................................................... 744skfp(7D) ............................................................................................................................................. 750slp(7P) ................................................................................................................................................ 752smbios(7D) ........................................................................................................................................ 754smbus(7D) ........................................................................................................................................... 755socal(7D) ........................................................................................................................................... 756sockio(7I) .......................................................................................................................................... 758sol_ofs(7D) ...................................................................................................................................... 759sol_ucma(7D) .................................................................................................................................... 760sol_uverbs(7D) ................................................................................................................................ 761sppptun(7M) ...................................................................................................................................... 762spwr(7D) ............................................................................................................................................. 763ssd(7D) ............................................................................................................................................... 764st(7D) ................................................................................................................................................. 769stp4020(7D) ...................................................................................................................................... 787streamio(7I) ...................................................................................................................................... 788su(7D) ................................................................................................................................................. 805sxp(7D) ............................................................................................................................................... 808symhisl(7D) ...................................................................................................................................... 811sysmsg(7D) ........................................................................................................................................ 814

    Contents

    man pages section 7: Device and Network Interfaces • August 201110

  • systrace(7D) .................................................................................................................................... 815tavor(7D) ........................................................................................................................................... 816tcp(7P) ................................................................................................................................................ 818termio(7I) .......................................................................................................................................... 824termiox(7I) ........................................................................................................................................ 845ticlts(7D) ........................................................................................................................................ 851timod(7M) .......................................................................................................................................... 853tirdwr(7M) ........................................................................................................................................ 855tmpfs(7FS) ......................................................................................................................................... 857todopl(7D) ........................................................................................................................................ 859tokenmt(7ipp) .................................................................................................................................... 860tpf(7D) ............................................................................................................................................... 863tsalarm(7D) ...................................................................................................................................... 864tswtclmt(7ipp) .................................................................................................................................. 868ttcompat(7M) .................................................................................................................................... 869tty(7D) ............................................................................................................................................... 877ttymux(7D) ........................................................................................................................................ 878tun(7M) .............................................................................................................................................. 879tzmon(7d) ........................................................................................................................................... 883uata(7D) ............................................................................................................................................. 884udfs(7FS) ........................................................................................................................................... 887udp(7P) ................................................................................................................................................ 888ufs(7FS) .............................................................................................................................................. 891ugen(7D) ............................................................................................................................................. 894uhci(7D) ............................................................................................................................................. 912usba(7D) ............................................................................................................................................. 913usb_ac(7D) ........................................................................................................................................ 916usb_ah(7M) ........................................................................................................................................ 920usb_as(7D) ........................................................................................................................................ 921usbecm(7D) ........................................................................................................................................ 923usbkbm(7M) ........................................................................................................................................ 924usb_mid(7D) ...................................................................................................................................... 926usbms(7M) .......................................................................................................................................... 928usbprn(7D) ........................................................................................................................................ 932usbsacm(7D) ...................................................................................................................................... 937usbser_edge(7D) .............................................................................................................................. 940

    Contents

    11

  • usbsksp(7D) ...................................................................................................................................... 943usbsprl(7D) ...................................................................................................................................... 946uscsi(7I) ............................................................................................................................................ 949usoc(7D) ............................................................................................................................................. 953virtualkm(7D) .................................................................................................................................. 955visual_io(7I) .................................................................................................................................... 958vni(7d) ................................................................................................................................................ 965volfs(7FS) ......................................................................................................................................... 966vuidmice(7M) .................................................................................................................................... 968wrsm(7D) ............................................................................................................................................. 971wrsmd(7D) ........................................................................................................................................... 973wscons(7D) ........................................................................................................................................ 974xge(7D) ............................................................................................................................................... 983xmemfs(7FS) ....................................................................................................................................... 985zcons(7D) ........................................................................................................................................... 987zero(7D) ............................................................................................................................................. 988zs(7D) ................................................................................................................................................. 989zsh(7D) ............................................................................................................................................... 992zulu(7d) .............................................................................................................................................. 996

    Contents

    man pages section 7: Device and Network Interfaces • August 201112

  • Preface

    Both novice users and those familar with the SunOS operating system can use online man pagesto obtain information about the system and its features. A man page is intended to answerconcisely the question “What does it do?” The man pages in general comprise a referencemanual. They are not intended to be a tutorial.

    OverviewThe following contains a brief description of each man page section and the information itreferences:■ Section 1 describes, in alphabetical order, commands available with the operating system.■ Section 1M describes, in alphabetical order, commands that are used chiefly for system

    maintenance and administration purposes.■ Section 2 describes all of the system calls. Most of these calls have one or more error returns.

    An error condition is indicated by an otherwise impossible returned value.■ Section 3 describes functions found in various libraries, other than those functions that

    directly invoke UNIX system primitives, which are described in Section 2.■ Section 4 outlines the formats of various files. The C structure declarations for the file

    formats are given where applicable.■ Section 5 contains miscellaneous documentation such as character-set tables.■ Section 6 contains available games and demos.■ Section 7 describes various special files that refer to specific hardware peripherals and device

    drivers. STREAMS software drivers, modules and the STREAMS-generic set of system callsare also described.

    ■ Section 9 provides reference information needed to write device drivers in the kernelenvironment. It describes two device driver interface specifications: the Device DriverInterface (DDI) and the Driver/Kernel Interface (DKI).

    ■ Section 9E describes the DDI/DKI, DDI-only, and DKI-only entry-point routines adeveloper can include in a device driver.

    ■ Section 9F describes the kernel functions available for use by device drivers.■ Section 9S describes the data structures used by drivers to share information between the

    driver and the kernel.

    13

  • Below is a generic format for man pages. The man pages of each manual section generallyfollow this order, but include only needed headings. For example, if there are no bugs to report,there is no BUGS section. See the intro pages for more information and detail about eachsection, and man(1) for more information about man pages in general.

    NAME This section gives the names of the commands or functionsdocumented, followed by a brief description of what theydo.

    SYNOPSIS This section shows the syntax of commands or functions.When a command or file does not exist in the standardpath, its full path name is shown. Options and argumentsare alphabetized, with single letter arguments first, andoptions with arguments next, unless a different argumentorder is required.

    The following special characters are used in this section:

    [ ] Brackets. The option or argument enclosed inthese brackets is optional. If the brackets areomitted, the argument must be specified.

    . . . Ellipses. Several values can be provided for theprevious argument, or the previous argumentcan be specified multiple times, for example,"filename . . ." .

    | Separator. Only one of the argumentsseparated by this character can be specified at atime.

    { } Braces. The options and/or argumentsenclosed within braces are interdependent,such that everything enclosed must be treatedas a unit.

    PROTOCOL This section occurs only in subsection 3R to indicate theprotocol description file.

    DESCRIPTION This section defines the functionality and behavior of theservice. Thus it describes concisely what the commanddoes. It does not discuss OPTIONS or cite EXAMPLES.Interactive commands, subcommands, requests, macros,and functions are described under USAGE.

    IOCTL This section appears on pages in Section 7 only. Only thedevice class that supplies appropriate parameters to theioctl(2) system call is called ioctl and generates its own

    Preface

    man pages section 7: Device and Network Interfaces • August 201114

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1man-1http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1ioctl-2

  • heading. ioctl calls for a specific device are listedalphabetically (on the man page for that specific device).ioctl calls are used for a particular class of devices all ofwhich have an io ending, such as mtio(7I).

    OPTIONS This secton lists the command options with a concisesummary of what each option does. The options are listedliterally and in the order they appear in the SYNOPSISsection. Possible arguments to options are discussed underthe option, and where appropriate, default values aresupplied.

    OPERANDS This section lists the command operands and describeshow they affect the actions of the command.

    OUTPUT This section describes the output – standard output,standard error, or output files – generated by thecommand.

    RETURN VALUES If the man page documents functions that return values,this section lists these values and describes the conditionsunder which they are returned. If a function can returnonly constant values, such as 0 or –1, these values are listedin tagged paragraphs. Otherwise, a single paragraphdescribes the return values of each function. Functionsdeclared void do not return values, so they are notdiscussed in RETURN VALUES.

    ERRORS On failure, most functions place an error code in the globalvariable errno indicating why they failed. This section listsalphabetically all error codes a function can generate anddescribes the conditions that cause each error. When morethan one condition can cause the same error, eachcondition is described in a separate paragraph under theerror code.

    USAGE This section lists special rules, features, and commandsthat require in-depth explanations. The subsections listedhere are used to explain built-in functionality:

    CommandsModifiersVariablesExpressionsInput Grammar

    Preface

    15

  • EXAMPLES This section provides examples of usage or of how to use acommand or function. Wherever possible a completeexample including command-line entry and machineresponse is shown. Whenever an example is given, theprompt is shown as example%, or if the user must besuperuser, example#. Examples are followed byexplanations, variable substitution rules, or returnedvalues. Most examples illustrate concepts from theSYNOPSIS, DESCRIPTION, OPTIONS, and USAGEsections.

    ENVIRONMENT VARIABLES This section lists any environment variables that thecommand or function affects, followed by a briefdescription of the effect.

    EXIT STATUS This section lists the values the command returns to thecalling program or shell and the conditions that cause thesevalues to be returned. Usually, zero is returned forsuccessful completion, and values other than zero forvarious error conditions.

    FILES This section lists all file names referred to by the man page,files of interest, and files created or required by commands.Each is followed by a descriptive summary or explanation.

    ATTRIBUTES This section lists characteristics of commands, utilities,and device drivers by defining the attribute type and itscorresponding value. See attributes(5) for moreinformation.

    SEE ALSO This section lists references to other man pages, in-housedocumentation, and outside publications.

    DIAGNOSTICS This section lists diagnostic messages with a briefexplanation of the condition causing the error.

    WARNINGS This section lists warnings about special conditions whichcould seriously affect your working conditions. This is nota list of diagnostics.

    NOTES This section lists additional information that does notbelong anywhere else on the page. It takes the form of anaside to the user, covering points of special interest.Critical information is never covered here.

    BUGS This section describes known bugs and, wherever possible,suggests workarounds.

    Preface

    man pages section 7: Device and Network Interfaces • August 201116

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5

  • Introduction

    R E F E R E N C E

    17

  • Intro – introduction to special files

    This section describes various device and network interfaces available on the system. Thetypes of interfaces described include character and block devices, STREAMS modules,network protocols, file systems, and ioctl requests for driver subsystems and classes.

    This section contains the following major collections:

    (7D) The system provides drivers for a variety of hardware devices, such as disk,magnetic tapes, serial communication lines, mice, and frame buffers, as well asvirtual devices such as pseudo-terminals and windows.

    This section describes special files that refer to specific hardware peripherals anddevice drivers. STREAMS device drivers are also described. Characteristics of boththe hardware device and the corresponding device driver are discussed whereapplicable.

    An application accesses a device through that device's special file. This sectionspecifies the device special file to be used to access the device as well as applicationprogramming interface (API) information relevant to the use of the device driver.

    All device special files are located under the /devices directory. The /devicesdirectory hierarchy attempts to mirror the hierarchy of system busses, controllers,and devices configured on the system. Logical device names for special files in/devices are located under the /dev directory. Although not every special fileunder /devices will have a corresponding logical entry under /dev, wheneverpossible, an application should reference a device using the logical name for thedevice. Logical device names are listed in the FILES section of the page for the devicein question.

    This section also describes driver configuration where applicable. Many devicedrivers have a driver configuration file of the form driver_name.conf associatedwith them (see driver.conf(4)). The configuration information stored in the driverconfiguration file is used to configure the driver and the device. Driverconfiguration files are located in /kernel/drv and /usr/kernel/drv. Driverconfiguration files for platform dependent drivers are located in /platform/‘uname-i‘/kernel/drv where ‘uname -i‘ is the output of the uname(1) command with the-i option.

    Some driver configuration files may contain user configurable properties. Changesin a driver's configuration file will not take effect until the system is rebooted or thedriver has been removed and re-added (see rem_drv(1M) and add_drv(1M)).

    (7FS) This section describes the programmatic interface for several file systems supportedby SunOS.

    Name

    Description

    Intro(7)

    man pages section 7: Device and Network Interfaces • Last Revised 29 Sep 199418

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1driver.conf-4http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1uname-1http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1rem-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1add-drv-1m

  • (7I) This section describes ioctl requests which apply to a class of drivers or subsystems.For example, ioctl requests which apply to most tape devices are discussed inmtio(7I). Ioctl requests relevant to only a specific device are described on the manpage for that device. The page for the device in question should still be examined forexceptions to the ioctls listed in section 7I.

    (7M) This section describes STREAMS modules. Note that STREAMS drivers arediscussed in section 7D. streamio(7I) contains a list of ioctl requests used tomanipulate STREAMS modules and interface with the STREAMS framework. Ioctlrequests specific to a STREAMS module will be discussed on the man page for thatmodule.

    (7P) This section describes various network protocols available in SunOS.

    SunOS supports both socket-based and STREAMS-based networkcommunications. The Internet protocol family, described in inet(7P), is theprimary protocol family supported by SunOS, although the system can support anumber of others. The raw interface provides low-level services, such as packetfragmentation and reassembly, routing, addressing, and basic transport forsocket-based implementations. Facilities for communicating using anInternet-family protocol are generally accessed by specifying the AF_INET addressfamily when binding a socket; see socket(3SOCKET) for details.

    Major protocols in the Internet family include:■ The Internet Protocol (IP) itself, which supports the universal datagram format,

    as described in ip(7P). This is the default protocol for SOCK_RAW type socketswithin the AF_INET domain.

    ■ The Transmission Control Protocol (TCP); see tcp(7P). This is the defaultprotocol for SOCK_STREAM type sockets.

    ■ The User Datagram Protocol (UDP); see udp(7P). This is the default protocol forSOCK_DGRAM type sockets.

    ■ The Address Resolution Protocol (ARP); see arp(7P).■ The Internet Control Message Protocol (ICMP); see icmp(7P).

    add_drv(1M), rem_drv(1M), Intro(3), ioctl(2), socket(3SOCKET), driver.conf(4),arp(7P), icmp(7P), inet(7P), ip(7P), mtio(7I), st(7D), streamio(7I), tcp(7P), udp(7P)

    System Administration Guide: IP Services

    STREAMS Programming Guide

    Writing Device Drivers

    See Also

    Intro(7)

    Introduction 19

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1socket-3sockethttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1add-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1rem-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1intro-3http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1ioctl-2http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1socket-3sockethttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1driver.conf-4http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=SYSADV3http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=STREAMShttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=DRIVER

  • 20

  • Device and Network Interfaces

    R E F E R E N C E

    21

  • aac – SCSI HBA driver for Adaptec AdvancedRAID Controller

    The aac plain SCSI host bus adapter driver is a SCSA-compliant nexus driver that supports theAdaptec 2200S/2120S SCSI RAID card, Dell PERC 3Di SCSI RAID controller, Dell PERC 3SiSCSI RAID controller, Adaptec 2820SA SATA RAID card, Adaptec 4800SAS, 4805SAS SASRAID cards and SUN's STK RAID REM, STK RAID INT, and STK RAID EXT RAID cards.

    The aac driver is ported from FreeBSD and supports RAID disk I/O functions and the RAIDmanagement interface.

    There are no user configurable parameters available. Please configure your hardware throughBIOS.

    See attributes(5) for a description of the following attributes:

    ATTRIBUTE TYPE ATTRIBUTE VALUE

    Availability x86, SPARC (Limited to systems with AAC hardwareRAID cards.)

    /kernel/drv/aac 32-bit ELF kernel module.

    /kernel/drv/amd64/aac 64-bit ELF kernel module. (x86)

    /kernel/drv/sparcv9/aac 64-bit ELF kernel module. (SPARC)

    /kernel/drv/aac.conf Configuration file. (Contains no user-configurable options).

    prtconf(1M), attributes(5), scsi_hba_attach(9F), scsi_sync_pkt(9F),scsi_transport(9F), scsi_device(9S), scsi_inquiry(9S), scsi_pkt(9S)

    Small Computer System Interface-2 (SCSI-2)

    Name

    Description

    DriverConfiguration

    Attributes

    Files

    See Also

    aac(7D)

    man pages section 7: Device and Network Interfaces • Last Revised 13 May 200822

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1prtconf-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-hba-attach-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-sync-pkt-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-transport-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-device-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-inquiry-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-pkt-9s

  • adp – Low-level module for controllers based on Adaptec AIC-7870P and AIC-7880P SCSIchips

    The adp module provides low-level interface routines between the common disk/tape I/Osystem and SCSI (Small Computer System Interface) controllers based on the AdaptecAIC-7870P and AIC-7880P SCSI chips. These controllers include the Adaptec AHA–2940,AHA–2940W, AHA–2940U, AHA–2940UW, AHA–3940, and AHA–3940W, as well asmotherboards with embedded AIC-7870P and AIC-7880P SCSI chips.

    Supported devices are AIC-7850, AIC-7860, AIC-7870, AIC-7880 and AIC-7895.

    The adp module can be configured for disk and streaming tape support for one or more hostadapter boards, each of which must be the sole initiator on a SCSI bus. Auto-configurationcode determines if the adapter is present at the configured address and what types of devicesare attached to the adapter.

    The Plug N Play SCAM Support option is not supported.

    ■ To use the AHA-3940 or AHA-3940W adapters, the motherboard must have a BIOS thatsupports the DEC PCI-to-PCI Bridge chip on the host bus adapter.

    ■ User-level programs have exhibited problems on some PCI systems with an AdaptecAHA-2940 or AHA-2940W card and certain motherboards. If problems with user-levelprograms occur, use the BIOS setup to disable write-back CPU caching (or all caching ifthere is no control over the caching algorithm). The affected motherboards are:

    - PCI motherboards with a 60-MHz Pentium chip, with PCI chipset numbers S82433LX Z852and S82434LX Z850. The part numbers of the Intel motherboards are AA616393-007 andAA615988-009.- PCI motherboards with a 90-MHz Pentium chip, with PCI chipset numbers S82433NXZ895, S82434NX Z895, and S82434NX Z896. The part number of the Intel motherboard is541286-005. (Some Gateway 2000 systems use this motherboard.)- AA-619772-002 motherboard with 82433LX Z852 and 82434LX Z882 chips causes randommemory inconsistencies. Return the motherboard to the vendor for a replacement.

    ■ If the AHA-2940 SCSI adapter does not recognize the Quantum Empire 1080S, HP 3323SE or other SCSI disk drive, reduce the Synchronous Transfer rate on the Adapteccontroller to 8 Mbps.

    ■ The AHA-3940 has been certified by Adaptec to work on specific systems; however, sometesting has shown that the Solaris operating environment works properly in some of thosesystems and not in others.

    Use the Adaptec configuration utility to perform the following steps:

    Name

    Description

    Preconfigure

    Known Problems andLimitations

    Configuration

    adp(7D)

    Device and Network Interfaces 23

  • ■ Configure each SCSI device to have a unique SCSI ID, then using the adapter's AdvancedConfiguration Options setup menu, set the Plug N Play SCAM Support option toDisabled.

    ■ If there is more than one controller (or an embedded controller), try to use one IRQ percontroller.

    ■ Enable bus mastering for the slots with your host bus adapters, when the choice is given.■ For older disk drives, tape drives, and most CD-ROM devices, make sure the maximum

    SCSI data transfer speed is set to 5.0 Mbps.■ Enable support for disks larger than 1 Gbyte if applicable.

    /kernel/drv/adp.conf Configuration file for the adp driver; there are nouser-configurable options in this file

    See attributes(5) for descriptions of the following attributes:

    ATTRIBUTE TYPE ATTRIBUTE VALUE

    Architecture x86

    attributes(5)

    Solaris (Intel Platform Edition) Hardware Compatibility List

    Throughout the release, support of additional devices may be added. See the Solaris (IntelPlatform Edition) Hardware Compatibility List for additional information.

    The adp driver supports Logical Unit Number (“LUN”) values of 0 through 15. This rangeexceeds the standard SCSI-2 requirements which call for support of LUNs 0 through 7.

    Files

    Attributes

    See Also

    Notes

    adp(7D)

    man pages section 7: Device and Network Interfaces • Last Revised 10 Oct 200024

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5

  • adpu320 – Adaptec Ultra320 SCSI host bus adapter driver

    scsi@unit-address

    The adpu320 host bus adapter driver is a SCSA-compliant nexus driver that supports thefollowing Adaptec Ultra320 SCSI Devices:

    Chips AIC-7902

    The adpu320 driver supports standard functions provided by the SCSA interface, includingtagged and untagged queuing, Wide/Fast/Ultra SCSI, and auto request sense. The adpu320driver does not support linked commands. The adpu320 driver supports hot swap SCSI andhot plug PCI.

    Additionally, the adpu320 driver supports the following features:

    ■ 64-bit addressing (Dual address Cycle)■ PCI-X v1.1 operating up to 133MHz and 64bits■ PCI bus spec v2.2 operating up to 66MHz and 64bits■ Packetized SCSI at 320 and 160 MB/s■ QAS■ DT■ 40MB/sec in single-ended mode and up to 320MB/sec transfer rate in LVD mode■ Domain Validation■ Retained Training Information (RTI)■ PCI and PCI-X Error handling

    The adpu320 host bus adapter driver is configured by defining the properties found inadpu320.conf. Properties in the adpu320.conf file that can be modified by the user include:ADPU320_SCSI_RD_STRM, ADPU320_SCSI_NLUN_SUPPORT.

    -------------------------------------------------------------

    Option: ADPU320_SCSI_RD_STRM=[value]

    Definition: Enables/disables read streaming negotiation

    for all drives.

    Possible Values: 0 (off), 1 (on)

    Default Value: 0 (off)

    Option: ADPU320_SCSI_NLUN_SUPPORT=[value]

    Definition: Enables the number of logical units to be

    scanned per drive.

    Possible Values: 1-64

    Default Value: 64

    -------------------------------------------------------------

    If you alter or add driver parameters incorrectly, you can render your system inoperable. Usedriver parameters with caution.

    Name

    Synopsis

    Description

    Driver Configuration

    adpu320(7D)

    Device and Network Interfaces 25

  • See attributes(5) for descriptions of the following attributes:

    ATTRIBUTE TYPE ATTRIBUTE VALUE

    Availability x86

    /kernel/drv/adpu320

    driver module

    /kernel/drv/amd64/adpu320

    64–bit driver module

    /kernel/drv/adpu320.conf

    configuration file

    /boot/solaris/drivers/notisa.010/adpu320.bef

    realmode driver

    cfgadm(1M), prtconf(1M), attributes(5), scsi_abort(9F), scsi_hba_attach_setup(9F),scsi_ifgetcap(9F), scsi_reset(9F), scsi_sync_pkt(9F), scsi_transport(9F),scsi_device(9S), scsi_extended_sense(9S), scsi_inquiry(9S), scsi_pkt(9S)

    Writing Device Drivers

    Small Computer System Interface-3 (SCSI-3)

    Attributes

    Files

    See Also

    adpu320(7D)

    man pages section 7: Device and Network Interfaces • Last Revised 19 Oct 200426

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1cfgadm-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1prtconf-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-abort-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-hba-attach-setup-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-ifgetcap-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-reset-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-sync-pkt-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-transport-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-device-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-extended-sense-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-inquiry-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1scsi-pkt-9shttp://www.oracle.com/pls/topic/lookup?ctx=E18752&id=DRIVER

  • afb – Elite3D graphics accelerator driver

    The afb driver is the device driver for the Sun Elite3D graphics accelerators. Theafbdaemonprocess loads the afb microcode at system startup time and during the resumesequence of a suspend-resume cycle.

    /dev/fbs/afbn Device special file

    /usr/lib/afb.ucode afb microcode

    /usr/sbin/afbdaemon afb microcode loader

    afbconfig(1M)

    Name

    Description

    Files

    See Also

    afb(7d)

    Device and Network Interfaces 27

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1afbconfig-1m

  • agpgart_io – Solaris agpgart driver I/O control operations

    #include

    The Accelerated Graphics Port (AGP) is a PCI bus technology enhancement that improves 3Dgraphics performance by using low-cost system memory. AGP chipsets use the GraphicsAddress Remapping Table (GART) to map discontiguous system memory into a contiguousPCI memory range (known as the AGP Aperture), enabling the graphics card to utilize themapped aperture range as video memory.

    The agpgart driver creates a pseudo device node at /dev/agpgart and provides a set of ioctlsfor managing allocation/deallocation of system memory, setting mappings between systemmemory and aperture range, and setting up AGP devices. The agpgart driver manages bothpseudo and real device nodes, but to initiate AGP-related operations you operate only on the/dev/agpgart pseudo device node. To do this, open /dev/agpgart. The macro defined forthe pseudo device node name is:

    #define AGP_DEVICE "/dev/agpgart"

    The agpgart_io driver implementation is AGP architecture-dependent and cannot be madegeneric. Currently, the agpgart_io driver only supports specific AGP systems. To determineif a system is supported, run an open(2) system call on the AGP_DEVICE node. (Note thatopen(2) fails if a system is not supported). After the AGP_DEVICE is opened, you can usekstat(1M) to read the system architecture type.

    In addition to AGP system support, the agpgart ioctls can also be used on Intel integratedgraphics devices (IGD). IGD devices usually have no dedicated video memory and must usesystem memory as video memory. IGD devices contain translation tables (referred to as GTTtables) that are similar to the GART translation table for address mapping purposes.

    The AGPIOC_INFO ioctl can be called by any process. All other ioctls must be called byprocesses utilizing a GRAPHICS_ACCESS privilege. With the exception of AGPIOC_INFO,the AGPIOC_ACQUIRE ioctl must be called before any other ioctl. Once a process hasacquired GART, it cannot be acquired by another process until the former process callsAGPIOC_RELEASE.

    If the AGP_DEVICE fails to open, it may be due to one of the following reasons:

    EAGAIN GART table allocation failed.

    EIO Internal hardware initialization failed.

    ENXIO Getting device soft state error. (This is unlikely to happen.)

    With the exception of GPIOC_INFO, all ioctls shown in this section are protected byGRAPHICS_ACCESS privilege. (Only processes with GRAPHICS_ACCESS privilege in itseffective set can access the privileged ioctls).

    Name

    Synopsis

    Description

    ioctls

    agpgart_io(7I)

    man pages section 7: Device and Network Interfaces • Last Revised 9 May 200628

    http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1open-2http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1open-2http://www.oracle.com/pls/topic/lookup?ctx=E18752&id=REFMAN1kstat-1m

  • Common ioctl error codes are shown below. (Additional error codes may be displayed byindividual ioctls.)

    ENXIO Ioctl command not supported or getting device soft state error.

    EPERM Process not privileged.

    AGPIOC_INFO Get system wide AGP or IGD hardware information. This commandcan be called by any process from user or kernel context.

    The argument is a pointer to agp_info_t structure.

    typedef struct _agp_info {

    agp_version_t agpi_version; /* OUT: AGP version supported */

    uint32_t agpi_devid; /* OUT: bridge vendor + device */

    uint32_t agpi_mode; /* OUT: mode of bridge */

    ulong_t agpi_aperbase; /* OUT: base of aperture */

    size_t agpi_apersize; /* OUT: aperture size in MB */

    uint32_t agpi_pgtotal; /* OUT: max aperture pages avail. */

    uint32_t agpi_pgsystem; /* OUT: same as pg_total */

    uint32_t agpi_pgused; /* OUT: no. of currently used pages */

    } agp_info_t;

    agpi_version The version of AGP protocol the bridge device is

    compatible with, for example, major 3 and minor 0

    means AGP version 3.0.

    typedef struct _agp_version {

    uint16_t agpv_major;

    uint16_t agpv_minor;

    } agp_version_t;

    agpi_devid AGP bridge vendor and device ID.

    agpi_mode Current AGP mode, read from AGP status register of

    target device. The main bits are defined as below.

    /* AGP status register bits definition */

    #define AGPSTAT_RQ_MASK 0xff000000

    #define AGPSTAT_SBA (0x1

  • #define AGP2_RATE_1X 0x1

    #define AGP2_RATE_2X 0x2

    #define AGP2_RATE_4X 0x4

    /* rate for 3.0 mode */

    #define AGP3_RATE_4X 0x1

    #define AGP3_RATE_8X 0x2

    agpi_aperbase The base address of aperture in PCI memory space.

    agpi_apersize The size of the aperture in megabytes.

    agpi_pgtotal Represents the maximum memory

    pages the system can allocate

    according to aperture size and

    system memory size (which may differ

    from the maximum locked memory a process

    can have. The latter is subject

    to the memory resource limit imposed

    by the resource_controls(5) for each

    project(4)):

    project.max-device-locked-memory

    This value can be modified through system

    utilities like prctl(1).

    agpi_pgsystem Same as pg_total.

    agpi_pgused System pages already allocated by the driver.

    Return Values:

    EFAULT Argument copy out error

    EINVAL Command invalid

    0 Success

    AGPIOC_ACQUIRE Acquire control of GART. With the exception of AGPIOC_INFO, aprocess must acquire GART before can it call other agpgart ioctlcommands. Additionally, only processes with GRAPHICS_ACCESSprivilege may access this ioctl. In the current agpgart implementation,GART access is exclusive, meaning that only one process can performGART operations at a time. To release control over GART, callAGPIOC_RELEASE. This command can be called from user or kernelcontext.

    The argument should be NULL.

    Return values:

    EBUSY GART has been acquired

    agpgart_io(7I)

    man pages section 7: Device and Network Interfaces • Last Revised 9 May 200630

  • 0 Success.

    AGPIOC_RELEASE Release GART control. If a process releases GART control, it cannotperform additional GART operations until GART is reacquired. Notethat this command does not free allocated memory or clear GARTentries. (All clear jobs are done by direct calls or by closing the device).When a process exits without making this ioctl, the final close(2)performs this automatically. This command can be called from user orkernel context.

    The argument should be NULL.

    Return values:

    EPERM Not owner of GART.

    0 Success.

    AGPIOC_SETUP Setup AGPCMD register. An AGPCMD register resides in both theAGP master and target devices. The AGPCMD register controls theworking mode of the AGP master and target devices. Each device mustbe configured using the same mode. This command can be called fromuser or kernel context.

    The argument is a pointer to agp_setup_t structure:

    typedef struct _agp_setup {

    uint32_t agps_mode; /* IN: value to be set for AGPCMD */

    } agp_setup_t;

    agps_mode Specifying the mode to be set. Each bit of the value may have

    a specific meaning, please refer to AGP 2.0/3.0 specification

    or hardware datasheets for details.

    /* AGP command register bits definition */

    #define AGPCMD_RQ_MASK 0xff000000

    #define AGPCMD_SBAEN (0x1

  • Return Values:

    EPERM Not owner of GART.

    EFAULT Argument copy in error.

    EINVAL Command invalid for non-AGP system.

    EIO Hardware setup error.

    0 Success.

    AGPIOC_ALLOCATE Allocate system memory for graphics device. This command returns aunique ID which can be used in subsequent operations to represent theallocated memory. The memory is made up of discontiguous physicalpages. In rare cases, special memory types may be required. Theallocated memory must be bound to the GART table before it can beused by graphics device. Graphics applications can also mmap(2) thememory to userland for data storing. Memory should be freed when itis no longer used by calling AGPIOC_DEALLOCATE or simply byclosing the device. This command can be called from user or kernelcontext.

    The argument is a pointer to agp_allocate_t structure.

    typedef struct _agp_allocate {

    int32_t agpa_key; /* OUT:ID of allocated memory */

    uint32_t agpa_pgcount;/* IN: no. of pages to be allocated */

    uint32_t agpa_type;/* IN: type of memory to be allocated */

    uint32_t agpa_physical; /* OUT: reserved */

    } agp_allocate_t;

    agpa_key Unique ID of the allocated memory.

    agpa_pgcount Number of pages to be allocated. Thedriver currently supports only 4K pages.The value cannot exceed theagpi_pgtotal value returned byAGPIOC_INFO ioct and is subject tothe limit ofproject.max-device-lo