Diff: MAX14661.h

Revision:

1:4b0d22958890

Parent:

0:6bd0b1a28e10

Child:

2:c3525ee2d636

--- a/MAX14661.h	Mon Feb 03 04:14:24 2014 +0000
+++ b/MAX14661.h	Sat Feb 15 22:07:55 2014 +0000
@@ -56,61 +56,61 @@
     /** Name the register addresses
     */
     enum MAX14661regs {
-        REG_DIR0 = 0x00,
-        REG_DIR1,
-        REG_DIR2,
-        REG_DIR3,
-        REG_SHDW0 = 0x10,
-        REG_SHDW1,
-        REG_SHDW2,
-        REG_SHSW3,
-        REG_CMD_A,
-        REG_CMD_B
+        REG_DIR0 = 0x00,  /**< 8A-1A Direct Access */
+        REG_DIR1,         /**< 16A-9A Direct Access */
+        REG_DIR2,         /**< 8B-1B Direct Access */
+        REG_DIR3,         /**< 16B-9B Direct Access */
+        REG_SHDW0 = 0x10, /**< 8A-1A Shadow */
+        REG_SHDW1,        /**< 16A-9A Shadow */
+        REG_SHDW2,        /**< 8B-1B Shadow */
+        REG_SHSW3,        /**< 16B-9B Shadow */
+        REG_CMD_A,        /**< Command A */
+        REG_CMD_B         /**< Command A */
     };
 
     /** Name the command codes
     */
     enum MAX14661cmds {
-        CMD_EN01 = 0x00,
-        CMD_EN02,
-        CMD_EN03,
-        CMD_EN04,
-        CMD_EN05,
-        CMD_EN06,
-        CMD_EN07,
-        CMD_EN08,
-        CMD_EN09,
-        CMD_EN10,
-        CMD_EN11,
-        CMD_EN12,
-        CMD_EN13,
-        CMD_EN14,
-        CMD_EN15,
-        CMD_EN16,
-        CMD_DIS,
-        CMD_COPY,
-        CMD_NOOP = 0x1F
+        CMD_EN01 = 0x00,  /**< Enable switch 1 */
+        CMD_EN02,         /**< Enable switch 2 */
+        CMD_EN03,         /**< Enable switch 3 */
+        CMD_EN04,         /**< Enable switch 4 */
+        CMD_EN05,         /**< Enable switch 5 */
+        CMD_EN06,         /**< Enable switch 6 */
+        CMD_EN07,         /**< Enable switch 7 */
+        CMD_EN08,         /**< Enable switch 8 */
+        CMD_EN09,         /**< Enable switch 9 */
+        CMD_EN10,         /**< Enable switch 10 */
+        CMD_EN11,         /**< Enable switch 11 */
+        CMD_EN12,         /**< Enable switch 12 */
+        CMD_EN13,         /**< Enable switch 13 */
+        CMD_EN14,         /**< Enable switch 14 */
+        CMD_EN15,         /**< Enable switch 15 */
+        CMD_EN16,         /**< Enable switch 16 */
+        CMD_DIS,          /**< Disable switches  */
+        CMD_COPY,         /**< Copy shadow registers to switches */
+        CMD_NOOP = 0x1F   /**< Keep current state, no changes */
     };
 
     /** Name the switch bits
     */
     enum MAX14661sws {
-        SW01 = (1 << 0),
-        SW02 = (1 << 1),
-        SW03 = (1 << 2),
-        SW04 = (1 << 3),
-        SW05 = (1 << 4),
-        SW06 = (1 << 5),
-        SW07 = (1 << 6),
-        SW08 = (1 << 7),
-        SW09 = (1 << 8),
-        SW10 = (1 << 9),
-        SW11 = (1 << 10),
-        SW12 = (1 << 11),
-        SW13 = (1 << 12),
-        SW14 = (1 << 13),
-        SW15 = (1 << 14),
-        SW16 = (1 << 15)
+        SW01 = (1 << 0),  /**< Bit mask for switch 1 */
+        SW02 = (1 << 1),  /**< Bit mask for switch 2 */
+        SW03 = (1 << 2),  /**< Bit mask for switch 3 */
+        SW04 = (1 << 3),  /**< Bit mask for switch 4 */
+        SW05 = (1 << 4),  /**< Bit mask for switch 5 */
+        SW06 = (1 << 5),  /**< Bit mask for switch 6 */
+        SW07 = (1 << 6),  /**< Bit mask for switch 7 */
+        SW08 = (1 << 7),  /**< Bit mask for switch 8 */
+        SW09 = (1 << 8),  /**< Bit mask for switch 9 */
+        SW10 = (1 << 9),  /**< Bit mask for switch 10 */
+        SW11 = (1 << 10), /**< Bit mask for switch 11 */
+        SW12 = (1 << 11), /**< Bit mask for switch 12 */
+        SW13 = (1 << 12), /**< Bit mask for switch 13 */
+        SW14 = (1 << 13), /**< Bit mask for switch 14 */
+        SW15 = (1 << 14), /**< Bit mask for switch 15 */
+        SW16 = (1 << 15)  /**< Bit mask for switch 16 */
     };
 
     /** Clears all bits to opens all 32 switches