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_timer_source_t timer; 131 132 mesh_transition_state_t state; 133 134 uint8_t transaction_identifier; 135 uint32_t transaction_timestamp_ms; 136 uint16_t src_address; 137 uint16_t dst_address; 138 139 uint8_t num_steps; 140 mesh_default_transition_step_resolution_t step_resolution; 141 uint32_t step_duration_ms; 142 143 // to send events and/or publish changes 144 mesh_model_t * mesh_model; 145 146 // to execute transition 147 void (* transition_callback)(struct mesh_transition * transition, model_state_update_reason_t event); 148 } mesh_transition_t; 149 150 /** 151 * @brief Init access layer 152 */ 153 void mesh_access_init(void); 154 155 /** 156 * @brief Inform access layer that access message was processed by higher layer 157 * @param pdu 158 */ 159 void mesh_access_message_processed(mesh_pdu_t * pdu); 160 161 /** 162 * @brief Get number of retransmissions used by default 163 */ 164 uint8_t mesh_access_acknowledged_message_retransmissions(void); 165 166 /** 167 * @brief Get retransmission timeout 168 */ 169 uint32_t mesh_access_acknowledged_message_timeout_ms(void); 170 171 /** 172 * @brief Send unacknowledged message 173 * @param pdu 174 */ 175 void mesh_access_send_unacknowledged_pdu(mesh_pdu_t * pdu); 176 177 /** 178 * @brief Send acknowledged message. Retransmits message if no acknowledgement with expected opcode is received 179 * @param pdu 180 * @param retransmissions 181 * @param ack_opcode opcode of acknowledgement 182 */ 183 void mesh_access_send_acknowledged_pdu(mesh_pdu_t * pdu, uint8_t retransmissions, uint32_t ack_opcode); 184 185 186 // Mesh Model Transitions 187 uint32_t mesh_access_transitions_step_ms_from_gdtt(uint8_t time_gdtt); 188 uint8_t mesh_access_transitions_num_steps_from_gdtt(uint8_t time_gdtt); 189 uint32_t mesh_access_time_gdtt2ms(uint8_t time_gdtt); 190 void mesh_access_transitions_init_transaction(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 191 void mesh_access_transition_setup(mesh_model_t *mesh_model, mesh_transition_t * base_transition, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, void (*transition_callback)(mesh_transition_t * base_transition, model_state_update_reason_t event)); 192 void mesh_access_transitions_abort_transaction(mesh_transition_t * transition); 193 uint8_t mesh_access_transactions_get_next_transaction_id(void); 194 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); 195 196 void mesh_access_emit_state_update_bool(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 197 model_state_id_t state_identifier, model_state_update_reason_t reason, uint8_t value); 198 199 void mesh_access_emit_state_update_int16(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 200 model_state_id_t state_identifier, model_state_update_reason_t reason, int16_t value); 201 202 // Mesh Model Publicaation 203 204 /** 205 * Inform Mesh Access that the state of a model has changed. may trigger state publication 206 * @param mesh_model 207 */ 208 void mesh_access_state_changed(mesh_model_t * mesh_model); 209 210 /** 211 * Start Model Publication 212 * @param mesh_model 213 */ 214 void mesh_model_publication_start(mesh_model_t * mesh_model); 215 216 /** 217 * Stop Model Publication 218 * @param mesh_model 219 */ 220 void mesh_model_publication_stop(mesh_model_t * mesh_model); 221 222 // Mesh PDU Getter 223 uint16_t mesh_pdu_ctl(mesh_pdu_t * pdu); 224 uint16_t mesh_pdu_ttl(mesh_pdu_t * pdu); 225 uint16_t mesh_pdu_src(mesh_pdu_t * pdu); 226 uint16_t mesh_pdu_dst(mesh_pdu_t * pdu); 227 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu); 228 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu); 229 uint16_t mesh_pdu_len(mesh_pdu_t * pdu); 230 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu); 231 uint8_t mesh_pdu_control_opcode(mesh_pdu_t * pdu); 232 233 // Mesh Access Parser 234 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size); 235 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu); 236 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip); 237 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state); 238 uint8_t mesh_access_parser_get_u8(mesh_access_parser_state_t * state); 239 uint16_t mesh_access_parser_get_u16(mesh_access_parser_state_t * state); 240 uint32_t mesh_access_parser_get_u24(mesh_access_parser_state_t * state); 241 uint32_t mesh_access_parser_get_u32(mesh_access_parser_state_t * state); 242 void mesh_access_parser_get_u128(mesh_access_parser_state_t * state, uint8_t * dest); 243 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest); 244 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest); 245 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser); 246 247 // message builder transport 248 mesh_transport_pdu_t * mesh_access_transport_init(uint32_t opcode); 249 void mesh_access_transport_add_uint8(mesh_transport_pdu_t * pdu, uint8_t value); 250 void mesh_access_transport_add_uint16(mesh_transport_pdu_t * pdu, uint16_t value); 251 void mesh_access_transport_add_uint24(mesh_transport_pdu_t * pdu, uint32_t value); 252 void mesh_access_transport_add_uint32(mesh_transport_pdu_t * pdu, uint32_t value); 253 void mesh_access_transport_add_model_identifier(mesh_transport_pdu_t * pdu, uint32_t model_identifier); 254 void mesh_access_transport_add_label_uuid(mesh_transport_pdu_t * pdu, uint8_t * value); 255 256 // message builder network 257 mesh_network_pdu_t * mesh_access_network_init(uint32_t opcode); 258 void mesh_access_network_add_uint8(mesh_network_pdu_t * pdu, uint8_t value); 259 void mesh_access_network_add_uint16(mesh_network_pdu_t * pdu, uint16_t value); 260 void mesh_access_network_add_uint24(mesh_network_pdu_t * pdu, uint16_t value); 261 void mesh_access_network_add_uint32(mesh_network_pdu_t * pdu, uint16_t value); 262 void mesh_access_network_add_model_identifier(mesh_network_pdu_t * pdu, uint32_t model_identifier); 263 264 // message builder using template 265 mesh_network_pdu_t * mesh_access_setup_unsegmented_message(const mesh_access_message_t *message_template, ...); 266 mesh_transport_pdu_t * mesh_access_setup_segmented_message(const mesh_access_message_t *message_template, ...); 267 268 #ifdef __cplusplus 269 } /* end of extern "C" */ 270 #endif 271 272 #endif 273