1 karl  1.1.2.2 // Copyright (c) 2005 DMTF.  All rights reserved.
 2               // <change cr="CIMCoreCR00752.000" type ="change">Update of
 3               // descriptions based on Tech Edit review.</
 4               // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
 5               // qualifier values to CIM Schema.</change>
 6               // <change cr="ArchCR00089.003" type="add">Add PUnit qualifier values
 7               // to Units qualifier values.</change>
 8               // ==================================================================
 9               //  CIM_Watchdog
10               // ==================================================================
11                  [Version ( "2.10.0" ), 
12                   UMLPackagePath ( "CIM::Device::Processor" ), 
13                   Description ( 
14                      "CIM_Watchdog is a timer that is implemented in the system "
15                      "hardware. It allows the hardware to monitor the state of the "
16                      "Operating System, BIOS, or a software component that is "
17                      "installed on the System. If the monitored component fails to "
18                      "re-arm the timer before its expiration, the hardware assumes "
19                      "that the System is in a critical state, and could reset the "
20                      "ComputerSystem. This feature can also be used as an "
21                      "application watchdog timer for a mission-critical application. "
22 karl  1.1.2.2        "In this case, the application would assume responsibility for "
23                      "re-arming the timer before expiration." )]
24               class CIM_Watchdog : CIM_LogicalDevice {
25               
26                     [Description ( 
27                         "The entity that is currently being monitored by the "
28                         "WatchDog. This property is used to identify the module "
29                         "that is responsible for re-arming, or whose information "
30                         "is used to re-arm, the watchdog at periodic intervals." ), 
31                      ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8" }, 
32                      Values { "Unknown", "Other", "Operating System", 
33                         "Operating System Boot Process", 
34                         "Operating System Shutdown Process", 
35                         "Firmware Boot Process", "BIOS Boot Process", 
36                         "Application", "Service Processor" }]
37                  uint16 MonitoredEntity;
38               
39                     [Description ( 
40                         "A string that describes more textual information about "
41                         "the monitored entity." ), 
42                      MaxLen ( 256 )]
43 karl  1.1.2.2    string MonitoredEntityDescription;
44               
45                     [Description ( 
46                         "The timeout interval that is used by the watchdog, in "
47                         "MicroSeconds." ), 
48                      Units ( "MicroSeconds" ), 
49                      PUnit ( "second * 10^-6" )]
50                  uint32 TimeoutInterval;
51               
52                     [Description ( 
53                         "Resolution of the timer. For example, if this value is "
54                         "100, then the timer can expire anytime between "
55                         "(TimeoutInterval- 100) microseconds or "
56                         "(TimeoutInterval+100) microseconds." ), 
57                      Units ( "MicroSeconds" ), 
58                      PUnit ( "second * 10^-6" )]
59                  uint32 TimerResolution;
60               
61                     [Description ( "The time of the last timer expiry." )]
62                  datetime TimeOfLastExpiration;
63               
64 karl  1.1.2.2       [Description ( 
65                         "Monitored entity at the time of last timer expiry." ), 
66                      ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8" }, 
67                      Values { "Unknown", "Other", "Operating System", 
68                         "Operating System Boot Process", 
69                         "Operating System Shutdown Process", 
70                         "Firmware Boot Process", "BIOS Boot Process", 
71                         "Application", "Service Processor" }]
72                  uint16 MonitoredEntityOnLastExpiration;
73               
74                     [Description ( 
75                         "The action that should happen upon the expiry of the watchdog."
76                          ), 
77                      ValueMap { "0", "1", "2", "3", "4", "5" }, 
78                      Values { "None - Status Only", "System Reset", 
79                         "System Power Off", "System Power Off, then On", 
80                         "Generate System NonMaskableInterrupt (NMI)", 
81                         "Generate System Management Interrupt (SMI)" }]
82                  uint16 ActionOnExpiration;
83               
84               
85 karl  1.1.2.2       [Description ( 
86                         "A method to re-arm the timer. This method is used only "
87                         "if the MonitoredEntity is \"Application\". It returns 0 "
88                         "if successful, 1 if unsupported, and any other value if "
89                         "an error occurred. In a subclass, the set of possible "
90                         "return codes could be specified, using a ValueMap "
91                         "qualifier on the method. The strings to which the "
92                         "ValueMap contents are \'translated\' can also be "
93                         "specified in the subclass as a Values array qualifier." )]
94                  uint32 KeepAlive(
95               );
96               
97               };