C H A P T E R  2

Installing the Sun Crypto Accelerator 4000 Board

This chapter describes how to install the Sun Crypto Accelerator 4000 hardware and also how to install and remove the software with automated scripts. This chapter includes the following sections:

Once you have installed the hardware and software of the board, you need to initialize the board with configuration and keystore information. See Initializing the Board With vcaadm for information on how to initialize the board.


Handling the Board

Each board is packed in a special antistatic bag to protect it during shipping and storage. To avoid damaging the static-sensitive components on the board, reduce any static electricity on your body before touching the board by using one of the following methods:



caution icon

Caution - To avoid damaging the sensitive components on the board, wear an antistatic wrist strap when handling the board, hold the board by its edges only, and always place the board on an antistatic surface (such as the plastic bag it came in).




Installing the Board

Installing the Sun Crypto Accelerator 4000 board involves inserting the board into the system and loading the software tools. The hardware installation instructions include only general steps for installing the board. Refer to the documentation that came with your system for specific installation instructions.


procedure icon  To Install the Hardware

1. As superuser, follow the instructions that came with your system to shut down and power off the computer, disconnect the power cord, and remove the computer cover.

2. Locate an unused PCI slot (preferably a 64-bit, 66 MHz slot).

3. Attach an antistatic wrist strap to your wrist, and attach the other end to a grounded metal surface.

4. Using a Phillips-head screwdriver, remove the screw from the PCI slot cover.

Save the screw to hold the bracket in Step 5.

5. Holding the Sun Crypto Accelerator 4000 board by its edges only, take it out of the plastic bag and insert it into the PCI slot.

6. Secure the screw on the rear bracket.

7. Replace the computer cover, reconnect the power cord, and power on the system.

8. Verify that the board is properly installed by entering the show-devs command at the OpenBoot PROM ok prompt:


ok show-devs
.
/chosen
/packages
/upa@8,480000/SUNW,ffb@0,0
/pci@8,600000/network@1
/pci@8,600000/SUNW,qlc@4
/pci@8,600000/SUNW,qlc@4/fp@0,0
.

In the preceding example, the /pci@8,600000/network@1 identifies the device path to the Sun Crypto Accelerator 4000 board. There is one such line for each board in the system.

To determine whether the Sun Crypto Accelerator 4000 device properties are listed correctly: From the ok prompt, navigate to the device path and type .properties to display the list of properties.


ok cd /pci@8,600000/network@1
ok .properties
assigned-addresses       82000810 00000000 00102000 00000000 00002000
                          81000814 00000000 00000400 00000000 00000100
                          82000818 00000000 00200000 00000000 00200000
                          82000830 00000000 00400000 00000000 00100000
d-fru-len                00 00 00 00
d-fru-off                00 00 e8 00
d-fru-dev                eeprom
s-fru-len                00 00 08 00
s-fru-off                00 00 e0 00
s-fru-dev                eeprom
compatible               70 63 69 38 30 38 36 2c 62 35 35 35 2e 31 30 38
reg                      00000800 00000000 00000000 00000000 00000000
                          02000810 00000000 00000000 00000000 00002000
                          02000814 00000000 00000000 00000000 00000100
                          02000818 00000000 00000000 00000000 00200000
                          02000830 00000000 00000000 00000000 00100000
address-bits             00 00 00 30
max-frame-size           00 00 40 00
network-interface-type   ethernet
device-type              network
name                     network
local-mac-address        00 03 ba 0e 99 ca
version                  Sun PCI Crypto Accelerator 4000 1000Base-T FCode
FCode 2.11.13 03/03/04
phy-type                 mif
board-model              501-6039
model                    SUNW,pci-vca
fcode-rom-offset         00000000
66mhz-capable
fast-back-to-back
devsel-speed             00000001
class-code               00100000
interrupts               00000001
max-latency              00000040
cache-line-size          00000010
max-latency              00000040
min-grant                00000040
subsystem-vendor-id      0000108e
subsystem-id             00003de8
revision-id              00000002
device-id                0000b555
vendor-id                00008086


Installing the Sun Crypto Accelerator 4000 Software With the install Script

