Add API to retrieve whitelist diag information. (#228)

include/openthread-types.h

@@ -362,6 +362,18 @@ typedef enum otMleAttachFilter
     kMleAttachBetterPartition = 2,  ///< Attach to a better (i.e. higher weight/partition id) Thread partition.
 } otMleAttachFilter;
 
+/**
+ * This structure represents a whitelist entry.
+ *
+ */
+typedef struct otMacWhitelistEntry
+{
+    otExtAddress mExtAddress;       ///< IEEE 802.15.4 Extended Address
+    int8_t       mRssi;             ///< RSSI value
+    bool         mValid : 1;        ///< Indicates whether or not the whitelist entry is vaild
+    bool         mFixedRssi : 1;    ///< Indicates whether or not the RSSI value is fixed.
+} otMacWhitelistEntry;
+
 /**
  * @}
  *

include/openthread.h

@@ -732,6 +732,7 @@ ThreadError otReleaseRouterId(uint8_t aRouterId);
  * @sa otAddMacWhitelistRssi
  * @sa otRemoveMacWhitelist
  * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otDisableMacWhitelist
  * @sa otEnableMacWhitelist
  */
@@ -749,6 +750,7 @@ ThreadError otAddMacWhitelist(const uint8_t *aExtAddr);
  * @sa otAddMacWhitelistRssi
  * @sa otRemoveMacWhitelist
  * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otDisableMacWhitelist
  * @sa otEnableMacWhitelist
  */
@@ -762,17 +764,31 @@ ThreadError otAddMacWhitelistRssi(const uint8_t *aExtAddr, int8_t aRssi);
  * @sa otAddMacWhitelist
  * @sa otAddMacWhitelistRssi
  * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otDisableMacWhitelist
  * @sa otEnableMacWhitelist
  */
 void otRemoveMacWhitelist(const uint8_t *aExtAddr);
 
+/**
+ * This function gets a MAC whitelist entry.
+ *
+ * @param[in]   aIndex  An index into the MAC whitelist table.
+ * @param[out]  aEntry  A pointer to where the information is placed.
+ *
+ * @retval kThreadError_None         Successfully retrieved the MAC whitelist entry.
+ * @retval kThreadError_InvalidArgs  @p aIndex is out of bounds or @p aEntry is NULL.
+ *
+ */
+ThreadError otGetMacWhitelistEntry(uint8_t aIndex, otMacWhitelistEntry *aEntry);
+
 /**
  *  Remove all entries from the MAC whitelist.
  *
  * @sa otAddMacWhitelist
  * @sa otAddMacWhitelistRssi
  * @sa otRemoveMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otDisableMacWhitelist
  * @sa otEnableMacWhitelist
  */
@@ -786,6 +802,7 @@ void otClearMacWhitelist(void);
  * @sa otAddMacWhitelistRssi
  * @sa otRemoveMacWhitelist
  * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otEnableMacWhitelist
  */
 void otDisableMacWhitelist(void);
@@ -793,14 +810,31 @@ void otDisableMacWhitelist(void);
 /**
  * Enable MAC whitelist filtering.
  *
- * @sa otAccMacWhitelist
+ * @sa otAddMacWhitelist
  * @sa otAddMacWhitelistRssi
  * @sa otRemoveMacWhitelist
  * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
  * @sa otDisableMacWhitelist
  */
 void otEnableMacWhitelist(void);
 
+/**
+ * This function indicates whether or not the MAC whitelist is enabled.
+ *
+ * @returns TRUE if the MAC whitelist is enabled, FALSE otherwise.
+ *
+ * @sa otAddMacWhitelist
+ * @sa otAddMacWhitelistRssi
+ * @sa otRemoveMacWhitelist
+ * @sa otClearMacWhitelist
+ * @sa otGetMacWhitelistEntry
+ * @sa otDisableMacWhitelist
+ * @sa otEnableMacWhitelist
+ *
+ */
+bool otIsMacWhitelistEnabled(void);
+
 /**
  * Detach from the Thread network.
  *