man pages section 7 device and network interfaces

man pages section 7: Device and NetworkInterfaces

Part No: E29044October 2012

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

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.

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.

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 END USERS. Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/ordocumentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation andagency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system,integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to theprograms. No other rights are granted to the U.S. Government.

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.

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.

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.

Ce logiciel et la documentation qui laccompagne sont protgs par les lois sur la proprit intellectuelle. Ils sont concds sous licence et soumis des restrictionsdutilisation et de divulgation. Sauf disposition de votre contrat de licence ou de la loi, vous ne pouvez pas copier, reproduire, traduire, diffuser, modifier, breveter,transmettre, distribuer, exposer, excuter, publier ou afficher le logiciel, mme partiellement, sous quelque forme et par quelque procd que ce soit. Par ailleurs, il estinterdit de procder toute ingnierie inverse du logiciel, de le dsassembler ou de le dcompiler, except des fins dinteroprabilit avec des logiciels tiers ou tel queprescrit par la loi.

Les informations fournies dans ce document sont susceptibles de modification sans pravis. Par ailleurs, Oracle Corporation ne garantit pas quelles soient exemptesderreurs et vous invite, le cas chant, lui en faire part par crit.

Si ce logiciel, ou la documentation qui laccompagne, est concd sous licence au Gouvernement des Etats-Unis, ou toute entit qui dlivre la licence de ce logicielou lutilise pour le compte du Gouvernement des Etats-Unis, la notice suivante sapplique:

U.S. GOVERNMENT END USERS. Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/ordocumentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation andagency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system,integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to theprograms. No other rights are granted to the U.S. Government.

Ce logiciel ou matriel a t dvelopp pour un usage gnral dans le cadre dapplications de gestion des informations. Ce logiciel ou matriel nest pas conu ni nestdestin tre utilis dans des applications risque, notamment dans des applications pouvant causer des dommages corporels. Si vous utilisez ce logiciel ou matrieldans le cadre dapplications dangereuses, il est de votre responsabilit de prendre toutes les mesures de secours, de sauvegarde, de redondance et autres mesuresncessaires son utilisation dans des conditions optimales de scurit. Oracle Corporation et ses affilis dclinent toute responsabilit quant aux dommages causspar lutilisation de ce logiciel ou matriel pour ce type dapplications.

Oracle et Java sont des marques dposes dOracle Corporation et/ou de ses affilis. Tout autre nom mentionn peut correspondre des marques appartenant dautres propritaires quOracle.

Intel et Intel Xeon sont des marques ou des marques dposes dIntel Corporation. Toutes les marques SPARC sont utilises sous licence et sont des marques ou desmarques dposes de SPARC International, Inc. AMD, Opteron, le logo AMD et le logo AMD Opteron sont des marques ou des marques dposes dAdvanced MicroDevices. UNIX est une marque dpose dThe Open Group.

Ce logiciel ou matriel et la documentation qui laccompagne peuvent fournir des informations ou des liens donnant accs des contenus, des produits et des servicesmanant de tiers. Oracle Corporation et ses affilis dclinent toute responsabilit ou garantie expresse quant aux contenus, produits ou services manant de tiers. Enaucun cas, Oracle Corporation et ses affilis ne sauraient tre tenus pour responsables des pertes subies, des cots occasionns ou des dommages causs par laccs des contenus, produits ou services tiers, ou leur utilisation.

121203@25097

Contents

Preface ...................................................................................................................................................15

Introduction .........................................................................................................................................19Intro(7) ................................................................................................................................................ 20