The Sun Crypto Accelerator 4000 software is included on the Sun Crypto Accelerator 4000 CD. You may need to download patches from the SunSolve web site. Refer to the Sun Crypto Accelerator 4000 Board Version 2.0 Release Notes for the required patches.

There are two methods to install the software, manually or with the install script. This section describes how to install the software with the install script. To install the software manually, refer to Installing the Software Without the install Script.

Version 1.1 and 2.0 Software Contained on the CD-ROM

The Sun Crypto Accelerator 4000 Version 2.0 CD-ROM contains both Versions 1.1 and 2.0 of the software.



caution icon

Caution - Version 1.1 is for Solaris 8 and 9. Version 2.0 is supported on Solaris 10 only.



The install script path to each version is as follows:

For Version 1.1:

/cdrom/cdrom0/Sun_Crypto_Acc_4000_1_1

For Version 2.0:

/cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0

The respective installation scripts are located in these directories.


procedure icon  To Install the Software With the install Script

1. The Sun Crypto Accelerator 4000 Version 1.x software should not be installed on Solaris 10. If Version 1.x exists on your Solaris 10 system, use the following command to remove all Version 1.x packages:


# pkgrm SUNWkcl2o SUNWvcav SUNWvcar SUNWkcl2a SUNWkcl2u SUNWkcl2r SUNWvcamn SUNWkcl2m SUNWkcl2i SUNWvcaa SUNWvcafw SUNWvcau

2. Insert the Sun Crypto Accelerator 4000 CD into a CD-ROM drive that is connected to your system.

You see the following files and directories in the /cdrom/cdrom0 directory.


TABLE 2-1 Files in the /cdrom/cdrom0 Directory

File or Directory

Contents

README

Release information

Sun_Crypto_Acc_4000_1_1

Contains the Sun Crypto Accelerator 4000 Version 1.1 software for Solaris 8 and 9

Sun_Crypto_Acc_4000_2_0

Contains the Sun Crypto Accelerator 4000 Version 2.0 software for Solaris 10 only


Refer to the Sun Crypto Accelerator 4000 Board Version 1.1 Installation and User's Guide (817-3693-10) for instructions on how to install the Version 1.1 software.

You see the following files and directories in the /cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0 directory.


TABLE 2-2 Files in the /cdrom/cdrom0 /Sun_Crypto_Acc_4000_2_0 Directory

File or Directory

Contents

 

README

 

 

Copyright

U.S. copyright file

FR_Copyright

French copyright file

install

Script that installs the Sun Crypto Accelerator 4000 software

remove

Script that removes the Sun Crypto Accelerator 4000 software

Docs

Sun Crypto Accelerator 4000 Board Version 2.0 Installation and User's Guide

Sun Crypto Accelerator 4000 Board Version 2.0 Release Notes

Packages

Contains the Sun Crypto Accelerator 4000 software packages:

 

SUNWvcaa

VCA administration

 

SUNWvcact

VCA activation file

 

SUNWvcafw

VCA firmware

 

SUNWvcamn

VCA manual pages

 

SUNWvcaf

VCA supplemental files

 

SUNWvcar

VCA drivers

 

SUNWvcau

VCA daemon


3. Install the required software by typing:


# cd /cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0
# ./install

The install script analyzes the system to determine which required patches need to be installed, installs those patches, installs the main software--for example:



Note - The copyright and license information was omitted from the following example. Refer to Appendix B for copyright and software licenses.




# ./install
This program installs the software for the Sun Crypto Accelerator
4000, Version 2.0.
 
 
This script is about to take the following actions:
- Install Sun Crypto Accelerator 4000 support for Solaris 10
 
To cancel installation of this software, press 'q' followed by a Return.
         **OR**
Press Return key to begin installation:
 
*** Installing Sun Crypto Accelerator 4000 software for Solaris 10...
Installing required packages:
     SUNWvcaf SUNWvcact SUNWvcar SUNWvcau SUNWvcaa SUNWvcamn SUNWvcafw
 
 
Importing VCA keystore management daemon to SMF
Starting VCA keystore/management daemon
 
Installation of <SUNWvcaf> was successful.
 
Installation of <SUNWvcact> was successful.
 
