1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>RTCAlarmParam</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTCAlarmParam <img src="../image/NTR.gif" align="middle"><img src="../image/TWL.gif" align="middle"></h1>
15
16<h2>Definition</h2>
17
18<dl>
19  <dd>
20<CODE>#include &lt;nitro/rtc.h&gt;</CODE><BR>
21  <PRE><CODE>typedef struct {
22         <A href="RTCWeek.html">RTCWeek</A>    week;
23         u32        hour;
24         u32        minute;
25         u32        enable;
26} RTCAlarmParam;</CODE></PRE>
27  </dd>
28
29</dl><h2>Elements</h2>
30<TABLE border="1" width="100%">
31  <TBODY>
32    <TR>
33      <TD width="300"><em><strong><font face="Courier New">week</font></strong></em></TD>
34      <TD width="700">Value of the <a href="RTCWeek.html">RTCWeek</a> enumeration that indicates the day of the week.</TD>
35    </TR>
36    <TR>
37      <TD><em><strong><font face="Courier New">hour</font></strong></em></TD>
38      <TD>Numerical value, from 0 to 23, that indicates the hour.</TD>
39    </TR>
40    <TR>
41      <TD><em><strong><font face="Courier New">minute</font></strong></em></TD>
42      <TD>Numerical value, from 0 to 59, that indicates the minute.</TD>
43    </TR>
44    <TR>
45      <TD><em><strong><font face="Courier New">enable</font></strong></em></TD>
46      <TD>Flag to determine the enabling of alarms (respectively) for: the day of the week, the hour, and the minute</TD>
47    </TR>
48  </TBODY>
49</TABLE>
50
51<H2>Description</H2>
52<P>Indicates the real-time clock alarm parameters. This function indicates the day of the week, the hour ,and the minute, as well as the status of the flag that determines whether each element is enabled.<br />The enable flag that determines whether an alarm is enabled can have any of the following values, or can be the value of the logical OR of all of them.</P>
53<TABLE border="1" width="100%">
54  <TBODY>
55    <TR>
56      <TD width="300"><em><strong><font face="Courier New">RTC_ALARM_ENABLE_NONE</font></strong></em></TD>
57      <TD width="100">0x0000</TD>
58      <TD width="600">All determining flags disabled</TD>
59    </TR>
60    <TR>
61      <TD><em><strong><font face="Courier New">RTC_ALARM_ENABLE_WEEK</font></strong></em></TD>
62      <TD>0x0001</TD>
63      <TD>Use day of week parameter in alarm determination.</TD>
64    </TR>
65    <TR>
66      <TD><em><strong><font face="Courier New">RTC_ALARM_ENABLE_HOUR</font></strong></em></TD>
67      <TD>0x0002</TD>
68      <TD>Use hour parameter in alarm determination.</TD>
69    </TR>
70    <TR>
71      <TD><em><strong><font face="Courier New">RTC_ALARM_ENABLE_MINUTE</font></strong></em></TD>
72      <TD>0x0004</TD>
73      <TD>Use minute parameter in alarm determination.</TD>
74    </TR>
75  </TBODY>
76</TABLE>
77
78<h2>See Also</h2>
79<P><CODE><A href="RTCWeek.html">RTCWeek</A></CODE></P>
80
81<H2>Revision History</H2>
82<P>
832004/08/19 Changed descriptions because the time notation was fixed. <BR>2004/07/01 Changed descriptions because the time notation was standardized. <BR>2004/05/18 Initial version.<BR>
84</P>
85<hr><p>CONFIDENTIAL</p></body>
86</html>
87