Device and Network Interfaces .........................................................................................................23aac(7D) ................................................................................................................................................. 24adpu320(7D) ........................................................................................................................................ 25afe(7D) ................................................................................................................................................. 27agpgart_io(7I) .................................................................................................................................... 29ahci(7D) ............................................................................................................................................... 40amd8111s(7D) ...................................................................................................................................... 42arcmsr(7D) .......................................................................................................................................... 43arn(7D) ................................................................................................................................................. 45arp(7P) .................................................................................................................................................. 46ast(7D) ................................................................................................................................................. 51asy(7D) ................................................................................................................................................. 52ata(7D) ................................................................................................................................................. 55atge(7D) ............................................................................................................................................... 60ath(7D) ................................................................................................................................................. 61atu(7D) ................................................................................................................................................. 62audio1575(7D) .................................................................................................................................... 63audio(7D) ............................................................................................................................................. 64audio(7I) .............................................................................................................................................. 67audio810(7D) ...................................................................................................................................... 78audiocmi(7D) ...................................................................................................................................... 79audiocs(7D) ........................................................................................................................................ 80

3

audioemu10k(7D) ................................................................................................................................ 81audioens(7D) ...................................................................................................................................... 82audiohd(7D) ........................................................................................................................................ 83audioixp(7D) ...................................................................................................................................... 84audiols(7D) ........................................................................................................................................ 85audiop16x(7D) .................................................................................................................................... 86audiopci(7D) ...................................................................................................................................... 87audiosolo(7D) .................................................................................................................................... 88audiots(7D) ........................................................................................................................................ 89audiovia823x(7D) .............................................................................................................................. 90av1394(7D) .......................................................................................................................................... 91balloon(7D) ........................................................................................................................................ 92bbc_beep(7D) ...................................................................................................................................... 94bcm_sata(7D) ...................................................................................................................................... 95bfe(7D) ................................................................................................................................................. 96bge(7D) ................................................................................................................................................. 97blkdev(7D) ........................................................................................................................................ 100bmc(7D) ............................................................................................................................................... 101bnx(7D) ............................................................................................................................................... 103bnxe(7D) ............................................................................................................................................. 107bpf(7D) ............................................................................................................................................... 109bscv(7D) ............................................................................................................................................. 119bufmod(7M) ........................................................................................................................................ 120cdio(7I) .............................................................................................................................................. 124chxge(7D) ........................................................................................................................................... 132cmdk(7D) ............................................................................................................................................. 133connld(7M) ........................................................................................................................................ 135console(7D) ...................................................................................................................................... 137cpqary3(7D) ...................................................................................................................................... 138cpr(7) .................................................................................................................................................. 141cpuid(7D) ........................................................................................................................................... 143ctfs(7FS) ........................................................................................................................................... 146cxge(7D) ............................................................................................................................................. 147dad(7D) ............................................................................................................................................... 149daplt(7D) ........................................................................................................................................... 152dca(7D) ............................................................................................................................................... 153

Contents

man pages section 7: Device and Network Interfaces October 20124

dcam1394(7D) .................................................................................................................................... 155dcfs(7FS) ........................................................................................................................................... 164dev(7FS) .............................................................................................................................................. 165devchassis(7FS) ............................................................................................................................... 166devfs(7FS) ......................................................................................................................................... 168devinfo(7D) ...................................................................................................................................... 169dkio(7I) .............................................................................................................................................. 170dlcosmk(7ipp) .................................................................................................................................... 182dlpi(7P) ............................................................................................................................................. 183dm2s(7D) ............................................................................................................................................. 192dmfe(7D) ............................................................................................................................................. 193dnet(7D) ............................................................................................................................................. 195dr(7d) .................................................................................................................................................. 197dscpmk(7ipp) ...................................................................................................................................... 198dsp(7I) ................................................................................................................................................. 199dtrace(7D) ........................................................................................................................................ 207e1000g(7D) ........................................................................................................................................ 208ecpp(7D) ............................................................................................................................................. 213efb(7D) ............................................................................................................................................... 219ehci(7D) ............................................................................................................................................. 220elxl(7D) ............................................................................................................................................. 223emlxs(7D) ........................................................................................................................................... 225eoib(7D) ............................................................................................................................................. 226eri(7D) ............................................................................................................................................... 228evb(7P) ................................................................................................................................................ 232fas(7D) ............................................................................................................................................... 235fasttrap(7D) .................................................................................................................................... 243fbio(7I) .............................................................................................................................................. 244fbt(7D) ............................................................................................................................................... 246fcip(7D) ............................................................................................................................................. 247fcoe(7D) ............................................................................................................................................. 250fcoei(7D) ........................................................................................................................................... 251fcoet(7D) ........................................................................................................................................... 252fcp(7D) ............................................................................................................................................... 253fctl(7D) ............................................................................................................................................. 254fipe(7D) ............................................................................................................................................. 255