Installation of <SUNWvcar> was successful.
 
Installation of <SUNWvcau> was successful.
 
Installation of <SUNWvcaa> was successful.
 
Installation of <SUNWvcamn> was successful.
 
Installation of <SUNWvcafw> was successful.
*** Installation complete.
 
To remove this software, use the 'remove' script on this CDROM, or
the following script:
 
        /var/tmp/crypto_acc.remove
 
A log of this installation can be found at:
        /var/tmp/crypto_acc.install.2005.01.31.0916


Directories and Files

TABLE 2-3 shows the directories created by the default installation of the Sun Crypto Accelerator 4000 software.


TABLE 2-3 Sun Crypto Accelerator 4000 Directories and Files

Directory

Contents

/etc/opt/SUNWconn/vca/keydata

Keystore data (encrypted)

/opt/SUNWconn/cryptov2/bin

Utilities

/opt/SUNWconn/cryptov2/firmware

Firmware

/opt/SUNWconn/cryptov2/lib

Support libraries

/opt/SUNWconn/cryptov2/man

Man pages

/opt/SUNWconn/cryptov2/method

SMF support files

/opt/SUNWconn/cryptov2/sbin

Administrative commands


FIGURE 2-1 shows the hierarchy of these directories and files.


FIGURE 2-1 Sun Crypto Accelerator 4000 Directories and Files




Note - Once you install the Sun Crypto Accelerator 4000 hardware and software, you need to initialize the board with configuration and keystore information. See Initializing the Board With vcaadm for information on how to initialize the board.




Removing the Sun Crypto Accelerator 4000 Software With the remove Script

There are three methods to remove the software: the remove script on the CD-ROM, the /var/tmp/crypto_acc.remove script on the server, or the pkgrm command. This section describes how to remove the software with the two removal scripts. For instructions on removing the software with the pkgrm command refer to Removing the Software Without the remove Script.

Use the remove script for software removal if you used the install script to install the software. Use the /var/tmp/crypto_acc.remove script if you installed the software manually. See Removing the Software Without the remove Script.


procedure icon  To Remove the Software With the remove Script on the CD-ROM

single-step bulletType the following with the Sun Crypto Accelerator 4000 CD-ROM inserted:


# cd /cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0/
# ./remove


procedure icon  To Remove the Software With the /var/tmp/crypto_acc.remove Script

A log of this installation can be found at:


 /var/tmp/crypto_acc.install.date

single-step bulletType the following:


# /var/tmp/crypto_acc.remove


Installing the Software Without the install Script

