Provides access to the System Configuration Table (SCT).
Access to this package is restricted to callers carrying a privileged ID. See your System Administrator for access.
Get error log
- Retrieves the error log record from the SCT.
Get hardware info
- Gets hardware infonnation about a cardcage.
Release hw entries
- Reserves modules which have already been reserved by the calling process.
Reserve hw entries
- Reserves the specified modules entries in SCf and returns the list of modules in the cardcage.
Retrieve cardcage entries
Returns a record which contains an entry describing the selected modules in the designated cardcage.
Retrieve_device_entry
Retrieves infonnation stored in the
scr
about a device.Retrieve software entry
Extracts user visible infonnation from the SCf's software entry and returns this infonnation in a record.
Set_system_monitor-parameters
Sets the System Monitor parameters in the SCf's software entry.
This package provides access to the SCf using four types:
• Retrieve functions return records which contain images of various entries in the SCf (card-module, device, or cardcage entries).
• The Set procedure allows the caller to set the System Monitor's control parameters.
• Reserve/Release functions allow the caller to reserve and release various card-modules in a cardcage.
• The Get procedure returns either the summary for the
scr
hardware information (that is, data on modules in a particular cardcage) or it's error logs.This package provides you with read access only to the System Configuration Table except for the System Monitor control parameters in the software entry.
The SCI' consists of three parts. The first part includes the system software entry which con-tains information used by the system software to cOnfigure the system.
The second part contains an error log. The error log is a circular buffer that records the most recent hardware-related errors. It also contains a total error count field which can be used to detect an error log overflow.
The third part of the
scr
contains the hardware entries. These entries contain a detailed descriotion of the current hardware confi2Ufation.Exceptions
reserved by others
An attempt was made to reselVe modules already reselVed by another process or release a module already reselVed by another process, using a Reserve or Release function.
not in
seT
- Indicates a non-existant HW entry in the SCT.
inconsistent data
Indicates an attempt to update the SCT with corrupt data.
Declarations
I
max Jlarameter _numbermax_parameter_number: constant:= 8;
Maximum number of parameters for each 10 device in the SCf's device list.
free_hw_entry: constant KMDS Defs.hardware entry rep :=
(entry type - => KMDS Defs.free~
cardcage ID => KMDS-Defs.sys, status - => KMDS=Defs.not_used);
HW entry of type free.
I
module_arraytype module_array is array ( System.ordinal range
o .. KMDS_Defs.max_slot_number) of KMDS_Defs.hardware_entry_rep;
List of module data, in a cardcage.
type entry list is record
-cardcage: KMDS Defs.hardware entry rep;
modules: module_array; - -end record;
List of entries.
I
parameter_arraytype parameter array is array (
1 .. max_parameter_number) of KMDS_Defs.device-param_rep;
Defme the data structures that hold device entry infonnation retrieved either from the SCf, or infonnation used to update the SCf.
I
device entryKMDS-Defs.functional status;
KMDS-Defs.slot number;
KMDS-Defs.IO device ID;
System. ordinal;
parameter_array;
end record;
The following fields define pertinent elements of the device.
Fields:
cardcage _ ID ID of the cardcage device belongs to.
status Functional status of the device.
module Slot number of the device.
device ID Device iD infonnation.
param_length The number of entries placed in the parameter field.
parameters Device parameters.
type reserve by option is
physical_ID, logical_ID, slot_number, ignore);
for reserve_by_option'size use System.storage_unit;
Module identification options to reselVe modules in a cardcage.
I
module_reserve _optionstype module reserve options (
pragma suppress(discriminant_check,module_reserve_options);
for module _reserve_options use record
option at 0 range 0 7;
phys ID at 1 range 0 7;
logic_ID at 1 range 0 7;
slot num end record;
at 1 range 0 .. 7;
Reserve the module with this physical 10.
Fields:
option phys_ID logic_ID slot num
Reserve the module with this logical_ID.
Reserve the module with this slot_number.
I
module_entries _arraytype module entries array is array (
1 .. KMDS_Defs.max_slot_number) of module_reserve_options;
Array type specifies a set of modules in a cardcage with it's slot number, VLSI physical_
ID, or VLSI logi ca 1_ ID. Reserve and Release functions then use it to reserve or release the modules in a cardcage. To specify the ID of each module, you need to set the option field of each array entry as defined by module_reserve_options record declaration.
dont care list: constant module entries array := module entries array' ( - 1 .~ KMDS_Defs.max_slot_nuffiber => (option => ignore»;
-Denotes an empty list of modules passed to Reserve _ hw _ entr ie s when the list of modules to reserve is not needed (reserving all modules in the cardcage), and passed to Re lea s e hw ent r i e s when the list of modules to release is not needed. This releases all modules in the cardcage reserved by the current process.
I
requested_modulestype requested modules is (
all_modules,-cardcage, offline, bad);
Used by the retrieve functions to indicate what set of modules in the cardcage to retrieve infonnation from.
• all_modules: Retrieve info from all modules in cardcage.
• cardcage: Retrieve info from the cardcage entry, only.
• offline: Retrieve info from modules with functional status of offline in cardcage.
• bad: Retrieve info from modules with functional status of offline, faulty, or, offline_or_faulty in cardcage.
function Get error log(
zero error count: boolean := false) return-KMDS Defs.error log record;
pragma outerface(value, Get_error_log);
Parameters
zero error count
- A directive to zero (clear) out the error count field (total number of errors logged) in the System Configuration Table.