Contents

5

flowacct(7ipp) .................................................................................................................................. 256fp(7d) .................................................................................................................................................. 257FSS(7) .................................................................................................................................................. 259gld(7D) ............................................................................................................................................... 262glm(7D) ............................................................................................................................................... 271hci1394(7D) ...................................................................................................................................... 277hdio(7I) .............................................................................................................................................. 278heci(7D) ............................................................................................................................................. 280hermon(7D) ........................................................................................................................................ 281hid(7D) ............................................................................................................................................... 283hme(7D) ............................................................................................................................................... 286hsfs(7FS) ........................................................................................................................................... 291hubd(7D) ............................................................................................................................................. 295hwahc(7D) ........................................................................................................................................... 298hwarc(7D) ........................................................................................................................................... 299hxge(7D) ............................................................................................................................................. 300i915(7d) .............................................................................................................................................. 302ib(7D) ................................................................................................................................................. 303ibcm(7D) ............................................................................................................................................. 306ibdm(7D) ............................................................................................................................................. 307ibdma(7D) ........................................................................................................................................... 308ibmf(7) ................................................................................................................................................ 309ibp(7D) ............................................................................................................................................... 310ibtl(7D) ............................................................................................................................................. 313icmp6(7P) ........................................................................................................................................... 314icmp(7P) ............................................................................................................................................. 316iec61883(7I) ...................................................................................................................................... 318ieee1394(7D) .................................................................................................................................... 327ifp(7D) ............................................................................................................................................... 329if_tcp(7P) ......................................................................................................................................... 333igb(7D) ............................................................................................................................................... 343igbvf(7D) ........................................................................................................................................... 346ii(7D) ................................................................................................................................................. 347imraid_sas(7D) ................................................................................................................................ 349inet6(7P) ........................................................................................................................................... 351inet(7P) ............................................................................................................................................. 356

Contents


ip6(7P) ................................................................................................................................................ 359ip(7P) .................................................................................................................................................. 367ipgpc(7ipp) ........................................................................................................................................ 375ipmi(7D) ............................................................................................................................................. 377ipnat(7I) ............................................................................................................................................ 381ipnet(7D) ........................................................................................................................................... 388ipqos(7ipp) ........................................................................................................................................ 390iprb(7D) ............................................................................................................................................. 392ipsec(7P) ........................................................................................................................................... 395ipsecah(7P) ....................................................................................................................................... 399ipsecesp(7P) ..................................................................................................................................... 400ipw(7D) ............................................................................................................................................... 401iscsi(7D) ........................................................................................................................................... 402isdnio(7I) .......................................................................................................................................... 403iser(7D) ............................................................................................................................................. 418isp(7D) ............................................................................................................................................... 419iwh(7D) ............................................................................................................................................... 425iwi(7D) ............................................................................................................................................... 426iwk(7D) ............................................................................................................................................... 427iwp(7D) ............................................................................................................................................... 428ixgb(7d) .............................................................................................................................................. 429ixgbe(7D) ........................................................................................................................................... 431ixgbevf(7D) ...................................................................................................................................... 434kb(7M) ................................................................................................................................................ 436kdmouse(7D) ...................................................................................................................................... 445kmdb(7d) .............................................................................................................................................. 446kstat(7D) ........................................................................................................................................... 447ksyms(7D) ........................................................................................................................................... 448ldterm(7M) ........................................................................................................................................ 450llc1(7D) ............................................................................................................................................. 453llc2(7D) ............................................................................................................................................. 456lockstat(7D) .................................................................................................................................... 463lofi(7D) ............................................................................................................................................. 464lofs(7FS) ........................................................................................................................................... 466log(7D) ............................................................................................................................................... 468lsc(7D) ............................................................................................................................................... 472

