WS LLC and MAC MPX API definition and IE types definition.

Define MPX API and WS LLC configure and Asynch data API.

Author: Juha Heiskanen

source/6LoWPAN/MAC/mpx_api.h

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef MPX_API_H_
+#define MPX_API_H_
+
+struct mcps_data_req_s;
+struct mcps_data_conf_s;
+struct mcps_data_ind_s;
+struct mcps_purge_s;
+
+typedef struct mpx_api_s mpx_api_t;
+
+/**
+ * @brief mpx_data_request MPX_DATA request with user ID
+ * @param api API to handle the request
+ * @param data MCPS-DATA.request specific values
+ * @param user_id MPX user ID
+ *
+ */
+typedef void mpx_data_request(const mpx_api_t *api, const struct mcps_data_req_s *data, uint16_t user_id);
+
+/**
+ * @brief mpx_data_queue_clean clean MPX user data
+ * @param api API to handle the request
+ * @param purge MCPS-purge request
+ * @param user_id MPX user ID
+ *
+ */
+typedef void mpx_data_purge_request(const mpx_api_t *api, struct mcps_purge_s *purge, uint16_t user_id);
+
+/**
+ * @brief mpx_data_confirm MPX-DATA confirm is called as a response to MPX-DATA request
+ * @param api The API which handled the response
+ * @param data MCPS-DATA.confirm specific values
+ * @param user_id MPX user ID
+ */
+typedef void mpx_data_confirm(const mpx_api_t* api, const struct mcps_data_conf_s *data);
+
+/**
+ * @brief mpx_data_indication MPX-DATA confirm is called as a response to MPX-DATA request
+ * @param api The API which handled the response
+ * @param data MCPS-DATA.indication specific values
+ * @param user_id MPX user ID
+ */
+typedef void mpx_data_indication(const mpx_api_t* api, const struct mcps_data_ind_s *data);
+
+/**
+ * @brief mpx_header_size_get Function for request MPX user head room size
+ * @param api The API which handled the response
+ * @param user_id MPX user ID
+ *
+ * @return >0 Head room size in bytes
+ * @return 0 When Unknown User Id
+ */
+typedef uint16_t mpx_header_size_get(const mpx_api_t * api, uint16_t user_id);
+
+/**
+ * @brief mpx_data_cb_register MPX-DATA confirm cb register by user
+ * @param api The API which handled the response
+ * @param confirm_cb MPX Data Confirm call back
+ * @param indication_cb MPX Data indication
+ * @param user_id MPX user ID
+ *
+ * @return 0 register OK
+ * @return -1 Unknown User ID
+ */
+typedef int8_t mpx_data_cb_register(const mpx_api_t* api, mpx_data_confirm *confirm_cb, mpx_data_indication *indication_cb, uint16_t user_id);
+
+/**
+ * \brief Struct mpx_api_s defines functions for MPX user for register call backs and send data.
+ */
+struct mpx_api_s {
+    mpx_data_request * mpx_data_request;            /**< MPX data request. */
+    mpx_data_purge_request *mpx_data_purge;            /**< MPX data Purge. */
+    mpx_header_size_get * mpx_headroom_size_get;    /**< MPX headroom size get in bytes. */
+    mpx_data_cb_register * mpx_user_registration;   /**< MPX User cb registration must be call before enable to send or RX data*/
+};
+
+
+#endif /* MPX_API_H_ */

source/6LoWPAN/ws/ws_common_defines.h

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef WS_COMMON_DEFINES_H_
+#define WS_COMMON_DEFINES_H_
+
+
+/* Header IE Sub elements */
+#define WH_IE_UTT_TYPE              1   /**< Unicast Timing and Frame type information */
+#define WH_IE_BT_TYPE               2   /**< Broadcast timing information */
+#define WH_IE_FC_TYPE               3   /**< Flow Control for Extended Direct Frame Exchange */
+#define WH_IE_RSL_TYPE              4   /**< Received Signal Level information */
+#define WH_IE_MHDS_TYPE             5   /**< MHDS information for mesh routing */
+#define WH_IE_VH_TYPE               6   /**< Vendor header information */
+
+#define WS_WP_NESTED_IE             4 /**< WS nested Payload IE element'selement could include mltiple sub payload IE */
+
+/* Payload IE sub elements in side WS_WP_NESTED_IE */
+#define WP_PAYLOAD_IE_US_TYPE       1   /**< Unicast Schedule information */
+#define WP_PAYLOAD_IE_BS_TYPE       2   /**< Broadcast Schedule information */
+#define WP_PAYLOAD_IE_VP_TYPE       3   /**< Vendor Payload information */
+#define WP_PAYLOAD_IE_PAN_TYPE      4   /**< PAN Information */
+#define WP_PAYLOAD_IE_NETNAME_TYPE  5   /**< Network Name information */
+#define WP_PAYLOAD_IE_PAN_VER_TYPE  6   /**< Pan configuration version */
+#define WP_PAYLOAD_IE_GTKHASH_TYPE  7   /**< GTK Hash information */
+
+/* WS frame types to WH_IE_UTT_TYPE */
+#define WS_FT_PAN_ADVERT        0          /**< PAN Advert */
+#define WS_FT_PAN_ADVERT_SOL    1          /**< PAN Advert Solicit */
+#define WS_FT_PAN_CONF          2          /**< PAN Config */
+#define WS_FT_PAN_CONF_SOL      3          /**< PAN Config Solicit */
+#define WS_FT_DATA              4          /**< data type inside MPX */
+#define WS_FT_ACK               5          /**< Enhanced ACK */
+#define WS_FT_EAPOL             6          /**< EAPOL message inside MPX */
+
+
+/**
+ * @brief ws_pan_information_t PAN information
+ */
+typedef struct ws_pan_information_s {
+    uint16_t pan_size;          /**< Number devices connected to Border Router. */
+    uint16_t routing_cost;      /**< ETX to border Router. */
+    uint16_t pan_version;       /**< Pan configuration version will be updatd by Border router at PAN. */
+    bool use_parent_bs:1;       /**< 1 for force to follow parent broadcast schedule. 0 node may define own schedule. */
+    bool rpl_routing_method:1;  /**< 1 when RPL routing is selected and 0 when L2 routing. */
+    unsigned version:3;         /**< Pan version support. */
+} ws_pan_information_t;
+
+#endif /* WS_COMMON_DEFINES_H_ */

