Austin Blackstone
mbed client lightswitch demo
Dependencies: mbed Socket lwip-eth lwip-sys lwip
Fork of
mbed-client-classic-example-lwip
by 
Austin Blackstone
Diff: mbed-client-c/source/libCoap/src/sn_coap_builder.c
- Revision:
- 11:cada08fc8a70
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-client-c/source/libCoap/src/sn_coap_builder.c Thu Jun 09 17:08:36 2016 +0000
@@ -0,0 +1,1102 @@
+/*
+ * Copyright (c) 2011-2015 ARM Limited. All rights reserved.
+ * 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.
+ */
+
+/**
+ * \file sn_coap_builder.c
+ *
+ * \brief CoAP Message builder
+ *
+ * Functionality: Builds CoAP message
+ *
+ */
+
+/* * * * * * * * * * * * * * */
+/* * * * INCLUDE FILES * * * */
+/* * * * * * * * * * * * * * */
+
+#include <string.h> /* For memset() and memcpy() */
+
+#include "ns_types.h"
+#include "sn_nsdl.h"
+#include "sn_coap_header.h"
+#include "sn_coap_header_internal.h"
+#include "sn_coap_protocol_internal.h"
+
+/* * * * LOCAL FUNCTION PROTOTYPES * * * */
+static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
+static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
+static uint16_t sn_coap_builder_options_calc_option_size(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option);
+static int16_t sn_coap_builder_options_build_add_one_option(uint8_t **dst_packet_data_pptr, uint16_t option_len, uint8_t *option_ptr, sn_coap_option_numbers_e option_number);
+static int16_t sn_coap_builder_options_build_add_zero_length_option(uint8_t **dst_packet_data_pptr, uint8_t option_length, uint8_t option_exist, sn_coap_option_numbers_e option_number);
+static int16_t sn_coap_builder_options_build_add_multiple_option(uint8_t **dst_packet_data_pptr, uint8_t **src_pptr, uint16_t *src_len_ptr, sn_coap_option_numbers_e option);
+static uint8_t sn_coap_builder_options_get_option_part_count(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option);
+static uint16_t sn_coap_builder_options_get_option_part_length_from_whole_option_string(uint16_t query_len, uint8_t *query_ptr, uint8_t query_index, sn_coap_option_numbers_e option);
+static int16_t sn_coap_builder_options_get_option_part_position(uint16_t query_len, uint8_t *query_ptr, uint8_t query_index, sn_coap_option_numbers_e option);
+static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
+static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr, uint8_t block_option);
+
+/* * * * GLOBAL DECLARATIONS * * * */
+static uint16_t global_previous_option_number = 0; /* Previous Option number in CoAP message */
+
+/* * * * EXTERN VARIABLES * * * */
+#if SN_COAP_BLOCKWISE_MAX_PAYLOAD_SIZE
+extern uint16_t sn_coap_block_data_size; /* From sn_coap_protocol_ieft_draft_12.c */
+#endif
+
+sn_coap_hdr_s *sn_coap_build_response(struct coap_s *handle, sn_coap_hdr_s *coap_packet_ptr, uint8_t msg_code)
+{
+ sn_coap_hdr_s *coap_res_ptr;
+
+ if (!coap_packet_ptr || !handle) {
+ return NULL;
+ }
+
+ coap_res_ptr = handle->sn_coap_protocol_malloc(sizeof(sn_coap_hdr_s));
+ if (!coap_res_ptr) {
+ return NULL;
+ }
+
+ memset(coap_res_ptr, 0x00, sizeof(sn_coap_hdr_s));
+
+ if (coap_packet_ptr->msg_type == COAP_MSG_TYPE_CONFIRMABLE) {
+ coap_res_ptr->msg_type = COAP_MSG_TYPE_ACKNOWLEDGEMENT;
+ coap_res_ptr->msg_code = (sn_coap_msg_code_e)msg_code;
+ coap_res_ptr->msg_id = coap_packet_ptr->msg_id;
+ }
+
+ else if (coap_packet_ptr->msg_type == COAP_MSG_TYPE_NON_CONFIRMABLE) {
+ coap_res_ptr->msg_type = COAP_MSG_TYPE_NON_CONFIRMABLE;
+ coap_res_ptr->msg_code = (sn_coap_msg_code_e)msg_code;
+ /* msg_id needs to be set by the caller in this case */
+ }
+
+ else {
+ handle->sn_coap_protocol_free( coap_res_ptr );
+ return NULL;
+ }
+
+ if (coap_packet_ptr->token_ptr) {
+ coap_res_ptr->token_len = coap_packet_ptr->token_len;
+ coap_res_ptr->token_ptr = handle->sn_coap_protocol_malloc(coap_res_ptr->token_len);
+ if (!coap_res_ptr->token_ptr) {
+ handle->sn_coap_protocol_free(coap_res_ptr);
+ return NULL;
+ }
+ memcpy(coap_res_ptr->token_ptr, coap_packet_ptr->token_ptr, coap_res_ptr->token_len);
+ }
+ return coap_res_ptr;
+}
+
+int16_t sn_coap_builder(uint8_t *dst_packet_data_ptr, sn_coap_hdr_s *src_coap_msg_ptr)
+{
+ uint8_t *base_packet_data_ptr = NULL;
+
+ /* * * * Check given pointers * * * */
+ if (dst_packet_data_ptr == NULL || src_coap_msg_ptr == NULL) {
+ return -2;
+ }
+
+ /* Initialize given Packet data memory area with zero values */
+ uint16_t dst_byte_count_to_be_built = sn_coap_builder_calc_needed_packet_data_size(src_coap_msg_ptr);
+
+ if (!dst_byte_count_to_be_built) {
+ return -1;
+ }
+
+ memset(dst_packet_data_ptr, 0, dst_byte_count_to_be_built);
+
+ /* * * * Store base (= original) destination Packet data pointer for later usage * * * */
+ base_packet_data_ptr = dst_packet_data_ptr;
+
+ /* * * * * * * * * * * * * * * * * * */
+ /* * * * Header part building * * * */
+ /* * * * * * * * * * * * * * * * * * */
+ if (sn_coap_builder_header_build(&dst_packet_data_ptr, src_coap_msg_ptr) != 0) {
+ /* Header building failed */
+ return -1;
+ }
+
+ /* If else than Reset message because Reset message must be empty */
+ if (src_coap_msg_ptr->msg_type != COAP_MSG_TYPE_RESET) {
+ /* * * * * * * * * * * * * * * * * * */
+ /* * * * Options part building * * * */
+ /* * * * * * * * * * * * * * * * * * */
+ sn_coap_builder_options_build(&dst_packet_data_ptr, src_coap_msg_ptr);
+
+ /* * * * * * * * * * * * * * * * * * */
+ /* * * * Payload part building * * * */
+ /* * * * * * * * * * * * * * * * * * */
+ sn_coap_builder_payload_build(&dst_packet_data_ptr, src_coap_msg_ptr);
+ }
+
+ /* * * * Return built Packet data length * * * */
+ return (dst_packet_data_ptr - base_packet_data_ptr);
+}
+
+uint16_t sn_coap_builder_calc_needed_packet_data_size(sn_coap_hdr_s *src_coap_msg_ptr)
+{
+ uint16_t returned_byte_count = 0;
+
+ if (!src_coap_msg_ptr) {
+ return 0;
+ }
+
+ /* * * * * HEADER * * * * */
+
+ /* Header size is fixed */
+ returned_byte_count = COAP_HEADER_LENGTH;
+
+ /* * * * * OPTIONS * * * * */
+
+ /* If else than Reset message because Reset message must be empty */
+ if (src_coap_msg_ptr->msg_type != COAP_MSG_TYPE_RESET) {
+ uint16_t repeatable_option_size = 0;
+
+ /* TOKEN - Length is 1-8 bytes */
+ if (src_coap_msg_ptr->token_ptr != NULL) {
+ if (src_coap_msg_ptr->token_len > 8 || src_coap_msg_ptr->token_len < 1) { /* Check that option is not longer than defined */
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->token_len;
+ }
+
+ /* URI PATH - Repeatable option. Length of one option is 0-255 */
+ if (src_coap_msg_ptr->uri_path_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->uri_path_len,
+ src_coap_msg_ptr->uri_path_ptr, COAP_OPTION_URI_PATH);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* CONTENT TYPE - Length of this option is 0-2 bytes */
+ if (src_coap_msg_ptr->content_type_ptr != NULL) {
+ returned_byte_count++;
+ if (src_coap_msg_ptr->content_type_len > 2) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->content_type_len;
+ }
+
+ /* If options list pointer exists */
+ if (src_coap_msg_ptr->options_list_ptr != NULL) {
+ /* ACCEPT - Repeatable option. Length of this option is 0-2 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->accept_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->accept_len,
+ src_coap_msg_ptr->options_list_ptr->accept_ptr, COAP_OPTION_ACCEPT);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* MAX AGE - Length of this option is 0-4 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->max_age_ptr != NULL) {
+ returned_byte_count++;
+ if (src_coap_msg_ptr->options_list_ptr->max_age_len > 4) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->max_age_len;
+ }
+
+ /* PROXY URI - Length of this option is 1-1034 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr != NULL) {
+ if (src_coap_msg_ptr->options_list_ptr->proxy_uri_len >= 1 && src_coap_msg_ptr->options_list_ptr->proxy_uri_len <= 12) { /* Add option header byte(s) - depending of option length */
+ returned_byte_count++;
+ }
+
+ else if (src_coap_msg_ptr->options_list_ptr->proxy_uri_len >= 13 && src_coap_msg_ptr->options_list_ptr->proxy_uri_len <= 269) {
+ returned_byte_count += 2;
+ }
+
+ else if (src_coap_msg_ptr->options_list_ptr->proxy_uri_len >= 270 && src_coap_msg_ptr->options_list_ptr->proxy_uri_len <= 1034) {
+ returned_byte_count += 3;
+ }
+
+ else {
+ return 0;
+ }
+
+ /* Add needed memory for Option value */
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->proxy_uri_len;
+ }
+
+ /* ETAG - Repeatable option. Length of this option is 1-8 bytes*/
+ if (src_coap_msg_ptr->options_list_ptr->etag_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->etag_len,
+ src_coap_msg_ptr->options_list_ptr->etag_ptr, COAP_OPTION_ETAG);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* URI HOST - Length of this option is 1-255 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->uri_host_ptr != NULL) {
+ if (src_coap_msg_ptr->options_list_ptr->uri_host_len > 0 && src_coap_msg_ptr->options_list_ptr->uri_host_len <= 12) {
+ returned_byte_count++;
+ }
+
+ else if (src_coap_msg_ptr->options_list_ptr->uri_host_len >= 13 && src_coap_msg_ptr->options_list_ptr->uri_host_len <= 255) {
+ returned_byte_count += 2;
+ }
+
+ else {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->uri_host_len;
+ }
+
+ /* LOCATION PATH - Repeatable option. Length of this option is 0-255 bytes*/
+ if (src_coap_msg_ptr->options_list_ptr->location_path_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->location_path_len,
+ src_coap_msg_ptr->options_list_ptr->location_path_ptr, COAP_OPTION_LOCATION_PATH);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* URI PORT - Length of this option is 0-2 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->uri_port_ptr != NULL) {
+ returned_byte_count++;
+ if (src_coap_msg_ptr->options_list_ptr->uri_port_len > 2) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->uri_port_len;
+ }
+
+ /* lOCATION QUERY - Repeatable option. Length of this option is 0-255 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->location_query_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->location_query_len,
+ src_coap_msg_ptr->options_list_ptr->location_query_ptr, COAP_OPTION_LOCATION_QUERY);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* OBSERVE - Length of this option is 0-3 bytes */
+ if (src_coap_msg_ptr->options_list_ptr->observe_ptr != NULL) {
+ returned_byte_count++;
+ if (src_coap_msg_ptr->options_list_ptr->observe_len > 3) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->observe_len;
+ } else if (src_coap_msg_ptr->options_list_ptr->observe) {
+ returned_byte_count++;
+ }
+
+ /* URI QUERY - Repeatable option. Length of this option is 1-255 */
+ if (src_coap_msg_ptr->options_list_ptr->uri_query_ptr != NULL) {
+ repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->uri_query_len,
+ src_coap_msg_ptr->options_list_ptr->uri_query_ptr, COAP_OPTION_URI_QUERY);
+ if (repeatable_option_size) {
+ returned_byte_count += repeatable_option_size;
+ } else {
+ return 0;
+ }
+ }
+
+ /* BLOCK 1 - Length of this option is 1-3 bytes*/
+ if (src_coap_msg_ptr->options_list_ptr->block2_ptr != NULL) {
+ returned_byte_count++;
+ if (src_coap_msg_ptr->options_list_ptr->block2_len > 3 || src_coap_msg_ptr->options_list_ptr->block2_len < 1) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->block2_len;
+ }
+
+ /* BLOCK 2 - Length of this option is 1-3 bytes*/
+ if (src_coap_msg_ptr->options_list_ptr->block1_ptr != NULL) {
+ returned_byte_count++;
+
+ if (src_coap_msg_ptr->options_list_ptr->block1_len > 3 || src_coap_msg_ptr->options_list_ptr->block1_len < 1) {
+ return 0;
+ }
+
+ returned_byte_count += src_coap_msg_ptr->options_list_ptr->block1_len;
+ }
+ }
+
+ /* * * * * PAYLOAD * * * * */
+#if SN_COAP_BLOCKWISE_MAX_PAYLOAD_SIZE /* If Message blockwising is not used at all, this part of code will not be compiled */
+ if ((src_coap_msg_ptr->payload_len > sn_coap_block_data_size) && (sn_coap_block_data_size > 0)) {
+ /* Two bytes for Block option */
+ returned_byte_count += 2;
+
+ if (src_coap_msg_ptr->msg_code < COAP_MSG_CODE_RESPONSE_CREATED) {
+ returned_byte_count += sn_coap_builder_options_calculate_jump_need(src_coap_msg_ptr, 1);
+ } else { /* Response message */
+ returned_byte_count += sn_coap_builder_options_calculate_jump_need(src_coap_msg_ptr, 2);
+ }
+ /* Add maximum payload at one Blockwise message */
+ returned_byte_count += sn_coap_block_data_size;
+ returned_byte_count ++; /* For payload marker */
+ } else {
+ returned_byte_count += sn_coap_builder_options_calculate_jump_need(src_coap_msg_ptr, 0);
+ /* Add wanted payload */
+
+ returned_byte_count += src_coap_msg_ptr->payload_len;
+
+ if (src_coap_msg_ptr->payload_len) {
+ returned_byte_count ++; /* For payload marker */
+ }
+
+ }
+#else
+ returned_byte_count += src_coap_msg_ptr->payload_len;
+ if (src_coap_msg_ptr->payload_len) {
+ returned_byte_count ++; /* For payload marker */
+ }
+ returned_byte_count += sn_coap_builder_options_calculate_jump_need(src_coap_msg_ptr, 0);
+#endif
+ }
+
+ return returned_byte_count;
+}
+
+/**
+ * \fn static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr, uint8_t block_option)
+ *
+ * \brief Checks if there is need for option jump
+ *
+ * \param *src_coap_msg_ptr is source of checked CoAP message
+ *
+ * \param block option marks if block option is to be added to message later. 0 = no block option, 1 = block1 and 2 = block2
+ *
+ * \return Returns bytes needed for jumping
+ */
+
+static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr, uint8_t block_option)
+{
+ uint8_t previous_option_number = 0;
+ uint8_t needed_space = 0;
+
+ if (src_coap_msg_ptr->options_list_ptr != NULL) {
+ /* If option numbers greater than 12 is not used, then jumping is not needed */
+ if (!src_coap_msg_ptr->options_list_ptr->uri_query_ptr &&
+ !src_coap_msg_ptr->options_list_ptr->accept_ptr &&
+ !src_coap_msg_ptr->options_list_ptr->location_query_ptr &&
+ !src_coap_msg_ptr->options_list_ptr->block2_ptr &&
+ !src_coap_msg_ptr->options_list_ptr->block1_ptr &&
+ !src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr &&
+ !block_option &&
+ !src_coap_msg_ptr->options_list_ptr->max_age_ptr) {
+ return 0;
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr->uri_host_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_URI_HOST);
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr->etag_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_ETAG);
+ }
+
+ if ((src_coap_msg_ptr->options_list_ptr->observe_ptr != NULL) || (src_coap_msg_ptr->options_list_ptr->observe)) {
+ previous_option_number = (COAP_OPTION_OBSERVE);
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr->uri_port_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_URI_PORT);
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr->location_path_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_LOCATION_PATH);
+ }
+
+ if (src_coap_msg_ptr->uri_path_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_URI_PATH);
+ }
+ if (src_coap_msg_ptr->content_type_ptr != NULL) {
+ previous_option_number = (COAP_OPTION_CONTENT_FORMAT);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->max_age_ptr != NULL) {
+ if ((COAP_OPTION_MAX_AGE - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_MAX_AGE);
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr->uri_query_ptr != NULL) {
+ if ((COAP_OPTION_URI_QUERY - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_URI_QUERY);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->accept_ptr != NULL) {
+ if ((COAP_OPTION_ACCEPT - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_ACCEPT);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->location_query_ptr != NULL) {
+ if ((COAP_OPTION_LOCATION_QUERY - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_LOCATION_QUERY);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->block2_ptr != NULL) {
+ if ((COAP_OPTION_BLOCK2 - previous_option_number) > 12 || (block_option == 2 && (COAP_OPTION_BLOCK2 - previous_option_number) > 12)) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_BLOCK2);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->block1_ptr != NULL) {
+ if ((COAP_OPTION_BLOCK1 - previous_option_number) > 12 || (block_option == 1 && (COAP_OPTION_BLOCK1 - previous_option_number) > 12)) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_BLOCK1);
+ }
+ if (src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr != NULL) {
+ if ((COAP_OPTION_PROXY_URI - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ if ((COAP_OPTION_PROXY_URI - previous_option_number) > 269) { //Can not happen
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_PROXY_URI);
+ }
+ }
+
+ else {
+ if (src_coap_msg_ptr->uri_path_ptr != 0) {
+ previous_option_number = (COAP_OPTION_URI_PATH);
+ }
+
+ if (src_coap_msg_ptr->content_type_ptr != 0) {
+ previous_option_number = (COAP_OPTION_CONTENT_FORMAT);
+ }
+
+#if SN_COAP_BLOCKWISE_MAX_PAYLOAD_SIZE //block_option 1 & 2 only used if this maro is defined
+ if (block_option == 2) {
+ if ((COAP_OPTION_BLOCK2 - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_BLOCK2);
+ }
+ if (block_option == 1) {
+ if ((COAP_OPTION_BLOCK1 - previous_option_number) > 12) {
+ needed_space += 1;
+ }
+ previous_option_number = (COAP_OPTION_BLOCK1);
+ }
+#endif
+ }
+ return needed_space;
+}
+
+/**
+ * \fn static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+ *
+ * \brief Builds Header part of Packet data
+ *
+ * \param **dst_packet_data_pptr is destination for built Packet data
+ *
+ * \param *src_coap_msg_ptr is source for building Packet data
+ *
+ * \return Return value is 0 in ok case and -1 in failure case
+ **************************************************************************** */
+static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+{
+ /* * * * Check validity of Header values * * * */
+ if (sn_coap_header_validity_check(src_coap_msg_ptr, COAP_VERSION) != 0) {
+ return -1;
+ }
+
+ /* * * Add CoAP Version * * */
+ **dst_packet_data_pptr += COAP_VERSION;
+
+ /* * * Add Message type * * */
+ **dst_packet_data_pptr += src_coap_msg_ptr->msg_type;
+
+ /* * * Add Token length * * */
+ **dst_packet_data_pptr += (src_coap_msg_ptr->token_len);
+
+ (*dst_packet_data_pptr) ++;
+ /* * * Add Message code * * */
+ **dst_packet_data_pptr = src_coap_msg_ptr->msg_code;
+ (*dst_packet_data_pptr) ++;
+
+ /* * * Add Message ID * * */
+ **dst_packet_data_pptr = (uint8_t)(src_coap_msg_ptr->msg_id >> COAP_HEADER_MSG_ID_MSB_SHIFT); /* MSB part */
+ (*dst_packet_data_pptr) ++;
+ **dst_packet_data_pptr = (uint8_t)src_coap_msg_ptr->msg_id; /* LSB part */
+ (*dst_packet_data_pptr) ++;
+
+ /* Success */
+ return 0;
+}
+
+/**
+ * \fn static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+ *
+ * \brief Builds Options part of Packet data
+ *
+ * \param **dst_packet_data_pptr is destination for built Packet data
+ *
+ * \param *src_coap_msg_ptr is source for building Packet data
+ *
+ * \return Return value is 0 in every case
+ */
+static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+{
+ int16_t ret_status = 0;
+
+ /* * * * Check if Options are used at all * * * */
+ if (src_coap_msg_ptr->uri_path_ptr == NULL && src_coap_msg_ptr->token_ptr == NULL &&
+ src_coap_msg_ptr->content_type_ptr == NULL && src_coap_msg_ptr->options_list_ptr == NULL) {
+ return 0;
+ }
+
+ /* * * * First add Token option * * * */
+ if (src_coap_msg_ptr->token_len && src_coap_msg_ptr->token_ptr) {
+ memcpy(*dst_packet_data_pptr, src_coap_msg_ptr->token_ptr, src_coap_msg_ptr->token_len);
+ }
+ (*dst_packet_data_pptr) += src_coap_msg_ptr->token_len;
+
+ /* Then build rest of the options */
+
+ /* * * * Initialize previous Option number for new built message * * * */
+ global_previous_option_number = 0;
+
+ //missing: COAP_OPTION_IF_MATCH, COAP_OPTION_IF_NONE_MATCH, COAP_OPTION_SIZE
+
+ /* Check if less used options are used at all */
+ if (src_coap_msg_ptr->options_list_ptr != NULL) {
+ /* * * * Build Uri-Host option * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->uri_host_len,
+ src_coap_msg_ptr->options_list_ptr->uri_host_ptr, COAP_OPTION_URI_HOST);
+
+ /* * * * Build ETag option * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->etag_ptr,
+ (uint16_t *)&src_coap_msg_ptr->options_list_ptr->etag_len, COAP_OPTION_ETAG);
+
+ /* * * * Build Observe option * * * * */
+ ret_status = sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->observe_len,
+ src_coap_msg_ptr->options_list_ptr->observe_ptr, COAP_OPTION_OBSERVE);
+ if (ret_status == 0) {
+ sn_coap_builder_options_build_add_zero_length_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->observe_len, src_coap_msg_ptr->options_list_ptr->observe, COAP_OPTION_OBSERVE);
+ }
+
+ /* * * * Build Uri-Port option * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->uri_port_len,
+ src_coap_msg_ptr->options_list_ptr->uri_port_ptr, COAP_OPTION_URI_PORT);
+
+ /* * * * Build Location-Path option * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->location_path_ptr,
+ &src_coap_msg_ptr->options_list_ptr->location_path_len, COAP_OPTION_LOCATION_PATH);
+ }
+ /* * * * Build Uri-Path option * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->uri_path_ptr,
+ &src_coap_msg_ptr->uri_path_len, COAP_OPTION_URI_PATH);
+
+ /* * * * Build Content-Type option * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->content_type_len,
+ src_coap_msg_ptr->content_type_ptr, COAP_OPTION_CONTENT_FORMAT);
+
+ if (src_coap_msg_ptr->options_list_ptr != NULL) {
+ /* * * * Build Max-Age option * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->max_age_len,
+ src_coap_msg_ptr->options_list_ptr->max_age_ptr, COAP_OPTION_MAX_AGE);
+
+ /* * * * Build Uri-Query option * * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->uri_query_ptr,
+ &src_coap_msg_ptr->options_list_ptr->uri_query_len, COAP_OPTION_URI_QUERY);
+
+ /* * * * Build Accept option * * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->accept_ptr,
+ (uint16_t *)&src_coap_msg_ptr->options_list_ptr->accept_len, COAP_OPTION_ACCEPT);
+ }
+
+ if (src_coap_msg_ptr->options_list_ptr != NULL) {
+ /* * * * Build Location-Query option * * * */
+ sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->location_query_ptr,
+ &src_coap_msg_ptr->options_list_ptr->location_query_len, COAP_OPTION_LOCATION_QUERY);
+
+ /* * * * Build Block2 option * * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->block2_len,
+ src_coap_msg_ptr->options_list_ptr->block2_ptr, COAP_OPTION_BLOCK2);
+
+ /* * * * Build Block1 option * * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->block1_len,
+ src_coap_msg_ptr->options_list_ptr->block1_ptr, COAP_OPTION_BLOCK1);
+
+ /* * * * Build Proxy-Uri option * * * */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->proxy_uri_len,
+ src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr, COAP_OPTION_PROXY_URI);
+ }
+
+ /* Success */
+ return 0;
+}
+
+/**
+ * \fn static int16_t sn_coap_builder_options_build_add_one_option(uint8_t **dst_packet_data_pptr, uint16_t option_value_len, uint8_t *option_value_ptr, sn_coap_option_numbers_e option_number)
+ *
+ * \brief Adds Options part of Packet data
+ *
+ * \param **dst_packet_data_pptr is destination for built Packet data
+ *
+ * \param option_value_len is Option value length to be added
+ *
+ * \param *option_value_ptr is pointer to Option value data to be added
+ *
+ * \param option_number is Option number to be added
+ *
+ * \return Return value is 0 if option was not added, 1 if added
+ */
+static int16_t sn_coap_builder_options_build_add_one_option(uint8_t **dst_packet_data_pptr, uint16_t option_len,
+ uint8_t *option_ptr, sn_coap_option_numbers_e option_number)
+{
+ /* Check if there is option at all */
+ if (option_ptr != NULL) {
+ uint16_t option_delta;
+
+ option_delta = (option_number - global_previous_option_number);
+
+ /* * * Build option header * * */
+
+ /* First option length without extended part */
+ if (option_len <= 12) {
+ **dst_packet_data_pptr = option_len;
+ }
+
+ else if (option_len > 12 && option_len < 269) {
+ **dst_packet_data_pptr = 0x0D;
+ }
+
+ else if (option_len >= 269) {
+ **dst_packet_data_pptr = 0x0E;
+ }
+
+ /* Then option delta with extensions, and move pointer */
+ if (option_delta <= 12) {
+ **dst_packet_data_pptr += (option_delta << 4);
+ *dst_packet_data_pptr += 1;
+ }
+
+ else if (option_delta > 12 && option_delta < 269) {
+ **dst_packet_data_pptr += 0xD0;
+ option_delta -= 13;
+
+ *(*dst_packet_data_pptr + 1) = (uint8_t)option_delta;
+ *dst_packet_data_pptr += 2;
+ }
+ //This is currently dead code (but possibly needed in future)
+ else if (option_delta >= 269) {
+ **dst_packet_data_pptr += 0xE0;
+ option_delta -= 269;
+
+ *(*dst_packet_data_pptr + 2) = (uint8_t)option_delta;
+ *(*dst_packet_data_pptr + 1) = (option_delta >> 8);
+ *dst_packet_data_pptr += 3;
+ }
+
+ /* Now option length extensions, if needed */
+ if (option_len > 12 && option_len < 269) {
+ **dst_packet_data_pptr = (uint8_t)(option_len - 13);
+ *dst_packet_data_pptr += 1;
+ }
+
+ else if (option_len >= 269) {
+ *(*dst_packet_data_pptr + 1) = (uint8_t)(option_len - 269);
+ **dst_packet_data_pptr = ((option_len - 269) >> 8);
+ *dst_packet_data_pptr += 2;
+ }
+
+ global_previous_option_number = option_number;
+
+ /* Write Option value */
+ memcpy(*dst_packet_data_pptr, option_ptr, option_len);
+
+ /* Increase destination Packet data pointer */
+ (*dst_packet_data_pptr) += option_len;
+
+ return 1;
+ }
+
+ /* Success */
+ return 0;
+}
+
+/*
+ * @return 1 if was added 0 otherwise
+*/
+int16_t sn_coap_builder_options_build_add_zero_length_option(uint8_t **dst_packet_data_pptr, uint8_t option_length, uint8_t option_exist, sn_coap_option_numbers_e option_number)
+{
+ if ((option_exist != 0) && (option_length == 0)) {
+ uint16_t option_delta;
+
+ option_delta = (option_number - global_previous_option_number);
+
+ /* * * Build option header * * */
+
+ /* First option length without extended part */
+ **dst_packet_data_pptr = 0;
+
+ /* Then option delta with extensions, and move pointer */
+ if (option_delta <= 12) {
+ **dst_packet_data_pptr += (option_delta << 4);
+ *dst_packet_data_pptr += 1;
+ }
+ //Cannot happen currently -->
+ else if (option_delta > 12 && option_delta < 269) {
+ **dst_packet_data_pptr += 0xD0;
+ option_delta -= 13;
+
+ *(*dst_packet_data_pptr + 1) = (uint8_t)option_delta;
+ *dst_packet_data_pptr += 2;
+ }
+
+ else if (option_delta >= 269) {
+ **dst_packet_data_pptr += 0xE0;
+ option_delta -= 269;
+
+ *(*dst_packet_data_pptr + 2) = (uint8_t)option_delta;
+ *(*dst_packet_data_pptr + 1) = (option_delta >> 8);
+ *dst_packet_data_pptr += 3;
+ }
+ //<-- Cannot happen currently
+
+ global_previous_option_number = option_number;
+
+ return 1;
+ }
+ return 0;
+}
+
+/**
+ * \fn static int16_t sn_coap_builder_options_build_add_multiple_option(uint8_t **dst_packet_data_pptr, uint8_t **src_pptr, uint16_t *src_len_ptr, sn_coap_option_numbers_e option)
+ *
+ * \brief Builds Option Uri-Query from given CoAP Header structure to Packet data
+ *
+ * \param **dst_packet_data_pptr is destination for built Packet data
+ *
+ * \param uint8_t **src_pptr
+ *
+ * \param uint16_t *src_len_ptr
+ *
+ * \paramsn_coap_option_numbers_e option option to be added
+ *
+ * \return Return value is 0 always
+ */
+static int16_t sn_coap_builder_options_build_add_multiple_option(uint8_t **dst_packet_data_pptr, uint8_t **src_pptr, uint16_t *src_len_ptr, sn_coap_option_numbers_e option)
+{
+ /* Check if there is option at all */
+ if (*src_pptr != NULL) {
+ uint8_t *query_ptr = *src_pptr;
+ uint8_t query_part_count = 0;
+ uint16_t query_len = *src_len_ptr;
+ uint8_t i = 0;
+ uint16_t query_part_offset = 0;
+
+ /* Get query part count */
+ query_part_count = sn_coap_builder_options_get_option_part_count(query_len, query_ptr, option);
+
+ /* * * * Options by adding all parts to option * * * */
+ for (i = 0; i < query_part_count; i++) {
+ /* Get length of query part */
+ uint16_t one_query_part_len = sn_coap_builder_options_get_option_part_length_from_whole_option_string(query_len, query_ptr, i, option);
+
+ /* Get position of query part */
+ query_part_offset = sn_coap_builder_options_get_option_part_position(query_len, query_ptr, i, option);
+
+ /* Add Uri-query's one part to Options */
+ sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, one_query_part_len, *src_pptr + query_part_offset, option);
+ }
+ }
+ /* Success */
+ return 0;
+}
+
+
+/**
+ * \fn static uint16_t sn_coap_builder_options_calc_option_size(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option)
+ *
+ * \brief Calculates needed Packet data memory size for option
+ *
+ * \param path_len is length of calculated strting(s)
+ *
+ * \param *path_ptr is pointer to calculated options
+ *
+ * \return Return value is count of needed memory as bytes for Uri-query option
+ */
+static uint16_t sn_coap_builder_options_calc_option_size(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option)
+{
+ uint8_t query_part_count = sn_coap_builder_options_get_option_part_count(query_len, query_ptr, option);
+ uint8_t i = 0;
+ uint16_t ret_value = 0;
+
+ /* * * * * * * * * * * * * * * * * * * * * * * * */
+ /* * * * Calculate Uri-query options length * * */
+ /* * * * * * * * * * * * * * * * * * * * * * * * */
+ for (i = 0; i < query_part_count; i++) {
+ /* * * Length of Option number and Option value length * * */
+
+ /* Get length of Query part */
+ uint16_t one_query_part_len = sn_coap_builder_options_get_option_part_length_from_whole_option_string(query_len, query_ptr, i, option);
+
+ /* Check option length */
+ switch (option) {
+ case (COAP_OPTION_ETAG): /* Length 1-8 */
+ if (one_query_part_len < 1 || one_query_part_len > 8) {
+ return 0;
+ }
+ break;
+ case (COAP_OPTION_LOCATION_PATH): /* Length 0-255 */
+ case (COAP_OPTION_URI_PATH): /* Length 0-255 */
+ case (COAP_OPTION_LOCATION_QUERY): /* Length 0-255 */
+ if (one_query_part_len > 255) {
+ return 0;
+ }
+ break;
+ case (COAP_OPTION_URI_QUERY): /* Length 1-255 */
+ if (one_query_part_len < 1 || one_query_part_len > 255) {
+ return 0;
+ }
+ break;
+ case (COAP_OPTION_ACCEPT): /* Length 0-2 */
+ if (one_query_part_len > 2) {
+ return 0;
+ }
+ break;
+ default:
+ break; //impossible scenario currently
+ }
+
+ /* Check if 4 bits are enough for writing Option value length */
+ if (one_query_part_len <= 12) {
+ /* 4 bits are enough for Option value length */
+ ret_value++;
+ } else if (one_query_part_len >= 13 && one_query_part_len < 269) {
+ /* Extra byte for Option value length is needed */
+ ret_value += 2;
+ }
+ //This can only happen if we are in default case above, currently is not happening
+ else if (one_query_part_len >= 270 && one_query_part_len < 1034) {
+ /* Extra bytes for Option value length is needed */
+ ret_value += 3;
+ }
+
+
+ /* * * Length of Option value * * */
+
+ /* Increase options length */
+ ret_value += one_query_part_len;
+ }
+
+ /* Success */
+ return ret_value;
+}
+
+
+
+/**
+ * \fn static uint8_t sn_coap_builder_options_get_option_part_count(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option)
+ *
+ * \brief Gets query part count from whole option string
+ *
+ * \param query_len is length of whole Path
+ *
+ * \param *query_ptr is pointer to the start of whole Path
+ *
+ * \return Return value is count of query parts
+ */
+static uint8_t sn_coap_builder_options_get_option_part_count(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option)
+{
+ uint8_t returned_query_count = 0;
+ uint16_t query_len_index = 0;
+ uint8_t char_to_search = '&';
+
+ if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
+ char_to_search = '/';
+ }
+
+ /* Loop whole query and search '\0' characters (not first and last char) */
+ for (query_len_index = 1; query_len_index < query_len - 1; query_len_index++) {
+ /* If new query part starts */
+ if (*(query_ptr + query_len_index) == char_to_search) { /* If match */
+ returned_query_count++;
+ }
+ }
+
+ returned_query_count++;
+
+ return returned_query_count;
+}
+
+/**
+ * \fn static uint16_t sn_coap_builder_options_get_option_part_length_from_whole_option_string(uint16_t query_len,
+ uint8_t *query_ptr,
+ uint8_t query_index, sn_coap_option_numbers_e option)
+ *
+ * \brief Gets one's query part length from whole query string
+ *
+ * \param query_len is length of whole string
+ *
+ * \param *query_ptr is pointer to the start of whole string
+ *
+ * \param query_index is query part index to be found
+ *
+ * \param sn_coap_option_numbers_e option is option number of the option
+ *
+ * \return Return value is length of query part
+ */
+static uint16_t sn_coap_builder_options_get_option_part_length_from_whole_option_string(uint16_t query_len, uint8_t *query_ptr,
+ uint8_t query_index, sn_coap_option_numbers_e option)
+{
+ uint16_t returned_query_part_len = 0;
+ uint8_t temp_query_index = 0;
+ uint16_t query_len_index = 0;
+ uint8_t char_to_search = '&';
+
+ if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
+ char_to_search = '/';
+ }
+
+ /* Loop whole query and search '\0' characters */
+ for (query_len_index = 0; query_len_index < query_len; query_len_index++) {
+ /* Store character to temp_char for helping debugging */
+ uint8_t temp_char = *query_ptr;
+
+ /* If new query part starts */
+ if (temp_char == char_to_search && returned_query_part_len > 0) { /* returned_query_part_len > 0 is for querys which start with "\0" */
+ /* If query part index is wanted */
+ if (temp_query_index == query_index) {
+ /* Return length of query part */
+ return returned_query_part_len;
+ } else {
+ /* Reset length of query part because wanted query part finding continues*/
+ returned_query_part_len = 0;
+ }
+
+ /* Next query part is looped */
+ temp_query_index++;
+ } else if (temp_char != char_to_search) { /* Else if query part continues */
+ /* Increase query part length */
+ returned_query_part_len++;
+ }
+
+ query_ptr++;
+ }
+
+ /* Return length of query part in cases that query part does not finish to '\0' character (last query part can be like that) */
+ return returned_query_part_len;
+}
+
+/**
+ * \fn static uint16_t sn_coap_builder_options_get_option_part_position(uint16_t query_len,
+ uint8_t *query_ptr,
+ uint8_t query_index, sn_coap_option_numbers_e option)
+ *
+ * \brief Gets query part position in whole query
+ *
+ * \param query_len is length of whole query
+ *
+ * \param *query_ptr is pointer to the start of whole query
+ *
+ * \param query_index is query part index to be found
+ *
+ * \return Return value is position (= offset) of query part in whole query. In
+ * fail cases -1 is returned.
+ */
+static int16_t sn_coap_builder_options_get_option_part_position(uint16_t query_len, uint8_t *query_ptr,
+ uint8_t query_index, sn_coap_option_numbers_e option)
+{
+ uint16_t returned_query_part_offset = 0;
+ uint8_t temp_query_index = 0;
+ uint16_t query_len_index = 0;
+ uint8_t char_to_search = '&';
+
+ if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
+ char_to_search = '/';
+ }
+
+ if (query_index == 0) {
+ if (*query_ptr == 0 || *query_ptr == char_to_search) {
+ return 1;
+ } else {
+ return 0;
+ }
+ }
+
+ /* Loop whole query and search separator characters */
+ for (query_len_index = 0; query_len_index < query_len; query_len_index++) {
+ /* Store character to temp_char for helping debugging */
+ uint8_t temp_char = *query_ptr;
+
+ /* If new query part starts */
+ if (temp_char == char_to_search && returned_query_part_offset > 0) { /* returned_query_part_offset > 0 is for querys which start with searched char */
+ /* If query part index is wanted */
+ if (temp_query_index == (query_index - 1)) {
+ /* Return offset of query part */
+ return (returned_query_part_offset + 1); /* Plus one is for passing separator */
+ }
+
+ /* Next query part is looped */
+ temp_query_index++;
+ }
+
+ returned_query_part_offset++;
+
+ query_ptr++;
+ }
+
+ return -1; //Dead code?
+}
+
+
+/**
+ * \fn static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+ *
+ * \brief Builds Options part of Packet data
+ *
+ * \param **dst_packet_data_pptr is destination for built Packet data
+ *
+ * \param *src_coap_msg_ptr is source for building Packet data
+ */
+static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
+{
+ /* Check if Payload is used at all */
+ if (src_coap_msg_ptr->payload_ptr != NULL) {
+ /* Write Payload marker */
+
+ **dst_packet_data_pptr = 0xff;
+ (*dst_packet_data_pptr)++;
+
+ /* Write Payload */
+ memcpy(*dst_packet_data_pptr, src_coap_msg_ptr->payload_ptr, src_coap_msg_ptr->payload_len);
+
+ /* Increase destination Packet data pointer */
+ (*dst_packet_data_pptr) += src_coap_msg_ptr->payload_len;
+ }
+}
+