nRF5 SDK for Mesh v5.0.0
serial_handler_common.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_HANDLER_COMMON_H__
39 #define SERIAL_HANDLER_COMMON_H__
40 
41 #include <stdint.h>
42 #include "serial_packet.h"
43 #include "nrf_mesh.h"
44 
62 typedef void (*serial_handler_common_cmd_cb_t)(const serial_packet_t * p_cmd);
63 
65 typedef struct
66 {
67  uint8_t opcode;
68  uint8_t payload_minlen;
72 
81 void serial_handler_common_cmd_rsp_nodata_on_error(uint8_t opcode, uint32_t status, const uint8_t * p_data, uint16_t length);
82 
90 void serial_handler_common_rx(const serial_packet_t * p_cmd, const serial_handler_common_opcode_to_fp_map_t * p_cmd_handlers, uint32_t no_handlers);
91 
94 #endif /* SERIAL_HANDLER_COMMON_H__ */
void serial_handler_common_cmd_rsp_nodata_on_error(uint8_t opcode, uint32_t status, const uint8_t *p_data, uint16_t length)
Send command response with the given data if the status is NRF_SUCCESS, otherwise sends NULL...
serial_handler_common_cmd_cb_t callback
Command processing function.
uint8_t payload_minlen
Expected minimum payload for this serial command (can be 0).
Structure for mapping a command opcode to the command processing function.
Serial packet structure.
Definition: serial_packet.h:64
uint8_t payload_optional_extra_bytes
Additonal payload bytes: can also be 0.
void(* serial_handler_common_cmd_cb_t)(const serial_packet_t *p_cmd)
Command processing function call back dedicated to a specific command.
void serial_handler_common_rx(const serial_packet_t *p_cmd, const serial_handler_common_opcode_to_fp_map_t *p_cmd_handlers, uint32_t no_handlers)
RX handler pattern for serial packets.

Documentation feedback | Developer Zone | Subscribe | Updated