8.1 Introduction

8.2 Keywords

8.2.1 Setting Keyword Values

Specifying the Keyword Level

8.2.2 Retrieving Keyword Values

8.3 Summary of Editable Keywords

8.4 Summary of Informational Keywords

8.5 QX Plug-In Keywords

8.6 Alphabetical Keyword Reference

8.1 Introduction

This chapter documents all QX 2000 keywords. This chapter includes:

• A brief overview of OAM keywords, and how to set and retrieve them

• A summary of the QX 2000 keywords

• An alphabetical reference of the QX 2000 keywords

To learn how to use OAM utilities such as oamsys and oamcfg, refer to the OAM System User's Manual. To learn about setting and retrieving keywords programmatically, refer to the OAM Service Developer's Reference Manual.

8.2 Keywords

The keywords in the record for a given QX 2000 board describe that board's configuration. Some keywords are read/write; others are read-only:

• Read/write (editable) keywords determine how the board is configured when it starts up. Changes to these keywords become effective after the board has been rebooted.

• Read-only (informational) keywords indicate the board's current configuration. Read-only keywords cannot be modified.

Plug-in level keywords exist in a separate record in the OAM database. They indicate certain board family-level information. QX plug-in keywords are also documented in this chapter.

A keyword has the general syntax:

keyword = value

Keywords are case-insensitive. Values are case-insensitive except where operating system conventions prevail (for example, filenames under UNIX). All values are strings, or strings that represent integers. An integer keyword may have a fixed numeric range of legal values. A string keyword may support a fixed set of legal values, or may accept any string.

8.2.1 Setting Keyword Values

There are several ways to set the values of read/write keywords:

• Use or modify one of the sample board keyword files corresponding to your country and board type. Specify the name of the file in the File statement in oamsys.cfg, and run oamsys again. (See the OAM System User's Manual for information about board keyword file syntax.)

• Create a new board keyword file, either with additional keywords, or keywords whose values override earlier settings.

• Specify parameter settings using the oamcfg utility. For information about this utility, refer to the OAM System User's Manual.

• Specify the settings programmatically, using the OAM service API. (See the OAM Service Developer's Reference Manual for more information.)
  Note: Keyword values take effect after the board is rebooted.

Specifying the Keyword Level

When you set keyword values, you specify the OAM database record to modify, either in the system configuration file or oamcfg command line. To set board-level keywords, specify the board name here. To set plug-in level keywords, specify the plug-in name (qx2kpi.bpi).

8.2.2 Retrieving Keyword Values

There are several ways to retrieve the values of read/write and read-only keywords:

• Retrieve the settings programmatically, using the OAM service API. (See the OAM Service Developer's Reference Manual for more information.)

• Run the oaminfo sample program. Specify the name of the board with the -n option on the command line:
  oaminfo -n boardname
  To access plug-in level keywords, specify the plug-in name on the command line:
  oaminfo -n qx2kpi.bpi
  oaminfo returns a complete list of keywords and values. For more information about oaminfo, refer to the OAM Service Developer's Reference Manual.

8.3 Summary of Editable Keywords

The following table summarizes the keywords that you may want to change:

If you want to...	Use these keywords...
Specify whether the board is started or stopped automatically	AutoStart AutoStop
Change the FPGA file	FPGA.ConfigFile
Change the QSLAC file	NetworkInterface.Analog.ConfigFile[x]
Specify the board location	Location.PCI.Bus Location.PCI.Slot
Change the board name and number	Name Number
Change the companding law	Xlaw
Change diagnostic level	BootDiagnosticLevel
Set up clocking information	QX 2000/100-4L: Clocking.HBus.ClockMode Clocking.HBus.ClockSource QX 2000/80-4L: Clocking.MVIP.ClockRef
Configure DSPs	DSP.C5x[x].Image

8.4 Summary of Informational Keywords

The following table summarizes informational keywords (keywords that are read-only):

If you want to...	Use these keywords...
Determine the CT bus type supported by the board	Clocking.Type
Determine clock fallback settings	Clocking.HBus.AutoFallBack Clocking.HBus.FallBackClockSource Clocking.MVIP.AutoFallBack Clocking.MVIP.FallBackClockSource
Retrieve the board driver ID and name for the board	Driver.BoardID Driver.Name
Retrieve information about the board's EEPROM	Eeprom.AssemblyRevision Eeprom.DSPSpeed Eeprom.MFGWeek Eeprom.MFGYear Eeprom.NumDSPCores Eeprom.SerialNum Eeprom.SoftwareCompatibility
Determine the bus type supported by the board	Location.Type
Determine the number of analog ports on the board	NetworkInterface.Analog.Count
Determine the current state of the board	State
Determine the name of the switching driver	SwitchDriver.Name
Determine the product type of the board	Product

8.5 QX Plug-In Keywords

The following is a list of keywords in the QX plug-in record in the OAM database:

• Boards[x]

• DetectedBoards[x]

• Products[x]

• Version.Major

• Version.Minor

8.6 Alphabetical Keyword Reference

The keywords are presented in detail in the following sections. Each keyword description includes:

Syntax	The syntax of the keyword
Access	Read/Write or Read-only
Type	The data type of the value: String or Integer
Default	Default value
Allowed Values	A list of all possible values
Example	An example of usage
Description	A detailed description of the keyword's function
See Also	A list of related keywords