serial_evt.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */



#ifndef SERIAL_EVT_H
#define SERIAL_EVT_H

#include <stdint.h>
#include "serial_cmd_rsp.h"
#include "nrf_mesh_serial.h"
#include "serial_types.h"
#include "internal_event.h"
#include "packet.h"

#define SERIAL_OPCODE_EVT_CMD_RSP (0x84) 
#define SERIAL_OPCODE_EVT_DEVICE_STARTED (0x81) 
#define SERIAL_OPCODE_EVT_DEVICE_ECHO_RSP (0x82) 
#define SERIAL_OPCODE_EVT_DEVICE_INTERNAL_EVENT (0x83) 
#define SERIAL_OPCODE_EVT_APPLICATION (0x8A) 
#define SERIAL_OPCODE_EVT_SAR_START (0x8B) 
#define SERIAL_OPCODE_EVT_SAR_CONTINUE (0x8C) 
#define SERIAL_OPCODE_EVT_DFU_REQ_RELAY (0xA0) 
#define SERIAL_OPCODE_EVT_DFU_REQ_SOURCE (0xA1) 
#define SERIAL_OPCODE_EVT_DFU_START (0xA2) 
#define SERIAL_OPCODE_EVT_DFU_END (0xA3) 
#define SERIAL_OPCODE_EVT_DFU_BANK_AVAILABLE (0xA4) 
#define SERIAL_OPCODE_EVT_DFU_FIRMWARE_OUTDATED (0xA5) 
#define SERIAL_OPCODE_EVT_DFU_FIRMWARE_OUTDATED_NO_AUTH (0xA6) 
#define SERIAL_OPCODE_EVT_OPENMESH_NEW (0xB3) 
#define SERIAL_OPCODE_EVT_OPENMESH_UPDATE (0xB4) 
#define SERIAL_OPCODE_EVT_OPENMESH_CONFLICTING (0xB5) 
#define SERIAL_OPCODE_EVT_OPENMESH_TX (0xB6) 
#define SERIAL_OPCODE_EVT_PROV_UNPROVISIONED_RECEIVED (0xC0) 
#define SERIAL_OPCODE_EVT_PROV_LINK_ESTABLISHED (0xC1) 
#define SERIAL_OPCODE_EVT_PROV_LINK_CLOSED (0xC2) 
#define SERIAL_OPCODE_EVT_PROV_CAPS_RECEIVED (0xC3) 
#define SERIAL_OPCODE_EVT_PROV_INVITE_RECEIVED (0xC4) 
#define SERIAL_OPCODE_EVT_PROV_COMPLETE (0xC5) 
#define SERIAL_OPCODE_EVT_PROV_AUTH_REQUEST (0xC6) 
#define SERIAL_OPCODE_EVT_PROV_ECDH_REQUEST (0xC7) 
#define SERIAL_OPCODE_EVT_PROV_OUTPUT_REQUEST (0xC8) 
#define SERIAL_OPCODE_EVT_PROV_FAILED (0xC9) 
#define SERIAL_OPCODE_EVT_PROV_START_RECEIVED (0xCA) 
#define SERIAL_OPCODE_EVT_MESH_MESSAGE_RECEIVED_UNICAST (0xD0) 
#define SERIAL_OPCODE_EVT_MESH_MESSAGE_RECEIVED_SUBSCRIPTION (0xD1) 
#define SERIAL_OPCODE_EVT_MESH_TX_COMPLETE (0xD2) 
#define SERIAL_OPCODE_EVT_MESH_IV_UPDATE_NOTIFICATION (0xD3) 
#define SERIAL_OPCODE_EVT_MESH_KEY_REFRESH_NOTIFICATION (0xD4) 
#define SERIAL_OPCODE_EVT_MESH_SAR_FAILED (0xD7) 
#define SERIAL_OPCODE_EVT_MESH_HEARTBEAT_RECEIVED (0xD8) 
#define SERIAL_OPCODE_EVT_MESH_IV_ENTRY_SET_NOTIFICATION (0xD9) 
#define SERIAL_OPCODE_EVT_MESH_SEQNUM_ENTRY_SET_NOTIFICATION (0xDA) 
#define SERIAL_OPCODE_EVT_MODEL_SPECIFIC (0xF0) 
/*lint -align_max(push) -align_max(1) */