Contents

7

marvell88sx(7D) .............................................................................................................................. 473mc-opl(7D) ........................................................................................................................................ 477mcxe(7D) ............................................................................................................................................. 478md(7D) ................................................................................................................................................. 480mediator(7D) .................................................................................................................................... 484mega_sas(7D) .................................................................................................................................... 487mem(7D) ............................................................................................................................................... 489mga(7D) ............................................................................................................................................... 490mhd(7i) ................................................................................................................................................. 491mixer(7I) ............................................................................................................................................ 496mpt(7D) ............................................................................................................................................... 507mpt_sas(7D) ...................................................................................................................................... 513mr_sas(7D) ........................................................................................................................................ 514msglog(7D) ........................................................................................................................................ 516mt(7D) ................................................................................................................................................. 517mtio(7I) .............................................................................................................................................. 518mwl(7D) ............................................................................................................................................... 533mxfe(7D) ............................................................................................................................................. 534myri10ge(7D) .................................................................................................................................... 535n2cp(7d) .............................................................................................................................................. 537n2rng(7d) ........................................................................................................................................... 539nca(7d) ................................................................................................................................................ 541ncp(7D) ............................................................................................................................................... 543nge(7D) ............................................................................................................................................... 545npe(7D) ............................................................................................................................................... 549ntwdt(7D) ........................................................................................................................................... 550ntxn(7D) ............................................................................................................................................. 551null(7D) ............................................................................................................................................. 553nulldriver(7D) ................................................................................................................................ 554nv_sata(7D) ...................................................................................................................................... 555nxge(7D) ............................................................................................................................................. 556objfs(7FS) ......................................................................................................................................... 559oce(7D) ............................................................................................................................................... 560ohci(7D) ............................................................................................................................................. 561openprom(7D) .................................................................................................................................... 563oplkmdrv(7D) .................................................................................................................................... 569

Contents


oplmsu(7D) ........................................................................................................................................ 570oplpanel(7D) .................................................................................................................................... 571packet(7P) ......................................................................................................................................... 572pcan(7D) ............................................................................................................................................. 575pcata(7D) ........................................................................................................................................... 576pcfs(7FS) ........................................................................................................................................... 578pcic(7D) ............................................................................................................................................. 584pcicmu(7D) ........................................................................................................................................ 585pcie_pci(7D) .................................................................................................................................... 586pckt(7M) ............................................................................................................................................ 587pcmcia(7D) ........................................................................................................................................ 588pcn(7D) ............................................................................................................................................... 589pcser(7D) ........................................................................................................................................... 591pcwl(7D) ............................................................................................................................................. 593pf_key(7P) ......................................................................................................................................... 594pfmod(7M) .......................................................................................................................................... 608physmem(7D) ...................................................................................................................................... 612pipemod(7M) ...................................................................................................................................... 613pm(7D) ................................................................................................................................................. 614poll(7d) .............................................................................................................................................. 620prnio(7I) ............................................................................................................................................ 626profile(7D) ...................................................................................................................................... 631ptem(7M) ............................................................................................................................................ 632ptm(7D) ............................................................................................................................................... 633pts(7D) ............................................................................................................................................... 635pty(7D) ............................................................................................................................................... 637qfe(7d) ................................................................................................................................................ 640qlc(7D) ............................................................................................................................................... 644qlcnic(7D) ........................................................................................................................................ 646qlge(7D) ............................................................................................................................................. 648quotactl(7I) ...................................................................................................................................... 649radeon(7d) ......................................................................................................................................... 651ral(7D) ............................................................................................................................................... 652ramdisk(7D) ...................................................................................................................................... 653random(7D) ........................................................................................................................................ 655rarp(7P) ............................................................................................................................................. 657

Contents

9

