Sun Microsystems HIPPI/P 1.0 Reference Manual

Sun Microsystems, Inc.

901 San Antonio Road

Palo Alto, CA 94303-4900

U.S.A.

Sun HIPPI/P 1.0 Character Device
Interface Reference Manual

Part No: 805-7708-10

March, 1999

Copyright 1999 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California 94303-4900 U.S.A. All rights reserved.
This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and

decompilation. No part of this product or document may be reproduced in any form by any means without prior written authorization of
Sun and its licensors, if any. Third-party software, including font technology, is copyrighted and licensed from Sun suppliers.

Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered
trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd.

Sun, Sun Microsystems, the Sun logo, SunDocs, Java, the Java Coffee Cup logo, and Solaris are trademarks, registered trademarks, or
service marks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks
or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon
an architecture developed by Sun Microsystems, Inc.

The OPEN LOOK and Sun
acknowledges the pioneering efforts of Xerox in researching and developing the concept of visual or graphical user interfaces for the
computer industry. Sun holds a non-exclusive license from Xerox to the Xerox Graphical User Interface, which license also covers Sun’s
licensees who implement OPEN LOOK GUIs and otherwise comply with Sun’s written license agreements.

RESTRICTED RIGHTS: Use, duplication, or disclosure by the U.S. Government is subject to restrictions of FAR 52.227–14(g)(2)(6/87) and
FAR 52.227–19(6/87), or DFAR 252.227–7015(b)(6/95) and DFAR 227.7202–3(a).

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY

TM

Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun

INVALID.

Copyright 1999 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, Californie 94303-4900 Etats-Unis. Tous droits réservés.
Ce produit ou document est protégé par un copyright et distribué avec des licences qui en restreignent l’utilisation, la copie, la

distribution, et la décompilation. Aucune partie de ce produit ou document ne peut être reproduite sous aucune forme, par quelque
moyen que ce soit, sans l’autorisation préalable et écrite de Sun et de ses bailleurs de licence, s’il y en a. Le logiciel détenu par des tiers, et
qui comprend la technologie relative aux polices de caractères, est protégé par un copyright et licencié par des fournisseurs de Sun.

Des parties de ce produit pourront être dérivées du système Berkeley BSD licenciés par l’Université de Californie. UNIX est une marque
déposée aux Etats-Unis et dans d’autres pays et licenciée exclusivement par X/Open Company, Ltd.

Sun, Sun Microsystems, le logo Sun, SunDocs, Java, le logo Java Coffee Cup, et Solaris sont des marques de fabrique ou des marques
déposées, ou marques de service, de Sun Microsystems, Inc. aux Etats-Unis et dans d’autres pays. Toutes les marques SPARC sont utilisées
sous licence et sont des marques de fabrique ou des marques déposées de SPARC International, Inc. aux Etats-Unis et dans d’autres pays.
Les produits portant les marques SPARC sont basés sur une architecture développée par Sun Microsystems, Inc.

L’interface d’utilisation graphique OPEN LOOK et Sun
Sun reconnaît les efforts de pionniers de Xerox pour la recherche et le développement du concept des interfaces d’utilisation visuelle ou
graphique pour l’industrie de l’informatique. Sun détient une licence non exclusive de Xerox sur l’interface d’utilisation graphique Xerox,
cette licence couvrant également les licenciés de Sun qui mettent en place l’interface d’utilisation graphique OPEN LOOK et qui en outre
se conforment aux licences écrites de Sun.

CETTE PUBLICATION EST FOURNIE “EN L’ETAT” ET AUCUNE GARANTIE, EXPRESSE OU IMPLICITE, N’EST ACCORDEE, Y
COMPRIS DES GARANTIES CONCERNANT LA VALEUR MARCHANDE, L’APTITUDE DE LA PUBLICATION A REPONDRE A UNE
UTILISATION PARTICULIERE, OU LE FAIT QU’ELLE NE SOIT PAS CONTREFAISANTE DE PRODUIT DE TIERS. CE DENI DE

TM

a été développée par Sun Microsystems, Inc. pour ses utilisateurs et licenciés.

GARANTIE NE S’APPLIQUERAIT PAS, DANS LA MESURE OU IL SERAIT TENU JURIDIQUEMENT NUL ET NON AVENU.

Please

Recycle

Contents

Intro(1M) 2
blast(1M) 3
hipadmin(1M) 5
hippi(1M) 6
hippiarp(1M) 10
hippid(1M) 13
hippidb(1M) 14
hippidispp(1M) 16
hippidmpd(1M) 19
hippidnld(1M) 21
hippistat(1M) 23
hippitb(1M) 24
hippitune(1M) 25
sink(1M) 28

