serial_types.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_TYPES_H__
#define SERIAL_TYPES_H__

#include <stdint.h>
#include "nrf_mesh_serial.h"
#include "access.h"

#define SERIAL_EVT_MESH_MESSAGE_RECEIVED_LEN_OVERHEAD (19 + NRF_MESH_SERIAL_PACKET_OVERHEAD)

#define SERIAL_EVT_MESH_MESSAGE_RECEIVED_DATA_MAXLEN (NRF_MESH_SERIAL_PAYLOAD_MAXLEN - (SERIAL_EVT_MESH_MESSAGE_RECEIVED_LEN_OVERHEAD - NRF_MESH_SERIAL_PACKET_OVERHEAD))

#define SERIAL_PACKET_INTERNAL_EVENT_OVERHEAD (3)

#define SERIAL_EVT_KEY_INDEX_INVALID (0xFF)

#define SERIAL_CMD_MESH_PACKET_SEND_OVERHEAD (10)

typedef enum
{
 SERIAL_DEVICE_OPERATING_MODE_TEST = 0, 
 SERIAL_DEVICE_OPERATING_MODE_BOOTLOADER = 1, 
 SERIAL_DEVICE_OPERATING_MODE_APPLICATION = 2, 
 SERIAL_DEVICE_OPERATING_MODE__LAST = 2,
} serial_device_operating_mode_t;

typedef enum
{
 SERIAL_CMD_TX_POWER_VALUE_0dBm = 0x00, 
 SERIAL_CMD_TX_POWER_VALUE_Pos4dBm = 0x04, 
 SERIAL_CMD_TX_POWER_VALUE_Neg30dBm = 0xD8, 
 SERIAL_CMD_TX_POWER_VALUE_Neg20dBm = 0xEC, 
 SERIAL_CMD_TX_POWER_VALUE_Neg16dBm = 0xF0, 
 SERIAL_CMD_TX_POWER_VALUE_Neg12dBm = 0xF4, 
 SERIAL_CMD_TX_POWER_VALUE_Neg8dBm = 0xF8, 
 SERIAL_CMD_TX_POWER_VALUE_Neg4dBm = 0xFC, 
} serial_cmd_tx_power_value_t;

typedef struct __attribute((packed))
{
 access_model_id_t model_id; 
 uint16_t element_index; 
} serial_cmd_model_specific_init_header_t;

typedef struct __attribute((packed))
{
 access_model_handle_t model_handle; 
} serial_cmd_model_specific_command_header_t;

#endif /* SERIAL_TYPES_H__ */