@@ -130,9 +130,9 @@ int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr);
130
130
*
131
131
* Table is Parent child relation using the Global address IID of the devices
132
132
* To get the full IPv6 address of the device.
133
- * IPv6 = Global Prefix + IID.
133
+ * IPv6 = Global Prefix + IID.
134
134
*
135
- * Routing table is in the format: 18 bytes per entry
135
+ * Routing table is in the format: 16 bytes per entry
136
136
* | Node IID 8 bytes | parent IID 8 bytes |
137
137
* | 1122112211221122 | 1111111111111111 |
138
138
* | 1133113311331133 | 1111111111111111 |
@@ -142,15 +142,18 @@ int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr);
142
142
* | 1177117711771177 | 1155115511551155 |
143
143
* | 1188118811881188 | 1177117711771177 |
144
144
*
145
- * Order is not assured only parent child link is given in random order
145
+ * Order is not assured only parent child link is given in random order,
146
146
*
147
- * Return value is device amount in network divided by 16 bytes per route entry
147
+ * When preparing to call this function ws_bbr_info_get function should be called to get the amount of devices in the network.
148
+ * Memory for table is allocated based on the size of network and needs to be sizeof(bbr_route_info_t) * amount of entries.
148
149
*
149
- * \param interface_id interface ID of the Wi-SUN network
150
- * \param table_ptr Application allocated memory block where routing table is written.
150
+ * Return value is amount of route entries written to the table.
151
+ *
152
+ * \param interface_id interface ID of the Wi-SUN network.
153
+ * \param table_ptr Application allocated memory where routing table is written.
151
154
* \param table_len Length of the table allocated by application given as amount of entries.
152
155
*
153
- * \return 0 - x on success indicates amount of bytes written to the table_ptr
156
+ * \return 0 - x on success indicates amount of Route entries written to the table_ptr
154
157
* \return <0 in case of errors
155
158
*
156
159
*/
0 commit comments