rge(7D) ............................................................................................................................................... 658route(7P) ........................................................................................................................................... 660routing(7P) ....................................................................................................................................... 665rtls(7D) ............................................................................................................................................. 667rtw(7D) ............................................................................................................................................... 668rum(7D) ............................................................................................................................................... 669rwd(7D) ............................................................................................................................................... 670rwn(7D) ............................................................................................................................................... 671sad(7D) ............................................................................................................................................... 672sata(7D) ............................................................................................................................................. 675scfd(7D) ............................................................................................................................................. 678scsa1394(7D) .................................................................................................................................... 679scsa2usb(7D) .................................................................................................................................... 682scsi_vhci(7D) .................................................................................................................................. 687sctp(7P) ............................................................................................................................................. 690scu(7D) ............................................................................................................................................... 696sd(7D) ................................................................................................................................................. 698sda(7D) ............................................................................................................................................... 706SDC(7) .................................................................................................................................................. 707sdcard(7D) ........................................................................................................................................ 708sdhost(7D) ........................................................................................................................................ 709sdp(7D) ............................................................................................................................................... 710sdt(7D) ............................................................................................................................................... 713se(7D) ................................................................................................................................................. 714se_hdlc(7D) ...................................................................................................................................... 718ses(7D) ............................................................................................................................................... 721sesio(7I) ............................................................................................................................................ 723sf(7D) ................................................................................................................................................. 725sfe(7D) ............................................................................................................................................... 728sgen(7D) ............................................................................................................................................. 730sharefs(7FS) ..................................................................................................................................... 735si3124(7D) ........................................................................................................................................ 736sip(7P) ................................................................................................................................................ 737slp(7P) ................................................................................................................................................ 738smbfs(7FS) ......................................................................................................................................... 740smbios(7D) ........................................................................................................................................ 742

Contents


smbus(7D) ........................................................................................................................................... 743smp(7D) ............................................................................................................................................... 744socal(7D) ........................................................................................................................................... 745sockio(7I) .......................................................................................................................................... 747sol_ofs(7D) ...................................................................................................................................... 748sol_ucma(7D) .................................................................................................................................... 749sol_umad(7D) .................................................................................................................................... 750sol_uverbs(7D) ................................................................................................................................ 751sppptun(7M) ...................................................................................................................................... 752srpt(7D) ............................................................................................................................................. 753ssd(7D) ............................................................................................................................................... 754st(7D) ................................................................................................................................................. 759streamio(7I) ...................................................................................................................................... 778su(7D) ................................................................................................................................................. 793sv(7D) ................................................................................................................................................. 796sxge(7D) ............................................................................................................................................. 797sysmsg(7D) ........................................................................................................................................ 799systrace(7D) .................................................................................................................................... 800tcp(7P) ................................................................................................................................................ 801termio(7I) .......................................................................................................................................... 808termiox(7I) ........................................................................................................................................ 829ticlts(7D) ........................................................................................................................................ 835timod(7M) .......................................................................................................................................... 837tirdwr(7M) ........................................................................................................................................ 839tmpfs(7FS) ......................................................................................................................................... 841todopl(7D) ........................................................................................................................................ 843tokenmt(7ipp) .................................................................................................................................... 844tsalarm(7D) ...................................................................................................................................... 847tswtclmt(7ipp) .................................................................................................................................. 851ttcompat(7M) .................................................................................................................................... 853tty(7D) ............................................................................................................................................... 861ttymux(7D) ........................................................................................................................................ 862tzmon(7d) ........................................................................................................................................... 863uata(7D) ............................................................................................................................................. 864uath(7D) ............................................................................................................................................. 867udfs(7FS) ........................................................................................................................................... 868

Contents

11

