Diff: inc/net/br_mle_lib.h

Revision:

4:c449bead5cf3

Child:

11:1b7aaf37a131

diff -r 1e7446b1fcae -r c449bead5cf3 inc/net/br_mle_lib.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/net/br_mle_lib.h	Tue Jun 24 16:48:01 2014 +0300
@@ -0,0 +1,71 @@
+/**
+ * \file br_mle_lib.h
+ * \brief Border Router MLE (Mesh Link Establishment) API when wireless interface is running.
+ *
+ * - arm_mle_prepare_update(), Update MLE link parameter(Channel, PAN-ID, allow-join) at Run time
+ * - arm_mle_update_beacon_payload(), Update Beacon payload optional data part
+ * - arm_mle_link_request_to_routers(), load MLE entry from NVM
+ *
+ * MLE update process recommend minimum delay should be >5000 ms.
+ * PAN-ID and Channel update cause problems to sleepy Host Node.
+ * Those nodes never get Multicast packet from parent and loose parent.
+ *
+ * MLE link update messages will be delivered by trickle multicast forwarding using multicast address FF03::1.
+ *
+ */
+
+
+/* Supported MLE Link layer Parameters changes at Run time*/
+#define MLE_CHANNEL_UPDATE_TYPE 0 		/* Update new link layer channel */
+#define MLE_PANID_UPDATE_TYPE 1			/* Update new link layer PAN-ID */
+#define MLE_ALLOW_JOIN_UPDATE_TYPE 2	/* Update Allow Join Bit at Beacon payload */
+
+/**
+ * \brief Update MLE link parameter at Run time
+ *
+ * \param nwk_id Network interface ID
+ * \param type MLE_CHANNEL_UPDATE_TYPE, MLE_PANID_UPDATE_TYPE or MLE_ALLOW_JOIN_UPDATE_TYPE
+ * \param time Interval to Update in milliseconds need to 5000 or bigger.
+ * \param value indicate channel, pan-id or boolean value for allow join
+ *
+ * \return 0 	Update process OK
+ * \return -1 	Old update process still active
+ * \return -2 	Unsupported Update Type
+ * \return -3	Un supported value (channel not between 11-26 or pan id was 0xffff or 0xfffe)
+ * \return -4 Stack at idle state
+ *
+ * List Possible values for specific types:
+ * - MLE_CHANNEL_UPDATE_TYPE, supported values 11-26
+ * - MLE_PAN_ID_UPDATE_TYPE ,supported value 0x0000 -0xfffd
+ * - MLE_ALLOW_JOIN__UPDATE_TYPE ,16-bit Boolean 0=Disbaled and 1=Enabled
+ *
+ *
+ */
+extern int8_t arm_mle_prepare_update(int8_t nwk_id,uint8_t type, uint32_t time, uint16_t value);
+/**
+ * \brief Update Beacon Payload optional field
+ *
+ * \param nwk_id Network interface ID
+ * \param optional_fields_data pointer to given Optional data
+ * \param optional_fields_len length of optional data
+ * \param delay Interval to Update in milliseconds need to 5000 or bigger.
+ *
+ * \return 0 	Update process OK
+ * \return -1 	Old update process still active or Memory allocation fail
+ * \return -2 	Unsupported Update Type
+ * \return -4 Stack at idle state
+ *
+ */
+extern int8_t arm_mle_update_beacon_payload(int8_t nwk_id, uint8_t *optional_fields_data, uint8_t optional_fields_len, uint32_t delay);
+/**
+ * \brief Send multicast MLE link request to all routers
+ *
+ *  This function should call when Border Router bootup by loaded NVM setups.
+ *
+ * \param nwk_id Network interface ID
+ *
+ * \return 0 	Update process OK
+ * \return -1 	Memory allocation fail for packet
+ *
+ */
+extern int8_t arm_mle_link_request_to_routers(int8_t nwk_id);