nRF5 SDK for Mesh v5.0.0
serial_packet.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef SERIAL_PACKET_H__
39 #define SERIAL_PACKET_H__
40 
41 #include <stdint.h>
42 #include <limits.h>
43 #include "serial_cmd.h"
44 #include "serial_evt.h"
45 #include "nrf_mesh_serial.h"
46 #include "nrf_mesh_assert.h"
47 
55 #define SERIAL_PACKET_LENGTH_OVERHEAD (1)
56 
57 #define SERIAL_PACKET_OVERHEAD (2)
58 
59 /*lint -align_max(push) -align_max(1) */
60 
64 typedef struct __attribute((packed))
65 {
66  uint8_t length;
67  uint8_t opcode;
70  union __attribute((packed))
71  {
74  } payload;
76 
77 
78 /* Check that the length of the packet fits in a uint8_t. */
79 NRF_MESH_STATIC_ASSERT(sizeof(serial_packet_t) <= (UINT8_MAX + 1));
80 
81 /*lint -align_max(pop) */
82 
85 #endif
Union of all serial event parameters.
Definition: serial_evt.h:421
serial_evt_t evt
Event packet parameters.
Definition: serial_packet.h:73
uint8_t opcode
Opcode of the packet.
Definition: serial_packet.h:67
Serial packet structure.
Definition: serial_packet.h:64
serial_cmd_t cmd
Command packet parameters.
Definition: serial_packet.h:72
uint8_t length
Length of the packet in bytes.
Definition: serial_packet.h:66
Union of all command parameters.
Definition: serial_cmd.h:720
#define NRF_MESH_STATIC_ASSERT(...)
Compile-time assertion.

Documentation feedback | Developer Zone | Subscribe | Updated