udp(7P) ................................................................................................................................................ 869ufs(7FS) .............................................................................................................................................. 872ugen(7D) ............................................................................................................................................. 875uhci(7D) ............................................................................................................................................. 897ural(7D) ............................................................................................................................................. 898urtw(7D) ............................................................................................................................................. 899usba(7D) ............................................................................................................................................. 900usb_ac(7D) ........................................................................................................................................ 904usb_ah(7M) ........................................................................................................................................ 906usb_as(7D) ........................................................................................................................................ 907usbecm(7D) ........................................................................................................................................ 909usbftdi(7D) ...................................................................................................................................... 910usb_ia(7D) ........................................................................................................................................ 913usbkbm(7M) ........................................................................................................................................ 914usb_mid(7D) ...................................................................................................................................... 916usbms(7M) .......................................................................................................................................... 918usbprn(7D) ........................................................................................................................................ 922usbsacm(7D) ...................................................................................................................................... 927usbser_edge(7D) .............................................................................................................................. 930usbsksp(7D) ...................................................................................................................................... 933usbsprl(7D) ...................................................................................................................................... 936usbvc(7D) ........................................................................................................................................... 939usbwcm(7M) ........................................................................................................................................ 943uscsi(7I) ............................................................................................................................................ 945usmp(7I) .............................................................................................................................................. 949uvfs(7FS) ........................................................................................................................................... 951uwba(7D) ............................................................................................................................................. 952virtualkm(7D) .................................................................................................................................. 953visual_io(7I) .................................................................................................................................... 956vni(7d) ................................................................................................................................................ 964vr(7D) ................................................................................................................................................. 965vt(7I) ................................................................................................................................................... 967vuidmice(7M) .................................................................................................................................... 972vxge(7D) ............................................................................................................................................. 975wpi(7D) ............................................................................................................................................... 977wscons(7D) ........................................................................................................................................ 978

Contents


wusb_ca(7D) ...................................................................................................................................... 988wusb_df(7D) ...................................................................................................................................... 989xge(7D) ............................................................................................................................................... 990xhci(7D) ............................................................................................................................................. 992yge(7D) ............................................................................................................................................... 994zcons(7D) ........................................................................................................................................... 995zero(7D) ............................................................................................................................................. 996zfs(7FS) .............................................................................................................................................. 997zs(7D) ................................................................................................................................................. 999zsh(7D) ............................................................................................................................................. 1002zyd(7D) ............................................................................................................................................. 1006

Contents

13

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 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 9E describes the DDI (Device Driver Interface)/DKI (Driver/Kernel Interface),DDI-only, and DKI-only entry-point routines a developer 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.

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,

15

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 ownheading. ioctl calls for a specific device are listedalphabetically (on the man page for that specific device).

Preface


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

ioctl calls are used for a particular class of devices all ofwhich have an io ending, such as mtio(7I).

OPTIONS This section 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

EXAMPLES This section provides examples of usage or of how to use acommand or function. Wherever possible a complete

Preface

17

example 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


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

Introduction

R E F E R E N C E

19

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 199420

http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN4driver.conf-4http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1uname-1http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mrem-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Madd-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 21

http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN3Bsocket-3sockethttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Madd-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mrem-drv-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN3Fintro-3http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN2ioctl-2http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN3Bsocket-3sockethttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN4driver.conf-4http://www.oracle.com/pls/topic/lookup?ctx=E23823&id=SYSADV3http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=STREAMShttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=DRIVER

Device and Network Interfaces

R E F E R E N C E

23

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/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 4 Jan 201224

http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mprtconf-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-hba-attach-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-sync-pkt-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-transport-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-device-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-inquiry-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-pkt-9s

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

Note The adpu320 driver does not support the HostRAID feature found on some AdaptecSCSI controllers. For adpu320 to support a Adaptec SCSI adapter with HostRAID, you mustnot use any HostRAID features.

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

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

Name

Synopsis

Description

Driver Configuration

adpu320(7D)

Device and Network Interfaces 25

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

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


Availability x86

/kernel/drv/adpu320 Driver module.

/kernel/drv/amd64/adpu320 64bit driver module.

/kernel/drv/adpu320.conf Configuration file.

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 23 May 200626

http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mcfgadm-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mprtconf-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-abort-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-hba-attach-setup-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-ifgetcap-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-reset-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-sync-pkt-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Fscsi-transport-9fhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-device-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-extended-sense-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-inquiry-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN9Sscsi-pkt-9shttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=DRIVER

afe ADMtek Fast Ethernet device driver

/dev/afe