This section describes how to install the Sun Crypto Accelerator 4000 software manually without using the installation script (/cdrom/cdrom0//Sun_Crypto_Acc_4000_2_0/install) provided on the product CD.

The Sun Crypto Accelerator 4000 software is included on the product CD. You might need to download patches from the SunSolve web site (http://sunsolve.sun.com). See Required Patches for more information.

Version 1.1 and 2.0 Software Contained on the CD-ROM

The Sun Crypto Accelerator 4000 Version 2.0 CD-ROM contains both Versions 1.1 and 2.0 of the software.



caution icon

Caution - Version 1.1 is for Solaris 8 and 9. Version 2.0 is supported on Solaris 10 only.



The install script path to each version is as follows:

For Version 1.1:

/cdrom/cdrom0/Sun_Crypto_Acc_4000_1_1

For Version 2.0:

/cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0

The respective installation scripts are located in these directories.

 


procedure icon  To Install the Software Without the install Script

1. The Sun Crypto Accelerator 4000 Version 1.x software should not be installed on Solaris 10. If Version 1.x exists on your Solaris 10 system, use the following command to remove all Version 1.x packages:


# pkgrm SUNWkcl2o SUNWvcav SUNWvcar SUNWkcl2a SUNWkcl2u SUNWkcl2r SUNWvcamn SUNWkcl2m SUNWkcl2i SUNWvcaa SUNWvcafw SUNWvcau

2. Insert the Sun Crypto Accelerator 4000 CD into a CD-ROM drive that is connected to your system.

You see the following files and directories in the /cdrom/cdrom0 directory.


TABLE 2-4 Files in the /cdrom/cdrom0 Directory

File or Directory

Contents

 

Copyright

U.S. copyright file

FR_Copyright

French copyright file

install

Script that installs the Sun Crypto Accelerator 4000 software

remove

Script that removes the Sun Crypto Accelerator 4000 software

Docs

Sun Crypto Accelerator 4000 Board Version 2.0 Installation and User's Guide

Sun Crypto Accelerator 4000 Board Release Notes

Packages

Contains the Sun Crypto Accelerator 4000 software packages:

 

SUNWvcaa

VCA administration

 

SUNWvcact

VCA activation file

 

SUNWvcafw

VCA firmware

 

SUNWvcamn

VCA manual pages

 

SUNWvcaf

VCA supplemental files

 

SUNWvcar

VCA drivers

 

SUNWvcau

VCA daemon


The required packages must be installed in a specific order and must be installed before installing any optional packages. Once the required packages are installed, you can install and remove the optional packages in any order.

3. Install the required software packages by typing:


# cd /cdrom/cdrom0/Sun_Crypto_Acc_4000_2_0/Packages 
# pkgadd -d . SUNWvcact SUNWvcaf SUNWvcar SUNWvcau SUNWvcaa SUNWvcafw SUNWvcamn

4. (Optional) To verify that the software is installed properly, run the pkginfo command.


# pkginfo SUNWvcact SUNWvcaf SUNWvcar SUNWvcau SUNWvcaa SUNWvcafw SUNWvcamn
system      SUNWvcaa  VCA Crypto Accelerator/Gigabit Ethernet Admin
system      SUNWvcact VCA Crypto Accelerator/Gigabit Activation File
system      SUNWvcaf  VCA Crypto Accelerator/Gigabit Supplemental (usr)
system      SUNWvcafw VCA Crypto Accelerator/Gigabit Ethernet firmware
system      SUNWvcamn VCA Crypto Accelerator/Gigabit Ethernet Manual Pages
system      SUNWvcar  VCA Crypto Accelerator/Gigabit Ethernet Drivers
system      SUNWvcau  VCA Crypto Accelerator/Gigabit Ethernet Daemon

5. (Optional) To ensure that the driver is attached, you can run the prtdiag command.


# prtdiag -v

Refer to the prtdiag(1m) online manual pages.

6. (Optional) Run the modinfo command to see that modules are loaded.


# modinfo | grep Crypto
62   1317f62  20b1f 198   1  vca (VCA Crypto/Ethernet v1.232)
197  136d5d6   19b0 199   1  vcactl (VCA Crypto Control v1.39)

See Directories and Files for a description and hierarchical diagram of the directories and files in the default installation.


Removing the Software Without the remove Script



Note - Remove the Sun Crypto Accelerator 4000 software manually only if you did not use the install script to install the software. If you installed the software with the install script, to remove the software, see Removing the Sun Crypto Accelerator 4000 Software With the remove Script.



If you have created keystores (see Managing Keystores With vcaadm), you must delete the keystore information that the Sun Crypto Accelerator 4000 board is configured with before removing the software. The zeroize command removes all key material, but does not delete the keystore files that are stored in the filesystem of the physical host in which the board is installed. See the Performing a Software Zeroize on the Board for details on the zeroize command. To delete the keystore files stored in the system, become superuser and remove the keystore files. If you have not yet created any keystores, you can skip this procedure.



caution icon

Caution - Do not delete a keystore that is currently in use or that is shared by other users and keystores. To free references to keystores, you might have to shut down the web server, administration server, or both





caution icon

Caution - Before removing the Sun Crypto Accelerator 4000 software disable any web servers you have enabled for use with the Sun Crypto Accelerator 4000 board. Failure to do so leaves those web servers nonfunctional.




procedure icon  To Remove the Software Without the remove Script

single-step bulletAs superuser, use the pkgrm command to remove only the software packages you installed.



caution icon

Caution - Installed packages must be removed in the order shown. Failure to remove them in this order could result in dependency warnings and leave kernel modules loaded.



If you installed all the packages, you would remove them as follows:


# pkgrm SUNWvcamn SUNWvcafw SUNWvcaa SUNWvcau SUNWvcar SUNWvcaf SUNWvcact