1 /* 2 * Copyright (C) 2018 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef __MESH_ACCESS_H 39 #define __MESH_ACCESS_H 40 41 #include <stdint.h> 42 #include <stdarg.h> 43 44 #include "bluetooth_company_id.h" 45 #include "btstack_linked_list.h" 46 47 #include "mesh/mesh_lower_transport.h" 48 #include "mesh/mesh_keys.h" 49 #include "mesh/mesh_node.h" 50 51 #ifdef __cplusplus 52 extern "C" 53 { 54 #endif 55 56 #define MESH_SEQUENCE_NUMBER_STORAGE_INTERVAL 1000 57 58 typedef enum { 59 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_100ms = 0x00u, 60 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_1s, 61 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10s, 62 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10min 63 } mesh_default_transition_step_resolution_t; 64 65 typedef enum { 66 MODEL_STATE_UPDATE_REASON_SET = 0x00u, 67 MODEL_STATE_UPDATE_REASON_TRANSITION_START, 68 MODEL_STATE_UPDATE_REASON_TRANSITION_ACTIVE, 69 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 70 MODEL_STATE_UPDATE_REASON_TRANSITION_ABORT, 71 // MODEL_STATE_UPDATE_REASON_BOUND_STATE, 72 MODEL_STATE_UPDATE_REASON_APPLICATION_CHANGE 73 } model_state_update_reason_t; 74 75 typedef enum { 76 TRANSITION_START, 77 TRANSITION_UPDATE 78 } transition_event_t; 79 80 typedef enum { 81 MESH_TRANSITION_STATE_IDLE, 82 MESH_TRANSITION_STATE_DELAYED, 83 MESH_TRANSITION_STATE_ACTIVE 84 } mesh_transition_state_t; 85 86 typedef enum { 87 MODEL_STATE_ID_GENERIC_ON_OFF = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 0u, 88 MODEL_STATE_ID_GENERIC_LEVEL = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 1u, 89 } model_state_id_t; 90 91 #define MESH_MAX_NUM_FAULTS 5 92 93 #define MESH_TRANSITION_NUM_STEPS_INFINITE 0x3f 94 95 typedef struct { 96 // linked list item 97 btstack_linked_item_t item; 98 uint8_t test_id; 99 uint16_t company_id; 100 uint16_t num_current_faults; 101 uint16_t num_registered_faults; 102 uint8_t current_faults[MESH_MAX_NUM_FAULTS]; 103 uint8_t registered_faults[MESH_MAX_NUM_FAULTS]; 104 } mesh_health_fault_t; 105 106 typedef struct { 107 // linked list of mesh_health_fault items 108 btstack_linked_list_t faults; 109 uint8_t fast_period_divisor; 110 } mesh_health_state_t; 111 112 typedef struct { 113 uint32_t opcode; 114 uint8_t * data; 115 uint16_t len; 116 } mesh_access_parser_state_t; 117 118 typedef struct { 119 uint32_t opcode; 120 const char * format; 121 } mesh_access_message_t; 122 123 typedef enum { 124 MESH_TRANSACTION_STATUS_NEW = 0, 125 MESH_TRANSACTION_STATUS_RETRANSMISSION, 126 MESH_TRANSACTION_STATUS_DIFFERENT_DST_OR_SRC 127 } mesh_transaction_status_t; 128 129 typedef struct mesh_transition { 130 btstack_linked_item_t item; 131 btstack_timer_source_t timer; 132 133 mesh_transition_state_t state; 134 135 uint8_t transaction_identifier; 136 uint32_t transaction_timestamp_ms; 137 uint16_t src_address; 138 uint16_t dst_address; 139 140 uint8_t num_steps; 141 142 uint32_t step_duration_ms; 143 uint32_t phase_start_ms; 144 uint32_t remaining_delay_time_ms; 145 uint32_t remaining_transition_time_ms; 146 // to send events and/or publish changes 147 mesh_model_t * mesh_model; 148 149 // to execute transition 150 void (* transition_callback)(struct mesh_transition * transition, transition_event_t event, uint32_t current_timestamp); 151 } mesh_transition_t; 152 153 /** 154 * @brief Init access layer 155 */ 156 void mesh_access_init(void); 157 158 /** 159 * @brief Inform access layer that access message was processed by higher layer 160 * @param pdu 161 */ 162 void mesh_access_message_processed(mesh_pdu_t * pdu); 163 164 /** 165 * @brief Get number of retransmissions used by default 166 */ 167 uint8_t mesh_access_acknowledged_message_retransmissions(void); 168 169 /** 170 * @brief Get retransmission timeout 171 */ 172 uint32_t mesh_access_acknowledged_message_timeout_ms(void); 173 174 /** 175 * @brief Send unacknowledged message 176 * @param pdu 177 */ 178 void mesh_access_send_unacknowledged_pdu(mesh_pdu_t * pdu); 179 180 /** 181 * @brief Send acknowledged message. Retransmits message if no acknowledgement with expected opcode is received 182 * @param pdu 183 * @param retransmissions 184 * @param ack_opcode opcode of acknowledgement 185 */ 186 void mesh_access_send_acknowledged_pdu(mesh_pdu_t * pdu, uint8_t retransmissions, uint32_t ack_opcode); 187 188 uint32_t mesh_access_transitions_step_ms_from_gdtt(uint8_t time_gdtt); 189 uint8_t mesh_access_transitions_num_steps_from_gdtt(uint8_t time_gdtt); 190 uint32_t mesh_access_time_gdtt2ms(uint8_t time_gdtt); 191 uint8_t mesh_access_time_as_gdtt(uint32_t step_resolution_ms, uint32_t time_ms); 192 193 void mesh_access_emit_state_update_bool(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 194 model_state_id_t state_identifier, model_state_update_reason_t reason, uint8_t value); 195 void mesh_access_emit_state_update_int16(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 196 model_state_id_t state_identifier, model_state_update_reason_t reason, int16_t value); 197 198 // Mesh Model Transitions 199 void mesh_access_transitions_setup_transaction(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 200 void mesh_access_transitions_abort_transaction(mesh_transition_t * transition); 201 mesh_transaction_status_t mesh_access_transitions_transaction_status(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 202 203 void mesh_access_transitions_setup(mesh_transition_t * transition, mesh_model_t * mesh_model, 204 uint8_t transition_time_gdtt, uint8_t delay_gdtt, 205 void (* transition_callback)(struct mesh_transition * transition, transition_event_t event, uint32_t current_timestamp)); 206 207 void mesh_access_transitions_add(mesh_transition_t * transition); 208 void mesh_access_transitions_remove(mesh_transition_t * transition); 209 uint8_t mesh_access_transactions_get_next_transaction_id(void); 210 211 // Mesh Model Publicaation 212 213 /** 214 * Inform Mesh Access that the state of a model has changed. may trigger state publication 215 * @param mesh_model 216 */ 217 void mesh_access_state_changed(mesh_model_t * mesh_model); 218 219 /** 220 * Start Model Publication 221 * @param mesh_model 222 */ 223 void mesh_model_publication_start(mesh_model_t * mesh_model); 224 225 /** 226 * Stop Model Publication 227 * @param mesh_model 228 */ 229 void mesh_model_publication_stop(mesh_model_t * mesh_model); 230 231 // Mesh PDU Getter 232 uint16_t mesh_pdu_ctl(mesh_pdu_t * pdu); 233 uint16_t mesh_pdu_ttl(mesh_pdu_t * pdu); 234 uint16_t mesh_pdu_src(mesh_pdu_t * pdu); 235 uint16_t mesh_pdu_dst(mesh_pdu_t * pdu); 236 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu); 237 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu); 238 uint16_t mesh_pdu_len(mesh_pdu_t * pdu); 239 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu); 240 uint8_t mesh_pdu_control_opcode(mesh_pdu_t * pdu); 241 242 // Mesh Access Parser 243 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size); 244 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu); 245 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip); 246 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state); 247 uint8_t mesh_access_parser_get_u8(mesh_access_parser_state_t * state); 248 uint16_t mesh_access_parser_get_u16(mesh_access_parser_state_t * state); 249 uint32_t mesh_access_parser_get_u24(mesh_access_parser_state_t * state); 250 uint32_t mesh_access_parser_get_u32(mesh_access_parser_state_t * state); 251 void mesh_access_parser_get_u128(mesh_access_parser_state_t * state, uint8_t * dest); 252 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest); 253 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest); 254 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser); 255 256 // message builder transport 257 mesh_transport_pdu_t * mesh_access_transport_init(uint32_t opcode); 258 void mesh_access_transport_add_uint8(mesh_transport_pdu_t * pdu, uint8_t value); 259 void mesh_access_transport_add_uint16(mesh_transport_pdu_t * pdu, uint16_t value); 260 void mesh_access_transport_add_uint24(mesh_transport_pdu_t * pdu, uint32_t value); 261 void mesh_access_transport_add_uint32(mesh_transport_pdu_t * pdu, uint32_t value); 262 void mesh_access_transport_add_model_identifier(mesh_transport_pdu_t * pdu, uint32_t model_identifier); 263 264 // message builder network 265 mesh_network_pdu_t * mesh_access_network_init(uint32_t opcode); 266 void mesh_access_network_add_uint8(mesh_network_pdu_t * pdu, uint8_t value); 267 void mesh_access_network_add_uint16(mesh_network_pdu_t * pdu, uint16_t value); 268 void mesh_access_network_add_uint24(mesh_network_pdu_t * pdu, uint16_t value); 269 void mesh_access_network_add_uint32(mesh_network_pdu_t * pdu, uint16_t value); 270 void mesh_access_network_add_model_identifier(mesh_network_pdu_t * pdu, uint32_t model_identifier); 271 272 // message builder using template 273 mesh_network_pdu_t * mesh_access_setup_unsegmented_message(const mesh_access_message_t *message_template, ...); 274 mesh_transport_pdu_t * mesh_access_setup_segmented_message(const mesh_access_message_t *message_template, ...); 275 276 #ifdef __cplusplus 277 } /* end of extern "C" */ 278 #endif 279 280 #endif 281