The afe driver is a multi-threaded, loadable, clonable, GLD-based STREAMS driversupporting the Data Link Provider Interface dlpi(7P) on ADMtek (now Infineon) Centaurand Comet Fast Ethernet controllers.

The afe driver can be used as either a style 1 or a style 2 Data Link Service Provider.Physical points of attachment (PPAs) are interpreted as the instance number of the afecontroller as assigned by the Solaris operating environment.

The relevant fields returned as part of a DL_INFO_ACK response are:

Maximum SDU is 1500. Minimum SDU is 0. The dlsap address length is 8. MAC type is DL_ETHER. SAP length is -2. The 6byte physical address is followed immediately by a 2byte SAP. Service mode is DL_CLDLS. Broadcast address is the 6-byte Ethernet broadcast address (ff:ff:ff:ff:ff:ff).

If the SAP provided is zero, then IEEE 802.3 mode is assumed and outbound frames will havethe frame payload length written into the type field. Likewise, inbound frames with a SAPbetween zero and 1500 are interpreted as IEEE 802.3 frames and delivered to any streams thatare bound to SAP zero (the 802.3 SAP).

The following properties may be configured using either ndd(1M) or the afe.confconfiguration file as described by driver.conf(4):

adv_autoneg_cap

Enables (default) or disables IEEE 802.3u auto-negotiation of link speed and duplexsettings. If enabled, the device negotiates among the supported (and configured, see below)link options with the link partner. If disabled, at least one of the link options below must bespecified. The driver selects the first enabled link option according to the IEEE 802.3uspecified preferences.

adv_100T4_cap

Enables the 100 BaseT4 link option. (Note that most hardware does not support thisunusual link style. Also, this uses two pairs of wires for data, rather than one.)

adv_100fdx_cap

Enables the 100 Base TX full-duplex link option. (This is generally the fastest mode if bothlink partners support it. Most modern equipment supports this mode.)

Name

Synopsis

Description

ApplicationProgramming

Interface

Properties

afe(7D)


http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mndd-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN4driver.conf-4

adv_100hdx_cap

Enables the 100 Base TX half-duplex link option. (Typically used when the link partner is a100 Mbps hub.)

adv_10fdx_cap

Enables the 10 Base-T full-duplex link option. (This less-frequently used mode is typicallyused when the link partner is a 10 Mbps switch.)

adv_10hdx_cap

Enables the 10 Base-T half-duplex link option. (This is the fall-back when no other optionis available. It is typically used when the link partner is a 10 Mbps hub or is an oldernetwork card.)

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


Architecture SPARC, x86

Interface Stability Committed

/dev/afe

Special character device

/kernel/drv/amd64/afe

64-bit driver binary (x86)

/kernel/drv/sparcv9/afe

64-bit driver binary (SPARC)

/kernel/drv/afe.conf

Configuration file

ndd(1M), driver.conf(4), attributes(5), streamio(7I), dlpi(7P)

IEEE 802.3 Institute of Electrical and Electronics Engineers, 2002

Attributes

Files

See Also

afe(7D)

man pages section 7: Device and Network Interfaces Last Revised 4 Jan 201128

http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN1Mndd-1mhttp://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN4driver.conf-4http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN5attributes-5

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.

Processes must open the agpgart_io driver utilizing a GRAPHICS_ACCESS privilege. Thenall the ioctls can be called by this processes with the saved file descriptor. With the exception ofAGPIOC_INFO, the AGPIOC_ACQUIRE ioctl must be called before any other ioctl. Once aprocess has acquired GART, it cannot be acquired by another process until the former processcalls AGPIOC_RELEASE.

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

EAGAINGART table allocation failed.

EIOInternal hardware initialization failed.

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

EPERMWithout enough privilege.

Name

Synopsis

Description

agpgart_io(7I)


http://www.oracle.com/pls/topic/lookup?ctx=E26502&id=REFMAN2open-2http://www.oracle.com/pls/topic/lookup?ctx=E26502&a

man pages section 7 device and network interfaces

Documents