typedef struct __attribute((packed))
{
 uint8_t operating_mode; 
 uint8_t hw_error; 
 uint8_t data_credit_available; 
} serial_evt_device_started_t;

typedef struct __attribute((packed))
{
 uint8_t data[NRF_MESH_SERIAL_PAYLOAD_MAXLEN]; 
} serial_evt_device_echo_t;

typedef struct __attribute((packed))
{
 uint8_t event_type; 
 uint8_t state; 
 uint8_t packet_size; 
 uint8_t packet[BLE_ADV_PACKET_PAYLOAD_MAX_LENGTH]; 
} serial_evt_device_internal_event_t;

typedef union __attribute((packed))
{
 serial_evt_device_started_t started; 
 serial_evt_device_echo_t echo;
 serial_evt_device_internal_event_t internal_event; 
} serial_evt_device_t;

typedef struct __attribute((packed))
{
 uint8_t uuid[NRF_MESH_UUID_SIZE]; 
 int8_t rssi; 
 uint8_t gatt_supported; 
 uint8_t adv_addr_type; 
 uint8_t adv_addr[BLE_GAP_ADDR_LEN]; 
} serial_evt_prov_unprov_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
} serial_evt_prov_link_established_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t close_reason; 
} serial_evt_prov_link_closed_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t num_elements; 
 uint8_t public_key_type; 
 uint8_t static_oob_types; 
 uint8_t output_oob_size; 
 uint16_t output_oob_actions; 
 uint8_t input_oob_size; 
 uint16_t input_oob_actions; 
} serial_evt_prov_caps_received_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t attention_duration_s; 
} serial_evt_prov_invite_received_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
} serial_evt_prov_start_received_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint32_t iv_index; 
 uint16_t net_key_index; 
 uint16_t address; 
 uint8_t iv_update_flag; 
 uint8_t key_refresh_flag; 
 uint8_t device_key[NRF_MESH_KEY_SIZE]; 
 uint8_t net_key[NRF_MESH_KEY_SIZE]; 
} serial_evt_prov_complete_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t method; 
 uint8_t action; 
 uint8_t size; 
} serial_evt_prov_auth_request_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t peer_public[NRF_MESH_ECDH_PUBLIC_KEY_SIZE]; 
 uint8_t node_private[NRF_MESH_ECDH_PRIVATE_KEY_SIZE]; 
} serial_evt_prov_ecdh_request_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t output_action; 
 uint8_t data[16]; 
} serial_evt_prov_output_request_t;

typedef struct __attribute((packed))
{
 uint8_t context_id; 
 uint8_t error_code; 
} serial_evt_prov_failed_t;
typedef union __attribute((packed))
{
 serial_evt_prov_unprov_t unprov; 
 serial_evt_prov_link_established_t link_established; 
 serial_evt_prov_link_closed_t link_closed; 
 serial_evt_prov_caps_received_t caps_received; 
 serial_evt_prov_invite_received_t invite_received; 
 serial_evt_prov_start_received_t start_received; 
 serial_evt_prov_complete_t complete; 
 serial_evt_prov_auth_request_t auth_request; 
 serial_evt_prov_ecdh_request_t ecdh_request; 
 serial_evt_prov_output_request_t output_request; 
 serial_evt_prov_failed_t failed; 
} serial_evt_prov_t;

typedef struct __attribute((packed))
{
 access_model_id_t model_id; 
 uint8_t evt_type; 
} serial_evt_model_specific_header_t;

typedef struct __attribute((packed))
{
 serial_evt_model_specific_header_t model_evt_info;
 uint8_t data[NRF_MESH_SERIAL_PAYLOAD_MAXLEN - sizeof(serial_evt_model_specific_header_t)];
} serial_evt_model_specific_t;

typedef struct __attribute((packed))
{
 uint8_t data[NRF_MESH_SERIAL_PAYLOAD_MAXLEN]; 
} serial_evt_application_t;

