nRF5 SDK for Mesh v5.0.0
serial.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_H__
39 #define SERIAL_H__
40 
41 #include <stdint.h>
42 
43 #include "nrf_mesh.h"
44 #include "nrf_mesh_serial.h"
45 #include "serial_packet.h"
46 
60 #define SERIAL_API_VERSION 10
61 
68 uint32_t serial_init(void);
69 
78 uint32_t serial_start(void);
79 
95 uint32_t serial_packet_buffer_get(uint16_t packet_len, serial_packet_t ** pp_packet);
96 
102 void serial_tx(const serial_packet_t * p_packet);
103 
107 void serial_process(void);
108 
114 uint8_t serial_translate_error(uint32_t status);
115 
122 
131 void serial_cmd_rsp_send(uint8_t opcode, uint8_t status, const uint8_t * p_data, uint16_t length);
132 
135 #endif
void serial_tx(const serial_packet_t *p_packet)
Queues a packet for transmission on the serial interface.
void serial_cmd_rsp_send(uint8_t opcode, uint8_t status, const uint8_t *p_data, uint16_t length)
Send a simple command response to the given opcode, with the given serial status. ...
uint32_t serial_start(void)
Starts the serial interface by sending a device started event to the host.
nrf_mesh_serial_state_t serial_state_get(void)
Get current state of the serial module.
Serial packet structure.
Definition: serial_packet.h:64
nrf_mesh_serial_state_t
Mesh serial states.
uint32_t serial_init(void)
Initializes the serial interface abstraction layer.
void serial_process(void)
Schedule processing for serial RX/TX.
uint8_t serial_translate_error(uint32_t status)
Translates an NRF_* error code into an ACI error code.
uint32_t serial_packet_buffer_get(uint16_t packet_len, serial_packet_t **pp_packet)
Returns a serial packet buffer of the requested length.

Documentation feedback | Developer Zone | Subscribe | Updated