Make main readme file easier to read, and make documentation build instructions clearer.

[pub/USBasp.git] / Projects / Magstripe / Lib / MagstripeHW.h

diff --git a/Projects/Magstripe/Lib/MagstripeHW.h b/Projects/Magstripe/Lib/MagstripeHW.h
index c468118..7afde48 100644 (file)
--- a/Projects/Magstripe/Lib/MagstripeHW.h
+++ b/Projects/Magstripe/Lib/MagstripeHW.h
@@ -1,14 +1,14 @@
 /*
 /*

-  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, and distribute this software
-  and its documentation for any purpose and without fee is hereby
-  granted, provided that the above copyright notice appear in all
-  copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting
-  documentation, and that the name of the author not be used in
-  advertising or publicity pertaining to distribution of the
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -25,30 +25,30 @@
        NOTE: The user of this include file MUST define the following macros
        prior to including the file:
 
        NOTE: The user of this include file MUST define the following macros
        prior to including the file:
 

-       MAG_T1_CLOCK_PIN   Pin connected to Track 1 clock wire (ie. PORTC1)
-       MAG_T1_DATA_PIN    Pin connected to Track 1 data wire (ie. PORTC2)
-       MAG_T2_CLOCK_PIN   Pin connected to Track 2 clock wire (ie. PORTC3)
-       MAG_T2_DATA_PIN    Pin connected to Track 2 data wire (ie. PORTC0)
-       MAG_T3_CLOCK_PIN   Pin connected to Track 3 clock wire (ie. PORTC5)
-       MAG_T3_DATA_PIN    Pin connected to Track 3 data wire (ie. PORTC6)
-       MAG_CLS_PIN        Pin connected to card loaded wire (ie. PORTC4)
-       MAG_PIN            PIN macro for the reader's port (ie. PINC)
-       MAG_DDR            DDR macro for the reader's port (ie. DDRC)
-       MAG_PORT           PORT macro for the reader's port (ie. PORTC)
+       MAG_T1_CLOCK_PIN   Pin connected to Track 1 clock wire (i.e.. PORTC1)
+       MAG_T1_DATA_PIN    Pin connected to Track 1 data wire (i.e.. PORTC2)
+       MAG_T2_CLOCK_PIN   Pin connected to Track 2 clock wire (i.e.. PORTC3)
+       MAG_T2_DATA_PIN    Pin connected to Track 2 data wire (i.e.. PORTC0)
+       MAG_T3_CLOCK_PIN   Pin connected to Track 3 clock wire (i.e.. PORTC5)
+       MAG_T3_DATA_PIN    Pin connected to Track 3 data wire (i.e.. PORTC6)
+       MAG_CLS_PIN        Pin connected to card loaded wire (i.e.. PORTC4)
+       MAG_PIN            PIN macro for the reader's port (i.e.. PINC)
+       MAG_DDR            DDR macro for the reader's port (i.e.. DDRC)
+       MAG_PORT           PORT macro for the reader's port (i.e.. PORTC)

 
        The example macros listed above assume that the Track 2 data wire is
        connected to pin 0 on port C, the Track 2 clock wire is connected to
        pin 3 on port C (similarly for Tracks 1 and 3), and the card loaded
        wire is connected to pin 4 on port C.
 
 
        The example macros listed above assume that the Track 2 data wire is
        connected to pin 0 on port C, the Track 2 clock wire is connected to
        pin 3 on port C (similarly for Tracks 1 and 3), and the card loaded
        wire is connected to pin 4 on port C.
 

-       If the magstripe reader you are using only reads one or two tracks,
+       If the mag-stripe reader you are using only reads one or two tracks,

        then set the clock and data pins for the tracks it doesn't read to a
        pin that is unused.  For example, on the AT90USBKey, any of the pins on
        port C that do not have wires attached will be unused since they are
        not connected to any onboard devices (such as the joystick or
        temperature sensor).
 
        then set the clock and data pins for the tracks it doesn't read to a
        pin that is unused.  For example, on the AT90USBKey, any of the pins on
        port C that do not have wires attached will be unused since they are
        not connected to any onboard devices (such as the joystick or
        temperature sensor).
 

-       Connecting wires to pins on different ports (ie. a data wire to pin 0
+       Connecting wires to pins on different ports (i.e.. a data wire to pin 0

        on port C and a clock wire to pin 0 on port D) is currently
        unsupported.  All pins specified above must be on the same port.
 */
        on port C and a clock wire to pin 0 on port D) is currently
        unsupported.  All pins specified above must be on the same port.
 */


@@ -93,7 +93,7 @@
                        static inline uint8_t Magstripe_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t Magstripe_GetStatus(void)
                        {
                        static inline uint8_t Magstripe_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t Magstripe_GetStatus(void)
                        {

-                               /* Magstripe IOs are active low and must be inverted when read */
+                               /* Mag-stripe IOs are active low and must be inverted when read */

                                return ((uint8_t)~MAG_PIN & MAG_MASK);
                        }
 
                                return ((uint8_t)~MAG_PIN & MAG_MASK);
                        }