typedef struct __attribute((packed))
{
 uint16_t src;
 uint16_t dst;
 uint16_t appkey_handle;
 uint16_t subnet_handle;
 uint8_t ttl;
 uint8_t adv_addr_type;
 uint8_t adv_addr[BLE_GAP_ADDR_LEN];
 int8_t rssi;
 uint16_t actual_length;
 uint8_t data[SERIAL_EVT_MESH_MESSAGE_RECEIVED_DATA_MAXLEN];
} serial_evt_mesh_message_received_t;

typedef struct __attribute((packed))
{
 nrf_mesh_tx_token_t token; 
} serial_evt_mesh_tx_complete_t;

typedef struct __attribute((packed))
{
 uint32_t iv_index; 
} serial_evt_mesh_iv_update_t;

typedef struct __attribute((packed))
{
 uint16_t netkey_index; 
 uint8_t phase; 
} serial_evt_mesh_key_refresh_t;

typedef struct __attribute((packed))
{
 uint8_t init_ttl;
 uint8_t hops;
 uint16_t features;
 uint16_t src;
} serial_evt_mesh_hb_message_t;

typedef struct __attribute((packed))
{
 uint32_t iv_index;
 uint8_t iv_update_in_progress;
 uint16_t iv_update_timout_counter;
} serial_evt_mesh_iv_entry_set_notification_t;

typedef struct __attribute((packed))
{
 uint32_t next_block;
} serial_evt_mesh_seqnum_entry_set_notification_t;

typedef union __attribute((packed))
{
 serial_evt_mesh_message_received_t message_received; 
 serial_evt_mesh_tx_complete_t tx_complete; 
 serial_evt_mesh_iv_update_t iv_update; 
 serial_evt_mesh_key_refresh_t key_refresh; 
 serial_evt_mesh_hb_message_t heartbeat; 
 serial_evt_mesh_iv_entry_set_notification_t iv_entry_set; 
 serial_evt_mesh_seqnum_entry_set_notification_t seqnum_entry_set; 
} serial_evt_mesh_t;

/********* DFU parameters *********/

typedef struct __attribute((packed))
{
 uint8_t dfu_type; 
 nrf_mesh_fwid_t fwid; 
 uint8_t authority; 
} serial_evt_dfu_req_relay_t;

typedef struct __attribute((packed))
{
 uint8_t dfu_type; 
} serial_evt_dfu_req_source_t;

typedef struct __attribute((packed))
{
 uint8_t role; 
 uint8_t dfu_type; 
 nrf_mesh_fwid_t fwid; 
} serial_evt_dfu_start_t;

typedef struct __attribute((packed))
{
 uint8_t role; 
 uint8_t dfu_type; 
 nrf_mesh_fwid_t fwid; 
 uint8_t end_reason; 
} serial_evt_dfu_end_t;

typedef struct __attribute((packed))
{
 uint8_t dfu_type; 
 nrf_mesh_fwid_t fwid; 
 uint32_t start_addr; 
 uint32_t length; 
 uint8_t is_signed; 
} serial_evt_dfu_bank_t;

typedef struct __attribute((packed))
{
 uint8_t dfu_type; 
 nrf_mesh_fwid_t available_fwid; 
 nrf_mesh_fwid_t current_fwid; 
} serial_evt_dfu_firmware_outdated_t;

typedef union __attribute((packed))
{
 serial_evt_dfu_req_relay_t req_relay; 
 serial_evt_dfu_req_source_t req_source; 
 serial_evt_dfu_start_t start; 
 serial_evt_dfu_end_t end; 
 serial_evt_dfu_bank_t bank; 
 serial_evt_dfu_firmware_outdated_t firmware_outdated; 
} serial_evt_dfu_t;

typedef union __attribute((packed))
{
 serial_evt_cmd_rsp_t cmd_rsp; 
 serial_evt_device_t device; 
 serial_evt_prov_t prov; 
 serial_evt_application_t application; 
 serial_evt_mesh_t mesh; 
 serial_evt_dfu_t dfu; 
 serial_evt_model_specific_t model; 
} serial_evt_t;

/*lint -align_max(pop) */
#endif