Contents iii

CHAPTER

Maintenance Commands

1

Maintenance Commands Intro(1M)

NAME Intro – HIPPI Administration

DESCRIPTION This section describes commands executed in the HIPPI environment.

LIST OF

COMMANDS

blast(1M) HIPPI character driver transmitter

hipadmin(1M) HIPPI configuration program

hippi(1M)
hippiarp(1M) HIPPI ARP (address resolution) display and

hippid(1M) HIPPI support daemon

hippidb(1M) HIPPI driver debug trace display and control

hippidisp(1M)
hippidmpd(1M) HIPPI dump daemon

hippidnld(1M) HIPPI driver RunCode download utility

hippistat(1M)
hippitb(1M) HIPPI driver debug trace display

hippitune(1M)

HIPPI control and status utility

control

HIPPI NIC display utility

HIPPI hardware statistics

HIPPI driver debugging and performance tuning
utility

sink(1M) HIPPI character device receiver

Last modified March 1999 SunOS 5.7 2

blast(1M) Maintenance Commands

NAME blast – HIPPI character driver transmitter example

SYNOPSIS blast [−2PMrkCc][−D unit][−I ifield][−l size][−n writes-per-pass][−m passes]

[−u ULP][−R file][−U]

AVAILABILITY SUNWhip

DESCRIPTION The /etc/opt/SUNWconn/bin/blast program provides sample code for

testing and using a HIPPI character device. The code includes most of the
ioctl() settings for transmitting data. For more information about these ioctl()
settings, see the character device interface user’s guide and reference. The
blast sample code also can be used with sink(1M) to analyze system
performance.

blast performs a write operation multiple times. The size of the packet
written is specified by size. The number of passes is specified by passes. The
number of times the packet is written during each pass is specified by
writes-per-pass. For example, to send 800 2MB packets 10 times, you would give
the following arguments:

-l 0x200000 -n 800 -m 10

You can also combine writes-per-pass into a single packet by using the -P flag.
For example, to sent 10 packets, each 1.6 GBytes in size, you could use the
following arguments:

-l 0x200000 -n 800 -m 10 -P
By default, blast writes packets that are four KBytes in size.
blast(1M) works with the sink(1M) sample program, which reads packets.

sink reads the HIPPI-FP header in addition to the packet data, so the sink

packet size must be at least eight bytes larger than the blast packet size.

OPTIONS All agruments are optional. Default values are as shown.

−2

−P

−r

3 SunOS 5.7 Last modified March 1999

Run blast in double-threaded mode. In this mode
the two threads write to the device
simultaneously. This argument cannot be used
with -P or -C.

Encapsulate each pass within a single packet.
This argument cannot be used with -2.

Send random data rather than printable ASCII
characters. If you use this option, the checking
option within sink(1M)> is inoperative.

Maintenance Commands blast(1M)

−C

−c

−D unit

−I Ifield Set the Ifield for the connection to the specified

−l size Use the specified size for the buffer passed to

−n writes-per-pass Use the specified number of writes per pass. The

−m passes

Establish a long-term connection, allowing the
transfer of multiple packets. This argument
cannot be used with -2.

When used with the -r option, cause a new
random packet to be generated for each write.
This option simulates a real world application.

Use the specified HIPPI card. This option is used
for paltforms that support multiple HIPPI cards.

value. The default is zero. For more information,
see the Sun HIPPI Installation and User’s Guide.

each write() call. The default is 4096 bytes.

default is 500. When -P is specified, the end of a
pass designates the end of a packet. When -C is
specified, the end of a pass indicates when the
connection is dropped.

Perform the specified number of passes. The
default is one.

−u ULP

−R file

−U

SEE ALSO hippi(1M), sink(1M)

Last modified March 1999 SunOS 5.7 4

Use the specified upper layer protocol identifier
for the framing protocol header. This identifier
must match the upper layer protocol identifier
specified by sink(1M). The default is 0x82.

Record performance information in the specified
file.

Send unknown-length (infinite) packets. The
actual packet length is specified by -1. The packet
length must be a multiple of 8 bytes.

hipadmin(1M) Maintenance Commands

NAME hipadmin – HIPPI configuration program

SYNOPSIS hipadmin [−u]

AVAILABILITY SUNWhip

DESCRIPTION For each HIPPI card present in the system,

/etc/opt/SUNWconn/bin/hipadmin interactively prompts the user to enter
the IP address, netmask, and HIPPI switch address in the following format:

address netmask switch_address

The information is then stored in:

/etc/opt/SUNWconn/hippi/hipn.conf

where n is an integer, 0 through 3, inclusive.
Each time you run hipadmin you must then edit the hippiarp.conf utility

to update the ARP configuration information, then run

/etc/init.d/hippi start. This sequence causes execution of
hippiarp.conf.

hipadmin also prompts for each NIC’s EEPROM update.
hipadmin must be executed after the HIPPI package has been installed, and

you must be root to do so.

OPTIONS The following options are supported:

−u

SEE ALSO hippi(1M), hippitune(1M), hippidnld(1M), boot(1M)

NOTE In the absence of HIPPI hardware, this utility asks for the number of interfaces

to be configured. Based on the response, it creates the aforementioned hipn
files. Then, when the hardware is installed, you need to execute one of the
following commands to create HIPPI /device nodes and /dev links:

ok boot diskname -r

# drvconfig, devlinks

5 SunOS 5.7 Last modified March 1999

Update the NIC(s) EEPROM contents.

Maintenance Commands hippi(1M)

NAME hippi – HIPPI driver RunCode download utility

SYNOPSIS hippi [on][[short]|[long]] [[fp]|[ph]] [[network]|[loopback]]

[[switched]|[direct]] [unit]

hippi off [dump] [unit]

hippi restart [dump] [unit]

hippi status [unit]

hippi accept [unit]

hippi reject [unit]

hippi version

hippi cards

AVAILABILITY SUNWhip

DESCRIPTION /etc/opt/SUNWconn/bin/hippi displays the state of the HIPPI driver and

hardware or queries the current status or version of the network cards.
Any user can execute this command to obtain the status, version number, or

number of cards on the network, but only super user can execute it with its
other options.

OPTIONS The following options are supported:

on [short | long] [fp | ph] [network | loopback] [switched | direct] [unit]

Load RunCode (firmware) into the HIPPI device and start the device. The
system boot processing automatically loads RunCode and starts the device if
it is not already running. If the driver is already active, the command fails.
When you execute hippi on with any of its options (for example, short or
long), the option value is remembered as long as the system remains up,
and is reused on the next invocation of hippi on. You can use
hippitune(1M) to permanently set default values.

IP datagrams over HIPPI have a maximum MTU size of 65288 bytes. All
HIPPI traffic should be limited to 64-Kbyte packet size when IP datagrams
are sent over a HIPPI network. Setting the short option limits packets to 64
kilobytes, while setting the long option permits any size of packets to be
sent over the network. long also enables you to use all of the
connection-control and packet-control facilities.

Last modified March 1999 SunOS 5.7 6

hippi(1M) Maintenance Commands

Use fp to set receive processing to HIPPI-FP mode, or ph to set it to
HIPPI-PH mode. In fp mode, the NIC multiplexes the incoming packets
based on the value in the ULP field of the FP header. In ph mode, all
incoming packets go to the same place. The network driver cannot be used
in ph mode.

The NIC usually passes HIPPI packets through the network interface and
out over the network. It also accepts packets from the network and you can
use the loopback option to place it in internal-loopback mode. In this mode,
all packets that are sent out are internally passed back to the receive
interface. All connection attempts from the network are rejected.

The NIC usually is connected to a HIPPI-SC switch (switched). To connect it
to another NIC, use the direct option.

As installed, the defaults for hippi on are short, fp, network, and
switched. You can use hippitune(1M) to change the defaults. But to
change the operating mode (for example, to short, long, fp, ph, network,
loopback, switched,ordirect), you must deconfigure the NIC by using
the ifconfig down. See ifconfig(1M).

off [dump]

Immediately stop the HIPPI RunCode and place the system into a state in
which it can neither accept nor transmit packets. All pending reads and
writes are completed with EINTR. All CDI calls complete with ENODEV
errors until you issue either a hippi on or hippi restart command.

The dump option causes a dump file to be generated. The dump file contains
the current state of the driver and RunCode. Customer support can use the
dump file to diagnose a problem.

restart [dump]

Stop the RunCode. A read or write that is actively passing data is completed
with EINTR, and the packet is truncated. Reads and writes that are waiting
to use the HIPPI device are not affected. Firmware is loaded and started.
Processing continues with the operation after the failed operation.

The dump option causes a dump file to be generated. The dump file
contains the current state of the driver and RunCode.

status

Query current system status and report whether the system is on or off.

7 SunOS 5.7 Last modified March 1999