nRF5 SDK for Mesh v5.0.0
serial_handler_models.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_MODELS_H__
39 #define SERIAL_HANDLER_MODELS_H__
40 
41 #include "serial_packet.h"
42 #include "serial_cmd.h"
43 
61 typedef uint32_t (*serial_handler_models_model_init_cb_t)(const serial_cmd_model_specific_init_t * p_init_params, access_model_handle_t * p_model_handle);
62 
72 typedef uint32_t (*serial_handler_models_model_command_cb_t)(const serial_cmd_model_specific_command_t * p_command_params, serial_evt_cmd_rsp_data_model_cmd_t * p_cmd_rsp);
73 
75 typedef struct
76 {
77  access_model_id_t model_id;
78  serial_handler_models_model_init_cb_t model_initialize;
79  serial_handler_models_model_command_cb_t model_command;
80 } serial_handler_models_info_t;
81 
87 void serial_handler_models_rx(const serial_packet_t* p_cmd);
88 
100 uint32_t serial_handler_models_register(const serial_handler_models_info_t * p_model_info);
101 
104 #endif /* SERIAL_HANDLER_MODELS_H__ */
105 
access_model_handle_t
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
serial_handler_models_rx
void serial_handler_models_rx(const serial_packet_t *p_cmd)
Handle model specific serial commands.
serial_handler_models_info_t::model_initialize
serial_handler_models_model_init_cb_t model_initialize
Initializer callback of the model registered.
Definition: serial_handler_models.h:78
serial_handler_models_info_t::model_id
access_model_id_t model_id
Model ID of the model to be registered.
Definition: serial_handler_models.h:77
serial_cmd_model_specific_init_t
Used for initializing one of the available models.
Definition: serial_cmd.h:682
serial_evt_cmd_rsp_data_model_cmd_t
Command response to SERIAL_OPCODE_CMD_MODEL_SPECIFIC_COMMAND from the model addressed.
Definition: serial_cmd_rsp.h:291
serial_handler_models_info_t::model_command
serial_handler_models_model_command_cb_t model_command
Command parser for the model registered.
Definition: serial_handler_models.h:79
serial_packet_t
Serial packet structure.
Definition: serial_packet.h:64
serial_handler_models_model_init_cb_t
uint32_t(* serial_handler_models_model_init_cb_t)(const serial_cmd_model_specific_init_t *p_init_params, access_model_handle_t *p_model_handle)
Initializer callback prototype used by the serial handler to forward init calls to each model...
Definition: serial_handler_models.h:61
serial_handler_models_register
uint32_t serial_handler_models_register(const serial_handler_models_info_t *p_model_info)
Registers a model with the serial handler so that the models presence can be seen via serial and comm...
access_model_id_t
Access layer model ID.
Definition: access.h:151
serial_cmd_model_specific_command_t
Used for sending commands to one of the initialized models.
Definition: serial_cmd.h:691
serial_handler_models_info_t
Information struct for registering a model with the serial handler to make it available over serial...
Definition: serial_handler_models.h:75
serial_handler_models_model_command_cb_t
uint32_t(* serial_handler_models_model_command_cb_t)(const serial_cmd_model_specific_command_t *p_command_params, serial_evt_cmd_rsp_data_model_cmd_t *p_cmd_rsp)
Command callback prototype for processing model specific commands.
Definition: serial_handler_models.h:72
Documentation feedback | Developer Zone | Subscribe | Updated