otas.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file otas.h
5 *
6 * @brief 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_OTA OTA Service (OTAS)
46 * @{
47 * @brief Definitions and prototypes for the OTAS interface.
48 *
49 * @details The 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 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 _OTAS_H_
60 #define _OTAS_H_
61
62 /*
63 * INCLUDE FILES
64 ****************************************************************************************
65 */
66 #include "gr55xx_sys.h"
67 #include "custom_config.h"
68
69 /**
70 * @defgroup OTAS_MACRO Defines
71 * @{
72 */
73 #define OTAS_CONNECTION_MAX (10 < CFG_MAX_CONNECTIONS ?\
74 10 : CFG_MAX_CONNECTIONS) /**< Maximum number of OTA Service connections. */
75 #define OTAS_MAX_DATA_LEN 244 /**< Maximum length of OTAS characteristic. */
76 #define BLE_UUID_OTA_SERVICE 0x1B, 0xD7, 0x90, 0xEC, 0xE8, 0xB9, 0x75, 0x80,\
77 0x0A, 0x46, 0x44, 0xD3, 0x01, 0x04, 0xED, 0xA6 /**< The UUID of OTA Service for setting advertising data. */
78 #define OTAS_CTRL_ENTER_DFU 0x474f4f44 /**< OTAS enter DFU control. */
79 /** @} */
80
81 /**
82 * @defgroup OTA_ENUM Enumerations
83 * @{
84 */
85 /**@brief OTA Service event type. */
86 typedef enum
87 {
88 OTAS_EVT_INVALID,
89 OTAS_EVT_TX_NOTIFICATION_ENABLED,
90 OTAS_EVT_TX_NOTIFICATION_DISABLED,
91 OTAS_EVT_RX_RECEIVE_DATA,
92 OTAS_EVT_NOTIFY_COMPLETE,
93 OTAS_EVT_DFU_MODE_ENTER,
94 } otas_evt_type_t;
95 /** @} */
96
97 /**
98 * @defgroup OTAS_STRUCT Structures
99 * @{
100 */
101 /**@brief OTA Service event. */
102 typedef struct
103 {
104 otas_evt_type_t evt_type; /**< The OTAS event. */
105 uint8_t conn_idx; /**< Index of connection. */
106 uint8_t *p_data; /**< Pointer to data. */
107 uint16_t length; /**< Length of data. */
108 } otas_evt_t;
109 /** @} */
110
111 /**
112 * @defgroup OTAS_TYPEDEF Typedefs
113 * @{
114 */
115 /**@brief OTA Service event handler type. */
116 typedef void (*otas_evt_handler_t)(otas_evt_t *p_evt);
117
118 /**@brief OTA Service function type. */
119 typedef void (*function)(void);
120 /** @} */
121
122 /**
123 * @defgroup OTAS_STRUCT Structures
124 * @{
125 */
126 /**@brief OTA Service initialization variable. */
127 typedef struct
128 {
129 otas_evt_handler_t evt_handler; /**< Handler to handle otas event. */
130 } otas_init_t;
131 /** @} */
132
133
134 /**
135 * @defgroup OTAS_FUNCTION Functions
136 * @{
137 */
138 /**
139 *****************************************************************************************
140 * @brief Add an OTA Service instance in the DB
141 *
142 * @param[in] p_otas_init :Pointer to OTA Service environment variable
143 *
144 * @return Result of service initialization.
145 *****************************************************************************************
146 */
147 sdk_err_t otas_service_init(otas_init_t *p_otas_init);
148
149
150 /**
151 *****************************************************************************************
152 * @brief Send data to peer device
153 *
154 * @param[in] conn_idx: Connection index
155 * @param[in] p_data: The Pointer of send value
156 * @param[in] length: The Lenth of send value
157 *
158 * @return Result of notify and indicate value
159 *****************************************************************************************
160 */
161 sdk_err_t otas_notify_tx_data(uint8_t conn_idx, uint8_t *p_data,uint16_t length);
162 /** @} */
163
164 #endif
165 /** @} */
166 /** @} */
otas_notify_tx_data
sdk_err_t otas_notify_tx_data(uint8_t conn_idx, uint8_t *p_data, uint16_t length)
Send data to peer device.
OTAS_EVT_TX_NOTIFICATION_ENABLED
@ OTAS_EVT_TX_NOTIFICATION_ENABLED
Definition: otas.h:89
otas_evt_handler_t
void(* otas_evt_handler_t)(otas_evt_t *p_evt)
OTA Service event handler type.
Definition: otas.h:116
otas_evt_t
OTA Service event.
Definition: otas.h:103
OTAS_EVT_INVALID
@ OTAS_EVT_INVALID
Definition: otas.h:88
otas_evt_t::p_data
uint8_t * p_data
Pointer to data.
Definition: otas.h:106
otas_evt_t::conn_idx
uint8_t conn_idx
Index of connection.
Definition: otas.h:105
gr55xx_sys.h
GR55XX System API.
OTAS_EVT_RX_RECEIVE_DATA
@ OTAS_EVT_RX_RECEIVE_DATA
Definition: otas.h:91
otas_evt_t::length
uint16_t length
Length of data.
Definition: otas.h:107
OTAS_EVT_TX_NOTIFICATION_DISABLED
@ OTAS_EVT_TX_NOTIFICATION_DISABLED
Definition: otas.h:90
otas_init_t
OTA Service initialization variable.
Definition: otas.h:128
sdk_err_t
uint16_t sdk_err_t
SDK API result type.
Definition: ble_error.h:243
otas_service_init
sdk_err_t otas_service_init(otas_init_t *p_otas_init)
Add an OTA Service instance in the DB.
OTAS_EVT_NOTIFY_COMPLETE
@ OTAS_EVT_NOTIFY_COMPLETE
Definition: otas.h:92
OTAS_EVT_DFU_MODE_ENTER
@ OTAS_EVT_DFU_MODE_ENTER
Definition: otas.h:93
otas_evt_t::evt_type
otas_evt_type_t evt_type
The OTAS event.
Definition: otas.h:104
otas_init_t::evt_handler
otas_evt_handler_t evt_handler
Handler to handle otas event.
Definition: otas.h:129
otas_evt_type_t
otas_evt_type_t
OTA Service event type.
Definition: otas.h:87