Kev Mann / mbed-dev-OS5_10_4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

features/frameworks/mbed-coap/source/sn_coap_builder.c@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /*
kevman 0:38ceb79fef03 2 * Copyright (c) 2011-2015 ARM Limited. All rights reserved.
kevman 0:38ceb79fef03 3 * SPDX-License-Identifier: Apache-2.0
kevman 0:38ceb79fef03 4 * Licensed under the Apache License, Version 2.0 (the License); you may
kevman 0:38ceb79fef03 5 * not use this file except in compliance with the License.
kevman 0:38ceb79fef03 6 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 7 *
kevman 0:38ceb79fef03 8 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 9 *
kevman 0:38ceb79fef03 10 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
kevman 0:38ceb79fef03 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 13 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 14 * limitations under the License.
kevman 0:38ceb79fef03 15 */
kevman 0:38ceb79fef03 16
kevman 0:38ceb79fef03 17 /**
kevman 0:38ceb79fef03 18 * \file sn_coap_builder.c
kevman 0:38ceb79fef03 19 *
kevman 0:38ceb79fef03 20 * \brief CoAP Message builder
kevman 0:38ceb79fef03 21 *
kevman 0:38ceb79fef03 22 * Functionality: Builds CoAP message
kevman 0:38ceb79fef03 23 *
kevman 0:38ceb79fef03 24 */
kevman 0:38ceb79fef03 25
kevman 0:38ceb79fef03 26 /* * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 27 /* * * * INCLUDE FILES * * * */
kevman 0:38ceb79fef03 28 /* * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 29
kevman 0:38ceb79fef03 30 #include <string.h> /* For memset() and memcpy() */
kevman 0:38ceb79fef03 31
kevman 0:38ceb79fef03 32 #include "ns_types.h"
kevman 0:38ceb79fef03 33 #include "mbed-coap/sn_coap_header.h"
kevman 0:38ceb79fef03 34 #include "sn_coap_header_internal.h"
kevman 0:38ceb79fef03 35 #include "sn_coap_protocol_internal.h"
kevman 0:38ceb79fef03 36 #include "mbed-trace/mbed_trace.h"
kevman 0:38ceb79fef03 37
kevman 0:38ceb79fef03 38 #define TRACE_GROUP "coap"
kevman 0:38ceb79fef03 39 /* * * * LOCAL FUNCTION PROTOTYPES * * * */
kevman 0:38ceb79fef03 40 static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
kevman 0:38ceb79fef03 41 static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
kevman 0:38ceb79fef03 42 static uint16_t sn_coap_builder_options_calc_option_size(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option);
kevman 0:38ceb79fef03 43 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, uint16_t *previous_option_number);
kevman 0:38ceb79fef03 44 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, uint16_t *previous_option_number);
kevman 0:38ceb79fef03 45 static uint8_t sn_coap_builder_options_build_add_uint_option(uint8_t **dst_packet_data_pptr, uint32_t value, sn_coap_option_numbers_e option_number, uint16_t *previous_option_number);
kevman 0:38ceb79fef03 46 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);
kevman 0:38ceb79fef03 47 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);
kevman 0:38ceb79fef03 48 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);
kevman 0:38ceb79fef03 49 static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr);
kevman 0:38ceb79fef03 50 static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr/*, uint8_t block_option*/);
kevman 0:38ceb79fef03 51
kevman 0:38ceb79fef03 52 sn_coap_hdr_s *sn_coap_build_response(struct coap_s *handle, sn_coap_hdr_s *coap_packet_ptr, uint8_t msg_code)
kevman 0:38ceb79fef03 53 {
kevman 0:38ceb79fef03 54 sn_coap_hdr_s *coap_res_ptr;
kevman 0:38ceb79fef03 55
kevman 0:38ceb79fef03 56 if (!coap_packet_ptr || !handle) {
kevman 0:38ceb79fef03 57 return NULL;
kevman 0:38ceb79fef03 58 }
kevman 0:38ceb79fef03 59
kevman 0:38ceb79fef03 60 coap_res_ptr = sn_coap_parser_alloc_message(handle);
kevman 0:38ceb79fef03 61 if (!coap_res_ptr) {
kevman 0:38ceb79fef03 62 tr_error("sn_coap_build_response - failed to allocate message!");
kevman 0:38ceb79fef03 63 return NULL;
kevman 0:38ceb79fef03 64 }
kevman 0:38ceb79fef03 65
kevman 0:38ceb79fef03 66 if (msg_code == COAP_MSG_CODE_REQUEST_GET) {
kevman 0:38ceb79fef03 67 // Blockwise message response is new GET
kevman 0:38ceb79fef03 68 coap_res_ptr->msg_type = COAP_MSG_TYPE_CONFIRMABLE;
kevman 0:38ceb79fef03 69 coap_res_ptr->msg_code = (sn_coap_msg_code_e)msg_code;
kevman 0:38ceb79fef03 70 /* msg_id needs to be set by the caller in this case */
kevman 0:38ceb79fef03 71 }
kevman 0:38ceb79fef03 72 else if (coap_packet_ptr->msg_type == COAP_MSG_TYPE_CONFIRMABLE) {
kevman 0:38ceb79fef03 73 coap_res_ptr->msg_type = COAP_MSG_TYPE_ACKNOWLEDGEMENT;
kevman 0:38ceb79fef03 74 coap_res_ptr->msg_code = (sn_coap_msg_code_e)msg_code;
kevman 0:38ceb79fef03 75 coap_res_ptr->msg_id = coap_packet_ptr->msg_id;
kevman 0:38ceb79fef03 76 }
kevman 0:38ceb79fef03 77 else if (coap_packet_ptr->msg_type == COAP_MSG_TYPE_NON_CONFIRMABLE) {
kevman 0:38ceb79fef03 78 coap_res_ptr->msg_type = COAP_MSG_TYPE_NON_CONFIRMABLE;
kevman 0:38ceb79fef03 79 coap_res_ptr->msg_code = (sn_coap_msg_code_e)msg_code;
kevman 0:38ceb79fef03 80 /* msg_id needs to be set by the caller in this case */
kevman 0:38ceb79fef03 81 }
kevman 0:38ceb79fef03 82 else {
kevman 0:38ceb79fef03 83 handle->sn_coap_protocol_free( coap_res_ptr );
kevman 0:38ceb79fef03 84 return NULL;
kevman 0:38ceb79fef03 85 }
kevman 0:38ceb79fef03 86
kevman 0:38ceb79fef03 87 if (coap_packet_ptr->token_ptr) {
kevman 0:38ceb79fef03 88 coap_res_ptr->token_len = coap_packet_ptr->token_len;
kevman 0:38ceb79fef03 89 coap_res_ptr->token_ptr = handle->sn_coap_protocol_malloc(coap_res_ptr->token_len);
kevman 0:38ceb79fef03 90 if (!coap_res_ptr->token_ptr) {
kevman 0:38ceb79fef03 91 tr_error("sn_coap_build_response - failed to allocate token!");
kevman 0:38ceb79fef03 92 handle->sn_coap_protocol_free(coap_res_ptr);
kevman 0:38ceb79fef03 93 return NULL;
kevman 0:38ceb79fef03 94 }
kevman 0:38ceb79fef03 95 memcpy(coap_res_ptr->token_ptr, coap_packet_ptr->token_ptr, coap_res_ptr->token_len);
kevman 0:38ceb79fef03 96 }
kevman 0:38ceb79fef03 97 return coap_res_ptr;
kevman 0:38ceb79fef03 98 }
kevman 0:38ceb79fef03 99
kevman 0:38ceb79fef03 100 int16_t sn_coap_builder(uint8_t *dst_packet_data_ptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 101 {
kevman 0:38ceb79fef03 102 return sn_coap_builder_2(dst_packet_data_ptr, src_coap_msg_ptr, SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE);
kevman 0:38ceb79fef03 103 }
kevman 0:38ceb79fef03 104
kevman 0:38ceb79fef03 105 int16_t sn_coap_builder_2(uint8_t *dst_packet_data_ptr, sn_coap_hdr_s *src_coap_msg_ptr, uint16_t blockwise_payload_size)
kevman 0:38ceb79fef03 106 {
kevman 0:38ceb79fef03 107 uint8_t *base_packet_data_ptr = NULL;
kevman 0:38ceb79fef03 108
kevman 0:38ceb79fef03 109 /* * * * Check given pointers * * * */
kevman 0:38ceb79fef03 110 if (dst_packet_data_ptr == NULL || src_coap_msg_ptr == NULL) {
kevman 0:38ceb79fef03 111 return -2;
kevman 0:38ceb79fef03 112 }
kevman 0:38ceb79fef03 113
kevman 0:38ceb79fef03 114 /* Initialize given Packet data memory area with zero values */
kevman 0:38ceb79fef03 115 uint16_t dst_byte_count_to_be_built = sn_coap_builder_calc_needed_packet_data_size_2(src_coap_msg_ptr, blockwise_payload_size);
kevman 0:38ceb79fef03 116 if (!dst_byte_count_to_be_built) {
kevman 0:38ceb79fef03 117 tr_error("sn_coap_builder_2 - failed to allocate message!");
kevman 0:38ceb79fef03 118 return -1;
kevman 0:38ceb79fef03 119 }
kevman 0:38ceb79fef03 120
kevman 0:38ceb79fef03 121 memset(dst_packet_data_ptr, 0, dst_byte_count_to_be_built);
kevman 0:38ceb79fef03 122
kevman 0:38ceb79fef03 123 /* * * * Store base (= original) destination Packet data pointer for later usage * * * */
kevman 0:38ceb79fef03 124 base_packet_data_ptr = dst_packet_data_ptr;
kevman 0:38ceb79fef03 125
kevman 0:38ceb79fef03 126 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 127 /* * * * Header part building * * * */
kevman 0:38ceb79fef03 128 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 129 if (sn_coap_builder_header_build(&dst_packet_data_ptr, src_coap_msg_ptr) != 0) {
kevman 0:38ceb79fef03 130 /* Header building failed */
kevman 0:38ceb79fef03 131 tr_error("sn_coap_builder_2 - header building failed!");
kevman 0:38ceb79fef03 132 return -1;
kevman 0:38ceb79fef03 133 }
kevman 0:38ceb79fef03 134
kevman 0:38ceb79fef03 135 /* If else than Reset message because Reset message must be empty */
kevman 0:38ceb79fef03 136 if (src_coap_msg_ptr->msg_type != COAP_MSG_TYPE_RESET) {
kevman 0:38ceb79fef03 137 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 138 /* * * * Options part building * * * */
kevman 0:38ceb79fef03 139 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 140 sn_coap_builder_options_build(&dst_packet_data_ptr, src_coap_msg_ptr);
kevman 0:38ceb79fef03 141
kevman 0:38ceb79fef03 142 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 143 /* * * * Payload part building * * * */
kevman 0:38ceb79fef03 144 /* * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 145 sn_coap_builder_payload_build(&dst_packet_data_ptr, src_coap_msg_ptr);
kevman 0:38ceb79fef03 146 }
kevman 0:38ceb79fef03 147 /* * * * Return built Packet data length * * * */
kevman 0:38ceb79fef03 148 return (dst_packet_data_ptr - base_packet_data_ptr);
kevman 0:38ceb79fef03 149 }
kevman 0:38ceb79fef03 150 uint16_t sn_coap_builder_calc_needed_packet_data_size(sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 151 {
kevman 0:38ceb79fef03 152 return sn_coap_builder_calc_needed_packet_data_size_2(src_coap_msg_ptr, SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE);
kevman 0:38ceb79fef03 153 }
kevman 0:38ceb79fef03 154
kevman 0:38ceb79fef03 155 uint16_t sn_coap_builder_calc_needed_packet_data_size_2(sn_coap_hdr_s *src_coap_msg_ptr, uint16_t blockwise_payload_size)
kevman 0:38ceb79fef03 156 {
kevman 0:38ceb79fef03 157 (void)blockwise_payload_size;
kevman 0:38ceb79fef03 158 uint16_t returned_byte_count = 0;
kevman 0:38ceb79fef03 159
kevman 0:38ceb79fef03 160 if (!src_coap_msg_ptr) {
kevman 0:38ceb79fef03 161 return 0;
kevman 0:38ceb79fef03 162 }
kevman 0:38ceb79fef03 163 /* * * * * HEADER * * * * */
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 /* Header size is fixed */
kevman 0:38ceb79fef03 166 returned_byte_count = COAP_HEADER_LENGTH;
kevman 0:38ceb79fef03 167
kevman 0:38ceb79fef03 168 /* * * * * OPTIONS * * * * */
kevman 0:38ceb79fef03 169
kevman 0:38ceb79fef03 170 /* If else than Reset message because Reset message must be empty */
kevman 0:38ceb79fef03 171 if (src_coap_msg_ptr->msg_type != COAP_MSG_TYPE_RESET) {
kevman 0:38ceb79fef03 172 uint16_t repeatable_option_size = 0;
kevman 0:38ceb79fef03 173 /* TOKEN - Length is 1-8 bytes */
kevman 0:38ceb79fef03 174 if (src_coap_msg_ptr->token_ptr != NULL) {
kevman 0:38ceb79fef03 175 if (src_coap_msg_ptr->token_len > 8 || src_coap_msg_ptr->token_len < 1) { /* Check that option is not longer than defined */
kevman 0:38ceb79fef03 176 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - token too large!");
kevman 0:38ceb79fef03 177 return 0;
kevman 0:38ceb79fef03 178 }
kevman 0:38ceb79fef03 179
kevman 0:38ceb79fef03 180 returned_byte_count += src_coap_msg_ptr->token_len;
kevman 0:38ceb79fef03 181 }
kevman 0:38ceb79fef03 182 /* URI PATH - Repeatable option. Length of one option is 0-255 */
kevman 0:38ceb79fef03 183 if (src_coap_msg_ptr->uri_path_ptr != NULL) {
kevman 0:38ceb79fef03 184 repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->uri_path_len,
kevman 0:38ceb79fef03 185 src_coap_msg_ptr->uri_path_ptr, COAP_OPTION_URI_PATH);
kevman 0:38ceb79fef03 186 if (repeatable_option_size) {
kevman 0:38ceb79fef03 187 returned_byte_count += repeatable_option_size;
kevman 0:38ceb79fef03 188 } else {
kevman 0:38ceb79fef03 189 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - uri path size failed!");
kevman 0:38ceb79fef03 190 return 0;
kevman 0:38ceb79fef03 191 }
kevman 0:38ceb79fef03 192 }
kevman 0:38ceb79fef03 193
kevman 0:38ceb79fef03 194 uint16_t tempInt = 0;
kevman 0:38ceb79fef03 195 /* CONTENT FORMAT - An integer option, up to 2 bytes */
kevman 0:38ceb79fef03 196 if (src_coap_msg_ptr->content_format != COAP_CT_NONE) {
kevman 0:38ceb79fef03 197 if ((uint32_t) src_coap_msg_ptr->content_format > 0xffff) {
kevman 0:38ceb79fef03 198 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - content format too large!");
kevman 0:38ceb79fef03 199 return 0;
kevman 0:38ceb79fef03 200 }
kevman 0:38ceb79fef03 201
kevman 0:38ceb79fef03 202 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->content_format, COAP_OPTION_CONTENT_FORMAT, &tempInt);
kevman 0:38ceb79fef03 203 }
kevman 0:38ceb79fef03 204 /* If options list pointer exists */
kevman 0:38ceb79fef03 205 if (src_coap_msg_ptr->options_list_ptr != NULL) {
kevman 0:38ceb79fef03 206 /* ACCEPT - An integer option, up to 2 bytes */
kevman 0:38ceb79fef03 207 if (src_coap_msg_ptr->options_list_ptr->accept != COAP_CT_NONE) {
kevman 0:38ceb79fef03 208 if ((uint32_t) src_coap_msg_ptr->options_list_ptr->accept > 0xffff) {
kevman 0:38ceb79fef03 209 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - accept too large!");
kevman 0:38ceb79fef03 210 return 0;
kevman 0:38ceb79fef03 211 }
kevman 0:38ceb79fef03 212
kevman 0:38ceb79fef03 213 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->accept, COAP_OPTION_ACCEPT, &tempInt);
kevman 0:38ceb79fef03 214 }
kevman 0:38ceb79fef03 215 /* MAX AGE - An integer option, omitted for default. Up to 4 bytes */
kevman 0:38ceb79fef03 216 if (src_coap_msg_ptr->options_list_ptr->max_age != COAP_OPTION_MAX_AGE_DEFAULT) {
kevman 0:38ceb79fef03 217 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->max_age, COAP_OPTION_MAX_AGE, &tempInt);
kevman 0:38ceb79fef03 218 }
kevman 0:38ceb79fef03 219 /* PROXY URI - Length of this option is 1-1034 bytes */
kevman 0:38ceb79fef03 220 if (src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr != NULL) {
kevman 0:38ceb79fef03 221 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 */
kevman 0:38ceb79fef03 222 returned_byte_count++;
kevman 0:38ceb79fef03 223 }
kevman 0:38ceb79fef03 224
kevman 0:38ceb79fef03 225 else if (src_coap_msg_ptr->options_list_ptr->proxy_uri_len >= 13 && src_coap_msg_ptr->options_list_ptr->proxy_uri_len <= 269) {
kevman 0:38ceb79fef03 226 returned_byte_count += 2;
kevman 0:38ceb79fef03 227 }
kevman 0:38ceb79fef03 228
kevman 0:38ceb79fef03 229 else if (src_coap_msg_ptr->options_list_ptr->proxy_uri_len >= 270 && src_coap_msg_ptr->options_list_ptr->proxy_uri_len <= 1034) {
kevman 0:38ceb79fef03 230 returned_byte_count += 3;
kevman 0:38ceb79fef03 231 }
kevman 0:38ceb79fef03 232
kevman 0:38ceb79fef03 233 else {
kevman 0:38ceb79fef03 234 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - proxy uri too large!");
kevman 0:38ceb79fef03 235 return 0;
kevman 0:38ceb79fef03 236 }
kevman 0:38ceb79fef03 237
kevman 0:38ceb79fef03 238 /* Add needed memory for Option value */
kevman 0:38ceb79fef03 239 returned_byte_count += src_coap_msg_ptr->options_list_ptr->proxy_uri_len;
kevman 0:38ceb79fef03 240 }
kevman 0:38ceb79fef03 241 /* ETAG - Repeatable option. Length of this option is 1-8 bytes*/
kevman 0:38ceb79fef03 242 if (src_coap_msg_ptr->options_list_ptr->etag_ptr != NULL) {
kevman 0:38ceb79fef03 243 repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->etag_len,
kevman 0:38ceb79fef03 244 src_coap_msg_ptr->options_list_ptr->etag_ptr, COAP_OPTION_ETAG);
kevman 0:38ceb79fef03 245 if (repeatable_option_size) {
kevman 0:38ceb79fef03 246 returned_byte_count += repeatable_option_size;
kevman 0:38ceb79fef03 247 } else {
kevman 0:38ceb79fef03 248 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - etag too large!");
kevman 0:38ceb79fef03 249 return 0;
kevman 0:38ceb79fef03 250 }
kevman 0:38ceb79fef03 251 }
kevman 0:38ceb79fef03 252 /* URI HOST - Length of this option is 1-255 bytes */
kevman 0:38ceb79fef03 253 if (src_coap_msg_ptr->options_list_ptr->uri_host_ptr != NULL) {
kevman 0:38ceb79fef03 254 if (src_coap_msg_ptr->options_list_ptr->uri_host_len > 0 && src_coap_msg_ptr->options_list_ptr->uri_host_len <= 12) {
kevman 0:38ceb79fef03 255 returned_byte_count++;
kevman 0:38ceb79fef03 256 }
kevman 0:38ceb79fef03 257
kevman 0:38ceb79fef03 258 else if (src_coap_msg_ptr->options_list_ptr->uri_host_len >= 13 && src_coap_msg_ptr->options_list_ptr->uri_host_len <= 255) {
kevman 0:38ceb79fef03 259 returned_byte_count += 2;
kevman 0:38ceb79fef03 260 }
kevman 0:38ceb79fef03 261
kevman 0:38ceb79fef03 262 else {
kevman 0:38ceb79fef03 263 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - uri host too large!");
kevman 0:38ceb79fef03 264 return 0;
kevman 0:38ceb79fef03 265 }
kevman 0:38ceb79fef03 266
kevman 0:38ceb79fef03 267 returned_byte_count += src_coap_msg_ptr->options_list_ptr->uri_host_len;
kevman 0:38ceb79fef03 268 }
kevman 0:38ceb79fef03 269 /* LOCATION PATH - Repeatable option. Length of this option is 0-255 bytes*/
kevman 0:38ceb79fef03 270 if (src_coap_msg_ptr->options_list_ptr->location_path_ptr != NULL) {
kevman 0:38ceb79fef03 271 repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->location_path_len,
kevman 0:38ceb79fef03 272 src_coap_msg_ptr->options_list_ptr->location_path_ptr, COAP_OPTION_LOCATION_PATH);
kevman 0:38ceb79fef03 273 if (repeatable_option_size) {
kevman 0:38ceb79fef03 274 returned_byte_count += repeatable_option_size;
kevman 0:38ceb79fef03 275 } else {
kevman 0:38ceb79fef03 276 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - location path too large!");
kevman 0:38ceb79fef03 277 return 0;
kevman 0:38ceb79fef03 278 }
kevman 0:38ceb79fef03 279 }
kevman 0:38ceb79fef03 280 /* URI PORT - An integer option, up to 2 bytes */
kevman 0:38ceb79fef03 281 if (src_coap_msg_ptr->options_list_ptr->uri_port != COAP_OPTION_URI_PORT_NONE) {
kevman 0:38ceb79fef03 282 if ((uint32_t) src_coap_msg_ptr->options_list_ptr->uri_port > 0xffff) {
kevman 0:38ceb79fef03 283 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - uri port too large!");
kevman 0:38ceb79fef03 284 return 0;
kevman 0:38ceb79fef03 285 }
kevman 0:38ceb79fef03 286 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->uri_port, COAP_OPTION_URI_PORT, &tempInt);
kevman 0:38ceb79fef03 287 }
kevman 0:38ceb79fef03 288 /* lOCATION QUERY - Repeatable option. Length of this option is 0-255 bytes */
kevman 0:38ceb79fef03 289 if (src_coap_msg_ptr->options_list_ptr->location_query_ptr != NULL) {
kevman 0:38ceb79fef03 290 repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->location_query_len,
kevman 0:38ceb79fef03 291 src_coap_msg_ptr->options_list_ptr->location_query_ptr, COAP_OPTION_LOCATION_QUERY);
kevman 0:38ceb79fef03 292 if (repeatable_option_size) {
kevman 0:38ceb79fef03 293 returned_byte_count += repeatable_option_size;
kevman 0:38ceb79fef03 294 } else {
kevman 0:38ceb79fef03 295 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - location query too large!");
kevman 0:38ceb79fef03 296 return 0;
kevman 0:38ceb79fef03 297 }
kevman 0:38ceb79fef03 298 }
kevman 0:38ceb79fef03 299 /* OBSERVE - An integer option, up to 3 bytes */
kevman 0:38ceb79fef03 300 if (src_coap_msg_ptr->options_list_ptr->observe != COAP_OBSERVE_NONE) {
kevman 0:38ceb79fef03 301 if ((uint32_t) src_coap_msg_ptr->options_list_ptr->observe > 0xffffff) {
kevman 0:38ceb79fef03 302 return 0;
kevman 0:38ceb79fef03 303 }
kevman 0:38ceb79fef03 304 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->observe, COAP_OPTION_OBSERVE, &tempInt);
kevman 0:38ceb79fef03 305 }
kevman 0:38ceb79fef03 306 /* URI QUERY - Repeatable option. Length of this option is 1-255 */
kevman 0:38ceb79fef03 307 if (src_coap_msg_ptr->options_list_ptr->uri_query_ptr != NULL) {
kevman 0:38ceb79fef03 308 repeatable_option_size = sn_coap_builder_options_calc_option_size(src_coap_msg_ptr->options_list_ptr->uri_query_len,
kevman 0:38ceb79fef03 309 src_coap_msg_ptr->options_list_ptr->uri_query_ptr, COAP_OPTION_URI_QUERY);
kevman 0:38ceb79fef03 310 if (repeatable_option_size) {
kevman 0:38ceb79fef03 311 returned_byte_count += repeatable_option_size;
kevman 0:38ceb79fef03 312 } else {
kevman 0:38ceb79fef03 313 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - observe too large!");
kevman 0:38ceb79fef03 314 return 0;
kevman 0:38ceb79fef03 315 }
kevman 0:38ceb79fef03 316 }
kevman 0:38ceb79fef03 317
kevman 0:38ceb79fef03 318 /* BLOCK 1 - An integer option, up to 3 bytes */
kevman 0:38ceb79fef03 319 if (src_coap_msg_ptr->options_list_ptr->block1 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 320 if ((uint32_t) src_coap_msg_ptr->options_list_ptr->block1 > 0xffffff) {
kevman 0:38ceb79fef03 321 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - block1 too large!");
kevman 0:38ceb79fef03 322 return 0;
kevman 0:38ceb79fef03 323 }
kevman 0:38ceb79fef03 324 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->block1, COAP_OPTION_BLOCK1, &tempInt);
kevman 0:38ceb79fef03 325 }
kevman 0:38ceb79fef03 326 /* SIZE1 - Length of this option is 0-4 bytes */
kevman 0:38ceb79fef03 327 if (src_coap_msg_ptr->options_list_ptr->use_size1) {
kevman 0:38ceb79fef03 328 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->size1, COAP_OPTION_SIZE1, &tempInt);
kevman 0:38ceb79fef03 329 }
kevman 0:38ceb79fef03 330 /* BLOCK 2 - An integer option, up to 3 bytes */
kevman 0:38ceb79fef03 331 if (src_coap_msg_ptr->options_list_ptr->block2 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 332 if ((uint32_t) src_coap_msg_ptr->options_list_ptr->block2 > 0xffffff) {
kevman 0:38ceb79fef03 333 tr_error("sn_coap_builder_calc_needed_packet_data_size_2 - block2 too large!");
kevman 0:38ceb79fef03 334 return 0;
kevman 0:38ceb79fef03 335 }
kevman 0:38ceb79fef03 336 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->block2, COAP_OPTION_BLOCK2, &tempInt);
kevman 0:38ceb79fef03 337 }
kevman 0:38ceb79fef03 338 /* SIZE2 - Length of this option is 0-4 bytes */
kevman 0:38ceb79fef03 339 if (src_coap_msg_ptr->options_list_ptr->use_size2) {
kevman 0:38ceb79fef03 340 returned_byte_count += sn_coap_builder_options_build_add_uint_option(NULL, src_coap_msg_ptr->options_list_ptr->size2, COAP_OPTION_SIZE2, &tempInt);
kevman 0:38ceb79fef03 341 }
kevman 0:38ceb79fef03 342 }
kevman 0:38ceb79fef03 343 #if SN_COAP_BLOCKWISE_ENABLED || SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE
kevman 0:38ceb79fef03 344 if ((src_coap_msg_ptr->payload_len > SN_COAP_MAX_NONBLOCKWISE_PAYLOAD_SIZE) &&
kevman 0:38ceb79fef03 345 (src_coap_msg_ptr->payload_len > blockwise_payload_size) &&
kevman 0:38ceb79fef03 346 (blockwise_payload_size > 0)) {
kevman 0:38ceb79fef03 347 returned_byte_count += blockwise_payload_size;
kevman 0:38ceb79fef03 348 } else {
kevman 0:38ceb79fef03 349 returned_byte_count += src_coap_msg_ptr->payload_len;
kevman 0:38ceb79fef03 350 }
kevman 0:38ceb79fef03 351 #else
kevman 0:38ceb79fef03 352 returned_byte_count += src_coap_msg_ptr->payload_len;
kevman 0:38ceb79fef03 353 #endif
kevman 0:38ceb79fef03 354 if (src_coap_msg_ptr->payload_len) {
kevman 0:38ceb79fef03 355 returned_byte_count ++; /* For payload marker */
kevman 0:38ceb79fef03 356 }
kevman 0:38ceb79fef03 357 returned_byte_count += sn_coap_builder_options_calculate_jump_need(src_coap_msg_ptr/*, 0*/);
kevman 0:38ceb79fef03 358 }
kevman 0:38ceb79fef03 359 return returned_byte_count;
kevman 0:38ceb79fef03 360 }
kevman 0:38ceb79fef03 361 /**
kevman 0:38ceb79fef03 362 * \fn static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr, uint8_t block_option)
kevman 0:38ceb79fef03 363 *
kevman 0:38ceb79fef03 364 * \brief Checks if there is need for option jump
kevman 0:38ceb79fef03 365 *
kevman 0:38ceb79fef03 366 * \param *src_coap_msg_ptr is source of checked CoAP message
kevman 0:38ceb79fef03 367 *
kevman 0:38ceb79fef03 368 * \param block option marks if block option is to be added to message later. 0 = no block option, 1 = block1 and 2 = block2
kevman 0:38ceb79fef03 369 *
kevman 0:38ceb79fef03 370 * \return Returns bytes needed for jumping
kevman 0:38ceb79fef03 371 */
kevman 0:38ceb79fef03 372
kevman 0:38ceb79fef03 373 static uint8_t sn_coap_builder_options_calculate_jump_need(sn_coap_hdr_s *src_coap_msg_ptr/*, uint8_t block_option*/)
kevman 0:38ceb79fef03 374 {
kevman 0:38ceb79fef03 375 uint8_t previous_option_number = 0;
kevman 0:38ceb79fef03 376 uint8_t needed_space = 0;
kevman 0:38ceb79fef03 377
kevman 0:38ceb79fef03 378 if (src_coap_msg_ptr->options_list_ptr != NULL) {
kevman 0:38ceb79fef03 379 /* If option numbers greater than 12 is not used, then jumping is not needed */
kevman 0:38ceb79fef03 380 //TODO: Check if this is really needed! Does it enhance perf? If not -> remove
kevman 0:38ceb79fef03 381 if (!src_coap_msg_ptr->options_list_ptr->uri_query_ptr &&
kevman 0:38ceb79fef03 382 src_coap_msg_ptr->options_list_ptr->accept == COAP_CT_NONE &&
kevman 0:38ceb79fef03 383 !src_coap_msg_ptr->options_list_ptr->location_query_ptr &&
kevman 0:38ceb79fef03 384 src_coap_msg_ptr->options_list_ptr->block2 == COAP_OPTION_BLOCK_NONE &&
kevman 0:38ceb79fef03 385 src_coap_msg_ptr->options_list_ptr->block1 == COAP_OPTION_BLOCK_NONE &&
kevman 0:38ceb79fef03 386 !src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr &&
kevman 0:38ceb79fef03 387 src_coap_msg_ptr->options_list_ptr->max_age == COAP_OPTION_MAX_AGE_DEFAULT &&
kevman 0:38ceb79fef03 388 !src_coap_msg_ptr->options_list_ptr->use_size1 &&
kevman 0:38ceb79fef03 389 !src_coap_msg_ptr->options_list_ptr->use_size2) {
kevman 0:38ceb79fef03 390 return 0;
kevman 0:38ceb79fef03 391 }
kevman 0:38ceb79fef03 392
kevman 0:38ceb79fef03 393 if (src_coap_msg_ptr->options_list_ptr->uri_host_ptr != NULL) {
kevman 0:38ceb79fef03 394 previous_option_number = (COAP_OPTION_URI_HOST);
kevman 0:38ceb79fef03 395 }
kevman 0:38ceb79fef03 396
kevman 0:38ceb79fef03 397 if (src_coap_msg_ptr->options_list_ptr->etag_ptr != NULL) {
kevman 0:38ceb79fef03 398 previous_option_number = (COAP_OPTION_ETAG);
kevman 0:38ceb79fef03 399 }
kevman 0:38ceb79fef03 400
kevman 0:38ceb79fef03 401 if (src_coap_msg_ptr->options_list_ptr->observe != COAP_OBSERVE_NONE) {
kevman 0:38ceb79fef03 402 previous_option_number = (COAP_OPTION_OBSERVE);
kevman 0:38ceb79fef03 403 }
kevman 0:38ceb79fef03 404
kevman 0:38ceb79fef03 405 if (src_coap_msg_ptr->options_list_ptr->uri_port != COAP_OPTION_URI_PORT_NONE) {
kevman 0:38ceb79fef03 406 previous_option_number = (COAP_OPTION_URI_PORT);
kevman 0:38ceb79fef03 407 }
kevman 0:38ceb79fef03 408
kevman 0:38ceb79fef03 409 if (src_coap_msg_ptr->options_list_ptr->location_path_ptr != NULL) {
kevman 0:38ceb79fef03 410 previous_option_number = (COAP_OPTION_LOCATION_PATH);
kevman 0:38ceb79fef03 411 }
kevman 0:38ceb79fef03 412
kevman 0:38ceb79fef03 413 if (src_coap_msg_ptr->uri_path_ptr != NULL) {
kevman 0:38ceb79fef03 414 previous_option_number = (COAP_OPTION_URI_PATH);
kevman 0:38ceb79fef03 415 }
kevman 0:38ceb79fef03 416 if (src_coap_msg_ptr->content_format != COAP_CT_NONE) {
kevman 0:38ceb79fef03 417 previous_option_number = (COAP_OPTION_CONTENT_FORMAT);
kevman 0:38ceb79fef03 418 }
kevman 0:38ceb79fef03 419 if (src_coap_msg_ptr->options_list_ptr->max_age != COAP_OPTION_MAX_AGE_DEFAULT) {
kevman 0:38ceb79fef03 420 if ((COAP_OPTION_MAX_AGE - previous_option_number) > 12) {
kevman 0:38ceb79fef03 421 needed_space += 1;
kevman 0:38ceb79fef03 422 }
kevman 0:38ceb79fef03 423 previous_option_number = (COAP_OPTION_MAX_AGE);
kevman 0:38ceb79fef03 424 }
kevman 0:38ceb79fef03 425
kevman 0:38ceb79fef03 426 if (src_coap_msg_ptr->options_list_ptr->uri_query_ptr != NULL) {
kevman 0:38ceb79fef03 427 if ((COAP_OPTION_URI_QUERY - previous_option_number) > 12) {
kevman 0:38ceb79fef03 428 needed_space += 1;
kevman 0:38ceb79fef03 429 }
kevman 0:38ceb79fef03 430 previous_option_number = (COAP_OPTION_URI_QUERY);
kevman 0:38ceb79fef03 431 }
kevman 0:38ceb79fef03 432 if (src_coap_msg_ptr->options_list_ptr->accept != COAP_CT_NONE) {
kevman 0:38ceb79fef03 433 if ((COAP_OPTION_ACCEPT - previous_option_number) > 12) {
kevman 0:38ceb79fef03 434 needed_space += 1;
kevman 0:38ceb79fef03 435 }
kevman 0:38ceb79fef03 436 previous_option_number = (COAP_OPTION_ACCEPT);
kevman 0:38ceb79fef03 437 }
kevman 0:38ceb79fef03 438 if (src_coap_msg_ptr->options_list_ptr->location_query_ptr != NULL) {
kevman 0:38ceb79fef03 439 if ((COAP_OPTION_LOCATION_QUERY - previous_option_number) > 12) {
kevman 0:38ceb79fef03 440 needed_space += 1;
kevman 0:38ceb79fef03 441 }
kevman 0:38ceb79fef03 442 previous_option_number = (COAP_OPTION_LOCATION_QUERY);
kevman 0:38ceb79fef03 443 }
kevman 0:38ceb79fef03 444 if (src_coap_msg_ptr->options_list_ptr->block2 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 445 if ((COAP_OPTION_BLOCK2 - previous_option_number) > 12 ){
kevman 0:38ceb79fef03 446 needed_space += 1;
kevman 0:38ceb79fef03 447 }
kevman 0:38ceb79fef03 448 previous_option_number = (COAP_OPTION_BLOCK2);
kevman 0:38ceb79fef03 449 }
kevman 0:38ceb79fef03 450 if (src_coap_msg_ptr->options_list_ptr->block1 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 451 if ((COAP_OPTION_BLOCK1 - previous_option_number) > 12 ){
kevman 0:38ceb79fef03 452 needed_space += 1;
kevman 0:38ceb79fef03 453 }
kevman 0:38ceb79fef03 454 previous_option_number = (COAP_OPTION_BLOCK1);
kevman 0:38ceb79fef03 455 }
kevman 0:38ceb79fef03 456 if (src_coap_msg_ptr->options_list_ptr->use_size2) {
kevman 0:38ceb79fef03 457 if ((COAP_OPTION_SIZE2 - previous_option_number) > 12) {
kevman 0:38ceb79fef03 458 needed_space += 1;
kevman 0:38ceb79fef03 459 }
kevman 0:38ceb79fef03 460 previous_option_number = (COAP_OPTION_SIZE2);
kevman 0:38ceb79fef03 461 }
kevman 0:38ceb79fef03 462 if (src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr != NULL) {
kevman 0:38ceb79fef03 463 if ((COAP_OPTION_PROXY_URI - previous_option_number) > 12) {
kevman 0:38ceb79fef03 464 needed_space += 1;
kevman 0:38ceb79fef03 465 }
kevman 0:38ceb79fef03 466 if ((COAP_OPTION_PROXY_URI - previous_option_number) > 269) { //Can not happen
kevman 0:38ceb79fef03 467 needed_space += 1;
kevman 0:38ceb79fef03 468 }
kevman 0:38ceb79fef03 469 previous_option_number = (COAP_OPTION_PROXY_URI);
kevman 0:38ceb79fef03 470 }
kevman 0:38ceb79fef03 471 if (src_coap_msg_ptr->options_list_ptr->use_size1 ) {
kevman 0:38ceb79fef03 472 if ((COAP_OPTION_SIZE1 - previous_option_number) > 12) {
kevman 0:38ceb79fef03 473 needed_space += 1;
kevman 0:38ceb79fef03 474 }
kevman 0:38ceb79fef03 475 previous_option_number = (COAP_OPTION_SIZE1);
kevman 0:38ceb79fef03 476 }
kevman 0:38ceb79fef03 477 }
kevman 0:38ceb79fef03 478
kevman 0:38ceb79fef03 479 else {
kevman 0:38ceb79fef03 480 if (src_coap_msg_ptr->uri_path_ptr != 0) {
kevman 0:38ceb79fef03 481 previous_option_number = (COAP_OPTION_URI_PATH);
kevman 0:38ceb79fef03 482 }
kevman 0:38ceb79fef03 483
kevman 0:38ceb79fef03 484 if (src_coap_msg_ptr->content_format != COAP_CT_NONE) {
kevman 0:38ceb79fef03 485 previous_option_number = (COAP_OPTION_CONTENT_FORMAT);
kevman 0:38ceb79fef03 486 }
kevman 0:38ceb79fef03 487 }
kevman 0:38ceb79fef03 488 return needed_space;
kevman 0:38ceb79fef03 489 }
kevman 0:38ceb79fef03 490
kevman 0:38ceb79fef03 491 /**
kevman 0:38ceb79fef03 492 * \fn static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 493 *
kevman 0:38ceb79fef03 494 * \brief Builds Header part of Packet data
kevman 0:38ceb79fef03 495 *
kevman 0:38ceb79fef03 496 * \param **dst_packet_data_pptr is destination for built Packet data
kevman 0:38ceb79fef03 497 *
kevman 0:38ceb79fef03 498 * \param *src_coap_msg_ptr is source for building Packet data
kevman 0:38ceb79fef03 499 *
kevman 0:38ceb79fef03 500 * \return Return value is 0 in ok case and -1 in failure case
kevman 0:38ceb79fef03 501 **************************************************************************** */
kevman 0:38ceb79fef03 502 static int8_t sn_coap_builder_header_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 503 {
kevman 0:38ceb79fef03 504 /* * * * Check validity of Header values * * * */
kevman 0:38ceb79fef03 505 if (sn_coap_header_validity_check(src_coap_msg_ptr, COAP_VERSION) != 0) {
kevman 0:38ceb79fef03 506 tr_error("sn_coap_builder_header_build - header build failed!");
kevman 0:38ceb79fef03 507 return -1;
kevman 0:38ceb79fef03 508 }
kevman 0:38ceb79fef03 509
kevman 0:38ceb79fef03 510 /* * * Add CoAP Version * * */
kevman 0:38ceb79fef03 511 **dst_packet_data_pptr += COAP_VERSION;
kevman 0:38ceb79fef03 512
kevman 0:38ceb79fef03 513 /* * * Add Message type * * */
kevman 0:38ceb79fef03 514 **dst_packet_data_pptr += src_coap_msg_ptr->msg_type;
kevman 0:38ceb79fef03 515
kevman 0:38ceb79fef03 516 /* * * Add Token length * * */
kevman 0:38ceb79fef03 517 **dst_packet_data_pptr += (src_coap_msg_ptr->token_len);
kevman 0:38ceb79fef03 518
kevman 0:38ceb79fef03 519 (*dst_packet_data_pptr) ++;
kevman 0:38ceb79fef03 520 /* * * Add Message code * * */
kevman 0:38ceb79fef03 521 **dst_packet_data_pptr = src_coap_msg_ptr->msg_code;
kevman 0:38ceb79fef03 522 (*dst_packet_data_pptr) ++;
kevman 0:38ceb79fef03 523
kevman 0:38ceb79fef03 524 /* * * Add Message ID * * */
kevman 0:38ceb79fef03 525 **dst_packet_data_pptr = (uint8_t)(src_coap_msg_ptr->msg_id >> COAP_HEADER_MSG_ID_MSB_SHIFT); /* MSB part */
kevman 0:38ceb79fef03 526 (*dst_packet_data_pptr) ++;
kevman 0:38ceb79fef03 527 **dst_packet_data_pptr = (uint8_t)src_coap_msg_ptr->msg_id; /* LSB part */
kevman 0:38ceb79fef03 528 (*dst_packet_data_pptr) ++;
kevman 0:38ceb79fef03 529
kevman 0:38ceb79fef03 530 /* Success */
kevman 0:38ceb79fef03 531 return 0;
kevman 0:38ceb79fef03 532 }
kevman 0:38ceb79fef03 533
kevman 0:38ceb79fef03 534 /**
kevman 0:38ceb79fef03 535 * \fn static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 536 *
kevman 0:38ceb79fef03 537 * \brief Builds Options part of Packet data
kevman 0:38ceb79fef03 538 *
kevman 0:38ceb79fef03 539 * \param **dst_packet_data_pptr is destination for built Packet data
kevman 0:38ceb79fef03 540 *
kevman 0:38ceb79fef03 541 * \param *src_coap_msg_ptr is source for building Packet data
kevman 0:38ceb79fef03 542 *
kevman 0:38ceb79fef03 543 * \return Return value is 0 in every case
kevman 0:38ceb79fef03 544 */
kevman 0:38ceb79fef03 545 static int8_t sn_coap_builder_options_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 546 {
kevman 0:38ceb79fef03 547 /* * * * Check if Options are used at all * * * */
kevman 0:38ceb79fef03 548 if (src_coap_msg_ptr->uri_path_ptr == NULL && src_coap_msg_ptr->token_ptr == NULL &&
kevman 0:38ceb79fef03 549 src_coap_msg_ptr->content_format == COAP_CT_NONE && src_coap_msg_ptr->options_list_ptr == NULL) {
kevman 0:38ceb79fef03 550 tr_error("sn_coap_builder_options_build - options not used!");
kevman 0:38ceb79fef03 551 return 0;
kevman 0:38ceb79fef03 552 }
kevman 0:38ceb79fef03 553
kevman 0:38ceb79fef03 554 /* * * * First add Token option * * * */
kevman 0:38ceb79fef03 555 if (src_coap_msg_ptr->token_len && src_coap_msg_ptr->token_ptr) {
kevman 0:38ceb79fef03 556 memcpy(*dst_packet_data_pptr, src_coap_msg_ptr->token_ptr, src_coap_msg_ptr->token_len);
kevman 0:38ceb79fef03 557 }
kevman 0:38ceb79fef03 558 (*dst_packet_data_pptr) += src_coap_msg_ptr->token_len;
kevman 0:38ceb79fef03 559
kevman 0:38ceb79fef03 560 /* Then build rest of the options */
kevman 0:38ceb79fef03 561
kevman 0:38ceb79fef03 562 /* * * * Initialize previous Option number for new built message * * * */
kevman 0:38ceb79fef03 563 uint16_t previous_option_number = 0;
kevman 0:38ceb79fef03 564
kevman 0:38ceb79fef03 565 //missing: COAP_OPTION_IF_MATCH, COAP_OPTION_IF_NONE_MATCH, COAP_OPTION_SIZE
kevman 0:38ceb79fef03 566
kevman 0:38ceb79fef03 567 /* Check if less used options are used at all */
kevman 0:38ceb79fef03 568 if (src_coap_msg_ptr->options_list_ptr != NULL) {
kevman 0:38ceb79fef03 569 /* * * * Build Uri-Host option * * * */
kevman 0:38ceb79fef03 570 sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->uri_host_len,
kevman 0:38ceb79fef03 571 src_coap_msg_ptr->options_list_ptr->uri_host_ptr, COAP_OPTION_URI_HOST, &previous_option_number);
kevman 0:38ceb79fef03 572
kevman 0:38ceb79fef03 573 /* * * * Build ETag option * * * */
kevman 0:38ceb79fef03 574 sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->etag_ptr,
kevman 0:38ceb79fef03 575 (uint16_t *)&src_coap_msg_ptr->options_list_ptr->etag_len, COAP_OPTION_ETAG, &previous_option_number);
kevman 0:38ceb79fef03 576
kevman 0:38ceb79fef03 577 /* * * * Build Observe option * * * * */
kevman 0:38ceb79fef03 578 if (src_coap_msg_ptr->options_list_ptr->observe != COAP_OBSERVE_NONE) {
kevman 0:38ceb79fef03 579 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->observe,
kevman 0:38ceb79fef03 580 COAP_OPTION_OBSERVE, &previous_option_number);
kevman 0:38ceb79fef03 581 }
kevman 0:38ceb79fef03 582
kevman 0:38ceb79fef03 583 /* * * * Build Uri-Port option * * * */
kevman 0:38ceb79fef03 584 if (src_coap_msg_ptr->options_list_ptr->uri_port != COAP_OPTION_URI_PORT_NONE) {
kevman 0:38ceb79fef03 585 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->uri_port,
kevman 0:38ceb79fef03 586 COAP_OPTION_URI_PORT, &previous_option_number);
kevman 0:38ceb79fef03 587 }
kevman 0:38ceb79fef03 588
kevman 0:38ceb79fef03 589 /* * * * Build Location-Path option * * * */
kevman 0:38ceb79fef03 590 sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->location_path_ptr,
kevman 0:38ceb79fef03 591 &src_coap_msg_ptr->options_list_ptr->location_path_len, COAP_OPTION_LOCATION_PATH, &previous_option_number);
kevman 0:38ceb79fef03 592 }
kevman 0:38ceb79fef03 593 /* * * * Build Uri-Path option * * * */
kevman 0:38ceb79fef03 594 sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->uri_path_ptr,
kevman 0:38ceb79fef03 595 &src_coap_msg_ptr->uri_path_len, COAP_OPTION_URI_PATH, &previous_option_number);
kevman 0:38ceb79fef03 596
kevman 0:38ceb79fef03 597 /* * * * Build Content-Type option * * * */
kevman 0:38ceb79fef03 598 if (src_coap_msg_ptr->content_format != COAP_CT_NONE) {
kevman 0:38ceb79fef03 599 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->content_format,
kevman 0:38ceb79fef03 600 COAP_OPTION_CONTENT_FORMAT, &previous_option_number);
kevman 0:38ceb79fef03 601 }
kevman 0:38ceb79fef03 602
kevman 0:38ceb79fef03 603 if (src_coap_msg_ptr->options_list_ptr != NULL) {
kevman 0:38ceb79fef03 604 /* * * * Build Max-Age option * * * */
kevman 0:38ceb79fef03 605 if (src_coap_msg_ptr->options_list_ptr->max_age != COAP_OPTION_MAX_AGE_DEFAULT) {
kevman 0:38ceb79fef03 606 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->max_age,
kevman 0:38ceb79fef03 607 COAP_OPTION_MAX_AGE, &previous_option_number);
kevman 0:38ceb79fef03 608 }
kevman 0:38ceb79fef03 609
kevman 0:38ceb79fef03 610 /* * * * Build Uri-Query option * * * * */
kevman 0:38ceb79fef03 611 sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->uri_query_ptr,
kevman 0:38ceb79fef03 612 &src_coap_msg_ptr->options_list_ptr->uri_query_len, COAP_OPTION_URI_QUERY, &previous_option_number);
kevman 0:38ceb79fef03 613
kevman 0:38ceb79fef03 614 /* * * * Build Accept option * * * * */
kevman 0:38ceb79fef03 615 if (src_coap_msg_ptr->options_list_ptr->accept != COAP_CT_NONE) {
kevman 0:38ceb79fef03 616 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->accept,
kevman 0:38ceb79fef03 617 COAP_OPTION_ACCEPT, &previous_option_number);
kevman 0:38ceb79fef03 618 }
kevman 0:38ceb79fef03 619 }
kevman 0:38ceb79fef03 620
kevman 0:38ceb79fef03 621 if (src_coap_msg_ptr->options_list_ptr != NULL) {
kevman 0:38ceb79fef03 622 /* * * * Build Location-Query option * * * */
kevman 0:38ceb79fef03 623 sn_coap_builder_options_build_add_multiple_option(dst_packet_data_pptr, &src_coap_msg_ptr->options_list_ptr->location_query_ptr,
kevman 0:38ceb79fef03 624 &src_coap_msg_ptr->options_list_ptr->location_query_len, COAP_OPTION_LOCATION_QUERY, &previous_option_number);
kevman 0:38ceb79fef03 625
kevman 0:38ceb79fef03 626 /* * * * Build Block2 option * * * * */
kevman 0:38ceb79fef03 627 if (src_coap_msg_ptr->options_list_ptr->block2 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 628 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->block2,
kevman 0:38ceb79fef03 629 COAP_OPTION_BLOCK2, &previous_option_number);
kevman 0:38ceb79fef03 630 }
kevman 0:38ceb79fef03 631
kevman 0:38ceb79fef03 632 /* * * * Build Block1 option * * * * */
kevman 0:38ceb79fef03 633 if (src_coap_msg_ptr->options_list_ptr->block1 != COAP_OPTION_BLOCK_NONE) {
kevman 0:38ceb79fef03 634 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->block1,
kevman 0:38ceb79fef03 635 COAP_OPTION_BLOCK1, &previous_option_number);
kevman 0:38ceb79fef03 636 }
kevman 0:38ceb79fef03 637
kevman 0:38ceb79fef03 638 /* * * * Build Size2 option * * * */
kevman 0:38ceb79fef03 639 if (src_coap_msg_ptr->options_list_ptr->use_size2) {
kevman 0:38ceb79fef03 640 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->size2,
kevman 0:38ceb79fef03 641 COAP_OPTION_SIZE2, &previous_option_number);
kevman 0:38ceb79fef03 642 }
kevman 0:38ceb79fef03 643
kevman 0:38ceb79fef03 644 /* * * * Build Proxy-Uri option * * * */
kevman 0:38ceb79fef03 645 sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->proxy_uri_len,
kevman 0:38ceb79fef03 646 src_coap_msg_ptr->options_list_ptr->proxy_uri_ptr, COAP_OPTION_PROXY_URI, &previous_option_number);
kevman 0:38ceb79fef03 647
kevman 0:38ceb79fef03 648
kevman 0:38ceb79fef03 649 /* * * * Build Size1 option * * * */
kevman 0:38ceb79fef03 650 if (src_coap_msg_ptr->options_list_ptr->use_size1) {
kevman 0:38ceb79fef03 651 sn_coap_builder_options_build_add_uint_option(dst_packet_data_pptr, src_coap_msg_ptr->options_list_ptr->size1,
kevman 0:38ceb79fef03 652 COAP_OPTION_SIZE1, &previous_option_number);
kevman 0:38ceb79fef03 653 }
kevman 0:38ceb79fef03 654 }
kevman 0:38ceb79fef03 655
kevman 0:38ceb79fef03 656 /* Success */
kevman 0:38ceb79fef03 657 return 0;
kevman 0:38ceb79fef03 658 }
kevman 0:38ceb79fef03 659
kevman 0:38ceb79fef03 660 /**
kevman 0:38ceb79fef03 661 * \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)
kevman 0:38ceb79fef03 662 *
kevman 0:38ceb79fef03 663 * \brief Adds Options part of Packet data
kevman 0:38ceb79fef03 664 *
kevman 0:38ceb79fef03 665 * \param **dst_packet_data_pptr is destination for built Packet data
kevman 0:38ceb79fef03 666 *
kevman 0:38ceb79fef03 667 * \param option_value_len is Option value length to be added
kevman 0:38ceb79fef03 668 *
kevman 0:38ceb79fef03 669 * \param *option_value_ptr is pointer to Option value data to be added
kevman 0:38ceb79fef03 670 *
kevman 0:38ceb79fef03 671 * \param option_number is Option number to be added
kevman 0:38ceb79fef03 672 *
kevman 0:38ceb79fef03 673 * \return Return value is 0 if option was not added, 1 if added
kevman 0:38ceb79fef03 674 */
kevman 0:38ceb79fef03 675 static int16_t sn_coap_builder_options_build_add_one_option(uint8_t **dst_packet_data_pptr, uint16_t option_len,
kevman 0:38ceb79fef03 676 uint8_t *option_ptr, sn_coap_option_numbers_e option_number, uint16_t *previous_option_number)
kevman 0:38ceb79fef03 677 {
kevman 0:38ceb79fef03 678 /* Check if there is option at all */
kevman 0:38ceb79fef03 679 if (option_ptr != NULL) {
kevman 0:38ceb79fef03 680 uint16_t option_delta;
kevman 0:38ceb79fef03 681
kevman 0:38ceb79fef03 682 option_delta = (option_number - *previous_option_number);
kevman 0:38ceb79fef03 683
kevman 0:38ceb79fef03 684 /* * * Build option header * * */
kevman 0:38ceb79fef03 685
kevman 0:38ceb79fef03 686 /* First option length without extended part */
kevman 0:38ceb79fef03 687 if (option_len <= 12) {
kevman 0:38ceb79fef03 688 **dst_packet_data_pptr = option_len;
kevman 0:38ceb79fef03 689 }
kevman 0:38ceb79fef03 690
kevman 0:38ceb79fef03 691 else if (option_len > 12 && option_len < 269) {
kevman 0:38ceb79fef03 692 **dst_packet_data_pptr = 0x0D;
kevman 0:38ceb79fef03 693 }
kevman 0:38ceb79fef03 694
kevman 0:38ceb79fef03 695 else if (option_len >= 269) {
kevman 0:38ceb79fef03 696 **dst_packet_data_pptr = 0x0E;
kevman 0:38ceb79fef03 697 }
kevman 0:38ceb79fef03 698
kevman 0:38ceb79fef03 699 /* Then option delta with extensions, and move pointer */
kevman 0:38ceb79fef03 700 if (option_delta <= 12) {
kevman 0:38ceb79fef03 701 **dst_packet_data_pptr += (option_delta << 4);
kevman 0:38ceb79fef03 702 *dst_packet_data_pptr += 1;
kevman 0:38ceb79fef03 703 }
kevman 0:38ceb79fef03 704
kevman 0:38ceb79fef03 705 else if (option_delta > 12 && option_delta < 269) {
kevman 0:38ceb79fef03 706 **dst_packet_data_pptr += 0xD0;
kevman 0:38ceb79fef03 707 option_delta -= 13;
kevman 0:38ceb79fef03 708
kevman 0:38ceb79fef03 709 *(*dst_packet_data_pptr + 1) = (uint8_t)option_delta;
kevman 0:38ceb79fef03 710 *dst_packet_data_pptr += 2;
kevman 0:38ceb79fef03 711 }
kevman 0:38ceb79fef03 712 //This is currently dead code (but possibly needed in future)
kevman 0:38ceb79fef03 713 else if (option_delta >= 269) {
kevman 0:38ceb79fef03 714 **dst_packet_data_pptr += 0xE0;
kevman 0:38ceb79fef03 715 option_delta -= 269;
kevman 0:38ceb79fef03 716
kevman 0:38ceb79fef03 717 *(*dst_packet_data_pptr + 2) = (uint8_t)option_delta;
kevman 0:38ceb79fef03 718 *(*dst_packet_data_pptr + 1) = (option_delta >> 8);
kevman 0:38ceb79fef03 719 *dst_packet_data_pptr += 3;
kevman 0:38ceb79fef03 720 }
kevman 0:38ceb79fef03 721
kevman 0:38ceb79fef03 722 /* Now option length extensions, if needed */
kevman 0:38ceb79fef03 723 if (option_len > 12 && option_len < 269) {
kevman 0:38ceb79fef03 724 **dst_packet_data_pptr = (uint8_t)(option_len - 13);
kevman 0:38ceb79fef03 725 *dst_packet_data_pptr += 1;
kevman 0:38ceb79fef03 726 }
kevman 0:38ceb79fef03 727
kevman 0:38ceb79fef03 728 else if (option_len >= 269) {
kevman 0:38ceb79fef03 729 *(*dst_packet_data_pptr + 1) = (uint8_t)(option_len - 269);
kevman 0:38ceb79fef03 730 **dst_packet_data_pptr = ((option_len - 269) >> 8);
kevman 0:38ceb79fef03 731 *dst_packet_data_pptr += 2;
kevman 0:38ceb79fef03 732 }
kevman 0:38ceb79fef03 733
kevman 0:38ceb79fef03 734 *previous_option_number = option_number;
kevman 0:38ceb79fef03 735
kevman 0:38ceb79fef03 736 /* Write Option value */
kevman 0:38ceb79fef03 737 memcpy(*dst_packet_data_pptr, option_ptr, option_len);
kevman 0:38ceb79fef03 738
kevman 0:38ceb79fef03 739 /* Increase destination Packet data pointer */
kevman 0:38ceb79fef03 740 (*dst_packet_data_pptr) += option_len;
kevman 0:38ceb79fef03 741
kevman 0:38ceb79fef03 742 return 1;
kevman 0:38ceb79fef03 743 }
kevman 0:38ceb79fef03 744
kevman 0:38ceb79fef03 745 /* Success */
kevman 0:38ceb79fef03 746 return 0;
kevman 0:38ceb79fef03 747 }
kevman 0:38ceb79fef03 748
kevman 0:38ceb79fef03 749 /**
kevman 0:38ceb79fef03 750 * \brief Constructs a uint Options part of Packet data
kevman 0:38ceb79fef03 751 *
kevman 0:38ceb79fef03 752 * \param **dst_packet_data_pptr is destination for built Packet data; NULL
kevman 0:38ceb79fef03 753 * to compute size only.
kevman 0:38ceb79fef03 754 *
kevman 0:38ceb79fef03 755 * \param option_value is Option value to be added
kevman 0:38ceb79fef03 756 *
kevman 0:38ceb79fef03 757 * \param option_number is Option number to be added
kevman 0:38ceb79fef03 758 *
kevman 0:38ceb79fef03 759 * \return Return value is total option size, or -1 in write failure case
kevman 0:38ceb79fef03 760 */
kevman 0:38ceb79fef03 761 static uint8_t sn_coap_builder_options_build_add_uint_option(uint8_t **dst_packet_data_pptr, uint32_t option_value, sn_coap_option_numbers_e option_number, uint16_t *previous_option_number)
kevman 0:38ceb79fef03 762 {
kevman 0:38ceb79fef03 763 uint8_t payload[4];
kevman 0:38ceb79fef03 764 uint8_t len = 0;
kevman 0:38ceb79fef03 765 /* Construct the variable-length payload representing the value */
kevman 0:38ceb79fef03 766 for (uint8_t i = 0; i < 4; i++) {
kevman 0:38ceb79fef03 767 if (len > 0 || (option_value & 0xff000000)) {
kevman 0:38ceb79fef03 768 payload[len++] = option_value >> 24;
kevman 0:38ceb79fef03 769 }
kevman 0:38ceb79fef03 770 option_value <<= 8;
kevman 0:38ceb79fef03 771 }
kevman 0:38ceb79fef03 772
kevman 0:38ceb79fef03 773 /* If output pointer isn't NULL, write it out */
kevman 0:38ceb79fef03 774 if (dst_packet_data_pptr) {
kevman 0:38ceb79fef03 775 int16_t ret = sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, len, payload, option_number, previous_option_number);
kevman 0:38ceb79fef03 776 /* Allow for failure returns when writing (why even permit failure returns?) */
kevman 0:38ceb79fef03 777 if (ret < 0) {
kevman 0:38ceb79fef03 778 return ret;
kevman 0:38ceb79fef03 779 }
kevman 0:38ceb79fef03 780 }
kevman 0:38ceb79fef03 781
kevman 0:38ceb79fef03 782 /* Return the total option size */
kevman 0:38ceb79fef03 783 return 1 + len;
kevman 0:38ceb79fef03 784 }
kevman 0:38ceb79fef03 785
kevman 0:38ceb79fef03 786 /**
kevman 0:38ceb79fef03 787 * \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)
kevman 0:38ceb79fef03 788 *
kevman 0:38ceb79fef03 789 * \brief Builds Option Uri-Query from given CoAP Header structure to Packet data
kevman 0:38ceb79fef03 790 *
kevman 0:38ceb79fef03 791 * \param **dst_packet_data_pptr is destination for built Packet data
kevman 0:38ceb79fef03 792 *
kevman 0:38ceb79fef03 793 * \param uint8_t **src_pptr
kevman 0:38ceb79fef03 794 *
kevman 0:38ceb79fef03 795 * \param uint16_t *src_len_ptr
kevman 0:38ceb79fef03 796 *
kevman 0:38ceb79fef03 797 * \paramsn_coap_option_numbers_e option option to be added
kevman 0:38ceb79fef03 798 *
kevman 0:38ceb79fef03 799 * \return Return value is 0 always
kevman 0:38ceb79fef03 800 */
kevman 0:38ceb79fef03 801 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, uint16_t *previous_option_number)
kevman 0:38ceb79fef03 802 {
kevman 0:38ceb79fef03 803 /* Check if there is option at all */
kevman 0:38ceb79fef03 804 if (*src_pptr != NULL) {
kevman 0:38ceb79fef03 805 uint8_t *query_ptr = *src_pptr;
kevman 0:38ceb79fef03 806 uint8_t query_part_count = 0;
kevman 0:38ceb79fef03 807 uint16_t query_len = *src_len_ptr;
kevman 0:38ceb79fef03 808 uint8_t i = 0;
kevman 0:38ceb79fef03 809 uint16_t query_part_offset = 0;
kevman 0:38ceb79fef03 810
kevman 0:38ceb79fef03 811 /* Get query part count */
kevman 0:38ceb79fef03 812 query_part_count = sn_coap_builder_options_get_option_part_count(query_len, query_ptr, option);
kevman 0:38ceb79fef03 813
kevman 0:38ceb79fef03 814 /* * * * Options by adding all parts to option * * * */
kevman 0:38ceb79fef03 815 for (i = 0; i < query_part_count; i++) {
kevman 0:38ceb79fef03 816 /* Get length of query part */
kevman 0:38ceb79fef03 817 uint16_t one_query_part_len = sn_coap_builder_options_get_option_part_length_from_whole_option_string(query_len, query_ptr, i, option);
kevman 0:38ceb79fef03 818
kevman 0:38ceb79fef03 819 /* Get position of query part */
kevman 0:38ceb79fef03 820 query_part_offset = sn_coap_builder_options_get_option_part_position(query_len, query_ptr, i, option);
kevman 0:38ceb79fef03 821
kevman 0:38ceb79fef03 822 /* Add Uri-query's one part to Options */
kevman 0:38ceb79fef03 823 sn_coap_builder_options_build_add_one_option(dst_packet_data_pptr, one_query_part_len, *src_pptr + query_part_offset, option, previous_option_number);
kevman 0:38ceb79fef03 824 }
kevman 0:38ceb79fef03 825 }
kevman 0:38ceb79fef03 826 /* Success */
kevman 0:38ceb79fef03 827 return 0;
kevman 0:38ceb79fef03 828 }
kevman 0:38ceb79fef03 829
kevman 0:38ceb79fef03 830
kevman 0:38ceb79fef03 831 /**
kevman 0:38ceb79fef03 832 * \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)
kevman 0:38ceb79fef03 833 *
kevman 0:38ceb79fef03 834 * \brief Calculates needed Packet data memory size for option
kevman 0:38ceb79fef03 835 *
kevman 0:38ceb79fef03 836 * \param path_len is length of calculated strting(s)
kevman 0:38ceb79fef03 837 *
kevman 0:38ceb79fef03 838 * \param *path_ptr is pointer to calculated options
kevman 0:38ceb79fef03 839 *
kevman 0:38ceb79fef03 840 * \return Return value is count of needed memory as bytes for Uri-query option
kevman 0:38ceb79fef03 841 */
kevman 0:38ceb79fef03 842 static uint16_t sn_coap_builder_options_calc_option_size(uint16_t query_len, uint8_t *query_ptr, sn_coap_option_numbers_e option)
kevman 0:38ceb79fef03 843 {
kevman 0:38ceb79fef03 844 uint8_t query_part_count = sn_coap_builder_options_get_option_part_count(query_len, query_ptr, option);
kevman 0:38ceb79fef03 845 uint8_t i = 0;
kevman 0:38ceb79fef03 846 uint16_t ret_value = 0;
kevman 0:38ceb79fef03 847
kevman 0:38ceb79fef03 848 /* * * * * * * * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 849 /* * * * Calculate Uri-query options length * * */
kevman 0:38ceb79fef03 850 /* * * * * * * * * * * * * * * * * * * * * * * * */
kevman 0:38ceb79fef03 851 for (i = 0; i < query_part_count; i++) {
kevman 0:38ceb79fef03 852 /* * * Length of Option number and Option value length * * */
kevman 0:38ceb79fef03 853
kevman 0:38ceb79fef03 854 /* Get length of Query part */
kevman 0:38ceb79fef03 855 uint16_t one_query_part_len = sn_coap_builder_options_get_option_part_length_from_whole_option_string(query_len, query_ptr, i, option);
kevman 0:38ceb79fef03 856
kevman 0:38ceb79fef03 857 /* Check option length */
kevman 0:38ceb79fef03 858 switch (option) {
kevman 0:38ceb79fef03 859 case (COAP_OPTION_ETAG): /* Length 1-8 */
kevman 0:38ceb79fef03 860 if (one_query_part_len < 1 || one_query_part_len > 8) {
kevman 0:38ceb79fef03 861 return 0;
kevman 0:38ceb79fef03 862 }
kevman 0:38ceb79fef03 863 break;
kevman 0:38ceb79fef03 864 case (COAP_OPTION_LOCATION_PATH): /* Length 0-255 */
kevman 0:38ceb79fef03 865 case (COAP_OPTION_URI_PATH): /* Length 0-255 */
kevman 0:38ceb79fef03 866 case (COAP_OPTION_LOCATION_QUERY): /* Length 0-255 */
kevman 0:38ceb79fef03 867 if (one_query_part_len > 255) {
kevman 0:38ceb79fef03 868 return 0;
kevman 0:38ceb79fef03 869 }
kevman 0:38ceb79fef03 870 break;
kevman 0:38ceb79fef03 871 case (COAP_OPTION_URI_QUERY): /* Length 1-255 */
kevman 0:38ceb79fef03 872 if (one_query_part_len < 1 || one_query_part_len > 255) {
kevman 0:38ceb79fef03 873 return 0;
kevman 0:38ceb79fef03 874 }
kevman 0:38ceb79fef03 875 break;
kevman 0:38ceb79fef03 876 // case (COAP_OPTION_ACCEPT): /* Length 0-2 */
kevman 0:38ceb79fef03 877 // if (one_query_part_len > 2) {
kevman 0:38ceb79fef03 878 // return 0;
kevman 0:38ceb79fef03 879 // }
kevman 0:38ceb79fef03 880 // break;
kevman 0:38ceb79fef03 881 default:
kevman 0:38ceb79fef03 882 break; //impossible scenario currently
kevman 0:38ceb79fef03 883 }
kevman 0:38ceb79fef03 884
kevman 0:38ceb79fef03 885 /* Check if 4 bits are enough for writing Option value length */
kevman 0:38ceb79fef03 886 if (one_query_part_len <= 12) {
kevman 0:38ceb79fef03 887 /* 4 bits are enough for Option value length */
kevman 0:38ceb79fef03 888 ret_value++;
kevman 0:38ceb79fef03 889 } else if (one_query_part_len >= 13 && one_query_part_len < 269) {
kevman 0:38ceb79fef03 890 /* Extra byte for Option value length is needed */
kevman 0:38ceb79fef03 891 ret_value += 2;
kevman 0:38ceb79fef03 892 }
kevman 0:38ceb79fef03 893 //This can only happen if we are in default case above, currently is not happening
kevman 0:38ceb79fef03 894 else if (one_query_part_len >= 270 && one_query_part_len < 1034) {
kevman 0:38ceb79fef03 895 /* Extra bytes for Option value length is needed */
kevman 0:38ceb79fef03 896 ret_value += 3;
kevman 0:38ceb79fef03 897 }
kevman 0:38ceb79fef03 898
kevman 0:38ceb79fef03 899
kevman 0:38ceb79fef03 900 /* * * Length of Option value * * */
kevman 0:38ceb79fef03 901
kevman 0:38ceb79fef03 902 /* Increase options length */
kevman 0:38ceb79fef03 903 ret_value += one_query_part_len;
kevman 0:38ceb79fef03 904 }
kevman 0:38ceb79fef03 905
kevman 0:38ceb79fef03 906 /* Success */
kevman 0:38ceb79fef03 907 return ret_value;
kevman 0:38ceb79fef03 908 }
kevman 0:38ceb79fef03 909
kevman 0:38ceb79fef03 910
kevman 0:38ceb79fef03 911
kevman 0:38ceb79fef03 912 /**
kevman 0:38ceb79fef03 913 * \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)
kevman 0:38ceb79fef03 914 *
kevman 0:38ceb79fef03 915 * \brief Gets query part count from whole option string
kevman 0:38ceb79fef03 916 *
kevman 0:38ceb79fef03 917 * \param query_len is length of whole Path
kevman 0:38ceb79fef03 918 *
kevman 0:38ceb79fef03 919 * \param *query_ptr is pointer to the start of whole Path
kevman 0:38ceb79fef03 920 *
kevman 0:38ceb79fef03 921 * \return Return value is count of query parts
kevman 0:38ceb79fef03 922 */
kevman 0:38ceb79fef03 923 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)
kevman 0:38ceb79fef03 924 {
kevman 0:38ceb79fef03 925 uint8_t returned_query_count = 0;
kevman 0:38ceb79fef03 926 uint16_t query_len_index = 0;
kevman 0:38ceb79fef03 927 uint8_t char_to_search = '&';
kevman 0:38ceb79fef03 928
kevman 0:38ceb79fef03 929 if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
kevman 0:38ceb79fef03 930 char_to_search = '/';
kevman 0:38ceb79fef03 931 }
kevman 0:38ceb79fef03 932
kevman 0:38ceb79fef03 933 /* Loop whole query and search '\0' characters (not first and last char) */
kevman 0:38ceb79fef03 934 for (query_len_index = 1; query_len_index < query_len - 1; query_len_index++) {
kevman 0:38ceb79fef03 935 /* If new query part starts */
kevman 0:38ceb79fef03 936 if (*(query_ptr + query_len_index) == char_to_search) { /* If match */
kevman 0:38ceb79fef03 937 returned_query_count++;
kevman 0:38ceb79fef03 938 }
kevman 0:38ceb79fef03 939 }
kevman 0:38ceb79fef03 940
kevman 0:38ceb79fef03 941 returned_query_count++;
kevman 0:38ceb79fef03 942
kevman 0:38ceb79fef03 943 return returned_query_count;
kevman 0:38ceb79fef03 944 }
kevman 0:38ceb79fef03 945
kevman 0:38ceb79fef03 946 /**
kevman 0:38ceb79fef03 947 * \fn static uint16_t sn_coap_builder_options_get_option_part_length_from_whole_option_string(uint16_t query_len,
kevman 0:38ceb79fef03 948 uint8_t *query_ptr,
kevman 0:38ceb79fef03 949 uint8_t query_index, sn_coap_option_numbers_e option)
kevman 0:38ceb79fef03 950 *
kevman 0:38ceb79fef03 951 * \brief Gets one's query part length from whole query string
kevman 0:38ceb79fef03 952 *
kevman 0:38ceb79fef03 953 * \param query_len is length of whole string
kevman 0:38ceb79fef03 954 *
kevman 0:38ceb79fef03 955 * \param *query_ptr is pointer to the start of whole string
kevman 0:38ceb79fef03 956 *
kevman 0:38ceb79fef03 957 * \param query_index is query part index to be found
kevman 0:38ceb79fef03 958 *
kevman 0:38ceb79fef03 959 * \param sn_coap_option_numbers_e option is option number of the option
kevman 0:38ceb79fef03 960 *
kevman 0:38ceb79fef03 961 * \return Return value is length of query part
kevman 0:38ceb79fef03 962 */
kevman 0:38ceb79fef03 963 static uint16_t sn_coap_builder_options_get_option_part_length_from_whole_option_string(uint16_t query_len, uint8_t *query_ptr,
kevman 0:38ceb79fef03 964 uint8_t query_index, sn_coap_option_numbers_e option)
kevman 0:38ceb79fef03 965 {
kevman 0:38ceb79fef03 966 uint16_t returned_query_part_len = 0;
kevman 0:38ceb79fef03 967 uint8_t temp_query_index = 0;
kevman 0:38ceb79fef03 968 uint16_t query_len_index = 0;
kevman 0:38ceb79fef03 969 uint8_t char_to_search = '&';
kevman 0:38ceb79fef03 970
kevman 0:38ceb79fef03 971 if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
kevman 0:38ceb79fef03 972 char_to_search = '/';
kevman 0:38ceb79fef03 973 }
kevman 0:38ceb79fef03 974
kevman 0:38ceb79fef03 975 /* Loop whole query and search '\0' characters */
kevman 0:38ceb79fef03 976 for (query_len_index = 0; query_len_index < query_len; query_len_index++) {
kevman 0:38ceb79fef03 977 /* Store character to temp_char for helping debugging */
kevman 0:38ceb79fef03 978 uint8_t temp_char = *query_ptr;
kevman 0:38ceb79fef03 979
kevman 0:38ceb79fef03 980 /* If new query part starts */
kevman 0:38ceb79fef03 981 if (temp_char == char_to_search && returned_query_part_len > 0) { /* returned_query_part_len > 0 is for querys which start with "\0" */
kevman 0:38ceb79fef03 982 /* If query part index is wanted */
kevman 0:38ceb79fef03 983 if (temp_query_index == query_index) {
kevman 0:38ceb79fef03 984 /* Return length of query part */
kevman 0:38ceb79fef03 985 return returned_query_part_len;
kevman 0:38ceb79fef03 986 } else {
kevman 0:38ceb79fef03 987 /* Reset length of query part because wanted query part finding continues*/
kevman 0:38ceb79fef03 988 returned_query_part_len = 0;
kevman 0:38ceb79fef03 989 }
kevman 0:38ceb79fef03 990
kevman 0:38ceb79fef03 991 /* Next query part is looped */
kevman 0:38ceb79fef03 992 temp_query_index++;
kevman 0:38ceb79fef03 993 } else if (temp_char != char_to_search) { /* Else if query part continues */
kevman 0:38ceb79fef03 994 /* Increase query part length */
kevman 0:38ceb79fef03 995 returned_query_part_len++;
kevman 0:38ceb79fef03 996 }
kevman 0:38ceb79fef03 997
kevman 0:38ceb79fef03 998 query_ptr++;
kevman 0:38ceb79fef03 999 }
kevman 0:38ceb79fef03 1000
kevman 0:38ceb79fef03 1001 /* Return length of query part in cases that query part does not finish to '\0' character (last query part can be like that) */
kevman 0:38ceb79fef03 1002 return returned_query_part_len;
kevman 0:38ceb79fef03 1003 }
kevman 0:38ceb79fef03 1004
kevman 0:38ceb79fef03 1005 /**
kevman 0:38ceb79fef03 1006 * \fn static uint16_t sn_coap_builder_options_get_option_part_position(uint16_t query_len,
kevman 0:38ceb79fef03 1007 uint8_t *query_ptr,
kevman 0:38ceb79fef03 1008 uint8_t query_index, sn_coap_option_numbers_e option)
kevman 0:38ceb79fef03 1009 *
kevman 0:38ceb79fef03 1010 * \brief Gets query part position in whole query
kevman 0:38ceb79fef03 1011 *
kevman 0:38ceb79fef03 1012 * \param query_len is length of whole query
kevman 0:38ceb79fef03 1013 *
kevman 0:38ceb79fef03 1014 * \param *query_ptr is pointer to the start of whole query
kevman 0:38ceb79fef03 1015 *
kevman 0:38ceb79fef03 1016 * \param query_index is query part index to be found
kevman 0:38ceb79fef03 1017 *
kevman 0:38ceb79fef03 1018 * \return Return value is position (= offset) of query part in whole query. In
kevman 0:38ceb79fef03 1019 * fail cases -1 is returned.
kevman 0:38ceb79fef03 1020 */
kevman 0:38ceb79fef03 1021 static int16_t sn_coap_builder_options_get_option_part_position(uint16_t query_len, uint8_t *query_ptr,
kevman 0:38ceb79fef03 1022 uint8_t query_index, sn_coap_option_numbers_e option)
kevman 0:38ceb79fef03 1023 {
kevman 0:38ceb79fef03 1024 uint16_t returned_query_part_offset = 0;
kevman 0:38ceb79fef03 1025 uint8_t temp_query_index = 0;
kevman 0:38ceb79fef03 1026 uint16_t query_len_index = 0;
kevman 0:38ceb79fef03 1027 uint8_t char_to_search = '&';
kevman 0:38ceb79fef03 1028
kevman 0:38ceb79fef03 1029 if (option == COAP_OPTION_URI_PATH || option == COAP_OPTION_LOCATION_PATH) {
kevman 0:38ceb79fef03 1030 char_to_search = '/';
kevman 0:38ceb79fef03 1031 }
kevman 0:38ceb79fef03 1032
kevman 0:38ceb79fef03 1033 if (query_index == 0) {
kevman 0:38ceb79fef03 1034 if (*query_ptr == 0 || *query_ptr == char_to_search) {
kevman 0:38ceb79fef03 1035 return 1;
kevman 0:38ceb79fef03 1036 } else {
kevman 0:38ceb79fef03 1037 return 0;
kevman 0:38ceb79fef03 1038 }
kevman 0:38ceb79fef03 1039 }
kevman 0:38ceb79fef03 1040
kevman 0:38ceb79fef03 1041 /* Loop whole query and search separator characters */
kevman 0:38ceb79fef03 1042 for (query_len_index = 0; query_len_index < query_len; query_len_index++) {
kevman 0:38ceb79fef03 1043 /* Store character to temp_char for helping debugging */
kevman 0:38ceb79fef03 1044 uint8_t temp_char = *query_ptr;
kevman 0:38ceb79fef03 1045
kevman 0:38ceb79fef03 1046 /* If new query part starts */
kevman 0:38ceb79fef03 1047 if (temp_char == char_to_search && returned_query_part_offset > 0) { /* returned_query_part_offset > 0 is for querys which start with searched char */
kevman 0:38ceb79fef03 1048 /* If query part index is wanted */
kevman 0:38ceb79fef03 1049 if (temp_query_index == (query_index - 1)) {
kevman 0:38ceb79fef03 1050 /* Return offset of query part */
kevman 0:38ceb79fef03 1051 return (returned_query_part_offset + 1); /* Plus one is for passing separator */
kevman 0:38ceb79fef03 1052 }
kevman 0:38ceb79fef03 1053
kevman 0:38ceb79fef03 1054 /* Next query part is looped */
kevman 0:38ceb79fef03 1055 temp_query_index++;
kevman 0:38ceb79fef03 1056 }
kevman 0:38ceb79fef03 1057
kevman 0:38ceb79fef03 1058 returned_query_part_offset++;
kevman 0:38ceb79fef03 1059
kevman 0:38ceb79fef03 1060 query_ptr++;
kevman 0:38ceb79fef03 1061 }
kevman 0:38ceb79fef03 1062
kevman 0:38ceb79fef03 1063 return -1; //Dead code?
kevman 0:38ceb79fef03 1064 }
kevman 0:38ceb79fef03 1065
kevman 0:38ceb79fef03 1066
kevman 0:38ceb79fef03 1067 /**
kevman 0:38ceb79fef03 1068 * \fn static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 1069 *
kevman 0:38ceb79fef03 1070 * \brief Builds Options part of Packet data
kevman 0:38ceb79fef03 1071 *
kevman 0:38ceb79fef03 1072 * \param **dst_packet_data_pptr is destination for built Packet data
kevman 0:38ceb79fef03 1073 *
kevman 0:38ceb79fef03 1074 * \param *src_coap_msg_ptr is source for building Packet data
kevman 0:38ceb79fef03 1075 */
kevman 0:38ceb79fef03 1076 static void sn_coap_builder_payload_build(uint8_t **dst_packet_data_pptr, sn_coap_hdr_s *src_coap_msg_ptr)
kevman 0:38ceb79fef03 1077 {
kevman 0:38ceb79fef03 1078 /* Check if Payload is used at all */
kevman 0:38ceb79fef03 1079 if (src_coap_msg_ptr->payload_len && src_coap_msg_ptr->payload_ptr != NULL) {
kevman 0:38ceb79fef03 1080 /* Write Payload marker */
kevman 0:38ceb79fef03 1081
kevman 0:38ceb79fef03 1082 **dst_packet_data_pptr = 0xff;
kevman 0:38ceb79fef03 1083 (*dst_packet_data_pptr)++;
kevman 0:38ceb79fef03 1084
kevman 0:38ceb79fef03 1085 /* Write Payload */
kevman 0:38ceb79fef03 1086 memcpy(*dst_packet_data_pptr, src_coap_msg_ptr->payload_ptr, src_coap_msg_ptr->payload_len);
kevman 0:38ceb79fef03 1087
kevman 0:38ceb79fef03 1088 /* Increase destination Packet data pointer */
kevman 0:38ceb79fef03 1089 (*dst_packet_data_pptr) += src_coap_msg_ptr->payload_len;
kevman 0:38ceb79fef03 1090 }
kevman 0:38ceb79fef03 1091 }