internal_event.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 INTERNAL_EVENT_H__
#define INTERNAL_EVENT_H__

#include "nrf_mesh_config_core.h"
#include "nrf_mesh_assert.h"

#include <nrf_error.h>
#include "log.h"
#include "utils.h"

typedef enum
{
 INTERNAL_EVENT_DECRYPT_APP, 
 INTERNAL_EVENT_DECRYPT_TRS, 
 INTERNAL_EVENT_DECRYPT_TRS_SEG, 
 INTERNAL_EVENT_PACKET_DROPPED, 
 INTERNAL_EVENT_PACKET_RELAYED, 
 INTERNAL_EVENT_NET_PACKET_QUEUED_TX, 
 INTERNAL_EVENT_TRS_ACK_RECEIVED, 
 INTERNAL_EVENT_ACK_QUEUED, 
 INTERNAL_EVENT_SAR_CANCELLED, 
 INTERNAL_EVENT_FM_ACTION, 
 INTERNAL_EVENT_FM_DEFRAG, 
 INTERNAL_EVENT_SAR_SUCCESS, 
 INTERNAL_EVENT_NET_PACKET_RECEIVED, 
 INTERNAL_EVENT_GATT_PROV_PDU_IGNORED, 
 INTERNAL_EVENT_FRIEND_PACKET_QUEUED, 
 INTERNAL_EVENT_NET_BEACON_TX, 
 INTERNAL_EVENT__LAST
} internal_event_type_t;

typedef enum
{
 PACKET_DROPPED_INVALID_APPKEY, 
 PACKET_DROPPED_INVALID_NETKEY, 
 PACKET_DROPPED_INVALID_DEVKEY, 
 PACKET_DROPPED_INVALID_ADDRESS, 
 PACKET_DROPPED_UNKNOWN_ADDRESS, 
 PACKET_DROPPED_REPLAY_CACHE, 
 PACKET_DROPPED_NETWORK_CACHE, 
 PACKET_DROPPED_NETWORK_DECRYPT_FAILED, 
 PACKET_DROPPED_INVALID_ADTYPE, 
 PACKET_DROPPED_INVALID_PACKET_LEN, 
 PACKET_DROPPED_NO_MEM 
} internal_event_packet_dropped_t;

typedef struct
{
 internal_event_type_t type;

 union
 {
 internal_event_packet_dropped_t reason;
 uint8_t value;
 } state;
 uint8_t packet_size;
 uint8_t * p_packet;
} internal_event_t;

typedef uint32_t (*internal_event_report_cb_t) (internal_event_t * p_event);

void internal_event_init(internal_event_report_cb_t report_cb);

uint32_t internal_event_push(internal_event_t * p_event);

#if INTERNAL_EVT_ENABLE
#define __INTERNAL_EVENT_PUSH(EVENT_TYPE, ADDATA, PACKET_SIZE, P_PACKET) \
 do { \
 internal_event_t EVT = \
 { \
 .type = (EVENT_TYPE), \
 .state.value = (ADDATA), \
 .packet_size = (PACKET_SIZE), \
 .p_packet = (uint8_t *) (P_PACKET) \
 }; \
 uint32_t RESULT = internal_event_push(&EVT); \
 if (RESULT != NRF_SUCCESS) \
 { \
 __LOG(LOG_SRC_INTERNAL, LOG_LEVEL_WARN, "Unable to push the internal event to the callback function [er%d]", RESULT); \
 } \
 } while (0)
#else
#define __INTERNAL_EVENT_PUSH(...)

#endif /* defined(INTERNAL_EVT_ENABLE) */

#endif /* INTERNAL_EVENT_H__ */