Specifying other sections

Other sections of the AOF file are populated for each attribute that is specified for the KEY, REQUIRED, and ADVANCED attributes that are defined in the ADAPTER section. These other sections list the configurable options for a network adapter. The synopsis is:

   ADAPTER:
      ...
   

      KEY=attribute[,attribute]
      REQUIRED=attribute_list
      ADVANCED=attribute_list
      attribute_list::ATTR1, ATTR2
      attribute::=[a-zA-Z][a-zA-Z0-9_]
   

   ATTR1:
      [PROMPT="string_to_display"]
      TYPE=link-kit|swconfig|unique
      VALUES=value[,value2,...]
      [DEFAULTS=value[,value2,...]]
   

   ATTR2:
      [PROMPT="string_to_display"]
      TYPE=link-kit|swconfig|unique
      VALUES=value[,value2,...]
      [DEFAULTS=value[,value2,...]]

PROMPT

(Optional) The prompt that will appear to the user when prompting for this configurable options. If this is not specified, it will default to the following values:

BASE_IO

I/O Base Address

SLOT

Slot #

IRQ

Interrupt Vector

RAM

Shared RAM

ROM

Boot ROM

DMA

DMA Channel

PCI_BUS

PCI Bus #

PCI_DEV

PCI Device #

PCI_FUNC

PCI Function #

TRANSCEIVER

Transceiver Type

MEDIA

Media/Cable Type

If PROMPT is not specified and the Attribute name is not in this list, the Attribute name itself will be used as the prompt. Nothing enforces naming attributes similarly across different AOFs, please use the standard attribute names for attributes that are used by the adapter.

Special case code is used to warn the user about potential conflicts in the list of legal values for some of the configurable options. The following algorithms are used to check for conflicts:

BASE_IO

BASE_IO:SIZE is a special attribute that is read to determine the size of the I/O register area. All the sdevice files in the Link Kit are then scanned for conflicting I/O addresses.

SLOT

All network adapter configurations for the same BUS type are scanned for conflicts.

IRQ

All sdevice files in the Link Kit are scanned to find conflicting interrupt vectors.

RAM

Entries in this field are assumed to include base address and size. All sdevice files in the Link Kit are scanned to find conflicting memory addresses.

ROM

Same as RAM.

DMA

The mdevice file in the Link Kit is scanned to find conflicting DMA channels.

other

If TYPE=unique, then scan all the configuration information for all the adapters that are supported in the system for conflicts.

TYPE

Tells the configuration framework how to treat this option. Valid values are:

link-kit

This option is passed to the vendor-supplied lkcfg script and is stored in the system Link Kit.

swconfig

This option is software configurable and will be passed to the vendor-supplied acfg utility which will write its value to the adapter.

unique

The value for this option must be unique across all adapters supported by this driver.

VALUES

List of legal values for that option. The syntax for a VALUES attribute is:

   VALUES=value[,value2,...]
   value::=string | value_range | region | region_range
   value_range::=start'-'end':'step
   region::=start '('sizelist')'
   region_range::=start'='end':'step'(sizelist ')'
   sizelist::=size ['|'size]
   start,end,step::=hex_number
   size::=decimal_number

The VALUES attribute is a comma-separated list of values. For example, the valid values for an interrupt vector are expressed as:

   IRQ:
        VALUES=2,3,4,5,7

Values in the list can be more complex; they can be a range of values. For example, a range of I/O base addresses could be expressed as:

   BASE_IO:
        VALUES=200-330:10

The range above is equivalent to the following list:

   BASE_IO:
        VALUES=200,210,220,230,240,250,260,270,280,290,
        2a0,2b0,2c0,2d0,2e0,2f0,300,310,320,330

Values for shared memory attributes (either RAM or ROM) should be expressed as lists of regions. For example, the 8K region starting at d0000 is:

   RAM:
        VALUES=d0000(8)

Multiple regions would be expressed as:

   RAM:
        VALUES=d0000(8),d1000(8),d2000(8)

A short hand for this is to use a range of regions:

   RAM:
        VALUES=d0000-d2000:1000(8)

Some adapters allow configurable sizes for memory regions. This can be expressed as:

   RAM:
        VALUES=d0000(8),d0000(16),d1000(8),d1000(16),d2000(32)

A shorthand for this is:

   RAM:
        VALUES=d0000(8|16),d1000(8|16),d2000(32)

Ranges of regions can be combined with multiple sizes, like the first value below:

   RAM:
        VALUES=d0000-d1000:1000(8|16),d2000(32)

DEFAULTS

(Optional) List of defaults to be used if this value cannot be determined from the adapter. This attribute can be used to order values differently than they are defined in the VALUES attribute. The first available, conflict-free DEFAULTS value is presented to the user. DEFAULTS are useful in cases where ranges are specified in the VALUES attribute, but the first value in the range is not the best choice for the default setting. For example:

   RAM:
        VALUES=a0000-f0000:4000(16)
        DEFAULTS=d0000,d4000,d8000,dc000