fast_otas.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file fast_otas.h
5 *
6 * @brief FAST_OTA Service API
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 *****************************************************************************************
36 */
37
38 /**
39 * @addtogroup BLE_SRV BLE Services
40 * @{
41 * @brief Definitions and prototypes for the BLE Service interface.
42 */
43
44 /**
45 * @defgroup BLE_SDK_FAST_OTA FAST_OTA Service (FAST_OTAS)
46 * @{
47 * @brief Definitions and prototypes for the FAST_OTAS interface.
48 *
49 * @details The FAST_OTA Service exposes the state of a battery within a device.
50 * This module implements the Battery Service with the Battery Level
51 * characteristic. After @ref otas_init_t variable is initialized, the
52 * developer shall call @ref otas_service_init() to add the FAST_OTA
53 * Service and RX, TX, Control characteristic to the BLE stack database.
54 *
55 * This module also provides \ref otas_notify_tx_data() function to the application
56 * to send data to peer.
57 */
58
59 #ifndef _FAST_OTAS_H_
60 #define _FAST_OTAS_H_
61
62 /*
63 * INCLUDE FILES
64 ****************************************************************************************
65 */
66 #include "gr55xx_sys.h"
67 #include "custom_config.h"
68
69 /**
70 * @defgroup FAST_OTAS_MACRO Defines
71 * @{
72 */
73 #define FAST_OTAS_CONNECTION_MAX (10 < CFG_MAX_CONNECTIONS ?\
74 10 : CFG_MAX_CONNECTIONS) /**< Maximum number of FAST_OTA Service connections. */
75 #define FAST_OTAS_MAX_DATA_LEN 244 /**< Maximum length of FAST_OTAS characteristic. */
76 #define BLE_UUID_FAST_OTA_SERVICE 0x1B, 0xD7, 0x90, 0xEC, 0xE8, 0xB9, 0x75, 0x80,\
77 0x0A, 0x46, 0x44, 0xD3, 0x01, 0x07, 0xED, 0xA6 /**< The UUID of FAST_OTA Service for setting advertising data. */
78
79 #define FAST_OTA_PATTERN_VALUE 0x474f4f44 /**< The Fast OTA pattern value. */
80 /** @} */
81
82 /**
83 * @defgroup FAST_OTA_ENUM Enumerations
84 * @{
85 */
86 /**@brief FAST_OTA Service event type. */
87 typedef enum
88 {
89 FAST_OTAS_EVT_INVALID,
90 FAST_OTAS_EVT_CMD_NOTIFICATION_ENABLED,
91 FAST_OTAS_EVT_CMD_NOTIFICATION_DISABLED,
92 FAST_OTAS_EVT_CMD_RECEIVE_DATA,
93 FAST_OTAS_EVT_CMD_NOTIFY_COMPLETE,
94 FAST_OTAS_EVT_DATA_RECEIVE_DATA
95 } fast_otas_evt_type_t;
96 /** @} */
97
98 /**
99 * @defgroup FAST_OTAS_STRUCT Structures
100 * @{
101 */
102 /**@brief FAST_OTA Service event. */
103 typedef struct
104 {
105 fast_otas_evt_type_t evt_type; /**< The FAST_OTAS event. */
106 uint8_t conn_idx; /**< Index of connection. */
107 uint8_t *p_data; /**< Pointer to data. */
108 uint16_t length; /**< Length of data. */
109 } fast_otas_evt_t;
110 /** @} */
111
112 /**
113 * @defgroup FAST_OTAS_TYPEDEF Typedefs
114 * @{
115 */
116 /**@brief FAST_OTA Service event handler type. */
117 typedef void (*fast_otas_evt_handler_t)(fast_otas_evt_t *p_evt);
118
119 /**@brief FAST_OTA Service function type. */
120 typedef void (*function)(void);
121 /** @} */
122
123 /**
124 * @defgroup FAST_OTAS_STRUCT Structures
125 * @{
126 */
127 /**@brief FAST_OTA Service initialization variable. */
128 typedef struct
129 {
130 fast_otas_evt_handler_t evt_handler; /**< Handler to handle otas event. */
131 } fast_otas_init_t;
132 /** @} */
133
134
135 /**
136 * @defgroup FAST_OTAS_FUNCTION Functions
137 * @{
138 */
139 /**
140 *****************************************************************************************
141 * @brief Add an FAST_OTA Service instance in the DB
142 *
143 * @param[in] p_otas_init :Pointer to FAST_OTA Service environment variable
144 *
145 * @return Result of service initialization.
146 *****************************************************************************************
147 */
148 sdk_err_t fast_otas_service_init(fast_otas_init_t *p_otas_init);
149
150
151 /**
152 *****************************************************************************************
153 * @brief Send data to peer device
154 *
155 * @param[in] conn_idx: Connection index
156 * @param[in] p_data: The Pointer of send value
157 * @param[in] length: The Lenth of send value
158 *
159 * @return Result of notify and indicate value
160 *****************************************************************************************
161 */
162 sdk_err_t fast_otas_notify_cmd_data(uint8_t conn_idx, uint8_t *p_data,uint16_t length);
163 /** @} */
164
165 #endif
166 /** @} */
167 /** @} */
fast_otas_evt_t
FAST_OTA Service event.
Definition: fast_otas.h:104
FAST_OTAS_EVT_CMD_NOTIFY_COMPLETE
@ FAST_OTAS_EVT_CMD_NOTIFY_COMPLETE
Definition: fast_otas.h:93
fast_otas_service_init
sdk_err_t fast_otas_service_init(fast_otas_init_t *p_otas_init)
Add an FAST_OTA Service instance in the DB.
fast_otas_evt_type_t
fast_otas_evt_type_t
FAST_OTA Service event type.
Definition: fast_otas.h:88
FAST_OTAS_EVT_INVALID
@ FAST_OTAS_EVT_INVALID
Definition: fast_otas.h:89
fast_otas_notify_cmd_data
sdk_err_t fast_otas_notify_cmd_data(uint8_t conn_idx, uint8_t *p_data, uint16_t length)
Send data to peer device.
fast_otas_evt_t::conn_idx
uint8_t conn_idx
Index of connection.
Definition: fast_otas.h:106
fast_otas_init_t
FAST_OTA Service initialization variable.
Definition: fast_otas.h:129
gr55xx_sys.h
GR55XX System API.
FAST_OTAS_EVT_CMD_NOTIFICATION_DISABLED
@ FAST_OTAS_EVT_CMD_NOTIFICATION_DISABLED
Definition: fast_otas.h:91
fast_otas_evt_handler_t
void(* fast_otas_evt_handler_t)(fast_otas_evt_t *p_evt)
FAST_OTA Service event handler type.
Definition: fast_otas.h:117
FAST_OTAS_EVT_CMD_NOTIFICATION_ENABLED
@ FAST_OTAS_EVT_CMD_NOTIFICATION_ENABLED
Definition: fast_otas.h:90
fast_otas_init_t::evt_handler
fast_otas_evt_handler_t evt_handler
Handler to handle otas event.
Definition: fast_otas.h:130
FAST_OTAS_EVT_DATA_RECEIVE_DATA
@ FAST_OTAS_EVT_DATA_RECEIVE_DATA
Definition: fast_otas.h:94
fast_otas_evt_t::p_data
uint8_t * p_data
Pointer to data.
Definition: fast_otas.h:107
fast_otas_evt_t::evt_type
fast_otas_evt_type_t evt_type
The FAST_OTAS event.
Definition: fast_otas.h:105
sdk_err_t
uint16_t sdk_err_t
SDK API result type.
Definition: ble_error.h:243
FAST_OTAS_EVT_CMD_RECEIVE_DATA
@ FAST_OTAS_EVT_CMD_RECEIVE_DATA
Definition: fast_otas.h:92
fast_otas_evt_t::length
uint16_t length
Length of data.
Definition: fast_otas.h:108