Fix documentation reference error.

[pub/USBasp.git] / Projects / TempDataLogger / Lib / DS1307.h

diff --git a/Projects/TempDataLogger/Lib/DS1307.h b/Projects/TempDataLogger/Lib/DS1307.h
index 9b14ee4..87c6229 100644 (file)
--- a/Projects/TempDataLogger/Lib/DS1307.h
+++ b/Projects/TempDataLogger/Lib/DS1307.h
@@ -1,8 +1,8 @@
 /*
      Copyright (C) Dean Camera, 2010.
 /*
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 #ifndef _DS1307_H_
 */
 
 #ifndef _DS1307_H_


@@ -23,23 +23,23 @@
                                        unsigned int Sec            : 4;
                                        unsigned int TenSec         : 3;
                                        unsigned int CH             : 1;
                                        unsigned int Sec            : 4;
                                        unsigned int TenSec         : 3;
                                        unsigned int CH             : 1;

-                               };
-                               
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte1;
                                uint8_t IntVal;
                        } Byte1;

-                       
+

                        union
                        {
                                struct
                                {
                                        unsigned int Min            : 4;
                                        unsigned int TenMin         : 3;
                        union
                        {
                                struct
                                {
                                        unsigned int Min            : 4;
                                        unsigned int TenMin         : 3;

-                                       unsigned int _RESERVED      : 1;
-                               };
-                               
+                                       unsigned int Reserved       : 1;
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte2;
                                uint8_t IntVal;
                        } Byte2;

-                       
+

                        union
                        {
                                struct
                        union
                        {
                                struct


@@ -47,9 +47,9 @@
                                        unsigned int Hour            : 4;
                                        unsigned int TenHour         : 2;
                                        unsigned int TwelveHourMode  : 1;
                                        unsigned int Hour            : 4;
                                        unsigned int TenHour         : 2;
                                        unsigned int TwelveHourMode  : 1;

-                                       unsigned int _RESERVED       : 1;
-                               };
-                               
+                                       unsigned int Reserved        : 1;
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte3;
                } DS1307_TimeRegs_t;
                                uint8_t IntVal;
                        } Byte3;
                } DS1307_TimeRegs_t;


@@ -62,9 +62,9 @@
                                {
                                        unsigned int Day             : 4;
                                        unsigned int TenDay          : 2;
                                {
                                        unsigned int Day             : 4;
                                        unsigned int TenDay          : 2;

-                                       unsigned int _RESERVED       : 2;
-                               };
-                       
+                                       unsigned int Reserved        : 2;
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte1;
 
                                uint8_t IntVal;
                        } Byte1;
 


@@ -74,20 +74,20 @@
                                {
                                        unsigned int Month           : 4;
                                        unsigned int TenMonth        : 1;
                                {
                                        unsigned int Month           : 4;
                                        unsigned int TenMonth        : 1;

-                                       unsigned int _RESERVED       : 3;
-                               };
-                               
+                                       unsigned int Reserved        : 3;
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte2;
                                uint8_t IntVal;
                        } Byte2;

-                       
+

                        union
                        {
                                struct
                                {
                                        unsigned int Year            : 4;
                                        unsigned int TenYear         : 4;
                        union
                        {
                                struct
                                {
                                        unsigned int Year            : 4;
                                        unsigned int TenYear         : 4;

-                               };
-                               
+                               } Fields;
+

                                uint8_t IntVal;
                        } Byte3;
                } DS1307_DateRegs_t;
                                uint8_t IntVal;
                        } Byte3;
                } DS1307_DateRegs_t;


@@ -95,15 +95,23 @@
        /* Macros: */
                #define DS1307_TIMEREG_START  0x00
                #define DS1307_DATEREG_START  0x04
        /* Macros: */
                #define DS1307_TIMEREG_START  0x00
                #define DS1307_DATEREG_START  0x04

-       
+

                #define DS1307_ADDRESS_READ   0b11010001
                #define DS1307_ADDRESS_WRITE  0b11010000
 
        /* Function Prototypes: */
                #define DS1307_ADDRESS_READ   0b11010001
                #define DS1307_ADDRESS_WRITE  0b11010000
 
        /* Function Prototypes: */

-               void DS1307_SetDate(uint8_t Day, uint8_t Month, uint8_t Year);
-               void DS1307_SetTime(uint8_t Hour, uint8_t Minute, uint8_t Second);
-               
-               void DS1307_GetDate(uint8_t* Day, uint8_t* Month, uint8_t* Year);
-               void DS1307_GetTime(uint8_t* Hour, uint8_t* Minute, uint8_t* Second);
+               void DS1307_SetDate(const uint8_t Day,
+                                   const uint8_t Month,
+                                   const uint8_t Year);
+               void DS1307_SetTime(const uint8_t Hour,
+                                   const uint8_t Minute,
+                                   const uint8_t Second);
+               void DS1307_GetDate(uint8_t* const Day,
+                                   uint8_t* const Month,
+                                   uint8_t* const Year);
+               void DS1307_GetTime(uint8_t* const Hour,
+                                   uint8_t* const Minute,
+                                   uint8_t* const Second);

 
 #endif
 
 #endif

+