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 "btstack_bool.h" 45 #include "bluetooth_company_id.h" 46 #include "btstack_linked_list.h" 47 48 #include "mesh/mesh_lower_transport.h" 49 #include "mesh/mesh_keys.h" 50 #include "mesh/mesh_node.h" 51 52 #ifdef __cplusplus 53 extern "C" 54 { 55 #endif 56 57 #define MESH_SEQUENCE_NUMBER_STORAGE_INTERVAL 1000 58 59 typedef enum { 60 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_100ms = 0x00u, 61 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_1s, 62 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10s, 63 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10min 64 } mesh_default_transition_step_resolution_t; 65 66 typedef enum { 67 MODEL_STATE_UPDATE_REASON_SET = 0x00u, 68 MODEL_STATE_UPDATE_REASON_TRANSITION_START, 69 MODEL_STATE_UPDATE_REASON_TRANSITION_ACTIVE, 70 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 71 MODEL_STATE_UPDATE_REASON_TRANSITION_ABORT, 72 // MODEL_STATE_UPDATE_REASON_BOUND_STATE, 73 MODEL_STATE_UPDATE_REASON_APPLICATION_CHANGE 74 } model_state_update_reason_t; 75 76 typedef enum { 77 TRANSITION_START, 78 TRANSITION_UPDATE 79 } transition_event_t; 80 81 typedef enum { 82 MESH_TRANSITION_STATE_IDLE, 83 MESH_TRANSITION_STATE_DELAYED, 84 MESH_TRANSITION_STATE_ACTIVE 85 } mesh_transition_state_t; 86 87 typedef enum { 88 MODEL_STATE_ID_GENERIC_ON_OFF = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 0u, 89 MODEL_STATE_ID_GENERIC_LEVEL = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 1u, 90 } model_state_id_t; 91 92 #define MESH_MAX_NUM_FAULTS 5 93 94 #define MESH_TRANSITION_NUM_STEPS_INFINITE 0x3f 95 96 typedef struct { 97 // linked list item 98 btstack_linked_item_t item; 99 uint8_t test_id; 100 uint16_t company_id; 101 uint16_t num_current_faults; 102 uint16_t num_registered_faults; 103 uint8_t current_faults[MESH_MAX_NUM_FAULTS]; 104 uint8_t registered_faults[MESH_MAX_NUM_FAULTS]; 105 } mesh_health_fault_t; 106 107 typedef struct { 108 // linked list of mesh_health_fault items 109 btstack_linked_list_t faults; 110 uint8_t fast_period_divisor; 111 } mesh_health_state_t; 112 113 typedef struct { 114 uint32_t opcode; 115 uint8_t * data; 116 uint16_t len; 117 } mesh_access_parser_state_t; 118 119 typedef struct { 120 uint32_t opcode; 121 const char * format; 122 } mesh_access_message_t; 123 124 typedef enum { 125 MESH_TRANSACTION_STATUS_NEW = 0, 126 MESH_TRANSACTION_STATUS_RETRANSMISSION, 127 MESH_TRANSACTION_STATUS_DIFFERENT_DST_OR_SRC 128 } mesh_transaction_status_t; 129 130 typedef struct mesh_transition { 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 mesh_default_transition_step_resolution_t step_resolution; 142 uint32_t step_duration_ms; 143 144 // to send events and/or publish changes 145 mesh_model_t * mesh_model; 146 147 // to execute transition 148 void (* transition_callback)(struct mesh_transition * transition, model_state_update_reason_t event); 149 } mesh_transition_t; 150 151 /** 152 * @brief Init access layer 153 */ 154 void mesh_access_init(void); 155 156 /** 157 * @brief Inform access layer that access message was processed by higher layer 158 * @param pdu 159 */ 160 void mesh_access_message_processed(mesh_pdu_t * pdu); 161 162 /** 163 * @brief Get number of retransmissions used by default 164 */ 165 uint8_t mesh_access_acknowledged_message_retransmissions(void); 166 167 /** 168 * @brief Get retransmission timeout 169 */ 170 uint32_t mesh_access_acknowledged_message_timeout_ms(void); 171 172 /** 173 * @brief Send unacknowledged message 174 * @param pdu 175 */ 176 void mesh_access_send_unacknowledged_pdu(mesh_pdu_t * pdu); 177 178 /** 179 * @brief Send acknowledged message. Retransmits message if no acknowledgement with expected opcode is received 180 * @param pdu 181 * @param retransmissions 182 * @param ack_opcode opcode of acknowledgement 183 */ 184 void mesh_access_send_acknowledged_pdu(mesh_pdu_t * pdu, uint8_t retransmissions, uint32_t ack_opcode); 185 186 187 // Mesh Model Transitions 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 void mesh_access_transitions_init_transaction(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 192 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)); 193 void mesh_access_transitions_abort_transaction(mesh_transition_t * transition); 194 uint8_t mesh_access_transactions_get_next_transaction_id(void); 195 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); 196 197 void mesh_access_emit_state_update_bool(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 198 model_state_id_t state_identifier, model_state_update_reason_t reason, uint8_t value); 199 200 void mesh_access_emit_state_update_int16(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 201 model_state_id_t state_identifier, model_state_update_reason_t reason, int16_t value); 202 203 // Mesh Model Publicaation 204 205 /** 206 * Inform Mesh Access that the state of a model has changed. may trigger state publication 207 * @param mesh_model 208 */ 209 void mesh_access_state_changed(mesh_model_t * mesh_model); 210 211 /** 212 * Start Model Publication 213 * @param mesh_model 214 */ 215 void mesh_model_publication_start(mesh_model_t * mesh_model); 216 217 /** 218 * Stop Model Publication 219 * @param mesh_model 220 */ 221 void mesh_model_publication_stop(mesh_model_t * mesh_model); 222 223 // Mesh PDU Getter 224 uint16_t mesh_pdu_ctl(mesh_pdu_t * pdu); 225 uint16_t mesh_pdu_ttl(mesh_pdu_t * pdu); 226 uint16_t mesh_pdu_src(mesh_pdu_t * pdu); 227 uint16_t mesh_pdu_dst(mesh_pdu_t * pdu); 228 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu); 229 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu); 230 uint16_t mesh_pdu_len(mesh_pdu_t * pdu); 231 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu); 232 uint8_t mesh_pdu_control_opcode(mesh_pdu_t * pdu); 233 234 // Mesh Access Parser 235 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size); 236 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu); 237 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip); 238 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state); 239 uint8_t mesh_access_parser_get_uint8(mesh_access_parser_state_t * state); 240 uint16_t mesh_access_parser_get_uint16(mesh_access_parser_state_t * state); 241 uint32_t mesh_access_parser_get_uint24(mesh_access_parser_state_t * state); 242 uint32_t mesh_access_parser_get_uint32(mesh_access_parser_state_t * state); 243 void mesh_access_parser_get_uint128(mesh_access_parser_state_t * state, uint8_t * dest); 244 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest); 245 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest); 246 uint32_t mesh_access_parser_get_sig_model_identifier(mesh_access_parser_state_t * parser); 247 uint32_t mesh_access_parser_get_vendor_model_identifier(mesh_access_parser_state_t * parser); 248 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser); 249 250 mesh_upper_transport_pdu_t * mesh_access_message_init(uint32_t opcode); 251 bool mesh_access_message_add_data(mesh_upper_transport_pdu_t * pdu, const uint8_t * data, uint16_t data_len); 252 bool mesh_access_message_add_uint8(mesh_upper_transport_pdu_t * pdu, uint8_t value); 253 bool mesh_access_message_add_uint16(mesh_upper_transport_pdu_t * pdu, uint16_t value); 254 bool mesh_access_message_add_uint24(mesh_upper_transport_pdu_t * pdu, uint16_t value); 255 bool mesh_access_message_add_uint32(mesh_upper_transport_pdu_t * pdu, uint16_t value); 256 bool mesh_access_message_add_model_identifier(mesh_upper_transport_pdu_t * pdu, uint32_t model_identifier); 257 258 // message builder using template 259 mesh_upper_transport_pdu_t * mesh_access_setup_message(const mesh_access_message_t *message_template, ...); 260 261 #ifdef __cplusplus 262 } /* end of extern "C" */ 263 #endif 264 265 #endif 266