source/6LoWPAN/ws/ws_llc.h

@@ -0,0 +1,120 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef WS_LLC_H_
+#define WS_LLC_H_
+
+struct protocol_interface_info_entry;
+struct mcps_data_ind_s;
+struct mcps_data_ie_list;
+struct channel_list_s;
+struct ws_pan_information_s;
+
+
+/**
+ * @brief ws_asynch_ind ws asynch data indication
+ * @param interface Interface pointer
+ * @param data MCPS-DATA.indication specific values
+ * @param ie_ext Information element list
+ */
+typedef void ws_asynch_ind(struct protocol_interface_info_entry *interface, const struct mcps_data_ind_s *data, const struct mcps_data_ie_list *ie_ext, uint8_t message_type);
+
+/**
+ * @brief ws_asynch_confirm ws asynch data confirmation to asynch message request
+ * @param api The API which handled the response
+ * @param data MCPS-DATA.confirm specific values
+ * @param user_id MPX user ID
+ */
+typedef void ws_asynch_confirm(struct protocol_interface_info_entry *interface, uint8_t asynch_message);
+
+/**
+ * @brief ws_llc_create ws LLC module create
+ * @param interface Interface pointer
+ * @param data MCPS-DATA.indication specific values
+ * @param ie_ext Information element list
+ *
+ * Function allocate and init LLC class and init it 2 supported 2 API: ws asynch and MPX user are internally registered.
+ */
+int8_t ws_llc_create(struct protocol_interface_info_entry *interface, ws_asynch_ind *asynch_ind_cb, ws_asynch_confirm *asynch_cnf_cb);
+
+/**
+ * @brief ws_llc_reset Reset ws LLC parametrs and clean messages
+ * @param interface Interface pointer
+ *
+ */
+void ws_llc_reset(struct protocol_interface_info_entry *interface);
+
+/**
+ * @brief ws_llc_asynch_request ws asynch message request to all giving channels
+ * @param interface Interface pointer
+ * @param asynch_message Asynch message type: WS_FT_PAN_ADVERT, WS_FT_PAN_ADVERT_SOL, WS_FT_PAN_CONF or WS_FT_PAN_CONF_SOL
+ * @param channel_list Channel list where message is pushed
+ *
+ * @return 0 Asynch message pushed to MAC
+ * @return -1 memory allocate problem
+ * @return -2 Parameter problem
+ * LLC allocate message spesific IE element itself how it is configured
+ *
+ */
+int8_t ws_llc_asynch_request(struct protocol_interface_info_entry *interface, uint8_t asynch_message, struct channel_list_s channel_list);
+
+
+/**
+ * @brief ws_llc_set_vendor_header_data Configure WS vendor Header data information (Data of WH_IE_VH_TYPE IE element)
+ * @param interface Interface pointer
+ * @param vendor_header_length configured vendor header length
+ * @param vendor_header pointer to vendor header this pointer must keep alive when it is configured to LLC
+ *
+ */
+void ws_llc_set_vendor_header_data(struct protocol_interface_info_entry *interface, uint8_t vendor_header_length, uint8_t *vendor_header);
+
+/**
+ * @brief ws_llc_set_vendor_payload_data Configure WS vendor payload data information (Data of WP_PAYLOAD_IE_VP_TYPE IE element)
+ * @param interface Interface pointer
+ * @param vendor_payload_length configured vendor payload length
+ * @param vendor_payload pointer to vendor payload this pointer must keep alive when it is configured to LLC
+ *
+ */
+void ws_llc_set_vendor_payload_data(struct protocol_interface_info_entry *interface, uint8_t vendor_payload_length, uint8_t *vendor_payload);
+
+/**
+ * @brief ws_llc_set_network_name Configure WS Network name (Data of WP_PAYLOAD_IE_NETNAME_TYPE IE element)
+ * @param interface Interface pointer
+ * @param name_length configured network name length
+ * @param net_name pointer to network name this pointer must keep alive when it is configured to LLC
+ *
+ */
+void ws_llc_set_network_name(struct protocol_interface_info_entry *interface, uint8_t name_length, uint8_t *net_name);
+
+/**
+ * @brief ws_llc_set_gtkhash Configure WS GTK hash information (Data of WP_PAYLOAD_IE_GTKHASH_TYPE IE element)
+ * @param interface Interface pointer
+ * @param gtkhash pointer to GTK hash which length is 32 bytes this pointer must keep alive when it is configured to LLC
+ *
+ */
+void  ws_llc_set_gtkhash(struct protocol_interface_info_entry *interface, uint8_t *gtkhash);
+
+/**
+ * @brief ws_llc_set_pan_information_pointer Configure WS PAN information (Data of WP_PAYLOAD_IE_PAN_TYPE IE element)
+ * @param interface Interface pointer
+ * @param pan_information_pointer pointer to Pan information this pointer must keep alive when it is configured to LLC
+ *
+ */
+void ws_llc_set_pan_information_pointer(struct protocol_interface_info_entry *interface, struct ws_pan_information_s *pan_information_pointer);
+
+
+#endif /* WS_LLC_H_ */